Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased io.github.libtmux:libtmux-clojure has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-clojure latest

libtmux.data/windows

Returns the captured window occurrences in a snapshot or session.

Source and package
Qualified name
libtmux.data/windows
Module
libtmux.data
Declared in
libtmux.data
Package
io.github.libtmux:libtmux-clojure
Source
libtmux-clojure/src/main/clojure/libtmux/data.clj
Other languages
Perlclass Erlangstruct PowerShellcmdlet Juliastruct Elixirstruct Haskell Common Lispclass PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamltypealias F#module

Public owner: libtmux.data

Description#

Use libtmux.core/windows! for a new acquisition; panes stays local.

Examples#

Traverse root and session windows in one captured graph. Use JDK 25 or newer, the Clojure CLI, Git and tmux on Linux or macOS, with /bin/cat and /bin/sh available. These packages are unpublished. In an empty directory, install this exact source into the consumer's isolated Maven repository:

Terminal window
$ git clone https://github.com/libtmux/libtmux-java libtmux-source && \
git -C libtmux-source checkout --detach 5f88402151ff08fc0390dd438b90963692ec3fe4 && \
(cd libtmux-source && ./gradlew \
:libtmux:publishToMavenLocal \
:libtmux-clojure:publishToMavenLocal \
--console=plain \
"-Dmaven.repo.local=$PWD/../m2")

Save this file as deps.edn. Dependencies resolve from the isolated m2 directory; the core.async dependency is only enabled by its alias. View source

{:paths ["src/main/clojure"]
:mvn/local-repo "m2"
:deps {org.clojure/clojure {:mvn/version "1.12.6"}
io.github.libtmux/libtmux-clojure {:mvn/version "0.1.2-SNAPSHOT"}}
:aliases
{:core-async
{:extra-deps
{io.github.libtmux/libtmux-clojure-core-async {:mvn/version "0.1.2-SNAPSHOT"}}}}}

Save this file as run.sh. The launcher creates and stops a private server, including after program failure, and reports leaked servers as errors. View source

#!/bin/sh
set -eu
if [ "$#" -eq 0 ]; then
printf 'Usage: sh run.sh program [arguments...]\n' >&2
exit 2
fi
binary=$(command -v "${TMUX_BIN:-tmux}")
root=${API_RUN_ROOT:-/tmp/libtmux-java-dev}
# A client that names no socket follows TMUX or LIBTMUX_SOCKET*, and otherwise lands on the default
# socket under TMUX_TMPDIR. The program gets none of them, and a TMUX_TMPDIR of its own below.
unset TMUX TMUX_PANE
for name in $(env | sed -n 's/^\(LIBTMUX_SOCKET[A-Za-z0-9_]*\)=.*/\1/p'); do
unset "$name"
done
mkdir -p "$root"
directory=$(mktemp -d "$root/api.XXXXXX")
tmpdir=$(mktemp -d "$root/tmpdir.XXXXXX")
socket="$directory/tmux.sock"
config="$directory/tmux.conf"
serves() {
"$binary" -S "$1" display-message -p '#{pid}' >/dev/null 2>&1
}
# Stops the server on the socket, then waits for it to stop answering.
stop() {
"$binary" -S "$1" kill-server || return 1
attempts=0
while serves "$1" && [ "$attempts" -lt 60 ]; do
sleep 0.05
attempts=$((attempts + 1))
done
! serves "$1"
}
cleanup() {
status=$?
trap - 0 HUP INT TERM PIPE
# A closed output must not end the cleanup, whose messages are the only thing left to write.
trap '' PIPE
set +e
stuck=
left=
if [ -S "$socket" ] && serves "$socket" && ! stop "$socket"; then
stuck="$stuck tmux.sock"
fi
# Every socket anywhere under either directory, without following links. Only one a server answers
# on is a leak; the runner's own is expected to be there.
old_ifs=$IFS
IFS='
'
set -f
for candidate in $(find "$tmpdir" "$directory" -type s 2>/dev/null); do
[ "$candidate" = "$socket" ] && continue
serves "$candidate" || continue
case "$candidate" in
"$tmpdir"/*) name=${candidate#"$tmpdir"/} ;;
*) name=${candidate#"$directory"/} ;;
esac
left="$left $name"
stop "$candidate" || stuck="$stuck $name"
done
set +f
IFS=$old_ifs
if [ -n "$stuck" ]; then
printf 'tmux still answers on%s after kill-server; kept %s and %s under the runner root\n' \
"$stuck" "${directory##*/}" "${tmpdir##*/}" >&2
exit 1
fi
rm -rf "$directory" "$tmpdir" || exit 1
if [ -n "$left" ]; then
printf 'The program left a tmux server running:%s\n' "$left" >&2
exit 1
fi
exit "$status"
}
trap cleanup 0
trap 'exit 1' HUP INT TERM PIPE
# A default socket path longer than this does not fit in sun_path.
default_socket="$tmpdir/tmux-$(id -u)/default"
if [ "$(printf '%s' "$default_socket" | wc -c)" -gt 100 ]; then
printf 'API_RUN_ROOT is too long for a tmux socket\n' >&2
exit 1
fi
TMUX_TMPDIR=$tmpdir
export TMUX_TMPDIR
printf 'set-option -g default-shell /bin/sh\n' > "$config"
"$binary" -S "$socket" -f "$config" new-session -d -s work-one -n editor /bin/cat
"$binary" -S "$socket" split-window -h -t '=work-one:editor' /bin/cat
"$binary" -S "$socket" new-window -d -t '=work-one' -n logs /bin/cat
"$binary" -S "$socket" new-session -d -s work-two -n editor /bin/cat
"$@" "$binary" "$socket" "$config"
"$binary" -S "$socket" has-session -t '=work-one'
"$binary" -S "$socket" has-session -t '=work-two'

Save the complete program as src/main/clojure/libtmux/examples/api/list_windows.clj, creating its parent directories. Closing its client leaves the launcher's server running. View source

(ns libtmux.examples.api.list-windows
"Traverse root and session windows from the same captured graph."
(:require [clojure.string :as str]
[libtmux.core :as tm]
[libtmux.data :as data]))
(defn -main [& args]
(when-not (= 3 (count args))
(throw (IllegalArgumentException. "expected: tmux-binary socket-path config-file")))
(let [[binary socket config] args]
(with-open [server (tm/open! {:binary binary :socket-path socket
:config-file config})]
(let [snapshot (tm/snapshot! server)
session (data/exactly-one
(filter #(= "work-one" (:session/name %))
(:tmux/sessions snapshot)))]
(println (str "windows="
(str/join "," (sort (map :window/name (data/windows snapshot))))))
(println (str "session-windows="
(str/join "," (sort (map :window/name (data/windows session))))))))))

Run it with the private fixture. Set TMUX_BIN to select another tmux binary:

Terminal window
$ sh run.sh clojure \
-J-Dclojure.main.report=stderr \
-M \
-m libtmux.examples.api.list-windows

Expected output:

windows=editor,editor,logs
session-windows=editor,logs
Parameters

Guides#

Pages that discuss windows.

In other ports#

A tmux window

Equivalents of A tmux window in other languages
Language Equivalent
Python libtmux.Window
Ruby LibTmux::Window
Lua libtmux.Window
PowerShell LibTmux\Get-TmuxWindow This cmdlet reads shared .NET LibTmux.Window placements. Use -Server for all sessions or -Session for one session.
Julia LibTmux.WindowSnapshot WindowSnapshot holds captured physical-window data. WindowLink records a placement in a session; actions use WindowRef.
Erlang #tmux_model:window{} A physical window can have several session memberships. window_link holds the session-relative index and active flag.
Elixir LibTmux.Window Window is a physical window. WindowLink records its session index and active state.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:window window is a physical captured window. window-link preserves each session placement.
TypeScript window.Window
Rust window.Window
Go tmux.Window
Java io.github.libtmux.Window
Kotlin io.github.libtmux.kotlin.Window
Scala io.github.libtmux.scaladsl.Window
C# LibTmux.Window
F# LibTmux.FSharp.Window This F# module identifies shared .NET LibTmux.Window placements and builds deferred pane queries. Query.list acquires their results from tmux.
C++ libtmux::Window
Swift Window
OCaml Libtmux.Window.t A global window can have several session placements. Window_link holds the session, index and current flag.
Perl LibTmux::Window Physical window identity. WindowLink owns each session/index placement.

List a session's windows

Equivalents of List a session's windows in other languages
Language Equivalent
Python libtmux.Session.windows
Ruby LibTmux::Session#list_windows
PowerShell LibTmux\Get-TmuxWindow Use the -Session parameter set to acquire placements in one session.
Julia LibTmux.windows windows with a captured SessionSnapshot reads distinct physical windows in that session. Use windowlinks for placements.
Erlang tmux_snapshot:related/3 Pass windows, a captured session and its snapshot for a local relationship read.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:windows windows traverses a captured session. Repeated links preserve their physical-window multiplicity.
TypeScript session.Session.windows
Rust session.Session.windows
Go tmux.Session.Windows
Java io.github.libtmux.Session.windows
Kotlin io.github.libtmux.kotlin.Session.windows
Scala io.github.libtmux.scaladsl.Session.windows
C# LibTmux.Session.Windows
F# LibTmux.FSharp.Session.windows Builds a deferred window query from one LibTmux.Session and its server. Query.list acquires placements scoped to that session ID.
C++ libtmux::Session::windows
Swift Snapshot.windows(of:)
OCaml Libtmux.Session.windows Reads distinct captured global windows in this session. window_links preserves individual indexed placements.
Perl Traverse Session::window_links and resolve each link’s window, preserving explicit session placement and multiplicity.

No equivalent is recorded in Lua or Elixir.

Esc

Type to search.

Reference previewOpen reference