← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 07:23:36 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730072336-3e9fd7ddb67b5f47
More branding: bazaar-ng -> Bazaar; bazaar-ng.org -> bazaar-vcs.org

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
4
 
 
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
 
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
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
17
 
20
18
"""Commit message editor support."""
21
19
 
 
20
import codecs
 
21
import errno
22
22
import os
23
 
import errno
24
23
from subprocess import call
 
24
import sys
25
25
 
 
26
import bzrlib
26
27
import bzrlib.config as config
27
28
from bzrlib.errors import BzrError
 
29
from bzrlib.trace import warning, mutter
 
30
 
28
31
 
29
32
def _get_editor():
30
33
    """Return a sequence of possible editor binaries for the current platform"""
37
40
    if e is not None:
38
41
        yield e
39
42
        
40
 
    try:
41
 
        yield os.environ["EDITOR"]
42
 
    except KeyError:
43
 
        pass
 
43
    for varname in 'VISUAL', 'EDITOR':
 
44
        if os.environ.has_key(varname):
 
45
            yield os.environ[varname]
44
46
 
45
 
    if os.name == "nt":
46
 
        yield "notepad.exe"
47
 
    elif os.name == "posix":
48
 
        yield "/usr/bin/vi"
 
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
49
53
 
50
54
 
51
55
def _run_editor(filename):
53
57
    for e in _get_editor():
54
58
        edargs = e.split(' ')
55
59
        try:
 
60
            ## mutter("trying editor: %r", (edargs +[filename]))
56
61
            x = call(edargs + [filename])
57
62
        except OSError, e:
58
 
           # ENOENT means no such editor
59
 
           if e.errno == errno.ENOENT:
 
63
           # We're searching for an editor, so catch safe errors and continue
 
64
           if e.errno in (errno.ENOENT, ):
60
65
               continue
61
66
           raise
62
67
        if x == 0:
65
70
            continue
66
71
        else:
67
72
            break
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):
 
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):
73
83
    """Let the user edit a commit message in a temp file.
74
84
 
75
85
    This is run if they don't give a message or
81
91
        'bzr status'.
82
92
    """
83
93
    import tempfile
84
 
    
85
 
    if ignoreline is None:
86
 
        ignoreline = "-- This line and the following will be ignored --"
87
 
        
 
94
 
 
95
    msgfilename = None
88
96
    try:
89
97
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
90
98
        msgfile = os.close(tmp_fileno)
91
99
        if infotext is not None and infotext != "":
92
100
            hasinfo = True
93
101
            msgfile = file(msgfilename, "w")
94
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
102
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
 
103
                infotext.encode(bzrlib.user_encoding, 'replace')))
95
104
            msgfile.close()
96
105
        else:
97
106
            hasinfo = False
102
111
        started = False
103
112
        msg = []
104
113
        lastline, nlines = 0, 0
105
 
        for line in file(msgfilename, "r"):
 
114
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
106
115
            stripped_line = line.strip()
107
116
            # strip empty line before the log message starts
108
117
            if not started:
131
140
            return "".join(msg)
132
141
    finally:
133
142
        # delete the msg file in any case
134
 
        try: os.unlink(msgfilename)
135
 
        except IOError: pass
 
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)
136
148
 
137
149
 
138
150
def make_commit_message_template(working_tree, specific_files):
148
160
    # the revision to be committed, then pause and ask the user to
149
161
    # confirm/write a message.
150
162
    from StringIO import StringIO       # must be unicode-safe
151
 
    from bzrlib.status import show_status
 
163
    from bzrlib.status import show_tree_status
152
164
    status_tmp = StringIO()
153
 
    show_status(working_tree.branch, specific_files=specific_files, to_file=status_tmp)
 
165
    show_tree_status(working_tree, specific_files=specific_files, 
 
166
                     to_file=status_tmp)
154
167
    return status_tmp.getvalue()