C++ workspace builder API

workspace consumer 0.1.0 · 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 description¶

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

• SWorkspace holds the session name, directories, options, environment, and windows.
• SWindow holds layout, options, index, focus, and panes.
• SPane holds its shell, directory, environment, focus, and commands.
• SCommand controls text, Enter, delays, and history suppression.

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

YAML reader¶

libtmux_consumers/tmuxp.hpp declares fparse_tmuxp(std::string_view), returning libtmux::expected<Workspace, ParseError>. aParseError.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 SWorkspace values directly do not need to parse YAML.

Core operations¶

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.