tmux-ruby 0.0.2

data/.yardopts

@@ -0,0 +1 @@
+--tag "tmux:tmux command" --tag "tmuxver:Required tmux version" --hide-void-return -m markdown --private --protected --default-return Undefined

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Dominik Honnef <dominikh@fork-bomb.org>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# Widgets
+
+- Progress bar ({Tmux::Widgets::ProgressBar ProgressBar})
+
+# Semantic Versioning
+
+tmux-ruby uses [Semantic Versioning](http://semver.org/)
+
+
+# Documentation
+
+tmux-ruby uses [YARD](http://github.com/lsegal/yard) for documenting
+its codebase.
+
+
+# Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Commit, do not mess with rakefile, version, or history. (if you want
+  to have your own version, that is fine but bump version in a commit
+  by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/lib/tmux.rb

@@ -0,0 +1,56 @@
+require "date"
+require "tmux/filterable_hash"
+require "tmux/exception"
+require "tmux/server"
+require "tmux/session"
+require "tmux/client"
+require "tmux/window"
+require "tmux/pane"
+require "tmux/buffer"
+require "tmux/status_bar"
+require "tmux/options_list"
+require "tmux/options"
+require "tmux/widget"
+require "tmux/version"
+
+# @todo Support querying and modifying keymaps
+module Tmux
+  # The newest version of tmux we officially support
+  TMUX_VERSION = "1.3".freeze
+
+  @binary = `which tmux`.chomp
+  @verbose = false
+
+  class << self
+    # Path of the tmux binary.
+    # @return [String]
+    attr_accessor :binary
+
+    # Print verbose information on $stderr?
+    # @return [Boolean]
+    attr_accessor :verbose
+    alias_method :verbose?, :verbose
+
+    # Invokes a tmux command and returns all output.
+    #
+    # @param [String] command Command to invoke
+    # @param [Boolean] unset_tmux If true, unsets $TMUX before calling
+    #   tmux, to allow nesting
+    # @return [String] all output
+    # @raise [Exception::UnknownCommand]
+    # @api private
+    def invoke_command(cmd, unset_tmux = false)
+      command = ""
+      command << "TMUX='' " if unset_tmux
+      command << "#{@binary} #{cmd}"
+
+      $stderr.puts(command) if verbose?
+      ret = `#{command} 2>&1`
+      if ret.start_with?("unknown command:")
+        raise Exception::UnknownCommand, ret.split(":", 2).last.strip
+      else
+        return ret
+      end
+    end
+  end
+end

data/lib/tmux/buffer.rb

@@ -0,0 +1,131 @@
+require "filesize"
+require "tempfile"
+
+module Tmux
+  class Buffer
+    # @return [Number]
+    attr_reader :number
+    # @return [Session]
+    attr_reader :session
+    # @return [Filesize]
+    def initialize(number, session)
+      @number, @session, @size = number, session
+      unless server.version >= "1.3"
+        # we do not need a temporary file for tmux versions that can
+        # directly load/save from/to stdin/stdout
+        @file = Tempfile.new("buffer")
+      end
+    end
+
+    # @param [Boolean] force_reload Ignore frozen state if true
+    # @return [Filesize]
+    attr_reader :size
+    undef_method "size"
+    def size(force_reload = false)
+      if @size && !force_reload
+        @size
+      else
+        Filesize.new(@session.buffers_information[number][:size].to_i)
+      end
+    end
+
+    # @param [Boolean] force_reload Ignore frozen state if true
+    # @return [String]
+    attr_accessor :data
+    undef_method "data"
+    undef_method "data="
+    def data(force_reload = false)
+      # note: we cannot use show-buffer because that would escape tabstops
+      if @data && !force_reload
+        @data
+      else
+        if server.version >= "1.3"
+          return server.invoke_command "save-buffer -b #@number -t #{@session.identifier} -"
+        else
+          server.invoke_command "save-buffer -b #@number -t #{@session.identifier} #{@file.path}"
+          return @file.read
+        end
+      end
+    end
+
+    def data=(new_data)
+      # FIXME maybe some more escaping?
+      server.invoke_command "set-buffer -b #@number -t #{@session.identifier} \"#{new_data}\""
+      @data = data(true) if @frozen
+      @size = size(true)
+    end
+
+    # Saves the contents of a buffer.
+    #
+    # @param [String] file The file to write to
+    # @param [Boolean] append Append to instead of overwriting the file
+    # @tmux save-buffer
+    # @return [void]
+    def save(file, append = false)
+      flag = append ? "-a" : ""
+      server.invoke_command "save-buffer #{flag} -b #@number -t #{@session.identifier} #{file}"
+    end
+    alias_method :write, :save
+
+    # By default, Buffer will not cache its data but instead query it each time.
+    # By calling this method, the data will be cached and not updated anymore.
+    #
+    # @return [void]
+    def freeze!
+      @frozen = true
+      @data = data
+      @size = size
+    end
+
+    # @return [Server]
+    attr_reader :server
+    undef_method "server"
+    def server
+      @session.server
+    end
+
+    # Deletes a buffer.
+    #
+    # @tmux delete-buffer
+    # @return [void]
+    def delete
+      freeze! # so we can still access its old value
+      server.invoke_command "delete-buffer -b #@number -t #{@session.identifier}"
+    end
+
+    # @return [String] The content of a buffer
+    def to_s
+      text
+    end
+
+    # Pastes the content of a buffer into a {Window window} or {Pane pane}.
+    #
+    # @param [Window] target The {Pane pane} or {Window window} to
+    #   paste the buffer into. Note: {Pane Panes} as as target are only
+    #   supported since tmux version 1.3.
+    # @param [Boolean] pop If true, delete the buffer from the stack
+    # @param [Boolean] translate If true, any linefeed (LF) characters
+    #   in the paste buffer are replaced with carriage returns (CR)
+    # @param [String] separator Replace any linefeed (LF) in the
+    #   buffer with this separator. +translate+ must be false.
+    #
+    # @tmux paste-buffer
+    # @tmuxver >=1.3 for pasting to {Pane panes}
+    # @return [void]
+    # @see Window#paste
+    # @see Pane#paste
+    def paste(target = nil, pop = false, translate = true, separator = nil)
+      if server.version < "1.3"
+        if separator || target.is_a?(Pane)
+          raise Exception::UnsupportedVersion, "1.3"
+        end
+      end
+
+      flag_pop       = pop ? "-d" : ""
+      flag_translate = translate ? "" : "-r"
+      flag_separator = separator ? "" : "-s \"#{separator}\"" # FIXME escape
+      window_param   = target ? "-t #{target.identifier}" : ""
+      server.invoke_command "paste-buffer #{flag_pop} #{flag_translate} #{flag_separator} #{window_param}"
+    end
+  end
+end

data/lib/tmux/client.rb

@@ -0,0 +1,193 @@
+module Tmux
+  class Client
+    # @return [Server]
+    attr_reader :server
+    # @return [String]
+    attr_reader :device
+    def initialize(server, device)
+      @server, @device = server, device
+    end
+
+    # @return [String]
+    attr_reader :identifier
+    undef_method "identifier"
+    def identifier
+      @device
+    end
+
+    # Setting this will make a client switch to another {Session session}.
+    #
+    # @tmux switch-client
+    # @return [Session]
+    attr_accessor :session
+    undef_method "session"
+    undef_method "session="
+    def session
+      @server.clients_information[@device][:session]
+    end
+
+    def session=(new_session)
+      @server.invoke_command "switch-client -c #@device -t #{new_session.number}"
+    end
+
+    # @return [Integer]
+    attr_reader :width
+    undef_method "width"
+    def width
+      @server.clients_information[@device][:width]
+    end
+
+    # @return [Integer]
+    attr_reader :height
+    undef_method "height"
+    def height
+      @server.clients_information[@device][:height]
+    end
+
+    # $TERM of a client.
+    #
+    # @return [String]
+    attr_reader :term
+    undef_method "term"
+    def term
+      @server.clients_information[@device][:term]
+    end
+
+    # True if the terminal is using UTF-8.
+    #
+    # @return [Boolean]
+    attr_reader :utf8
+    undef_method "utf8"
+    def utf8
+      @server.clients_information[@device][:utf8]
+    end
+    alias_method :utf8?, :utf8
+
+    # Detaches a client from tmux.
+    #
+    # @tmux detach-client
+    # @return [void]
+    def detach
+      @server.invoke_command "detach-client -t #@device"
+    end
+
+    # Locks a client.
+    #
+    # @tmux lock-client
+    # @return [void]
+    # @tmuxver >=1.1
+    def lock
+      @server.check_for_version!("1.1")
+
+      @server.invoke_command "lock-client -t #@device"
+    end
+
+    # Suspends a client.
+    #
+    # @tmux suspend-client
+    # @return [void]
+    def suspend
+      @server.invoke_command "suspend-client -c #@device"
+    end
+
+    # Refreshs a client.
+    #
+    # @tmux refresh-client
+    # @return [void]
+    def refresh
+      @server.invoke_command "refresh-client -t #@device"
+    end
+
+    # @tmux show-messages
+    # @return [Array<String>] A log of messages
+    # @tmuxver &gt;=1.2
+    attr_reader :messages
+    undef_method "messages"
+    def messages
+      @server.check_for_version!("1.2")
+
+      @server.invoke_command("show-messages -t #@device").split("\n")
+    end
+
+    # Displays a visible indicator of each {Pane pane} shown by a client.
+    #
+    # @tmux display-panes
+    # @return [void]
+    # @tmuxver &gt;=1.0
+    def display_panes
+      @server.check_for_version!("1.0")
+
+      @server.invoke_command("display-panes -t #@device")
+    end
+
+    # @return [Window] The currently displayed {Window window}.
+    # @tmuxver &gt;=1.2
+    attr_reader :current_window
+    undef_method "current_window"
+    def current_window
+      @server.check_for_version!("1.2")
+
+      num = @server.invoke_command("display -p -t #@device '#I'").chomp
+      session.windows[num.to_i]
+    end
+
+    # @return [Pane] The currently displayed {Pane pane}.
+    # @tmuxver &gt;=1.2
+    attr_reader :current_pane
+    undef_method "current_pane"
+    def current_pane
+      @server.check_for_version!("1.2")
+
+      output = @server.invoke_command "display-message -p -t #@device"
+      current_pane = output.match(/^.+?, current pane (\d+) . .+$/)[1]
+      current_window.panes[current_pane.to_i]
+    end
+
+    # Displays a message.
+    #
+    # @param [String] text The message to display
+    # @tmux display-message
+    # @return [void]
+    # @tmuxver &gt;=1.0
+    def message(text)
+      @server.check_for_version!("1.0")
+
+      @server.invoke_command "display-message -t #@device \"#{text}\""
+    end
+
+    # Opens a prompt inside a client allowing a {Window window} index to be entered interactively.
+    #
+    # @tmux command-prompt + select-window
+    # @return [void]
+    def select_interactively
+      command_prompt "select-window -t:%%", ["index"]
+    end
+
+    # Opens a command prompt in the client. This may be used to
+    # execute commands interactively.
+    #
+    # @param [String] template The template is used as the command to
+    #   execute. Before the command is executed, the first occurrence
+    #   of the string '%%' and all occurrences of '%1' are replaced by
+    #   the response to the first prompt, the second '%%' and all '%2'
+    #   are replaced with the response to the second prompt, and so on
+    #   for further prompts. Up to nine prompt responses may be
+    #   replaced ('%1' to '%9')
+    #
+    # @param [Array<String>] prompts prompts is a list
+    #   of prompts which are displayed in order; otherwise a single
+    #   prompt is displayed, constructed from template
+    #
+    # @return [void]
+    # @tmux command-prompt
+    # @todo escape prompts and template
+    def command_prompt(template, prompts = [])
+      prompts = prompts.join(",")
+      flags = []
+      flags << "-p #{prompts}" unless prompts.empty?
+      flags << "-t #{identifier}"
+      flags << "\"#{template}\""
+      @server.invoke_command "command-prompt #{flags.join(" ")}"
+    end
+  end
+end

data/lib/tmux/exception.rb

@@ -0,0 +1,5 @@
+require "tmux/exception/basic_exception"
+require "tmux/exception/in_tmux"
+require "tmux/exception/index_in_use"
+require "tmux/exception/unknown_command"
+require "tmux/exception/unsupported_version"

data/lib/tmux/exception/basic_exception.rb

@@ -0,0 +1,6 @@
+module Tmux
+  module Exception
+    class BasicException < StandardError
+    end
+  end
+end

data/lib/tmux/exception/in_tmux.rb

@@ -0,0 +1,9 @@
+module Tmux
+  module Exception
+    class InTmux < RuntimeError
+      def initialize(command)
+        super("This command should not be run from inside tmux: #{command}")
+      end
+    end
+  end
+end