← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Robert Collins
  • Date: 2005-10-06 22:15:52 UTC
  • mfrom: (1185.13.2)
  • mto: This revision was merged to the branch mainline in revision 1420.
  • Revision ID: robertc@robertcollins.net-20051006221552-9b15c96fa504e0ad
merge from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Bazaar-NG -- distributed version control
 
2
 
 
3
# Copyright (C) 2005 by Canonical Ltd
 
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
7
 
#
 
9
 
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
13
# GNU General Public License for more details.
12
 
#
 
14
 
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
19
 
18
20
"""Commit message editor support."""
19
21
 
20
 
import codecs
21
 
import errno
22
22
import os
23
23
from subprocess import call
24
 
import sys
25
 
 
26
 
import bzrlib
27
 
import bzrlib.config as config
28
24
from bzrlib.errors import BzrError
29
 
from bzrlib.trace import warning, mutter
30
 
 
31
25
 
32
26
def _get_editor():
33
27
    """Return a sequence of possible editor binaries for the current platform"""
 
28
    from bzrlib.osutils import _read_config_value
 
29
    
34
30
    try:
35
31
        yield os.environ["BZR_EDITOR"]
36
32
    except KeyError:
37
33
        pass
38
34
 
39
 
    e = config.GlobalConfig().get_editor()
 
35
    e = _read_config_value("editor")
40
36
    if e is not None:
41
37
        yield e
42
38
        
43
 
    for varname in 'VISUAL', 'EDITOR':
44
 
        if varname in os.environ:
45
 
            yield os.environ[varname]
 
39
    try:
 
40
        yield os.environ["EDITOR"]
 
41
    except KeyError:
 
42
        pass
46
43
 
47
 
    if sys.platform == 'win32':
48
 
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
50
 
    else:
51
 
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
 
44
    if os.name == "nt":
 
45
        yield "notepad.exe"
 
46
    elif os.name == "posix":
 
47
        yield "/usr/bin/vi"
53
48
 
54
49
 
55
50
def _run_editor(filename):
56
51
    """Try to execute an editor to edit the commit message."""
57
52
    for e in _get_editor():
58
53
        edargs = e.split(' ')
59
 
        try:
60
 
            ## mutter("trying editor: %r", (edargs +[filename]))
61
 
            x = call(edargs + [filename])
62
 
        except OSError, e:
63
 
           # We're searching for an editor, so catch safe errors and continue
64
 
           if e.errno in (errno.ENOENT, ):
65
 
               continue
66
 
           raise
 
54
        x = call(edargs + [filename])
67
55
        if x == 0:
68
56
            return True
69
57
        elif x == 127:
70
58
            continue
71
59
        else:
72
60
            break
73
 
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
74
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
75
 
                   " - $VISUAL\n - $EDITOR" % \
76
 
                    config.config_filename())
77
 
 
78
 
 
79
 
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
80
 
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
81
 
 
82
 
 
83
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
 
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):
84
66
    """Let the user edit a commit message in a temp file.
85
67
 
86
68
    This is run if they don't give a message or
92
74
        'bzr status'.
93
75
    """
94
76
    import tempfile
95
 
 
96
 
    msgfilename = None
 
77
    
 
78
    if ignoreline is None:
 
79
        ignoreline = "-- This line and the following will be ignored --"
 
80
        
97
81
    try:
98
 
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
 
82
        tmp_fileno, msgfilename = tempfile.mkstemp()
99
83
        msgfile = os.close(tmp_fileno)
100
84
        if infotext is not None and infotext != "":
101
85
            hasinfo = True
102
86
            msgfile = file(msgfilename, "w")
103
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
104
 
                infotext.encode(bzrlib.user_encoding, 'replace')))
 
87
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
105
88
            msgfile.close()
106
89
        else:
107
90
            hasinfo = False
112
95
        started = False
113
96
        msg = []
114
97
        lastline, nlines = 0, 0
115
 
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
 
98
        for line in file(msgfilename, "r"):
116
99
            stripped_line = line.strip()
117
100
            # strip empty line before the log message starts
118
101
            if not started:
141
124
            return "".join(msg)
142
125
    finally:
143
126
        # delete the msg file in any case
144
 
        if msgfilename is not None:
145
 
            try:
146
 
                os.unlink(msgfilename)
147
 
            except IOError, e:
148
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
149
 
 
150
 
 
151
 
def make_commit_message_template(working_tree, specific_files):
152
 
    """Prepare a template file for a commit into a branch.
153
 
 
154
 
    Returns a unicode string containing the template.
155
 
    """
156
 
    # TODO: Should probably be given the WorkingTree not the branch
157
 
    #
158
 
    # TODO: make provision for this to be overridden or modified by a hook
159
 
    #
160
 
    # TODO: Rather than running the status command, should prepare a draft of
161
 
    # the revision to be committed, then pause and ask the user to
162
 
    # confirm/write a message.
163
 
    from StringIO import StringIO       # must be unicode-safe
164
 
    from bzrlib.status import show_tree_status
165
 
    status_tmp = StringIO()
166
 
    show_tree_status(working_tree, specific_files=specific_files, 
167
 
                     to_file=status_tmp)
168
 
    return status_tmp.getvalue()
 
127
        try: os.unlink(msgfilename)
 
128
        except IOError: pass
 
129