← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shellcomplete.py

Partial updates for API changes in trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shellcomplete.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
import sys
 
18
 
 
19
 
 
20
def shellcomplete(context=None, outfile = None):
 
21
    if outfile is None:
 
22
        outfile = sys.stdout
 
23
    if context is None:
 
24
        shellcomplete_commands(outfile = outfile)
 
25
    else:
 
26
        shellcomplete_on_command(context, outfile = outfile)
 
27
 
 
28
 
 
29
def shellcomplete_on_command(cmdname, outfile=None):
 
30
    cmdname = str(cmdname)
 
31
 
 
32
    if outfile is None:
 
33
        outfile = sys.stdout
 
34
 
 
35
    from inspect import getdoc
 
36
    import commands
 
37
    cmdobj = commands.get_cmd_object(cmdname)
 
38
 
 
39
    doc = getdoc(cmdobj)
 
40
    if doc is None:
 
41
        raise NotImplementedError("sorry, no detailed shellcomplete yet for %r" % cmdname)
 
42
 
 
43
    shellcomplete_on_options(cmdobj.options().values(), outfile=outfile)
 
44
    for aname in cmdobj.takes_args:
 
45
        outfile.write(aname + '\n')
 
46
 
 
47
 
 
48
def shellcomplete_on_options(options, outfile=None):
 
49
    for opt in options:
 
50
        if opt.short_name:
 
51
            outfile.write('"(--%s -%s)"{--%s,-%s}\n'
 
52
                    % (opt.name, opt.short_name, opt.name, opt.short_name))
 
53
        else:
 
54
            outfile.write('--%s\n' % opt.name)
 
55
 
 
56
 
 
57
def shellcomplete_commands(outfile = None):
 
58
    """List all commands"""
 
59
    import inspect
 
60
    import commands
 
61
    from inspect import getdoc
 
62
    
 
63
    if outfile is None:
 
64
        outfile = sys.stdout
 
65
    
 
66
    cmds = []
 
67
    for cmdname, cmdclass in commands.get_all_cmds():
 
68
        cmds.append((cmdname, cmdclass))
 
69
        for alias in cmdclass.aliases:
 
70
            cmds.append((alias, cmdclass))
 
71
    cmds.sort()
 
72
    for cmdname, cmdclass in cmds:
 
73
        if cmdclass.hidden:
 
74
            continue
 
75
        doc = getdoc(cmdclass)
 
76
        if doc is None:
 
77
            outfile.write(cmdname + '\n')
 
78
        else:
 
79
            doclines = doc.splitlines()
 
80
            firstline = doclines[0].lower()
 
81
            outfile.write(cmdname + ':' + firstline[0:-1] + '\n')