← 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-16 05:20:50 UTC
  • Revision ID: mbp@sourcefrog.net-20050916052050-eb836e24235c1795
- more commit ancestry tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
 
1
# Bazaar-NG -- distributed version control
 
2
 
 
3
# Copyright (C) 2005 by Canonical Ltd
2
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
17
19
 
18
20
"""Commit message editor support."""
19
21
 
20
 
 
21
 
import errno
22
22
import os
23
 
from subprocess import call
24
 
import sys
25
 
 
26
 
import bzrlib.config as config
27
23
from bzrlib.errors import BzrError
28
24
 
29
 
 
30
25
def _get_editor():
31
26
    """Return a sequence of possible editor binaries for the current platform"""
32
 
    try:
33
 
        yield os.environ["BZR_EDITOR"]
34
 
    except KeyError:
35
 
        pass
36
 
 
37
 
    e = config.GlobalConfig().get_editor()
 
27
    from bzrlib.osutils import _read_config_value
 
28
    
 
29
    e = _read_config_value("editor")
38
30
    if e is not None:
39
31
        yield e
40
32
        
41
 
    for varname in 'VISUAL', 'EDITOR':
42
 
        if os.environ.has_key(varname):
43
 
            yield os.environ[varname]
44
 
 
45
 
    if sys.platform == 'win32':
46
 
        for editor in 'wordpad.exe', 'notepad.exe':
47
 
            yield editor
48
 
    else:
49
 
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
50
 
            yield editor
 
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"
51
40
 
52
41
 
53
42
def _run_editor(filename):
54
43
    """Try to execute an editor to edit the commit message."""
55
44
    for e in _get_editor():
56
45
        edargs = e.split(' ')
57
 
        try:
58
 
            x = call(edargs + [filename])
59
 
        except OSError, e:
60
 
           # We're searching for an editor, so catch safe errors and continue
61
 
           if e.errno in (errno.ENOENT, ):
62
 
               continue
63
 
           raise
 
46
        x = os.spawnvp(os.P_WAIT, edargs[0],
 
47
                       edargs + [filename])
64
48
        if x == 0:
65
49
            return True
66
50
        elif x == 127:
67
51
            continue
68
52
        else:
69
53
            break
70
 
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
71
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
72
 
                    config.config_filename())
73
 
 
74
 
 
75
 
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
76
 
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
77
 
 
78
 
 
79
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
 
54
    raise BzrError("Could not start any editor. "
 
55
                   "Please specify $EDITOR or use ~/.bzr.conf/editor")
 
56
                          
 
57
 
 
58
def edit_commit_message(infotext, ignoreline=None):
80
59
    """Let the user edit a commit message in a temp file.
81
60
 
82
61
    This is run if they don't give a message or
88
67
        'bzr status'.
89
68
    """
90
69
    import tempfile
91
 
 
92
 
    msgfilename = None
 
70
    
 
71
    if ignoreline is None:
 
72
        ignoreline = "-- This line and the following will be ignored --"
 
73
        
93
74
    try:
94
 
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
 
75
        tmp_fileno, msgfilename = tempfile.mkstemp()
95
76
        msgfile = os.close(tmp_fileno)
96
77
        if infotext is not None and infotext != "":
97
78
            hasinfo = True
98
79
            msgfile = file(msgfilename, "w")
99
 
            msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
 
80
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
100
81
            msgfile.close()
101
82
        else:
102
83
            hasinfo = False
126
107
            msg.append(line)
127
108
            
128
109
        if len(msg) == 0:
129
 
            return ""
 
110
            return None
130
111
        # delete empty lines at the end
131
112
        del msg[lastline:]
132
113
        # add a newline at the end, if needed
136
117
            return "".join(msg)
137
118
    finally:
138
119
        # delete the msg file in any case
139
 
        if msgfilename is not None:
140
 
            try:
141
 
                os.unlink(msgfilename)
142
 
            except IOError, e:
143
 
                mutter("failed to unlink %s: %s; ignored", msgfilename, e)
144
 
 
145
 
 
146
 
def make_commit_message_template(working_tree, specific_files):
147
 
    """Prepare a template file for a commit into a branch.
148
 
 
149
 
    Returns a unicode string containing the template.
150
 
    """
151
 
    # TODO: Should probably be given the WorkingTree not the branch
152
 
    #
153
 
    # TODO: make provision for this to be overridden or modified by a hook
154
 
    #
155
 
    # TODO: Rather than running the status command, should prepare a draft of
156
 
    # the revision to be committed, then pause and ask the user to
157
 
    # confirm/write a message.
158
 
    from StringIO import StringIO       # must be unicode-safe
159
 
    from bzrlib.status import show_tree_status
160
 
    status_tmp = StringIO()
161
 
    show_tree_status(working_tree, specific_files=specific_files, 
162
 
                     to_file=status_tmp)
163
 
    return status_tmp.getvalue()
 
120
        try: os.unlink(msgfilename)
 
121
        except IOError: pass
 
122