Class: Tmux::Window

Inherits:

Object

• Object
• Tmux::Window

show all

Includes:

Comparable

Defined in:

lib/tmux/window.rb,
lib/tmux/window/status.rb,
lib/tmux/window/status/state.rb

Overview

Defined Under Namespace

Classes: Status

Instance Attribute Summary (collapse)

• - (Boolean) aggressive_resize (also: #aggressive_resize?)

  Aggressively resize the window.

• - (Boolean) alternate_screen (also: #alternate_screen?)

  This option configures whether programs running inside tmux may use the terminal alternate screen feature, which allows the smcup and rmcup terminfo(5) capabilities to be issued to preserve the existing window content on start and restore it on exit.

• - (Boolean) automatic_rename (also: #automatic_rename?)

  Control automatic window renaming.

• - (Symbol<:twelve, :twenty_four>) clock_mode_style

  Clock hour format.

• - (Integer) height readonly
• - (String) identifier readonly
• - (Symbol<:even_horizontal, :even_vertical, :main_horizontal, :main_vertical>) layout writeonly
• - (Number) main_pane_height

  The height of the main (left or top) pane in the main-horizontal or main-vertical layouts.

• - (Number) main_pane_width

  The width of the main (left or top) pane in the main-horizontal or main-vertical layouts.

• - (Number) max_height (also: #force_height)

  Prevent tmux from resizing the window to greater than max_height.

• - (Number) max_width (also: #force_width)

  Prevent tmux from resizing the window to greater than max_width.

• - (Symbol) mode_attr
• - (Symbol) mode_bg
• - (Symbol) mode_fg
• - (Symbol) mode_keys
• - (Boolean) mode_mouse (also: #mode_mouse?)

  Mouse state in modes.

• - (Boolean) monitor_activity (also: #monitor_activity?)

  Monitor for activity in the window.

• - (String) monitor_content

  Monitor content in the window.

• - (String) name
• - (Number) number
• - (OptionsList) options readonly
• - (Array<Pane>) panes readonly

  All panes.

• - (Boolean) remain_on_exit (also: #remain_on_exit?)

  A window with this flag set is not destroyed when the program running in it exits.

• - (Server) server readonly
• - (Session) session

  Moves the window to another session.

• - (Status) status readonly
• - (Boolean) synchronize_panes (also: #synchronize_panes?)

  Duplicate input to any pane to all other panes in the same window (only for panes that are not in any special mode).

• - (Boolean) utf8 (also: #utf8?)

  Instructs tmux to expect UTF-8 sequences to appear in this window.

• - (Integer) width readonly
• - (Array<String>) word_separators

  Sets the window's conception of what characters are considered word separators, for the purposes of the next and previous word commands in copy mode.

• - (Boolean) xterm_keys (also: #xterm_keys?)

  If this option is set to true, tmux will generate xterm(1)-style function key sequences.

Class Method Summary (collapse)

• + (OptionsList) options(server)

Instance Method Summary (collapse)

• - (Undefined) <=>(other)
• - (Boolean) ==(other)
• - (Symbol) clock_mode_color (also: #clock_mode_colour)

  Clock color.

• - (Symbol) clock_mode_color=(color) (also: #clock_mode_colour=)
• - (Pane^?) current_pane(return_if = :always)

  The current pane.

• - (Boolean) eql?(other)
• - (Number) hash
• - (Window) initialize(session, number) constructor

  A new instance of Window.

• - kill

  Kills the window.

• - move(new_session, new_number)

  Moves the window to either a different session, a different position or both.

• - (Hash) panes_information(search = {})

  A hash with information for all panes.

• - paste(buffer, pop = false, translate = true, separator = nil)

  Pastes a buffer into the window.

• - respawn(command = nil, kill = false)

  Reactivates a window in which the command has exited.

• - rotate(direction = :upward)

  Rotates the positions of the panes within a window.

• - select

  Select the window.

• - (Pane^?) select_last_pane(return_if = :always)

  Select the previously selected pane.

• - swap_with(window)

  Swap the window with another one.

32
33
34
35
36

# File 'lib/tmux/window.rb', line 32

def initialize(session, number)
  @session, @number = session, number
  @options = OptionsList.new(:window, self, false)
  @status = Status.new(self)
end

174
175
176

# File 'lib/tmux/window.rb', line 174

def aggressive_resize
  @options.aggressive_resize
end

375
376
377

# File 'lib/tmux/window.rb', line 375

def alternate_screen
  @options.alternate_screen
end

195
196
197

# File 'lib/tmux/window.rb', line 195

def automatic_rename
  @options.automatic_rename
end

426
427
428

# File 'lib/tmux/window.rb', line 426

def clock_mode_style
  @options.clock_mode_style
end

150
151
152
153
154

# File 'lib/tmux/window.rb', line 150

def height
  server.check_for_version!("1.1")

  @session.windows_information[@number][:height]
end

159
160
161

# File 'lib/tmux/window.rb', line 159

def identifier
  "%s:%s" % [@session.identifier, @number]
end

550
551
552
553
554
555
556
557
558

# File 'lib/tmux/window.rb', line 550

def layout=(layout)
  server.check_for_version!("1.0")
  raise Exception::UnsupportedVersion, "1.3" if layout == :tiled && server.version < "1.3"

  valid_layouts = [:even_horizontal, :even_vertical, :main_horizontal, :main_vertical, :tiled]
  raise ArgumentError unless valid_layouts.include?(layout)
  layout = layout.to_s.tr("_", "-")
  server.invoke_command "select-layout -t #{identifier} #{layout}"
end

443
444
445

# File 'lib/tmux/window.rb', line 443

def main_pane_height
  @options.main_pane_height
end

460
461
462

# File 'lib/tmux/window.rb', line 460

def main_pane_width
  @options.main_pane_width
end

318
319
320

# File 'lib/tmux/window.rb', line 318

def max_height
  @options.force_height
end

299
300
301

# File 'lib/tmux/window.rb', line 299

def max_width
  @options.force_width
end

473
474
475

# File 'lib/tmux/window.rb', line 473

def mode_attr
  @options.mode_attr
end

485
486
487

# File 'lib/tmux/window.rb', line 485

def mode_bg
  @options.mode_bg
end

497
498
499

# File 'lib/tmux/window.rb', line 497

def mode_fg
  @options.mode_fg
end

510
511
512

# File 'lib/tmux/window.rb', line 510

def mode_keys
  @options.mode_keys
end

393
394
395

# File 'lib/tmux/window.rb', line 393

def mode_mouse
  @options.mode_mouse
end

264
265
266

# File 'lib/tmux/window.rb', line 264

def monitor_activity
  @options.monitor_activity
end

282
283
284

# File 'lib/tmux/window.rb', line 282

def monitor_content
  @options.monitor_content
end

124
125
126
127
128

# File 'lib/tmux/window.rb', line 124

def name
  server.check_for_version!("1.1")

  @session.windows_information[@number][:name]
end

22
23
24

# File 'lib/tmux/window.rb', line 22

def number
  @number
end

28
29
30

# File 'lib/tmux/window.rb', line 28

def options
  @options
end

599
600
601
602
603
604
605

# File 'lib/tmux/window.rb', line 599

def panes
  server.check_for_version!("1.1")

  panes_information.map do |num, information|
    Pane.new(self, num)
  end
end

230
231
232

# File 'lib/tmux/window.rb', line 230

def remain_on_exit
  @options.remain_on_exit
end

116
117
118

# File 'lib/tmux/window.rb', line 116

def server
  @session.server
end

25
26
27

# File 'lib/tmux/window.rb', line 25

def session
  @session
end

31
32
33

# File 'lib/tmux/window.rb', line 31

def status
  @status
end

213
214
215

# File 'lib/tmux/window.rb', line 213

def synchronize_panes
  @options.synchronize_panes
end

247
248
249

# File 'lib/tmux/window.rb', line 247

def utf8
  @options.utf8
end

140
141
142
143
144

# File 'lib/tmux/window.rb', line 140

def width
  server.check_for_version!("1.1")

  @session.windows_information[@number][:width]
end

357
358
359

# File 'lib/tmux/window.rb', line 357

def word_separators
  @options.word_separators
end

338
339
340

# File 'lib/tmux/window.rb', line 338

def xterm_keys
  @options.xterm_keys
end

16
17
18

# File 'lib/tmux/window.rb', line 16

def options(server)
  OptionsList.new(:window, server, true)
end

93
94
95
96

# File 'lib/tmux/window.rb', line 93

def <=>(other)
  return nil unless other.is_a?(Window)
  [@session, @number] <=> [other.session, other.number]
end

99
100
101

# File 'lib/tmux/window.rb', line 99

def ==(other)
  self.class == other.class && @session == other.session && @number == other.number
end

409
410
411

# File 'lib/tmux/window.rb', line 409

def clock_mode_color
  @options.clock_mode_colour
end

416
417
418

# File 'lib/tmux/window.rb', line 416

def clock_mode_color=(color)
  @options.clock_mode_colour = color
end

644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672

# File 'lib/tmux/window.rb', line 644

def current_pane(return_if = :always)
  if server.version >= "1.4"
    self.panes.find(&:active?)
  else
    # In tmux <1.4, we can only determine the selected pane of the
    # current window.
    #
    # If the user specified return_if = :always, we select this
    # window (if it is not already selected), determine the
    # current pane and select the lastly selected window again.
    cur_window = self.session.any_client.current_window
    same_window = cur_window == self
    return_if_b = ((return_if == :if_same_window && same_window) || (return_if == :always))

    self.select if return_if_b && !same_window

    new_pane = nil
    if return_if_b
      num = self.session.any_client.message_stdout("#P")
      new_pane = Pane.new(self, num.to_i)
    end

    if return_if == :always && !same_window
      self.session.select_previous_window
    end

    return new_pane if new_pane
  end
end

109
110
111

# File 'lib/tmux/window.rb', line 109

def eql?(other)
  self == other
end

104
105
106

# File 'lib/tmux/window.rb', line 104

def hash
  [@session.hash, @number].hash
end

523
524
525

# File 'lib/tmux/window.rb', line 523

def kill
  server.invoke_command "kill-window -t #{identifier}"
end

81
82
83
84
85
86
87
88
89
90
91

# File 'lib/tmux/window.rb', line 81

def move(new_session, new_number)
  return if @session == new_session && @number == new_number
  target = "%s:%s" % [new_session.identifier, new_number]

  res = server.invoke_command("move-window -s #{identifier} -t #{target}")
  if res =~ /^can't move window: index in use: \d+/
    raise IndexInUse, [new_session, new_number]
  end
  @session = new_session
  @number  = new_number
end

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593

# File 'lib/tmux/window.rb', line 564

def panes_information(search={})
  server.check_for_version!("1.1")

  hash = {}
  output = server.invoke_command "list-panes -t #{identifier}"
  output.each_line do |pane|
    params = pane.match(/^(?<num>\d+): \[(?<width>\d+)x(?<height>\d+)\] \[history (?<cur_history>\d+)\/(?<max_history>\d+), (?<memory>\d+) bytes\]( %\d+)?(?<active> \(active\))?$/)
    num = params[:num].to_i
    width = params[:width].to_i
    height = params[:height].to_i
    cur_history = params[:cur_history].to_i
    max_history = params[:max_history].to_i
    memory = Filesize.new(params[:memory].to_i)

    # this flag requires tmux >=1.4
    active = !params[:active].nil?

    hash[num] = {
      :num => num,
      :width => width,
      :height => height,
      :cur_history => cur_history,
      :max_history => max_history,
      :memory => memory,
      :active => active,
    }
  end
  hash.extend FilterableHash
  hash.filter(search)
end

617
618
619

# File 'lib/tmux/window.rb', line 617

def paste(buffer, pop = false, translate = true, separator = nil)
  buffer.paste(self, pop, translate, separator)
end

695
696
697
698
699
700
701
702

# File 'lib/tmux/window.rb', line 695

def respawn(command = nil, kill = false)
  flags = []
  flags << "-k" if kill
  flags << "-t #{identifier}"
  flags << "\"#{command}\"" if command

  server.invoke_command "respawn-window #{flags.join(" ")}"
end

531
532
533
534
535
536
537
538
539
540
541

# File 'lib/tmux/window.rb', line 531

def rotate(direction = :upward)
  flag = case direction
         when :upward
           "U"
         when :downward
           "D"
         else
           raise ArgumentError
         end
  server.invoke_command "rotate-window -#{flag} -t #{identifier}"
end

625
626
627

# File 'lib/tmux/window.rb', line 625

def select
  server.invoke_command "select-window -t #{identifier}"
end

680
681
682
683

# File 'lib/tmux/window.rb', line 680

def select_last_pane(return_if = :always)
  server.invoke_command("last-pane -t #{identifier}")
  current_pane(return_if)
end

634
635
636

# File 'lib/tmux/window.rb', line 634

def swap_with(window)
  server.invoke_command "swap-window -s #{identifier} -t #{window.identifier}"
end