← 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: 2006-02-26 07:54:02 UTC
  • mto: (1587.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1588.
  • Revision ID: robertc@robertcollins.net-20060226075402-92fca9fdb7b0070d
Check for incorrect revision parentage in the weave during revision access.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 by 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
 
22
import os
21
23
import errno
22
 
import os
23
24
from subprocess import call
24
 
import sys
25
25
 
26
 
import bzrlib
27
26
import bzrlib.config as config
28
27
from bzrlib.errors import BzrError
29
 
from bzrlib.trace import warning, mutter
30
 
 
31
28
 
32
29
def _get_editor():
33
30
    """Return a sequence of possible editor binaries for the current platform"""
40
37
    if e is not None:
41
38
        yield e
42
39
        
43
 
    for varname in 'VISUAL', 'EDITOR':
44
 
        if os.environ.has_key(varname):
45
 
            yield os.environ[varname]
 
40
    try:
 
41
        yield os.environ["EDITOR"]
 
42
    except KeyError:
 
43
        pass
46
44
 
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
 
45
    if os.name == "nt":
 
46
        yield "notepad.exe"
 
47
    elif os.name == "posix":
 
48
        yield "/usr/bin/vi"
53
49
 
54
50
 
55
51
def _run_editor(filename):
57
53
    for e in _get_editor():
58
54
        edargs = e.split(' ')
59
55
        try:
60
 
            ## mutter("trying editor: %r", (edargs +[filename]))
61
56
            x = call(edargs + [filename])
62
57
        except OSError, e:
63
 
           # We're searching for an editor, so catch safe errors and continue
64
 
           if e.errno in (errno.ENOENT, ):
 
58
           # ENOENT means no such editor
 
59
           if e.errno == errno.ENOENT:
65
60
               continue
66
61
           raise
67
62
        if x == 0:
70
65
            continue
71
66
        else:
72
67
            break
73
 
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
74
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
75
 
                    config.config_filename())
76
 
 
77
 
 
78
 
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
79
 
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
80
 
 
81
 
 
82
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
 
68
    raise BzrError("Could not start any editor. "
 
69
                   "Please specify $EDITOR or use ~/.bzr.conf/editor")
 
70
                          
 
71
 
 
72
def edit_commit_message(infotext, ignoreline=None):
83
73
    """Let the user edit a commit message in a temp file.
84
74
 
85
75
    This is run if they don't give a message or
91
81
        'bzr status'.
92
82
    """
93
83
    import tempfile
94
 
 
95
 
    msgfilename = None
 
84
    
 
85
    if ignoreline is None:
 
86
        ignoreline = "-- This line and the following will be ignored --"
 
87
        
96
88
    try:
97
89
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
98
90
        msgfile = os.close(tmp_fileno)
99
91
        if infotext is not None and infotext != "":
100
92
            hasinfo = True
101
93
            msgfile = file(msgfilename, "w")
102
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
103
 
                infotext.encode(bzrlib.user_encoding, 'replace')))
 
94
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
104
95
            msgfile.close()
105
96
        else:
106
97
            hasinfo = False
111
102
        started = False
112
103
        msg = []
113
104
        lastline, nlines = 0, 0
114
 
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
 
105
        for line in file(msgfilename, "r"):
115
106
            stripped_line = line.strip()
116
107
            # strip empty line before the log message starts
117
108
            if not started:
140
131
            return "".join(msg)
141
132
    finally:
142
133
        # delete the msg file in any case
143
 
        if msgfilename is not None:
144
 
            try:
145
 
                os.unlink(msgfilename)
146
 
            except IOError, e:
147
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
134
        try: os.unlink(msgfilename)
 
135
        except IOError: pass
148
136
 
149
137
 
150
138
def make_commit_message_template(working_tree, specific_files):
160
148
    # the revision to be committed, then pause and ask the user to
161
149
    # confirm/write a message.
162
150
    from StringIO import StringIO       # must be unicode-safe
163
 
    from bzrlib.status import show_tree_status
 
151
    from bzrlib.status import show_status
164
152
    status_tmp = StringIO()
165
 
    show_tree_status(working_tree, specific_files=specific_files, 
166
 
                     to_file=status_tmp)
 
153
    show_status(working_tree.branch, specific_files=specific_files, to_file=status_tmp)
167
154
    return status_tmp.getvalue()