File: fish.py

package info (click to toggle)
crazy-complete 0.3.6-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,404 kB
  • sloc: python: 7,949; sh: 4,636; makefile: 74
file content (360 lines) | stat: -rw-r--r-- 13,272 bytes parent folder | download | duplicates (2)
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
349
350
351
352
353
354
355
356
357
358
359
360
'''Code for generating a fish auto completion file.'''

from collections import namedtuple, OrderedDict

from . import config as config_
from . import generation_notice
from . import modeline
from . import shell
from . import utils
from . import algo
from . import fish_complete
from . import fish_helpers
from .fish_utils import FishCompleteCommand, VariableManager
from . import when
from . import generation


class FishQuery:
    '''Class for querying the command line.'''

    def __init__(self, ctxt):
        self.ctxt = ctxt

    def positional_contains(self, num, words):
        '''Check if a positional contains words.'''

        self.ctxt.helpers.use_function('fish_query', 'positional_contains')
        r = "$query '$opts' positional_contains %d %s" % (num, ' '.join(words))
        return r

    def has_option(self, options):
        '''Check if certain option is present on command line.'''

        self.ctxt.helpers.use_function('fish_query', 'has_option')
        r = "$query '$opts' has_option %s" % ' '.join(options)
        return r

    def option_is(self, options, values):
        '''Check if certain options have certain values.'''

        self.ctxt.helpers.use_function('fish_query', 'option_is')
        r = "$query '$opts' option_is %s -- %s" % (
            ' '.join(options), ' '.join(values))
        return r

    def num_of_positionals(self, operator, num):
        '''Check the current count of positional arguments .'''

        self.ctxt.helpers.use_function('fish_query', 'num_of_positionals')
        r = "$query '$opts' num_of_positionals %s %d" % (operator, num)
        return r

    def by_object(self, obj):
        if isinstance(obj, when.OptionIs):
            return self.option_is(obj.options, obj.values)
        if isinstance(obj, when.HasOption):
            return self.has_option(obj.options)
        raise AssertionError("Should not be reached")


class Conditions:
    NumOfPositionals = namedtuple('NumOfPositionals', ['operator', 'value'])

    def __init__(self, ctxt):
        self.ctxt = ctxt
        self.fish_query = FishQuery(ctxt)
        self.positional_contains = {}
        self.not_has_option = []
        self.num_of_positionals = None
        self.has_hidden_option = []
        self.when = None

    def get(self, unsafe=False):
        conditions = []

        for num, words in self.positional_contains.items():
            if unsafe:
                guard = "__fish_seen_subcommand_from %s" % (' '.join(words))
            else:
                guard = self.fish_query.positional_contains(num, words)
            conditions += [guard]

        if self.not_has_option:
            if unsafe:
                guard = "not __fish_seen_argument"
                for opt in self.not_has_option:
                    if opt.startswith('--'):
                        guard += ' -l %s' % opt.lstrip('-')
                    elif len(opt) == 2:
                        guard += ' -s %s' % opt[1]
                    else:
                        guard += ' -o %s' % opt.lstrip('-')
            else:
                guard = "not %s" % self.fish_query.has_option(self.not_has_option)
            conditions += [guard]

        if self.num_of_positionals is not None:
            if unsafe:
                guard = "test (__fish_number_of_cmd_args_wo_opts) %s %d" % (
                    self.num_of_positionals.operator, self.num_of_positionals.value) # TODO - 1)
            else:
                guard = self.fish_query.num_of_positionals(
                    self.num_of_positionals.operator, self.num_of_positionals.value - 1)
            conditions += [guard]

        if self.has_hidden_option:
            self.ctxt.helpers.use_function('fish_query', 'with_incomplete')
            self.ctxt.helpers.use_function('fish_query', 'has_option')
            guard = "$query '$opts' has_option WITH_INCOMPLETE %s" % (
                ' '.join(shell.escape(o) for o in self.has_hidden_option))
            conditions += [guard]

        if self.when is not None:
            parsed = when.parse_when(self.when)
            guard = self.fish_query.by_object(parsed)
            conditions += [guard]

        if not conditions:
            return None

        return '"%s"' % ' && '.join(conditions)


class FishCompletionDefinition:
    def __init__(
          self,
          ctxt,
          short_options=None,      # List of short options
          long_options=None,       # List of long options
          old_options=None,        # List of old-style options
          description=None,        # Description
          requires_argument=False, # Option requires an argument
          completion_args=None
        ):
        if short_options is None:
            short_options = []
        if long_options is None:
            long_options = []
        if old_options is None:
            old_options = []
        self.ctxt = ctxt
        self.short_options = short_options
        self.long_options = long_options
        self.old_options = old_options
        self.description = description
        self.requires_argument = requires_argument
        self.completion_args = completion_args
        self.conditions = Conditions(ctxt)

    def get_complete_cmd(self, unsafe=False):
        cmd = FishCompleteCommand()
        cmd.set_command('$prog', raw=True)
        cmd.add_short_options(self.short_options)
        cmd.add_long_options(self.long_options)
        cmd.add_old_options(self.old_options)

        if self.description is not None:
            cmd.set_description(self.description)

        if self.requires_argument:
            cmd.flags.add('r')

        cmd.parse_args(self.completion_args)
        cmd.set_condition(self.conditions.get(unsafe=unsafe), raw=True)

        return cmd


def _get_positional_contains(option):
    cmdlines = option.parent.get_parents(include_self=True)
    del cmdlines[0]

    r = OrderedDict()

    for cmdline in cmdlines:
        cmds = utils.get_all_command_variations(cmdline)
        r[cmdline.parent.get_subcommands().get_positional_num()] = cmds

    return r


class FishCompletionGenerator:
    def __init__(self, ctxt, commandline):
        self.commandline = commandline
        self.ctxt = ctxt
        self.completer = fish_complete.FishCompleter()
        self.lines = []
        self.conditions = VariableManager('C')
        self.command_comment = '# command %s' % self.commandline.get_command_path()
        self.options_for_query = 'set -l opts "%s"' % utils.get_query_option_strings(self.commandline)

        complete_definitions = []
        for option in self.commandline.get_options():
            complete_definitions.append(self._complete_option(option))

        for positional in self.commandline.get_positionals():
            complete_definitions.append(self._complete_positional(positional))

        if self.commandline.get_subcommands():
            complete_definitions.append(self._complete_subcommands(self.commandline.get_subcommands()))

        for definition in complete_definitions:
            cmd = definition.get_complete_cmd(self.ctxt.config.fish_fast)

            if cmd.condition is not None and '$query' in cmd.condition.s:
                self.ctxt.helpers.use_function('fish_query')

            if not self.ctxt.config.fish_inline_conditions:
                if cmd.condition is not None:
                    cmd.set_condition(self.conditions.add(cmd.condition.s), raw=True)

            self.lines.append(cmd.get())

    def _complete_option(self, option):
        context = self.ctxt.get_option_context(self.commandline, option)

        if option.complete:
            completion_args = self.completer.complete(context, *option.complete).get_args()
        else:
            completion_args = self.completer.complete(context, 'none').get_args()

        definition = FishCompletionDefinition(
            self.ctxt,
            short_options       = option.get_short_option_strings(),
            long_options        = option.get_long_option_strings(),
            old_options         = option.get_old_option_strings(),
            requires_argument   = (option.complete and not option.optional_arg),
            description         = option.help,
            completion_args     = completion_args)

        final_options = self.commandline.get_final_option_strings()
        definition.conditions.not_has_option.extend(final_options)

        conflicting_options = option.get_conflicting_option_strings()
        definition.conditions.not_has_option.extend(conflicting_options)

        if not option.repeatable:
            definition.conditions.not_has_option.extend(option.option_strings)

        if option.hidden:
            definition.conditions.has_hidden_option = option.option_strings

        definition.conditions.not_has_option = algo.uniq(definition.conditions.not_has_option)

        # If we don't inherit options, add a condition to the option that
        # ensures that we're in the right (sub)command.
        if not self.commandline.inherit_options and self.commandline.get_subcommands():
            positional = self.commandline.get_subcommands().get_positional_num()
            definition.conditions.num_of_positionals = Conditions.NumOfPositionals('-eq', positional)

        definition.conditions.positional_contains = _get_positional_contains(option)
        definition.conditions.when = option.when

        return definition

    def _complete_positional(self, option):
        context = self.ctxt.get_option_context(self.commandline, option)

        if option.complete:
            completion_args = self.completer.complete(context, *option.complete).get_args()
        else:
            completion_args = self.completer.complete(context, 'none').get_args()

        definition = FishCompletionDefinition(
            self.ctxt,
            requires_argument   = True,
            description         = option.help,
            completion_args     = completion_args
        )

        definition.conditions.when = option.when
        definition.conditions.positional_contains = _get_positional_contains(option)

        positional = option.get_positional_num()
        if option.repeatable:
            definition.conditions.num_of_positionals = Conditions.NumOfPositionals('-ge', positional)
        else:
            definition.conditions.num_of_positionals = Conditions.NumOfPositionals('-eq', positional)

        return definition

    def _complete_subcommands(self, option):
        items = option.get_choices()
        context = self.ctxt.get_option_context(self.commandline, option)
        completion_args = self.completer.complete(context, 'choices', items).get_args()

        definition = FishCompletionDefinition(
            self.ctxt,
            description    = 'Commands',
            completion_args = completion_args
        )

        positional = option.get_positional_num()
        definition.conditions.num_of_positionals = Conditions.NumOfPositionals('-eq', positional)
        definition.conditions.positional_contains = _get_positional_contains(option)
        return definition


def generate_completion(commandline, config=None):
    '''Code for generating a Fish auto completion file.'''

    if config is None:
        config = config_.Config()

    commandline = generation.enhance_commandline(commandline, config)
    helpers = fish_helpers.FishHelpers(commandline.prog)
    ctxt = generation.GenerationContext(config, helpers)
    result = generation.visit_commandlines(FishCompletionGenerator, ctxt, commandline)

    if helpers.is_used('fish_query'):
        types = utils.get_defined_option_types(commandline)
        if types.short:
            ctxt.helpers.use_function('fish_query', 'short_options')
        if types.long:
            ctxt.helpers.use_function('fish_query', 'long_options')
        if types.old:
            ctxt.helpers.use_function('fish_query', 'old_options')

    output = []

    output.append(generation_notice.GENERATION_NOTICE)
    output.append('')

    for code in config.get_included_files_content():
        output.append(code)
        output.append('')

    for code in helpers.get_used_functions_code():
        output.append(code)
        output.append('')

    output.append("set -l prog '%s'" % commandline.prog)
    if helpers.is_used('fish_query'):
        output.append("set -l query '%s'" % helpers.use_function('fish_query'))

    output.append('')
    output.append('# Delete existing completions')
    output.append('complete -c $prog -e')
    output.append('')
    output.append('# Generally disable file completion')
    output.append('complete -c $prog -x')

    for generator in result:
        output.append('')
        output.append(generator.command_comment)
        output.append(generator.options_for_query)
        output.extend(generator.conditions.get_lines())
        output.extend(generator.lines)

    if commandline.aliases:
        output.append('')
        for alias in commandline.aliases:
            output.append('complete -c %s -e' % alias)
            output.append('complete -c %s -w %s' % (alias, commandline.prog))

    if config.vim_modeline:
        output.append('')
        output.append(modeline.get_vim_modeline('fish'))

    return '\n'.join(output)