terminal.lua

• Index

Contents

• Functions

Modules

• terminal
• terminal.clear
• terminal.cursor
• terminal.cursor.position
• terminal.cursor.position.stack
• terminal.cursor.shape
• terminal.cursor.shape.stack
• terminal.cursor.visible
• terminal.cursor.visible.stack
• terminal.draw
• terminal.draw.line
• terminal.input
• terminal.input.keymap
• terminal.output
• terminal.progress
• terminal.scroll
• terminal.scroll.stack
• terminal.text
• terminal.text.color
• terminal.text.stack
• terminal.text.width
• terminal.utils

Classes

• Sequence
• Utf8edit
• cli.Prompt
• cli.Select

Topics

• 1. Introduction
• 2. Terminal handling
• CHANGELOG
• CONTRIBUTING
• MIT License

Examples

• async.lua
• colors.lua
• copas.lua
• cow.lua
• headers.lua
• keymap.lua
• progress.lua
• prompt.lua
• readline_old.lua
• sequence.lua
• testscreen.lua

Module terminal.text.stack

Terminal text-attribute stack module.

Manages a stack of text-attributes for terminal control.

Functions

apply ()	Re-applies the current attributes/colors (at the top of the stack), and writes it to the terminal.
apply_seq ()	Re-applies the current attributes/colors (at the top of the stack), returns the sequence without writing to the terminal.
pop ([n=1])	Pops n attributes/colors off the stack, and writes the last one to the terminal.
pop_seq ([n=1])	Pops n attributes/colors off the stack (and returns the last one), without writing it to the terminal.
push (attr)	Pushes the given attributes/colors onto the stack, and writes an ansi sequence to set the new attributes to the terminal.
push_seq (attr)	Pushes the given attributes/colors onto the stack, and returns an ansi sequence to set the new attributes without writing it to the terminal.

Functions

apply ()

Re-applies the current attributes/colors (at the top of the stack), and writes it to the terminal.

Returns:

true

apply_seq ()

Re-applies the current attributes/colors (at the top of the stack), returns the sequence without writing to the terminal.

Returns:

string ansi sequence to write to the terminal

pop ([n=1])

Pops n attributes/colors off the stack, and writes the last one to the terminal.

Parameters:

• n number number of attributes to pop (default 1)

Returns:

true

pop_seq ([n=1])

Pops n attributes/colors off the stack (and returns the last one), without writing it to the terminal.

Parameters:

• n number number of attributes to pop (default 1)

Returns:

string ansi sequence to write to the terminal

push (attr)

Pushes the given attributes/colors onto the stack, and writes an ansi sequence to set the new attributes to the terminal. Every element omitted in the attr table will be taken from the current top of the stack.

Parameters:

• attr table the attributes to set, see text.attrs for details.

Returns:

true

push_seq (attr)

Pushes the given attributes/colors onto the stack, and returns an ansi sequence to set the new attributes without writing it to the terminal. Every element omitted in the attr table will be taken from the current top of the stack.

Parameters:

• attr table the attributes to set, see text.attrs for details.

Returns:

string ansi sequence to write to the terminal