Terminal

Terminal Struct This struct represents a terminal buffer and a set of functions to manipulate it under the defined i/o descriptors.

struct Terminal {

enum OutputType;

this(OutputType outType, int outputDescriptor, int inputDescriptor);

void terminate();

void enableRawMode();

void viewCursor(bool val, bool flush);

void alternateScreen(bool val, bool flush);

void disableRawMode(bool flush);

void clear(bool flush);

void setCursorPos(int x, int y, bool flush);

void moveXPos(int val, bool flush);

void moveYPos(int val, bool flush);

void writeBuffer(char[] buf);

void writeBuffer(dchar ch);

void writeBuffer(string str);

void writeDescriptor(string str);

void flushBuffer();

void writeDescriptor(const(char*) cstr, size_t len);

size_t readCh(dchar c);

string readBuffer();

int getWindowSize(int rows, int cols);

int getCursorPosition(int rows, int cols);

bool isRawMode [@property getter];

void setTitle(string title);

Event pollEvents();

bool keyHit();

static bool terminalInFamily(string[] terms);

static bool isMacTerminal();

enum EventFlag;

}

Constructors

this this(): Undocumented in source.
this this(OutputType outType, int outputDescriptor, int inputDescriptor): Constructor for Terminal This construct a terminal buffer with the specified output type and i/o descriptors @param outType Output Type @param outputDescriptor Output descriptor @param inputDescriptor Input descriptor

Destructor

~this ~this(): Destructor for Terminal

Postblit

this(this) this(this): Undocumented in source.

Members

Enums

EventFlag enum EventFlag: Undocumented in source.
OutputType enum OutputType: Terminal Output Type Enumerates the terminal output type

Functions

alternateScreen void alternateScreen(bool val, bool flush): Undocumented in source. Be warned that the author may not have intended to support it.
clear void clear(bool flush): Undocumented in source. Be warned that the author may not have intended to support it.
disableRawMode void disableRawMode(bool flush): Undocumented in source. Be warned that the author may not have intended to support it.
enableRawMode void enableRawMode(): Undocumented in source. Be warned that the author may not have intended to support it.
flushBuffer void flushBuffer(): Undocumented in source. Be warned that the author may not have intended to support it.
getCursorPosition int getCursorPosition(int rows, int cols): Undocumented in source. Be warned that the author may not have intended to support it.
getWindowSize int getWindowSize(int rows, int cols): Undocumented in source. Be warned that the author may not have intended to support it.
keyHit bool keyHit(): Undocumented in source. Be warned that the author may not have intended to support it.
moveXPos void moveXPos(int val, bool flush): Undocumented in source. Be warned that the author may not have intended to support it.
moveYPos void moveYPos(int val, bool flush): Undocumented in source. Be warned that the author may not have intended to support it.
pollEvents Event pollEvents(): Undocumented in source. Be warned that the author may not have intended to support it.
readBuffer string readBuffer(): Undocumented in source. Be warned that the author may not have intended to support it.
readCh size_t readCh(dchar c): Undocumented in source. Be warned that the author may not have intended to support it.
setCursorPos void setCursorPos(int x, int y, bool flush): Undocumented in source. Be warned that the author may not have intended to support it.
setTitle void setTitle(string title): Undocumented in source. Be warned that the author may not have intended to support it.
terminate void terminate(): Terminate terminal mode
viewCursor void viewCursor(bool val, bool flush): Undocumented in source. Be warned that the author may not have intended to support it.
writeBuffer void writeBuffer(char[] buf): Undocumented in source. Be warned that the author may not have intended to support it.
writeBuffer void writeBuffer(dchar ch): Undocumented in source. Be warned that the author may not have intended to support it.
writeBuffer void writeBuffer(string str): Undocumented in source. Be warned that the author may not have intended to support it.
writeDescriptor void writeDescriptor(string str): Undocumented in source. Be warned that the author may not have intended to support it.
writeDescriptor void writeDescriptor(const(char*) cstr, size_t len): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

isRawMode bool isRawMode [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

isMacTerminal bool isMacTerminal(): Undocumented in source. Be warned that the author may not have intended to support it.
terminalInFamily bool terminalInFamily(string[] terms): Undocumented in source. Be warned that the author may not have intended to support it.

Structs

Event struct Event: Undocumented in source.
Input struct Input: Undocumented in source.

Variables

input Input input;: Undocumented in source.

Meta

Source

See Implementation

aurorafw cli terminal terminal classes

TerminalDieException

structs

Terminal