~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Martin Pool
  • Date: 2005-05-03 07:48:54 UTC
  • Revision ID: mbp@sourcefrog.net-20050503074854-adb6f9d6382e27a9
- sketchy experiments in bash and zsh completion

Show diffs side-by-side

added added

removed removed

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