diff options
Diffstat (limited to 'lib/reline/ansi.rb')
| -rw-r--r-- | lib/reline/ansi.rb | 180 |
1 files changed, 114 insertions, 66 deletions
diff --git a/lib/reline/ansi.rb b/lib/reline/ansi.rb index f34d0b53fe..a3719f502c 100644 --- a/lib/reline/ansi.rb +++ b/lib/reline/ansi.rb @@ -1,9 +1,37 @@ require 'io/console' require 'io/wait' -require 'timeout' require_relative 'terminfo' class Reline::ANSI + RESET_COLOR = "\e[0m" + + CAPNAME_KEY_BINDINGS = { + '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, + } + + ANSI_CURSOR_KEY_BINDINGS = { + # 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, {}], + } + if Reline::Terminfo.enabled? Reline::Terminfo.setupterm(0, 2) end @@ -16,48 +44,61 @@ class Reline::ANSI false end - def self.set_default_key_bindings(config) - if Reline::Terminfo.enabled? + 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 { - # extended entries of terminfo - [27, 91, 49, 59, 53, 67] => :em_next_word, # Ctrl+→, extended entry - [27, 91, 49, 59, 53, 68] => :ed_prev_word, # Ctrl+←, extended entry - [27, 91, 49, 59, 51, 67] => :em_next_word, # Meta+→, extended entry - [27, 91, 49, 59, 51, 68] => :ed_prev_word, # Meta+←, extended entry + [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) - config.add_default_key_binding_by_keymap(:vi_command, key, func) end { # default bindings [27, 32] => :em_set_mark, # M-<space> [24, 24] => :em_exchange_mark, # C-x C-x - [27, 91, 90] => :completion_journey_up, # S-Tab }.each_pair do |key, func| config.add_default_key_binding_by_keymap(:emacs, key, func) end end + 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 + def self.set_default_key_bindings_terminfo(config) - { - Reline::Terminfo.tigetstr('khome').bytes => :ed_move_to_beg, - Reline::Terminfo.tigetstr('kend').bytes => :ed_move_to_end, - Reline::Terminfo.tigetstr('kcuu1').bytes => :ed_prev_history, - Reline::Terminfo.tigetstr('kcud1').bytes => :ed_next_history, - Reline::Terminfo.tigetstr('kcuf1').bytes => :ed_next_char, - Reline::Terminfo.tigetstr('kcub1').bytes => :ed_prev_char, - # Escape sequences that omit the move distance and are set to defaults - # value 1 may be sometimes sent by pressing the arrow-key. - Reline::Terminfo.tigetstr('cuu').sub(/%p1%d/, '').bytes => :ed_prev_history, - Reline::Terminfo.tigetstr('cud').sub(/%p1%d/, '').bytes => :ed_next_history, - Reline::Terminfo.tigetstr('cuf').sub(/%p1%d/, '').bytes => :ed_next_char, - Reline::Terminfo.tigetstr('cub').sub(/%p1%d/, '').bytes => :ed_prev_char, - }.each_pair do |key, func| + 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) @@ -70,14 +111,8 @@ class Reline::ANSI [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 - [27, 91, 65] => :ed_prev_history, # ↑ - [27, 91, 66] => :ed_next_history, # ↓ - [27, 91, 67] => :ed_next_char, # → - [27, 91, 68] => :ed_prev_char, # ← # KDE - [27, 91, 72] => :ed_move_to_beg, # Home - [27, 91, 70] => :ed_move_to_end, # End # Del is 0x08 [27, 71, 65] => :ed_prev_history, # ↑ [27, 71, 66] => :ed_next_history, # ↓ @@ -94,12 +129,6 @@ class Reline::ANSI # Del is 0x08 # Arrow keys are the same of KDE - # iTerm2 - [27, 27, 91, 67] => :em_next_word, # Option+→, extended entry - [27, 27, 91, 68] => :ed_prev_word, # Option+←, extended entry - [195, 166] => :em_next_word, # Option+f - [195, 162] => :ed_prev_word, # Option+b - [27, 79, 65] => :ed_prev_history, # ↑ [27, 79, 66] => :ed_next_history, # ↓ [27, 79, 67] => :ed_next_char, # → @@ -121,15 +150,27 @@ class Reline::ANSI @@output = val end + def self.with_raw_input + if @@input.tty? + @@input.raw(intr: true) { yield } + else + yield + end + end + @@buf = [] - def self.inner_getc + def self.inner_getc(timeout_second) unless @@buf.empty? return @@buf.shift end - until c = @@input.raw(intr: true, &:getbyte) - sleep 0.1 + until @@input.wait_readable(0.01) + timeout_second -= 0.01 + return nil if timeout_second <= 0 + + Reline.core.line_editor.handle_signal end - (c == 0x16 && @@input.raw(min: 0, tim: 0, &:getbyte)) || c + c = @@input.getbyte + (c == 0x16 && @@input.raw(min: 0, time: 0, &:getbyte)) || c rescue Errno::EIO # Maybe the I/O has been closed. nil @@ -140,45 +181,43 @@ class Reline::ANSI @@in_bracketed_paste_mode = false START_BRACKETED_PASTE = String.new("\e[200~,", encoding: Encoding::ASCII_8BIT) END_BRACKETED_PASTE = String.new("\e[200~.", encoding: Encoding::ASCII_8BIT) - def self.getc_with_bracketed_paste + def self.getc_with_bracketed_paste(timeout_second) buffer = String.new(encoding: Encoding::ASCII_8BIT) - buffer << inner_getc + 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 + return inner_getc(timeout_second) elsif END_BRACKETED_PASTE == buffer @@in_bracketed_paste_mode = false ungetc(-1) - return inner_getc + return inner_getc(timeout_second) end - begin - succ_c = nil - Timeout.timeout(Reline.core.config.keyseq_timeout * 100) { - succ_c = inner_getc - } - rescue Timeout::Error - break - else + 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 + inner_getc(timeout_second) end - def self.getc + # if the usage expects to wait indefinitely, use Float::INFINITY for timeout_second + def self.getc(timeout_second) if Reline.core.config.enable_bracketed_paste - getc_with_bracketed_paste + getc_with_bracketed_paste(timeout_second) else - inner_getc + inner_getc(timeout_second) end end def self.in_pasting? - @@in_bracketed_paste_mode or (not Reline::IOGate.empty_buffer?) + @@in_bracketed_paste_mode or (not empty_buffer?) end def self.empty_buffer? @@ -261,7 +300,7 @@ class Reline::ANSI def self.move_cursor_up(x) if x > 0 - @@output.write "\e[#{x}A" if x > 0 + @@output.write "\e[#{x}A" elsif x < 0 move_cursor_down(-x) end @@ -269,23 +308,31 @@ class Reline::ANSI def self.move_cursor_down(x) if x > 0 - @@output.write "\e[#{x}B" if x > 0 + @@output.write "\e[#{x}B" elsif x < 0 move_cursor_up(-x) end end def self.hide_cursor - if Reline::Terminfo.enabled? - @@output.write Reline::Terminfo.tigetstr('civis') + 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 def self.show_cursor - if Reline::Terminfo.enabled? - @@output.write Reline::Terminfo.tigetstr('cnorm') + 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 @@ -295,9 +342,12 @@ class Reline::ANSI @@output.write "\e[K" end + # This only works when the cursor is at the bottom of the scroll range + # For more details, see https://github.com/ruby/reline/pull/577#issuecomment-1646679623 def self.scroll_down(x) return if x.zero? - @@output.write "\e[#{x}S" + # We use `\n` instead of CSI + S because CSI + S would cause https://github.com/ruby/reline/issues/576 + @@output.write "\n" * x end def self.clear_screen @@ -316,8 +366,6 @@ class Reline::ANSI end def self.deprep(otio) - int_handle = Signal.trap('INT', 'IGNORE') - Signal.trap('INT', int_handle) Signal.trap('WINCH', @@old_winch_handler) if @@old_winch_handler end end |