← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Andrew Bennetts
  • Date: 2008-12-12 03:53:56 UTC
  • mto: This revision was merged to the branch mainline in revision 3900.
  • Revision ID: andrew.bennetts@canonical.com-20081212035356-uqcu89gy4nqf017x
Fix compilation error in _dirstate_helpers_c on SunOS/Solaris. (Jari Aalto)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
 
1
# Copyright (C) 2004, 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
 
 
17
# TODO: Some way to get a list of external commands (defined by shell
 
18
# scripts) so that they can be included in the help listing as well.
 
19
# It should be enough to just list the plugin directory and look for
 
20
# executable files with reasonable names.
 
21
 
 
22
# TODO: `help commands --all` should show hidden commands
 
23
 
 
24
import sys
 
25
import textwrap
 
26
 
 
27
from bzrlib import (
 
28
    commands as _mod_commands,
 
29
    errors,
 
30
    help_topics,
 
31
    osutils,
 
32
    plugin,
 
33
    symbol_versioning,
 
34
    )
 
35
 
 
36
 
 
37
def help(topic=None, outfile=None):
 
38
    """Write the help for the specific topic to outfile"""
 
39
    if outfile is None:
 
40
        outfile = sys.stdout
 
41
 
 
42
    indices = HelpIndices()
 
43
 
 
44
    alias = _mod_commands.get_alias(topic)
 
45
    try:
 
46
        topics = indices.search(topic)
 
47
        shadowed_terms = []
 
48
        for index, topic in topics[1:]:
 
49
            shadowed_terms.append('%s%s' % (index.prefix,
 
50
                topic.get_help_topic()))
 
51
        outfile.write(topics[0][1].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)))
 
59
 
 
60
 
 
61
def help_commands(outfile=None):
 
62
    """List all commands"""
 
63
    if outfile is None:
 
64
        outfile = sys.stdout
 
65
    outfile.write(_help_commands_to_text('commands'))
 
66
 
 
67
 
 
68
def _help_commands_to_text(topic):
 
69
    """Generate the help text for the list of commands"""
 
70
    out = []
 
71
    if topic == 'hidden-commands':
 
72
        hidden = True
 
73
    else:
 
74
        hidden = False
 
75
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
76
    names.update(_mod_commands.plugin_command_names())
 
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
79
    max_name = max(len(n) for n, o in shown_commands)
 
80
    indent = ' ' * (max_name + 1)
 
81
    width = osutils.terminal_width() - 1
 
82
 
 
83
    for cmd_name, cmd_object in sorted(shown_commands):
 
84
        plugin_name = cmd_object.plugin_name()
 
85
        if plugin_name is None:
 
86
            plugin_name = ''
 
87
        else:
 
88
            plugin_name = ' [%s]' % plugin_name
 
89
 
 
90
        cmd_help = cmd_object.help()
 
91
        if cmd_help:
 
92
            firstline = cmd_help.split('\n', 1)[0]
 
93
        else:
 
94
            firstline = ''
 
95
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
96
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
97
                              width=width)
 
98
        for line in lines:
 
99
            out.append(line + '\n')
 
100
    return ''.join(out)
 
101
 
 
102
 
 
103
help_topics.topic_registry.register("commands",
 
104
                                    _help_commands_to_text,
 
105
                                    "Basic help for all commands",
 
106
                                    help_topics.SECT_HIDDEN)
 
107
help_topics.topic_registry.register("hidden-commands",
 
108
                                    _help_commands_to_text,
 
109
                                    "All hidden commands",
 
110
                                    help_topics.SECT_HIDDEN)
 
111
 
 
112
 
 
113
class HelpIndices(object):
 
114
    """Maintainer of help topics across multiple indices.
 
115
    
 
116
    It is currently separate to the HelpTopicRegistry because of its ordered
 
117
    nature, but possibly we should instead structure it as a search within the
 
118
    registry and add ordering and searching facilities to the registry. The
 
119
    registry would probably need to be restructured to support that cleanly
 
120
    which is why this has been implemented in parallel even though it does as a
 
121
    result permit searching for help in indices which are not discoverable via
 
122
    'help topics'.
 
123
 
 
124
    Each index has a unique prefix string, such as "commands", and contains
 
125
    help topics which can be listed or searched.
 
126
    """
 
127
 
 
128
    def __init__(self):
 
129
        self.search_path = [
 
130
            help_topics.HelpTopicIndex(),
 
131
            _mod_commands.HelpCommandIndex(),
 
132
            plugin.PluginsHelpIndex(),
 
133
            ]
 
134
 
 
135
    def _check_prefix_uniqueness(self):
 
136
        """Ensure that the index collection is able to differentiate safely."""
 
137
        prefixes = {}
 
138
        for index in self.search_path:
 
139
            prefixes.setdefault(index.prefix, []).append(index)
 
140
        for prefix, indices in prefixes.items():
 
141
            if len(indices) > 1:
 
142
                raise errors.DuplicateHelpPrefix(prefix)
 
143
 
 
144
    def search(self, topic):
 
145
        """Search for topic across the help search path.
 
146
        
 
147
        :param topic: A string naming the help topic to search for.
 
148
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
149
        :return: A list of HelpTopics which matched 'topic'.
 
150
        """
 
151
        self._check_prefix_uniqueness()
 
152
        result = []
 
153
        for index in self.search_path:
 
154
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
155
        if not result:
 
156
            raise errors.NoHelpTopic(topic)
 
157
        else:
 
158
            return result