Class: Reline::ANSI

Inherits:
IO
  • Object
show all
Defined in:
lib/reline/io/ansi.rb

Constant Summary collapse

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, {}],
}
START_BRACKETED_PASTE = 
String.new("\e[200~", encoding: Encoding::ASCII_8BIT)
END_BRACKETED_PASTE = 
String.new("\e[201~", encoding: Encoding::ASCII_8BIT)

Constants inherited from IO

IO::RESET_COLOR

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from IO

decide_io_gate, #dumb?, #read_single_char, #reset_color_sequence, #win?

Constructor Details

#initialize ⇒ ANSI

Returns a new instance of ANSI.



34
35
36
37
38
39
40
 
# File 'lib/reline/io/ansi.rb', line 34

def initialize
  @input = STDIN
  @output = STDOUT
  @buf = []
  @output_buffer = nil
  @old_winch_handler = nil
end

Instance Attribute Details

#input=(value) ⇒ Object (writeonly)

Sets the attribute input

Parameters:

  • value —

    the value to set the attribute input to.



32
33
34
 
# File 'lib/reline/io/ansi.rb', line 32

def input=(value)
  @input = value
end

#output=(value) ⇒ Object (writeonly)

Sets the attribute output

Parameters:

  • value —

    the value to set the attribute output to.



32
33
34
 
# File 'lib/reline/io/ansi.rb', line 32

def output=(value)
  @output = value
end

Instance Method Details

#both_tty? ⇒ Boolean

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/reline/io/ansi.rb', line 232

def both_tty?
  @input.tty? && @output.tty?
end

#buffered_output ⇒ Object 



244
245
246
247
248
249
250
 
# File 'lib/reline/io/ansi.rb', line 244

def buffered_output
  @output_buffer = +''
  yield
  @output.write(@output_buffer)
ensure
  @output_buffer = nil
end

#clear_screen ⇒ Object 



292
293
294
295
 
# File 'lib/reline/io/ansi.rb', line 292

def clear_screen
  write "\e[2J"
  write "\e[1;1H"
end

#cursor_pos ⇒ Object 



227
228
229
230
 
# File 'lib/reline/io/ansi.rb', line 227

def cursor_pos
  col, row = cursor_pos_internal(timeout: 0.5) if both_tty?
  Reline::CursorPos.new(col || 0, row || 0)
end

#deprep(otio) ⇒ Object 



319
320
321
322
323
324
 
# File 'lib/reline/io/ansi.rb', line 319

def deprep(otio)
  # Disable bracketed paste
  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? ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
170
171
172
 
# File 'lib/reline/io/ansi.rb', line 167

def empty_buffer?
  unless @buf.empty?
    return false
  end
  !@input.wait_readable(0)
end

#encoding ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/reline/io/ansi.rb', line 42

def encoding
  @input.external_encoding || Encoding.default_external
rescue IOError
  # STDIN.external_encoding raises IOError in Ruby <= 3.0 when STDIN is closed
  Encoding.default_external
end

#erase_after_cursor ⇒ Object 



280
281
282
 
# File 'lib/reline/io/ansi.rb', line 280

def erase_after_cursor
  write "\e[K"
end

#get_screen_size ⇒ Object 



189
190
191
192
193
194
195
196
197
 
# File 'lib/reline/io/ansi.rb', line 189

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) ⇒ Object

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



159
160
161
 
# File 'lib/reline/io/ansi.rb', line 159

def getc(timeout_second)
  inner_getc(timeout_second)
end

#hide_cursor ⇒ Object 



272
273
274
 
# File 'lib/reline/io/ansi.rb', line 272

def hide_cursor
  write "\e[?25l"
end

#in_pasting? ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/reline/io/ansi.rb', line 163

def in_pasting?
  not empty_buffer?
end

#inner_getc(timeout_second) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/reline/io/ansi.rb', line 128

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) ⇒ Object 



252
253
254
 
# File 'lib/reline/io/ansi.rb', line 252

def move_cursor_column(x)
  write "\e[#{x + 1}G"
end

#move_cursor_down(x) ⇒ Object 



264
265
266
267
268
269
270
 
# File 'lib/reline/io/ansi.rb', line 264

def move_cursor_down(x)
  if x > 0
    write "\e[#{x}B"
  elsif x < 0
    move_cursor_up(-x)
  end
end

#move_cursor_up(x) ⇒ Object 



256
257
258
259
260
261
262
 
# File 'lib/reline/io/ansi.rb', line 256

def move_cursor_up(x)
  if x > 0
    write "\e[#{x}A"
  elsif x < 0
    move_cursor_down(-x)
  end
end

#prep ⇒ Object 



312
313
314
315
316
317
 
# File 'lib/reline/io/ansi.rb', line 312

def prep
  # Enable bracketed paste
  write "\e[?2004h" if Reline.core.config.enable_bracketed_paste && both_tty?
  retrieve_keybuffer
  nil
end

#read_bracketed_paste ⇒ Object 



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/reline/io/ansi.rb', line 147

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 ⇒ Object 



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/reline/io/ansi.rb', line 178

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) ⇒ Object

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



286
287
288
289
290
 
# File 'lib/reline/io/ansi.rb', line 286

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
  write "\n" * x
end

#set_bracketed_paste_key_bindings(config) ⇒ Object 



68
69
70
71
72
 
# File 'lib/reline/io/ansi.rb', line 68

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) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/reline/io/ansi.rb', line 49

def set_default_key_bindings(config)
  set_bracketed_paste_key_bindings(config)
  set_default_key_bindings_ansi_cursor(config)
  set_default_key_bindings_comprehensive_list(config)
  {
    [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) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/reline/io/ansi.rb', line 74

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) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/reline/io/ansi.rb', line 99

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_screen_size(rows, columns) ⇒ Object 



199
200
201
202
203
204
 
# File 'lib/reline/io/ansi.rb', line 199

def set_screen_size(rows, columns)
  @input.winsize = [rows, columns]
  self
rescue Errno::ENOTTY, Errno::ENODEV
  self
end

#set_winch_handler(&handler) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/reline/io/ansi.rb', line 297

def set_winch_handler(&handler)
  @old_winch_handler = Signal.trap('WINCH') do |arg|
    handler.call
    @old_winch_handler.call(arg) if @old_winch_handler.respond_to?(:call)
  end
  @old_cont_handler = Signal.trap('CONT') do |arg|
    @input.raw!(intr: true) if @input.tty?
    # Rerender the screen. Note that screen size might be changed while suspended.
    handler.call
    @old_cont_handler.call(arg) if @old_cont_handler.respond_to?(:call)
  end
rescue ArgumentError
  # Signal.trap may raise an ArgumentError if the platform doesn't support the signal.
end

#show_cursor ⇒ Object 



276
277
278
 
# File 'lib/reline/io/ansi.rb', line 276

def show_cursor
  write "\e[?25h"
end

#ungetc(c) ⇒ Object 



174
175
176
 
# File 'lib/reline/io/ansi.rb', line 174

def ungetc(c)
  @buf.unshift(c)
end

#with_raw_input ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/reline/io/ansi.rb', line 120

def with_raw_input
  if @input.tty?
    @input.raw(intr: true) { yield }
  else
    yield
  end
end

#write(string) ⇒ Object 



236
237
238
239
240
241
242
 
# File 'lib/reline/io/ansi.rb', line 236

def write(string)
  if @output_buffer
    @output_buffer << string
  else
    @output.write(string)
  end
end