← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

(mbp) merge bzr.dev to 0.8, prepare for release

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:
41
43
    except KeyError:
42
44
        pass
43
45
 
44
 
    if os.name == "nt":
45
 
        yield "notepad.exe"
46
 
    elif os.name == "posix":
47
 
        yield "/usr/bin/vi"
 
46
    if sys.platform == 'win32':
 
47
        for editor in 'wordpad.exe', 'notepad.exe':
 
48
            yield editor
 
49
    else:
 
50
        for editor in ['vi', 'pico', 'nano', 'joe']:
 
51
            yield editor
48
52
 
49
53
 
50
54
def _run_editor(filename):
51
55
    """Try to execute an editor to edit the commit message."""
52
56
    for e in _get_editor():
53
57
        edargs = e.split(' ')
54
 
        x = call(edargs + [filename])
 
58
        try:
 
59
            x = call(edargs + [filename])
 
60
        except OSError, e:
 
61
           # We're searching for an editor, so catch safe errors and continue
 
62
           if e.errno in (errno.ENOENT, ):
 
63
               continue
 
64
           raise
55
65
        if x == 0:
56
66
            return True
57
67
        elif x == 127:
58
68
            continue
59
69
        else:
60
70
            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):
 
71
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
72
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
 
73
                    config.config_filename())
 
74
 
 
75
 
 
76
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
77
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
78
 
 
79
 
 
80
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
66
81
    """Let the user edit a commit message in a temp file.
67
82
 
68
83
    This is run if they don't give a message or
74
89
        'bzr status'.
75
90
    """
76
91
    import tempfile
77
 
    
78
 
    if ignoreline is None:
79
 
        ignoreline = "-- This line and the following will be ignored --"
80
 
        
 
92
 
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
127
139
        try: os.unlink(msgfilename)
128
140
        except IOError: pass
129
141
 
 
142
 
 
143
def make_commit_message_template(working_tree, specific_files):
 
144
    """Prepare a template file for a commit into a branch.
 
145
 
 
146
    Returns a unicode string containing the template.
 
147
    """
 
148
    # TODO: Should probably be given the WorkingTree not the branch
 
149
    #
 
150
    # TODO: make provision for this to be overridden or modified by a hook
 
151
    #
 
152
    # TODO: Rather than running the status command, should prepare a draft of
 
153
    # the revision to be committed, then pause and ask the user to
 
154
    # confirm/write a message.
 
155
    from StringIO import StringIO       # must be unicode-safe
 
156
    from bzrlib.status import show_tree_status
 
157
    status_tmp = StringIO()
 
158
    show_tree_status(working_tree, specific_files=specific_files, 
 
159
                     to_file=status_tmp)
 
160
    return status_tmp.getvalue()