← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: John Arbash Meinel
  • Date: 2006-07-27 18:14:48 UTC
  • mto: (1946.2.6 reduce-knit-churn)
  • mto: This revision was merged to the branch mainline in revision 1887.
  • Revision ID: john@arbash-meinel.com-20060727181448-62962f823be5d3cc
minor typo fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
41
41
        yield e
42
42
        
43
43
    for varname in 'VISUAL', 'EDITOR':
44
 
        if varname in os.environ:
 
44
        if os.environ.has_key(varname):
45
45
            yield os.environ[varname]
46
46
 
47
47
    if sys.platform == 'win32':
71
71
        else:
72
72
            break
73
73
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
74
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
75
 
                   " - $VISUAL\n - $EDITOR" % \
 
74
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
76
75
                    config.config_filename())
77
76
 
78
77
 
80
79
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
81
80
 
82
81
 
83
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
84
 
                        start_message=None):
 
82
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
85
83
    """Let the user edit a commit message in a temp file.
86
84
 
87
85
    This is run if they don't give a message or
88
86
    message-containing file on the command line.
89
87
 
90
 
    :param infotext:    Text to be displayed at bottom of message
91
 
                        for the user's reference;
92
 
                        currently similar to 'bzr status'.
93
 
 
94
 
    :param ignoreline:  The separator to use above the infotext.
95
 
 
96
 
    :param start_message:   The text to place above the separator, if any.
97
 
                            This will not be removed from the message
98
 
                            after the user has edited it.
99
 
 
100
 
    :return:    commit message or None.
 
88
    infotext:
 
89
        Text to be displayed at bottom of message for
 
90
        the user's reference; currently similar to
 
91
        'bzr status'.
101
92
    """
 
93
    import tempfile
 
94
 
102
95
    msgfilename = None
103
96
    try:
104
 
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
105
 
                                    infotext, ignoreline, start_message)
 
97
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
 
98
        msgfile = os.close(tmp_fileno)
 
99
        if infotext is not None and infotext != "":
 
100
            hasinfo = True
 
101
            msgfile = file(msgfilename, "w")
 
102
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
 
103
                infotext.encode(bzrlib.user_encoding, 'replace')))
 
104
            msgfile.close()
 
105
        else:
 
106
            hasinfo = False
106
107
 
107
 
        if not msgfilename or not _run_editor(msgfilename):
 
108
        if not _run_editor(msgfilename):
108
109
            return None
109
110
        
110
111
        started = False
111
112
        msg = []
112
113
        lastline, nlines = 0, 0
113
 
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
114
 
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
115
 
        f = file(msgfilename, 'rU')
116
 
        for line in codecs.getreader(bzrlib.user_encoding)(f):
 
114
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
117
115
            stripped_line = line.strip()
118
116
            # strip empty line before the log message starts
119
117
            if not started:
130
128
            if stripped_line != "":
131
129
                lastline = nlines
132
130
            msg.append(line)
133
 
        f.close()
134
 
 
 
131
            
135
132
        if len(msg) == 0:
136
133
            return ""
137
134
        # delete empty lines at the end
150
147
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
151
148
 
152
149
 
153
 
def _create_temp_file_with_commit_template(infotext,
154
 
                                           ignoreline=DEFAULT_IGNORE_LINE,
155
 
                                           start_message=None):
156
 
    """Create temp file and write commit template in it.
157
 
 
158
 
    :param infotext:    Text to be displayed at bottom of message
159
 
                        for the user's reference;
160
 
                        currently similar to 'bzr status'.
161
 
 
162
 
    :param ignoreline:  The separator to use above the infotext.
163
 
 
164
 
    :param start_message:   The text to place above the separator, if any.
165
 
                            This will not be removed from the message
166
 
                            after the user has edited it.
167
 
 
168
 
    :return:    2-tuple (temp file name, hasinfo)
169
 
    """
170
 
    import tempfile
171
 
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
172
 
                                               dir=u'.',
173
 
                                               text=True)
174
 
    msgfile = os.fdopen(tmp_fileno, 'w')
175
 
    try:
176
 
        if start_message is not None:
177
 
            msgfile.write("%s\n" % start_message.encode(
178
 
                                       bzrlib.user_encoding, 'replace'))
179
 
 
180
 
        if infotext is not None and infotext != "":
181
 
            hasinfo = True
182
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
183
 
                          infotext.encode(bzrlib.user_encoding,
184
 
                                                'replace')))
185
 
        else:
186
 
            hasinfo = False
187
 
    finally:
188
 
        msgfile.close()
189
 
 
190
 
    return (msgfilename, hasinfo)
191
 
 
192
 
 
193
150
def make_commit_message_template(working_tree, specific_files):
194
151
    """Prepare a template file for a commit into a branch.
195
152