← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

Late bind to PatienceSequenceMatcher in merge3.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
4
2
 
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
19
17
 
20
18
"""Commit message editor support."""
21
19
 
 
20
 
 
21
import errno
22
22
import os
23
23
from subprocess import call
 
24
import sys
24
25
 
25
26
import bzrlib.config as config
26
27
from bzrlib.errors import BzrError
27
28
 
 
29
 
28
30
def _get_editor():
29
31
    """Return a sequence of possible editor binaries for the current platform"""
30
32
    try:
36
38
    if e is not None:
37
39
        yield e
38
40
        
39
 
    try:
40
 
        yield os.environ["EDITOR"]
41
 
    except KeyError:
42
 
        pass
 
41
    for varname in 'VISUAL', 'EDITOR':
 
42
        if os.environ.has_key(varname):
 
43
            yield os.environ[varname]
43
44
 
44
 
    if os.name == "nt":
45
 
        yield "notepad.exe"
46
 
    elif os.name == "posix":
47
 
        yield "/usr/bin/vi"
 
45
    if sys.platform == 'win32':
 
46
        for editor in 'wordpad.exe', 'notepad.exe':
 
47
            yield editor
 
48
    else:
 
49
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
 
50
            yield editor
48
51
 
49
52
 
50
53
def _run_editor(filename):
51
54
    """Try to execute an editor to edit the commit message."""
52
55
    for e in _get_editor():
53
56
        edargs = e.split(' ')
54
 
        x = call(edargs + [filename])
 
57
        try:
 
58
            x = call(edargs + [filename])
 
59
        except OSError, e:
 
60
           # We're searching for an editor, so catch safe errors and continue
 
61
           if e.errno in (errno.ENOENT, ):
 
62
               continue
 
63
           raise
55
64
        if x == 0:
56
65
            return True
57
66
        elif x == 127:
58
67
            continue
59
68
        else:
60
69
            break
61
 
    raise BzrError("Could not start any editor. "
62
 
                   "Please specify $EDITOR or use ~/.bzr.conf/editor")
63
 
                          
64
 
 
65
 
def edit_commit_message(infotext, ignoreline=None):
 
70
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
71
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
 
72
                    config.config_filename())
 
73
 
 
74
 
 
75
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
76
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
77
 
 
78
 
 
79
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
66
80
    """Let the user edit a commit message in a temp file.
67
81
 
68
82
    This is run if they don't give a message or
74
88
        'bzr status'.
75
89
    """
76
90
    import tempfile
77
 
    
78
 
    if ignoreline is None:
79
 
        ignoreline = "-- This line and the following will be ignored --"
80
 
        
 
91
 
 
92
    msgfilename = None
81
93
    try:
82
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
94
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
83
95
        msgfile = os.close(tmp_fileno)
84
96
        if infotext is not None and infotext != "":
85
97
            hasinfo = True
86
98
            msgfile = file(msgfilename, "w")
87
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
99
            msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
88
100
            msgfile.close()
89
101
        else:
90
102
            hasinfo = False
124
136
            return "".join(msg)
125
137
    finally:
126
138
        # delete the msg file in any case
127
 
        try: os.unlink(msgfilename)
128
 
        except IOError: pass
129
 
 
 
139
        if msgfilename is not None:
 
140
            try:
 
141
                os.unlink(msgfilename)
 
142
            except IOError, e:
 
143
                mutter("failed to unlink %s: %s; ignored", msgfilename, e)
 
144
 
 
145
 
 
146
def make_commit_message_template(working_tree, specific_files):
 
147
    """Prepare a template file for a commit into a branch.
 
148
 
 
149
    Returns a unicode string containing the template.
 
150
    """
 
151
    # TODO: Should probably be given the WorkingTree not the branch
 
152
    #
 
153
    # TODO: make provision for this to be overridden or modified by a hook
 
154
    #
 
155
    # TODO: Rather than running the status command, should prepare a draft of
 
156
    # the revision to be committed, then pause and ask the user to
 
157
    # confirm/write a message.
 
158
    from StringIO import StringIO       # must be unicode-safe
 
159
    from bzrlib.status import show_tree_status
 
160
    status_tmp = StringIO()
 
161
    show_tree_status(working_tree, specific_files=specific_files, 
 
162
                     to_file=status_tmp)
 
163
    return status_tmp.getvalue()