← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge3.py

- rules for using destructors

Show diffs side-by-side

added added

removed removed

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