← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/patches.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/patches.py
1
 
# Copyright (C) 2004 - 2006 Aaron Bentley
 
1
# Copyright (C) 2004 - 2006, 2008 Aaron Bentley, Canonical Ltd
2
2
# <aaron.bentley@utoronto.ca>
3
3
#
4
 
#    This program is free software; you can redistribute it and/or modify
5
 
#    it under the terms of the GNU General Public License as published by
6
 
#    the Free Software Foundation; either version 2 of the License, or
7
 
#    (at your option) any later version.
8
 
#
9
 
#    This program is distributed in the hope that it will be useful,
10
 
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
#    GNU General Public License for more details.
13
 
#
14
 
#    You should have received a copy of the GNU General Public License
15
 
#    along with this program; if not, write to the Free Software
16
 
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
import re
 
18
 
 
19
 
 
20
class BinaryFiles(Exception):
 
21
 
 
22
    def __init__(self, orig_name, mod_name):
 
23
        self.orig_name = orig_name
 
24
        self.mod_name = mod_name
 
25
        Exception.__init__(self, 'Binary files section encountered.')
17
26
 
18
27
 
19
28
class PatchSyntax(Exception):
57
66
def get_patch_names(iter_lines):
58
67
    try:
59
68
        line = iter_lines.next()
 
69
        match = re.match('Binary files (.*) and (.*) differ\n', line)
 
70
        if match is not None:
 
71
            raise BinaryFiles(match.group(1), match.group(2))
60
72
        if not line.startswith("--- "):
61
73
            raise MalformedPatchHeader("No orig name", line)
62
74
        else:
92
104
    range = int(range)
93
105
    return (pos, range)
94
106
 
95
 
 
 
107
 
96
108
def hunk_from_header(line):
97
 
    if not line.startswith("@@") or not line.endswith("@@\n") \
98
 
        or not len(line) > 4:
99
 
        raise MalformedHunkHeader("Does not start and end with @@.", line)
 
109
    import re
 
110
    matches = re.match(r'\@\@ ([^@]*) \@\@( (.*))?\n', line)
 
111
    if matches is None:
 
112
        raise MalformedHunkHeader("Does not match format.", line)
100
113
    try:
101
 
        (orig, mod) = line[3:-4].split(" ")
102
 
    except Exception, e:
 
114
        (orig, mod) = matches.group(1).split(" ")
 
115
    except (ValueError, IndexError), e:
103
116
        raise MalformedHunkHeader(str(e), line)
104
117
    if not orig.startswith('-') or not mod.startswith('+'):
105
118
        raise MalformedHunkHeader("Positions don't start with + or -.", line)
106
119
    try:
107
120
        (orig_pos, orig_range) = parse_range(orig[1:])
108
121
        (mod_pos, mod_range) = parse_range(mod[1:])
109
 
    except Exception, e:
 
122
    except (ValueError, IndexError), e:
110
123
        raise MalformedHunkHeader(str(e), line)
111
124
    if mod_range < 0 or orig_range < 0:
112
125
        raise MalformedHunkHeader("Hunk range is negative", line)
113
 
    return Hunk(orig_pos, orig_range, mod_pos, mod_range)
 
126
    tail = matches.group(3)
 
127
    return Hunk(orig_pos, orig_range, mod_pos, mod_range, tail)
114
128
 
115
129
 
116
130
class HunkLine:
162
176
        return InsertLine(line[1:])
163
177
    elif line.startswith("-"):
164
178
        return RemoveLine(line[1:])
165
 
    elif line == NO_NL:
166
 
        return NO_NL
167
179
    else:
168
180
        raise MalformedLine("Unknown line type", line)
169
181
__pychecker__=""
170
182
 
171
183
 
172
184
class Hunk:
173
 
    def __init__(self, orig_pos, orig_range, mod_pos, mod_range):
 
185
    def __init__(self, orig_pos, orig_range, mod_pos, mod_range, tail=None):
174
186
        self.orig_pos = orig_pos
175
187
        self.orig_range = orig_range
176
188
        self.mod_pos = mod_pos
177
189
        self.mod_range = mod_range
 
190
        self.tail = tail
178
191
        self.lines = []
179
192
 
180
193
    def get_header(self):
181
 
        return "@@ -%s +%s @@\n" % (self.range_str(self.orig_pos, 
182
 
                                                   self.orig_range),
183
 
                                    self.range_str(self.mod_pos, 
184
 
                                                   self.mod_range))
 
194
        if self.tail is None:
 
195
            tail_str = ''
 
196
        else:
 
197
            tail_str = ' ' + self.tail
 
198
        return "@@ -%s +%s @@%s\n" % (self.range_str(self.orig_pos,
 
199
                                                     self.orig_range),
 
200
                                      self.range_str(self.mod_pos,
 
201
                                                     self.mod_range),
 
202
                                      tail_str)
185
203
 
186
204
    def range_str(self, pos, range):
187
205
        """Return a file range, special-casing for 1-line files.
212
230
            return self.shift_to_mod_lines(pos)
213
231
 
214
232
    def shift_to_mod_lines(self, pos):
215
 
        assert (pos >= self.orig_pos-1 and pos <= self.orig_pos+self.orig_range)
216
233
        position = self.orig_pos-1
217
234
        shift = 0
218
235
        for line in self.lines:
254
271
        yield hunk
255
272
 
256
273
 
257
 
class Patch:
 
274
class BinaryPatch(object):
258
275
    def __init__(self, oldname, newname):
259
276
        self.oldname = oldname
260
277
        self.newname = newname
 
278
 
 
279
    def __str__(self):
 
280
        return 'Binary files %s and %s differ\n' % (self.oldname, self.newname)
 
281
 
 
282
 
 
283
class Patch(BinaryPatch):
 
284
 
 
285
    def __init__(self, oldname, newname):
 
286
        BinaryPatch.__init__(self, oldname, newname)
261
287
        self.hunks = []
262
288
 
263
289
    def __str__(self):
264
 
        ret = self.get_header() 
 
290
        ret = self.get_header()
265
291
        ret += "".join([str(h) for h in self.hunks])
266
292
        return ret
267
293
 
268
294
    def get_header(self):
269
295
        return "--- %s\n+++ %s\n" % (self.oldname, self.newname)
270
296
 
271
 
    def stats_str(self):
272
 
        """Return a string of patch statistics"""
 
297
    def stats_values(self):
 
298
        """Calculate the number of inserts and removes."""
273
299
        removes = 0
274
300
        inserts = 0
275
301
        for hunk in self.hunks:
278
304
                     inserts+=1;
279
305
                elif isinstance(line, RemoveLine):
280
306
                     removes+=1;
 
307
        return (inserts, removes, len(self.hunks))
 
308
 
 
309
    def stats_str(self):
 
310
        """Return a string of patch statistics"""
281
311
        return "%i inserts, %i removes in %i hunks" % \
282
 
            (inserts, removes, len(self.hunks))
 
312
            self.stats_values()
283
313
 
284
314
    def pos_in_mod(self, position):
285
315
        newpos = position
289
319
                return None
290
320
            newpos += shift
291
321
        return newpos
292
 
            
 
322
 
293
323
    def iter_inserted(self):
294
324
        """Iteraties through inserted lines
295
 
        
 
325
 
296
326
        :return: Pair of line number, line
297
327
        :rtype: iterator of (int, InsertLine)
298
328
        """
307
337
 
308
338
 
309
339
def parse_patch(iter_lines):
310
 
    (orig_name, mod_name) = get_patch_names(iter_lines)
311
 
    patch = Patch(orig_name, mod_name)
312
 
    for hunk in iter_hunks(iter_lines):
313
 
        patch.hunks.append(hunk)
314
 
    return patch
 
340
    iter_lines = iter_lines_handle_nl(iter_lines)
 
341
    try:
 
342
        (orig_name, mod_name) = get_patch_names(iter_lines)
 
343
    except BinaryFiles, e:
 
344
        return BinaryPatch(e.orig_name, e.mod_name)
 
345
    else:
 
346
        patch = Patch(orig_name, mod_name)
 
347
        for hunk in iter_hunks(iter_lines):
 
348
            patch.hunks.append(hunk)
 
349
        return patch
315
350
 
316
351
 
317
352
def iter_file_patch(iter_lines):
318
353
    saved_lines = []
 
354
    orig_range = 0
319
355
    for line in iter_lines:
320
356
        if line.startswith('=== ') or line.startswith('*** '):
321
357
            continue
322
358
        if line.startswith('#'):
323
359
            continue
 
360
        elif orig_range > 0:
 
361
            if line.startswith('-') or line.startswith(' '):
 
362
                orig_range -= 1
324
363
        elif line.startswith('--- '):
325
364
            if len(saved_lines) > 0:
326
365
                yield saved_lines
327
366
            saved_lines = []
 
367
        elif line.startswith('@@'):
 
368
            hunk = hunk_from_header(line)
 
369
            orig_range = hunk.orig_range
328
370
        saved_lines.append(line)
329
371
    if len(saved_lines) > 0:
330
372
        yield saved_lines
340
382
    last_line = None
341
383
    for line in iter_lines:
342
384
        if line == NO_NL:
343
 
            assert last_line.endswith('\n')
 
385
            if not last_line.endswith('\n'):
 
386
                raise AssertionError()
344
387
            last_line = last_line[:-1]
345
388
            line = None
346
389
        if last_line is not None:
351
394
 
352
395
 
353
396
def parse_patches(iter_lines):
354
 
    iter_lines = iter_lines_handle_nl(iter_lines)
355
397
    return [parse_patch(f.__iter__()) for f in iter_file_patch(iter_lines)]
356
398
 
357
399
 
378
420
    """Iterate through a series of lines with a patch applied.
379
421
    This handles a single file, and does exact, not fuzzy patching.
380
422
    """
381
 
    if orig_lines is not None:
382
 
        orig_lines = orig_lines.__iter__()
 
423
    patch_lines = iter_lines_handle_nl(iter(patch_lines))
 
424
    get_patch_names(patch_lines)
 
425
    return iter_patched_from_hunks(orig_lines, iter_hunks(patch_lines))
 
426
 
 
427
 
 
428
def iter_patched_from_hunks(orig_lines, hunks):
 
429
    """Iterate through a series of lines with a patch applied.
 
430
    This handles a single file, and does exact, not fuzzy patching.
 
431
 
 
432
    :param orig_lines: The unpatched lines.
 
433
    :param hunks: An iterable of Hunk instances.
 
434
    """
383
435
    seen_patch = []
384
 
    patch_lines = iter_lines_handle_nl(patch_lines.__iter__())
385
 
    get_patch_names(patch_lines)
386
436
    line_no = 1
387
 
    for hunk in iter_hunks(patch_lines):
 
437
    if orig_lines is not None:
 
438
        orig_lines = iter(orig_lines)
 
439
    for hunk in hunks:
388
440
        while line_no < hunk.orig_pos:
389
441
            orig_line = orig_lines.next()
390
442
            yield orig_line
400
452
                if isinstance(hunk_line, ContextLine):
401
453
                    yield orig_line
402
454
                else:
403
 
                    assert isinstance(hunk_line, RemoveLine)
 
455
                    if not isinstance(hunk_line, RemoveLine):
 
456
                        raise AssertionError(hunk_line)
404
457
                line_no += 1
405
458
    if orig_lines is not None:
406
459
        for line in orig_lines: