1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
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
|
# SPDX-License-Identifier: GPL-3.0-or-later
# Copyright (C) 2025-2026 Benjamin Abendroth <braph93@gmx.de>
'''Module for option completion in Bash.'''
from . import cli
from . import algo
from . import utils
from . import bash_when
from . import bash_utils
from . import bash_patterns
from .str_utils import indent
class MasterCompletionFunctionBase:
'''Base class for generating master completion functions.'''
def __init__(self, options, abbreviations, generator):
self.options = options
self.abbreviations = abbreviations
self.generator = generator
self.complete = generator.complete_option
def get(self, funcname):
'''Get the function code.'''
raise NotImplementedError
def get_all_option_strings(self, option):
'''Return all possible option strings for option.'''
opts = option.get_short_option_strings()
opts += self.abbreviations.get_many_abbreviations(
option.get_long_option_strings())
opts += self.abbreviations.get_many_abbreviations(
option.get_old_option_strings())
return opts
class MasterCompletionFunction(MasterCompletionFunctionBase):
'''Class for generating a master completion function.'''
# pylint: disable=too-many-instance-attributes
# pylint: disable=too-few-public-methods
def __init__(self, options, abbreviations, generator):
super().__init__(options, abbreviations, generator)
self.optionals = False
self.code = []
optional_arg = list(filter(cli.Option.has_optional_arg, options))
required_arg = list(filter(cli.Option.has_required_arg, options))
self._add_options(required_arg)
if optional_arg:
self.optionals = True
self.code.append('[[ "$mode" == WITH_OPTIONAL ]] || return 1')
self._add_options(optional_arg)
def _add_options(self, options):
with_when, without_when = algo.partition(options, lambda o: o.when)
self._add_options_with_when(with_when)
self._add_options_without_when(without_when)
def _add_options_without_when(self, options_):
options_group_by_complete = algo.group_by(options_, self.complete)
if options_group_by_complete:
r = 'case "$opt" in\n'
for complete, options in options_group_by_complete.items():
opts = algo.flatten(map(self.get_all_option_strings, options))
r += ' %s)\n' % bash_patterns.make_pattern(opts)
if complete:
r += '%s\n' % indent(complete, 4)
r += ' return 0;;\n'
r += 'esac'
self.code.append(r)
def _add_options_with_when(self, options):
for option in options:
opts = self.get_all_option_strings(option)
completion_code = self.complete(option)
cond = bash_when.generate_when_conditions(
self.generator.commandline,
self.generator.variable_manager,
option.when)
r = 'case "$opt" in %s)\n' % bash_patterns.make_pattern(opts)
r += ' if %s; then\n' % cond
if completion_code:
r += '%s\n' % indent(completion_code, 4)
r += ' return 0\n'
r += ' fi;;\n'
r += 'esac'
self.code.append(r)
def get(self, funcname):
'''Get the function code.'''
if self.code:
r = '%s() {\n' % funcname
if self.optionals:
r += ' local opt="$1" cur="$2" mode="$3"\n\n'
else:
r += ' local opt="$1" cur="$2"\n\n'
r += '%s\n\n' % indent('\n\n'.join(self.code), 2)
r += ' return 1\n'
r += '}'
return r
return None
class MasterCompletionFunctionNoWhen(MasterCompletionFunctionBase):
'''Class for generating a master completion function.'''
def __init__(self, options, abbreviations, generator):
super().__init__(options, abbreviations, generator)
self.optionals = False
self.code = []
optional_arg = list(filter(cli.Option.has_optional_arg, options))
required_arg = list(filter(cli.Option.has_required_arg, options))
self._add_options(required_arg)
if optional_arg:
self.optionals = True
r = '(( ! ret )) && return 0\n'
r += '[[ "$mode" == WITH_OPTIONAL ]] || return 1\n'
r += 'ret=0'
self.code.append(r)
self._add_options(optional_arg)
@staticmethod
def accept(options):
'''Return True if none of the options have the when attribute set.'''
return not any(option.when for option in options)
def _add_options(self, options_):
options_group_by_complete = algo.group_by(options_, self.complete)
if options_group_by_complete:
r = 'case "$opt" in\n'
for complete, options in options_group_by_complete.items():
opts = algo.flatten(map(self.get_all_option_strings, options))
if complete:
r += ' %s)\n' % bash_patterns.make_pattern(opts)
r += '%s;;\n' % indent(complete, 4)
else:
r += ' %s);;\n' % bash_patterns.make_pattern(opts)
r += ' *) ret=1;;\n'
r += 'esac'
self.code.append(r)
def get(self, funcname):
'''Get the function code.'''
if self.code:
r = '%s() {\n' % funcname
if self.optionals:
r += ' local opt="$1" cur="$2" mode="$3" ret=0\n\n'
else:
r += ' local opt="$1" cur="$2" ret=0\n\n'
r += '%s\n\n' % indent('\n\n'.join(self.code), 2)
r += ' return $ret\n'
r += '}'
return r
return None
def _get_master_completion_obj(options, abbreviations, generator):
if MasterCompletionFunctionNoWhen.accept(options):
klass = MasterCompletionFunctionNoWhen
else:
klass = MasterCompletionFunction
return klass(options, abbreviations, generator)
class _Info:
# pylint: disable=too-many-instance-attributes
# pylint: disable=too-few-public-methods
def __init__(self, options, abbreviations, commandline, ctxt):
self.commandline = commandline
self.ctxt = ctxt
self.short_required = False # Short with required argument
self.short_optional = False # Short with optional argument
self.long_required = False # Long with required argument
self.long_optional = False # Long with optional argument
self.old_required = False # Old-Style with required argument
self.old_optional = False # Old-Style with optional argument
self._collect_options_info(options)
all_options = self.commandline.get_options(
with_parent_options=self.commandline.inherit_options)
old_option_strings = algo.flatten([o.get_old_option_strings() for o in all_options])
old_option_strings = abbreviations.get_many_abbreviations(old_option_strings)
self.old_option_strings = bash_utils.CasePatterns.for_old_without_arg(old_option_strings)
self.short_no_args = ''
self.short_required_args = ''
self.short_optional_args = ''
for option in all_options:
short_opts = ''.join(o.lstrip('-') for o in option.get_short_option_strings())
if option.has_required_arg():
self.short_required_args += short_opts
elif option.has_optional_arg():
self.short_optional_args += short_opts
elif option.complete is None:
self.short_no_args += short_opts
if self.short_no_args:
self.short_no_args_pattern = '*([%s])' % self.short_no_args
else:
self.short_no_args_pattern = ''
def _collect_options_info(self, options):
for option in options:
if option.get_long_option_strings():
if option.has_optional_arg():
self.long_optional = True
elif option.has_required_arg():
self.long_required = True
if option.get_old_option_strings():
if option.has_optional_arg():
self.old_optional = True
elif option.has_required_arg():
self.old_required = True
if option.get_short_option_strings():
if option.has_optional_arg():
self.short_optional = True
elif option.has_required_arg():
self.short_required = True
def _get_prev_completion(info):
r = 'case "$prev" in\n'
if info.long_required:
r += ' --*) __complete_option "$prev" "$cur" WITHOUT_OPTIONAL && return 0;;\n'
else:
r += ' --*);;\n'
if info.old_required and info.short_required:
r += ' -*) __complete_option "$prev" "$cur" WITHOUT_OPTIONAL && return 0;&\n'
r += ' -%s[%s])\n' % (info.short_no_args_pattern, info.short_required_args)
r += ' __complete_option "-${prev: -1}" "$cur" WITHOUT_OPTIONAL && return 0;;\n'
elif info.old_required:
r += ' -*) __complete_option "$prev" "$cur" WITHOUT_OPTIONAL && return 0;;\n'
elif info.short_required:
r += ' -%s[%s])\n' % (info.short_no_args_pattern, info.short_required_args)
r += ' __complete_option "-${prev: -1}" "$cur" WITHOUT_OPTIONAL && return 0;;\n'
r += 'esac'
return r
def _get_cur_completion(info):
short_no_args_pattern = info.short_no_args_pattern
short_required_args = info.short_required_args
short_optional_args = info.short_optional_args
r = 'case "$cur" in\n'
if info.long_required or info.long_optional:
r += ' --*=*)\n'
r += ' __complete_option "${cur%%=*}" "${cur#*=}" WITH_OPTIONAL && return 0;;\n'
else:
r += ' --*=*);;\n'
r += ' --*);;\n'
if (info.short_required or info.short_optional) and info.old_option_strings:
r += ' %s);;\n' % info.old_option_strings
if info.old_required or info.old_optional:
r += ' -*=*)\n'
r += ' __complete_option "${cur%%=*}" "${cur#*=}" WITH_OPTIONAL && return 0;&\n'
if info.short_required or info.short_optional:
r += ' -%s[%s%s]*)\n' % (short_no_args_pattern, short_required_args, short_optional_args)
r += ' local i\n'
r += ' for ((i=2; i <= ${#cur}; ++i)); do\n'
r += ' local pre="${cur:0:$i}" value="${cur:$i}"\n'
r += ' __complete_option "-${pre: -1}" "$value" WITH_OPTIONAL && {\n'
r += ' %s "$pre"\n' % info.ctxt.helpers.use_function('prefix_compreply')
r += ' return 0\n'
r += ' }\n'
r += ' done;;\n'
# Optimization: Strip unused case patterns at the end
if r.endswith(' -*=*);;\n'):
r = r.replace(' -*=*);;\n', '')
if r.endswith(' --*);;\n'):
r = r.replace(' --*);;\n', '')
r += 'esac'
return r
def _get_dispatcher(info):
r = []
required = info.short_required or info.long_required or info.old_required
optional = info.short_optional or info.long_optional or info.old_optional
if required:
r.append(_get_prev_completion(info))
if required or optional:
r.append(_get_cur_completion(info))
return '\n\n'.join(r)
def generate_option_completion(self):
'''Generate code for completing options.'''
options = self.commandline.get_options(only_with_arguments=True)
abbreviations = utils.get_option_abbreviator(self.commandline)
complete_function = _get_master_completion_obj(options, abbreviations, self)
complete_function_code = complete_function.get('__complete_option')
if not complete_function_code:
return None
info = _Info(options, abbreviations, self.commandline, self.ctxt)
dispatcher_code = _get_dispatcher(info)
if not complete_function.optionals:
dispatcher_code = dispatcher_code.replace('WITH_OPTIONAL ', '')
dispatcher_code = dispatcher_code.replace('WITHOUT_OPTIONAL ', '')
return f'{complete_function_code}\n\n{dispatcher_code}'
|
