diff --git a/regress/floating-pane-prompt-wide-character.sh b/regress/floating-pane-prompt-wide-character.sh new file mode 100755 index 000000000..cdd892a54 --- /dev/null +++ b/regress/floating-pane-prompt-wide-character.sh @@ -0,0 +1,179 @@ +#!/bin/sh + +# A damage rectangle's clip range is grown to avoid splitting a wide +# character, but redraw_damage_grow_span_clip() (screen-redraw.c) only ever +# checks the span's own pane *content* grid (wp->screen) for that. For a +# REDRAW_SPAN_PANE span, that same range is then also handed to +# redraw_damage_draw_pane_prompt() to recompose the pane's separately +# rendered prompt (wp->prompt, e.g. from "command-prompt -P") over the +# damaged sub-range - but the prompt is drawn into its own, freshly +# allocated one-line screen, unrelated to the pane's content grid, so a +# range grown (or left ungrown) against the content is not necessarily +# grown correctly for the prompt's own wide characters. +# +# This is invisible when the pane's own content is plain ASCII (as here): +# redraw_damage_grow_span_clip() never finds anything to grow against, so +# the raw, ungrown geometric range is passed straight through to the +# prompt - and if that range's edge lands mid-character in the *prompt's* +# grid, tty_draw_line() clears the character it cuts through +# (tty_draw_line_get_empty()'s gc->data.width > nx check, for a trailing +# base cell with no room left for its padding half). +# +# The trigger is a palette change (OSC 4) in a tiled pane that is one half +# of a vertical split running the full height of the window - occluded +# under the floating pane, but still geometrically triggering a redraw of +# its own rectangle. Positioned so the split boundary falls inside the +# floating pane's own CJK prompt, this reproduces exactly Codex's report: +# "a floating pane containing a CJK prompt across a tiled-pane boundary - +# a palette update in the tiled pane blanks a prompt character." + +PATH=/bin:/usr/bin +TERM=screen +LC_ALL=C.UTF-8 +export PATH TERM LC_ALL + +[ -z "$TEST_TMUX" ] && TEST_TMUX=$(readlink -f ../tmux) + +DIR=$(mktemp -d) || exit 1 +cd "$DIR" || exit 1 +INNER="$TEST_TMUX -Lpromptwide-inner-$$ -f/dev/null" +OUTER="$TEST_TMUX -Lpromptwide-outer-$$ -f/dev/null" +EMITTER=$DIR/emitter.pl +CAPTURE=$DIR/capture +FLOAT= + +fail() +{ + echo "$*" >&2 + [ -s "$CAPTURE" ] && cat "$CAPTURE" >&2 + exit 1 +} + +cleanup() +{ + $OUTER kill-server 2>/dev/null + $INNER kill-server 2>/dev/null + cd / + rm -rf "$DIR" +} +trap cleanup 0 1 15 + +wait_for_client() +{ + i=0 + while [ "$i" -lt 50 ]; do + CLIENT=$($INNER list-clients -F '#{client_name}' 2>/dev/null) + [ -n "$CLIENT" ] && return 0 + sleep 0.1 + i=$((i + 1)) + done + fail "inner client did not attach" +} + +wait_outer_has() +{ + marker=$1 + i=0 + while [ "$i" -lt 50 ]; do + $OUTER capture-pane -p -t outer:0.0 >"$CAPTURE" 2>/dev/null || true + grep -q "$marker" "$CAPTURE" && return 0 + sleep 0.1 + i=$((i + 1)) + done + fail "outer client did not show $marker" +} + +wait_prompt_row_intact() +{ + i=0 + while [ "$i" -lt 50 ]; do + $OUTER capture-pane -p -t outer:0.0 >"$CAPTURE" 2>/dev/null || true + line=$(sed -n "${PROMPTROW}p" "$CAPTURE") + case $line in + *"$PROMPTTEXT"*) return 0 ;; + esac + sleep 0.1 + i=$((i + 1)) + done + fail "the CJK prompt was not intact after the palette-triggered damage - got: $line" +} + +cat >"$EMITTER" <<'PERL' +use strict; +use warnings; + +$| = 1; +my $line = ; +print "\e]4;1;rgb:11/22/33\e\\"; +sleep 100; +PERL + +$INNER new-session -d -s inner -x 60 -y 12 "perl '$EMITTER'" || exit 1 +$INNER set-option -g status off || exit 1 +$INNER set-option -g window-size manual || exit 1 +LEFT=$($INNER list-panes -t inner -F '#{pane_id}') || exit 1 + +# Split so the boundary between the two tiled panes falls at column 17 - +# used below to pick a floating-pane column that lands the boundary +# mid-character inside the prompt. +RIGHT=$($INNER split-window -t inner -h -l 43 -PF '#{pane_id}' \ + 'sleep 100') || exit 1 +RX=$($INNER display-message -p -t "$RIGHT" '#{pane_left}') || exit 1 + +# Create the floating pane, then check its actual resulting position (the +# border-framing offset added to -X is not something to hand-compute). Try +# adjacent starting columns until the split boundary lands on an odd +# (padding-half) column of the prompt's own numbering, and within the +# prompt's 12-column width. +startx=10 +tries=0 +while [ "$tries" -lt 4 ]; do + [ -n "$FLOAT" ] && $INNER kill-pane -t "$FLOAT" 2>/dev/null + FLOAT=$($INNER new-pane -d -PF '#{pane_id}' -x 24 -y 5 -X "$startx" \ + -Y 2 "sh -c 'i=0; while [ \$i -lt 10 ]; do \ +printf AAAAAAAAAAAAAAAAAAAAAA\\\\n; i=\$((i+1)); done; sleep 100'") || + exit 1 + sleep 0.2 + X1=$($INNER display-message -p -t "$FLOAT" '#{pane_left}') + Y1=$($INNER display-message -p -t "$FLOAT" '#{pane_top}') + H1=$($INNER display-message -p -t "$FLOAT" '#{pane_height}') + local=$((RX - X1 - 1)) + if [ "$local" -ge 1 ] && [ "$local" -le 11 ] && + [ $((local % 2)) -eq 1 ]; then + break + fi + startx=$((startx + 1)) + tries=$((tries + 1)) +done +local=$((RX - X1 - 1)) +[ "$local" -ge 1 ] && [ "$local" -le 11 ] && [ $((local % 2)) -eq 1 ] || + fail "could not find bad-parity starting column" + +$OUTER new-session -d -s outer -x 60 -y 12 'sleep 100' || exit 1 +$OUTER set-option -g status off || exit 1 +$OUTER set-option -g window-size manual || exit 1 +$OUTER set-option -g default-terminal screen-256color || exit 1 +$OUTER respawn-pane -k -t outer:0.0 \ + "$TEST_TMUX -Lpromptwide-inner-$$ -f/dev/null attach-session -t inner" || + exit 1 + +wait_for_client +wait_outer_has AAAAAAAAAAAAAAAAAAAAAA +CLIENT=$($INNER list-clients -F '#{client_name}') || exit 1 + +$INNER select-pane -t "$FLOAT" || exit 1 +PROMPTTEXT=$(printf '\344\270\255' | perl -CSD -ne 'print $_ x 6') +$INNER command-prompt -b -P -t "$CLIENT" -p "$PROMPTTEXT" \ + 'display-message -- %1' || exit 1 +wait_outer_has "$PROMPTTEXT" + +PROMPTROW=$((Y1 + H1)) + +# Trigger the damage: unblock the emitter so it fires the palette change in +# the left tiled pane, which is occluded under (but geometrically overlaps) +# the floating pane's prompt row. +$INNER send-keys -t "$LEFT" Enter || exit 1 + +wait_prompt_row_intact + +exit 0 diff --git a/regress/floating-pane-status-cross-client.sh b/regress/floating-pane-status-cross-client.sh new file mode 100755 index 000000000..ee3f19259 --- /dev/null +++ b/regress/floating-pane-status-cross-client.sh @@ -0,0 +1,117 @@ +#!/bin/sh + +# redraw_damage_refresh_status() (screen-redraw.c) force-regenerates a +# pane's border-status title when a damage rectangle touches it, guarded +# by the per-pane PANE_NEWSTATUS flag. window_make_pane_status() formats +# pane-border-format using the requesting client's own context (so e.g. +# #{client_name} differs per client), but wp->status_screen/PANE_NEWSTATUS +# are shared by every client viewing the pane. With two clients attached +# to the same session, whichever client's damage pass runs first renders +# its own text and sets the flag; the other client's damage pass, finding +# the flag already set, used to skip rendering entirely and reuse +# whatever was already there. +# +# This checks the actual server-side decision via the -vv log rather than +# a visual capture: an unrelated periodic client status-refresh reliably +# repaints each client's title correctly again within the same tick right +# after the buggy decision is made, before anything is ever flushed to +# either terminal, so the wrong content this bug produces is never +# visible to any external capture - the log is the only place the actual +# bug (or its absence) can be observed. +# +# A floating pane with its own pane-border-status is positioned so that a +# damage rectangle from an *unrelated* palette change (OSC 4) in the +# underlying tiled pane - whose own geometry spans the whole window - +# overlaps the floating pane's title row without touching its content, +# giving a damage-only trigger with no side effect that would otherwise +# force a normal (non-buggy) full per-client status re-render in the same +# pass and mask the result either way. + +PATH=/bin:/usr/bin +TERM=screen +LC_ALL=C.UTF-8 +export PATH TERM LC_ALL + +[ -z "$TEST_TMUX" ] && TEST_TMUX=$(readlink -f ../tmux) + +DIR=$(mktemp -d) || exit 1 +cd "$DIR" || exit 1 +INNER="$TEST_TMUX -vv -Lstatuscc-inner-$$ -f/dev/null" +OUTER1="$TEST_TMUX -Lstatuscc-outer1-$$ -f/dev/null" +OUTER2="$TEST_TMUX -Lstatuscc-outer2-$$ -f/dev/null" + +fail() +{ + echo "$*" >&2 + exit 1 +} + +cleanup() +{ + $OUTER1 kill-server 2>/dev/null + $OUTER2 kill-server 2>/dev/null + $INNER kill-server 2>/dev/null + cd / + rm -rf "$DIR" +} +trap cleanup 0 1 15 + +BASEEMITTER=$DIR/base-emitter.pl +cat >"$BASEEMITTER" <<'PERL' +use strict; +use warnings; + +$| = 1; +my $line = ; +print "\e]4;1;rgb:11/22/33\e\\"; +sleep 100; +PERL + +$INNER new-session -d -s inner -x 40 -y 10 "perl '$BASEEMITTER'" || exit 1 +$INNER set-option -g status off || exit 1 +$INNER set-option -g window-size manual || exit 1 +$INNER set-option -g pane-border-status top || exit 1 +$INNER set-option -g pane-border-format 'C=#{client_name}' || exit 1 +BASE=$($INNER list-panes -t inner -F '#{pane_id}') || exit 1 +FLOAT=$($INNER new-pane -d -PF '#{pane_id}' -x 20 -y 3 -X 5 -Y 4 \ + 'sleep 100') || exit 1 + +$OUTER1 new-session -d -s outer -x 40 -y 10 'sleep 100' || exit 1 +$OUTER1 set-option -g status off || exit 1 +$OUTER1 set-option -g window-size manual || exit 1 +$OUTER1 set-option -g default-terminal screen-256color || exit 1 +$OUTER1 respawn-pane -k -t outer:0.0 \ + "$TEST_TMUX -Lstatuscc-inner-$$ -f/dev/null attach-session -t inner" || + exit 1 +sleep 0.5 +NAME1=$($INNER list-clients -F '#{client_name}') || exit 1 + +$OUTER2 new-session -d -s outer -x 40 -y 10 'sleep 100' || exit 1 +$OUTER2 set-option -g status off || exit 1 +$OUTER2 set-option -g window-size manual || exit 1 +$OUTER2 set-option -g default-terminal screen-256color || exit 1 +$OUTER2 respawn-pane -k -t outer:0.0 \ + "$TEST_TMUX -Lstatuscc-inner-$$ -f/dev/null attach-session -t inner" || + exit 1 +sleep 0.5 +ALLNAMES=$($INNER list-clients -F '#{client_name}') || exit 1 +NAME2=$(echo "$ALLNAMES" | grep -v "^$NAME1\$") +[ -n "$NAME2" ] || fail "sanity: could not identify the second client" + +# Let any attach-driven full redraw (and its own, non-buggy, per-client +# status render) finish completely before triggering the damage-only +# palette update. +sleep 1.5 + +$INNER send-keys -t "$BASE" Enter || exit 1 +sleep 0.5 + +LOG=$(ls tmux-server*.log 2>/dev/null | head -1) +[ -n "$LOG" ] || fail "sanity: no server -vv log was produced" + +n1=$(grep -c "regenerated pane .* status for $NAME1\$" "$LOG") +n2=$(grep -c "regenerated pane .* status for $NAME2\$" "$LOG") +[ "$n1" -ge 1 ] || fail "damage pass never regenerated $NAME1's own status - it reused whatever the other client's render left behind" +[ "$n2" -ge 1 ] || fail "damage pass never regenerated $NAME2's own status - it reused whatever the other client's render left behind" + +exit 0 diff --git a/screen-redraw.c b/screen-redraw.c index 6b920f858..df753aa38 100644 --- a/screen-redraw.c +++ b/screen-redraw.c @@ -236,6 +236,12 @@ struct redraw_build_cell { static struct redraw_build_cell *redraw_cells; static size_t redraw_ncells; +/* + * Bumped once per redraw_client_damage() call (one client's one redraw + * pass) - see redraw_damage_refresh_status(). + */ +static u_int redraw_status_serial; + /* Context for building the scene. */ struct redraw_build_ctx { struct client *c; @@ -2216,6 +2222,17 @@ redraw_pane_scrollbar(struct client *c, struct window_pane *wp) * whenever PANE_NEWSTATUS is not set, leaving a pane's border-status title * blank until some unrelated redraw happens to touch it (e.g. a focus * change or window resize). + * + * wp->status_screen/PANE_NEWSTATUS are per-pane, but the formatted content + * (window_make_pane_status() expands pane-border-format, which can read + * per-client fields like #{client_name}) is per-client. Gating purely on + * PANE_NEWSTATUS would let one client's damage pass render its own text, + * set the flag, and leave every other client's pass - this tick or any + * later one, since nothing else clears it here - reusing that stale, + * wrong-client text. redraw_status_serial (bumped once per + * redraw_client_damage() call, i.e. once per client per pass) still + * dedupes repeat calls within that same pass, but forces a fresh, + * correctly-client-formatted render on every distinct client/pass. */ static void redraw_damage_refresh_status(struct redraw_draw_ctx *dctx, @@ -2224,13 +2241,29 @@ redraw_damage_refresh_status(struct redraw_draw_ctx *dctx, struct redraw_span *first; u_int width; - if (wp->flags & PANE_NEWSTATUS) + if ((wp->flags & PANE_NEWSTATUS) && + wp->status_serial == redraw_status_serial) return; width = redraw_pane_status_width(dctx, wp, &first); if (width == 0) return; + log_debug("%s: regenerated pane %%%u status for %s", __func__, wp->id, + dctx->scene->c->name); window_make_pane_status(wp, dctx->scene->c, width, first); wp->flags |= PANE_NEWSTATUS; + wp->status_serial = redraw_status_serial; +} + +/* Whether the cell at (px, py) in screen s is a padding cell. */ +static int +redraw_screen_cell_is_padding(struct screen *s, u_int px, u_int py) +{ + struct grid_cell gc; + + if (px >= screen_size_x(s)) + return (0); + grid_view_get_cell(s->grid, px, py, &gc); + return ((gc.flags & GRID_FLAG_PADDING) != 0); } /* @@ -2256,7 +2289,6 @@ static int redraw_span_cell_is_padding(struct redraw_span *span, u_int x) { struct screen *s; - struct grid_cell gc; u_int px, py; switch (span->data.type) { @@ -2278,10 +2310,7 @@ redraw_span_cell_is_padding(struct redraw_span *span, u_int x) default: return (1); } - if (px >= screen_size_x(s)) - return (0); - grid_view_get_cell(s->grid, px, py, &gc); - return ((gc.flags & GRID_FLAG_PADDING) != 0); + return (redraw_screen_cell_is_padding(s, px, py)); } /* @@ -2308,6 +2337,26 @@ redraw_damage_grow_span_clip(struct redraw_span *span, u_int *xp, u_int *endp) (*endp)++; } +/* + * As redraw_damage_grow_span_clip(), but against an explicit screen: px0 is + * the column in that screen corresponding to span->x, py the row. Used for + * a span's separately rendered content (e.g. a pane's prompt) that isn't + * span->data.p.wp->screen (or whichever grid redraw_span_cell_is_padding() + * would otherwise consult for this span's type), and so has its own, + * unrelated wide-character boundaries at the same columns. + */ +static void +redraw_damage_grow_screen_clip(struct redraw_span *span, struct screen *s, + u_int px0, u_int py, u_int *xp, u_int *endp) +{ + if (*xp > span->x && + redraw_screen_cell_is_padding(s, px0 + (*xp - span->x), py)) + (*xp)--; + if (*endp < span->x + span->width && + redraw_screen_cell_is_padding(s, px0 + (*endp - span->x), py)) + (*endp)++; +} + /* Recompose a pane's prompt over a damaged section of its display row. */ static void redraw_damage_draw_pane_prompt(struct redraw_draw_ctx *dctx, @@ -2317,7 +2366,7 @@ redraw_damage_draw_pane_prompt(struct redraw_draw_ctx *dctx, struct window_pane *wp = span->data.p.wp; struct tty *tty = &scene->c->tty; struct screen screen; - u_int px, width, prompt_y; + u_int px, width, prompt_y, x0, x1; if (wp->prompt == NULL || wp->sx == 0 || wp->sy == 0) return; @@ -2329,12 +2378,25 @@ redraw_damage_draw_pane_prompt(struct redraw_draw_ctx *dctx, return; redraw_make_pane_prompt(wp, &screen); - px = span->data.p.px + (x - span->x); + + /* + * x and n were clipped and grown against wp->screen, whose character + * boundaries have nothing to do with the prompt's separately + * rendered screen - realign the range on the prompt's own grid + * instead, clamped to this span so it cannot bleed into a + * neighbouring one. + */ + x0 = x; + x1 = x + n; + redraw_damage_grow_screen_clip(span, &screen, span->data.p.px, 0, &x0, + &x1); + + px = span->data.p.px + (x0 - span->x); if (px < screen_size_x(&screen)) { - width = n; + width = x1 - x0; if (width > screen_size_x(&screen) - px) width = screen_size_x(&screen) - px; - tty_draw_line(tty, &screen, px, 0, width, x, y, NULL); + tty_draw_line(tty, &screen, px, 0, width, x0, y, NULL); } screen_free(&screen); } @@ -2486,6 +2548,7 @@ redraw_client_damage(struct client *c) redraw_free_pending_damage(c); if (TAILQ_EMPTY(&w->damage) && TAILQ_EMPTY(&c->pending_damage)) return; + redraw_status_serial++; scene = redraw_get_scene(c); if (scene == NULL) diff --git a/tmux.h b/tmux.h index f701d7e48..548590e8f 100644 --- a/tmux.h +++ b/tmux.h @@ -1449,6 +1449,7 @@ struct window_pane { struct screen base; struct screen status_screen; + u_int status_serial; TAILQ_HEAD(, window_mode_entry) modes;