Class: Reline::ANSI

Inherits:
Object show all
Defined in:
lib/reline/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[200~.", encoding: Encoding::ASCII_8BIT)
@@input = 
STDIN
@@output = 
STDOUT
@@buf = 
[]
@@in_bracketed_paste_mode = 
false
@@old_winch_handler = 
nil

Class Method Summary collapse

Class Method Details

.clear_screen ⇒ Object 



345
346
347
348
 
# File 'lib/reline/ansi.rb', line 345

def self.clear_screen
  @@output.write "\e[2J"
  @@output.write "\e[1;1H"
end

.cursor_pos ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/reline/ansi.rb', line 254

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



360
361
362
 
# File 'lib/reline/ansi.rb', line 360

def self.deprep(otio)
  Signal.trap('WINCH', @@old_winch_handler) if @@old_winch_handler
end

.empty_buffer? ⇒ Boolean

Returns:

  • (Boolean) 


215
216
217
218
219
220
 
# File 'lib/reline/ansi.rb', line 215

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

.encoding ⇒ Object 



37
38
39
 
# File 'lib/reline/ansi.rb', line 37

def self.encoding
  Encoding.default_external
end

.erase_after_cursor ⇒ Object 



333
334
335
 
# File 'lib/reline/ansi.rb', line 333

def self.erase_after_cursor
  @@output.write "\e[K"
end

.get_screen_size ⇒ Object 



237
238
239
240
241
242
243
244
245
 
# File 'lib/reline/ansi.rb', line 237

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

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



203
204
205
206
207
208
209
 
# File 'lib/reline/ansi.rb', line 203

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/reline/ansi.rb', line 176

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



309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/reline/ansi.rb', line 309

def self.hide_cursor
  if Reline::Terminfo.enabled?
    begin
      @@output.write Reline::Terminfo.tigetstr('civis')
    rescue Reline::Terminfo::TerminfoError
      # civis is undefined
    end
  else
    # ignored
  end
end

.in_pasting? ⇒ Boolean

Returns:

  • (Boolean) 


211
212
213
 
# File 'lib/reline/ansi.rb', line 211

def self.in_pasting?
  @@in_bracketed_paste_mode or (not empty_buffer?)
end

.inner_getc(timeout_second) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/reline/ansi.rb', line 156

def self.inner_getc(timeout_second)
  unless @@buf.empty?
    return @@buf.shift
  end
  until c = @@input.raw(intr: true) { @@input.wait_readable(0.1) && @@input.getbyte }
    timeout_second -= 0.1
    return nil if timeout_second <= 0
    Reline.core.line_editor.resize
  end
  (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) ⇒ Object 



142
143
144
 
# File 'lib/reline/ansi.rb', line 142

def self.input=(val)
  @@input = val
end

.move_cursor_column(x) ⇒ Object 



289
290
291
 
# File 'lib/reline/ansi.rb', line 289

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

.move_cursor_down(x) ⇒ Object 



301
302
303
304
305
306
307
 
# File 'lib/reline/ansi.rb', line 301

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



293
294
295
296
297
298
299
 
# File 'lib/reline/ansi.rb', line 293

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



147
148
149
 
# File 'lib/reline/ansi.rb', line 147

def self.output=(val)
  @@output = val
end

.prep ⇒ Object 



355
356
357
358
 
# File 'lib/reline/ansi.rb', line 355

def self.prep
  retrieve_keybuffer
  nil
end

.retrieve_keybuffer ⇒ Object 



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/reline/ansi.rb', line 226

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



339
340
341
342
343
 
# File 'lib/reline/ansi.rb', line 339

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



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

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/reline/ansi.rb', line 67

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/reline/ansi.rb', line 106

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/reline/ansi.rb', line 89

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



247
248
249
250
251
252
 
# File 'lib/reline/ansi.rb', line 247

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

.set_winch_handler(&handler) ⇒ Object 



351
352
353
 
# File 'lib/reline/ansi.rb', line 351

def self.set_winch_handler(&handler)
  @@old_winch_handler = Signal.trap('WINCH', &handler)
end

.show_cursor ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/reline/ansi.rb', line 321

def self.show_cursor
  if Reline::Terminfo.enabled?
    begin
      @@output.write Reline::Terminfo.tigetstr('cnorm')
    rescue Reline::Terminfo::TerminfoError
      # cnorm is undefined
    end
  else
    # ignored
  end
end

.ungetc(c) ⇒ Object 



222
223
224
 
# File 'lib/reline/ansi.rb', line 222

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

.win? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/reline/ansi.rb', line 41

def self.win?
  false
end

.with_raw_input ⇒ Object 



151
152
153
 
# File 'lib/reline/ansi.rb', line 151

def self.with_raw_input
  @@input.raw { yield }
end