C++ workspace builder API

Edit this page on GitHub

workspace consumer 0.1.0-alpha.10 · Source

The workspace API described here belongs to the repository consumer. Its headers are available through the workspace_builder target and are not installed core library headers.

Typed descriptionLink to section

libtmux_consumers/workspace.hpp defines the libtmux::workspace namespace:

• Workspace holds the session name, directories, options, environment, and windows.
• Window holds layout, options, index, focus, and panes.
• Pane holds its shell, directory, environment, focus, and commands.
• Command controls text, Enter, delays, and history suppression.

build(const Server&, const Workspace&) returns libtmux::expected<libtmux::Session, BuildError>. BuildError contains a window index and reason. It does not contain a rollback result or guarantee that the server is unchanged.

YAML readerLink to section

libtmux_consumers/tmuxp.hpp declares parse_tmuxp(std::string_view), returning libtmux::expected<Workspace, ParseError>. ParseError.where identifies the configuration path and reason explains the refusal.

The compiled implementation in src/tmuxp.cpp is the part that depends on yaml-cpp. Applications constructing Workspace values directly do not need to parse YAML.

Core operationsLink to section

The returned session is a core libtmux value. Use the C++ core reference for subsequent inspection and mutation. Consumer source contracts remain the authority for the workspace types.

Workspace header; YAML header.