← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shellcomplete.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shellcomplete.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009, 2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import sys
18
18
 
25
25
    else:
26
26
        shellcomplete_on_command(context, outfile = outfile)
27
27
 
28
 
def shellcomplete_on_command(cmdname, outfile = None):
 
28
 
 
29
def shellcomplete_on_command(cmdname, outfile=None):
29
30
    cmdname = str(cmdname)
30
31
 
31
32
    if outfile is None:
39
40
    if doc is None:
40
41
        raise NotImplementedError("sorry, no detailed shellcomplete yet for %r" % cmdname)
41
42
 
42
 
    shellcomplete_on_option(cmdobj.takes_options, outfile = None)
 
43
    shellcomplete_on_options(cmdobj.options().values(), outfile=outfile)
43
44
    for aname in cmdobj.takes_args:
44
45
        outfile.write(aname + '\n')
45
46
 
46
47
 
47
 
def shellcomplete_on_option(options, outfile=None):
48
 
    from bzrlib.option import Option
49
 
    if not options:
50
 
        return
51
 
    if outfile is None:
52
 
        outfile = sys.stdout
53
 
    for on in options:
54
 
        for shortname, longname in Option.SHORT_OPTIONS.items():
55
 
            if longname == on:
56
 
                l = '"(--' + on + ' -' + shortname + ')"{--' + on + ',-' + shortname + '}'
57
 
                break
58
 
            else:
59
 
                l = '--' + on
60
 
        outfile.write(l + '\n')
 
48
def shellcomplete_on_options(options, outfile=None):
 
49
    for opt in options:
 
50
        short_name = opt.short_name()
 
51
        if short_name:
 
52
            outfile.write('"(--%s -%s)"{--%s,-%s}\n'
 
53
                    % (opt.name, short_name, opt.name, short_name))
 
54
        else:
 
55
            outfile.write('--%s\n' % opt.name)
61
56
 
62
57
 
63
58
def shellcomplete_commands(outfile = None):
65
60
    import inspect
66
61
    import commands
67
62
    from inspect import getdoc
68
 
    
 
63
 
 
64
    commands.install_bzr_command_hooks()
 
65
 
69
66
    if outfile is None:
70
67
        outfile = sys.stdout
71
 
    
 
68
 
72
69
    cmds = []
73
 
    for cmdname, cmdclass in commands.get_all_cmds():
74
 
        cmds.append((cmdname, cmdclass))
75
 
        for alias in cmdclass.aliases:
76
 
            cmds.append((alias, cmdclass))
 
70
    for cmdname in commands.all_command_names():
 
71
        cmd = commands.get_cmd_object(cmdname)
 
72
        cmds.append((cmdname, cmd))
 
73
        for alias in cmd.aliases:
 
74
            cmds.append((alias, cmd))
77
75
    cmds.sort()
78
 
    for cmdname, cmdclass in cmds:
79
 
        if cmdclass.hidden:
 
76
    for cmdname, cmd in cmds:
 
77
        if cmd.hidden:
80
78
            continue
81
 
        doc = getdoc(cmdclass)
 
79
        doc = getdoc(cmd)
82
80
        if doc is None:
83
 
            outfile.write(cmdname + '\n')
 
81
            outfile.write(cmdname + '\n')
84
82
        else:
85
 
            doclines = doc.splitlines()
86
 
            firstline = doclines[0].lower()
87
 
            outfile.write(cmdname + ':' + firstline[0:-1] + '\n')
 
83
            doclines = doc.splitlines()
 
84
            firstline = doclines[0].lower()
 
85
            outfile.write(cmdname + ':' + firstline[0:-1] + '\n')