Class: Reline::LineEditor

Inherits:
Object
  • Object
show all
Defined in:
lib/reline/line_editor.rb

Defined Under Namespace

Modules: CompletionState Classes: CompletionJourneyData, MenuInfo

Constant Summary collapse

VI_MOTIONS = 
%i{
  ed_prev_char
  ed_next_char
  vi_zero
  ed_move_to_beg
  ed_move_to_end
  vi_to_column
  vi_next_char
  vi_prev_char
  vi_next_word
  vi_prev_word
  vi_to_next_char
  vi_to_prev_char
  vi_end_word
  vi_next_big_word
  vi_prev_big_word
  vi_end_big_word
  vi_repeat_next_char
  vi_repeat_prev_char
}
PROMPT_LIST_CACHE_TIMEOUT = 
0.5

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, encoding) ⇒ LineEditor

Returns a new instance of LineEditor.



55
56
57
58
59
 
# File 'lib/reline/line_editor.rb', line 55

def initialize(config, encoding)
  @config = config
  @completion_append_character = ''
  reset_variables(encoding: encoding)
end

Instance Attribute Details

#auto_indent_proc ⇒ Object

Returns the value of attribute auto_indent_proc.



15
16
17
 
# File 'lib/reline/line_editor.rb', line 15

def auto_indent_proc
  @auto_indent_proc
end

#byte_pointer ⇒ Object

Returns the value of attribute byte_pointer.



9
10
11
 
# File 'lib/reline/line_editor.rb', line 9

def byte_pointer
  @byte_pointer
end

#completion_append_character ⇒ Object

Returns the value of attribute completion_append_character.



12
13
14
 
# File 'lib/reline/line_editor.rb', line 12

def completion_append_character
  @completion_append_character
end

#completion_proc ⇒ Object

Returns the value of attribute completion_proc.



11
12
13
 
# File 'lib/reline/line_editor.rb', line 11

def completion_proc
  @completion_proc
end

#confirm_multiline_termination_proc ⇒ Object

Returns the value of attribute confirm_multiline_termination_proc.



10
11
12
 
# File 'lib/reline/line_editor.rb', line 10

def confirm_multiline_termination_proc
  @confirm_multiline_termination_proc
end

#dig_perfect_match_proc ⇒ Object

Returns the value of attribute dig_perfect_match_proc.



17
18
19
 
# File 'lib/reline/line_editor.rb', line 17

def dig_perfect_match_proc
  @dig_perfect_match_proc
end

#line ⇒ Object (readonly)

TODO: undo



8
9
10
 
# File 'lib/reline/line_editor.rb', line 8

def line
  @line
end

#output=(value) ⇒ Object (writeonly)

Sets the attribute output

Parameters:

  • value —

    the value to set the attribute output to.



18
19
20
 
# File 'lib/reline/line_editor.rb', line 18

def output=(value)
  @output = value
end

#output_modifier_proc ⇒ Object

Returns the value of attribute output_modifier_proc.



13
14
15
 
# File 'lib/reline/line_editor.rb', line 13

def output_modifier_proc
  @output_modifier_proc
end

#pre_input_hook ⇒ Object

Returns the value of attribute pre_input_hook.



16
17
18
 
# File 'lib/reline/line_editor.rb', line 16

def pre_input_hook
  @pre_input_hook
end

#prompt_proc ⇒ Object

Returns the value of attribute prompt_proc.



14
15
16
 
# File 'lib/reline/line_editor.rb', line 14

def prompt_proc
  @prompt_proc
end

Instance Method Details

#call_completion_proc ⇒ Object 



1099
1100
1101
1102
1103
1104
1105
 
# File 'lib/reline/line_editor.rb', line 1099

def call_completion_proc
  result = retrieve_completion_block(true)
  slice = result[1]
  result = @completion_proc.(slice) if @completion_proc and slice
  Reline.core.instance_variable_set(:@completion_quote_character, nil)
  result
end

#confirm_multiline_termination ⇒ Object 



1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'lib/reline/line_editor.rb', line 1209

def confirm_multiline_termination
  temp_buffer = @buffer_of_lines.dup
  if @previous_line_index and @line_index == (@buffer_of_lines.size - 1)
    temp_buffer[@previous_line_index] = @line
  else
    temp_buffer[@line_index] = @line
  end
  @confirm_multiline_termination_proc.(temp_buffer.join("\n") + "\n")
end

#delete_text(start = nil, length = nil) ⇒ Object 



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
 
# File 'lib/reline/line_editor.rb', line 1231

def delete_text(start = nil, length = nil)
  if start.nil? and length.nil?
    @line&.clear
    @byte_pointer = 0
    @cursor = 0
    @cursor_max = 0
  elsif not start.nil? and not length.nil?
    if @line
      before = @line.byteslice(0, start)
      after = @line.byteslice(start + length, @line.bytesize)
      @line = before + after
      @byte_pointer = @line.bytesize if @byte_pointer > @line.bytesize
      str = @line.byteslice(0, @byte_pointer)
      @cursor = calculate_width(str)
      @cursor_max = calculate_width(@line)
    end
  elsif start.is_a?(Range)
    range = start
    first = range.first
    last = range.last
    last = @line.bytesize - 1 if last > @line.bytesize
    last += @line.bytesize if last < 0
    first += @line.bytesize if first < 0
    range = range.exclude_end? ? first...last : first..last
    @line = @line.bytes.reject.with_index{ |c, i| range.include?(i) }.map{ |c| c.chr(Encoding::ASCII_8BIT) }.join.force_encoding(@encoding)
    @byte_pointer = @line.bytesize if @byte_pointer > @line.bytesize
    str = @line.byteslice(0, @byte_pointer)
    @cursor = calculate_width(str)
    @cursor_max = calculate_width(@line)
  else
    @line = @line.byteslice(0, start)
    @byte_pointer = @line.bytesize if @byte_pointer > @line.bytesize
    str = @line.byteslice(0, @byte_pointer)
    @cursor = calculate_width(str)
    @cursor_max = calculate_width(@line)
  end
end

#editing_mode ⇒ Object 



759
760
761
 
# File 'lib/reline/line_editor.rb', line 759

def editing_mode
  @config.editing_mode
end

#eof? ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
 
# File 'lib/reline/line_editor.rb', line 188

def eof?
  @eof
end

#finalize ⇒ Object 



184
185
186
 
# File 'lib/reline/line_editor.rb', line 184

def finalize
  Signal.trap('SIGINT', @old_trap)
end

#finish ⇒ Object 



1294
1295
1296
1297
1298
 
# File 'lib/reline/line_editor.rb', line 1294

def finish
  @finished = true
  @rerender_all = true
  @config.reset
end

#finished? ⇒ Boolean

Returns:

  • (Boolean) 


1290
1291
1292
 
# File 'lib/reline/line_editor.rb', line 1290

def finished?
  @finished
end

#input_key(key) ⇒ Object 



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/reline/line_editor.rb', line 1045

def input_key(key)
  @just_cursor_moving = nil
  if key.char.nil?
    if @first_char
      @line = nil
    end
    finish
    return
  end
  old_line = @line.dup
  @first_char = false
  completion_occurs = false
  if @config.editing_mode_is?(:emacs, :vi_insert) and key.char == "\C-i".ord
    unless @config.disable_completion
      result = call_completion_proc
      if result.is_a?(Array)
        completion_occurs = true
        process_insert
        complete(result)
      end
    end
  elsif not @config.disable_completion and @config.editing_mode_is?(:vi_insert) and ["\C-p".ord, "\C-n".ord].include?(key.char)
    unless @config.disable_completion
      result = call_completion_proc
      if result.is_a?(Array)
        completion_occurs = true
        process_insert
        move_completed_list(result, "\C-p".ord == key.char ? :up : :down)
      end
    end
  elsif Symbol === key.char and respond_to?(key.char, true)
    process_key(key.char, key.char)
  else
    normal_char(key)
  end
  unless completion_occurs
    @completion_state = CompletionState::NORMAL
  end
  if not Reline::IOGate.in_pasting? and @just_cursor_moving.nil?
    if @previous_line_index and @buffer_of_lines[@previous_line_index] == @line
      @just_cursor_moving = true
    elsif @previous_line_index.nil? and @buffer_of_lines[@line_index] == @line and old_line == @line
      @just_cursor_moving = true
    else
      @just_cursor_moving = false
    end
  else
    @just_cursor_moving = false
  end
  if @is_multiline and @auto_indent_proc and not simplified_rendering?
    process_auto_indent
  end
end

#insert_text(text) ⇒ Object 



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/reline/line_editor.rb', line 1219

def insert_text(text)
  width = calculate_width(text)
  if @cursor == @cursor_max
    @line += text
  else
    @line = byteinsert(@line, @byte_pointer, text)
  end
  @byte_pointer += text.bytesize
  @cursor += width
  @cursor_max += width
end

#just_move_cursor ⇒ Object 



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/reline/line_editor.rb', line 464

def just_move_cursor
  prompt, prompt_width, prompt_list = check_multiline_prompt(@buffer_of_lines, prompt)
  move_cursor_up(@started_from)
  new_first_line_started_from =
    if @line_index.zero?
      0
    else
      calculate_height_by_lines(@buffer_of_lines[0..(@line_index - 1)], prompt_list || prompt)
    end
  first_line_diff = new_first_line_started_from - @first_line_started_from
  new_cursor, _, new_started_from, _ = calculate_nearest_cursor(@line, @cursor, @started_from, @byte_pointer, false)
  new_started_from = calculate_height_by_width(prompt_width + new_cursor) - 1
  calculate_scroll_partial_screen(@highest_in_all, new_first_line_started_from + new_started_from)
  @previous_line_index = nil
  if @rerender_all
    @line = @buffer_of_lines[@line_index]
    rerender_all_lines
    @rerender_all = false
    true
  else
    @line = @buffer_of_lines[@line_index]
    @first_line_started_from = new_first_line_started_from
    @started_from = new_started_from
    @cursor = new_cursor
    move_cursor_down(first_line_diff + @started_from)
    Reline::IOGate.move_cursor_column((prompt_width + @cursor) % @screen_size.last)
    false
  end
end

#multiline_off ⇒ Object 



248
249
250
 
# File 'lib/reline/line_editor.rb', line 248

def multiline_off
  @is_multiline = false
end

#multiline_on ⇒ Object 



244
245
246
 
# File 'lib/reline/line_editor.rb', line 244

def multiline_on
  @is_multiline = true
end

#rerender ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/reline/line_editor.rb', line 355

def rerender
  return if @line.nil?
  if @menu_info
    scroll_down(@highest_in_all - @first_line_started_from)
    @rerender_all = true
  end
  if @menu_info
    show_menu
    @menu_info = nil
  end
  prompt, prompt_width, prompt_list = check_multiline_prompt(whole_lines, prompt)
  if @cleared
    clear_screen_buffer(prompt, prompt_list, prompt_width)
    @cleared = false
    return
  end
  new_highest_in_this = calculate_height_by_width(prompt_width + calculate_width(@line.nil? ? '' : @line))
  # FIXME: end of logical line sometimes breaks
  if @add_newline_to_end_of_buffer
    rerender_added_newline
    @add_newline_to_end_of_buffer = false
  else
    if @just_cursor_moving and not @rerender_all
      rendered = just_move_cursor
      @just_cursor_moving = false
      return
    elsif @previous_line_index or new_highest_in_this != @highest_in_this
      rerender_changed_current_line
      @previous_line_index = nil
      rendered = true
    elsif @rerender_all
      rerender_all_lines
      @rerender_all = false
      rendered = true
    else
    end
  end
  line = modify_lines(whole_lines)[@line_index]
  if @is_multiline
    prompt, prompt_width, prompt_list = check_multiline_prompt(whole_lines, prompt)
    if finished?
      # Always rerender on finish because output_modifier_proc may return a different output.
      render_partial(prompt, prompt_width, line, @first_line_started_from)
      scroll_down(1)
      Reline::IOGate.move_cursor_column(0)
      Reline::IOGate.erase_after_cursor
    elsif not rendered
      render_partial(prompt, prompt_width, line, @first_line_started_from)
    end
    @buffer_of_lines[@line_index] = @line
  else
    render_partial(prompt, prompt_width, line, 0)
    if finished?
      scroll_down(1)
      Reline::IOGate.move_cursor_column(0)
      Reline::IOGate.erase_after_cursor
    end
  end
end

#rerender_all ⇒ Object 



349
350
351
352
353
 
# File 'lib/reline/line_editor.rb', line 349

def rerender_all
  @rerender_all = true
  process_insert(force: true)
  rerender
end

#reset(prompt = '', encoding:) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/reline/line_editor.rb', line 136

def reset(prompt = '', encoding:)
  @rest_height = (Reline::IOGate.get_screen_size.first - 1) - Reline::IOGate.cursor_pos.y
  @screen_size = Reline::IOGate.get_screen_size
  @screen_height = @screen_size.first
  reset_variables(prompt, encoding: encoding)
  @old_trap = Signal.trap('SIGINT') {
    @old_trap.call if @old_trap.respond_to?(:call) # can also be string, ex: "DEFAULT"
    raise Interrupt
  }
  Reline::IOGate.set_winch_handler do
    @rest_height = (Reline::IOGate.get_screen_size.first - 1) - Reline::IOGate.cursor_pos.y
    old_screen_size = @screen_size
    @screen_size = Reline::IOGate.get_screen_size
    @screen_height = @screen_size.first
    if old_screen_size.last < @screen_size.last # columns increase
      @rerender_all = true
      rerender
    else
      back = 0
      new_buffer = whole_lines
      prompt, prompt_width, prompt_list = check_multiline_prompt(new_buffer, prompt)
      new_buffer.each_with_index do |line, index|
        prompt_width = calculate_width(prompt_list[index], true) if @prompt_proc
        width = prompt_width + calculate_width(line)
        height = calculate_height_by_width(width)
        back += height
      end
      @highest_in_all = back
      @highest_in_this = calculate_height_by_width(prompt_width + @cursor_max)
      @first_line_started_from =
        if @line_index.zero?
          0
        else
          calculate_height_by_lines(@buffer_of_lines[0..(@line_index - 1)], prompt_list || prompt)
        end
      if @prompt_proc
        prompt = prompt_list[@line_index]
        prompt_width = calculate_width(prompt, true)
      end
      calculate_nearest_cursor
      @started_from = calculate_height_by_width(prompt_width + @cursor) - 1
      Reline::IOGate.move_cursor_column((prompt_width + @cursor) % @screen_size.last)
      @highest_in_this = calculate_height_by_width(prompt_width + @cursor_max)
      @rerender_all = true
    end
  end
end

#reset_line ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/reline/line_editor.rb', line 226

def reset_line
  @cursor = 0
  @cursor_max = 0
  @byte_pointer = 0
  @buffer_of_lines = [String.new(encoding: @encoding)]
  @line_index = 0
  @previous_line_index = nil
  @line = @buffer_of_lines[0]
  @first_line_started_from = 0
  @move_up = 0
  @started_from = 0
  @highest_in_this = 1
  @highest_in_all = 1
  @line_backup_in_history = nil
  @multibyte_buffer = String.new(encoding: 'ASCII-8BIT')
  @check_new_auto_indent = false
end

#reset_variables(prompt = '', encoding:) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/reline/line_editor.rb', line 192

def reset_variables(prompt = '', encoding:)
  @prompt = prompt
  @mark_pointer = nil
  @encoding = encoding
  @is_multiline = false
  @finished = false
  @cleared = false
  @rerender_all = false
  @history_pointer = nil
  @kill_ring ||= Reline::KillRing.new
  @vi_clipboard = ''
  @vi_arg = nil
  @waiting_proc = nil
  @waiting_operator_proc = nil
  @waiting_operator_vi_arg = nil
  @completion_journey_data = nil
  @completion_state = CompletionState::NORMAL
  @perfect_matched = nil
  @menu_info = nil
  @first_prompt = true
  @searching_prompt = nil
  @first_char = true
  @add_newline_to_end_of_buffer = false
  @just_cursor_moving = nil
  @cached_prompt_list = nil
  @prompt_cache_time = nil
  @eof = false
  @continuous_insertion_buffer = String.new(encoding: @encoding)
  @scroll_partial_screen = nil
  @prev_mode_icon = nil
  @drop_terminate_spaces = false
  reset_line
end

#retrieve_completion_block(set_completion_quote_character = false) ⇒ Object 



1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/reline/line_editor.rb', line 1148

def retrieve_completion_block(set_completion_quote_character = false)
  word_break_regexp = /\A[#{Regexp.escape(Reline.completer_word_break_characters)}]/
  quote_characters_regexp = /\A[#{Regexp.escape(Reline.completer_quote_characters)}]/
  before = @line.byteslice(0, @byte_pointer)
  rest = nil
  break_pointer = nil
  quote = nil
  closing_quote = nil
  escaped_quote = nil
  i = 0
  while i < @byte_pointer do
    slice = @line.byteslice(i, @byte_pointer - i)
    unless slice.valid_encoding?
      i += 1
      next
    end
    if quote and slice.start_with?(closing_quote)
      quote = nil
      i += 1
      rest = nil
    elsif quote and slice.start_with?(escaped_quote)
      # skip
      i += 2
    elsif slice =~ quote_characters_regexp # find new "
      rest = $'
      quote = $&
      closing_quote = /(?!\\)#{Regexp.escape(quote)}/
      escaped_quote = /\\#{Regexp.escape(quote)}/
      i += 1
      break_pointer = i - 1
    elsif not quote and slice =~ word_break_regexp
      rest = $'
      i += 1
      before = @line.byteslice(i, @byte_pointer - i)
      break_pointer = i
    else
      i += 1
    end
  end
  postposing = @line.byteslice(@byte_pointer, @line.bytesize - @byte_pointer)
  if rest
    preposing = @line.byteslice(0, break_pointer)
    target = rest
    if set_completion_quote_character and quote
      Reline.core.instance_variable_set(:@completion_quote_character, quote)
      if postposing !~ /(?!\\)#{Regexp.escape(quote)}/ # closing quote
        insert_text(quote)
      end
    end
  else
    preposing = ''
    if break_pointer
      preposing = @line.byteslice(0, break_pointer)
    else
      preposing = ''
    end
    target = before
  end
  [preposing.encode(@encoding), target.encode(@encoding), postposing.encode(@encoding)]
end

#simplified_rendering? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
64
65
66
67
68
69
 
# File 'lib/reline/line_editor.rb', line 61

def simplified_rendering?
  if finished?
    false
  elsif @just_cursor_moving and not @rerender_all
    true
  else
    not @rerender_all and not finished? and Reline::IOGate.in_pasting?
  end
end

#whole_buffer ⇒ Object 



1282
1283
1284
1285
1286
1287
1288
 
# File 'lib/reline/line_editor.rb', line 1282

def whole_buffer
  if @buffer_of_lines.size == 1 and @line.nil?
    nil
  else
    whole_lines.join("\n")
  end
end

#whole_lines(index: @line_index, line: @line) ⇒ Object 



1276
1277
1278
1279
1280
 
# File 'lib/reline/line_editor.rb', line 1276

def whole_lines(index: @line_index, line: @line)
  temp_lines = @buffer_of_lines.dup
  temp_lines[index] = line
  temp_lines
end

#wrap_method_call(method_symbol, method_obj, key, with_operator = false) ⇒ Object 



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/reline/line_editor.rb', line 936

def wrap_method_call(method_symbol, method_obj, key, with_operator = false)
  if @config.editing_mode_is?(:emacs, :vi_insert) and @waiting_proc.nil? and @waiting_operator_proc.nil?
    not_insertion = method_symbol != :ed_insert
    process_insert(force: not_insertion)
  end
  if @vi_arg and argumentable?(method_obj)
    if with_operator and inclusive?(method_obj)
      method_obj.(key, arg: @vi_arg, inclusive: true)
    else
      method_obj.(key, arg: @vi_arg)
    end
  else
    if with_operator and inclusive?(method_obj)
      method_obj.(key, inclusive: true)
    else
      method_obj.(key)
    end
  end
end