Skip to content

vtf iodata decpm

Jump to bottom
srccircumflex edited this page Apr 24, 2023 · 4 revisions

↑ vtf-iodata

decpm

The module provides factory methods and handlers for the DEC Private Mode sequences.

These methods are equipped with the __DECPM_GATE__ decorator.

Module contents

Constants

__ReplyCache__ = _ReplyCache()

A global memory for DEC private mode status requests.
Containers

class decpm.DECPModeIds

DEC private mode numbers collection.

AllMotionMouseTracking = 1003

Allow80to132Mode = 40

AlternateScreenBuffer = 1047

AlternateScrollMode = 1007

ApplicationCursorKeys = 1

ApplicationKeypad = 66

AutoRepeatKeys = 8

AutoWrapMode = 7

BackarrowKeySendsBackspace = 67

BellIsUrgent = 1042

BracketedPasteMode = 2004

CellMotionMouseTracking = 1002

Column132Mode = 3

CursesMoreFix = 41

DesignateUSASCII = 2

DisableSixelScrolling = 80

EnableFontShifting = 35

EnableLRmargin = 69

EnableXORblinkingCursor = 14

EnterTektronixMode = 38

ExpandedPrintMode = 43

HPFKey = 1052

HighlightMouseTracking = 1001

InterpretMetaKey = 1034

KeepClipboard = 1044

KeepSelection = 1040

KeyPressScrollToBottom = 1011

LegacyKeyboard = 1060

MarginBell = 44

NationalReplacementCharacter = 42

NotClearScreenDECCOLM = 95

OriginMode = 6

PopOnBell = 1043

PrintColorMode = 44

PrintColorSpace = 45

PrintFormFeed = 18

PrintFullScreen = 19

ReverseVideo = 5

ReverseWraparound = 45

RotatedPrintMode = 47

SCOFKey = 1053

SGRMouseMode = 1006

SGRMousePixelMode = 1016

SaveCursor = 1048

SaveCursorAlternateScreenBuffer = 1049

SelectToClipboard = 1041

SendDELEditingKeypad = 1037

SendESCAltModifies = 1039

SendESCMetaModifies = 1036

SendFocusInFocusOut = 1004

SendMousePress_X10 = 9

SendMousePress_X11 = 1000

ShowCursor = 25

ShowScrollbar = 30

ShowToolbar = 10

SmoothScroll = 4

SpecialModifiers = 1035

StartBlinkingCursor = 12

StartLogging = 46

SunFKey = 1051

SwitchingAlternateScreenBuffer = 1046

TTYoutScrollToBottom = 1010

TerminfoTermcapKey = 1050

UTF8MouseMode = 1005

UrxvtMouseMode = 1015

VT220Keyboard = 1061

alternateScreenBuffer = 47

startBlinkingCursor = 13

Functions

decpm.ApplicationCursorKeys(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(1, <atexit>)

DECPM 1: Application Cursor Keys (DECCKM), VT100. [i] Windows / UNIX compatible

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.BracketedPasteMode(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(2004, <atexit>)

DECPM 2004: Set bracketed paste mode, xterm.

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.CursorAutowrapMode(atexit='h') -> DECPMHandler

Factory function to DECPMHandler(7, <atexit>)

DECPM 7: Auto-Wrap Mode (DECAWM), VT100.

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.CursorBlinking(atexit='h') -> DECPMHandler

Factory function to DECPMHandler(12, <atexit>)

DECPM 12: Blinking cursor (AT&T 610). [i] Windows / UNIX compatible

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.CursorSaveDEC(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(1048, <atexit>)

DECPM 1048: Save cursor as in DECSC, xterm. This may be disabled by the titeInhibit resource.

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.CursorShow(atexit='h') -> DECPMHandler

Factory function to DECPMHandler(25, <atexit>)

DECPM 25: Show cursor (DECTCEM), VT220. [i] Windows / UNIX compatible

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.MouseAllTracking(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(1003, <atexit>)

DECPM 1003: Use All Motion Mouse Tracking, xterm.

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.MouseCellMotionTracking(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(1002, <atexit>)

DECPM 1002: Use Cell Motion Mouse Tracking, xterm.

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.MouseHighlightTracking(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(1001, <atexit>)

DECPM 1001: Use Highlight Mouse Tracking, xterm. (eq. to 1000)

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.MouseSendPress(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(9, <atexit>)

DECPM 9: Send Mouse X & Y on button press. (X10 xterm mouse protocol)

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.MouseSendPressNRelease(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(1000, <atexit>)

DECPM 1000: Send Mouse X & Y on button press and release. See the section Mouse Tracking. This is the X11 xterm mouse protocol.

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.ScreenAlternateBuffer(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(1049, <atexit>)

DECPM 1049: Save cursor as in DECSC, xterm. After saving the cursor, switch to the Alternate Screen Buffer, clearing it first. This may be disabled by the titeInhibit resource. This control combines the effects of the 1 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based applications rather than the 4 7 mode. [i] Windows / UNIX compatible

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

decpm.ScreenReverseVideo(atexit='l') -> DECPMHandler

Factory function to DECPMHandler(5, <atexit>)

DECPM 5: Reverse Video (DECSCNM), VT100.

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

Objects

Factory Class

class decpm.DECPrivateMode

  • [DECSET] CSI ? n=mode h (.high)
  • [DECRST] CSI ? n=mode l (.low)

mode =

Mouse:
  • 9 : Send Mouse X & Y on button press. (X10 xterm mouse protocol)
  • 1000 : Send Mouse X & Y on button press and release. See the section xterm/Mouse-Tracking. This is the X11 xterm mouse protocol.
  • 1001 : Use Highlight Mouse Tracking, xterm. (eq. to 1000)
  • 1002 : Use Cell Motion Mouse Tracking, xterm.
  • 1003 : Use All Motion Mouse Tracking, xterm.
Extended Mouse Coordinates (supported by the vtiinterpreter):
  • 1006 : Enable SGR Mouse Mode, xterm.
  • 1016 : Enable SGR Mouse PixelMode, xterm.

# Resources: xterm/Extended-coordinates

Screen:
  • 5 : Reverse Video (DECSCNM), VT100.
  • 1046 : Switching to/from Alternate Screen Buffer, xterm. This works for terminfo-based systems, updating the titeInhibit resource.
  • 1047 : Use Alternate Screen Buffer, xterm. This may be disabled by the titeInhibit resource.
  • 1049 : Save cursor as in DECSC, xterm. After saving the cursor, switch to the Alternate Screen Buffer, clearing it first. This may be disabled by the titeInhibit resource. This control combines the effects of the 1 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based applications rather than the 4 7 mode. [i] Windows / UNIX compatible

# Resources: xterm/The-Alternate-Screen-Buffer

Cursor:
  • 7 : Auto-Wrap Mode (DECAWM), VT100.
  • 12 : Blinking cursor (AT&T 610). [i] Windows / UNIX compatible
  • 13 : Blinking cursor (set only via resource or menu).
  • 14 : Enable XOR of blinking cursor control sequence and menu.
  • 25 : Show cursor (DECTCEM), VT220. [i] Windows / UNIX compatible
  • 1048 : Save cursor as in DECSC, xterm. This may be disabled by the titeInhibit resource.
Modes:
  • 1 : Application Cursor Keys (DECCKM), VT100. [i] Windows / UNIX compatible
  • 2004 : Set bracketed paste mode, xterm.

# Resources: xterm/Bracketed-Paste-Mode

Miscellaneous:
  • 2 : Designate USASCII for character sets G0-G3 (DECANM), VT100, and set VT100 mode.
  • 3 : 132 Column Mode (DECCOLM), VT100. [i] Windows / UNIX compatible
  • 4 : Smooth (Slow) Scroll (DECSCLM), VT100.
  • 6 : Origin Mode (DECOM), VT100.
  • 8 : Auto-Repeat Keys (DECARM), VT100.
  • 10 : Show toolbar (rxvt).
  • 18 : Print Form Feed (DECPFF), VT220.
  • 19 : Set print extent to full screen (DECPEX), VT220.
  • 30 : Show scrollbar (rxvt).
  • 35 : Enable font-shifting functions (rxvt).
  • 38 : Enter Tektronix mode (DECTEK), VT240, xterm.
  • 40 : Allow 80 => 132 mode, xterm.
  • 41 : more(1) fix (see curses resource).
  • 42 : Enable National Replacement Character sets (DECNRCM), VT220.
  • 43 : Enable Graphics Expanded Print Mode (DECGEPM).
  • 44 : Turn on margin bell, xterm. || Enable Graphics Print Color Mode (DECGPCM).
  • 45 : Reverse-wraparound mode, xterm. || Enable Graphics Print ColorSpace (DECGPCS).
  • 46 : Start logging, xterm. This is normally disabled by a compile-time option.
  • 47 : Use Alternate Screen Buffer, xterm. This may be disabled by the titeInhibit resource. || Enable Graphics Rotated Print Mode (DECGRPM).
  • 66 : Application keypad mode (DECNKM), VT320.
  • 67 : Backarrow key sends backspace (DECBKM), VT340, VT420. This sets the backarrowKey resource to "true".
  • 69 : Enable left and right margin mode (DECLRMM), VT420 and up.
  • 80 : Disable Sixel Scrolling (DECSDM).
  • 95 : Do not clear screen when DECCOLM is set/reset (DECNCSM), VT510 and up.
  • 1004 : Send FocusIn/FocusOut events, xterm.
  • 1005 : Enable UTF-8 Mouse Mode, xterm.
  • 1007 : Enable Alternate Scroll Mode, xterm. This corresponds to the alternateScroll resource.
  • 1010 : Scroll to bottom on tty output (rxvt). This sets the scrollTtyOutput resource to "true".
  • 1011 : Scroll to bottom on key press (rxvt). This sets the scrollKey resource to "true".
  • 1015 : Enable urxvt Mouse Mode.
  • 1034 : Interpret "meta" key, xterm. This sets the eighth bit of keyboard input (and enables the eightBitInput resource).
  • 1035 : Enable special modifiers for Alt and NumLock keys, xterm. This enables the numLock resource.
  • 1036 : Send ESC when Meta modifies a key, xterm. This enables the metaSendsEscape resource.
  • 1037 : Send DEL from the editing-keypad Delete key, xterm.
  • 1039 : Send ESC when Alt modifies a key, xterm. This enables the altSendsEscape resource, xterm.
  • 1040 : Keep selection even if not highlighted, xterm. This enables the keepSelection resource.
  • 1041 : Use the CLIPBOARD selection, xterm. This enables the selectToClipboard resource.
  • 1042 : Enable Urgency window manager hint when Control-G is received, xterm. This enables the bellIsUrgent resource.
  • 1043 : Enable raising of the window when Control-G is received, xterm. This enables the popOnBell resource.
  • 1044 : Reuse the most recent data copied to CLIPBOARD, xterm. This enables the keepClipboard resource.
  • 1050 : Set terminfo/termcap function-key mode, xterm.
  • 1051 : Set Sun function-key mode, xterm.
  • 1052 : Set HP function-key mode, xterm.
  • 1053 : Set SCO function-key mode, xterm.
  • 1060 : Set legacy keyboard emulation, i.e, X11R6, xterm.
  • 1061 : Set VT220 keyboard emulation, xterm.
# Resources:
; xterm/CSI/DECPM/h ; xterm/CSI/DECPM/l ; microsoft/console-virtual-terminal-sequences/cursor-visibility ; microsoft/console-virtual-terminal-sequences/mode-changes ; microsoft/console-virtual-terminal-sequences/alternate-screen-buffer ; microsoft/console-virtual-terminal-sequences/window-width
@__DECPM_GATE__(CSI.new_nul)
staticmethod high(mode) -> CSI
CSI ? { mode } h
@__DECPM_GATE__(CSI.new_nul)
staticmethod low(mode) -> CSI
CSI ? { mode } l

staticmethod reply_cache(mode) -> int | None

Query a reply value for mode from the __ReplyCache__. Returns the reply value or None.
Handler

class decpm.DECPMHandler

Handler for DEC private modes.

mode: int

__init__(mode, atexit=None)

Create a handler for DEC Private mode. See DECPrivateMode for a list of mode numbers.

For registering the corresponding output on stdout when exiting the Python interpreter, atexit can be "h" or "l"; if None is chosen, the registration is omitted.

high() -> CSI

CSI ? { mode } h

highout() -> None

Output "CSI ? { mode } h" to stdout, then flush stdout.

low() -> CSI

CSI ? { mode } l

lowout() -> None

"CSI ? { mode } l" to stdout, then flush stdout.
Date: 07 Nov 2022
Version: 0.1
Author: Adrian Hoefflin [srccircumflex]
Doc-Generator: "pyiStructure-RSTGenerator" <prototype>
↑ Up
VT-Python-Logo.png

Clone this wiki locally