1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
4
20
def shellcomplete(context=None, outfile = None):
6
22
outfile = sys.stdout
8
24
shellcomplete_commands(outfile = outfile)
10
26
shellcomplete_on_command(context, outfile = outfile)
12
def shellcomplete_on_command(cmdname, outfile = None):
29
def shellcomplete_on_command(cmdname, outfile=None):
13
30
cmdname = str(cmdname)
16
33
outfile = sys.stdout
18
35
from inspect import getdoc
20
context, cmdclass = commands.get_cmd_class(cmdname)
37
cmdobj = commands.get_cmd_object(cmdname)
22
doc = getdoc(cmdclass)
24
41
raise NotImplementedError("sorry, no detailed shellcomplete yet for %r" % cmdname)
26
shellcomplete_on_option(cmdclass.takes_options, outfile = None)
27
for aname in cmdclass.takes_args:
28
outfile.write(aname + '\n')
31
def shellcomplete_on_option(options, outfile = None):
41
for shortname, longname in commands.SHORT_OPTIONS.items():
43
l = '"(--' + on + ' -' + shortname + ')"{--' + on + ',-' + shortname + '}'
47
outfile.write(l + '\n')
43
shellcomplete_on_options(cmdobj.options().values(), outfile=outfile)
44
for aname in cmdobj.takes_args:
45
outfile.write(aname + '\n')
48
def shellcomplete_on_options(options, outfile=None):
51
outfile.write('"(--%s -%s)"{--%s,-%s}\n'
52
% (opt.name, opt.short_name, opt.name, opt.short_name))
54
outfile.write('--%s\n' % opt.name)
50
57
def shellcomplete_commands(outfile = None):
54
61
from inspect import getdoc
57
64
outfile = sys.stdout
60
67
for cmdname, cmdclass in commands.get_all_cmds():
61
68
cmds.append((cmdname, cmdclass))
62
for alias in cmdclass.aliases:
63
cmds.append((alias, cmdclass))
69
for alias in cmdclass.aliases:
70
cmds.append((alias, cmdclass))
65
72
for cmdname, cmdclass in cmds:
66
73
if cmdclass.hidden:
68
75
doc = getdoc(cmdclass)
70
outfile.write(cmdname + '\n')
77
outfile.write(cmdname + '\n')
72
doclines = doc.splitlines()
73
firstline = doclines[0].lower()
74
outfile.write(cmdname + ':' + firstline[0:-1] + '\n')
79
doclines = doc.splitlines()
80
firstline = doclines[0].lower()
81
outfile.write(cmdname + ':' + firstline[0:-1] + '\n')