wezterm/termwiz/Cargo.toml

[package]
authors = ["Wez Furlong"]
name = "termwiz"
version = "0.22.0"
edition = "2018"
repository = "https://github.com/wez/wezterm"
description = "Terminal Wizardry for Unix and Windows"
license = "MIT"
documentation = "https://docs.rs/termwiz"
keywords = ["terminal", "readline", "console", "curses"]
readme = "README.md"

[dependencies]
# backtrace = "0.3"
base64 = "0.21"
bitflags = "2.0"
cassowary = {version="0.3", optional=true}
anyhow = "1.0"
filedescriptor = { version="0.8", path = "../filedescriptor" }
finl_unicode = "1.2"
fixedbitset = "0.4"
fnv = {version="1.0", optional=true}
hex = "0.4"
# we want image 0.24.6 or later. see https://github.com/wez/wezterm/issues/3250
image = {version="0.24", git="https://github.com/image-rs/image.git", rev="fe069785ae245a2c510fd724ef96da283b05a236", optional=true}
lazy_static = "1.4"
libc = "0.2"
log = "0.4"
memmem = "0.1"
num-traits = "0.2"
ordered-float = "3.0"
pest = "2.1"
pest_derive = "2.1"
phf = "0.11"
regex = "1"
semver = "0.11"
serde = {version="1.0", features = ["rc", "derive"], optional=true}
siphasher = "0.3"
sha2 = "0.10"
tempfile = "3.4"
terminfo = "0.8"
thiserror = "1.0"
unicode-segmentation = "1.8"
ucd-trie = "0.1"
vtparse = { version="0.6.2", path="../vtparse" }
wezterm-bidi = { path = "../bidi", version="0.2.1" }
wezterm-blob-leases = { path = "../wezterm-blob-leases", version="0.1" }
wezterm-color-types = { path = "../color-types", version="0.2" }
wezterm-dynamic = { path = "../wezterm-dynamic", version="0.1" }

[features]
widgets = ["cassowary", "fnv"]
use_serde = ["serde", "wezterm-color-types/use_serde", "wezterm-blob-leases/serde"]
use_image = ["image"]
docs = ["widgets", "use_serde"]

[dev-dependencies]
criterion = "0.3"
varbincode = "0.1"
k9 = "0.11"
env_logger = "0.10"

[dependencies.num-derive]
features = ["full-syntax"]
version = "0.3"

[target."cfg(unix)".dependencies]
signal-hook = "0.1"
termios = "0.3"
nix = "0.26"

[target."cfg(windows)".dependencies.winapi]
features = [
    "winbase",
    "winerror",
    "winnls",
    "winuser",
    "consoleapi",
    "handleapi",
    "fileapi",
    "synchapi",
    "memoryapi",
    "winnt",
    "impl-default"
]
version = "0.3.9"

[package.metadata.docs.rs]
features = ["docs"]
rustdoc-args = ["--cfg", "feature=\"docs\""]

[[bench]]
name = "wcwidth"
harness = false

[[bench]]
name = "cell"
harness = false
start building out the terminal model This is influenced by my code in wezterm 2018-07-12 17:26:37 +03:00			`[package]`
add some structs for holding image data 2018-08-07 07:54:17 +03:00			`authors = ["Wez Furlong"]`
start building out the terminal model This is influenced by my code in wezterm 2018-07-12 17:26:37 +03:00			`name = "termwiz"`
fixup images with the multiplexer * Translate from File to EncodedFile as needed * Adopt blob leases in the mux server * Fix an issue where the first image sent by the mux server would be replaced on the client by its background image, if configured. Removed the ImageData::id field to resolve this: you should use the hash field instead to identify and disambiguate images. Bumped the termwiz API version because this is conceptually a breaking change to the API refs: https://github.com/wez/wezterm/issues/3343 2023-03-24 07:40:01 +03:00			`version = "0.22.0"`
update termwiz to 2018 edition 2019-02-19 10:26:41 +03:00			`edition = "2018"`
termwiz: prep for publishing on crates.io 2019-05-28 05:51:10 +03:00			`repository = "https://github.com/wez/wezterm"`
			`description = "Terminal Wizardry for Unix and Windows"`
			`license = "MIT"`
			`documentation = "https://docs.rs/termwiz"`
add keywords 2019-05-28 05:57:44 +03:00			`keywords = ["terminal", "readline", "console", "curses"]`
bump some deps 2019-05-28 06:08:02 +03:00			`readme = "README.md"`
start building out the terminal model This is influenced by my code in wezterm 2018-07-12 17:26:37 +03:00
			`[dependencies]`
termwiz: avoid cluster -> vec conversions in a few more cases This reduces the resident memory by another ~10% because it avoids keeping as many runs of whitespace. Runtime for `time cat enwiki8.wiki` is still ~11-12s, resident: 530K refs: https://github.com/wez/wezterm/issues/1626 2022-07-24 17:57:33 +03:00			`# backtrace = "0.3"`
update base64, work around another batch of breaking API changes closes: https://github.com/wez/wezterm/pull/2931 2023-01-09 04:49:45 +03:00			`base64 = "0.21"`
fix: Update bitflags to 2.0 and fix compilation errors - v2.0 no longer derives a bunch of traits (Debug, Clone, Copy, PartialEq, Eq) by default, so I manually derived them. - It also changed the snapshot results so I updated them: An empty bitflags struct is no longer displayed as `None` but as `BitFlags(0x0)`. - `bits` is no longer a field but a method so I added the missing parenthesis. 2023-03-27 07:51:30 +03:00			`bitflags = "2.0"`
prep termwiz for a new release Make the widgets portion a feature that can be disabled 2020-01-10 08:52:47 +03:00			`cassowary = {version="0.3", optional=true}`
failure -> anyhow + thiserror 2019-12-15 08:43:05 +03:00			`anyhow = "1.0"`
filedescriptor: remove anyhow from public interface Use thiserror instead 2021-05-24 00:24:01 +03:00			`filedescriptor = { version="0.8", path = "../filedescriptor" }`
deps: upgrade finl_unicode to 1.2 2022-10-23 22:07:00 +03:00			`finl_unicode = "1.2"`
termwiz: add clustered line storage for line Adds the option to use an alternative clusted line storage for the cells component of the line. This structure is not optimal for mutation, but is better structured for: * matching/extracting textual content * using less memory than the prior simple vector For some contrast: the line "hello" occupies 5 Cells in the cell based storage; that 5 discrete Cells each with their own tiny string and a copy of their attributes. The clustered version of the line stores one copy of the cell attributes, the string "hello" and some small (almost constant size) overhead for some metadata. For simple lines of ascii text, the clustered version is smaller as there are fewer copies of the cell attributes. Over the span of a large scrollback and typical terminal display composition, this saving is anticipated to be significant. The clustered version is also cheaper to search as it doesn't require building a copy of the search text for each line (provided the line is already in clustered form). This commit introduces the capability: none of the internals request the new form yet, and there are likely a few call sites that need to be tweaked to avoid coersion from clustered to vector form. 2022-07-23 21:51:55 +03:00			`fixedbitset = "0.4"`
prep termwiz for a new release Make the widgets portion a feature that can be disabled 2020-01-10 08:52:47 +03:00			`fnv = {version="1.0", optional=true}`
termwiz: recognize the XTGETTCAP DCS sequence Parse and respond to this sequence docs can be found https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h4-Device-Control-functions:DCS-plus-q-Pt-ST.F95 refs: https://github.com/wez/wezterm/issues/954 2021-07-25 07:02:54 +03:00			`hex = "0.4"`
improve handling of animated webp images Use mainline image crate to avoid an otherwise unavoidable panic in the upstream: https://github.com/image-rs/image/issues/1775 Explicitly operate on the frames from the animation. refs: https://github.com/wez/wezterm/issues/3250 2023-03-15 21:34:47 +03:00			`# we want image 0.24.6 or later. see https://github.com/wez/wezterm/issues/3250`
			`image = {version="0.24", git="https://github.com/image-rs/image.git", rev="fe069785ae245a2c510fd724ef96da283b05a236", optional=true}`
deps: normalize the lazy-static version 2020-11-13 18:57:09 +03:00			`lazy_static = "1.4"`
bump some deps 2019-05-28 06:08:02 +03:00			`libc = "0.2"`
more log 2019-06-09 01:37:55 +03:00			`log = "0.4"`
bump some deps 2019-05-28 06:08:02 +03:00			`memmem = "0.1"`
			`num-traits = "0.2"`
deps: ordered-float closes: https://github.com/wez/wezterm/pull/1946 2022-05-02 07:43:22 +03:00			`ordered-float = "3.0"`
move tmux-cc crate to be module inside termwiz refs: #1090 2022-01-17 23:43:35 +03:00			`pest = "2.1"`
			`pest_derive = "2.1"`
chore: Update phf to 0.11 2023-03-27 07:50:24 +03:00			`phf = "0.11"`
termwiz: bump regex to 1.0+ This makes termwiz (likely) use the same regex when being compiled together with other dependencies in the eco-system. 2020-02-04 18:52:23 +03:00			`regex = "1"`
deps: misc updates 2020-12-29 20:21:50 +03:00			`semver = "0.11"`
termwiz: make serde an optional dep closes: https://github.com/wez/wezterm/pull/186 2020-06-13 19:51:17 +03:00			`serde = {version="1.0", features = ["rc", "derive"], optional=true}`
Adjust render caching; switch to LFU caches from LRU 2022-08-28 20:27:50 +03:00			`siphasher = "0.3"`
deps: update sha2 closes: https://github.com/wez/wezterm/pull/3379 2023-03-27 05:50:53 +03:00			`sha2 = "0.10"`
Image decoding is now done in a bg thread Continuing from the previous commit, this shifts: * In-memory data -> temporary file * Image decoding -> background thread The background thread asynchronously decodes frames and sends them to the render thread via a bounded channel. While decoding frames, it writes them, uncompressed, to a scratch file so that when the animation loops, it is a very cheap operation to rewind and pull that data from the file, without having to burn CPU to re-decode the data from the start. Memory usage is bounded to 4 uncompressed frames while decoding, then 3 uncompressed frames (triple buffered) while looping over the rest. However, disk usage is N uncompressed frames. refs: https://github.com/wez/wezterm/issues/3263 2023-03-17 21:11:46 +03:00			`tempfile = "3.4"`
update terminfo to 0.8 2023-03-24 20:12:49 +03:00			`terminfo = "0.8"`
termwiz: Remove anyhow::Result from public API It's been replaced with an opaque termwiz error type instead. This is a bit of a more conservative approach than that in (refs: #407) and has less of an impact on the surrounding code, which appeals to me from a maintenance perspective. refs: #406 refs: #407 2021-01-08 11:21:54 +03:00			`thiserror = "1.0"`
deps: update unicode-segmentation to 1.8 2021-08-12 07:56:30 +03:00			`unicode-segmentation = "1.8"`
termwiz: improve performance of emoji presentation lookup 2021-08-12 00:26:57 +03:00			`ucd-trie = "0.1"`
termwiz: ensure ST sequence is grouped with OSC When `parse_first_as_vec` is parsing an OSC sequence (e.g. `SetHyperlink`) that is terminated by the escaped form of ST (`ESC \`), ensure that the ST sequence is included in the returned vector. This is achieved by ensuring the VTParser has returned to the "ground" state: i.e. the stored state after the `ESC` is processed is not enough for `parse_first_as_vec` to terminate. We must also parse the `\` to ensure that we return a complete span to the caller. Fixes https://github.com/markbt/streampager/issues/57 2022-08-01 23:29:19 +03:00			`vtparse = { version="0.6.2", path="../vtparse" }`
termwiz: prepare for a 0.18.0 release 2022-09-22 05:20:26 +03:00			`wezterm-bidi = { path = "../bidi", version="0.2.1" }`
ImageDataType::File -> EncodedLease Adopt the new blob lease layer to storing and referencing image files. This reduces the number of open files needed when images are being displayed in the terminal. refs: https://github.com/wez/wezterm/issues/3263 2023-03-19 06:32:49 +03:00			`wezterm-blob-leases = { path = "../wezterm-blob-leases", version="0.1" }`
color types version bump for crates.io 2022-08-02 04:41:52 +03:00			`wezterm-color-types = { path = "../color-types", version="0.2" }`
			`wezterm-dynamic = { path = "../wezterm-dynamic", version="0.1" }`
Add a parser for terminal input This includes a trie structure for dealing with the keymap lookups. 2018-07-24 00:49:15 +03:00
prep termwiz for a new release Make the widgets portion a feature that can be disabled 2020-01-10 08:52:47 +03:00			`[features]`
			`widgets = ["cassowary", "fnv"]`
ImageDataType::File -> EncodedLease Adopt the new blob lease layer to storing and referencing image files. This reduces the number of open files needed when images are being displayed in the terminal. refs: https://github.com/wez/wezterm/issues/3263 2023-03-19 06:32:49 +03:00			`use_serde = ["serde", "wezterm-color-types/use_serde", "wezterm-blob-leases/serde"]`
move image decoding into termwiz Adds a use_image feature to termwiz that enables an optional dep on the image crate. This in turn allows decoding of animation formats (gif, apng) from file data, but more crucially, allows modeling animation frames at the termwiz layer, which is a pre-req for enabling kitty img protocol animation support. refs: #986 2021-08-03 02:22:55 +03:00			`use_image = ["image"]`
Instruct docs.rs to build with widgets and serde features (#409) 2020-12-30 20:25:54 +03:00			`docs = ["widgets", "use_serde"]`
prep termwiz for a new release Make the widgets portion a feature that can be disabled 2020-01-10 08:52:47 +03:00
Enable serializing various Line and Cell related structs 2019-03-14 17:58:48 +03:00			`[dev-dependencies]`
termwiz: add criterion benches for wcwidth 2022-04-30 01:14:02 +03:00			`criterion = "0.3"`
moved varbincode to its own repo 2019-05-28 05:44:55 +03:00			`varbincode = "0.1"`
deps: replace pretty_assertions dep with k9 2022-05-05 04:51:51 +03:00			`k9 = "0.11"`
env_logger -> 0.10 closes: https://github.com/wez/wezterm/pull/2803 2022-11-28 07:37:25 +03:00			`env_logger = "0.10"`
Enable serializing various Line and Cell related structs 2019-03-14 17:58:48 +03:00
Add a parser for terminal input This includes a trie structure for dealing with the keymap lookups. 2018-07-24 00:49:15 +03:00			`[dependencies.num-derive]`
			`features = ["full-syntax"]`
deps: misc updates 2020-12-29 20:21:50 +03:00			`version = "0.3"`

add some structs for holding image data 2018-08-07 07:54:17 +03:00			`[target."cfg(unix)".dependencies]`
bump some deps 2019-05-28 06:08:02 +03:00			`signal-hook = "0.1"`
			`termios = "0.3"`
chore: Update nix to 0.26 2023-03-27 07:57:21 +03:00			`nix = "0.26"`
deps: nix -> 0.24 2022-05-05 04:55:56 +03:00
add some structs for holding image data 2018-08-07 07:54:17 +03:00			`[target."cfg(windows)".dependencies.winapi]`
			`features = [`
add terminal wakers Terminal wakers allow other threads to wake the main terminal processing thread. 2019-04-28 19:31:35 +03:00			`"winbase",`
			`"winerror",`
termwiz: Windows: force CP_UTF8, fix alt-screen and examples We need to force the codepage to UTF8 this to avoid having our UTF-8 bytestreams be misinterpreted, and to restore the original before we're done. refs: https://github.com/wez/wezterm/issues/1435 implement missing alt-screen support and fixup building the examples while we're in here. refs: #1244 2021-12-22 22:21:39 +03:00			`"winnls",`
add some structs for holding image data 2018-08-07 07:54:17 +03:00			`"winuser",`
			`"consoleapi",`
			`"handleapi",`
			`"fileapi",`
add terminal wakers Terminal wakers allow other threads to wake the main terminal processing thread. 2019-04-28 19:31:35 +03:00			`"synchapi",`
Added support for kitty images protocol using Shared Memory (#1810) * termwiz: add support for kitty image using shm mode * termwiz: kitty image shm cleanup error handling * termwiz: kitty image shm create wrapper for HANDLE and impl Drop for it * termwiz: kitty image shm refactor windows implementation Signed-off-by: Shreesh Adiga <16567adigashreesh@gmail.com> 2022-04-03 22:59:58 +03:00			`"memoryapi",`
			`"winnt",`
[termwiz] add impl-default feature to winapi dep to fix the build Without the feature the build fails with: --> src\escape\apc.rs:377:57 \| 377 \| let mut memory_info = MEMORY_BASIC_INFORMATION::default(); \| ^^^^^^^ function or associated item not found in `MEMORY_BASIC_INFORMATION` \| 2022-08-02 20:31:25 +03:00			`"impl-default"`
add some structs for holding image data 2018-08-07 07:54:17 +03:00			`]`
termwiz: fix min version dep on winapi. publish 0.17.1 Need at least 0.3.5 (I think) for the type used in https://github.com/wez/wezterm/pull/2349 as well as the impl-default feature. refs: https://github.com/markbt/streampager/issues/57#event-7110671310 2022-08-03 04:19:34 +03:00			`version = "0.3.9"`
Instruct docs.rs to build with widgets and serde features (#409) 2020-12-30 20:25:54 +03:00
			`[package.metadata.docs.rs]`
			`features = ["docs"]`
			`rustdoc-args = ["--cfg", "feature=\"docs\""]`
termwiz: add criterion benches for wcwidth 2022-04-30 01:14:02 +03:00
			`[[bench]]`
			`name = "wcwidth"`
			`harness = false`
termwiz: add bench for Cell creation/drop 2022-04-30 23:01:55 +03:00
			`[[bench]]`
			`name = "cell"`
			`harness = false`