Source code for console.constants

'''
    .. console - Comprehensive utility library for ANSI terminals.
    .. © 2018-2025, Mike Miller - Released under the LGPL, version 3+.

    Constants needed cross-package.
'''
from enum import IntEnum as _IntEnum
from . import using_terminfo as _using_terminfo


# ASCII Constants      DEC   OCT    HEX   CTL     DESC
ENQ = '\x05'        #:   5   005           ^E     Enquiry
BEL = '\a'          #:   7   007   0x07    ^G     Terminal bell - Ding!
BS  = '\b'          #:   8   010   0x08    ^H     Backspace
HT  = '\t'          #:   9   011   0x09    ^I     Horizontal TAB
LF  = '\n'          #:  10   012   0x0A    ^J     Linefeed (newline)
VT  = '\v'          #:  11   013   0x0B    ^K     Vertical TAB
FF  = '\f'          #:  12   014   0x0C    ^L     Formfeed (also: New page NP)
CR  = '\r'          #:  13   015   0x0D    ^M     Carriage return

ESC = '\x1b'        #:  27   033           ^[     Escape character
FS  = '\x1c'        #:  28   034           ^\     Field Separator
GS  = '\x1d'        #:  29   035           ^]     Group Separator
RS  = '\x1e'        #:  30   036           ^^     Record Separator

DEL = '\x7f'        #: 127   177                  Delete character

# ANSI Constants
CSI = ESC + '['     #: Control Sequence Introducer
OSC = ESC + ']'     #: Operating System Command
RIS = ESC + 'c'     #: Reset to Initial State, aka clear screen (see utils)
ST  = ESC + '\\'    #: Sequence terminator

# some C1 codes, use is problematic under UTF-8 encoding
CSI_C1 = '\x9b'
OSC_C1 = '\x9d'
ST_C1  = '\x9c'

# Where ANSI codes start, floor values:
ANSI_FG_LO_BASE = 30
ANSI_FG_HI_BASE = 90
ANSI_BG_LO_BASE = 40
ANSI_BG_HI_BASE = 100

ANSI_RESET = CSI + '0m'


# update several constants via terminfo, needs improvement
if _using_terminfo:
    from . import _curses
    def _get_val(name, default):  # walrus >= 3.8
        value = _curses.tigetstr(name)
        return value.decode('ascii') if value else default

    BEL = _get_val('bel', BEL)
    BS = _get_val('kbs', BS)
    CR = _get_val('cr', CR)
    HT = _get_val('ht', HT)
    LF = _get_val('ind', LF)
    del _get_val

# Mappings for xterm funcionality:
_COLOR_CODE_MAP = dict(foreground='10', fg='10', background='11', bg='11')
_MODE_MAP = dict(
    forward='0', backward='1', right='0', left='1', full='2', history='3'
)
_TITLE_MODE_MAP = dict(both='0', icon='1', title='2')

# those that use colon sep
TERMS_DIRECT_COLON = ('xterm-', 'iterm2-', 'kitty-', 'mintty-', 'mlterm-')


# Level of functionality provided by der terminal


class TermLevel(_IntEnum):
    DUMB            = 0     # Stream/not a tty, disabled, or ASCII teleprinter
    ANSI_MONOCHROME = 1     # Text effects but no color, e.g. vt220
    ANSI_BASIC      = 2     # + 3,4 Bit, 8/16 indexed colors
    ANSI_EXTENDED   = 3     # + 8 bit, 256 indexed colors
    ANSI_DIRECT     = 4     # + 24 bit, 16m direct colors, aka "true"
    THE_FULL_MONTY  = 9     # + Bleeding edge (not yet a determining factor)



if __name__ == '__main__':

    ''' Print out constants for convenience. '''
    print('\nConstants:\n')
    _locals = locals()      # avoids issues
    for key in dir():
        if not key.startswith('_'):
            obj = _locals[key]
            if isinstance(obj, type) and issubclass(obj, _IntEnum):
                print('%16s = %r%r' % (key, obj,
                    tuple((m.value, m.name) for m in TermLevel)))
            else:
                print('%16s = %r' % (key, obj))