vimamsa 0.1.26 → 0.1.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/appimage.yml +93 -0
  3. data/.gitignore +4 -1
  4. data/Dockerfile +7 -4
  5. data/README.md +62 -16
  6. data/custom_example.rb +43 -13
  7. data/doc/TODO.md +461 -0
  8. data/doc/bundling_plan.md +569 -0
  9. data/doc/key_bindings_report_plan.md +168 -0
  10. data/doc/missing_vim_bindings.md +71 -0
  11. data/doc/modules_settings_plan.md +433 -0
  12. data/doc/refactor_dedup_plan.md +117 -0
  13. data/doc/unused_code_plan.md +120 -0
  14. data/doc/vim_compatibility_plan.md +296 -0
  15. data/doc/vimlike_vim_conflicts.md +254 -0
  16. data/doc/vm_snapshots_plan.md +146 -0
  17. data/exe/run_tests.rb +117 -3
  18. data/exe/vimamsa +24 -4
  19. data/fonts/OFL-Oxanium.txt +93 -0
  20. data/fonts/Oxanium[wght].ttf +0 -0
  21. data/icon.png +0 -0
  22. data/img/demo.gif +0 -0
  23. data/lang/hyperplaintext.lang +6 -0
  24. data/lib/vimamsa/ack.rb +11 -1
  25. data/lib/vimamsa/actions.rb +4 -1
  26. data/lib/vimamsa/appimage_env.rb +35 -0
  27. data/lib/vimamsa/audio.rb +2 -5
  28. data/lib/vimamsa/bookmarks.rb +302 -0
  29. data/lib/vimamsa/buffer.rb +593 -82
  30. data/lib/vimamsa/buffer_changetext.rb +102 -42
  31. data/lib/vimamsa/buffer_cursor.rb +7 -0
  32. data/lib/vimamsa/buffer_list.rb +4 -0
  33. data/lib/vimamsa/buffer_manager.rb +4 -1
  34. data/lib/vimamsa/bundled_fonts.rb +32 -0
  35. data/lib/vimamsa/clipboard.rb +3 -0
  36. data/lib/vimamsa/conf.rb +59 -3
  37. data/lib/vimamsa/constants.rb +3 -0
  38. data/lib/vimamsa/crash_handler.rb +149 -0
  39. data/lib/vimamsa/debug.rb +4 -1
  40. data/lib/vimamsa/desktop_install.rb +96 -0
  41. data/lib/vimamsa/diff_buffer.rb +39 -10
  42. data/lib/vimamsa/easy_jump.rb +3 -0
  43. data/lib/vimamsa/editor.rb +263 -57
  44. data/lib/vimamsa/encrypt.rb +78 -29
  45. data/lib/vimamsa/file_finder.rb +4 -19
  46. data/lib/vimamsa/file_history.rb +3 -0
  47. data/lib/vimamsa/file_manager.rb +30 -15
  48. data/lib/vimamsa/fold.rb +226 -0
  49. data/lib/vimamsa/gui.rb +520 -106
  50. data/lib/vimamsa/gui_command_line.rb +208 -0
  51. data/lib/vimamsa/gui_dialog.rb +94 -42
  52. data/lib/vimamsa/gui_file_panel.rb +356 -25
  53. data/lib/vimamsa/gui_form_generator.rb +59 -35
  54. data/lib/vimamsa/gui_func_panel.rb +67 -22
  55. data/lib/vimamsa/gui_image.rb +3 -0
  56. data/lib/vimamsa/gui_keylog_panel.rb +246 -0
  57. data/lib/vimamsa/gui_menu.rb +23 -11
  58. data/lib/vimamsa/gui_select_window.rb +19 -48
  59. data/lib/vimamsa/gui_settings.rb +78 -37
  60. data/lib/vimamsa/gui_sourceview.rb +273 -19
  61. data/lib/vimamsa/gui_sourceview_autocomplete.rb +319 -90
  62. data/lib/vimamsa/gui_text.rb +63 -2
  63. data/lib/vimamsa/gui_theme.rb +606 -0
  64. data/lib/vimamsa/hook.rb +3 -0
  65. data/lib/vimamsa/hyper_plain_text.rb +3 -0
  66. data/lib/vimamsa/key_actions.rb +112 -13
  67. data/lib/vimamsa/key_binding_tree.rb +242 -215
  68. data/lib/vimamsa/key_bindings_notepad.rb +43 -0
  69. data/lib/vimamsa/key_bindings_report.rb +261 -0
  70. data/lib/vimamsa/key_bindings_vim.rb +354 -0
  71. data/lib/vimamsa/key_bindings_vimlike.rb +65 -9
  72. data/lib/vimamsa/langservp.rb +271 -54
  73. data/lib/vimamsa/macro.rb +3 -0
  74. data/lib/vimamsa/main.rb +14 -8
  75. data/lib/vimamsa/rbvma.rb +26 -1
  76. data/lib/vimamsa/search.rb +3 -0
  77. data/lib/vimamsa/search_replace.rb +11 -10
  78. data/lib/vimamsa/string_util.rb +120 -40
  79. data/lib/vimamsa/terminal.rb +3 -0
  80. data/lib/vimamsa/test_framework.rb +28 -2
  81. data/lib/vimamsa/tests.rb +3 -0
  82. data/lib/vimamsa/text_objects.rb +353 -0
  83. data/lib/vimamsa/text_transforms.rb +14 -0
  84. data/lib/vimamsa/util.rb +46 -7
  85. data/lib/vimamsa/version.rb +1 -1
  86. data/lib/vimamsa.rb +0 -1
  87. data/modules/color_highlight/color_highlight.rb +118 -0
  88. data/modules/color_highlight/color_highlight_info.rb +3 -0
  89. data/modules/dictation/dictation.rb +1054 -0
  90. data/modules/dictation/dictation_info.rb +3 -0
  91. data/modules/dictation/whisper_worker.py +273 -0
  92. data/modules/ollama/ollama.rb +107 -0
  93. data/modules/ollama/ollama_info.rb +3 -0
  94. data/modules/tts/tts.rb +119 -0
  95. data/modules/tts/tts_info.rb +3 -0
  96. data/run_e2e_vm.sh +28 -0
  97. data/run_tests_vm.sh +130 -0
  98. data/scripts/appimage/AppRun +54 -0
  99. data/scripts/appimage/Dockerfile +18 -0
  100. data/scripts/appimage/build.sh +19 -0
  101. data/scripts/appimage/build_in_container.sh +192 -0
  102. data/scripts/appimage/smoke_test.sh +27 -0
  103. data/scripts/demo/demo_steps.txt +59 -0
  104. data/scripts/demo/record_demo.rb +177 -0
  105. data/scripts/demo/shapes.rb +28 -0
  106. data/styles/134272-molokai.xml +3 -0
  107. data/styles/molokai_cyber.xml +48 -0
  108. data/styles/molokai_edit.xml +1 -0
  109. data/tests/support/virtual_keyboard.rb +254 -0
  110. data/tests/support/virtual_mic.rb +67 -0
  111. data/tests/test_ack.rb +22 -0
  112. data/tests/test_auto_format.rb +122 -0
  113. data/tests/test_autocomplete.rb +211 -0
  114. data/tests/test_autosave.rb +145 -0
  115. data/tests/test_basic_editing.rb +33 -3
  116. data/tests/test_bookmarks.rb +206 -0
  117. data/tests/test_bracket_match.rb +85 -0
  118. data/tests/test_bundling.rb +92 -0
  119. data/tests/test_color_highlight.rb +92 -0
  120. data/tests/test_command_line.rb +79 -0
  121. data/tests/test_command_line_file.rb +27 -0
  122. data/tests/test_context_menu_file.rb +129 -0
  123. data/tests/test_copy_paste.rb +80 -0
  124. data/tests/test_crash_handler.rb +39 -0
  125. data/tests/test_custom_two_phase.rb +92 -0
  126. data/tests/test_dialog_callback_errors.rb +44 -0
  127. data/tests/test_dictation.rb +294 -0
  128. data/tests/test_diff_buffer_name.rb +51 -0
  129. data/tests/test_double_click.rb +41 -0
  130. data/tests/test_drag_selection.rb +125 -0
  131. data/tests/test_e2e_cmdline.rb +116 -0
  132. data/tests/test_e2e_dictation.rb +98 -0
  133. data/tests/test_e2e_replace_char.rb +58 -0
  134. data/tests/test_extract_file_links.rb +55 -0
  135. data/tests/test_file_format.rb +217 -0
  136. data/tests/test_file_manager.rb +72 -0
  137. data/tests/test_file_panel.rb +269 -0
  138. data/tests/test_flash.rb +78 -0
  139. data/tests/test_fold.rb +111 -0
  140. data/tests/test_font_refresh.rb +56 -0
  141. data/tests/test_func_panel.rb +68 -0
  142. data/tests/test_grep_apply.rb +46 -0
  143. data/tests/test_gtk_sync.rb +126 -0
  144. data/tests/test_hpt_highlight_visible.rb +75 -0
  145. data/tests/test_hpt_link_highlight.rb +82 -0
  146. data/tests/test_jump_to_file.rb +41 -0
  147. data/tests/test_key_bindings.rb +208 -0
  148. data/tests/test_keylog_panel.rb +101 -0
  149. data/tests/test_lsp_clangd.rb +281 -0
  150. data/tests/test_lsp_jump.rb +87 -0
  151. data/tests/test_lsp_position_encoding.rb +49 -0
  152. data/tests/test_lsp_symbols.rb +68 -0
  153. data/tests/test_macro.rb +137 -0
  154. data/tests/test_markdown_highlight.rb +57 -0
  155. data/tests/test_mode_badge.rb +41 -0
  156. data/tests/test_notepad_bindings.rb +67 -0
  157. data/tests/test_popup_queue.rb +51 -0
  158. data/tests/test_random_edit.rb +109 -0
  159. data/tests/test_revert.rb +127 -0
  160. data/tests/test_startup_file.rb +58 -0
  161. data/tests/test_status_area.rb +50 -0
  162. data/tests/test_text_objects.rb +163 -0
  163. data/tests/test_text_transforms.rb +329 -0
  164. data/tests/test_tts.rb +68 -0
  165. data/tests/test_vim_bindings.rb +252 -0
  166. data/tests/test_vim_conflicts.rb +63 -0
  167. data/tests/test_window_layout.rb +219 -0
  168. data/vimamsa.gemspec +3 -1
  169. data/vm_guest_run.sh +109 -0
  170. metadata +112 -10
@@ -1,3 +1,5 @@
1
+
2
+ module Vimamsa
1
3
  # This file has everyting related to binding key (and other) events
2
4
  # into actions.
3
5
 
@@ -43,9 +45,29 @@ end
43
45
 
44
46
  class KeyBindingTree
45
47
  attr_accessor :C, :I, :cur_state, :root, :match_state, :last_action, :cur_action, :modifiers, :next_command_count, :method_handles_repeat, :default_mode
46
- attr_reader :mode_root_state, :state_trail, :act_bindings, :default_mode_stack
47
-
48
- def initialize()
48
+ attr_accessor :action_handler, :on_action_error, :logger, :fatal_handler, :error_handler
49
+ attr_reader :mode_root_state, :state_trail, :act_bindings, :default_mode_stack, :actions
50
+
51
+ # This class is host-agnostic: it never touches the editor or GUI directly.
52
+ # The host injects collaborators (actions registry, action_handler, logger,
53
+ # fatal_handler, on_action_error) and subscribes to events via #on:
54
+ # :mode_set(label) - set_mode was called explicitly
55
+ # :mode_changed(label) - mode changed (any path)
56
+ # :state_trail_changed(badge, badge_key, trail) - badge/pending-chord display
57
+ # :key_no_match(key, trail) - key did not match any binding
58
+ # :key_pending(trail) - multi-key sequence in progress
59
+ # :key_action(trail, action) - action about to be executed
60
+ # :action_executed(action, ret) - one execution of an action finished
61
+ # :action_handled(trail, action) - key handling for an action completed
62
+ def initialize(actions: nil)
63
+ @actions = actions
64
+ @listeners = {}
65
+ @action_handler = nil
66
+ @logger = nil
67
+ @fatal_handler = proc { |msg| raise msg }
68
+ # Non-fatal problems the user should see (e.g. a binding to an unknown mode)
69
+ @error_handler = proc { |msg| warn msg }
70
+ @on_action_error = nil
49
71
  @next_command_count = nil
50
72
  @modes = {}
51
73
  @root = State.new("ROOT")
@@ -67,9 +89,31 @@ class KeyBindingTree
67
89
  @act_bindings = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
68
90
  end
69
91
 
92
+ # Subscribe to one of the events listed above initialize
93
+ def on(event, &blk)
94
+ (@listeners[event] ||= []) << blk
95
+ end
96
+
97
+ def emit(event, *args)
98
+ @listeners.fetch(event, []).each { |l| l.call(*args) }
99
+ end
100
+ private :emit
101
+
102
+ def log(msg, level = 1)
103
+ @logger.call(msg, level) if @logger
104
+ end
105
+ private :log
106
+
107
+ # Report a non-fatal problem (bad binding definition etc.) to the host.
108
+ def error(msg)
109
+ log(msg)
110
+ @error_handler.call(msg) if @error_handler
111
+ end
112
+ private :error
113
+
70
114
  def set_mode(label)
71
115
  return if get_mode == :label
72
- vma.buf&.new_undo_group
116
+ emit(:mode_set, label)
73
117
  @match_state = [@modes[label]] # used for matching input
74
118
  @mode_root_state = @modes[label]
75
119
 
@@ -77,9 +121,6 @@ class KeyBindingTree
77
121
  @default_mode_stack << label if label != @default_mode_stack[-1]
78
122
 
79
123
  __set_mode(label)
80
- if !vma.buf.nil?
81
- # vma.buf.mode_stack = @default_mode_stack.clone
82
- end
83
124
  end
84
125
 
85
126
  def set_default_mode(label)
@@ -90,8 +131,7 @@ class KeyBindingTree
90
131
  end
91
132
 
92
133
  def set_mode_stack(ms)
93
- debug "set_mode_stack(#{ms})", 2
94
- show_caller if cnf.debug? # TODO: remove
134
+ log "set_mode_stack(#{ms})", 2
95
135
  @default_mode_stack = ms
96
136
  label = @default_mode_stack[-1]
97
137
  @match_state = [@modes[label]]
@@ -99,10 +139,9 @@ class KeyBindingTree
99
139
  end
100
140
 
101
141
  def dump_state
102
- debug "dump_state", 2
142
+ log "dump_state", 2
103
143
  pp ["@default_mode_stack", @default_mode_stack]
104
144
  pp ["@default_mode", @default_mode]
105
- pp ["vma.buf.mode_stack", vma.buf.mode_stack]
106
145
  pp ["scope", self.get_scope]
107
146
  # pp ["@mode_root_state", @mode_root_state]
108
147
  # pp ["@match_state", @match_state]
@@ -115,16 +154,21 @@ class KeyBindingTree
115
154
  end
116
155
 
117
156
  def to_previous_mode()
118
- debug "to_previous_mode", 2
119
- debug @default_mode_stack
157
+ log "to_previous_mode", 2
158
+ log @default_mode_stack
120
159
  if @default_mode_stack.size > 1
121
160
  @default_mode_stack.pop
122
161
  end
123
- debug @default_mode_stack
162
+ log @default_mode_stack
124
163
  __set_mode(@default_mode_stack[-1])
125
164
  end
126
165
 
127
166
  def add_mode(id, label, cursortype = :command, name: nil, scope: :buffer)
167
+ # Replace any existing mode with the same key id: when a keybinding scheme
168
+ # file is loaded over another one, both binding (which walks @root.children
169
+ # by key name) and matching (which starts from @modes) must resolve to the
170
+ # same, new node.
171
+ @root.children.delete_if { |s| s.key_name == id }
128
172
  mode = State.new(id, "", cursortype, scope: scope)
129
173
  mode.level = 1
130
174
  @modes[label] = mode
@@ -136,11 +180,9 @@ class KeyBindingTree
136
180
 
137
181
  # Add keyboard key binding mode based on another mode
138
182
  def add_minor_mode(id, label, major_mode_label)
183
+ @root.children.delete_if { |s| s.key_name == id }
139
184
  mode = State.new(id)
140
185
  @modes[label] = mode
141
- if @root.nil?
142
- show_caller
143
- end
144
186
  @root.children << mode
145
187
  mode.major_modes << major_mode_label
146
188
  end
@@ -177,15 +219,15 @@ class KeyBindingTree
177
219
  if c.key_name == key_name and c.eval_rule == ""
178
220
  new_state << c
179
221
  elsif c.key_name == key_name and c.eval_rule != ""
180
- debug "CHECK EVAL: #{c.eval_rule}"
222
+ log "CHECK EVAL: #{c.eval_rule}"
181
223
  if eval(c.eval_rule)
182
224
  # if eval_rule.match(/macro/)
183
225
  debug = true
184
226
  # end
185
227
  new_state << c
186
- debug "EVAL TRUE"
228
+ log "EVAL TRUE"
187
229
  else
188
- debug "EVAL FALSE"
230
+ log "EVAL FALSE"
189
231
  end
190
232
  end
191
233
  }
@@ -206,12 +248,11 @@ class KeyBindingTree
206
248
  end
207
249
 
208
250
  def show_state_trail
209
- (st, children) = get_state_trail_str()
210
- vma.gui.statnfo.markup = "<span weight='ultrabold'>#{st}</span>"
251
+ emit(:state_trail_changed, *get_state_trail_parts())
211
252
  end
212
253
 
213
254
  def __set_mode(label)
214
- debug "__set_mode(#{label})"
255
+ log "__set_mode(#{label})"
215
256
  @mode_history << @mode_root_state
216
257
 
217
258
  # Check if label in form :label
@@ -228,13 +269,7 @@ class KeyBindingTree
228
269
  end
229
270
  @cur_mode = label
230
271
 
231
- if self.get_scope != :editor and !vma.buf.nil?
232
- vma.buf.mode_stack = @default_mode_stack.clone
233
- end
234
-
235
- if !vma.gui.view.nil?
236
- vma.gui.view.draw_cursor() #TODO: handle outside this class
237
- end
272
+ emit(:mode_changed, label)
238
273
  end
239
274
 
240
275
  def get_scope
@@ -278,6 +313,7 @@ class KeyBindingTree
278
313
  end
279
314
 
280
315
  @state_trail = [@mode_root_state]
316
+ @num_digits = nil
281
317
  end
282
318
 
283
319
  # Returns a list of key positions that are free (no action bound) under each
@@ -367,8 +403,8 @@ class KeyBindingTree
367
403
  else
368
404
  method_desc = t.action
369
405
  if t.action.class == Symbol
370
- if vma.actions.include?(t.action)
371
- a = vma.actions[t.action].method_name
406
+ if @actions&.include?(t.action)
407
+ a = @actions[t.action].method_name
372
408
  if !a.nil? and !a.empty?
373
409
  method_desc = a
374
410
  end
@@ -386,55 +422,18 @@ class KeyBindingTree
386
422
  return s
387
423
  end
388
424
 
389
- # Print key bindings to show as documentation or for debugging
390
425
  def to_s()
391
426
  return self.class.to_s
392
- s = ""
393
- # @cur_state = @root
394
- stack = [[@root, ""]]
395
- lines = []
396
-
397
- # Traverse the tree (class State objects) using a stack
398
- while stack.any?
399
- t, p = *stack.pop # t = current state, p = current path
400
- if t.children.any?
401
- t.children.reverse.each { |c|
402
- if c.eval_rule.size > 0
403
- new_p = "#{p} #{c.key_name}(#{c.eval_rule})"
404
- else
405
- if c.level == 1
406
- new_p = "#{p} [#{c.key_name}]"
407
- else
408
- new_p = "#{p} #{c.key_name}"
409
- end
410
- end
411
- stack << [c, new_p]
412
- }
413
- # stack.concat[t.children]
414
- else
415
- method_desc = t.action
416
- if t.action.class == Symbol
417
- if vma.actions.include?(t.action)
418
- a = vma.actions[t.action].method_name
419
- if !a.nil? and !a.empty?
420
- method_desc = a
421
- end
422
- end
423
- end
424
-
425
- kw = ""
426
- # kw = ", " + t.keywords.join(",") if !t.keywords.empty?
427
- lines << p + " : #{method_desc}#{kw}"
428
- end
429
- end
430
- s = lines.sort.join("\n")
431
- return s
432
427
  end
433
428
 
434
- def get_state_trail_str
435
- s_trail = ""
436
- last_state = @state_trail.last
437
- last_state = last_state[0] if last_state.class == Array
429
+ # Returns [badge_str, badge_key, trail_str]:
430
+ # badge_str = human readable mode ("COMMAND", "C>fexp", ...), no brackets
431
+ # badge_key = key_name of the mode state ("C", "I", "fexp", ...)
432
+ # trail_str = pending key chord states + repeat count
433
+ def get_state_trail_parts
434
+ badge_str = ""
435
+ badge_key = nil
436
+ trail_str = ""
438
437
  first = true
439
438
  for st in @state_trail
440
439
  st = st[0] if st.class == Array
@@ -450,39 +449,88 @@ class KeyBindingTree
450
449
  mode_str = "VISUAL" if mode_str == "V"
451
450
  mode_str = "BROWSE" if mode_str == "B"
452
451
 
453
- s_trail << "[#{trailpfx}#{mode_str}]"
452
+ badge_key = st.key_name
453
+ badge_str = "#{trailpfx}#{mode_str}"
454
+ elsif st.key_name == "<num>" and @num_digits
455
+ trail_str << " #{@num_digits}"
454
456
  else
455
- s_trail << " #{st.to_s}"
457
+ trail_str << " #{st.to_s}"
456
458
  end
457
459
  first = false
458
460
  end
461
+ if !@next_command_count.nil?
462
+ trail_str << " #{@next_command_count}"
463
+ end
464
+ trail_str.strip!
465
+ return [badge_str, badge_key, trail_str]
466
+ end
467
+
468
+ def get_state_trail_str
469
+ (badge, _key, trail) = get_state_trail_parts()
470
+ s_trail = "[#{badge}]"
471
+ s_trail << " #{trail}" if !trail.empty?
472
+ last_state = @state_trail.last
473
+ last_state = last_state[0] if last_state.class == Array
459
474
  children = ""
460
475
  for cstate in last_state.children
461
476
  act_s = "..."
462
477
  act_s = cstate.action.to_s if cstate.action != nil
463
478
  children << " #{cstate.to_s} #{act_s}\n"
464
479
  end
465
- if !@next_command_count.nil?
466
- s_trail << " #{@next_command_count}"
467
- end
468
480
  return [s_trail, children]
469
481
  end
470
482
 
483
+ # True for a bare modifier key event ("ctrl", "shift!", ...)
484
+ def modifier_key?(c)
485
+ %w[ctrl alt shift meta super caps].include?(c.to_s.delete_suffix("!"))
486
+ end
487
+
471
488
  def set_next_command_count(num)
472
489
  if @next_command_count != nil
473
490
  @next_command_count = @next_command_count * 10 + num.to_i
474
491
  else
475
492
  @next_command_count = num.to_i
476
493
  end
477
- debug("NEXT COMMAND COUNT: #{@next_command_count}")
494
+ log("NEXT COMMAND COUNT: #{@next_command_count}")
478
495
  end
479
496
 
480
497
  # Modifies state of key binding tree (move to new state) based on received event
498
+ # A count typed inside a key sequence, for bindings like "C d <num> e"
499
+ # (d 3 e = delete to the end of the third word). The digits go to
500
+ # @num_digits; when the next key matches, they become the repeat count,
501
+ # multiplied by a count typed before the sequence (2 d 3 e = 6), as in vim.
502
+ # Exact bindings win: "C d 0" is still matched before this is tried.
503
+ def match_num_key(c, event_type)
504
+ return false unless event_type == :key_press and c.match?(/\A[0-9]\z/)
505
+ if @num_digits and @match_state.all? { |s| s.key_name == "<num>" }
506
+ @num_digits << c
507
+ else
508
+ return false if c == "0"
509
+ nums = @match_state.flat_map { |s| s.children.select { |x| x.key_name == "<num>" } }
510
+ return false if nums.empty?
511
+ @match_state = nums
512
+ @state_trail << nums
513
+ @num_digits = c.dup
514
+ end
515
+ emit(:key_pending, get_state_trail_str[0])
516
+ show_state_trail
517
+ true
518
+ end
519
+
520
+ def finish_num_count
521
+ return if @num_digits.nil?
522
+ @next_command_count = (@next_command_count || 1) * @num_digits.to_i
523
+ @num_digits = nil
524
+ end
525
+
481
526
  # Checks child nodes of current state if they match received event
482
527
  # if yes, change state to child
483
528
  # if no, go back to root
484
529
  def match_key_conf(c, translated_c, event_type)
485
- debug "MATCH KEY CONF: #{[c, translated_c]}"
530
+ log "MATCH KEY CONF: #{[c, translated_c]}"
531
+ # A delete still flashing from the previous key must land before this
532
+ # key's action runs.
533
+ Gui.flush_flash
486
534
 
487
535
  if !@override_keyhandling_callback.nil?
488
536
  ret = @override_keyhandling_callback.call(c, event_type)
@@ -492,6 +540,8 @@ class KeyBindingTree
492
540
  eval_s = nil
493
541
 
494
542
  new_state = match(c)
543
+ return true if new_state.nil? and match_num_key(c, event_type)
544
+ finish_num_count if new_state
495
545
  # #TODO:
496
546
  # new_state = match(translated_c)
497
547
  # if new_state == nil and translated_c.index("shift") == 0
@@ -540,11 +590,20 @@ class KeyBindingTree
540
590
  end
541
591
 
542
592
  if new_state == nil
543
- debug("NO MATCH")
593
+ log("NO MATCH")
594
+ if event_type == :key_press and !modifier_key?(c)
595
+ emit(:key_no_match, c, get_state_trail_str[0])
596
+ # A key that leads nowhere (e.g. esc) also aborts a count that is being
597
+ # typed: "2 0 0 esc" must not leave 200 pending for the next command.
598
+ # Modifier keys are excluded: they arrive as separate press events and
599
+ # must not break e.g. "2 0 ctrl-d".
600
+ @next_command_count = nil
601
+ @num_digits = nil
602
+ end
544
603
  if event_type == :key_press and c != "shift"
545
604
  # TODO:include other modifiers in addition to shift?
546
605
  set_state_to_root
547
- printf(", BACK TO ROOT") if cnf.debug?
606
+ log("BACK TO ROOT", 2)
548
607
  end
549
608
 
550
609
  if event_type == :key_release and c == "shift!"
@@ -552,10 +611,8 @@ class KeyBindingTree
552
611
  # only on key release when no other key has been pressed
553
612
  # after said modifier key (shift).
554
613
  set_state_to_root
555
- printf(", BACK TO ROOT") if cnf.debug?
614
+ log("BACK TO ROOT", 2)
556
615
  end
557
-
558
- printf("\n") if cnf.debug?
559
616
  else
560
617
 
561
618
  # Don't execute action if one of the states has children
@@ -592,16 +649,19 @@ class KeyBindingTree
592
649
  # if eval_s.to_s.match(/end_recording/)
593
650
  # require "pry"; binding.pry
594
651
  # end
595
- debug "FOUND MATCH:#{eval_s}"
596
- debug "CHAR: #{c}"
652
+ log "FOUND MATCH:#{eval_s}"
653
+ log "CHAR: #{c}"
597
654
  c.gsub!("\\", %q{\\\\} * 4) # Escape \ -chars
598
655
  c.gsub!("'", "#{'\\' * 4}'") # Escape ' -chars
599
656
 
600
657
  eval_s.gsub!("<char>", "'#{c}'") if eval_s.class == String
601
- debug eval_s
602
- debug c
658
+ log eval_s
659
+ log c
603
660
  handle_key_bindigs_action(eval_s, c)
604
661
  set_state_to_root
662
+ else
663
+ # Multi-key sequence still in progress
664
+ emit(:key_pending, get_state_trail_str[0])
605
665
  end
606
666
  end
607
667
 
@@ -628,17 +688,63 @@ class KeyBindingTree
628
688
  a = label
629
689
  proc = action[1]
630
690
  msg = action[2]
631
- reg_act(label, proc, msg)
691
+ @actions.register(label, Action.new(label, msg, proc))
632
692
  end
633
693
  key.each { |k| _bindkey(k, a, keywords: keywords) }
634
694
  end
635
695
 
636
- def unbindkey(key)
696
+ # Unbind one or more key definitions (split on "||").
697
+ #
698
+ # Normally each key addresses a single binding to remove, e.g.
699
+ # unbindkey "C , k"
700
+ #
701
+ # To tear down every binding under a node without listing each key, pass
702
+ # include_child_nodes: true (or address a bare mode with no chord, which has
703
+ # no leaf of its own to delete and so implies the same). Both of these clear
704
+ # all child bindings of the addressed node while leaving the node itself:
705
+ # unbindkey "dictation" # whole minor mode
706
+ # unbindkey "dictation", include_child_nodes: true
707
+ # unbindkey "C ,", include_child_nodes: true # every "C , x" chord
708
+ def unbindkey(key, include_child_nodes: false)
637
709
  if key.class != Array
638
710
  key = key.split("||")
639
711
  end
640
- #TODO: test
641
- key.each { |k| _bindkey(k.strip, :delete_state) }
712
+ key.each { |k|
713
+ k = k.strip
714
+ if include_child_nodes || k.split(/\s+/).size == 1
715
+ unbind_child_nodes(k)
716
+ else
717
+ _bindkey(k, :delete_state)
718
+ end
719
+ }
720
+ end
721
+
722
+ # Remove every child binding under the node addressed by `key`, leaving the
723
+ # node itself in place. No-op if the node doesn't exist.
724
+ def unbind_child_nodes(key)
725
+ tokens = key.strip.split(/\s+/)
726
+ node = find_state_by_path(tokens)
727
+ return if node.nil?
728
+ node.children.clear
729
+ # Drop the action->keydef map for a whole mode so menus/help stop listing
730
+ # its bindings (only meaningful when addressing a bare mode root).
731
+ @act_bindings.delete(tokens[0]) if tokens.size == 1 && @act_bindings.key?(tokens[0])
732
+ end
733
+
734
+ # Resolve the State addressed by a key path: the first token is a mode id (a
735
+ # direct child of @root), any remaining tokens are chord keys walked down from
736
+ # there. Accepts a string or a pre-split token array. Returns nil if unfound.
737
+ def find_state_by_path(key)
738
+ tokens = key.class == Array ? key.dup : key.strip.split(/\s+/)
739
+ mode_id = tokens.shift
740
+ node = @root.children.find { |s| s.key_name == mode_id }
741
+ tokens.each { |k|
742
+ return nil if node.nil?
743
+ m = /(.+)\((.*)\)/.match(k) # strip an (eval_rule) suffix, as binding does
744
+ key_name = m ? m[1] : k
745
+ node = node.children.find { |s| s.key_name == key_name }
746
+ }
747
+ node
642
748
  end
643
749
 
644
750
  def _bindkey(key, action, keywords: [])
@@ -650,17 +756,18 @@ class KeyBindingTree
650
756
  # return
651
757
  # end
652
758
  # $action_list << { :action => action, :key => key }
653
- if !vma.actions.include?(action)
759
+ if !@actions.include?(action)
654
760
  if action.class == String
655
- reg_act(action, proc { eval(action) }, action)
761
+ @actions.register(action, Action.new(action, action, proc { eval(action) }))
656
762
  end
657
763
  end
658
764
 
659
765
  m = key.match(/^(\S+)\s(\S.*)$/)
660
766
  # Match/split e.g. "VC , , s" to "VC" and ", , s"
767
+ modes = nil
661
768
  if m
662
769
  modetmp = m[1]
663
- debug [key, modetmp, m].inspect
770
+ log [key, modetmp, m].inspect
664
771
 
665
772
  # If all of first word are uppercase, e.g. in
666
773
  # "VCIX left" => "buf.move(BACKWARD_CHAR)",
@@ -673,12 +780,20 @@ class KeyBindingTree
673
780
  modes = [modetmp] if modetmp.match(/^\p{Ll}+$/) # Lowercase
674
781
  keydef = m[2]
675
782
  else
676
- fatal_error("Error in keydef #{key.inspect}")
783
+ @fatal_handler.call("Error in keydef #{key.inspect}")
784
+ end
785
+
786
+ # Mode part is neither all uppercase nor all lowercase, e.g. "Fexp , x"
787
+ if modes.nil?
788
+ error("bindkey: invalid mode #{modetmp.inspect} in #{key.inspect}: " \
789
+ "mode must be all uppercase (major modes, e.g. \"C\") or all " \
790
+ "lowercase (minor modes, e.g. \"fexp\"). Binding skipped.")
791
+ return
677
792
  end
678
793
 
679
794
  # puts "keywords #{keywords}"
680
795
  modes.each { |mode_id|
681
- mode_bind_key(mode_id, keydef, action, keywords: keywords)
796
+ next if !mode_bind_key(mode_id, keydef, action, keywords: keywords)
682
797
 
683
798
  # Map froma actions to keybindings (e.g. to show bindings in menu)
684
799
  @act_bindings[mode_id][action] = keydef
@@ -687,6 +802,7 @@ class KeyBindingTree
687
802
 
688
803
  # Binds a keyboard key combination to an action,
689
804
  # for a given keyboard mode like insert ("I") or command ("C")
805
+ # Returns true if the binding was created, false if the mode is unknown.
690
806
  def mode_bind_key(mode_id, keydef, action, keywords: [])
691
807
  # debug "mode_bind_key #{mode_id.inspect}, #{keydef.inspect}, #{action.inspect}", 2
692
808
  # Example:
@@ -694,7 +810,18 @@ class KeyBindingTree
694
810
  # mode_id = "C", keydef = ", f"
695
811
  # and action = :gui_file_finder
696
812
 
697
- set_state(mode_id, "") # TODO: check is ok?
813
+ # Bind only to a mode that exists. Without this check the binding would
814
+ # silently end up in the current default mode (see set_state), e.g. a
815
+ # 'bindkey "fexp , x"' in custom.rb (loaded before FileManager.init creates
816
+ # the fexp mode) would become "C , x" and fire in every buffer.
817
+ mode_state = @root.children.find { |s| s.key_name == mode_id }
818
+ if mode_state.nil?
819
+ error("bindkey: unknown mode #{mode_id.inspect} for #{keydef.inspect} => " \
820
+ "#{action.inspect}. Binding skipped. If the mode is created by a " \
821
+ "module, bind it in hook_custom_after_init.")
822
+ return false
823
+ end
824
+ @cur_state = mode_state
698
825
  start_state = @cur_state
699
826
 
700
827
  k_arr = keydef.split #e.g. definition: "C y e" = > ["C", "y", "e"]
@@ -742,26 +869,26 @@ class KeyBindingTree
742
869
  end
743
870
  @cur_state.keywords = keywords
744
871
  @cur_state = @root
872
+ return true
745
873
  end
746
874
 
747
875
  def handle_key_bindigs_action(action, c)
748
876
  trail_str = get_state_trail_str[0]
877
+ # Emitted before execution so key logs show the entry even if the action raises
878
+ emit(:key_action, trail_str, action)
749
879
  # $acth << action #TODO:needed here?
750
880
  @method_handles_repeat = false #TODO:??
751
881
  n = 1
752
882
  if @next_command_count and !(action.class == String and action.include?("set_next_command_count"))
753
883
  n = @next_command_count
754
- debug("COUNT command #{n} times")
884
+ log("COUNT command #{n} times")
755
885
  end
756
886
 
757
887
  begin
758
888
  n.times do
759
- ret = exec_action(action)
889
+ ret = @action_handler.call(action)
760
890
 
761
- if vma.macro.is_recording and ret != false
762
- debug "RECORD ACTION:#{action}", 2
763
- vma.macro.record_action(action)
764
- end
891
+ emit(:action_executed, action, ret)
765
892
  break if @method_handles_repeat
766
893
  # Some methods have specific implementation for repeat,
767
894
  # like '5yy' => copy next five lines. (copy_line())
@@ -769,43 +896,16 @@ class KeyBindingTree
769
896
  # like '20j' => go to next line 20 times.
770
897
  # But methods can also handle the number input themselves if vma.kbd.method_handles_repeat=true is set,
771
898
  end
772
- # run_as_idle proc { vma.buf.refresh_cursor; vma.buf.refresh_cursor }, delay: 0.05
773
- rescue SyntaxError
774
- message("SYNTAX ERROR with eval cmd #{action}: " + $!.to_s)
775
- # rescue NoMethodError
776
- # debug("NoMethodError with eval cmd #{action}: " + $!.to_s)
777
- # rescue NameError
778
- # debug("NameError with eval cmd #{action}: " + $!.to_s)
779
- # raise
780
899
  rescue Exception => e
781
- puts "BACKTRACE"
782
- puts e.backtrace
783
- puts e.inspect
784
- puts "BACKTRACE END"
785
- if $!.class == SystemExit
786
- exit
787
- else
788
- crash("Error with action: #{action}: ", e)
789
- end
900
+ raise if @on_action_error.nil?
901
+ @on_action_error.call(action, e)
790
902
  end
791
903
 
792
904
  if !(action.class == String and action.include?("set_next_command_count"))
793
905
  @next_command_count = nil
794
906
  end
795
907
 
796
- if cnf.kbd.show_prev_action? and trail_str.class == String
797
- len_limit = 35
798
- action_desc = "UNK"
799
- if action.class == String && (m = action.match(/\Abuf\.insert_txt\((.+)\)\z/))
800
- char_part = m[1].gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
801
- action_desc = "insert #{char_part}"
802
- else
803
- action_desc = vma.actions[action]&.method_name || action.to_s
804
- action_desc = action_desc[0..len_limit] if action_desc.size > len_limit
805
- end
806
- trail_str = trail_str.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
807
- vma.gui.action_trail_label.markup = "<span weight='bold'>#{action_desc}|#{trail_str}</span>"
808
- end
908
+ emit(:action_handled, trail_str, action)
809
909
  end
810
910
  end
811
911
 
@@ -813,8 +913,8 @@ def bindkey(key, action, keywords: "")
813
913
  vma.kbd.bindkey(key, action, keywords: keywords)
814
914
  end
815
915
 
816
- def unbindkey(key)
817
- vma.kbd.unbindkey(key)
916
+ def unbindkey(key, include_child_nodes: false)
917
+ vma.kbd.unbindkey(key, include_child_nodes: include_child_nodes)
818
918
  end
819
919
 
820
920
  def add_keys(keywords, to_add)
@@ -838,80 +938,6 @@ def exec_action(action)
838
938
  end
839
939
  end
840
940
 
841
- def show_free_key_bindings()
842
- kbd_s = "❙Free key binding slots❙\n"
843
- kbd_s << "\n⦁[Mode] <prefix> : <free keys>⦁\n"
844
- kbd_s << "[B]=Browse, [C]=Command, [I]=Insert, [V]=Visual\n"
845
- kbd_s << "Free = not yet bound under that prefix\n"
846
- kbd_s << "===============================================\n"
847
- kbd_s << vma.kbd.get_free_bindings
848
- kbd_s << "\n"
849
- b = create_new_buffer(kbd_s, "free-key-bindings")
850
- gui_set_file_lang(b.id, "hyperplaintext")
851
- end
852
-
853
- def show_key_bindings()
854
- kbd_s = "❙Key bindings❙\n"
855
- kbd_s << "\n⦁[Mode] <keys> : <action>⦁\n"
856
- done = []
857
-
858
- kbd_s << "[B]=Browse, [C]=Command, [I]=Insert, [V]=Visual\n"
859
- kbd_s << "<key>!: Press <key> once, release before pressing any other keys\n"
860
- kbd_s << "===============================================\n"
861
- kbd_s << "◼ Basic\n"
862
- kbd_s << "◼◼ Command mode\n"
863
-
864
- x = vma.kbd.get_by_keywords(modes: ["C"], keywords: ["intro"])
865
- done.concat(x.lines); kbd_s << x
866
-
867
- kbd_s << "\n"
868
- kbd_s << "◼◼ Insert mode\n"
869
- x = vma.kbd.get_by_keywords(modes: ["I"], keywords: ["intro"])
870
- done.concat(x.lines); kbd_s << x
871
- kbd_s << "\n"
872
- kbd_s << "◼◼ Visual mode\n"
873
- x = vma.kbd.get_by_keywords(modes: ["V"], keywords: ["intro"])
874
- done.concat(x.lines); kbd_s << x
875
- kbd_s << "\n"
876
-
877
- kbd_s << "◼ Hyper Plaintext\n"
878
- x = vma.kbd.get_by_keywords(modes: ["C"], keywords: ["hyperplaintext"])
879
- x2 = vma.kbd.get_by_keywords(modes: ["V"], keywords: ["hyperplaintext"])
880
- done.concat(x.lines); kbd_s << x << "\n" << x2
881
- kbd_s << "\n"
882
-
883
- kbd_s << "◼ Core\n"
884
- x = vma.kbd.get_by_keywords(modes: [], keywords: ["core"])
885
- x << vma.kbd.get_by_keywords(modes: ["X"], keywords: ["intro"])
886
-
887
- done.concat(x.lines); kbd_s << x
888
- kbd_s << "\n"
889
-
890
- kbd_s << "◼ Debug / Experimental\n"
891
- x = vma.kbd.get_by_keywords(modes: [], keywords: ["experimental"])
892
- done.concat(x.lines); kbd_s << x
893
- kbd_s << "\n"
894
-
895
- kbd_s << "◼ Others\n"
896
- # x = vma.kbd.get_by_keywords(modes: [], keywords:["experimental"])
897
- # x = vma.kbd.to_s
898
- x = vma.kbd.get_by_keywords(modes: [], keywords: [])
899
- done << x.lines - done
900
- kbd_s << (x.lines - done).join
901
- kbd_s << "\n"
902
-
903
- kbd_s << "===============================================\n"
904
- # x = vma.kbd.to_s
905
- # # require "pry"; binding.pry
906
- # done << x.lines - done
907
- # kbd_s << (x.lines - done).join
908
- # kbd_s << "\n"
909
- # kbd_s << "===============================================\n"
910
- b = create_new_buffer(kbd_s, "key-bindings")
911
- gui_set_file_lang(b.id, "hyperplaintext")
912
- #
913
- end
914
-
915
941
  # Try to clear modifiers when program loses focus
916
942
  # e.g. after alt-tab
917
943
  # TODO
@@ -923,3 +949,4 @@ end
923
949
  # def handle_key_event(event)
924
950
  # vma.kbd.handle_key_event(event)
925
951
  # end
952
+ end # module Vimamsa