class Reline::ANSI

Constants

ANSI_CURSOR_KEY_BINDINGS
CAPNAME_KEY_BINDINGS
END_BRACKETED_PASTE
START_BRACKETED_PASTE

Public Class Methods

new ()
# File lib/reline/io/ansi.rb, line 36
def initialize
  @input = STDIN
  @output = STDOUT
  @buf = []
  @old_winch_handler = nil
end

Public Instance Methods

both_tty? ()
# File lib/reline/io/ansi.rb, line 259
def both_tty?
  @input.tty? && @output.tty?
end
clear_screen ()
# File lib/reline/io/ansi.rb, line 319
def clear_screen
  @output.write "\e[2J"
  @output.write "\e[1;1H"
end
cursor_pos ()
# File lib/reline/io/ansi.rb, line 254
def cursor_pos
  col, row = cursor_pos_internal(timeout: 0.5) if both_tty?
  Reline::CursorPos.new(col || 0, row || 0)
end
deprep (otio)
# File lib/reline/io/ansi.rb, line 342
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
empty_buffer? ()
# File lib/reline/io/ansi.rb, line 194
def empty_buffer?
  unless @buf.empty?
    return false
  end
  !@input.wait_readable(0)
end
encoding ()
# File lib/reline/io/ansi.rb, line 43
def encoding
  Encoding.default_external
end
erase_after_cursor ()
# File lib/reline/io/ansi.rb, line 307
def erase_after_cursor
  @output.write "\e[K"
end
get_screen_size ()
# File lib/reline/io/ansi.rb, line 216
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

# File lib/reline/io/ansi.rb, line 186
def getc(timeout_second)
  inner_getc(timeout_second)
end
hide_cursor ()
# File lib/reline/io/ansi.rb, line 283
def hide_cursor
  seq = "\e[?25l"
  if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
    begin
      seq = Reline::Terminfo.tigetstr('civis')
    rescue Reline::Terminfo::TerminfoError
      # civis is undefined
    end
  end
  @output.write seq
end
in_pasting? ()
# File lib/reline/io/ansi.rb, line 190
def in_pasting?
  not empty_buffer?
end
inner_getc (timeout_second)
# File lib/reline/io/ansi.rb, line 155
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
input= (val)
# File lib/reline/io/ansi.rb, line 139
def input=(val)
  @input = val
end
move_cursor_column (x)
# File lib/reline/io/ansi.rb, line 263
def move_cursor_column(x)
  @output.write "\e[#{x + 1}G"
end
move_cursor_down (x)
# File lib/reline/io/ansi.rb, line 275
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)
# File lib/reline/io/ansi.rb, line 267
def move_cursor_up(x)
  if x > 0
    @output.write "\e[#{x}A"
  elsif x < 0
    move_cursor_down(-x)
  end
end
output= (val)
# File lib/reline/io/ansi.rb, line 143
def output=(val)
  @output = val
end
prep ()
# File lib/reline/io/ansi.rb, line 335
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 ()
# File lib/reline/io/ansi.rb, line 174
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 ()
# File lib/reline/io/ansi.rb, line 205
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

# File lib/reline/io/ansi.rb, line 313
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)
# File lib/reline/io/ansi.rb, line 70
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, allow_terminfo: true)
# File lib/reline/io/ansi.rb, line 47
def set_default_key_bindings(config, allow_terminfo: true)
  set_bracketed_paste_key_bindings(config)
  set_default_key_bindings_ansi_cursor(config)
  if allow_terminfo && Reline::Terminfo.enabled?
    set_default_key_bindings_terminfo(config)
  else
    set_default_key_bindings_comprehensive_list(config)
  end
  {
    [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)
# File lib/reline/io/ansi.rb, line 76
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)
# File lib/reline/io/ansi.rb, line 118
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_default_key_bindings_terminfo (config)
# File lib/reline/io/ansi.rb, line 101
def set_default_key_bindings_terminfo(config)
  key_bindings = CAPNAME_KEY_BINDINGS.map do |capname, key_binding|
    begin
      key_code = Reline::Terminfo.tigetstr(capname)
      [ key_code.bytes, key_binding ]
    rescue Reline::Terminfo::TerminfoError
      # capname is undefined
    end
  end.compact.to_h

  key_bindings.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)
# File lib/reline/io/ansi.rb, line 226
def set_screen_size(rows, columns)
  @input.winsize = [rows, columns]
  self
rescue Errno::ENOTTY, Errno::ENODEV
  self
end
set_winch_handler (&handler)
# File lib/reline/io/ansi.rb, line 324
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 ()
# File lib/reline/io/ansi.rb, line 295
def show_cursor
  seq = "\e[?25h"
  if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
    begin
      seq = Reline::Terminfo.tigetstr('cnorm')
    rescue Reline::Terminfo::TerminfoError
      # cnorm is undefined
    end
  end
  @output.write seq
end
ungetc (c)
# File lib/reline/io/ansi.rb, line 201
def ungetc(c)
  @buf.unshift(c)
end
with_raw_input () { || ... }
# File lib/reline/io/ansi.rb, line 147
def with_raw_input
  if @input.tty?
    @input.raw(intr: true) { yield }
  else
    yield
  end
end