← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Martin Pool
  • Date: 2005-09-01 11:19:08 UTC
  • Revision ID: mbp@sourcefrog.net-20050901111907-ff5ac13ee6fedc85
- split commit message editor functions out into own file

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
 
 
5
# This program is free software; you can redistribute it and/or modify
 
6
# it under the terms of the GNU General Public License as published by
 
7
# the Free Software Foundation; either version 2 of the License, or
 
8
# (at your option) any later version.
 
9
 
 
10
# This program is distributed in the hope that it will be useful,
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
# GNU General Public License for more details.
 
14
 
 
15
# You should have received a copy of the GNU General Public License
 
16
# along with this program; if not, write to the Free Software
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
18
 
 
19
 
 
20
"""Commit message editor support."""
 
21
 
 
22
import os
 
23
from bzrlib.errors import BzrError
 
24
 
 
25
def _get_editor():
 
26
    """Return a sequence of possible editor binaries for the current platform"""
 
27
    from bzrlib.osutils import _read_config_value
 
28
    
 
29
    e = _read_config_value("editor")
 
30
    if e is not None:
 
31
        yield e
 
32
        
 
33
    if os.name == "windows":
 
34
        yield "notepad.exe"
 
35
    elif os.name == "posix":
 
36
        try:
 
37
            yield os.environ["EDITOR"]
 
38
        except KeyError:
 
39
            yield "/usr/bin/vi"
 
40
 
 
41
 
 
42
def _run_editor(filename):
 
43
    """Try to execute an editor to edit the commit message. Returns True on success,
 
44
    False on failure"""
 
45
    for e in _get_editor():
 
46
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
 
47
        if x == 0:
 
48
            return True
 
49
        elif x == 127:
 
50
            continue
 
51
        else:
 
52
            break
 
53
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
 
54
    return False
 
55
                          
 
56
 
 
57
def edit_commit_message(infotext, ignoreline=None):
 
58
    """Let the user edit a commit message in a temp file.
 
59
 
 
60
    This is run if they don't give a message or
 
61
    message-containing file on the command line.
 
62
 
 
63
    infotext:
 
64
        Text to be displayed at bottom of message for
 
65
        the user's reference; currently similar to
 
66
        'bzr status'.
 
67
    """
 
68
    import tempfile
 
69
    
 
70
    if ignoreline is None:
 
71
        ignoreline = "-- This line and the following will be ignored --"
 
72
        
 
73
    try:
 
74
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
75
        msgfile = os.close(tmp_fileno)
 
76
        if infotext is not None and infotext != "":
 
77
            hasinfo = True
 
78
            msgfile = file(msgfilename, "w")
 
79
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
80
            msgfile.close()
 
81
        else:
 
82
            hasinfo = False
 
83
 
 
84
        if not _run_editor(msgfilename):
 
85
            return None
 
86
        
 
87
        started = False
 
88
        msg = []
 
89
        lastline, nlines = 0, 0
 
90
        for line in file(msgfilename, "r"):
 
91
            stripped_line = line.strip()
 
92
            # strip empty line before the log message starts
 
93
            if not started:
 
94
                if stripped_line != "":
 
95
                    started = True
 
96
                else:
 
97
                    continue
 
98
            # check for the ignore line only if there
 
99
            # is additional information at the end
 
100
            if hasinfo and stripped_line == ignoreline:
 
101
                break
 
102
            nlines += 1
 
103
            # keep track of the last line that had some content
 
104
            if stripped_line != "":
 
105
                lastline = nlines
 
106
            msg.append(line)
 
107
            
 
108
        if len(msg) == 0:
 
109
            return None
 
110
        # delete empty lines at the end
 
111
        del msg[lastline:]
 
112
        # add a newline at the end, if needed
 
113
        if not msg[-1].endswith("\n"):
 
114
            return "%s%s" % ("".join(msg), "\n")
 
115
        else:
 
116
            return "".join(msg)
 
117
    finally:
 
118
        # delete the msg file in any case
 
119
        try: os.unlink(msgfilename)
 
120
        except IOError: pass
 
121