/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-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
# TODO: Some way to get a list of external commands (defined by shell
18
18
# scripts) so that they can be included in the help listing as well.
30
30
    help_topics,
31
31
    osutils,
32
32
    plugin,
33
 
    symbol_versioning,
34
33
    )
35
34
 
36
35
 
40
39
        outfile = sys.stdout
41
40
 
42
41
    indices = HelpIndices()
43
 
    topics = indices.search(topic)
44
 
    shadowed_terms = []
45
 
    for index, topic in topics[1:]:
46
 
        shadowed_terms.append('%s%s' % (index.prefix, topic.get_help_topic()))
47
 
    outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
42
 
 
43
    alias = _mod_commands.get_alias(topic)
 
44
    try:
 
45
        topics = indices.search(topic)
 
46
        shadowed_terms = []
 
47
        for index, topic in topics[1:]:
 
48
            shadowed_terms.append('%s%s' % (index.prefix,
 
49
                topic.get_help_topic()))
 
50
        source = topics[0][1]
 
51
        outfile.write(source.get_help_text(shadowed_terms))
 
52
    except errors.NoHelpTopic:
 
53
        if alias is None:
 
54
            raise
 
55
 
 
56
    if alias is not None:
 
57
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
58
            " ".join(alias)))
48
59
 
49
60
 
50
61
def help_commands(outfile=None):
54
65
    outfile.write(_help_commands_to_text('commands'))
55
66
 
56
67
 
57
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
58
 
def command_usage(cmd):
59
 
    return cmd._usage()
60
 
 
61
 
 
62
68
def _help_commands_to_text(topic):
63
69
    """Generate the help text for the list of commands"""
64
70
    out = []
66
72
        hidden = True
67
73
    else:
68
74
        hidden = False
69
 
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
70
 
    names.update(_mod_commands.plugin_command_names())
 
75
    names = list(_mod_commands.all_command_names())
71
76
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
72
77
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
73
78
    max_name = max(len(n) for n, o in shown_commands)
74
79
    indent = ' ' * (max_name + 1)
75
 
    width = osutils.terminal_width() - 1
 
80
    width = osutils.terminal_width()
 
81
    if width is None:
 
82
        width = osutils.default_terminal_width
 
83
    # we need one extra space for terminals that wrap on last char
 
84
    width = width - 1
76
85
 
77
86
    for cmd_name, cmd_object in sorted(shown_commands):
78
87
        plugin_name = cmd_object.plugin_name()
87
96
        else:
88
97
            firstline = ''
89
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
90
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
91
 
                              width=width)
 
99
        lines = textwrap.wrap(
 
100
            helpstring, subsequent_indent=indent,
 
101
            width=width,
 
102
            break_long_words=False)
92
103
        for line in lines:
93
104
            out.append(line + '\n')
94
105
    return ''.join(out)
96
107
 
97
108
help_topics.topic_registry.register("commands",
98
109
                                    _help_commands_to_text,
99
 
                                    "Basic help for all commands")
 
110
                                    "Basic help for all commands",
 
111
                                    help_topics.SECT_HIDDEN)
100
112
help_topics.topic_registry.register("hidden-commands",
101
113
                                    _help_commands_to_text,
102
 
                                    "All hidden commands")
 
114
                                    "All hidden commands",
 
115
                                    help_topics.SECT_HIDDEN)
103
116
 
104
117
 
105
118
class HelpIndices(object):
106
119
    """Maintainer of help topics across multiple indices.
107
 
    
 
120
 
108
121
    It is currently separate to the HelpTopicRegistry because of its ordered
109
122
    nature, but possibly we should instead structure it as a search within the
110
123
    registry and add ordering and searching facilities to the registry. The
135
148
 
136
149
    def search(self, topic):
137
150
        """Search for topic across the help search path.
138
 
        
 
151
 
139
152
        :param topic: A string naming the help topic to search for.
140
153
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
141
154
        :return: A list of HelpTopics which matched 'topic'.