← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-02-27 17:34:50 UTC
  • mfrom: (1558.1.15 Aaron's integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060227173450-dd501228d2297c7c
Whitespace fix

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
 
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 varname in os.environ:
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"
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):
 
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):
84
73
    """Let the user edit a commit message in a temp file.
85
74
 
86
75
    This is run if they don't give a message or
92
81
        'bzr status'.
93
82
    """
94
83
    import tempfile
95
 
 
96
 
    msgfilename = None
 
84
    
 
85
    if ignoreline is None:
 
86
        ignoreline = "-- This line and the following will be ignored --"
 
87
        
97
88
    try:
98
89
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
99
90
        msgfile = os.close(tmp_fileno)
100
91
        if infotext is not None and infotext != "":
101
92
            hasinfo = True
102
93
            msgfile = file(msgfilename, "w")
103
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
104
 
                infotext.encode(bzrlib.user_encoding, 'replace')))
 
94
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
105
95
            msgfile.close()
106
96
        else:
107
97
            hasinfo = False
112
102
        started = False
113
103
        msg = []
114
104
        lastline, nlines = 0, 0
115
 
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
 
105
        for line in file(msgfilename, "r"):
116
106
            stripped_line = line.strip()
117
107
            # strip empty line before the log message starts
118
108
            if not started:
141
131
            return "".join(msg)
142
132
    finally:
143
133
        # 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)
 
134
        try: os.unlink(msgfilename)
 
135
        except IOError: pass
149
136
 
150
137
 
151
138
def make_commit_message_template(working_tree, specific_files):