Module trial.terminal

Ignore coverage Module for interacting with the user's terminal, including color output, cursor manipulation, and full-featured real-time mouse and keyboard input. Also includes high-level convenience methods, like [Terminal.getline], which gives the user a line editor with history, completion, etc. See the [#examples].

The main interface for this module is the Terminal struct, which encapsulates the output functions and line-buffered input of the terminal, and RealTimeConsoleInput, which gives real time input.

Creating an instance of these structs will perform console initialization. When the struct goes out of scope, any changes in console settings will be automatically reverted.

Note

on Posix, it traps SIGINT and translates it into an input event. You should keep your event loop moving and keep an eye open for this to exit cleanly; simply break your event loop upon receiving a UserInterruptionEvent. (Without the signal handler, ctrl+c can leave your terminal in a bizarre state.)

As a user, if you have to forcibly kill your program and the event doesn't work, there's still ctrl+\

On Mac Terminal btw, a lot of hacks are needed and mouse support doesn't work. Most functions basically work now though.

Future Roadmap

* The CharacterEvent and NonCharacterKeyEvent types will be removed. Instead, use KeyboardEvent on new programs. * The ScrollbackBuffer will be expanded to be easier to use to partition your screen. It might even handle input events of some sort. Its API may change. * getline I want to be really easy to use both for code and end users. It will need multi-line support eventually. * I might add an expandable event loop and base level widget classes. This may be Linux-specific in places and may overlap with similar functionality in simpledisplay.d. If I can pull it off without a third module, I want them to be compatible with each other too so the two modules can be combined easily. (Currently, they are both compatible with my eventloop.d and can be easily combined through it, but that is a third module.) * More advanced terminal features as functions, where available, like cursor changing and full-color functions. * The module will eventually be renamed to arsd.terminal. * More documentation.

WHAT I WON'T DO: * support everything under the sun. If it isn't default-installed on an OS I or significant number of other people might actually use, and isn't written by me, I don't really care about it. This means the only supported terminals are: * xterm (and decently xterm compatible emulators like Konsole) * Windows console * rxvt (to a lesser extent) * Linux console * My terminal emulator family of applications https://github.com/adamdruppe/terminal-emulator Anything else is cool if it does work, but I don't want to go out of my way for it. * Use other libraries, unless strictly optional. terminal.d is a stand-alone module by default and always will be. * Do a full TUI widget set. I might do some basics and lay a little groundwork, but a full TUI is outside the scope of this module (unless I can do it really small.)

Classes

NameDescription
FileLineGetter This is a line getter that customizes the tab completion to fill in file names separated by spaces, like a command line thing.
LineGetter

Structs

NameDescription
CharacterEvent
EndOfFileEvent Sent upon receiving end-of-file from stdin.
HangupEvent If the user hangs up (for example, closes the terminal emulator without exiting the app), this is sent. If you receive it, you should generally cleanly exit.
InputEvent [RealTimeConsoleInput.nextEvent] returns one of these. Check the type, then use the [InputEvent.get|get] method to get the more detailed information about the event.
KeyboardEvent The new style of keyboard event
MouseEvent .
NonCharacterKeyEvent
PasteEvent .
RealTimeConsoleInput Encapsulates the stream of input events received from the terminal input.
RGB Represents a 24-bit color.
SizeChangedEvent When you get this, check terminal.width and terminal.height to see the new size and react accordingly.
Terminal Encapsulates the I/O capabilities of a terminal.
UserInterruptionEvent the user hitting ctrl+c will send this You should drop what you're doing and perhaps exit when this happens.

Enums

NameDescription
Color Defines the list of standard colors understood by Terminal.
ConsoleInputFlags When capturing input, what events are you interested in?
ConsoleOutputType Defines how terminal output should be handled.
ForceOption Some methods will try not to send unnecessary commands to the screen. You can override their judgement using a ForceOption parameter, if present
ModifierState

Templates

NameDescription
LineGetterConstructors Adds default constructors that just forward to the superclass

Global variables

NameTypeDescription
hangedUp bool similar to interrupted.
hangedUp bool similar to interrupted.
interrupted bool you might periodically check this in a long operation and abort if it is set. Remember it is volatile. It is also sent through the input event loop via RealTimeConsoleInput
interrupted bool you might periodically check this in a long operation and abort if it is set. Remember it is volatile. It is also sent through the input event loop via RealTimeConsoleInput