zed/crates/terminal
2022-08-09 17:15:52 -07:00
..
scripts Move terminal scripts to scripts folder, and remove parking_lot from terminal crate 2022-07-08 16:16:57 -07:00
src WIP compiling but failing with circular reference 2022-08-09 17:15:52 -07:00
Cargo.toml Checkpoint, not compiling 2022-08-04 10:16:26 -07:00
README.md Fixed cursor-over-大 bug 2022-08-03 14:17:25 -07:00

Design notes:

This crate is split into two conceptual halves:

  • The terminal.rs file and the src/mappings/ folder, these contain the code for interacting with Alacritty and maintaining the pty event loop. Some behavior in this file is constrained by terminal protocols and standards. The Zed init function is also placed here.
  • Everything else. These other files integrate the Terminal struct created in terminal.rs into the rest of GPUI. The main entry point for GPUI is the terminal_view.rs file and the modal.rs file.

Terminals are created externally, and so can fail in unexpected ways However, GPUI currently does not have an API for models than can fail to instantiate. TerminalBuilder solves this by using Rust's type system to split Terminal instantiation into a 2 step process: first attempt to create the file handles with TerminalBuilder::new(), check the result, then call TerminalBuilder::subscribe(cx) from within a model context. The TerminalView struct abstracts over failed and successful terminals, and provides a standardized way of instantiating an always-successful view of a terminal.