kward 0.85.0 → 0.86.0

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 (151) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +130 -0
  3. data/CONTRIBUTING.md +1 -1
  4. data/Gemfile.lock +6 -2
  5. data/README.md +3 -3
  6. data/Rakefile +3 -0
  7. data/doc/agent-tools.md +11 -0
  8. data/doc/api.md +4 -1
  9. data/doc/composer.md +4 -3
  10. data/doc/configuration.md +60 -11
  11. data/doc/extensibility.md +2 -0
  12. data/doc/getting-started.md +3 -3
  13. data/doc/git.md +1 -1
  14. data/doc/memory.md +1 -1
  15. data/doc/plugins.md +40 -5
  16. data/doc/providers.md +10 -4
  17. data/doc/rpc.md +125 -7
  18. data/doc/session-management.md +36 -1
  19. data/doc/shell.md +643 -27
  20. data/doc/tabs.md +2 -1
  21. data/doc/troubleshooting.md +1 -1
  22. data/doc/usage.md +21 -11
  23. data/examples/plugins/openrouter_proxy/README.md +103 -0
  24. data/examples/plugins/openrouter_proxy/fake_embeddings.rb +85 -0
  25. data/examples/plugins/openrouter_proxy/plugin.rb +7 -0
  26. data/examples/plugins/openrouter_proxy/protocol.rb +202 -0
  27. data/examples/plugins/openrouter_proxy/server.rb +186 -0
  28. data/examples/plugins/space_invaders.rb +0 -1
  29. data/exe/kward +2 -2
  30. data/exe/kwsh +7 -0
  31. data/kward.gemspec +3 -1
  32. data/lib/kward/agent.rb +43 -9
  33. data/lib/kward/cli/commands.rb +41 -11
  34. data/lib/kward/cli/interactive_turn.rb +10 -0
  35. data/lib/kward/cli/plugins.rb +5 -1
  36. data/lib/kward/cli/prompt_interface.rb +4 -1
  37. data/lib/kward/cli/rendering.rb +21 -28
  38. data/lib/kward/cli/runtime_helpers.rb +52 -34
  39. data/lib/kward/cli/settings/model.rb +1 -12
  40. data/lib/kward/cli/tabs.rb +91 -18
  41. data/lib/kward/cli/tool_summaries.rb +2 -0
  42. data/lib/kward/cli/transcript_formatter.rb +3 -10
  43. data/lib/kward/cli/worktrees.rb +1 -0
  44. data/lib/kward/cli.rb +56 -7
  45. data/lib/kward/config/core.rb +16 -5
  46. data/lib/kward/config/extensions.rb +3 -0
  47. data/lib/kward/config/paths.rb +11 -0
  48. data/lib/kward/config/settings.rb +7 -0
  49. data/lib/kward/conversation.rb +11 -1
  50. data/lib/kward/entrypoint.rb +14 -0
  51. data/lib/kward/events.rb +2 -0
  52. data/lib/kward/generated_images.rb +237 -0
  53. data/lib/kward/model/catalog.rb +6 -3
  54. data/lib/kward/model/client.rb +105 -36
  55. data/lib/kward/model/codex_images.rb +83 -0
  56. data/lib/kward/model/copilot_models.rb +8 -4
  57. data/lib/kward/model/model_info.rb +27 -9
  58. data/lib/kward/model/openrouter_model_cache.rb +4 -2
  59. data/lib/kward/model/payloads.rb +6 -5
  60. data/lib/kward/model/sources.rb +3 -1
  61. data/lib/kward/model/stream_parser.rb +4 -7
  62. data/lib/kward/pan/index.html.erb +8 -1
  63. data/lib/kward/pan/server.rb +13 -1
  64. data/lib/kward/plugins/codex_responses.rb +73 -0
  65. data/lib/kward/plugins/host.rb +16 -0
  66. data/lib/kward/plugins/http_server.rb +83 -0
  67. data/lib/kward/plugins/registry.rb +39 -0
  68. data/lib/kward/prompt_interface/composer_controller.rb +0 -1
  69. data/lib/kward/prompt_interface/composer_renderer.rb +159 -72
  70. data/lib/kward/prompt_interface/editor/controller.rb +1 -1
  71. data/lib/kward/prompt_interface/editor/renderer.rb +10 -7
  72. data/lib/kward/prompt_interface/file_overlay.rb +3 -3
  73. data/lib/kward/prompt_interface/generated_image_preview.rb +162 -0
  74. data/lib/kward/prompt_interface/git_prompt.rb +18 -11
  75. data/lib/kward/prompt_interface/interactive/renderer.rb +1 -1
  76. data/lib/kward/prompt_interface/interactive/state.rb +18 -20
  77. data/lib/kward/prompt_interface/key_handler.rb +108 -25
  78. data/lib/kward/prompt_interface/layout.rb +11 -1
  79. data/lib/kward/prompt_interface/overlay_renderer.rb +25 -8
  80. data/lib/kward/prompt_interface/project_browser.rb +27 -54
  81. data/lib/kward/prompt_interface/prompt_renderer.rb +27 -35
  82. data/lib/kward/prompt_interface/question_prompt.rb +19 -28
  83. data/lib/kward/prompt_interface/runtime_state.rb +31 -9
  84. data/lib/kward/prompt_interface/screen.rb +24 -21
  85. data/lib/kward/prompt_interface/selection_prompt.rb +8 -8
  86. data/lib/kward/prompt_interface/slash_overlay.rb +1 -1
  87. data/lib/kward/prompt_interface/transcript_renderer.rb +7 -6
  88. data/lib/kward/prompt_interface.rb +109 -39
  89. data/lib/kward/prompts.rb +7 -1
  90. data/lib/kward/pty/adaptive_output_sink.rb +38 -4
  91. data/lib/kward/pty/interactive_runner.rb +20 -28
  92. data/lib/kward/pty/transcript_normalizer.rb +65 -21
  93. data/lib/kward/rpc/config_manager.rb +3 -0
  94. data/lib/kward/rpc/server.rb +27 -5
  95. data/lib/kward/rpc/session_manager.rb +62 -17
  96. data/lib/kward/rpc/transcript_normalizer.rb +11 -7
  97. data/lib/kward/sessions/store.rb +30 -3
  98. data/lib/kward/shell/kwsh.rb +27 -7
  99. data/lib/kward/shell/kwshrc.rb +11 -2
  100. data/lib/kward/shell/native_arithmetic.rb +255 -0
  101. data/lib/kward/shell/native_arrays.rb +102 -0
  102. data/lib/kward/shell/native_braces.rb +96 -0
  103. data/lib/kward/shell/native_builtins.rb +476 -0
  104. data/lib/kward/shell/native_completion.rb +169 -0
  105. data/lib/kward/shell/native_condition.rb +75 -0
  106. data/lib/kward/shell/native_directory.rb +116 -0
  107. data/lib/kward/shell/native_exec_state.rb +73 -0
  108. data/lib/kward/shell/native_expansion.rb +252 -0
  109. data/lib/kward/shell/native_fields.rb +62 -0
  110. data/lib/kward/shell/native_glob.rb +96 -0
  111. data/lib/kward/shell/native_history.rb +242 -0
  112. data/lib/kward/shell/native_interactive.rb +164 -0
  113. data/lib/kward/shell/native_invocation.rb +42 -0
  114. data/lib/kward/shell/native_jobs.rb +250 -0
  115. data/lib/kward/shell/native_line_editor.rb +382 -0
  116. data/lib/kward/shell/native_line_terminal.rb +286 -0
  117. data/lib/kward/shell/native_locale.rb +109 -0
  118. data/lib/kward/shell/native_locals.rb +57 -0
  119. data/lib/kward/shell/native_pattern.rb +200 -0
  120. data/lib/kward/shell/native_process.rb +279 -0
  121. data/lib/kward/shell/native_program.rb +40 -0
  122. data/lib/kward/shell/native_programmable_completion.rb +115 -0
  123. data/lib/kward/shell/native_prompt_format.rb +89 -0
  124. data/lib/kward/shell/native_runtime.rb +964 -0
  125. data/lib/kward/shell/native_substitution.rb +110 -0
  126. data/lib/kward/shell/native_syntax.rb +946 -0
  127. data/lib/kward/shell/native_traps.rb +196 -0
  128. data/lib/kward/shell/native_vi.rb +407 -0
  129. data/lib/kward/shell/native_vi_terminal.rb +19 -0
  130. data/lib/kward/shell/native_worker.rb +82 -0
  131. data/lib/kward/shell/persistent_session.rb +184 -190
  132. data/lib/kward/shell/prompt.rb +14 -0
  133. data/lib/kward/shell/prompt_agent.rb +17 -0
  134. data/lib/kward/shell/script_runner.rb +244 -0
  135. data/lib/kward/shell/standalone_agent.rb +31 -0
  136. data/lib/kward/shell/standalone_link.rb +78 -0
  137. data/lib/kward/shell/standalone_terminal.rb +287 -0
  138. data/lib/kward/terminal/keys.rb +22 -1
  139. data/lib/kward/terminal/locale_text.rb +29 -0
  140. data/lib/kward/terminal/sequences.rb +45 -4
  141. data/lib/kward/tools/datetime.rb +85 -0
  142. data/lib/kward/tools/generate_image.rb +36 -0
  143. data/lib/kward/tools/registry.rb +35 -9
  144. data/lib/kward/tools/tool_call.rb +3 -1
  145. data/lib/kward/transcripts/markdown_transcript.rb +8 -0
  146. data/lib/kward/transcripts/turn_summary_formatter.rb +93 -0
  147. data/lib/kward/transport/gateway.rb +2 -1
  148. data/lib/kward/turn_summary.rb +68 -0
  149. data/lib/kward/version.rb +1 -1
  150. data/lib/main.rb +6 -3
  151. metadata +84 -1
@@ -0,0 +1,476 @@
1
+ module Kward
2
+ module NativeShell
3
+ # State-changing utilities execute in the interpreter, never in an external
4
+ # shell. Explicit eval and dot-sourcing use the same native parser.
5
+ module Builtins
6
+ private
7
+
8
+ SHELL_OPTIONS = { "a" => "allexport", "b" => "notify", "h" => "hashall", "v" => "verbose", "m" => "monitor", "e" => "errexit", "f" => "noglob", "n" => "noexec", "u" => "nounset", "x" => "xtrace", "C" => "noclobber" }.freeze
9
+
10
+ def builtin_flags(args, allowed, command)
11
+ flags = []
12
+ while args.first&.start_with?("-") && args.first != "-"
13
+ option = args.shift
14
+ break if option == "--"
15
+ option[1..].each_char do |flag|
16
+ raise ExecutionError, "#{command}: unsupported option -#{flag}" unless allowed.include?(flag)
17
+ flags << flag
18
+ end
19
+ end
20
+ flags
21
+ end
22
+
23
+ def times_builtin(args, streams)
24
+ builtin_flags(args, "", "times")
25
+ raise ExecutionError, "times: unexpected operand" unless args.empty?
26
+ usage = Process.times
27
+ [[usage.utime, usage.stime], [usage.cutime, usage.cstime]].each do |pair|
28
+ write_line(streams, pair.map { |seconds| format("%dm%.6fs", seconds.to_i / 60, seconds % 60) }.join(" "))
29
+ end
30
+ 0
31
+ end
32
+
33
+ def hash_builtin(args, streams)
34
+ flags = builtin_flags(args, "r", "hash")
35
+ @command_hash.clear if flags.include?("r")
36
+ if args.empty?
37
+ @command_hash.sort.each { |_, path| write_line(streams, path) } if flags.empty?
38
+ return 0
39
+ end
40
+ result = 0
41
+ args.each do |name|
42
+ next if self.class::BUILTINS.include?(name) || @functions.key?(name)
43
+ path = executable_path(name)
44
+ if path && File.file?(path) && File.executable?(path)
45
+ @command_hash[name] = path unless name.include?("/")
46
+ else
47
+ streams[2]&.puts("kwsh: hash: #{name}: not found")
48
+ result = 1
49
+ end
50
+ end
51
+ result
52
+ end
53
+
54
+ def remember_function_commands(tree)
55
+ return unless tree.is_a?(Node)
56
+ if tree.kind == :simple
57
+ word = tree.values.first.find { |item| !item.assignment }
58
+ name = word&.literal
59
+ if name && !self.class::BUILTINS.include?(name) && !@functions.key?(name)
60
+ path = executable_path(name)
61
+ @command_hash[name] = path if path && File.file?(path) && File.executable?(path)
62
+ end
63
+ end
64
+ tree.values.flatten.each { |child| remember_function_commands(child) if child.is_a?(Node) }
65
+ end
66
+
67
+ def persist_descriptors(redirected, streams)
68
+ redirected.each do |descriptor, io|
69
+ next if streams[descriptor].equal?(io)
70
+ copy = io&.dup
71
+ copy.sync = true if copy
72
+ @owned_descriptors << copy if copy
73
+ @persistent_descriptors[descriptor] = copy
74
+ streams[descriptor] = copy
75
+ @base_streams[descriptor] = copy if @base_streams
76
+ end
77
+ release_descriptors
78
+ end
79
+
80
+ def release_descriptors
81
+ retained = @persistent_descriptors.values + @active_streams.flat_map(&:values)
82
+ @owned_descriptors.delete_if do |io|
83
+ next false if retained.include?(io)
84
+ io.close unless io.closed?
85
+ true
86
+ end
87
+ end
88
+
89
+ def exec_builtin(args, streams)
90
+ raise ExecutionError, "exec: needs a user-driven terminal" if @shell_agent_command
91
+
92
+ clear = false
93
+ argv0 = nil
94
+ login = false
95
+ while args.first&.start_with?("-")
96
+ option = args.shift
97
+ break if option == "--"
98
+ case option
99
+ when "-c" then clear = true
100
+ when "-l" then login = true
101
+ when "-a"
102
+ argv0 = args.shift || raise(ExecutionError, "exec: -a requires a name")
103
+ else raise ExecutionError, "exec: unsupported option #{option}"
104
+ end
105
+ end
106
+ if args.empty?
107
+ persist_descriptors(streams, @streams)
108
+ NativeProcess.redirect_standard_streams(@persistent_descriptors) if @replace_process
109
+ return 0
110
+ end
111
+ recover = @replace_process && interactive_scope?
112
+ persist_descriptors(streams, @streams) if recover
113
+ executable = executable_path(args.first)
114
+ unless executable
115
+ streams[2]&.puts("kwsh: #{args.first}: command not found")
116
+ if recover
117
+ NativeProcess.redirect_standard_streams(@persistent_descriptors)
118
+ raise Flow.new(:abort, 127)
119
+ end
120
+ raise Flow.new(:exit, 127) unless interactive_scope?
121
+ return 127
122
+ end
123
+ arguments = args.dup
124
+ arguments[0] = argv0 || arguments[0]
125
+ arguments[0] = "-#{arguments[0]}" if login
126
+ env = clear ? {} : environment
127
+ NativeProcess.validate(arguments, env)
128
+ if @replace_process
129
+ @history&.commit_pending
130
+ result = NativeProcess.replace(executable, arguments, env, cwd: @directory, streams: streams, mask: @umask, signals: child_signal_dispositions, recover: recover)
131
+ NativeProcess.redirect_standard_streams(@persistent_descriptors) if recover
132
+ raise Flow.new(recover ? :abort : :exit, result)
133
+ else
134
+ pid = NativeProcess.spawn(executable, arguments, env, cwd: @directory, streams: streams, mask: @umask, hosted: @hosted, signals: child_signal_dispositions)
135
+ result = wait(pid)
136
+ pid = nil
137
+ # The protocol worker must return its final state before exiting.
138
+ @traps.delete("EXIT")
139
+ raise Flow.new(:exit, result)
140
+ end
141
+ rescue Interrupt
142
+ @traps.delete("EXIT")
143
+ raise Flow.new(:exit, 130)
144
+ ensure
145
+ terminate(pid) if pid
146
+ end
147
+
148
+ def set_options(args, streams)
149
+ if args.empty?
150
+ @variables.sort.each { |name, value| write_line(streams, "#{name}=#{Shellwords.escape(value)}") }
151
+ return 0
152
+ end
153
+ until args.empty?
154
+ option = args.shift
155
+ if option == "-"
156
+ @options.subtract(%w[verbose xtrace])
157
+ @arguments = args unless args.empty?
158
+ return 0
159
+ end
160
+ if option == "--"
161
+ @arguments = args
162
+ return 0
163
+ end
164
+ unless option.start_with?("-", "+") && option.length > 1
165
+ @arguments = [option] + args
166
+ return 0
167
+ end
168
+ enabled = option.start_with?("-")
169
+ flags = option[1..].chars
170
+ flags.each do |flag|
171
+ name = if flag == "o"
172
+ if args.empty?
173
+ (SHELL_OPTIONS.values + %w[pipefail ignoreeof nolog vi]).each do |entry|
174
+ write_line(streams, "set #{@options.include?(entry) ? '-' : '+'}o #{entry}")
175
+ end
176
+ next
177
+ end
178
+ args.shift
179
+ else
180
+ SHELL_OPTIONS[flag]
181
+ end
182
+ raise ExecutionError, "set: unsupported option #{name || flag}" unless (SHELL_OPTIONS.values + %w[pipefail ignoreeof nolog vi]).include?(name)
183
+ raise ExecutionError, "set: native vi editing is standalone-only" if name == "vi" && enabled && @hosted
184
+ raise ExecutionError, "set: vi editing requires an ANSI-compatible terminal" if name == "vi" && enabled && @interactive && @variables["TERM"] == "dumb"
185
+ enabled ? @options.add(name) : @options.delete(name)
186
+ end
187
+ end
188
+ 0
189
+ end
190
+
191
+ RESOURCE_LIMITS = {
192
+ "c" => [:CORE, 512, "core file size (512 bytes)"],
193
+ "d" => [:DATA, 1024, "data segment size (1024 bytes)"],
194
+ "f" => [:FSIZE, 512, "file size (512 bytes)"],
195
+ "n" => [:NOFILE, 1, "open file descriptors"],
196
+ "s" => [:STACK, 1024, "stack size (1024 bytes)"],
197
+ "t" => [:CPU, 1, "CPU time (seconds)"],
198
+ "v" => [:AS, 1024, "address space size (1024 bytes)"]
199
+ }.transform_values(&:freeze).freeze
200
+
201
+ def ulimit_builtin(args, streams)
202
+ flags = builtin_flags(args, "HSacdfnstv", "ulimit")
203
+ selected = flags & RESOURCE_LIMITS.keys
204
+ all = flags.include?("a")
205
+ if (flags.include?("H") && flags.include?("S")) || selected.length > 1 ||
206
+ (all && (!selected.empty? || !args.empty?)) || args.length > 1
207
+ raise ExecutionError, "ulimit: incompatible options or operands"
208
+ end
209
+ selected = all ? RESOURCE_LIMITS.keys : [selected.first || "f"]
210
+ if args.empty?
211
+ selected.each do |flag|
212
+ resource, unit, label = RESOURCE_LIMITS.fetch(flag)
213
+ value = Process.getrlimit(resource)[flags.include?("H") ? 1 : 0]
214
+ text = value == Process::RLIM_INFINITY ? "unlimited" : (value / unit).to_s
215
+ write_line(streams, all ? "#{label} (-#{flag}) #{text}" : text)
216
+ end
217
+ else
218
+ # Never lower an embedding application's process-wide hard limit.
219
+ # Forked shell environments own their process even when their parent
220
+ # runtime was embedded. Dedicated entrypoints opt in explicitly.
221
+ unless @process_owned || Process.pid != @shell_pid
222
+ raise ExecutionError, "ulimit: setting limits requires an owned shell process"
223
+ end
224
+ resource, unit = RESOURCE_LIMITS.fetch(selected.first)
225
+ operand = args.first
226
+ value = if operand == "unlimited"
227
+ Process::RLIM_INFINITY
228
+ elsif operand.match?(/\A\+?[0-9]+\z/)
229
+ Integer(operand, 10) * unit
230
+ else
231
+ raise ExecutionError, "ulimit: invalid limit"
232
+ end
233
+ soft, hard = Process.getrlimit(resource)
234
+ soft = value unless flags.include?("H")
235
+ hard = value unless flags.include?("S")
236
+ Process.setrlimit(resource, soft, hard)
237
+ end
238
+ 0
239
+ rescue SystemCallError, ArgumentError, RangeError, NotImplementedError => e
240
+ raise ExecutionError, "ulimit: #{e.message}"
241
+ end
242
+
243
+ def umask_builtin(args, streams)
244
+ flags = builtin_flags(args, "S", "umask")
245
+ if args.empty?
246
+ text = unless flags.include?("S")
247
+ format("%04o", @umask)
248
+ else
249
+ %w[u g o].each_with_index.map do |who, index|
250
+ bits = (7 & ~(@umask >> (6 - index * 3)))
251
+ permissions = [[4, "r"], [2, "w"], [1, "x"]].filter_map { |bit, letter| letter if bits & bit != 0 }.join
252
+ "#{who}=#{permissions}"
253
+ end.join(",")
254
+ end
255
+ write_line(streams, text)
256
+ return 0
257
+ end
258
+ raise ExecutionError, "umask: expected one mask" unless args.length == 1
259
+ value = args.first
260
+ if value.match?(/\A[0-7]+\z/) && value.to_i(8) <= 0o777
261
+ @umask = value.to_i(8)
262
+ return 0
263
+ end
264
+ allowed = 0o777 & ~@umask
265
+ executable = allowed & 0o111 != 0
266
+ shifts = { "u" => 6, "g" => 3, "o" => 0 }
267
+ value.split(",", -1).each do |clause|
268
+ match = clause.match(/\A([ugoa]*)((?:[+=-](?:[ugo]|[rwxXst]*))+)\z/)
269
+ raise ExecutionError, "umask: invalid symbolic mask" unless match
270
+ who, actions = match.captures
271
+ who = "ugo" if who.empty? || who.include?("a")
272
+ actions.scan(/([+=-])([ugo]|[rwxXst]*)/).each do |operator, permissions|
273
+ bits = if shifts.key?(permissions)
274
+ (allowed >> shifts.fetch(permissions)) & 7
275
+ else
276
+ # Non-permission s/t bits do not affect the creation mask.
277
+ permissions.chars.reduce(0) { |mask, letter| mask | { "r" => 4, "w" => 2, "x" => 1, "X" => executable ? 1 : 0 }.fetch(letter, 0) }
278
+ end
279
+ who.chars.uniq.each do |group|
280
+ shift = shifts.fetch(group)
281
+ allowed &= ~(7 << shift) if operator == "="
282
+ allowed = operator == "-" ? allowed & ~(bits << shift) : allowed | (bits << shift)
283
+ end
284
+ end
285
+ end
286
+ @umask = 0o777 & ~allowed
287
+ 0
288
+ end
289
+
290
+ def source_script(utility, args, streams)
291
+ raise ExecutionError, "#{utility}: expected a file" if args.empty?
292
+ raise ExecutionError, "source nesting exceeds 100 levels" if @source_depth >= 100
293
+ name = args.first
294
+ input = open_source_file(name)
295
+ raise ExecutionError, "#{utility}: file not found: #{name}" unless input
296
+ previous = @arguments
297
+ @arguments = args.drop(1) if args.length > 1
298
+ @source_depth += 1
299
+ begin
300
+ evaluate_program(input, streams)
301
+ rescue Flow => flow
302
+ raise unless flow.kind == :return
303
+ flow.status
304
+ ensure
305
+ input.close
306
+ @source_depth -= 1
307
+ @arguments = previous
308
+ end
309
+ end
310
+
311
+ def open_source_file(name)
312
+ return @directory.open_file(name) if name.include?("/")
313
+
314
+ @variables.fetch("PATH", "/usr/bin:/bin").split(":", -1).each do |directory|
315
+ candidate = @directory.resolve(File.join(directory.empty? ? "." : directory, name))
316
+ next unless File.file?(candidate)
317
+ begin
318
+ return @directory.open_file(candidate)
319
+ rescue Errno::EACCES, Errno::ENOENT, Errno::ENOTDIR, Errno::ELOOP
320
+ next
321
+ end
322
+ end
323
+ nil
324
+ end
325
+
326
+ def readonly(args, streams)
327
+ flags = builtin_flags(args, "p", "readonly")
328
+ if args.empty? || flags.include?("p")
329
+ @readonly.sort.each do |name|
330
+ value = @variables.key?(name) ? "=#{Shellwords.escape(parameter(name))}" : ""
331
+ write_line(streams, "readonly #{name}#{value}")
332
+ end
333
+ else
334
+ args.each do |argument|
335
+ name, value = argument.split("=", 2)
336
+ validate_name(name)
337
+ assign(name, value) if value
338
+ @readonly.add(name)
339
+ end
340
+ end
341
+ 0
342
+ end
343
+
344
+ def shopt(args, streams)
345
+ mode = args.first&.start_with?("-") ? args.shift : nil
346
+ raise ExecutionError, "shopt: supported options are -s, -u, and -q" unless [nil, "-s", "-u", "-q"].include?(mode)
347
+ raise ExecutionError, "shopt: only globstar is currently supported" unless args.empty? || args == ["globstar"]
348
+ case mode
349
+ when "-s" then @globstar = true
350
+ when "-u" then @globstar = false
351
+ when "-q" then return @globstar ? 0 : 1
352
+ else write_line(streams, "globstar\t#{@globstar ? 'on' : 'off'}")
353
+ end
354
+ 0
355
+ end
356
+
357
+ def command_builtin(args, streams)
358
+ flags = builtin_flags(args, "vVp", "command")
359
+ mode = flags.reverse.find { |flag| %w[v V].include?(flag) }
360
+ old_path = @variables["PATH"]
361
+ saved_hash, saved_hash_path = @command_hash.dup, @hash_path
362
+ @variables["PATH"] = Etc.confstr(Etc::CS_PATH) || "/usr/bin:/bin" if flags.include?("p")
363
+ return 0 if args.empty?
364
+ return describe_commands(args, streams, mode) if mode
365
+ dispatch(args, streams, functions: false)
366
+ ensure
367
+ if flags&.include?("p")
368
+ old_path ? @variables["PATH"] = old_path : @variables.delete("PATH")
369
+ @command_hash, @hash_path = saved_hash, saved_hash_path
370
+ end
371
+ end
372
+
373
+ def which_builtin(args, streams)
374
+ # Preserve the platform utility's options (for example, macOS -a and -s).
375
+ return external(["which", *args], streams) if args.empty? || (args.first.match?(/\A-.+/) && args.first != "--")
376
+
377
+ args.shift if args.first == "--"
378
+ return 1 if args.empty?
379
+
380
+ describe_commands(args, streams, "which")
381
+ end
382
+
383
+ def describe_commands(names, streams, mode)
384
+ result = 0
385
+ names.each do |name|
386
+ if @aliases.key?(name)
387
+ replacement = @aliases.fetch(name)
388
+ text = mode == "which" ? "#{name}: aliased to #{replacement}" : "alias #{name}=#{Shellwords.escape(replacement)}"
389
+ write_line(streams, text)
390
+ next
391
+ end
392
+
393
+ kind = if Parser::RESERVED.include?(name)
394
+ "keyword"
395
+ elsif self.class::SPECIAL.include?(name)
396
+ "shell builtin"
397
+ elsif @functions.key?(name)
398
+ "function"
399
+ elsif self.class::BUILTINS.include?(name)
400
+ "shell builtin"
401
+ end
402
+ path = kind ? name : executable_path(name)
403
+ if path && (kind || File.file?(path) && File.executable?(path))
404
+ text = case mode
405
+ when "V" then "#{name} is #{kind || path}"
406
+ when "which" then kind ? "#{name}: #{kind}" : path
407
+ else path
408
+ end
409
+ write_line(streams, text)
410
+ else
411
+ result = 1
412
+ end
413
+ end
414
+ result
415
+ end
416
+
417
+ def getopts(args, streams)
418
+ @getopts_running = true
419
+ raise ExecutionError, "getopts: expected optstring and variable" if args.length < 2
420
+ spec, name, *explicit = args
421
+ validate_name(name)
422
+ arguments = args.length > 2 ? explicit : @arguments
423
+ index = Integer(@variables.fetch("OPTIND", "1"), 10)
424
+ index = 1 if index < 1
425
+ @getopts_offset = 1 if index != @getopts_index
426
+ @getopts_offset ||= 1
427
+ argument = arguments[index - 1]
428
+ if !argument || !argument.start_with?("-") || argument == "-" || argument == "--"
429
+ index += 1 if argument == "--"
430
+ assign("OPTIND", index.to_s)
431
+ assign(name, "?")
432
+ @variables.delete("OPTARG")
433
+ @getopts_index = index
434
+ @getopts_offset = 1
435
+ return 1
436
+ end
437
+ option = argument[@getopts_offset]
438
+ @getopts_offset += 1
439
+ position = spec.delete_prefix(":").index(option)
440
+ silent = spec.start_with?(":")
441
+ @variables.delete("OPTARG")
442
+ if position.nil? || option == ":"
443
+ assign(name, "?")
444
+ assign("OPTARG", option) if silent
445
+ streams[2]&.puts("#{@name}: getopts: illegal option -- #{option}") unless silent
446
+ else
447
+ assign(name, option)
448
+ if spec.delete_prefix(":")[position + 1] == ":"
449
+ value = argument[@getopts_offset..]
450
+ if value.empty?
451
+ value = arguments[index]
452
+ index += 1 if value
453
+ end
454
+ if value
455
+ assign("OPTARG", value)
456
+ else
457
+ assign(name, silent ? ":" : "?")
458
+ assign("OPTARG", option) if silent
459
+ streams[2]&.puts("#{@name}: getopts: option requires an argument -- #{option}") unless silent
460
+ end
461
+ @getopts_offset = argument.length
462
+ end
463
+ end
464
+ if @getopts_offset >= argument.length
465
+ index += 1
466
+ @getopts_offset = 1
467
+ end
468
+ @getopts_index = index
469
+ assign("OPTIND", index.to_s)
470
+ 0
471
+ ensure
472
+ @getopts_running = false
473
+ end
474
+ end
475
+ end
476
+ end
@@ -0,0 +1,169 @@
1
+ require_relative "native_syntax"
2
+
3
+ module Kward
4
+ module NativeShell
5
+ # Complete literal words without expanding the draft or executing shell code.
6
+ class Completion
7
+ Result = Struct.new(:range, :replacement, :candidates, :choices, :choice_range, keyword_init: true)
8
+ COMMAND_BOUNDARIES = %w[; && || | & ( ) { } ;; ;&].freeze
9
+ COMMAND_PREFIXES = %w[! if then elif else while until do].freeze
10
+ REDIRECTIONS = %w[< > << <<- >> <> >| <& >&].freeze
11
+
12
+ def initialize(directory:, variables:, commands:)
13
+ @directory, @variables, @commands = directory, variables, commands
14
+ end
15
+
16
+ def complete(input, cursor, &programmed)
17
+ source = input[0...cursor]
18
+ tokens = lex(source)
19
+ current = tokens.pop if tokens.last&.value.is_a?(Word) && tokens.last.finish >= cursor
20
+ start = current ? current.start : cursor
21
+ raw = source[start..]
22
+ prefix = literal_text(current) if current
23
+ return if current && !prefix
24
+ return unless current || source[tokens.last&.finish || 0..].match?(/\A[ \t\r]*\z/)
25
+
26
+ prefix ||= ""
27
+ words, redirect = command_context(tokens)
28
+ command = words.first || ("" unless words.empty?)
29
+ command_position = command.nil? && !redirect
30
+ tilde = raw.start_with?("~/")
31
+ names = programmed.call(words + [prefix]) if programmed && words.first && !redirect && words.none?(&:nil?)
32
+ if names
33
+ names = names.select { |name| candidate?(name, prefix) }.uniq.sort
34
+ tilde = false
35
+ elsif command_position && !prefix.include?("/")
36
+ names = command_candidates(prefix)
37
+ else
38
+ names = path_candidates(prefix, tilde: tilde, directories_only: command == "cd" && !redirect, executable: command_position)
39
+ end
40
+ return if names.empty?
41
+
42
+ match = names.one? ? names.first : common_prefix(names)
43
+ finish = word_end(input, current, cursor)
44
+ format = ->(name) { candidate_text(name, tilde: tilde, command: command_position && !prefix.include?("/")) }
45
+ choices = names.map do |name|
46
+ text = format.call(name)
47
+ text += " " if finish == input.length && !name.end_with?("/")
48
+ text
49
+ end
50
+ extend_word = names.one? || match.length > prefix.length
51
+ Result.new(range: start...(extend_word ? finish : cursor),
52
+ replacement: names.one? ? choices.first : (extend_word ? format.call(match) : raw),
53
+ candidates: names, choices: choices, choice_range: start...finish)
54
+ rescue SyntaxError, ArgumentError, EncodingError, SystemCallError
55
+ nil
56
+ end
57
+
58
+ private
59
+
60
+ def lex(source)
61
+ Lexer.new(source, eof: false).tokens
62
+ rescue IncompleteInput => e
63
+ # The cursor is often inside a quoted filename. Close the quote for
64
+ # tokenization only; other incomplete syntax is not evaluated or repaired.
65
+ quote = if e.message.end_with?("unclosed single quote")
66
+ "'"
67
+ elsif e.message.end_with?("unclosed double quote")
68
+ '"'
69
+ else
70
+ raise
71
+ end
72
+ Lexer.new(source + quote, eof: false).tokens
73
+ end
74
+
75
+ def word_end(input, current, cursor)
76
+ return cursor unless current && cursor < input.length
77
+
78
+ word = Lexer.new(input[current.start..], eof: false).next_token
79
+ current.start + word.finish
80
+ end
81
+
82
+ def literal_text(token)
83
+ return unless token.value.parts.all? { |part| part.kind == :literal }
84
+
85
+ token.value.parts.map(&:text).join
86
+ end
87
+
88
+ def command_context(tokens)
89
+ words = []
90
+ redirect = false
91
+ tokens.each do |token|
92
+ value = token.value
93
+ if COMMAND_BOUNDARIES.include?(value)
94
+ words.clear
95
+ redirect = false
96
+ elsif REDIRECTIONS.include?(value) || (value.is_a?(Array) && value.first == :redirect)
97
+ redirect = true
98
+ elsif value.is_a?(Word)
99
+ if redirect
100
+ redirect = false
101
+ elsif !words.empty? || !value.assignment && !COMMAND_PREFIXES.include?(value.literal)
102
+ words << literal_text(token)
103
+ end
104
+ end
105
+ end
106
+ [words, redirect]
107
+ end
108
+
109
+ def command_candidates(prefix)
110
+ return [] if prefix.empty?
111
+
112
+ names = @commands.select { |name| candidate?(name, prefix) }
113
+ @variables.fetch("PATH", "/usr/bin:/bin").split(File::PATH_SEPARATOR, -1).each do |entry|
114
+ directory = @directory.resolve(entry.empty? ? "." : entry)
115
+ Dir.each_child(directory, encoding: prefix.encoding) do |name|
116
+ next unless candidate?(name, prefix)
117
+
118
+ file = File.join(directory, name)
119
+ names << name if File.file?(file) && File.executable?(file)
120
+ end
121
+ rescue SystemCallError
122
+ next
123
+ end
124
+ names.uniq.sort
125
+ end
126
+
127
+ def path_candidates(prefix, tilde:, directories_only:, executable:)
128
+ dir, slash, basename = prefix.rpartition("/")
129
+ spelling = dir + slash
130
+ path = if tilde
131
+ return [] if @variables["HOME"].to_s.empty?
132
+
133
+ File.join(@variables["HOME"], spelling.delete_prefix("~/"))
134
+ else
135
+ spelling.empty? ? "." : spelling
136
+ end
137
+ directory = @directory.resolve(path)
138
+ Dir.each_child(directory, encoding: prefix.encoding).filter_map do |name|
139
+ next unless candidate?(name, basename)
140
+ next if name.start_with?(".") && !basename.start_with?(".")
141
+
142
+ file = File.join(directory, name)
143
+ if File.directory?(file)
144
+ "#{spelling}#{name}/"
145
+ elsif !directories_only && (!executable || (File.file?(file) && File.executable?(file)))
146
+ "#{spelling}#{name}"
147
+ end
148
+ end.sort
149
+ end
150
+
151
+ def candidate?(name, prefix)
152
+ name.valid_encoding? && name.start_with?(prefix) && !name.match?(/[[:cntrl:]]/)
153
+ end
154
+
155
+ def candidate_text(match, tilde:, command:)
156
+ return "~/#{Shellwords.escape(match.delete_prefix('~/'))}" if tilde && match != "~/"
157
+ return match if tilde || (command && match.match?(/\A[A-Za-z0-9_!%,@-]+\z/))
158
+
159
+ Shellwords.escape(match)
160
+ end
161
+
162
+ def common_prefix(names)
163
+ prefix = names.first.dup
164
+ names.drop(1).each { |name| prefix.chop! until name.start_with?(prefix) }
165
+ prefix
166
+ end
167
+ end
168
+ end
169
+ end