← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Andrew Bennetts
  • Date: 2010-06-25 06:47:40 UTC
  • mto: (5050.3.16 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: andrew.bennetts@canonical.com-20100625064740-k93ngat248kdcqdm
Remove merge_into_helper for now, as it currently has no callers.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 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
 
18
18
"""Commit message editor support."""
19
19
 
20
20
import codecs
21
 
import errno
22
21
import os
23
22
from subprocess import call
24
23
import sys
27
26
    config,
28
27
    osutils,
29
28
    trace,
 
29
    transport,
 
30
    ui,
30
31
    )
31
32
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
 
from bzrlib.hooks import Hooks
 
33
from bzrlib.hooks import HookPoint, Hooks
33
34
 
34
35
 
35
36
def _get_editor():
42
43
    e = config.GlobalConfig().get_editor()
43
44
    if e is not None:
44
45
        yield e, config.config_filename()
45
 
        
 
46
 
46
47
    for varname in 'VISUAL', 'EDITOR':
47
48
        if varname in os.environ:
48
49
            yield os.environ[varname], '$' + varname
63
64
            ## mutter("trying editor: %r", (edargs +[filename]))
64
65
            x = call(edargs + [filename])
65
66
        except OSError, e:
66
 
            # We're searching for an editor, so catch safe errors and continue
67
 
            if e.errno in (errno.ENOENT, errno.EACCES):
68
 
                if candidate_source is not None:
69
 
                    # We tried this editor because some user configuration (an
70
 
                    # environment variable or config file) said to try it.  Let
71
 
                    # the user know their configuration is broken.
72
 
                    trace.warning(
73
 
                        'Could not start editor "%s" (specified by %s): %s\n'
74
 
                        % (candidate, candidate_source, str(e)))
75
 
                continue
 
67
            if candidate_source is not None:
 
68
                # We tried this editor because some user configuration (an
 
69
                # environment variable or config file) said to try it.  Let
 
70
                # the user know their configuration is broken.
 
71
                trace.warning(
 
72
                    'Could not start editor "%s" (specified by %s): %s\n'
 
73
                    % (candidate, candidate_source, str(e)))
 
74
            continue
76
75
            raise
77
76
        if x == 0:
78
77
            return True
141
140
    try:
142
141
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
143
142
                                    infotext, ignoreline, start_message)
144
 
 
145
 
        if not msgfilename or not _run_editor(msgfilename):
146
 
            return None
147
 
        
 
143
        if not msgfilename:
 
144
            return None
 
145
        basename = osutils.basename(msgfilename)
 
146
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
 
147
        reference_content = msg_transport.get_bytes(basename)
 
148
        if not _run_editor(msgfilename):
 
149
            return None
 
150
        edited_content = msg_transport.get_bytes(basename)
 
151
        if edited_content == reference_content:
 
152
            if not ui.ui_factory.get_boolean(
 
153
                "Commit message was not edited, use anyway"):
 
154
                # Returning "" makes cmd_commit raise 'empty commit message
 
155
                # specified' which is a reasonable error, given the user has
 
156
                # rejected using the unedited template.
 
157
                return ""
148
158
        started = False
149
159
        msg = []
150
160
        lastline, nlines = 0, 0
247
257
    from StringIO import StringIO       # must be unicode-safe
248
258
    from bzrlib.status import show_tree_status
249
259
    status_tmp = StringIO()
250
 
    show_tree_status(working_tree, specific_files=specific_files, 
 
260
    show_tree_status(working_tree, specific_files=specific_files,
251
261
                     to_file=status_tmp, verbose=True)
252
262
    return status_tmp.getvalue()
253
263
 
283
293
    """A dictionary mapping hook name to a list of callables for message editor
284
294
    hooks.
285
295
 
286
 
    e.g. ['commit_message_template'] is the list of items to be called to 
 
296
    e.g. ['commit_message_template'] is the list of items to be called to
287
297
    generate a commit message template
288
298
    """
289
299
 
293
303
        These are all empty initially.
294
304
        """
295
305
        Hooks.__init__(self)
296
 
        # Introduced in 1.10:
297
 
        # Invoked to generate the commit message template shown in the editor
298
 
        # The api signature is:
299
 
        # (commit, message), and the function should return the new message
300
 
        # There is currently no way to modify the order in which 
301
 
        # template hooks are invoked
302
 
        self['commit_message_template'] = []
 
306
        self.create_hook(HookPoint('commit_message_template',
 
307
            "Called when a commit message is being generated. "
 
308
            "commit_message_template is called with the bzrlib.commit.Commit "
 
309
            "object and the message that is known so far. "
 
310
            "commit_message_template must return a new message to use (which "
 
311
            "could be the same as it was given. When there are multiple "
 
312
            "hooks registered for commit_message_template, they are chained "
 
313
            "with the result from the first passed into the second, and so "
 
314
            "on.", (1, 10), None))
303
315
 
304
316
 
305
317
hooks = MessageEditorHooks()