← 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-05 04:08:03 UTC
  • Revision ID: mbp@sourcefrog.net-20050905040803-332af983e14b1072
- help on command says "usage: bzr help"

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