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
|
'''This module contains code for completing arguments in Fish.'''
from . import shell
from . import helpers
from .type_utils import is_dict_type
from .str_utils import indent, join_with_wrap
CHOICES_INLINE_THRESHOLD = 80
# The `choices` command can in Fish be expressed inline in a complete command
# like this:
# complete -c program -a 'foo bar baz'
# or:
# complete -c program -a 'foo\t"Foo value" bar\t"Bar value" baz\t"Baz value"'
#
# This variable defines how big this string can get before a function
# is used instead.
class FishCompletionBase:
'''Base class for Fish completions.'''
def get_args(self):
'''Return a list of arguments to be appended to the `complete`
command in Fish.
The returned arguments should be in raw form, without any escaping.
Escaping will be handled at a later stage.
'''
raise NotImplementedError
def get_code(self):
'''Return the code that can be used for completing an argument.'''
raise NotImplementedError
class FishCompleteNone(FishCompletionBase):
'''Class for completing an argument without a completer.'''
def get_args(self):
return ['-f']
def get_code(self):
return ''
class FishCompletionCommand(FishCompletionBase):
'''Class for executing a command and parsing its output.'''
def __init__(self, command):
self.command = command
def get_code(self):
return self.command
def get_args(self):
return ['-f', '-a', '(%s)' % self.command]
class FishCompleteChoices(FishCompletionBase):
'''Class for completing choices.'''
def __init__(self, ctxt, choices):
self.ctxt = ctxt
self.choices = choices
@staticmethod
def _get_inline_for_list(choices):
return ' '.join(shell.escape(str(c)) for c in choices)
@staticmethod
def _get_inline_for_dict(choices):
stringified = {str(item): str(desc) for item, desc in choices.items()}
r = ['%s\\t%s' % (shell.escape(item), shell.escape(desc)) for item, desc in stringified.items()]
return ' '.join(r)
@staticmethod
def _get_code_for_list(choices):
code = "printf '%s\\n' \\\n"
escaped = [shell.escape(str(item)) for item in choices]
code += indent(join_with_wrap(' ', ' \\\n', 80, escaped), 2)
return code.rstrip(' \\\n')
@staticmethod
def _get_code_for_dict(choices):
code = "printf '%s\\t%s\\n' \\\n"
for item, description in choices.items():
code += ' %s %s \\\n' % (shell.escape(str(item)), shell.escape(str(description)))
return code.rstrip(' \\\n')
def get_args(self):
if is_dict_type(self.choices):
arg = self._get_inline_for_dict(self.choices)
else:
arg = self._get_inline_for_list(self.choices)
if len(arg) <= CHOICES_INLINE_THRESHOLD:
return ['-f', '-a', arg]
code = self.get_code()
funcname = self.ctxt.helpers.add_dynamic_func(self.ctxt, code)
return ['-f', '-a', '(%s)' % funcname]
def get_code(self):
if is_dict_type(self.choices):
return self._get_code_for_dict(self.choices)
return self._get_code_for_list(self.choices)
class FishCompleteFileDir(FishCompletionBase):
'''Class for completing file/dir completion.'''
def __init__(self, ctxt, mode, opts):
self.ctxt = ctxt
self.mode = mode
self.directory = None if opts is None else opts.get('directory', None)
def get_args(self):
if self.mode == 'file':
if self.directory is not None:
funcname = self.ctxt.helpers.use_function('fish_complete_filedir')
return ['-f', '-a', '(%s -C %s)' % (funcname, shell.escape(self.directory))]
return ['-F']
# self.mode == 'directory'
if self.directory is not None:
funcname = self.ctxt.helpers.use_function('fish_complete_filedir')
return ['-f', '-a', '(%s -D -C %s)' % (funcname, shell.escape(self.directory))]
return ['-f', '-a', '(__fish_complete_directories)']
def get_code(self):
if self.mode == 'file':
funcname = self.ctxt.helpers.use_function('fish_complete_filedir')
if self.directory is not None:
return '%s -C %s' % (funcname, shell.escape(self.directory))
return '%s' % funcname
# self.mode == 'directory'
if self.directory is not None:
funcname = self.ctxt.helpers.use_function('fish_complete_filedir')
return '%s -D -C %s' % (funcname, shell.escape(self.directory))
return '__fish_complete_directories'
class FishCompleteValueList(FishCompletionBase):
'''Class for completing a list of values.'''
def __init__(self, ctxt, opts):
separator = opts.get('separator', ',')
values = opts['values']
if is_dict_type(values):
code = "printf '%s\\t%s\\n' \\\n"
for item, desc in values.items():
code += ' %s %s \\\n' % (shell.escape(item), shell.escape(desc))
code = code.rstrip(' \\\n')
else:
code = "printf '%s\\n' \\\n"
for value in values:
code += ' %s \\\n' % shell.escape(value)
code = code.rstrip(' \\\n')
funcname = ctxt.helpers.add_dynamic_func(ctxt, code)
self.cmd = '__fish_complete_list %s %s' % (shell.escape(separator), funcname)
def get_args(self):
return ['-f', '-a', '(%s)' % self.cmd]
def get_code(self):
return self.cmd
class FishCompleteCombine(FishCompletionBase):
'''Used for combining multiple complete commands.'''
def __init__(self, ctxt, completer, commands):
self.ctxt = ctxt
self.code = []
for command_args in commands:
command, *args = command_args
obj = getattr(completer, command)(ctxt, *args)
self.code.append(obj.get_code())
def get_code(self):
return '\n'.join(self.code)
def get_args(self):
code_is_singleline = not any('\n' in code for code in self.code)
if code_is_singleline:
return ['-f', '-a', '(%s)' % '; '.join(self.code)]
code = '\n'.join(self.code)
funcname = self.ctxt.helpers.add_dynamic_func(self.ctxt, code)
return ['-f', '-a', '(%s)' % funcname]
class FishCompleter(shell.ShellCompleter):
'''Code generator for completing arguments in Fish.'''
# pylint: disable=missing-function-docstring
# pylint: disable=too-many-public-methods
def none(self, _ctxt, *_):
return FishCompleteNone()
def integer(self, _ctxt, *_):
return FishCompleteNone()
def float(self, _ctxt, *_):
return FishCompleteNone()
def choices(self, ctxt, choices):
return FishCompleteChoices(ctxt, choices)
def command(self, __ctxt):
return FishCompletionCommand("__fish_complete_command")
def directory(self, ctxt, opts=None):
return FishCompleteFileDir(ctxt, 'directory', opts)
def file(self, ctxt, opts=None):
return FishCompleteFileDir(ctxt, 'file', opts)
def group(self, _ctxt):
return FishCompletionCommand("__fish_complete_groups")
def hostname(self, _ctxt):
return FishCompletionCommand("__fish_print_hostnames")
def pid(self, _ctxt):
return FishCompletionCommand("__fish_complete_pids")
def process(self, _ctxt):
return FishCompletionCommand("__fish_complete_proc")
def range(self, _ctxt, start, stop, step=1):
if step == 1:
return FishCompletionCommand(f"command seq {start} {stop}")
return FishCompletionCommand(f"command seq {start} {step} {stop}")
def service(self, _ctxt):
return FishCompletionCommand("__fish_systemctl_services")
def user(self, _ctxt):
return FishCompletionCommand("__fish_complete_users")
def variable(self, _ctxt):
return FishCompletionCommand("set -n")
def environment(self, _ctxt):
return FishCompletionCommand("set -n -x")
def exec(self, _ctxt, command):
return FishCompletionCommand(command)
def exec_fast(self, _ctxt, command):
return FishCompletionCommand(command)
def exec_internal(self, _ctxt, command):
return FishCompletionCommand(command)
def value_list(self, ctxt, opts):
return FishCompleteValueList(ctxt, opts)
def combine(self, ctxt, commands):
return FishCompleteCombine(ctxt, self, commands)
def history(self, ctxt, pattern):
func = ctxt.helpers.use_function('history')
return FishCompletionCommand('%s %s' % (func, shell.escape(pattern)))
# =========================================================================
# Bonus
# =========================================================================
def net_interface(self, ctxt):
func = ctxt.helpers.use_function('net_interfaces_list')
return FishCompletionCommand(func)
def timezone(self, ctxt):
func = ctxt.helpers.use_function('timezone_list')
return FishCompletionCommand(func)
def alsa_card(self, ctxt):
func = ctxt.helpers.use_function('alsa_list_cards')
return FishCompletionCommand(func)
def alsa_device(self, ctxt):
func = ctxt.helpers.use_function('alsa_list_devices')
return FishCompletionCommand(func)
|
