Scala API

method libtmux-scala latest

Server.windows

Package i.g.l.scaladsl io.github.libtmux.scaladsl

Captures every winlink, preserving each session and index placement.

Source and package

Module: io.github.libtmux.scaladsl
Declared in: Server
Package: io.github.libtmux:libtmux-scala_3
Source: libtmux-scala/build/generated/sources/catalog/scala/operations/GeneratedOperations.scala
Other languages: Python Ruby Lua TypeScript Rust Go Java C#C++Swift Kotlin F#

Scala extension methods Adds methods callable on the receiver type without changing its definition. Language documentation (self: Server) Scala method declarations Declares a method, with its name, parameter lists and return type. Language documentation windows(): Vector[Window] Scala extension methods Adds methods callable on the receiver type without changing its definition. Language documentation (self: Server) Scala method declarations Declares a method, with its name, parameter lists and return type. Language documentation windows(expression: io.github.libtmux.scaladsl.query.Expr[io.github.libtmux.Window]): Vector[Window] Scala extension methods Adds methods callable on the receiver type without changing its definition. Language documentation (self: Server) Scala method declarations Declares a method, with its name, parameter lists and return type. Language documentation windows(id: io.github.libtmux.WindowId): Vector[Window]

methodoverload3 overloads [source] ¶

Examples#

List all windows, then the windows captured for one session. Use JDK 25, Git, and tmux 3.2a through 3.7c on Linux, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-java.git libtmux-source && \
  git -C libtmux-source checkout f56392b5d9bc7f1f9c1631842333fb90f3d82d40

Save this consumer setup as settings.gradle.kts: View source

rootProject.name = "api-example"

includeBuild("libtmux-source") {
    dependencySubstitution {
        substitute(module("io.github.libtmux:libtmux-scala_3"))
            .using(project(":libtmux-scala"))
    }
}

Save this consumer setup as build.gradle.kts: View source

plugins {
    scala
    application
}

repositories { mavenCentral() }

dependencies {
    implementation("io.github.libtmux:libtmux-scala_3:0.0.1-alpha.17-SNAPSHOT")
    implementation("org.scala-lang:scala3-library_3:3.9.0")
}

java { toolchain { languageVersion.set(JavaLanguageVersion.of(25)) } }

application { mainClass.set(providers.gradleProperty("exampleMain")) }

Save this consumer setup as gradle.properties: View source

org.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=768m -Dfile.encoding=UTF-8
kotlin.daemon.jvmargs=-Xmx2g
org.gradle.workers.max=2

Save this launcher as run.sh. It creates and stops a private tmux server, including after program failure. A shutdown failure retains its socket directory and exits unsuccessfully. 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}")
mkdir -p /tmp/libtmux-java-dev
directory=$(mktemp -d /tmp/libtmux-java-dev/api.XXXXXX)
socket="$directory/tmux.sock"
config="$directory/tmux.conf"

alive() {
    "$binary" -S "$socket" display-message -p '#{pid}' >/dev/null 2>&1
}

cleanup() {
    status=$?
    trap - 0 HUP INT TERM
    if alive; then
        if ! "$binary" -S "$socket" kill-server; then
            printf 'Cannot stop tmux; kept %s\n' "$directory" >&2
            exit 1
        fi
        attempts=0
        while alive && [ "$attempts" -lt 100 ]; do
            sleep 0.05
            attempts=$((attempts + 1))
        done
        if alive; then
            printf 'tmux is still responding; kept %s\n' "$directory" >&2
            exit 1
        fi
    fi
    rm -rf "$directory" || exit 1
    exit "$status"
}
trap cleanup 0
trap 'exit 1' HUP INT TERM

unset TMUX TMUX_PANE
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 this complete program as src/main/scala/ListWindows.scala. It opens an ordinary client for the launcher's server; closing the client releases its transport. View source

package io.github.libtmux.examples.api.scaladirect

import io.github.libtmux.{ServerConfig, ServerEndpoint}
import java.nio.file.Path
import io.github.libtmux.scaladsl.*
import scala.util.Using
import scala.util.control.NonFatal

/** List all windows, then the windows captured for one session. */
object ListWindows {
  def main(args: Array[String]): Unit = {
    try {
      require(args.length == 3, "expected: tmux-binary socket-path config-file")
      val config = ServerConfig
        .builder()
        .binary(args(0))
        .endpoint(ServerEndpoint.socketPath(Path.of(args(1))))
        .configFile(Path.of(args(2)))
        .build()
      Using.resource(Server.open(config)) { server =>
        println("windows=" + server.windows().map(_.name).sorted.mkString(","))
        val session =
          server.session("work-one").getOrElse(sys.error("missing work-one"))
        println(
          "session-windows=" + session.windows.map(_.name).sorted.mkString(",")
        )
      }
    } catch {
      case NonFatal(error) =>
        System.err.println("Example failed: " + error.getMessage)
        sys.exit(1)
    }
  }
}

Build the minimal consumer and run the saved program with the private fixture. An operation or cleanup error makes the command exit unsuccessfully:

$ ./libtmux-source/gradlew --project-dir . --console=plain --quiet \
    installDist -PexampleMain=io.github.libtmux.examples.api.scaladirect.ListWindows && \
  sh run.sh build/install/api-example/bin/api-example

Expected output:

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

Parameters

expression ( io.github.libtmux.scaladsl.query.Expr[io.github.libtmux.Window] ) (for windows(expression))
id ( io.github.libtmux.WindowId ) (for windows(id))

tmux command list-windows

In other ports List the server's windows

Python libtmux.Server.windows
Ruby LibTmux::Server#list_windows
Lua libtmux.Snapshot.windows
TypeScript server.Server.windows
Rust server.Server.windows
Go tmux.Server.Windows
Java io.github.libtmux.Server.windows
C# LibTmux.Server.Windows
C++ libtmux::Server::windows
Swift Server.windows()
Kotlin io.github.libtmux.kotlin.Server.windows
F# LibTmux.FSharp.Server.windows

Scripting & web

Compiled & native

JVM

.NET

tmux

Server.windows

Examples#

Examples#

Related types#