Janet 1.38.0-73334f3 Documentation
(Other Versions: 1.37.1 1.36.0 1.35.0 1.34.0 1.31.0 1.29.1 1.28.0 1.27.0 1.26.0 1.25.1 1.24.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.1 1.17.1 1.16.1 1.15.0 1.13.1 1.12.2 1.11.1 1.10.1 1.9.1 1.8.1 1.7.0 1.6.0 1.5.1 1.5.0 1.4.0 1.3.1 )

Raw Terminal Functionality

Index

rawterm/begin rawterm/buffer-traverse rawterm/ctrl-z rawterm/end rawterm/getch rawterm/isatty rawterm/monowidth rawterm/rune-monowidth rawterm/size rawterm/slice-monowidth


rawterm/begin cfunction source

(rawterm/begin &opt on-winch)

Begin raw terminal functionality. Return a stream that can be read from to get input.


rawterm/buffer-traverse cfunction source

(rawterm/buffer-traverse bytes index delta &opt skip-zerowidth)

Move to a new position in a buffer from index by incrementing by delta codepoints. Can also skip zero-width codepoints if desired.


rawterm/ctrl-z cfunction source

(rawterm/ctrl-z)

A handler that a user can use to handle ctrl-z from input to suspend the current process.


rawterm/end cfunction source

(rawterm/end)

End raw terminal functionality.


rawterm/getch cfunction source

(rawterm/getch &opt into)

Get a byte of input from stdin, without blocking if possible. Returns a buffer.


rawterm/isatty cfunction source

(rawterm/isatty)

Check if the current stdin is a tty.


rawterm/monowidth cfunction source

(rawterm/monowidth bytes &opt start-index end-index)

Measure the monospace width of a string.


rawterm/rune-monowidth cfunction source

(rawterm/rune-monowidth rune)

Get the monospace width of a rune. Returns either 0, 1, or 2.


rawterm/size cfunction source

(rawterm/size)

Get the number of rows and columns visible in the terminal as tuple [rows cols]


rawterm/slice-monowidth cfunction source

(rawterm/slice-monowidth bytes columns &opt start-index into)

Get a byte slice that will fit into a number of columns.