C++ API

method libtmux-cxx latest

Window.panes

Source and package

Qualified name: libtmux::Window::panes
Namespace: libtmux
Declared in: Window
Package: libtmux-cxx
Source: include/libtmux/entities.hpp
Other languages: Perlmethod Erlangfunction PowerShellcmdlet Juliafunction Elixir Haskell Common Lispfunction PythonRuby Lua TypeScriptRustGoJavaC#SwiftKotlinScalaOCamlfunction F#function Clojurefunction

[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<std::vector<Pane>, CommandFailure> panes() const; method readonly [source] ¶

Examples#

Traverse a session and its children. List windows and panes within one session, then follow a pane back to its owning window and session. Each relation method performs a new read; the original entity still holds its earlier snapshot. libtmux-cxx is not published to a package registry yet, so this builds it from its repository. Use Clang 18 or newer with libc++, CMake 3.25 or newer, Ninja, Git, and tmux 3.3a or newer on Linux. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-cxx.git libtmux-source && \
  git -C libtmux-source checkout 542fdc204ff3cfa56f5484327cda0c69bad2307d

Build and install the C++23 library and its public testing component into this directory:

$ cmake -S libtmux-source -B libtmux-build -G Ninja \
    -DCMAKE_TOOLCHAIN_FILE="$PWD/libtmux-source/cmake/toolchains/clang-libcxx.cmake" \
    -DCMAKE_C_COMPILER=clang \
    -DCMAKE_CXX_COMPILER=clang++ \
    -DCMAKE_BUILD_TYPE=Release \
    -DLIBTMUX_BUILD_TESTS=OFF \
    -DLIBTMUX_BUILD_EXAMPLES=OFF \
    -DLIBTMUX_BUILD_TESTING_LIBRARY=ON && \
  cmake --build libtmux-build --parallel 2 && \
  cmake --install libtmux-build --prefix "$PWD/libtmux-prefix"

Save this complete consumer project as CMakeLists.txt: View source

cmake_minimum_required(VERSION 3.25)
project(libtmux_api_example LANGUAGES CXX)

find_package(libtmux REQUIRED COMPONENTS testing)

add_executable(api_example main.cpp)
target_link_libraries(api_example PRIVATE libtmux::libtmux libtmux::testing)

Save this complete program as main.cpp. ScopedTmuxServer owns a private daemon and stops it when the program exits. Ordinary applications use Server for their own socket; these examples use the fixture until setup moves to ordinary server objects. View source

#include <cstdio>

#include <libtmux/libtmux.hpp>
#include <libtmux/testing/scoped_server.hpp>

int main() {
  // The fixture owns this private server and cleans it up on every return path.
  auto fixture = libtmux::test::ScopedTmuxServer::start({
      .session_name = "api",
      .socket_namespace = libtmux::test::SocketNamespace::consumer("api"),
  });
  if (!fixture.has_value()) {
    std::fprintf(stderr, "%s\n", fixture.error().c_str());
    return 1;
  }
  auto server = libtmux::Server::at_socket_path(fixture->socket_path());
  if (!server.has_value()) {
    std::fprintf(stderr, "%s\n", server.error().diagnostic.c_str());
    return 1;
  }

  const auto sessions = server->sessions();
  if (!sessions.has_value()) {
    std::fprintf(stderr, "%s\n", sessions.error().diagnostic.c_str());
    return 1;
  }
  if (sessions->size() != 1) {
    std::fputs("expected one session\n", stderr);
    return 1;
  }
  const auto& session = sessions->front();
  const auto windows = session.windows();
  const auto session_panes = session.panes();
  if (!windows.has_value()) {
    std::fprintf(stderr, "%s\n", windows.error().diagnostic.c_str());
    return 1;
  }
  if (!session_panes.has_value()) {
    std::fprintf(stderr, "%s\n", session_panes.error().diagnostic.c_str());
    return 1;
  }
  if (windows->size() != 1 || session_panes->size() != 1) {
    std::fputs("expected one window and pane\n", stderr);
    return 1;
  }
  const auto& window = windows->front();
  const auto panes = window.panes();
  if (!panes.has_value()) {
    std::fprintf(stderr, "%s\n", panes.error().diagnostic.c_str());
    return 1;
  }
  if (panes->size() != 1) {
    std::fputs("expected one window pane\n", stderr);
    return 1;
  }
  const auto owner_window = panes->front().window();
  const auto owner_session = panes->front().session();
  if (!owner_window.has_value()) {
    std::fprintf(stderr, "%s\n", owner_window.error().diagnostic.c_str());
    return 1;
  }
  if (!owner_session.has_value()) {
    std::fprintf(stderr, "%s\n", owner_session.error().diagnostic.c_str());
    return 1;
  }
  if (*owner_window != window || *owner_session != session ||
      panes->front() != session_panes->front()) {
    std::fputs("entity ownership does not match\n", stderr);
    return 1;
  }
  std::puts("api session -> one window -> one pane; owners match.");
  return 0;
}

Build against the installed library and run the saved program. An operation error produces a failing exit status:

$ cmake -S . -B build -G Ninja \
    -DCMAKE_PREFIX_PATH="$PWD/libtmux-prefix" \
    -DCMAKE_CXX_COMPILER=clang++ \
    -DCMAKE_CXX_FLAGS=-stdlib=libc++ && \
  cmake --build build --parallel 2 && \
  ./build/api_example

Expected output:

api session -> one window -> one pane; owners match.

tmux command#

The tmux commands behind panes.

list-panes -t window scope, cmd_list_panes_window

tmux C API#

The C declarations in tmux that implement these commands.

cmd_list_panes_entry cmd_list_panes_window

Guides#

Pages that discuss panes.

Traversal

In other ports#

List a window's panes

Equivalents of List a window's panes in other languages
Language	Equivalent
Python	`libtmux.Window.panes`
Ruby	`LibTmux::Window#list_panes`
PowerShell	`LibTmux\Get-TmuxPane` Use the `-Window` parameter set to acquire panes in one window.
Julia	`LibTmux.panes` `panes` with a captured `WindowSnapshot` reads panes in that window; missing coverage is an error.
Erlang	`tmux_snapshot:related/3` Pass `panes`, a captured physical window 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:panes` `panes` traverses a captured window without contacting tmux.
TypeScript	`window.Window.panes`
Rust	`window.Window.panes`
Go	`tmux.Window.Panes`
Java	`io.github.libtmux.Window.panes`
Clojure	`libtmux.data/panes` Traverses one capture locally. It does not issue a list-panes command.
Kotlin	`io.github.libtmux.kotlin.Window.panes`
Scala	`io.github.libtmux.scaladsl.Window.panes`
C#	`LibTmux.Window.Panes`
F#	`LibTmux.FSharp.Window.panes` Builds a deferred pane query from one `LibTmux.Window` and its server. `Query.list` acquires panes scoped to that window ID.
Swift	`Snapshot.panes(of:)`
OCaml	`Libtmux.Window.panes` Reads captured panes in one global window without I/O.
Perl	`LibTmux::Window::panes` Reads this physical window’s captured panes without I/O.

No equivalent is recorded in Lua or Elixir.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Window.panes

Examples#

tmux command#

tmux C API#

Guides#

In other ports#

Examples#

tmux command#

tmux C API#

Guides#

In other ports#

Related types#