← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge3.py

Major code cleanup.

Show diffs side-by-side

added added

removed removed

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