File: bash-compgen

package info (click to toggle)
moap 0.2.7-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, squeeze, wheezy
  • size: 1,360 kB
  • ctags: 904
  • sloc: python: 5,590; sh: 818; makefile: 228; cs: 16
file content (211 lines) | stat: -rwxr-xr-x 6,387 bytes parent folder | download | duplicates (5)
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
#!/usr/bin/env python
# -*- Mode: Python -*-
# vi:si:et:sw=4:sts=4:ts=4

# generate bash completion for all commands
# first argument should be program name
# second argument should be the main Command entry class's fully qualified name

import sys

def funcName(cmd):
    """
    Generate a name for the given command by walking up the ancestry
    and seperating with underscore.
    """
    l = [cmd.name]
    while cmd.parentCommand:
        cmd = cmd.parentCommand
        l.append(cmd.name)

    l.reverse()
    return "_%s_complete_" % cmd.name + "_".join(l)
    
def generateOneCommand(cmd):
    function = funcName(cmd)
    commandList = cmd.subCommands.keys()
    commandList.sort()
    commands = '"' + " ".join(commandList) + '"'

    # poking into private instance variables for optparse.Option is nasty,
    # but I see no alternative
    optionBooleanList = []
    optionValueList = []
    optionList = []
    for option in cmd.parser.option_list:
        optionList.extend(option._short_opts + option._long_opts)
        if not option.nargs:
            optionBooleanList.extend(option._short_opts + option._long_opts)
        else:
            optionValueList.extend(option._short_opts + option._long_opts)
    optionList.sort()
    options = '"' + " ".join(optionList) + '"'
    optionsBoolean = '"' + " ".join(optionBooleanList) + '"'
    optionsValue = '"' + " ".join(optionValueList) + '"'

    name = cmd.name

    return """
%(function)s()
{
    options=%(options)s
    optionsboolean=%(optionsBoolean)s
    optionsvalue=%(optionsValue)s
    commands=%(commands)s
    completed=false

    debug "function %(function)s"
    debug "args '$@'"
    debug "ARG1 '$1'"
    debug "ARG2 '$2'"
    shift
    debug "after shift: args '$@'"
    debug "ARG1 '$1'"
    debug "ARG2 '$2'"


    while [[ "$completed" == "false" ]]
    do
        if [[ "$1" == -* ]]
        then
            # handle as argument
            debug "handling argument $#"
            # found will be set to true when the current argument fully matches
            # an option, causing us to swallow it
            found=false
            # first check for boolean options
            for option in $optionsboolean
            do
                debug "matching option $option to args $1"
                if [[ "$option" == "$1" ]]
                then
                    debug "found full boolean option $option, eating"
                    found=true
                    shift
                fi
            done
            # then check for valued options
            if [[ "$found" == false ]]
            then
                for option in $optionsvalue
                do
                    debug "matching option $option to args $1"
                    if [[ "$option" == "$1" ]]
                    then
                        found=true
                        if [[ $# -eq 1 ]]
                        then
                            # a valued option with no value
                            # we can't complete this since we don't know what
                            # values the option takes
                            completed=true
                            COMPREPLY=()
                        else
                            # eat option and its value
                            shift 2
                        fi
                    fi
                done
            fi
            if [[ "$found" == false ]]
            then
                debug "completing argument"
                COMPREPLY=( $( compgen -W "$options" -- $1 ) )
                debug "COMPREPLY ${COMPREPLY[*]}"
                completed=true
            fi
        else
            # handle as command
            debug "handle as command"
            found=false
            if [[ $# -eq 0 ]]; then
                # completing this command
                COMPREPLY=( $( compgen -W "$commands" -- $1 ) )
                debug "command, COMPREPLY ${COMPREPLY[*]}"
                completed=true
            else
                for command in $commands
                do
                    debug "matching arg $1 against command $command"
                    if [[ "$command" == "$1" ]]
                    then
                        debug "found full command, delegating"
                         # completing a subcommand, delegate
                        debug "delegate, $# args, 1 is $1"
                        %(function)s_$1 $@
                        debug "delegated, COMPREPLY ${COMPREPLY[*]}"
                        found=true
                    fi
                done
                # if not found, we must still be wanting to complete the
                # current partial command
                if [[ "$found" == false ]]
                then
                    COMPREPLY=( $( compgen -W "$commands" -- $1 ) )
                    completed=true
                fi
            fi
        fi
        debug "function %(function)s: COMPREPLY ${COMPREPLY[*]}"
    done
        
}
""" % locals()

def generateSubCommands(cmd):
    snippets = []
    if cmd.subCommands:
        for subCommand in cmd.subCommands.values():
            snippets.extend(generateSubCommands(subCommand))
    snippets.append(generateOneCommand(cmd))
    return snippets

        
def start():
    if len(sys.argv) != 3:
        sys.stderr.write('Usage: %s [program-name] [entry-class]\n')
        sys.exit(1)

    name = sys.argv[1]
    entry = sys.argv[2]
    parts = entry.split('.')
    if len(parts) <= 1:
        sys.stderr.write(
            'The entry class should be a module-qualified Class.\n')
        sys.exit(1)
    module = ".".join(parts[:-1])
    command = "from %s import %s as EntryClass" % (module, parts[-1])
    exec command
    entry = EntryClass()
    print """#-*- mode: shell-script;-*-

# Programmed completion for bash to use %s

""" % name

    print "\n".join(generateSubCommands(entry))

    print """
# helper debug function
debug()
{
    if [[ ! -z "$DEBUG" ]]
    then
        echo $@
    fi
}

# main entry point
# dispatches to a command-specific function, passing in the rest of the
# command line as arguments, starting with the command name being called
_%(name)s()
{
        COMPREPLY=()
        # pass as a list, not as a single string
        _%(name)s_complete_%(name)s ${COMP_WORDS[*]}
}

complete -F _%(name)s -o default %(name)s
""" % locals()

start()