C++ API reference

Deleted for an rvalue string only: an lvalue string converts as before, and so does a literal.

A relation predicate has to reach the related rows without running tmux, so the caller lists both kinds once and links them here. The result borrows the rows it was given, exactly as a filtered view does, so it must not outlive the listing it reads.

current_environment copies this process's; set_environment replaces any existing entry rather than appending; erase_environment removes every entry for the name.

Escaping only ever lengthens, so the decoded bytes fit where the encoded ones were: the write cursor never overtakes the read cursor, nothing moves, and nothing is allocated. Answers the decoded length.

An escape marker followed by anything else is left as written. Output this library asked for contains no such sequence, and failing on one would mean a recording could not carry a literal ␛.

The two substitutions nest rather than run in sequence, because tmux applies the inner one to the raw value and the outer one to its result. In that order a value already holding the escape marker is neutralised before the separator pass can produce one; reversed, the two become indistinguishable.

#{s/…/…/:…} predates every tmux this library supports, and neither character is a regular-expression metacharacter.

Unconditional, rather than applied only to the fields that could carry a separator. Expanding the substitutions costs about 0.32us per row — a 61-row listing pays 19us, against a process launch of some milliseconds — and a per-field exemption list is a thing to get wrong later, once, silently.

x is an id by this test and no pane by tmux's, and both are right: it carries no separator, so composing it can only produce the caller's own mistake back.

-- is part of the fragment rather than something a caller appends, because text beginning with a dash is read as another send-keys option without it and that is not a mistake worth making twice. It was made twice: this returned the flag and the text alone, Pane::send_text inserted the separator afterwards, and Chain::send_text did not — so the same text through the two spellings reached tmux as two different commands.

An empty name reaches here only from a key that carried no separator at all; a key ending in one is refused before this is asked.

Groups and negations are bracketed by begin/end so a sink never has to count operands itself.

The value is taken verbatim after the first =, so a value containing = or __ survives unchanged; only the key is split.

Returns nullopt for a blank line so callers can feed raw output straight in.

Ids skip validation because they contain no separator by construction.

A tmux that cannot be run or whose version cannot be parsed reports as the newest possible version, so version-gated tests run and fail rather than silently skipping.

Defined in a header this package does not install.

The trailing separator emitted by format_request produces one empty tail element, which is dropped; a short or long row is reported rather than padded so a format-name typo cannot masquerade as an empty field.

These read the three shapes it uses, and answer zero, false or the epoch for a value it did not render — which within the supported version range means tmux had nothing to say, not that the token was unknown.

tmux picks one of four forms, and a reader that knows only one corrupts the rest: 'for an empty value; double quotes when the value contains any of #';${}; single quotes when it contains a double quote; and otherwise no quotes at all. Inside any of them the body is escaped the wayvisdoes it —\t,\n,\\,\ooo` for a byte with no printable form — and a leading tilde is escaped whether or not anything else is.

This is the inverse of tmux's own args_escape, so a value read here and written back is the value that was there.

The name is not escaped: a name is chosen by the caller from tmux's format vocabulary, not built from data.