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 188String.new("\e[201~", encoding: Encoding::ASCII_8BIT)
-
START_BRACKETED_PASTE =
# File 'lib/reline/io/ansi.rb', line 187String.new("\e[200~", encoding: Encoding::ASCII_8BIT)
IO
- Inherited
Class Method Summary
Instance Attribute Summary
- #both_tty? ⇒ Boolean readonly
- #empty_buffer? ⇒ Boolean readonly
- #in_pasting? ⇒ Boolean readonly
- #input=(val) writeonly
- #output=(val) writeonly
IO
- Inherited
Instance Method Summary
- #clear_screen
- #cursor_pos
- #deprep(otio)
- #encoding
- #erase_after_cursor
- #get_screen_size
-
#getc(timeout_second)
if the usage expects to wait indefinitely, use
Float::INFINITY
for timeout_second. - #hide_cursor
- #inner_getc(timeout_second)
- #move_cursor_column(x)
- #move_cursor_down(x)
- #move_cursor_up(x)
- #prep
- #read_bracketed_paste
- #retrieve_keybuffer
-
#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.
- #set_bracketed_paste_key_bindings(config)
- #set_default_key_bindings(config, allow_terminfo: true)
- #set_default_key_bindings_ansi_cursor(config)
- #set_default_key_bindings_comprehensive_list(config)
- #set_default_key_bindings_terminfo(config)
- #set_screen_size(rows, columns)
- #set_winch_handler(&handler)
- #show_cursor
- #ungetc(c)
- #with_raw_input
IO
- Inherited
Constructor Details
.new ⇒ ANSI
# File 'lib/reline/io/ansi.rb', line 36
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 283
def both_tty? @input.tty? && @output.tty? end
#empty_buffer? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/reline/io/ansi.rb', line 209
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 205
def in_pasting? not empty_buffer? end
#input=(val) (writeonly)
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 154
def input=(val) @input = val end
#output=(val) (writeonly)
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 158
def output=(val) @output = val end
Instance Method Details
#clear_screen
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 343
def clear_screen @output.write "\e[2J" @output.write "\e[1;1H" end
#cursor_pos
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 248
def cursor_pos if both_tty? 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 else 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)
[ GitHub ]#encoding
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 43
def encoding Encoding.default_external end
#erase_after_cursor
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 331
def erase_after_cursor @output.write "\e[K" end
#get_screen_size
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 231
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 201
def getc(timeout_second) inner_getc(timeout_second) end
#hide_cursor
[ GitHub ]#inner_getc(timeout_second)
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 170
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 287
def move_cursor_column(x) @output.write "\e[#{x + 1}G" end
#move_cursor_down(x)
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 299
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 291
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 359
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 189
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 220
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 337
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 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)
[ GitHub ]# 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)
[ GitHub ]# 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 if modifiers[:ctrl] # CSI + ctrl_key_modifier + char bindings << ["\e[1;5#{char}", modifiers[:ctrl]] end if modifiers[: ] # CSI + meta_key_modifier + char bindings << ["\e[1;3#{char}", modifiers[: ]] # Meta(ESC) + CSI + char bindings << ["\e\e[#{char}", modifiers[: ]] 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 115
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 # 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)
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 98
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)
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 241
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 348
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 ]#ungetc(c)
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 216
def ungetc(c) @buf.unshift(c) end
#with_raw_input
[ GitHub ]# File 'lib/reline/io/ansi.rb', line 162
def with_raw_input if @input.tty? @input.raw(intr: true) { yield } else yield end end