src/com/googlecode/lanterna/terminal/ansi/UnixTerminalSizeQuerier.java

   1 /*
   2  * This file is part of lanterna (http://code.google.com/p/lanterna/).
   3  *
   4  * lanterna is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Copyright (C) 2010-2015 Martin
  18  */
  19 package com.googlecode.lanterna.terminal.ansi;
  20
  21 import com.googlecode.lanterna.TerminalSize;
  22
  23 /**
  24  * This class allows you to override by what means Lanterna detects the size of
  25  * the terminal. You can implement this interface and pass it to the
  26  * UnixTerminal constructor in order to use it.
  27  * @author martin
  28  */
  29 @SuppressWarnings("WeakerAccess")
  30 public interface UnixTerminalSizeQuerier {
  31     /**
  32      * Checks what the size of the terminal is, measured in number of rows and columns. The implementer of this
  33      * interface is expected to know which terminal we are querying for and have all it needs to figure out the size.
  34      * One way of implementing this could be to read of an external value or variable or calling IPCs or just return
  35      * a static size at all times.
  36      * @return Size of the terminal at this point in time
  37      */
  38     TerminalSize queryTerminalSize();
  39 }