← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shellcomplete.py

merge merge tweaks from aaron, which includes latest .dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shellcomplete.py
1
 
# Copyright (C) 2005, 2006, 2007, 2009, 2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
from __future__ import absolute_import
18
 
 
19
1
import sys
20
2
 
21
3
 
22
4
def shellcomplete(context=None, outfile = None):
23
 
    if outfile is None:
 
5
    if outfile == None:
24
6
        outfile = sys.stdout
25
 
    if context is None:
 
7
    if context == None:
26
8
        shellcomplete_commands(outfile = outfile)
27
9
    else:
28
10
        shellcomplete_on_command(context, outfile = outfile)
29
11
 
30
 
 
31
 
def shellcomplete_on_command(cmdname, outfile=None):
 
12
def shellcomplete_on_command(cmdname, outfile = None):
32
13
    cmdname = str(cmdname)
33
14
 
34
 
    if outfile is None:
 
15
    if outfile == None:
35
16
        outfile = sys.stdout
36
17
 
37
18
    from inspect import getdoc
39
20
    cmdobj = commands.get_cmd_object(cmdname)
40
21
 
41
22
    doc = getdoc(cmdobj)
42
 
    if doc is None:
 
23
    if doc == None:
43
24
        raise NotImplementedError("sorry, no detailed shellcomplete yet for %r" % cmdname)
44
25
 
45
 
    shellcomplete_on_options(cmdobj.options().values(), outfile=outfile)
 
26
    shellcomplete_on_option(cmdobj.takes_options, outfile = None)
46
27
    for aname in cmdobj.takes_args:
47
28
        outfile.write(aname + '\n')
48
29
 
49
30
 
50
 
def shellcomplete_on_options(options, outfile=None):
51
 
    for opt in options:
52
 
        short_name = opt.short_name()
53
 
        if short_name:
54
 
            outfile.write('"(--%s -%s)"{--%s,-%s}\n'
55
 
                    % (opt.name, short_name, opt.name, short_name))
56
 
        else:
57
 
            outfile.write('--%s\n' % opt.name)
 
31
def shellcomplete_on_option(options, outfile = None):
 
32
    import commands
 
33
    
 
34
    if not options:
 
35
        return
 
36
    
 
37
    if outfile == None:
 
38
        outfile = sys.stdout
 
39
 
 
40
    for on in options:
 
41
        for shortname, longname in commands.SHORT_OPTIONS.items():
 
42
            if longname == on:
 
43
                l = '"(--' + on + ' -' + shortname + ')"{--' + on + ',-' + shortname + '}'
 
44
                break
 
45
            else:
 
46
                l = '--' + on
 
47
        outfile.write(l + '\n')
58
48
 
59
49
 
60
50
def shellcomplete_commands(outfile = None):
61
51
    """List all commands"""
62
 
    from bzrlib import commands
 
52
    import inspect
 
53
    import commands
63
54
    from inspect import getdoc
64
 
 
65
 
    commands.install_bzr_command_hooks()
66
 
 
67
 
    if outfile is None:
 
55
    
 
56
    if outfile == None:
68
57
        outfile = sys.stdout
69
 
 
 
58
    
70
59
    cmds = []
71
 
    for cmdname in commands.all_command_names():
72
 
        cmd = commands.get_cmd_object(cmdname)
73
 
        cmds.append((cmdname, cmd))
74
 
        for alias in cmd.aliases:
75
 
            cmds.append((alias, cmd))
 
60
    for cmdname, cmdclass in commands.get_all_cmds():
 
61
        cmds.append((cmdname, cmdclass))
 
62
        for alias in cmdclass.aliases:
 
63
            cmds.append((alias, cmdclass))
76
64
    cmds.sort()
77
 
    for cmdname, cmd in cmds:
78
 
        if cmd.hidden:
 
65
    for cmdname, cmdclass in cmds:
 
66
        if cmdclass.hidden:
79
67
            continue
80
 
        doc = getdoc(cmd)
81
 
        if doc is None:
82
 
            outfile.write(cmdname + '\n')
 
68
        doc = getdoc(cmdclass)
 
69
        if doc == None:
 
70
            outfile.write(cmdname + '\n')
83
71
        else:
84
 
            doclines = doc.splitlines()
85
 
            firstline = doclines[0].lower()
86
 
            outfile.write(cmdname + ':' + firstline[0:-1] + '\n')
 
72
            doclines = doc.splitlines()
 
73
            firstline = doclines[0].lower()
 
74
            outfile.write(cmdname + ':' + firstline[0:-1] + '\n')