class Tput

• Tput
• Reference
• Object

Overview

Many Tput methods correspond to terminal sequences. Often times methods are named according to their purpose, and then aliased to the names of sequences used behind the scenes.

For example, method #delete_columns is directly implemented using sequence decdc. Therefore, it is also accessible under the alias #decdc.

Furthermore, for understanding the instructions on terminal sequences, the following names are important:

ESC - Sequence starting with ESC (\e)
CSI - Control Sequence Introducer: sequence starting with ESC [ (7bit) or CSI (\x9B, 8bit)
DCS - Device Control String: sequence starting with ESC P (7bit) or DCS (\x90, 8bit)
OSC - Operating System Command: sequence starting with ESC ] (7bit) or OSC (\x9D, 8bit)
C0: single byte command (7bit control codes, byte range \x00 .. \x1F, \x7F)
C1: single byte command (8bit control codes, byte range \x80 .. \x9F)

Some sequences accept arguments. Their naming and types correspond to those used in XTerm documentation:

Ps: A single (usually optional) numeric parameter, composed of one or more decimal digits.
Pm: A multiple numeric parameter composed of any number of single numeric parameters, separated by ";", e.g. ` Ps ; Ps ; … `.
Pt: A text parameter composed of printable characters.

In all of the examples above, spaces exist just for clarity and are not part of actual escape sequences. For example, in "ESC [" or " Ps ; Ps ;" there are no actual spaces.

Included Modules

• Crystallabs::Helpers::Logging
• JSON::Serializable
• Tput::ACSC
• Tput::Coordinates
• Tput::Input
• Tput::Namespace
• Tput::Output

Defined in:

Constant Summary

CSI7 = "\e["

CSI8 = "\x9B"

DCS7 = "\eP"

DCS8 = "\x90"

DEFAULT_SCREEN_SIZE = Size.new(80, 24)

ESC = "\e"

Log = ::Log.for((self.name.gsub("::", '.')).underscore)

OSC7 = "\e]"

OSC8 = "\x9D"

VERSION = "1.0.8"

Constructors

• .new(pull : JSON::PullParser)
• .new(terminfo : Nil | Unibilium::Terminfo = nil, input : IO = STDIN, output : IO = STDOUT.dup, error : IO = STDERR.dup, force_unicode = nil, use_buffer : Bool = true, screen_size = nil)

Instance Method Summary

• #_exiting=(_exiting : Bool)
• #_exiting? : Bool
• #_saved : Hash(String | Symbol | UInt64, Tput::Namespace::CursorState)
• #_saved=(_saved : Hash(String | Symbol | UInt64, Tput::Namespace::CursorState))
• #_title : String
• #cursor : Point
• #cursor_hidden? : Bool
• #emulator : Emulator
• #emulator? : Emulator | Nil
• #error : IO
• #error=(error : IO)
• #features : Features
• #features? : Features | Nil
• #force_unicode? : Bool
• #has?(&)
• #input : IO
• #input=(input : IO)
• #is_alt : Bool
• #name?(nam : String)
• #name?(*names)
• #output : IO
• #output=(output : IO)
• #pause(callback : Proc | Nil = nil)
• #put(&)

  Outputs a string capability to the designated @output, if the capability exists.

• #read_timeout : Time::Span

  Timeout when reading escape sequences.

• #resume
• #ret : IO | Nil
• #ret=(ret : IO | Nil)
• #saved_cursor : Point | Nil
• #screen : Size
• #scroll_bottom : Int32
• #scroll_top : Int32
• #shim : Unibilium::Terminfo::Shim | Nil
• #sigtstp(callback)
• #terminfo : Unibilium::Terminfo | Nil
• #use_buffer? : Bool

Constructor Detail

Instance Method Detail

put &.smcup?

put &.cursor_pos?(10, 20)