Class: Reline::LineEditor
- Inherits:
-
Object
- Object
- Reline::LineEditor
- 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 }
Instance Attribute Summary collapse
-
#auto_indent_proc ⇒ Object
Returns the value of attribute auto_indent_proc.
-
#byte_pointer ⇒ Object
Returns the value of attribute byte_pointer.
-
#completion_append_character ⇒ Object
Returns the value of attribute completion_append_character.
-
#completion_proc ⇒ Object
Returns the value of attribute completion_proc.
-
#confirm_multiline_termination_proc ⇒ Object
Returns the value of attribute confirm_multiline_termination_proc.
-
#dig_perfect_match_proc ⇒ Object
Returns the value of attribute dig_perfect_match_proc.
-
#line ⇒ Object
readonly
TODO: undo.
-
#output ⇒ Object
writeonly
Sets the attribute output.
-
#output_modifier_proc ⇒ Object
Returns the value of attribute output_modifier_proc.
-
#pre_input_hook ⇒ Object
Returns the value of attribute pre_input_hook.
-
#prompt_proc ⇒ Object
Returns the value of attribute prompt_proc.
Instance Method Summary collapse
- #call_completion_proc ⇒ Object
- #confirm_multiline_termination ⇒ Object
- #delete_text(start = nil, length = nil) ⇒ Object
- #editing_mode ⇒ Object
- #eof? ⇒ Boolean
- #finalize ⇒ Object
- #finish ⇒ Object
- #finished? ⇒ Boolean
-
#initialize(config, encoding) ⇒ LineEditor
constructor
A new instance of LineEditor.
- #input_key(key) ⇒ Object
- #insert_text(text) ⇒ Object
- #multiline_off ⇒ Object
- #multiline_on ⇒ Object
- #rerender ⇒ Object
- #rerender_all ⇒ Object
- #reset(prompt = '', encoding:) ⇒ Object
- #reset_line ⇒ Object
- #reset_variables(prompt = '', encoding:) ⇒ Object
- #retrieve_completion_block(set_completion_quote_character = false) ⇒ Object
- #simplified_rendering? ⇒ Boolean
- #whole_buffer ⇒ Object
- #whole_lines(index: @line_index, line: @line) ⇒ Object
Constructor Details
#initialize(config, encoding) ⇒ LineEditor
Returns a new instance of LineEditor.
53 54 55 56 57 |
# File 'lib/reline/line_editor.rb', line 53 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
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
859 860 861 862 863 864 865 |
# File 'lib/reline/line_editor.rb', line 859 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
969 970 971 972 973 974 975 976 977 |
# File 'lib/reline/line_editor.rb', line 969 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
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 |
# File 'lib/reline/line_editor.rb', line 991 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
564 565 566 |
# File 'lib/reline/line_editor.rb', line 564 def editing_mode @config.editing_mode end |
#eof? ⇒ Boolean
164 165 166 |
# File 'lib/reline/line_editor.rb', line 164 def eof? @eof end |
#finalize ⇒ Object
160 161 162 |
# File 'lib/reline/line_editor.rb', line 160 def finalize Signal.trap('SIGINT', @old_trap) end |
#finish ⇒ Object
1054 1055 1056 1057 1058 |
# File 'lib/reline/line_editor.rb', line 1054 def finish @finished = true @rerender_all = true @config.reset end |
#finished? ⇒ Boolean
1050 1051 1052 |
# File 'lib/reline/line_editor.rb', line 1050 def finished? @finished end |
#input_key(key) ⇒ Object
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 |
# File 'lib/reline/line_editor.rb', line 820 def input_key(key) if key.char.nil? if @first_char @line = nil end finish return end @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 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 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 @is_multiline and @auto_indent_proc and not simplified_rendering? process_auto_indent end end |
#insert_text(text) ⇒ Object
979 980 981 982 983 984 985 986 987 988 989 |
# File 'lib/reline/line_editor.rb', line 979 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 |
#multiline_off ⇒ Object
215 216 217 |
# File 'lib/reline/line_editor.rb', line 215 def multiline_off @is_multiline = false end |
#multiline_on ⇒ Object
211 212 213 |
# File 'lib/reline/line_editor.rb', line 211 def multiline_on @is_multiline = true end |
#rerender ⇒ Object
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 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 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 |
# File 'lib/reline/line_editor.rb', line 314 def rerender return if @line.nil? if @menu_info scroll_down(@highest_in_all - @first_line_started_from) @rerender_all = true @menu_info.list.sort!.each do |item| Reline::IOGate.move_cursor_column(0) @output.write item @output.flush scroll_down(1) end scroll_down(@highest_in_all - 1) move_cursor_up(@highest_in_all - 1 - @first_line_started_from) @menu_info = nil end prompt, prompt_width, prompt_list = check_multiline_prompt(whole_lines, prompt) if @cleared Reline::IOGate.clear_screen @cleared = false back = 0 modify_lines(whole_lines).each_with_index do |line, index| if @prompt_proc pr = prompt_list[index] height = render_partial(pr, calculate_width(pr), line, false) else height = render_partial(prompt, prompt_width, line, false) end if index < (@buffer_of_lines.size - 1) move_cursor_down(height) back += height end end move_cursor_up(back) move_cursor_down(@first_line_started_from + @started_from) Reline::IOGate.move_cursor_column((prompt_width + @cursor) % @screen_size.last) 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 @previous_line_index or new_highest_in_this != @highest_in_this if @previous_line_index new_lines = whole_lines(index: @previous_line_index, line: @line) else new_lines = whole_lines end prompt, prompt_width, prompt_list = check_multiline_prompt(new_lines, prompt) all_height = calculate_height_by_lines(new_lines, prompt_list || prompt) diff = all_height - @highest_in_all move_cursor_down(@highest_in_all - @first_line_started_from - @started_from - 1) if diff > 0 scroll_down(diff) move_cursor_up(all_height - 1) elsif diff < 0 (-diff).times do Reline::IOGate.move_cursor_column(0) Reline::IOGate.erase_after_cursor move_cursor_up(1) end move_cursor_up(all_height - 1) else move_cursor_up(all_height - 1) end @highest_in_all = all_height back = 0 modify_lines(new_lines).each_with_index do |line, index| if @prompt_proc prompt = prompt_list[index] prompt_width = calculate_width(prompt, true) end height = render_partial(prompt, prompt_width, line, false) if index < (new_lines.size - 1) scroll_down(1) back += height else back += height - 1 end end move_cursor_up(back) if @previous_line_index @buffer_of_lines[@previous_line_index] = @line @line = @buffer_of_lines[@line_index] end @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 move_cursor_down(@first_line_started_from) calculate_nearest_cursor @started_from = calculate_height_by_width(prompt_width + @cursor) - 1 move_cursor_down(@started_from) Reline::IOGate.move_cursor_column((prompt_width + @cursor) % @screen_size.last) @highest_in_this = calculate_height_by_width(prompt_width + @cursor_max) @previous_line_index = nil rendered = true elsif @rerender_all move_cursor_up(@first_line_started_from + @started_from) Reline::IOGate.move_cursor_column(0) 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 if back > @highest_in_all scroll_down(back - 1) move_cursor_up(back - 1) elsif back < @highest_in_all scroll_down(back) Reline::IOGate.erase_after_cursor (@highest_in_all - back - 1).times do scroll_down(1) Reline::IOGate.erase_after_cursor end move_cursor_up(@highest_in_all - 1) end modify_lines(new_buffer).each_with_index do |line, index| if @prompt_proc prompt = prompt_list[index] prompt_width = calculate_width(prompt, true) end render_partial(prompt, prompt_width, line, false) if index < (new_buffer.size - 1) move_cursor_down(1) end end move_cursor_up(back - 1) if @prompt_proc prompt = prompt_list[@line_index] prompt_width = calculate_width(prompt, true) 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(new_buffer[0..(@line_index - 1)], prompt_list || prompt) end @started_from = calculate_height_by_width(prompt_width + @cursor) - 1 move_cursor_down(@first_line_started_from + @started_from) Reline::IOGate.move_cursor_column((prompt_width + @cursor) % @screen_size.last) @rerender_all = false rendered = true 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) scroll_down(1) Reline::IOGate.move_cursor_column(0) Reline::IOGate.erase_after_cursor elsif not rendered render_partial(prompt, prompt_width, line) end else render_partial(prompt, prompt_width, line) if finished? scroll_down(1) Reline::IOGate.move_cursor_column(0) Reline::IOGate.erase_after_cursor end end end |
#rerender_all ⇒ Object
309 310 311 312 |
# File 'lib/reline/line_editor.rb', line 309 def rerender_all @rerender_all = true rerender end |
#reset(prompt = '', encoding:) ⇒ Object
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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/reline/line_editor.rb', line 114 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 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 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
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/reline/line_editor.rb', line 193 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
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/reline/line_editor.rb', line 168 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 @completion_journey_data = nil @completion_state = CompletionState::NORMAL @perfect_matched = nil @menu_info = nil @first_prompt = true @searching_prompt = nil @first_char = true @eof = false reset_line end |
#retrieve_completion_block(set_completion_quote_character = false) ⇒ Object
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 |
# File 'lib/reline/line_editor.rb', line 908 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
59 60 61 62 63 64 65 |
# File 'lib/reline/line_editor.rb', line 59 def simplified_rendering? if finished? false else not @rerender_all and not finished? and Reline::IOGate.in_pasting? end end |
#whole_buffer ⇒ Object
1042 1043 1044 1045 1046 1047 1048 |
# File 'lib/reline/line_editor.rb', line 1042 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
1036 1037 1038 1039 1040 |
# File 'lib/reline/line_editor.rb', line 1036 def whole_lines(index: @line_index, line: @line) temp_lines = @buffer_of_lines.dup temp_lines[index] = line temp_lines end |