***************************************************************************
Copyright 2018-2019,2020 Thomas E. Dickey *
Copyright 2010-2015,2017 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_variables.3x,v 1.14 2020/02/02 23:34:34 tom Exp $
.. COLORS, COLOR_PAIRS, COLS, ESCDELAY, LINES, TABSIZE, curscr, newscr, stdscr - curses global variables

#include <curses.h>

int COLOR_PAIRS;

int COLORS;

int COLS;

int ESCDELAY;

int LINES;

int TABSIZE;

WINDOW * curscr;

WINDOW * newscr;

WINDOW * stdscr;

This page summarizes variables provided by the curses library. A more complete description is given in the curses(3X) manual page.

Depending on the configuration, these may be actual variables, or macros (see curs_threads(3X) and curs_opaque(3X)) which provide read-only access to curses's state. In either case, applications should treat them as read-only to avoid confusing the library.

After initializing curses, this variable contains the number of color pairs which the terminal can support. Usually the number of color pairs will be the product COLORS*COLORS, however this is not always true: .bP a few terminals use HLS colors, which do not follow this rule .bP terminals supporting a large number of colors are limited by the number of color pairs that can be represented in a signed short value. After initializing curses, this variable contains the number of colors which the terminal can support. After initializing curses, this variable contains the width of the screen, i.e., the number of columns. This variable holds the number of milliseconds to wait after reading an escape character, to distinguish between an individual escape character entered on the keyboard from escape sequences sent by cursor- and function-keys (see curses(3X)). After initializing curses, this variable contains the height of the screen, i.e., the number of lines. This variable holds the number of columns used by the curses library when converting a tab character to spaces as it adds the tab to a window (see curs_addch(3X). This implementation of curses uses a special window curscr to record its updates to the terminal screen.

This is referred to as the \*(``physical screen\*('' in the curs_refresh(3X) and curs_outopts(3X) manual pages.

This implementation of curses uses a special window newscr to hold updates to the terminal screen before applying them to curscr.

This is referred to as the \*(``virtual screen\*('' in the curs_kernel(3X), curs_refresh(3X) and curs_outopts(3X) manual pages.

Upon initializing curses, a default window called stdscr, which is the size of the terminal screen, is created. Many curses functions use this window. The curses library is initialized using either initscr(3X), or newterm(3X).

If curses is configured to use separate curses/terminfo libraries, most of these variables reside in the curses library.

TABSIZE is a feature of SVr4 curses which is not documented by X/Open curses. .bP In SVr4 curses, TABSIZE is initially set from the terminal description's init_tabs capability. After that, it can be altered by the applications using SVr4 curses. SVr4 curses uses the current value of TABSIZE to compute the position of tabstops for updating both the virtual screen with addch(3X) as well as the physical screen with mvcur(3X). .bP This implementation uses the current value of TABSIZE only for updating the virtual screen. It uses the terminal description's it (init_tabs) capability for computing hardware tabs (i.e., tab stops on the physical screen). .bP Other implementations differ. For instance, NetBSD curses allows TABSIZE to be set through an environment variable. This implementation does not. NetBSD curses does not support hardware tabs; it uses the init_tabs capability and the TABSIZE variable only for updating the virtual screen.

ESCDELAY is an extension in AIX curses: .bP In AIX, the units for ESCDELAY are fifths of a millisecond. .bP The default value for AIX's ESCDELAY is 0.1 seconds. .bP AIX also enforces a limit of 10,000 seconds for ESCDELAY; this implementation currently has no upper limit.

This implementation has long used ESCDELAY with units of milliseconds, making it impossible to be completely compatible with AIX. Likewise, most users have either decided to override the value, or rely upon its default value.

curses(3X), curs_opaque(3X), curs_terminfo(3X), curs_threads(3X), term_variables(3X), terminfo(\*n).