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
|
# SPDX-License-Identifier: GPL-3.0-or-later
# Copyright (C) 2025-2026 Benjamin Abendroth <braph93@gmx.de>
'''Classes for including functions in the generation process.'''
import re
from . import cli
from . import shell
from . import preprocessor
from .str_utils import (indent, strip_comments, strip_double_empty_lines)
# pylint: disable=too-few-public-methods
def replace_function_name(search, replace, s):
'''Safely replace a function name in code'''
pattern = f'\\b{search}\\b'
return re.sub(pattern, replace, s)
class FunctionBase:
'''Base class for functions.'''
def __init__(self, funcname, code, dependencies=None):
self.funcname = funcname
self.code = code.strip()
self.dependencies = dependencies if dependencies else []
def get_code(self):
'''Return the whole function.'''
raise NotImplementedError
class ShellFunction(FunctionBase):
'''Class for generating Bash and Zsh functions.'''
def get_code(self, funcname=None, defines=frozenset()):
if funcname is None:
funcname = self.funcname
code = self.code.replace('%FUNCNAME%', funcname)
code = preprocessor.preprocess(code, defines)
code = strip_double_empty_lines(code)
r = '%s() {\n' % funcname
r += '%s\n' % indent(code, 2).rstrip()
r += '}'
return r
class FishFunction(FunctionBase):
'''Class for generating Fish functions.'''
def get_code(self, funcname=None, defines=frozenset()):
if funcname is None:
funcname = self.funcname
code = self.code.replace('%FUNCNAME%', funcname)
code = preprocessor.preprocess(code, defines)
code = strip_double_empty_lines(code)
r = 'function %s\n' % funcname
r += '%s\n' % indent(code, 2).rstrip()
r += 'end'
return r
def make_completion_funcname_for_context(ctxt, prefix):
'''TODO.'''
commandlines = ctxt.commandline.get_parents(include_self=True)
prognames = [p.prog for p in commandlines]
prognames[0] = prefix
funcname = shell.make_identifier('_'.join(prognames))
if isinstance(ctxt.option, cli.Option):
return '%s__%s' % (funcname, ctxt.option.option_strings[0])
if isinstance(ctxt.option, cli.Positional):
if ctxt.option.metavar:
identifier = shell.make_identifier(ctxt.option.metavar)
else:
identifier = 'arg%d' % ctxt.option.get_positional_num()
return '%s__%s' % (funcname, identifier)
raise AssertionError('Should not be reached')
class GeneralHelpers:
'''Class for including functions in the generation process.'''
def __init__(self, config, prog, function_class):
self.config = config
self.function_prefix = config.function_prefix.replace('$PROG', prog)
self.function_class = function_class
# Dynamic functions
self.dynamic_functions_code_to_funcname = {}
# Builtin functins
self.functions = {}
self.used_functions = {} # funcname:set(defines)
self.global_defines = set()
# Set debug mode
if self.config.debug:
self.define('DEBUG')
# =========================================================================
# Dynamic functions
# =========================================================================
def add_dynamic_func(self, ctxt, code):
'''Add dynamically generated function.'''
try:
return self.dynamic_functions_code_to_funcname[code]
except KeyError:
funcname = self.get_dynamic_funcname(ctxt)
self.dynamic_functions_code_to_funcname[code] = funcname
return funcname
def get_dynamic_funcname(self, ctxt):
'''Return a unique function name for `ctxt`.'''
funcname = make_completion_funcname_for_context(ctxt, self.function_prefix)
num = 0
funcname_plus_num = funcname
while funcname_plus_num in self.dynamic_functions_code_to_funcname.values():
funcname_plus_num = '%s%d' % (funcname, num)
num += 1
return funcname_plus_num
def get_all_dynamic_functions(self):
'''Return a list of code for all dynamically defined functions.'''
r = []
for code, funcname in self.dynamic_functions_code_to_funcname.items():
r.append(self.function_class(funcname, code).get_code())
return r
# =========================================================================
# Builtin functions
# =========================================================================
def add_function(self, function):
'''Add a function to the function repository.'''
assert isinstance(function, FunctionBase)
self.functions[function.funcname] = function
def define(self, name):
'''Define a macro on global scope.'''
self.global_defines.add(name)
def use_function(self, function_name, *defines):
'''Use a function from the function repository.'''
if function_name not in self.functions:
raise KeyError('No such function: %r' % function_name)
if function_name not in self.used_functions:
self.used_functions[function_name] = set(defines)
else:
self.used_functions[function_name].update(defines)
# Add dependencies
for function in self.functions[function_name].dependencies:
self.use_function(function)
return self.get_real_function_name(function_name)
def get_real_function_name(self, function_name):
'''Return the function name with its prefix.'''
return '%s__%s' % (self.function_prefix, function_name)
def is_used(self, function_name):
'''Check if a function is used.'''
return function_name in self.used_functions
def get_used_functions_code(self):
'''Return a list of code for all used functions.'''
r = []
for funcname, defines in self.used_functions.items():
function = self.functions[funcname]
realname = self.get_real_function_name(funcname)
code = function.get_code(realname, self.global_defines | defines)
for dep_func in function.dependencies:
real_func = self.get_real_function_name(dep_func)
code = replace_function_name(dep_func, real_func, code)
code = code.replace('%PREFIX%', self.function_prefix)
if not self.config.keep_comments:
code = strip_comments(code)
code = strip_double_empty_lines(code)
r.append(code)
r.extend(self.get_all_dynamic_functions())
return r
# =========================================================================
# Other methods
# =========================================================================
def make_completion_funcname(self, commandline, suffix=''):
'''Generates a function name for auto-completing a program or subcommand.
Args:
cmdline (CommandLine):
The CommandLine instance representing the program or subcommand.
suffix (str):
The suffix that shall be appended to the result.
Returns:
str: The generated function name for auto-completion.
This function is used to generate a unique function name for
auto-completing a program or subcommand in the specified shell.
It concatenates the names of all parent commandlines, including the
current commandline, and converts them into a valid function name
format.
Example:
For a program with the name 'my_program' and a subcommand with the name 'subcommand',
the generated function name is '_my_program_subcommand'.
'''
assert isinstance(commandline, cli.CommandLine)
commandlines = commandline.get_parents(include_self=True)
prognames = [cmdline.prog for cmdline in commandlines]
prognames[0] = self.function_prefix
identifier = shell.make_identifier('_'.join(prognames))
return f'{identifier}{suffix}'
|
