/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge3.py

[merge] robertc's integration, updated tests to check for retcode=3

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge3.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
# mbp: "you know that thing where cvs gives you conflict markers?"
20
19
# s: "i hate that."
21
20
 
22
 
import patiencediff
23
 
 
24
 
 
25
 
from . import (
26
 
    errors,
27
 
    textfile,
28
 
    )
29
 
 
30
 
 
31
 
class CantReprocessAndShowBase(errors.BzrError):
32
 
 
33
 
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
34
 
            "the relationship of conflicting lines to the base")
35
 
 
 
21
 
 
22
from difflib import SequenceMatcher
 
23
from bzrlib.errors import CantReprocessAndShowBase
36
24
 
37
25
def intersect(ra, rb):
38
26
    """Given two ranges return the range where they intersect or None.
46
34
    >>> intersect((0, 9), (7, 15))
47
35
    (7, 9)
48
36
    """
49
 
    # preconditions: (ra[0] <= ra[1]) and (rb[0] <= rb[1])
50
 
 
 
37
    assert ra[0] <= ra[1]
 
38
    assert rb[0] <= rb[1]
 
39
    
51
40
    sa = max(ra[0], rb[0])
52
41
    sb = min(ra[1], rb[1])
53
42
    if sa < sb:
59
48
def compare_range(a, astart, aend, b, bstart, bend):
60
49
    """Compare a[astart:aend] == b[bstart:bend], without slicing.
61
50
    """
62
 
    if (aend - astart) != (bend - bstart):
 
51
    if (aend-astart) != (bend-bstart):
63
52
        return False
64
 
    for ia, ib in zip(range(astart, aend), range(bstart, bend)):
 
53
    for ia, ib in zip(xrange(astart, aend), xrange(bstart, bend)):
65
54
        if a[ia] != b[ib]:
66
55
            return False
67
56
    else:
68
57
        return True
 
58
        
 
59
 
69
60
 
70
61
 
71
62
class Merge3(object):
74
65
    Given BASE, OTHER, THIS, tries to produce a combined text
75
66
    incorporating the changes from both BASE->OTHER and BASE->THIS.
76
67
    All three will typically be sequences of lines."""
77
 
 
78
 
    def __init__(self, base, a, b, is_cherrypick=False, allow_objects=False):
79
 
        """Constructor.
80
 
 
81
 
        :param base: lines in BASE
82
 
        :param a: lines in A
83
 
        :param b: lines in B
84
 
        :param is_cherrypick: flag indicating if this merge is a cherrypick.
85
 
            When cherrypicking b => a, matches with b and base do not conflict.
86
 
        :param allow_objects: if True, do not require that base, a and b are
87
 
            plain Python strs.  Also prevents BinaryFile from being raised.
88
 
            Lines can be any sequence of comparable and hashable Python
89
 
            objects.
90
 
        """
91
 
        if not allow_objects:
92
 
            textfile.check_text_lines(base)
93
 
            textfile.check_text_lines(a)
94
 
            textfile.check_text_lines(b)
 
68
    def __init__(self, base, a, b):
95
69
        self.base = base
96
70
        self.a = a
97
71
        self.b = b
98
 
        self.is_cherrypick = is_cherrypick
 
72
 
 
73
 
99
74
 
100
75
    def merge_lines(self,
101
76
                    name_a=None,
102
77
                    name_b=None,
103
78
                    name_base=None,
104
 
                    start_marker=b'<<<<<<<',
105
 
                    mid_marker=b'=======',
106
 
                    end_marker=b'>>>>>>>',
 
79
                    start_marker='<<<<<<<',
 
80
                    mid_marker='=======',
 
81
                    end_marker='>>>>>>>',
107
82
                    base_marker=None,
108
83
                    reprocess=False):
109
84
        """Return merge in cvs-like form.
110
85
        """
111
 
        newline = b'\n'
112
 
        if len(self.a) > 0:
113
 
            if self.a[0].endswith(b'\r\n'):
114
 
                newline = b'\r\n'
115
 
            elif self.a[0].endswith(b'\r'):
116
 
                newline = b'\r'
117
86
        if base_marker and reprocess:
118
87
            raise CantReprocessAndShowBase()
119
88
        if name_a:
120
 
            start_marker = start_marker + b' ' + name_a
 
89
            start_marker = start_marker + ' ' + name_a
121
90
        if name_b:
122
 
            end_marker = end_marker + b' ' + name_b
 
91
            end_marker = end_marker + ' ' + name_b
123
92
        if name_base and base_marker:
124
 
            base_marker = base_marker + b' ' + name_base
 
93
            base_marker = base_marker + ' ' + name_base
125
94
        merge_regions = self.merge_regions()
126
95
        if reprocess is True:
127
96
            merge_regions = self.reprocess_merge_regions(merge_regions)
137
106
                for i in range(t[1], t[2]):
138
107
                    yield self.b[i]
139
108
            elif what == 'conflict':
140
 
                yield start_marker + newline
 
109
                yield start_marker + '\n'
141
110
                for i in range(t[3], t[4]):
142
111
                    yield self.a[i]
143
112
                if base_marker is not None:
144
 
                    yield base_marker + newline
 
113
                    yield base_marker + '\n'
145
114
                    for i in range(t[1], t[2]):
146
115
                        yield self.base[i]
147
 
                yield mid_marker + newline
 
116
                yield mid_marker + '\n'
148
117
                for i in range(t[5], t[6]):
149
118
                    yield self.b[i]
150
 
                yield end_marker + newline
 
119
                yield end_marker + '\n'
151
120
            else:
152
121
                raise ValueError(what)
 
122
        
 
123
        
 
124
 
 
125
 
153
126
 
154
127
    def merge_annotated(self):
155
128
        """Return merge with conflicts, showing origin of lines.
156
129
 
157
 
        Most useful for debugging merge.
 
130
        Most useful for debugging merge.        
158
131
        """
159
132
        for t in self.merge_regions():
160
133
            what = t[0]
177
150
                yield '>>>>\n'
178
151
            else:
179
152
                raise ValueError(what)
 
153
        
 
154
        
 
155
 
 
156
 
180
157
 
181
158
    def merge_groups(self):
182
159
        """Yield sequence of line groups.  Each one is a tuple:
212
189
            else:
213
190
                raise ValueError(what)
214
191
 
 
192
 
215
193
    def merge_regions(self):
216
194
        """Return sequences of matching and conflicting regions.
217
195
 
241
219
 
242
220
        # section a[0:ia] has been disposed of, etc
243
221
        iz = ia = ib = 0
244
 
 
 
222
        
245
223
        for zmatch, zend, amatch, aend, bmatch, bend in self.find_sync_regions():
 
224
            #print 'match base [%d:%d]' % (zmatch, zend)
 
225
            
246
226
            matchlen = zend - zmatch
247
 
            # invariants:
248
 
            #   matchlen >= 0
249
 
            #   matchlen == (aend - amatch)
250
 
            #   matchlen == (bend - bmatch)
 
227
            assert matchlen >= 0
 
228
            assert matchlen == (aend - amatch)
 
229
            assert matchlen == (bend - bmatch)
 
230
            
251
231
            len_a = amatch - ia
252
232
            len_b = bmatch - ib
253
 
            # invariants:
254
 
            # assert len_a >= 0
255
 
            # assert len_b >= 0
 
233
            len_base = zmatch - iz
 
234
            assert len_a >= 0
 
235
            assert len_b >= 0
 
236
            assert len_base >= 0
256
237
 
257
 
            # print 'unmatched a=%d, b=%d' % (len_a, len_b)
 
238
            #print 'unmatched a=%d, b=%d' % (len_a, len_b)
258
239
 
259
240
            if len_a or len_b:
260
241
                # try to avoid actually slicing the lists
 
242
                equal_a = compare_range(self.a, ia, amatch,
 
243
                                        self.base, iz, zmatch)
 
244
                equal_b = compare_range(self.b, ib, bmatch,
 
245
                                        self.base, iz, zmatch)
261
246
                same = compare_range(self.a, ia, amatch,
262
247
                                     self.b, ib, bmatch)
263
248
 
264
249
                if same:
265
250
                    yield 'same', ia, amatch
 
251
                elif equal_a and not equal_b:
 
252
                    yield 'b', ib, bmatch
 
253
                elif equal_b and not equal_a:
 
254
                    yield 'a', ia, amatch
 
255
                elif not equal_a and not equal_b:
 
256
                    yield 'conflict', iz, zmatch, ia, amatch, ib, bmatch
266
257
                else:
267
 
                    equal_a = compare_range(self.a, ia, amatch,
268
 
                                            self.base, iz, zmatch)
269
 
                    equal_b = compare_range(self.b, ib, bmatch,
270
 
                                            self.base, iz, zmatch)
271
 
                    if equal_a and not equal_b:
272
 
                        yield 'b', ib, bmatch
273
 
                    elif equal_b and not equal_a:
274
 
                        yield 'a', ia, amatch
275
 
                    elif not equal_a and not equal_b:
276
 
                        if self.is_cherrypick:
277
 
                            for node in self._refine_cherrypick_conflict(
278
 
                                    iz, zmatch, ia, amatch,
279
 
                                    ib, bmatch):
280
 
                                yield node
281
 
                        else:
282
 
                            yield ('conflict', iz, zmatch, ia, amatch, ib,
283
 
                                   bmatch)
284
 
                    else:
285
 
                        raise AssertionError(
286
 
                            "can't handle a=b=base but unmatched")
 
258
                    raise AssertionError("can't handle a=b=base but unmatched")
287
259
 
288
260
                ia = amatch
289
261
                ib = bmatch
292
264
            # if the same part of the base was deleted on both sides
293
265
            # that's OK, we can just skip it.
294
266
 
 
267
                
295
268
            if matchlen > 0:
296
 
                # invariants:
297
 
                # assert ia == amatch
298
 
                # assert ib == bmatch
299
 
                # assert iz == zmatch
300
 
 
 
269
                assert ia == amatch
 
270
                assert ib == bmatch
 
271
                assert iz == zmatch
 
272
                
301
273
                yield 'unchanged', zmatch, zend
302
274
                iz = zend
303
275
                ia = aend
304
276
                ib = bend
305
 
 
306
 
    def _refine_cherrypick_conflict(self, zstart, zend, astart, aend, bstart,
307
 
                                    bend):
308
 
        """When cherrypicking b => a, ignore matches with b and base."""
309
 
        # Do not emit regions which match, only regions which do not match
310
 
        matches = patiencediff.PatienceSequenceMatcher(
311
 
            None, self.base[zstart:zend], self.b[bstart:bend]
312
 
            ).get_matching_blocks()
313
 
        last_base_idx = 0
314
 
        last_b_idx = 0
315
 
        last_b_idx = 0
316
 
        yielded_a = False
317
 
        for base_idx, b_idx, match_len in matches:
318
 
            conflict_b_len = b_idx - last_b_idx
319
 
            if conflict_b_len == 0:
320
 
                # There are no lines in b which conflict, so skip it
321
 
                pass
322
 
            else:
323
 
                if yielded_a:
324
 
                    yield ('conflict',
325
 
                           zstart + last_base_idx, zstart + base_idx,
326
 
                           aend, aend, bstart + last_b_idx, bstart + b_idx)
327
 
                else:
328
 
                    # The first conflict gets the a-range
329
 
                    yielded_a = True
330
 
                    yield ('conflict', zstart + last_base_idx, zstart +
331
 
                           base_idx,
332
 
                           astart, aend, bstart + last_b_idx, bstart + b_idx)
333
 
            last_base_idx = base_idx + match_len
334
 
            last_b_idx = b_idx + match_len
335
 
        if last_base_idx != zend - zstart or last_b_idx != bend - bstart:
336
 
            if yielded_a:
337
 
                yield ('conflict', zstart + last_base_idx, zstart + base_idx,
338
 
                       aend, aend, bstart + last_b_idx, bstart + b_idx)
339
 
            else:
340
 
                # The first conflict gets the a-range
341
 
                yielded_a = True
342
 
                yield ('conflict', zstart + last_base_idx, zstart + base_idx,
343
 
                       astart, aend, bstart + last_b_idx, bstart + b_idx)
344
 
        if not yielded_a:
345
 
            yield ('conflict', zstart, zend, astart, aend, bstart, bend)
 
277
    
346
278
 
347
279
    def reprocess_merge_regions(self, merge_regions):
348
 
        """Where there are conflict regions, remove the agreed lines.
349
 
 
350
 
        Lines where both A and B have made the same changes are
351
 
        eliminated.
352
 
        """
353
280
        for region in merge_regions:
354
281
            if region[0] != "conflict":
355
282
                yield region
357
284
            type, iz, zmatch, ia, amatch, ib, bmatch = region
358
285
            a_region = self.a[ia:amatch]
359
286
            b_region = self.b[ib:bmatch]
360
 
            matches = patiencediff.PatienceSequenceMatcher(
361
 
                None, a_region, b_region).get_matching_blocks()
 
287
            matches = SequenceMatcher(None, a_region, 
 
288
                                      b_region).get_matching_blocks()
362
289
            next_a = ia
363
290
            next_b = ib
364
291
            for region_ia, region_ib, region_len in matches[:-1]:
368
295
                                           region_ib)
369
296
                if reg is not None:
370
297
                    yield reg
371
 
                yield 'same', region_ia, region_len + region_ia
 
298
                yield 'same', region_ia, region_len+region_ia
372
299
                next_a = region_ia + region_len
373
300
                next_b = region_ib + region_len
374
301
            reg = self.mismatch_region(next_a, amatch, next_b, bmatch)
375
302
            if reg is not None:
376
303
                yield reg
377
304
 
 
305
 
378
306
    @staticmethod
379
 
    def mismatch_region(next_a, region_ia, next_b, region_ib):
 
307
    def mismatch_region(next_a, region_ia,  next_b, region_ib):
380
308
        if next_a < region_ia or next_b < region_ib:
381
309
            return 'conflict', None, None, next_a, region_ia, next_b, region_ib
 
310
            
382
311
 
383
312
    def find_sync_regions(self):
384
313
        """Return a list of sync regions, where both descendents match the base.
388
317
        """
389
318
 
390
319
        ia = ib = 0
391
 
        amatches = patiencediff.PatienceSequenceMatcher(
392
 
            None, self.base, self.a).get_matching_blocks()
393
 
        bmatches = patiencediff.PatienceSequenceMatcher(
394
 
            None, self.base, self.b).get_matching_blocks()
 
320
        amatches = SequenceMatcher(None, self.base, self.a).get_matching_blocks()
 
321
        bmatches = SequenceMatcher(None, self.base, self.b).get_matching_blocks()
395
322
        len_a = len(amatches)
396
323
        len_b = len(bmatches)
397
324
 
403
330
 
404
331
            # there is an unconflicted block at i; how long does it
405
332
            # extend?  until whichever one ends earlier.
406
 
            i = intersect((abase, abase + alen), (bbase, bbase + blen))
 
333
            i = intersect((abase, abase+alen), (bbase, bbase+blen))
407
334
            if i:
408
335
                intbase = i[0]
409
336
                intend = i[1]
411
338
 
412
339
                # found a match of base[i[0], i[1]]; this may be less than
413
340
                # the region that matches in either one
414
 
                # assert intlen <= alen
415
 
                # assert intlen <= blen
416
 
                # assert abase <= intbase
417
 
                # assert bbase <= intbase
 
341
                assert intlen <= alen
 
342
                assert intlen <= blen
 
343
                assert abase <= intbase
 
344
                assert bbase <= intbase
418
345
 
419
346
                asub = amatch + (intbase - abase)
420
347
                bsub = bmatch + (intbase - bbase)
421
348
                aend = asub + intlen
422
349
                bend = bsub + intlen
423
350
 
424
 
                # assert self.base[intbase:intend] == self.a[asub:aend], \
425
 
                #       (self.base[intbase:intend], self.a[asub:aend])
426
 
                # assert self.base[intbase:intend] == self.b[bsub:bend]
 
351
                assert self.base[intbase:intend] == self.a[asub:aend], \
 
352
                       (self.base[intbase:intend], self.a[asub:aend])
 
353
 
 
354
                assert self.base[intbase:intend] == self.b[bsub:bend]
427
355
 
428
356
                sl.append((intbase, intend,
429
357
                           asub, aend,
430
358
                           bsub, bend))
 
359
 
431
360
            # advance whichever one ends first in the base text
432
361
            if (abase + alen) < (bbase + blen):
433
362
                ia += 1
434
363
            else:
435
364
                ib += 1
436
 
 
 
365
            
437
366
        intbase = len(self.base)
438
367
        abase = len(self.a)
439
368
        bbase = len(self.b)
441
370
 
442
371
        return sl
443
372
 
 
373
 
 
374
 
444
375
    def find_unconflicted(self):
445
376
        """Return a list of ranges in base that are not conflicted."""
446
 
        am = patiencediff.PatienceSequenceMatcher(
447
 
            None, self.base, self.a).get_matching_blocks()
448
 
        bm = patiencediff.PatienceSequenceMatcher(
449
 
            None, self.base, self.b).get_matching_blocks()
 
377
 
 
378
        import re
 
379
 
 
380
        # don't sync-up on lines containing only blanks or pounds
 
381
        junk_re = re.compile(r'^[ \t#]*$')
 
382
        
 
383
        am = SequenceMatcher(junk_re.match, self.base, self.a).get_matching_blocks()
 
384
        bm = SequenceMatcher(junk_re.match, self.base, self.b).get_matching_blocks()
450
385
 
451
386
        unc = []
452
387
 
465
400
                del am[0]
466
401
            else:
467
402
                del bm[0]
468
 
 
 
403
                
469
404
        return unc
470
405
 
471
406
 
472
407
def main(argv):
473
408
    # as for diff3 and meld the syntax is "MINE BASE OTHER"
474
 
    with open(argv[1], 'rt') as f:
475
 
        a = f.readlines()
476
 
    with open(argv[2], 'rt') as f:
477
 
        base = f.readlines()
478
 
    with open(argv[3], 'rt') as f:
479
 
        b = f.readlines()
 
409
    a = file(argv[1], 'rt').readlines()
 
410
    base = file(argv[2], 'rt').readlines()
 
411
    b = file(argv[3], 'rt').readlines()
480
412
 
481
413
    m3 = Merge3(base, a, b)
482
414
 
483
 
    # for sr in m3.find_sync_regions():
 
415
    #for sr in m3.find_sync_regions():
484
416
    #    print sr
485
417
 
486
418
    # sys.stdout.writelines(m3.merge_lines(name_a=argv[1], name_b=argv[3]))