← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Aaron Bentley
  • Date: 2007-12-29 22:05:47 UTC
  • mto: This revision was merged to the branch mainline in revision 3162.
  • Revision ID: aaron.bentley@utoronto.ca-20071229220547-fi8mxlg9fv9ivq68
do case-insensitive comparision of iexplore filename

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2011 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
16
 
 
17
 
from __future__ import absolute_import
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
# TODO: Some way to get a list of external commands (defined by shell
20
18
# scripts) so that they can be included in the help listing as well.
24
22
# TODO: `help commands --all` should show hidden commands
25
23
 
26
24
import sys
 
25
import textwrap
27
26
 
28
27
from bzrlib import (
29
28
    commands as _mod_commands,
31
30
    help_topics,
32
31
    osutils,
33
32
    plugin,
34
 
    ui,
35
 
    utextwrap,
 
33
    symbol_versioning,
36
34
    )
37
35
 
38
36
 
39
37
def help(topic=None, outfile=None):
40
38
    """Write the help for the specific topic to outfile"""
41
39
    if outfile is None:
42
 
        outfile = ui.ui_factory.make_output_stream()
 
40
        outfile = sys.stdout
43
41
 
44
42
    indices = HelpIndices()
45
43
 
47
45
    try:
48
46
        topics = indices.search(topic)
49
47
        shadowed_terms = []
50
 
        for index, topic_obj in topics[1:]:
 
48
        for index, topic in topics[1:]:
51
49
            shadowed_terms.append('%s%s' % (index.prefix,
52
 
                topic_obj.get_help_topic()))
53
 
        source = topics[0][1]
54
 
        outfile.write(source.get_help_text(shadowed_terms))
 
50
                topic.get_help_topic()))
 
51
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
55
52
    except errors.NoHelpTopic:
56
53
        if alias is None:
57
54
            raise
64
61
def help_commands(outfile=None):
65
62
    """List all commands"""
66
63
    if outfile is None:
67
 
        outfile = ui.ui_factory.make_output_stream()
 
64
        outfile = sys.stdout
68
65
    outfile.write(_help_commands_to_text('commands'))
69
66
 
70
67
 
 
68
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
 
69
def command_usage(cmd):
 
70
    return cmd._usage()
 
71
 
 
72
 
71
73
def _help_commands_to_text(topic):
72
74
    """Generate the help text for the list of commands"""
73
75
    out = []
75
77
        hidden = True
76
78
    else:
77
79
        hidden = False
78
 
    names = list(_mod_commands.all_command_names())
 
80
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
81
    names.update(_mod_commands.plugin_command_names())
79
82
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
80
83
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
81
84
    max_name = max(len(n) for n, o in shown_commands)
82
85
    indent = ' ' * (max_name + 1)
83
 
    width = osutils.terminal_width()
84
 
    if width is None:
85
 
        width = osutils.default_terminal_width
86
 
    # we need one extra space for terminals that wrap on last char
87
 
    width = width - 1
 
86
    width = osutils.terminal_width() - 1
88
87
 
89
88
    for cmd_name, cmd_object in sorted(shown_commands):
90
89
        plugin_name = cmd_object.plugin_name()
99
98
        else:
100
99
            firstline = ''
101
100
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
102
 
        lines = utextwrap.wrap(
103
 
            helpstring, subsequent_indent=indent,
104
 
            width=width,
105
 
            break_long_words=False)
 
101
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
102
                              width=width)
106
103
        for line in lines:
107
104
            out.append(line + '\n')
108
105
    return ''.join(out)
120
117
 
121
118
class HelpIndices(object):
122
119
    """Maintainer of help topics across multiple indices.
123
 
 
 
120
    
124
121
    It is currently separate to the HelpTopicRegistry because of its ordered
125
122
    nature, but possibly we should instead structure it as a search within the
126
123
    registry and add ordering and searching facilities to the registry. The
138
135
            help_topics.HelpTopicIndex(),
139
136
            _mod_commands.HelpCommandIndex(),
140
137
            plugin.PluginsHelpIndex(),
141
 
            help_topics.ConfigOptionHelpIndex(),
142
138
            ]
143
139
 
144
140
    def _check_prefix_uniqueness(self):
152
148
 
153
149
    def search(self, topic):
154
150
        """Search for topic across the help search path.
155
 
 
 
151
        
156
152
        :param topic: A string naming the help topic to search for.
157
153
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
158
154
        :return: A list of HelpTopics which matched 'topic'.