← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shellcomplete.py

  • Committer: Robert Collins
  • Date: 2007-06-04 03:39:48 UTC
  • mto: (2507.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2505.
  • Revision ID: robertc@robertcollins.net-20070604033948-erld0bugxcbo62gf
Review feedback.

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
 
1
17
import sys
2
18
 
3
19
 
4
20
def shellcomplete(context=None, outfile = None):
5
 
    if outfile == None:
 
21
    if outfile is None:
6
22
        outfile = sys.stdout
7
 
    if context == None:
 
23
    if context is None:
8
24
        shellcomplete_commands(outfile = outfile)
9
25
    else:
10
26
        shellcomplete_on_command(context, outfile = outfile)
11
27
 
12
 
def shellcomplete_on_command(cmdname, outfile = None):
 
28
 
 
29
def shellcomplete_on_command(cmdname, outfile=None):
13
30
    cmdname = str(cmdname)
14
31
 
15
 
    if outfile == None:
 
32
    if outfile is None:
16
33
        outfile = sys.stdout
17
34
 
18
35
    from inspect import getdoc
19
36
    import commands
20
 
    context, cmdclass = commands.get_cmd_class(cmdname)
 
37
    cmdobj = commands.get_cmd_object(cmdname)
21
38
 
22
 
    doc = getdoc(cmdclass)
23
 
    if doc == None:
 
39
    doc = getdoc(cmdobj)
 
40
    if doc is None:
24
41
        raise NotImplementedError("sorry, no detailed shellcomplete yet for %r" % cmdname)
25
42
 
26
 
    shellcomplete_on_option(cmdclass.takes_options, outfile = None)
27
 
    for aname in cmdclass.takes_args:
28
 
            outfile.write(aname + '\n')
29
 
 
30
 
 
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')
 
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)
48
55
 
49
56
 
50
57
def shellcomplete_commands(outfile = None):
53
60
    import commands
54
61
    from inspect import getdoc
55
62
    
56
 
    if outfile == None:
 
63
    if outfile is None:
57
64
        outfile = sys.stdout
58
65
    
59
66
    cmds = []
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))
64
71
    cmds.sort()
65
72
    for cmdname, cmdclass in cmds:
66
73
        if cmdclass.hidden:
67
74
            continue
68
75
        doc = getdoc(cmdclass)
69
 
        if doc == None:
70
 
            outfile.write(cmdname + '\n')
 
76
        if doc is None:
 
77
            outfile.write(cmdname + '\n')
71
78
        else:
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')