Class: Reline::ANSI
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/reline/ansi.rb |
Constant Summary
-
ANSI_CURSOR_KEY_BINDINGS =
# File 'lib/reline/ansi.rb', line 20{ # 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/ansi.rb', line 8{ '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/ansi.rb', line 183String.new("\e[200~.", encoding: Encoding::ASCII_8BIT)
-
RESET_COLOR =
# File 'lib/reline/ansi.rb', line 6"\e[0m"
-
START_BRACKETED_PASTE =
# File 'lib/reline/ansi.rb', line 182String.new("\e[200~,", encoding: Encoding::ASCII_8BIT)
Class Attribute Summary
- .empty_buffer? ⇒ Boolean readonly
- .in_pasting? ⇒ Boolean readonly
- .input=(val) writeonly
- .output=(val) writeonly
- .win? ⇒ Boolean readonly
Class 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. - .getc_with_bracketed_paste(timeout_second)
- .hide_cursor
- .inner_getc(timeout_second)
- .move_cursor_column(x)
- .move_cursor_down(x)
- .move_cursor_up(x)
- .prep
- .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_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
Class Attribute Details
.empty_buffer? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/reline/ansi.rb', line 223
def self.empty_buffer? unless @@buf.empty? return false end !@@input.wait_readable(0) end
.in_pasting? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/reline/ansi.rb', line 219
def self.in_pasting? @@in_bracketed_paste_mode or (not empty_buffer?) end
.input=(val) (writeonly)
[ GitHub ]# File 'lib/reline/ansi.rb', line 144
def self.input=(val) @@input = val end
.output=(val) (writeonly)
[ GitHub ]# File 'lib/reline/ansi.rb', line 149
def self.output=(val) @@output = val end
.win? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/reline/ansi.rb', line 43
def self.win? false end
Class Method Details
.clear_screen
[ GitHub ]# File 'lib/reline/ansi.rb', line 353
def self.clear_screen @@output.write "\e[2J" @@output.write "\e[1;1H" end
.cursor_pos
[ GitHub ]# File 'lib/reline/ansi.rb', line 262
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 # 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 ]# File 'lib/reline/ansi.rb', line 368
def self.deprep(otio) Signal.trap('WINCH', @@old_winch_handler) if @@old_winch_handler end
.encoding
[ GitHub ]# File 'lib/reline/ansi.rb', line 39
def self.encoding Encoding.default_external end
.erase_after_cursor
[ GitHub ]# File 'lib/reline/ansi.rb', line 341
def self.erase_after_cursor @@output.write "\e[K" end
.get_screen_size
[ GitHub ]# File 'lib/reline/ansi.rb', line 245
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)
if the usage expects to wait indefinitely, use Float::INFINITY
for timeout_second
# File 'lib/reline/ansi.rb', line 211
def self.getc(timeout_second) if Reline.core.config.enable_bracketed_paste getc_with_bracketed_paste(timeout_second) else inner_getc(timeout_second) end end
.getc_with_bracketed_paste(timeout_second)
[ GitHub ]# File 'lib/reline/ansi.rb', line 184
def self.getc_with_bracketed_paste(timeout_second) buffer = String.new(encoding: Encoding::ASCII_8BIT) buffer << inner_getc(timeout_second) while START_BRACKETED_PASTE.start_with?(buffer) or END_BRACKETED_PASTE.start_with?(buffer) do if START_BRACKETED_PASTE == buffer @@in_bracketed_paste_mode = true return inner_getc(timeout_second) elsif END_BRACKETED_PASTE == buffer @@in_bracketed_paste_mode = false ungetc(-1) return inner_getc(timeout_second) end succ_c = inner_getc(Reline.core.config.keyseq_timeout) if succ_c buffer << succ_c else break end end buffer.bytes.reverse_each do |ch| ungetc ch end inner_getc(timeout_second) end
.hide_cursor
[ GitHub ].inner_getc(timeout_second)
[ GitHub ]# File 'lib/reline/ansi.rb', line 162
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
.move_cursor_column(x)
[ GitHub ]# File 'lib/reline/ansi.rb', line 297
def self.move_cursor_column(x) @@output.write "\e[#{x + 1}G" end
.move_cursor_down(x)
[ GitHub ]# File 'lib/reline/ansi.rb', line 309
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)
[ GitHub ]# File 'lib/reline/ansi.rb', line 301
def self.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/ansi.rb', line 363
def self.prep retrieve_keybuffer nil end
.retrieve_keybuffer
[ GitHub ]# File 'lib/reline/ansi.rb', line 234
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)
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 347
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_default_key_bindings(config, allow_terminfo: true)
[ GitHub ]# File 'lib/reline/ansi.rb', line 47
def self.set_default_key_bindings(config, allow_terminfo: true) 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/ansi.rb', line 69
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[: ] # 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/ansi.rb', line 108
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)
[ GitHub ]# File 'lib/reline/ansi.rb', line 91
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)
[ GitHub ]# File 'lib/reline/ansi.rb', line 255
def self.set_screen_size(rows, columns) @@input.winsize = [rows, columns] self rescue Errno::ENOTTY self end
.set_winch_handler(&handler)
[ GitHub ]# File 'lib/reline/ansi.rb', line 359
def self.set_winch_handler(&handler) @@old_winch_handler = Signal.trap('WINCH', &handler) end
.show_cursor
[ GitHub ].ungetc(c)
[ GitHub ]# File 'lib/reline/ansi.rb', line 230
def self.ungetc(c) @@buf.unshift(c) end
.with_raw_input
[ GitHub ]# File 'lib/reline/ansi.rb', line 153
def self.with_raw_input if @@input.tty? @@input.raw(intr: true) { yield } else yield end end