History

James Bardin daa2b78a9c need to add the files too		9 years ago
..
winterm	need to add the files too	9 years ago
LICENSE	need to add the files too	9 years ago
README.md	need to add the files too	9 years ago
constants.go	need to add the files too	9 years ago
context.go	need to add the files too	9 years ago
csi_entry_state.go	need to add the files too	9 years ago
csi_param_state.go	need to add the files too	9 years ago
escape_intermediate_state.go	need to add the files too	9 years ago
escape_state.go	need to add the files too	9 years ago
event_handler.go	need to add the files too	9 years ago
ground_state.go	need to add the files too	9 years ago
osc_string_state.go	need to add the files too	9 years ago
parser.go	need to add the files too	9 years ago
parser_action_helpers.go	need to add the files too	9 years ago
parser_actions.go	need to add the files too	9 years ago
states.go	need to add the files too	9 years ago
utilities.go	need to add the files too	9 years ago

README.md

go-ansiterm

This is a cross platform Ansi Terminal Emulation library. It reads a stream of Ansi characters and produces the appropriate function calls. The results of the function calls are platform dependent.

For example the parser might receive "ESC, [, A" as a stream of three characters. This is the code for Cursor Up (http://www.vt100.net/docs/vt510-rm/CUU). The parser then calls the cursor up function (CUU()) on an event handler. The event handler determines what platform specific work must be done to cause the cursor to move up one position.

The parser (parser.go) is a partial implementation of this state machine (http://vt100.net/emu/vt500_parser.png). There are also two event handler implementations, one for tests (test_event_handler.go) to validate that the expected events are being produced and called, the other is a Windows implementation (winterm/win_event_handler.go).

See parser_test.go for examples exercising the state machine and generating appropriate function calls.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.