Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
## [Unreleased]

### Fixed
- **tmux の中でさらに tmux を動かしたとき(入れ子)も、内側の tmux の `Ctrl+C` のコピーが手元の PC のクリップボードに
届くようにしました(#528)。** base イメージの tmux の既定に `set -s set-clipboard on` を足し、ペインの中のプログラムが
送る OSC 52 を外側の端末へ中継します。ペインの中から読み取ることはできません。元に戻すには `~/.tmux.conf` に
`set -s set-clipboard external` と書きます。**効かせるには base イメージを建て直します。**
- **Remote-SSH で入ったホストの tmux から、手元の PC の VS Code にエディタが開くようにしました(#523)。**
以前のクライアントが作った tmux のペインで、IPC ソケットを tmux のセッション環境から拾い直しても、起動されるのは
ペインの `PATH` の先頭にあるホストのデスクトップ版の `code` で、手元の PC には何も開いていませんでした。
Expand Down
6 changes: 6 additions & 0 deletions containers/base/tmux.conf
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ bind-key -T copy-mode-vi MouseDrag1Pane select-pane \; send-keys -X begin-select
bind-key -T copy-mode C-c send-keys -X copy-selection-and-cancel
bind-key -T copy-mode-vi C-c send-keys -X copy-selection-and-cancel

# 入れ子の tmux など、ペインの中のプログラムが送る OSC 52 を外側の端末へ中継する (#528)。
# 既定の external のままだと、内側の tmux の Ctrl+C のコピーが手元のクリップボードに届かない。
# on でもペインの中から読み取ることはできない (tmux は OSC 52 の問い合わせに答えない)。
# 戻すときは ~/.tmux.conf に set -s set-clipboard external と書く。
set -s set-clipboard on

# 既定の 2000 行はビルドログ 1 回で流れ切る。pane あたりの上限であり、実際に使った
# 分だけ確保するので固定の先取りは無い。
set -g history-limit 100000
Expand Down
8 changes: 8 additions & 0 deletions docs/specifications/kiro-auth-persistence-and-tmux-copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ base イメージの tmux は `mouse on` を既定とし、マウスホイール
端末のクリップボードへ送り、copy-mode を終了する。コピーせずに選択を終了する場合は `q` を
使用する。ペインをまたぐ端末側の選択には `Shift` + ドラッグを使用する。

tmux の中でさらに tmux を動かす(入れ子)場合も、内側の tmux の `Ctrl+C` で手元のクリップボードへ
届ける。内側の tmux は選択内容を OSC 52 で外側の tmux へ送る。外側の tmux は `set-clipboard` を
`on` とし、ペインの中のプログラムから来た OSC 52 を端末へ中継する。既定の `external` は tmux
自身のコピーだけを端末へ送り、ペインから来た OSC 52 を捨てるため、入れ子では届かない。
`on` でもペインの中のプログラムはクリップボードを書き換えられるだけで、読み取ることはできない
(tmux は OSC 52 の問い合わせに答えない)。利用者は `~/.tmux.conf` に
`set -s set-clipboard external` と書けば元の動きに戻せる。

`Ctrl+Home` は VS Code や Windows 側の操作と競合するため、tmux では割り当てない。

## データ・設定
Expand Down
63 changes: 63 additions & 0 deletions tests/containers/test_tmux_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,69 @@ def test_focus_events_is_on(options):
assert options["focus-events"] == ["on"]


@needs_tmux
def test_set_clipboard_relays_osc52_from_panes(options):
"""#528: ペインの中のプログラム (入れ子の tmux など) が送る OSC 52 を外側の端末へ中継する。

既定の ``external`` は tmux 自身のコピーだけを端末へ送り、ペインから来た OSC 52 を捨てる。
そのままだと入れ子の内側の tmux で ``Ctrl+C`` したものが手元のクリップボードに届かない。
"""
assert options["set-clipboard"] == ["on"]


def _wait_until(predicate, timeout: float = 10.0) -> bool:
deadline = time.monotonic() + timeout
while time.monotonic() < deadline:
if predicate():
return True
time.sleep(0.1)
return False


@needs_tmux
def test_nested_tmux_copy_reaches_outer_tmux():
"""#528: 内側の tmux のコピー (OSC 52) が外側の tmux のバッファに届く。

外側と内側の両方に base の設定を読ませ、外側のペインから内側のサーバへ attach する。
内側で ``set-buffer -w`` (``Ctrl+C`` のコピーと同じく OSC 52 で端末へ送る) をすると、
外側が ``set-clipboard on`` なら外側のバッファにも同じ文字列が入る。
"""
tag = uuid.uuid4().hex[:8]
outer = Path(tempfile.gettempdir()) / f"dvb528o-{tag}"
inner = Path(tempfile.gettempdir()) / f"dvb528i-{tag}"
env = {k: v for k, v in os.environ.items() if k != "TMUX"}
env["TERM"] = "xterm-256color"
o = ["tmux", "-S", str(outer)]
i = ["tmux", "-S", str(inner)]
text = f"nested-copy-{tag}"
try:
subprocess.run([*o, "-f", str(TMUX_CONF), "new-session", "-d", "-x", "120", "-y", "30"],
env=env, check=True, capture_output=True)
subprocess.run([*i, "-f", str(TMUX_CONF), "new-session", "-d", "-s", "in"],
env=env, check=True, capture_output=True)
subprocess.run([*o, "send-keys", f"env -u TMUX tmux -S {inner} attach -t in", "Enter"],
env=env, check=True, capture_output=True)

def attached() -> bool:
shown = subprocess.run([*i, "list-clients"], env=env, capture_output=True, text=True)
return bool(shown.stdout.strip())

assert _wait_until(attached), "外側のペインから内側の tmux へ attach できなかった"
subprocess.run([*i, "set-buffer", "-w", text], env=env, check=True, capture_output=True)

def relayed() -> bool:
shown = subprocess.run([*o, "list-buffers"], env=env, capture_output=True, text=True)
return text in shown.stdout

assert _wait_until(relayed), "内側のコピーが外側の tmux のバッファに届かない"
finally:
for base in (i, o):
subprocess.run([*base, "kill-server"], env=env, capture_output=True)
for sock in (inner, outer):
with contextlib.suppress(FileNotFoundError):
sock.unlink()


@needs_tmux
def test_default_terminal_is_tmux_256color(options):
"""条件 4: tmux の版に依らず tmux-256color へ固定する。"""
Expand Down
Loading