← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-09 15:09:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3699.
  • Revision ID: john@arbash-meinel.com-20080909150912-wyttm8he1zsls2ck
Use the right timing function on win32

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
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
 
18
18
"""Commit message editor support."""
23
23
from subprocess import call
24
24
import sys
25
25
 
26
 
from bzrlib import (
27
 
    config,
28
 
    osutils,
29
 
    trace,
30
 
    )
 
26
import bzrlib
 
27
import bzrlib.config as config
 
28
from bzrlib import osutils
31
29
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
 
from bzrlib.hooks import HookPoint, Hooks
 
30
from bzrlib.trace import warning, mutter
33
31
 
34
32
 
35
33
def _get_editor():
36
34
    """Return a sequence of possible editor binaries for the current platform"""
37
35
    try:
38
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
36
        yield os.environ["BZR_EDITOR"]
39
37
    except KeyError:
40
38
        pass
41
39
 
42
40
    e = config.GlobalConfig().get_editor()
43
41
    if e is not None:
44
 
        yield e, config.config_filename()
45
 
 
 
42
        yield e
 
43
        
46
44
    for varname in 'VISUAL', 'EDITOR':
47
45
        if varname in os.environ:
48
 
            yield os.environ[varname], '$' + varname
 
46
            yield os.environ[varname]
49
47
 
50
48
    if sys.platform == 'win32':
51
49
        for editor in 'wordpad.exe', 'notepad.exe':
52
 
            yield editor, None
 
50
            yield editor
53
51
    else:
54
52
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
55
 
            yield editor, None
 
53
            yield editor
56
54
 
57
55
 
58
56
def _run_editor(filename):
59
57
    """Try to execute an editor to edit the commit message."""
60
 
    for candidate, candidate_source in _get_editor():
61
 
        edargs = candidate.split(' ')
 
58
    for e in _get_editor():
 
59
        edargs = e.split(' ')
62
60
        try:
63
61
            ## mutter("trying editor: %r", (edargs +[filename]))
64
62
            x = call(edargs + [filename])
65
63
        except OSError, e:
66
64
            # 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)))
 
65
            if e.errno in (errno.ENOENT, ):
75
66
                continue
76
67
            raise
77
68
        if x == 0:
111
102
    """
112
103
 
113
104
    if not start_message is None:
114
 
        start_message = start_message.encode(osutils.get_user_encoding())
115
 
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
 
105
        start_message = start_message.encode(bzrlib.user_encoding)
 
106
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
116
107
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
117
108
 
118
109
 
144
135
 
145
136
        if not msgfilename or not _run_editor(msgfilename):
146
137
            return None
147
 
 
 
138
        
148
139
        started = False
149
140
        msg = []
150
141
        lastline, nlines = 0, 0
153
144
        f = file(msgfilename, 'rU')
154
145
        try:
155
146
            try:
156
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
147
                for line in codecs.getreader(bzrlib.user_encoding)(f):
157
148
                    stripped_line = line.strip()
158
149
                    # strip empty line before the log message starts
159
150
                    if not started:
190
181
            try:
191
182
                os.unlink(msgfilename)
192
183
            except IOError, e:
193
 
                trace.warning(
194
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
184
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
195
185
 
196
186
 
197
187
def _create_temp_file_with_commit_template(infotext,
247
237
    from StringIO import StringIO       # must be unicode-safe
248
238
    from bzrlib.status import show_tree_status
249
239
    status_tmp = StringIO()
250
 
    show_tree_status(working_tree, specific_files=specific_files,
251
 
                     to_file=status_tmp, verbose=True)
 
240
    show_tree_status(working_tree, specific_files=specific_files, 
 
241
                     to_file=status_tmp)
252
242
    return status_tmp.getvalue()
253
243
 
254
244
 
277
267
        template = template + '\n' + stream.getvalue()
278
268
 
279
269
    return template
280
 
 
281
 
 
282
 
class MessageEditorHooks(Hooks):
283
 
    """A dictionary mapping hook name to a list of callables for message editor
284
 
    hooks.
285
 
 
286
 
    e.g. ['commit_message_template'] is the list of items to be called to
287
 
    generate a commit message template
288
 
    """
289
 
 
290
 
    def __init__(self):
291
 
        """Create the default hooks.
292
 
 
293
 
        These are all empty initially.
294
 
        """
295
 
        Hooks.__init__(self)
296
 
        self.create_hook(HookPoint('commit_message_template',
297
 
            "Called when a commit message is being generated. "
298
 
            "commit_message_template is called with the bzrlib.commit.Commit "
299
 
            "object and the message that is known so far. "
300
 
            "commit_message_template must return a new message to use (which "
301
 
            "could be the same as it was given. When there are multiple "
302
 
            "hooks registered for commit_message_template, they are chained "
303
 
            "with the result from the first passed into the second, and so "
304
 
            "on.", (1, 10), None))
305
 
 
306
 
 
307
 
hooks = MessageEditorHooks()
308
 
 
309
 
 
310
 
def generate_commit_message_template(commit, start_message=None):
311
 
    """Generate a commit message template.
312
 
 
313
 
    :param commit: Commit object for the active commit.
314
 
    :param start_message: Message to start with.
315
 
    :return: A start commit message or None for an empty start commit message.
316
 
    """
317
 
    start_message = None
318
 
    for hook in hooks['commit_message_template']:
319
 
        start_message = hook(commit, start_message)
320
 
    return start_message