123456789_123456789_123456789_123456789_123456789_

Class: Reline::ANSI

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, IO
Instance Chain:
self, IO
Inherits: Reline::IO
Defined in: lib/reline/io/ansi.rb

Constant Summary

  • ANSI_CURSOR_KEY_BINDINGS =
    # File 'lib/reline/io/ansi.rb', line 17
    {
      # Up
      'A' => [:ed_prev_history, {}],
      # Down
      'B' => [:ed_next_history, {}],
      # Right
      'C' => [:ed_next_char, { ctrl: :em_next_word, meta: :em_next_word }],
      # Left
      'D' => [:ed_prev_char, { ctrl: :ed_prev_word, meta: :ed_prev_word }],
      # End
      'F' => [:ed_move_to_end, {}],
      # Home
      'H' => [:ed_move_to_beg, {}],
    }
  • CAPNAME_KEY_BINDINGS =
    # File 'lib/reline/io/ansi.rb', line 5
    {
      'khome' => :ed_move_to_beg,
      'kend'  => :ed_move_to_end,
      'kdch1' => :key_delete,
      'kpp' => :ed_search_prev_history,
      'knp' => :ed_search_next_history,
      'kcuu1' => :ed_prev_history,
      'kcud1' => :ed_next_history,
      'kcuf1' => :ed_next_char,
      'kcub1' => :ed_prev_char,
    }
  • END_BRACKETED_PASTE =
    # File 'lib/reline/io/ansi.rb', line 148
    String.new("\e[201~", encoding: Encoding::ASCII_8BIT)
  • START_BRACKETED_PASTE =
    # File 'lib/reline/io/ansi.rb', line 147
    String.new("\e[200~", encoding: Encoding::ASCII_8BIT)

IO - Inherited

RESET_COLOR

Class Method Summary

IO - Inherited

Instance Attribute Summary

Instance Method Summary

Constructor Details

.newANSI

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 32

def initialize
  @input = STDIN
  @output = STDOUT
  @buf = []
  @old_winch_handler = nil
end

Instance Attribute Details

#both_tty?Boolean (readonly)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 234

def both_tty?
  @input.tty? && @output.tty?
end

#empty_buffer?Boolean (readonly)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 169

def empty_buffer?
  unless @buf.empty?
    return false
  end
  !@input.wait_readable(0)
end

#in_pasting?Boolean (readonly)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 165

def in_pasting?
  not empty_buffer?
end

#input=(val) (writeonly)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 114

def input=(val)
  @input = val
end

#output=(val) (writeonly)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 118

def output=(val)
  @output = val
end

Instance Method Details

#clear_screen

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 278

def clear_screen
  @output.write "\e[2J"
  @output.write "\e[1;1H"
end

#cursor_pos

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 229

def cursor_pos
  col, row = cursor_pos_internal(timeout: 0.5) if both_tty?
  Reline::CursorPos.new(col || 0, row || 0)
end

#cursor_pos_internal(timeout:) (private)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 208

private def cursor_pos_internal(timeout:)
  match = nil
  @input.raw do |stdin|
    @output << "\e[6n"
    @output.flush
    timeout_at = Time.now + timeout
    buf = +''
    while (wait = timeout_at - Time.now) > 0 && stdin.wait_readable(wait)
      buf << stdin.readpartial(1024)
      if (match = buf.match(/\e\[(?<row>\d);(?<column>\d)R/))
        buf = match.pre_match + match.post_match
        break
      end
    end
    buf.chars.reverse_each do |ch|
      stdin.ungetc ch
    end
  end
  [match[:column].to_i - 1, match[:row].to_i - 1] if match
end

#deprep(otio)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 301

def deprep(otio)
  # Disable bracketed paste
  @output.write "\e[?2004l" if Reline.core.config.enable_bracketed_paste && both_tty?
  Signal.trap('WINCH', @old_winch_handler) if @old_winch_handler
  Signal.trap('CONT', @old_cont_handler) if @old_cont_handler
end

#encoding

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 39

def encoding
  @input.external_encoding || Encoding.default_external
end

#erase_after_cursor

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 266

def erase_after_cursor
  @output.write "\e[K"
end

#get_screen_size

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 191

def get_screen_size
  s = @input.winsize
  return s if s[0] > 0 && s[1] > 0
  s = [ENV["LINES"].to_i, ENV["COLUMNS"].to_i]
  return s if s[0] > 0 && s[1] > 0
  [24, 80]
rescue Errno::ENOTTY, Errno::ENODEV
  [24, 80]
end

#getc(timeout_second)

if the usage expects to wait indefinitely, use Float::INFINITY for timeout_second

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 161

def getc(timeout_second)
  inner_getc(timeout_second)
end

#hide_cursor

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 258

def hide_cursor
  @output.write "\e[?25l"
end

#inner_getc(timeout_second)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 130

def inner_getc(timeout_second)
  unless @buf.empty?
    return @buf.shift
  end
  until @input.wait_readable(0.01)
    timeout_second -= 0.01
    return nil if timeout_second <= 0

    Reline.core.line_editor.handle_signal
  end
  c = @input.getbyte
  (c == 0x16 && @input.tty? && @input.raw(min: 0, time: 0, &:getbyte)) || c
rescue Errno::EIO
  # Maybe the I/O has been closed.
  nil
end

#move_cursor_column(x)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 238

def move_cursor_column(x)
  @output.write "\e[#{x + 1}G"
end

#move_cursor_down(x)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 250

def move_cursor_down(x)
  if x > 0
    @output.write "\e[#{x}B"
  elsif x < 0
    move_cursor_up(-x)
  end
end

#move_cursor_up(x)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 242

def move_cursor_up(x)
  if x > 0
    @output.write "\e[#{x}A"
  elsif x < 0
    move_cursor_down(-x)
  end
end

#prep

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 294

def prep
  # Enable bracketed paste
  @output.write "\e[?2004h" if Reline.core.config.enable_bracketed_paste && both_tty?
  retrieve_keybuffer
  nil
end

#read_bracketed_paste

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 149

def read_bracketed_paste
  buffer = String.new(encoding: Encoding::ASCII_8BIT)
  until buffer.end_with?(END_BRACKETED_PASTE)
    c = inner_getc(Float::INFINITY)
    break unless c
    buffer << c
  end
  string = buffer.delete_suffix(END_BRACKETED_PASTE).force_encoding(encoding)
  string.valid_encoding? ? string : ''
end

#retrieve_keybuffer

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 180

def retrieve_keybuffer
  begin
    return unless @input.wait_readable(0.001)
    str = @input.read_nonblock(1024)
    str.bytes.each do |c|
      @buf.push(c)
    end
  rescue EOFError
  end
end

#scroll_down(x)

This only works when the cursor is at the bottom of the scroll range For more details, see github.com/ruby/reline/pull/577#issuecomment-1646679623

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 272

def scroll_down(x)
  return if x.zero?
  # We use `\n` instead of CSI + S because CSI + S would cause https://github.com/ruby/reline/issues/576
  @output.write "\n" * x
end

#set_bracketed_paste_key_bindings(config)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 62

def set_bracketed_paste_key_bindings(config)
  [:emacs, :vi_insert, :vi_command].each do |keymap|
    config.add_default_key_binding_by_keymap(keymap, START_BRACKETED_PASTE.bytes, :bracketed_paste_start)
  end
end

#set_default_key_bindings(config)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 43

def set_default_key_bindings(config)
  set_bracketed_paste_key_bindings(config)
  set_default_key_bindings_ansi_cursor(config)
  set_default_key_bindings_comprehensive_list(config)
  {
    [27, 91, 90] => :completion_journey_up, # S-Tab
  }.each_pair do |key, func|
    config.add_default_key_binding_by_keymap(:emacs, key, func)
    config.add_default_key_binding_by_keymap(:vi_insert, key, func)
  end
  {
    # default bindings
    [27, 32] => :em_set_mark,             # M-<space>
    [24, 24] => :em_exchange_mark,        # C-x C-x
  }.each_pair do |key, func|
    config.add_default_key_binding_by_keymap(:emacs, key, func)
  end
end

#set_default_key_bindings_ansi_cursor(config)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 68

def set_default_key_bindings_ansi_cursor(config)
  ANSI_CURSOR_KEY_BINDINGS.each do |char, (default_func, modifiers)|
    bindings = [
      ["\e[#{char}", default_func], # CSI + char
      ["\eO#{char}", default_func] # SS3 + char, application cursor key mode
    ]
    if modifiers[:ctrl]
      # CSI + ctrl_key_modifier + char
      bindings << ["\e[1;5#{char}", modifiers[:ctrl]]
    end
    if modifiers[:meta]
      # CSI + meta_key_modifier + char
      bindings << ["\e[1;3#{char}", modifiers[:meta]]
      # Meta(ESC) + CSI + char
      bindings << ["\e\e[#{char}", modifiers[:meta]]
    end
    bindings.each do |sequence, func|
      key = sequence.bytes
      config.add_default_key_binding_by_keymap(:emacs, key, func)
      config.add_default_key_binding_by_keymap(:vi_insert, key, func)
      config.add_default_key_binding_by_keymap(:vi_command, key, func)
    end
  end
end

#set_default_key_bindings_comprehensive_list(config)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 93

def set_default_key_bindings_comprehensive_list(config)
  {
    # xterm
    [27, 91, 51, 126] => :key_delete, # kdch1
    [27, 91, 53, 126] => :ed_search_prev_history, # kpp
    [27, 91, 54, 126] => :ed_search_next_history, # knp

    # Console (80x25)
    [27, 91, 49, 126] => :ed_move_to_beg, # Home
    [27, 91, 52, 126] => :ed_move_to_end, # End

    # urxvt / exoterm
    [27, 91, 55, 126] => :ed_move_to_beg, # Home
    [27, 91, 56, 126] => :ed_move_to_end, # End
  }.each_pair do |key, func|
    config.add_default_key_binding_by_keymap(:emacs, key, func)
    config.add_default_key_binding_by_keymap(:vi_insert, key, func)
    config.add_default_key_binding_by_keymap(:vi_command, key, func)
  end
end

#set_screen_size(rows, columns)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 201

def set_screen_size(rows, columns)
  @input.winsize = [rows, columns]
  self
rescue Errno::ENOTTY, Errno::ENODEV
  self
end

#set_winch_handler(&handler)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 283

def set_winch_handler(&handler)
  @old_winch_handler = Signal.trap('WINCH', &handler)
  @old_cont_handler = Signal.trap('CONT') do
    @input.raw!(intr: true) if @input.tty?
    # Rerender the screen. Note that screen size might be changed while suspended.
    handler.call
  end
rescue ArgumentError
  # Signal.trap may raise an ArgumentError if the platform doesn't support the signal.
end

#show_cursor

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 262

def show_cursor
  @output.write "\e[?25h"
end

#ungetc(c)

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 176

def ungetc(c)
  @buf.unshift(c)
end

#with_raw_input

[ GitHub ]

  
# File 'lib/reline/io/ansi.rb', line 122

def with_raw_input
  if @input.tty?
    @input.raw(intr: true) { yield }
  else
    yield
  end
end