1.164.3 Get methods

terminal_image <-pty_name: -> name*

Path of the pseudo-terminal device, or @nil when not connected to one.

terminal_image <-foreground_process: -> int

Process group of another session that owns the pty, i.e. of the process running in the terminal. Fails if there is none, which is the case while the terminal is driven by a thread of this process. While it succeeds the control keys are passed to that process rather than looked up in terminal_image<-bindings. Unix only.

terminal_image <-displayed_cursor: -> cursor

Cursor reflecting whether the pointer is on text or over a link.

terminal_image <-selected: -> string

New string with the contents of the selection.

terminal_image <-cursor_position: -> point

Logical cursor position as point(col, row).

terminal_image <-row: int -> string

Text contents of a visible row, 0-based from the top.

terminal_image <-link: point|event -> name

Hyperlink URL at the given position or under an event.

terminal_image <-find: from=int, for=string, times=[int], return=[{start,end}], exact_case=[bool], word=[bool] -> int

Search the buffer, as text_buffer<-find does and with the same defaults: case sensitive, ignoring word boundaries, and -- note -- reporting the end of a match going forwards and its start going back. A negative times searches backwards. from outside the buffer is clamped to the nearest end. Fails if there is no match.

Unlike text_buffer<-find, a repeat starts one character past the match it found, so times greater than one reaches the hits after the first.

terminal_image <-length: -> int

Number of characters in the buffer.

terminal_image <-contents: from=[int], size=[int] -> string

Text of the buffer from from.

terminal_image <-block: id=int -> terminal_block

The block with this terminal_image<-id, or fail if it has scrolled out of the buffer.

terminal_image <-block_at: at=int|point|event -> terminal_block

The block holding a character index, or the one at a position given as pixels or taken from an event. Fails outside every block.

terminal_image <-fold_at: at=point|event -> terminal_block

The block whose fold marker is at this position, i.e. fails unless the position is in the left margin beside a command whose output can be hidden. What tells a click or a popup on the marker from one on the text.

terminal_image <-cell_style: column=int, row=int -> style

The style painted over the cell at column of the visible row: the selection, the hit of an incremental search, one of its other matches, or the hyperlink under it. Fails when the cell is drawn from its own attributes, which is to say from the colours and the bold or underline the client asked for.

This goes through the very computation the painter uses, so it is not a second opinion about what should be drawn. It says nothing about what has actually been drawn yet: a cell whose line has not been repainted since still shows what it showed before.

terminal_image <-cwidth: code=int -> int

Number of columns the code point code occupies when drawn in terminal_image<-font: 0 for combining marks, 2 for wide characters and 1 for the rest. This is the classification the renderer itself uses, so clients that must predict our layout can share it rather than keep a second copy that drifts. In particular it accounts for symbol and emoji code points that the static Unicode tables call width 1 while an emoji-presenting font draws them twice as wide. Fails while the terminal has no cell metrics yet.