Files
tmux/cmd-select-layout.c
Michael Grant 64db144425 Update select-layout and list-windows to work with new layouts,
floating panes, and use a more modern serialization format.

  ## Serialization

  layout-custom.c now emits a canonical current format with:

  - Pane syntax: %pane-id,z-index:geometry[:flags]
  - Semicolons between child cells.
  - X-style geometry: WxH+X+Y
  - Every pane represented inside layout_root, including floating panes.
  - No legacy <...> floating-pane wrapper.
  - Z-index serialized for tiled and floating panes.
  - Flags:
      - f: floating
      - h: hidden
      - z: zoomed

  - Hidden panes use their saved restoration geometry.
  - Single-pane windows serialize as a pane root cell.

  window_layout and list-windows continue emitting a four-digit checksum.

  ## Geometry

  Current layouts accept:

  - +N: absolute positive offset
  - ++N: equivalent to +N
  - +-N: absolute negative offset
  - -N: right/bottom-relative offset for floating panes
  - Omitted offsets: +0+0
  - One offset: second defaults to +0

  Relative offsets are resolved immediately. Output always contains canonical absolute
  coordinates.

  Widths and heights are restricted to 1..PANE_MAXIMUM; offsets and resolved offsets are
  restricted to -PANE_MAXIMUM..PANE_MAXIMUM.

  ## Checksums and whitespace

  - The outer checksum is optional on input for current and legacy layouts.
  - If supplied, it must be correct.
  - Output still includes it.
  - Checksums cover all non-whitespace layout text.
  - Whitespace and newlines may be inserted between tokens.
  - Optional nested checksums are accepted and validated but not emitted.

  ## Legacy compatibility

  Legacy comma-separated layouts remain accepted:

  WxH,x,y{cell,cell,...}
  WxH,x,y,pane-id

  Additional compatibility behavior includes:

  - The reported e6db,113x28,... layout works and resizes existing panes correctly.
  - Older inconsistent root dimensions are corrected safely.
  - Legacy layouts with surplus cells continue pruning cells until the target pane count
    matches.

  - Legacy panes remain assigned in tree order.
  - Legacy input is re-emitted in the current canonical format.

  Mixed legacy/current syntax is rejected.

  ## Pane matching and counts

  For current layouts:

  - Pane IDs must be unique.
  - With matching pane counts:
      - An exact ID set maps panes by identity.
      - A completely disjoint ID set maps panes in tree order.
      - A partial ID match is rejected as ambiguous.

  - If the target has fewer panes:
      - Cells are removed from the end of the tree.
      - Remaining z-indexes are compacted while preserving order.
      - Existing panes are assigned in tree order.
      - No panes are killed or created.

  - A target with more panes than layout cells is rejected.

  Layouts are therefore snapshots that rearrange existing panes and windows, not complete
  session-restoration data.

  ## Validation and safety

  Parsing now constructs and validates a temporary tree before replacing the active layout:

  - Maximum input length: 8192 bytes.
  - Maximum nesting depth: 64.
  - Checked signed and unsigned numeric parsing.
  - Dimension and offset bounds.
  - Container size consistency.
  - Exact trailing-input checks.
  - Unique, contiguous z-indexes starting at zero.
  - Floating panes must precede tiled panes in z-order.
  - Unknown and duplicate flags are rejected.
  - Hidden and zoomed flags cannot be combined.
  - Only one pane may be zoomed.
  - Relative positioning is accepted only for floating panes.
  - Overflow-safe size aggregation.

  Invalid single-window layouts are validated before the window is unzoomed. Multi-window
  layouts are all validated before any window is changed.

  ## Multi-window layouts

  cmd-select-layout.c accepts:

  @window-id:layout[@window-id:layout...]

  Records may be adjacent or separated by whitespace/newlines. Unknown and duplicate window IDs
  are rejected.

  This allows direct reuse of:

  tmux list-windows -F '#{window_id}:#{window_layout}'

  ## Supporting runtime changes

  - tmux.h adds parsed pane IDs, z-indexes, hidden/zoomed/relative cell flags, and
    layout_validate.

  - layout.c initializes parsed metadata safely.
  - window.c treats hidden cells, including saved cells, as non-visible.

  ## Documentation

  tmux.1 now documents:

  - Current and legacy grammars.
  - Geometry and flags.
  - Z-index and pane-ID rules.
  - Optional checksums.
  - Multi-window wrappers.
  - Pane-count pruning.
  - Snapshot versus session-restoration semantics.

  The authoritative description is under select-layout; list-windows and list-panes reference
  it.

  ## Tests

  Added regress/layout-custom.sh covering serialization, compatibility, validation, geometry,
  IDs, pruning, flags, zoom, checksums, whitespace, and multi-window application.

  Updated regress/control-client-sanity.sh for canonical output.

  Verified:

  - Debug build
  - Layout regression
  - Floating-pane geometry regression
  - Control-client regression
  - Man-page rendering
  - git diff --check
2026-06-29 17:47:28 +02:00

291 lines
6.8 KiB
C

/* $OpenBSD$ */
/*
* Copyright (c) 2009 Nicholas Marriott <nicholas.marriott@gmail.com>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <sys/types.h>
#include <ctype.h>
#include <stdlib.h>
#include <string.h>
#include "tmux.h"
/*
* Switch window to selected layout.
*/
static enum cmd_retval cmd_select_layout_exec(struct cmd *,
struct cmdq_item *);
static enum cmd_retval cmd_select_layout_exec_multiple(struct cmdq_item *,
const char *);
struct cmd_select_layout_record {
struct window *w;
char *layout;
};
const struct cmd_entry cmd_select_layout_entry = {
.name = "select-layout",
.alias = "selectl",
.args = { "Enopt:", 0, 1, NULL },
.usage = "[-Enop] " CMD_TARGET_PANE_USAGE " [layout-name]",
.target = { 't', CMD_FIND_PANE, 0 },
.flags = CMD_AFTERHOOK,
.exec = cmd_select_layout_exec
};
const struct cmd_entry cmd_next_layout_entry = {
.name = "next-layout",
.alias = "nextl",
.args = { "t:", 0, 0, NULL },
.usage = CMD_TARGET_WINDOW_USAGE,
.target = { 't', CMD_FIND_WINDOW, 0 },
.flags = CMD_AFTERHOOK,
.exec = cmd_select_layout_exec
};
const struct cmd_entry cmd_previous_layout_entry = {
.name = "previous-layout",
.alias = "prevl",
.args = { "t:", 0, 0, NULL },
.usage = CMD_TARGET_WINDOW_USAGE,
.target = { 't', CMD_FIND_WINDOW, 0 },
.flags = CMD_AFTERHOOK,
.exec = cmd_select_layout_exec
};
static void
cmd_select_layout_free_records(struct cmd_select_layout_record *records,
u_int nrecords)
{
u_int i;
for (i = 0; i < nrecords; i++)
free(records[i].layout);
free(records);
}
/* Apply a list of @window-id:layout records. */
static enum cmd_retval
cmd_select_layout_exec_multiple(struct cmdq_item *item, const char *input)
{
struct cmd_select_layout_record *records = NULL;
struct window *w;
const char *ptr = input, *idstart, *idend;
const char *layoutstart, *layoutend;
char *id, *cause, *oldlayout;
u_int i, nrecords = 0;
for (;;) {
while (*ptr != '\0' && isspace((u_char)*ptr))
ptr++;
if (*ptr == '\0')
break;
if (*ptr != '@')
goto invalid;
idstart = ptr++;
if (!isdigit((u_char)*ptr))
goto invalid;
while (isdigit((u_char)*ptr))
ptr++;
idend = ptr;
while (*ptr != '\0' && isspace((u_char)*ptr))
ptr++;
if (*ptr++ != ':')
goto invalid;
id = xstrndup(idstart, idend - idstart);
w = window_find_by_id_str(id);
if (w == NULL) {
cmdq_error(item, "unknown window: %s", id);
free(id);
goto fail;
}
free(id);
for (i = 0; i < nrecords; i++) {
if (records[i].w == w) {
cmdq_error(item, "duplicate window: @%u", w->id);
goto fail;
}
}
layoutstart = ptr;
while (*ptr != '\0' && *ptr != '@')
ptr++;
layoutend = ptr;
while (layoutend != layoutstart &&
isspace((u_char)layoutend[-1]))
layoutend--;
if (layoutend == layoutstart)
goto invalid;
records = xreallocarray(records, nrecords + 1,
sizeof *records);
records[nrecords].w = w;
records[nrecords].layout = xstrndup(layoutstart,
layoutend - layoutstart);
nrecords++;
}
if (nrecords == 0)
goto invalid;
/* Validate every record before changing any window. */
for (i = 0; i < nrecords; i++) {
if (layout_validate(records[i].w, records[i].layout,
&cause) != 0) {
cmdq_error(item, "@%u: %s", records[i].w->id, cause);
free(cause);
goto fail;
}
}
for (i = 0; i < nrecords; i++) {
w = records[i].w;
server_unzoom_window(w);
oldlayout = w->old_layout;
w->old_layout = layout_dump(w, w->layout_root);
if (layout_parse(w, records[i].layout, &cause) != 0) {
cmdq_error(item, "@%u: %s", w->id, cause);
free(cause);
free(w->old_layout);
w->old_layout = oldlayout;
goto fail;
}
free(oldlayout);
recalculate_sizes();
server_redraw_window(w);
notify_window("window-layout-changed", w);
}
cmd_select_layout_free_records(records, nrecords);
return (CMD_RETURN_NORMAL);
invalid:
cmdq_error(item, "invalid multiple-window layout");
fail:
cmd_select_layout_free_records(records, nrecords);
return (CMD_RETURN_ERROR);
}
static enum cmd_retval
cmd_select_layout_exec(struct cmd *self, struct cmdq_item *item)
{
struct args *args = cmd_get_args(self);
struct cmd_find_state *target = cmdq_get_target(item);
struct winlink *wl = target->wl;
struct window *w = wl->window;
struct window_pane *wp = target->wp;
const char *layoutname;
char *oldlayout, *cause;
int next, previous, layout;
const char *ptr;
if (cmd_get_entry(self) == &cmd_select_layout_entry &&
args_count(args) != 0 && !args_has(args, 'E') &&
!args_has(args, 'n') && !args_has(args, 'o') &&
!args_has(args, 'p')) {
ptr = args_string(args, 0);
while (*ptr != '\0' && isspace((u_char)*ptr))
ptr++;
if (*ptr == '@')
return (cmd_select_layout_exec_multiple(item, ptr));
if (layout_set_lookup(ptr) == -1 &&
layout_validate(w, ptr, &cause) != 0) {
cmdq_error(item, "%s: %s", cause, ptr);
free(cause);
return (CMD_RETURN_ERROR);
}
}
server_unzoom_window(w);
next = (cmd_get_entry(self) == &cmd_next_layout_entry);
if (args_has(args, 'n'))
next = 1;
previous = (cmd_get_entry(self) == &cmd_previous_layout_entry);
if (args_has(args, 'p'))
previous = 1;
oldlayout = w->old_layout;
w->old_layout = layout_dump(w, w->layout_root);
if (next || previous) {
if (next)
layout_set_next(w);
else
layout_set_previous(w);
goto changed;
}
if (args_has(args, 'E')) {
layout_spread_out(wp);
goto changed;
}
if (args_count(args) != 0)
layoutname = args_string(args, 0);
else if (args_has(args, 'o'))
layoutname = oldlayout;
else
layoutname = NULL;
if (!args_has(args, 'o')) {
if (layoutname == NULL)
layout = w->lastlayout;
else
layout = layout_set_lookup(layoutname);
if (layout != -1) {
layout_set_select(w, layout);
goto changed;
}
}
if (layoutname != NULL) {
if (layout_parse(w, layoutname, &cause) == -1) {
cmdq_error(item, "%s: %s", cause, layoutname);
free(cause);
goto error;
}
goto changed;
}
free(oldlayout);
return (CMD_RETURN_NORMAL);
changed:
free(oldlayout);
recalculate_sizes();
server_redraw_window(w);
notify_window("window-layout-changed", w);
return (CMD_RETURN_NORMAL);
error:
free(w->old_layout);
w->old_layout = oldlayout;
return (CMD_RETURN_ERROR);
}