wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-11-30 14:49:26 +03:00
Code Issues Projects Releases Wiki Activity
cdd0735357
wezterm/termwiz
History
Wez Furlong 1a883a40e9 use vte with larger OSC buffer support 
I wanted to see how much work remains to enable iterm2 image
display; one of the blockers was a limit in the size of the
buffer in the vte crate, which has been removed in my fork
of vte.

As part of testing our ability to absorb that data, I found
a couple of issues with applying the image cells to the display,
so this commit also takes care of that.

We still don't have code to connect the cell image data to the
opengl render layer.
2019-03-22 20:41:50 -07:00
..
data restructure termwiz tree prior to merging into wezterm repo 2018-08-05 07:55:30 -07:00
examples restructure termwiz tree prior to merging into wezterm repo 2018-08-05 07:55:30 -07:00
src implement coarse tab data rpc PoC 2019-03-22 20:41:50 -07:00
Cargo.toml use vte with larger OSC buffer support 2019-03-22 20:41:50 -07:00
LICENSE.md restructure termwiz tree prior to merging into wezterm repo 2018-08-05 07:55:30 -07:00
README.md tweak manifest to point to in-tree termwiz 2018-08-05 08:00:45 -07:00

README.md

Terminal Wizardry

This is a rust crate that provides a number of support functions for applications interesting in either displaying data to a terminal or in building a terminal emulator.

It is currently in active development and subject to fairly wild sweeping changes.

Included functionality:

  • Surface models a terminal display and its component Cells
  • Terminal attributes are aware of modern features such as True Color, Hyperlinks and will also support sixel and iterm style terminal graphics display.
  • Surfaces include a log of Changes and an API for consuming and applying deltas. This is a powerful building block for synchronizing screen instances.
  • Escape sequence parser decodes inscrutable escape sequences and gives them semantic meaning, making the code that uses them clearer. The decoded escapes can be re-encoded, allowing applications to start with the semantic meaning and emit the appropriate escape sequence without embedding obscure binary bytes.
  • Capabilities allows probing for terminal capabilities that may not be included in the system terminfo database, and overriding them in an embedding application.
  • Terminal trait provides an abstraction over unix style ttys and Windows style console APIs. Changes from Surface can be rendered to Terminals. Terminals allow decoding mouse and keyboard inputs in both blocking or non-blocking mode.
  • Widget trait allows composition of UI elements at a higher level.

Documentation

Until this goes up on crates.io, run:

$ cargo doc --open

to build and browse the docs locally.

TODO

  • Load key mapping information from terminfo
  • Look at unicode width and graphemes for cells
  • ensure that sgr is reset to default on drop
  • Option to use alt screen when going raw
  • Mouse reporting mode (and restore on drop)
  • Bracketed paste mode (and restore on drop)

Windows

Testing via Wine:

sudo apt install gcc-mingw-w64-x86-64
rustup target add x86_64-pc-windows-gnu
cargo build --target=x86_64-pc-windows-gnu  --example hello

Then, from an X session of some kind:

wineconsole cmd.exe

and from there you can launch the generated .exe files; they are found under target/x86_64-pc-windows-gnu/debug