# class Reline::ANSI

### Constants

ANSI_CURSOR_KEY_BINDINGS
CAPNAME_KEY_BINDINGS
END_BRACKETED_PASTE
RESET_COLOR
START_BRACKETED_PASTE

### Public Class Methods

clear_screen() click to toggle source

    # File lib/reline/ansi.rb, line 340
    def self.clear_screen
      @@output.write "\e[2J"
      @@output.write "\e[1;1H"
    end

cursor_pos() click to toggle source

    # File lib/reline/ansi.rb, line 249
    def self.cursor_pos
      begin
        res = +''
        m = nil
        @@input.raw do |stdin|
          @@output << "\e[6n"
          @@output.flush
          loop do
            c = stdin.getc
            next if c.nil?
            res << c
            m = res.match(/\e\[(?<row>\d+);(?<column>\d+)R/)
            break if m
          end
          (m.pre_match + m.post_match).chars.reverse_each do |ch|
            stdin.ungetc ch
          end
        end
        column = m[:column].to_i - 1
        row = m[:row].to_i - 1
      rescue Errno::ENOTTY
        begin
          buf = @@output.pread(@@output.pos, 0)
          row = buf.count("\n")
          column = buf.rindex("\n") ? (buf.size - buf.rindex("\n")) - 1 : 0
        rescue Errno::ESPIPE, IOError
          # Just returns column 1 for ambiguous width because this I/O is not
          # tty and can't seek.
          row = 0
          column = 1
        end
      end
      Reline::CursorPos.new(column, row)
    end

deprep(otio) click to toggle source

    # File lib/reline/ansi.rb, line 357
    def self.deprep(otio)
      # Disable bracketed paste
      @@output.write "\e[?2004l" if Reline.core.config.enable_bracketed_paste
      Signal.trap('WINCH', @@old_winch_handler) if @@old_winch_handler
    end

empty_buffer?() click to toggle source

    # File lib/reline/ansi.rb, line 210
    def self.empty_buffer?
      unless @@buf.empty?
        return false
      end
      !@@input.wait_readable(0)
    end

encoding() click to toggle source

    # File lib/reline/ansi.rb, line 39
    def self.encoding
      Encoding.default_external
    end

erase_after_cursor() click to toggle source

    # File lib/reline/ansi.rb, line 328
    def self.erase_after_cursor
      @@output.write "\e[K"
    end

get_screen_size() click to toggle source

    # File lib/reline/ansi.rb, line 232
    def self.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
      [24, 80]
    end

getc(timeout_second) click to toggle source

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

    # File lib/reline/ansi.rb, line 202
    def self.getc(timeout_second)
      inner_getc(timeout_second)
    end

hide_cursor() click to toggle source

    # File lib/reline/ansi.rb, line 304
    def self.hide_cursor
      if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
        begin
          @@output.write Reline::Terminfo.tigetstr('civis')
        rescue Reline::Terminfo::TerminfoError
          # civis is undefined
        end
      else
        # ignored
      end
    end

in_pasting?() click to toggle source

    # File lib/reline/ansi.rb, line 206
    def self.in_pasting?
      not empty_buffer?
    end

inner_getc(timeout_second) click to toggle source

    # File lib/reline/ansi.rb, line 169
    def self.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.raw(min: 0, time: 0, &:getbyte)) || c
    rescue Errno::EIO
      # Maybe the I/O has been closed.
      nil
    rescue Errno::ENOTTY
      nil
    end

input=(val) click to toggle source

    # File lib/reline/ansi.rb, line 151
    def self.input=(val)
      @@input = val
    end

move_cursor_column(x) click to toggle source

    # File lib/reline/ansi.rb, line 284
    def self.move_cursor_column(x)
      @@output.write "\e[#{x + 1}G"
    end

move_cursor_down(x) click to toggle source

    # File lib/reline/ansi.rb, line 296
    def self.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) click to toggle source

    # File lib/reline/ansi.rb, line 288
    def self.move_cursor_up(x)
      if x > 0
        @@output.write "\e[#{x}A"
      elsif x < 0
        move_cursor_down(-x)
      end
    end

output=(val) click to toggle source

    # File lib/reline/ansi.rb, line 156
    def self.output=(val)
      @@output = val
    end

prep() click to toggle source

    # File lib/reline/ansi.rb, line 350
    def self.prep
      # Enable bracketed paste
      @@output.write "\e[?2004h" if Reline.core.config.enable_bracketed_paste
      retrieve_keybuffer
      nil
    end

read_bracketed_paste() click to toggle source

    # File lib/reline/ansi.rb, line 190
    def self.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() click to toggle source

    # File lib/reline/ansi.rb, line 221
    def self.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) click to toggle source

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/ansi.rb, line 334
    def self.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) click to toggle source

    # File lib/reline/ansi.rb, line 70
    def self.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) click to toggle source

    # File lib/reline/ansi.rb, line 47
    def self.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) click to toggle source

    # File lib/reline/ansi.rb, line 76
    def self.set_default_key_bindings_ansi_cursor(config)
      ANSI_CURSOR_KEY_BINDINGS.each do |char, (default_func, modifiers)|
        bindings = [["\e[#{char}", default_func]] # CSI + char
        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) click to toggle source

    # File lib/reline/ansi.rb, line 115
    def self.set_default_key_bindings_comprehensive_list(config)
      {
        # Console (80x25)
        [27, 91, 49, 126] => :ed_move_to_beg, # Home
        [27, 91, 52, 126] => :ed_move_to_end, # End
        [27, 91, 51, 126] => :key_delete,     # Del

        # KDE
        # Del is 0x08
        [27, 71, 65] => :ed_prev_history,     # ↑
        [27, 71, 66] => :ed_next_history,     # ↓
        [27, 71, 67] => :ed_next_char,        # →
        [27, 71, 68] => :ed_prev_char,        # ←

        # urxvt / exoterm
        [27, 91, 55, 126] => :ed_move_to_beg, # Home
        [27, 91, 56, 126] => :ed_move_to_end, # End

        # GNOME
        [27, 79, 72] => :ed_move_to_beg,      # Home
        [27, 79, 70] => :ed_move_to_end,      # End
        # Del is 0x08
        # Arrow keys are the same of KDE

        [27, 79, 65] => :ed_prev_history,     # ↑
        [27, 79, 66] => :ed_next_history,     # ↓
        [27, 79, 67] => :ed_next_char,        # →
        [27, 79, 68] => :ed_prev_char,        # ←
      }.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) click to toggle source

    # File lib/reline/ansi.rb, line 98
    def self.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) click to toggle source

    # File lib/reline/ansi.rb, line 242
    def self.set_screen_size(rows, columns)
      @@input.winsize = [rows, columns]
      self
    rescue Errno::ENOTTY
      self
    end

set_winch_handler(&handler) click to toggle source

    # File lib/reline/ansi.rb, line 346
    def self.set_winch_handler(&handler)
      @@old_winch_handler = Signal.trap('WINCH', &handler)
    end

show_cursor() click to toggle source

    # File lib/reline/ansi.rb, line 316
    def self.show_cursor
      if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
        begin
          @@output.write Reline::Terminfo.tigetstr('cnorm')
        rescue Reline::Terminfo::TerminfoError
          # cnorm is undefined
        end
      else
        # ignored
      end
    end

ungetc(c) click to toggle source

    # File lib/reline/ansi.rb, line 217
    def self.ungetc(c)
      @@buf.unshift(c)
    end

win?() click to toggle source

    # File lib/reline/ansi.rb, line 43
    def self.win?
      false
    end

with_raw_input() { || ... } click to toggle source

    # File lib/reline/ansi.rb, line 160
    def self.with_raw_input
      if @@input.tty?
        @@input.raw(intr: true) { yield }
      else
        yield
      end
    end