← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge3.py

  • Committer: Martin Pool
  • Date: 2005-08-05 19:23:12 UTC
  • Revision ID: mbp@sourcefrog.net-20050805192312-273968b3145cbcf6
- cleanup re-raise of exception

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