← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Robert Collins
  • Date: 2005-10-18 05:26:22 UTC
  • mto: This revision was merged to the branch mainline in revision 1463.
  • Revision ID: robertc@robertcollins.net-20051018052622-653d638c9e26fde4
fix broken 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
18
20
"""Commit message editor support."""
19
21
 
20
22
import os
21
 
import errno
22
23
from subprocess import call
23
24
 
24
25
import bzrlib.config as config
40
41
    except KeyError:
41
42
        pass
42
43
 
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
 
44
    if os.name == "nt":
 
45
        yield "notepad.exe"
 
46
    elif os.name == "posix":
 
47
        yield "/usr/bin/vi"
49
48
 
50
49
 
51
50
def _run_editor(filename):
52
51
    """Try to execute an editor to edit the commit message."""
53
52
    for e in _get_editor():
54
53
        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
 
54
        x = call(edargs + [filename])
62
55
        if x == 0:
63
56
            return True
64
57
        elif x == 127:
65
58
            continue
66
59
        else:
67
60
            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):
 
61
    raise BzrError("Could not start any editor. "
 
62
                   "Please specify $EDITOR or use ~/.bzr.conf/editor")
 
63
                          
 
64
 
 
65
def edit_commit_message(infotext, ignoreline=None):
78
66
    """Let the user edit a commit message in a temp file.
79
67
 
80
68
    This is run if they don't give a message or
86
74
        'bzr status'.
87
75
    """
88
76
    import tempfile
89
 
 
 
77
    
 
78
    if ignoreline is None:
 
79
        ignoreline = "-- This line and the following will be ignored --"
 
80
        
90
81
    try:
91
 
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
 
82
        tmp_fileno, msgfilename = tempfile.mkstemp()
92
83
        msgfile = os.close(tmp_fileno)
93
84
        if infotext is not None and infotext != "":
94
85
            hasinfo = True
95
86
            msgfile = file(msgfilename, "w")
96
 
            msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
 
87
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
97
88
            msgfile.close()
98
89
        else:
99
90
            hasinfo = False
136
127
        try: os.unlink(msgfilename)
137
128
        except IOError: pass
138
129
 
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()