/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

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

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