/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: 2007-04-20 03:54:06 UTC
  • mto: This revision was merged to the branch mainline in revision 2441.
  • Revision ID: robertc@robertcollins.net-20070420035406-e68xf089otkpo7xx
Teach Command.get_help_text to show additional help cross references when supplied.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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.
29
29
    errors,
30
30
    help_topics,
31
31
    osutils,
32
 
    plugin,
33
32
    )
34
33
 
35
34
 
39
38
        outfile = sys.stdout
40
39
 
41
40
    indices = HelpIndices()
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)))
 
41
    topics = indices.search(topic)
 
42
    outfile.write(topics[0][1].get_help_text())
59
43
 
60
44
 
61
45
def help_commands(outfile=None):
72
56
        hidden = True
73
57
    else:
74
58
        hidden = False
75
 
    names = list(_mod_commands.all_command_names())
 
59
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
60
    names.update(_mod_commands.plugin_command_names())
76
61
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
77
62
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
78
63
    max_name = max(len(n) for n, o in shown_commands)
79
64
    indent = ' ' * (max_name + 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
 
65
    width = osutils.terminal_width() - 1
85
66
 
86
67
    for cmd_name, cmd_object in sorted(shown_commands):
87
68
        plugin_name = cmd_object.plugin_name()
96
77
        else:
97
78
            firstline = ''
98
79
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
99
 
        lines = textwrap.wrap(
100
 
            helpstring, subsequent_indent=indent,
101
 
            width=width,
102
 
            break_long_words=False)
 
80
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
81
                              width=width)
103
82
        for line in lines:
104
83
            out.append(line + '\n')
105
84
    return ''.join(out)
107
86
 
108
87
help_topics.topic_registry.register("commands",
109
88
                                    _help_commands_to_text,
110
 
                                    "Basic help for all commands",
111
 
                                    help_topics.SECT_HIDDEN)
 
89
                                    "Basic help for all commands")
112
90
help_topics.topic_registry.register("hidden-commands",
113
91
                                    _help_commands_to_text,
114
 
                                    "All hidden commands",
115
 
                                    help_topics.SECT_HIDDEN)
 
92
                                    "All hidden commands")
116
93
 
117
94
 
118
95
class HelpIndices(object):
119
 
    """Maintainer of help topics across multiple indices.
120
 
 
121
 
    It is currently separate to the HelpTopicRegistry because of its ordered
122
 
    nature, but possibly we should instead structure it as a search within the
123
 
    registry and add ordering and searching facilities to the registry. The
124
 
    registry would probably need to be restructured to support that cleanly
125
 
    which is why this has been implemented in parallel even though it does as a
126
 
    result permit searching for help in indices which are not discoverable via
 
96
    """An object to manage help in multiple indices.
 
97
    
 
98
    This maintains a list of places to search for help. It is currently
 
99
    separate to the HelpTopicRegistry because of its ordered nature, but
 
100
    possibly we should instread structure it as a search within the registry
 
101
    and add ordering and searching facilities to the registry. The registry
 
102
    would probably need to be restructured to support that cleanly which is
 
103
    why this has been implemented in parallel even though it does as a result
 
104
    permit searching for help in indexs which are not discoverable via
127
105
    'help topics'.
128
 
 
129
 
    Each index has a unique prefix string, such as "commands", and contains
130
 
    help topics which can be listed or searched.
131
106
    """
132
107
 
133
108
    def __init__(self):
134
109
        self.search_path = [
135
110
            help_topics.HelpTopicIndex(),
136
111
            _mod_commands.HelpCommandIndex(),
137
 
            plugin.PluginsHelpIndex(),
138
112
            ]
139
113
 
140
114
    def _check_prefix_uniqueness(self):
148
122
 
149
123
    def search(self, topic):
150
124
        """Search for topic across the help search path.
151
 
 
 
125
        
152
126
        :param topic: A string naming the help topic to search for.
153
127
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
154
128
        :return: A list of HelpTopics which matched 'topic'.