← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shellcomplete.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

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