Skip to content

Refactor perform_completon #778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ima1zumi merged 1 commit into from
Nov 11, 2024
Merged

Refactor perform_completon #778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 54 additions & 84 deletions lib/reline/line_editor.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ class Reline::LineEditor

module CompletionState
NORMAL = :normal
COMPLETION = :completion
MENU = :menu
MENU_WITH_PERFECT_MATCH = :menu_with_perfect_match
PERFECT_MATCH = :perfect_match
Expand Down Expand Up @@ -800,105 +799,74 @@ def editing_mode
@config.editing_mode
end

private def menu(_target, list)
private def menu(list)
@menu_info = MenuInfo.new(list)
end

private def complete_internal_proc(list, is_menu)
preposing, target, postposing = retrieve_completion_block
candidates = list.select { |i|
if i and not Encoding.compatible?(target.encoding, i.encoding)
raise Encoding::CompatibilityError, "#{target.encoding.name} is not compatible with #{i.encoding.name}"
private def filter_normalize_candidates(target, list)
target = target.downcase if @config.completion_ignore_case
list.select do |item|
next unless item

unless Encoding.compatible?(target.encoding, item.encoding)
# Crash with Encoding::CompatibilityError is required by readline-ext/test/readline/test_readline.rb
# TODO: fix the test
Copy link
Member

@ima1zumi ima1zumi Nov 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the test still failing?

Copy link
Member Author

@tompng tompng Nov 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. here's the failed ci log https://github.com/tompng/reline/actions/runs/11743521493/job/32716559834

raise Encoding::CompatibilityError, "#{target.encoding.name} is not compatible with #{item.encoding.name}"
end

if @config.completion_ignore_case
i&.downcase&.start_with?(target.downcase)
item.downcase.start_with?(target)
else
i&.start_with?(target)
end
}.uniq
if is_menu
menu(target, candidates)
return nil
end
completed = candidates.inject { |memo, item|
begin
memo_mbchars = memo.unicode_normalize.grapheme_clusters
item_mbchars = item.unicode_normalize.grapheme_clusters
rescue Encoding::CompatibilityError
memo_mbchars = memo.grapheme_clusters
item_mbchars = item.grapheme_clusters
end
size = [memo_mbchars.size, item_mbchars.size].min
result = +''
size.times do |i|
if @config.completion_ignore_case
if memo_mbchars[i].casecmp?(item_mbchars[i])
result << memo_mbchars[i]
else
break
end
else
if memo_mbchars[i] == item_mbchars[i]
result << memo_mbchars[i]
else
break
end
end
item.start_with?(target)
end
result
}

[target, preposing, completed, postposing, candidates]
end.map do |item|
item.unicode_normalize
rescue Encoding::CompatibilityError
item
end.uniq
end

private def perform_completion(list, just_show_list)
private def perform_completion(list)
preposing, target, postposing = retrieve_completion_block
candidates = filter_normalize_candidates(target, list)

case @completion_state
when CompletionState::NORMAL
@completion_state = CompletionState::COMPLETION
when CompletionState::PERFECT_MATCH
if @dig_perfect_match_proc
@dig_perfect_match_proc.(@perfect_matched)
else
@completion_state = CompletionState::COMPLETION
@dig_perfect_match_proc.call(@perfect_matched)
return
end
end
if just_show_list
is_menu = true
elsif @completion_state == CompletionState::MENU
is_menu = true
elsif @completion_state == CompletionState::MENU_WITH_PERFECT_MATCH
is_menu = true
else
is_menu = false
end
result = complete_internal_proc(list, is_menu)
if @completion_state == CompletionState::MENU_WITH_PERFECT_MATCH
when CompletionState::MENU
menu(candidates)
return
when CompletionState::MENU_WITH_PERFECT_MATCH
menu(candidates)
@completion_state = CompletionState::PERFECT_MATCH
return
end
return if result.nil?
target, preposing, completed, postposing, candidates = result
return if completed.nil?
if target <= completed and (@completion_state == CompletionState::COMPLETION)
append_character = ''
if candidates.include?(completed)
if candidates.one?
append_character = completion_append_character.to_s
@completion_state = CompletionState::PERFECT_MATCH
else
@completion_state = CompletionState::MENU_WITH_PERFECT_MATCH
perform_completion(candidates, true) if @config.show_all_if_ambiguous
end
@perfect_matched = completed

completed = Reline::Unicode.common_prefix(candidates, ignore_case: @config.completion_ignore_case)
return if completed.empty?

append_character = ''
if candidates.include?(completed)
if candidates.one?
append_character = completion_append_character.to_s
@completion_state = CompletionState::PERFECT_MATCH
elsif @config.show_all_if_ambiguous
menu(candidates)
@completion_state = CompletionState::PERFECT_MATCH
else
@completion_state = CompletionState::MENU
perform_completion(candidates, true) if @config.show_all_if_ambiguous
end
unless just_show_list
@buffer_of_lines[@line_index] = (preposing + completed + append_character + postposing).split("\n")[@line_index] || String.new(encoding: encoding)
line_to_pointer = (preposing + completed + append_character).split("\n")[@line_index] || String.new(encoding: encoding)
@byte_pointer = line_to_pointer.bytesize
@completion_state = CompletionState::MENU_WITH_PERFECT_MATCH
end
@perfect_matched = completed
else
@completion_state = CompletionState::MENU
menu(candidates) if @config.show_all_if_ambiguous
end
@buffer_of_lines[@line_index] = (preposing + completed + append_character + postposing).split("\n")[@line_index] || String.new(encoding: encoding)
line_to_pointer = (preposing + completed + append_character).split("\n")[@line_index] || String.new(encoding: encoding)
@byte_pointer = line_to_pointer.bytesize
end

def dialog_proc_scope_completion_journey_data
Expand Down Expand Up @@ -1463,7 +1431,7 @@ def finish
result = call_completion_proc
if result.is_a?(Array)
@completion_occurs = true
perform_completion(result, false)
perform_completion(result)
end
end
end
Expand Down Expand Up @@ -1929,7 +1897,9 @@ def finish
elsif !@config.autocompletion # show completed list
result = call_completion_proc
if result.is_a?(Array)
perform_completion(result, true)
_preposing, target = retrieve_completion_block
candidates = filter_normalize_candidates(target, result)
menu(candidates)
end
end
end
Expand Down
13 changes: 13 additions & 0 deletions lib/reline/unicode.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,19 @@ def self.vi_backward_word(line, byte_pointer)
[byte_size, width]
end

def self.common_prefix(list, ignore_case: false)
Copy link
Member

@ima1zumi ima1zumi Nov 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious, what's the purpose of this method?

Copy link
Member Author

@tompng tompng Nov 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Calculates the common prefix of the list
common_prefix(["a.singleton_class", "a.singleton_method", "a.singleton_methods"]) returns
the common part prefix "a.singleton_"
Used in TAB completion

$ irb --noautocomplete
irb(main):001> a=''
=> ""
irb(main):002> a.sin[TAB]
↓
irb(main):002> a.singleton_

complete_internal_proc was doing this common prefix calculation (and also doing other things like filtering list and menu setup)
I split it to common_prefix (Pure string processing logic independent to line_editor) and filter_normalize_candidates (including completion logic).

Copy link
Member

@ima1zumi ima1zumi Nov 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand. Thank you!

return '' if list.empty?

common_prefix_gcs = list.first.grapheme_clusters
list.each do |item|
gcs = item.grapheme_clusters
common_prefix_gcs = common_prefix_gcs.take_while.with_index do |gc, i|
ignore_case ? gc.casecmp?(gcs[i]) : gc == gcs[i]
end
end
common_prefix_gcs.join
end

def self.vi_first_print(line)
width = 0
byte_size = 0
Expand Down
3 changes: 3 additions & 0 deletions test/reline/test_key_actor_emacs.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -986,6 +986,9 @@ def test_completion_with_completion_ignore_case
input_keys('b')
input_keys("\C-i", false)
assert_line_around_cursor('foo_ba', '')
input_keys('Z')
input_keys("\C-i", false)
assert_line_around_cursor('Foo_baz', '')
end

def test_completion_in_middle_of_line
Expand Down
10 changes: 10 additions & 0 deletions test/reline/test_unicode.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,16 @@ def test_take_mbchar_range
assert_equal ["\e[41m \e[42mい\e[43m ", 1, 4], Reline::Unicode.take_mbchar_range("\e[41mあ\e[42mい\e[43mう", 1, 4, padding: true)
end

def test_common_prefix
assert_equal('', Reline::Unicode.common_prefix([]))
assert_equal('abc', Reline::Unicode.common_prefix(['abc']))
assert_equal('12', Reline::Unicode.common_prefix(['123', '123️⃣']))
assert_equal('', Reline::Unicode.common_prefix(['abc', 'xyz']))
assert_equal('ab', Reline::Unicode.common_prefix(['abcd', 'abc', 'abx', 'abcd']))
assert_equal('A', Reline::Unicode.common_prefix(['AbcD', 'ABC', 'AbX', 'AbCD']))
assert_equal('Ab', Reline::Unicode.common_prefix(['AbcD', 'ABC', 'AbX', 'AbCD'], ignore_case: true))
end

def test_encoding_conversion
texts = [
String.new("invalid\xFFutf8", encoding: 'utf-8'),
Expand Down