~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
 
22
22
"""Weave - storage of related text file versions"""
23
23
 
 
24
# before intset (r923) 2000 versions in 41.5s
 
25
# with intset (r926) 2000 versions in 93s !!!
 
26
# better to just use plain sets.
 
27
 
 
28
# making _extract build and return a list, rather than being a generator
 
29
# takes 37.94s
 
30
 
 
31
# with python -O, r923 does 2000 versions in 36.87s
 
32
 
 
33
# with optimizations to avoid mutating lists - 35.75!  I guess copying
 
34
# all the elements every time costs more than the small manipulations.
 
35
# a surprisingly small change.
 
36
 
 
37
# r931, which avoids using a generator for extract, does 36.98s
 
38
 
 
39
# with memoized inclusions, takes 41.49s; not very good
 
40
 
 
41
# with slots, takes 37.35s; without takes 39.16, a bit surprising
 
42
 
 
43
# with the delta calculation mixed in with the add method, rather than
 
44
# separated, takes 36.78s
 
45
 
 
46
# with delta folded in and mutation of the list, 36.13s
 
47
 
 
48
# with all this and simplification of add code, 33s
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
# TODO: Perhaps have copy method for Weave instances?
24
55
 
25
56
# XXX: If we do weaves this way, will a merge still behave the same
26
57
# way if it's done in a different order?  That's a pretty desirable
43
74
 
44
75
# TODO: Parallel-extract that passes back each line along with a
45
76
# description of which revisions include it.  Nice for checking all
46
 
# shas or calculating stats in parallel.
 
77
# shas in parallel.
47
78
 
48
79
# TODO: Using a single _extract routine and then processing the output
49
80
# is probably inefficient.  It's simple enough that we can afford to
50
81
# have slight specializations for different ways its used: annotate,
51
82
# basis for add, get, etc.
52
83
 
53
 
# TODO: Probably the API should work only in names to hide the integer
54
 
# indexes from the user.
55
 
 
56
 
# TODO: Is there any potential performance win by having an add()
57
 
# variant that is passed a pre-cooked version of the single basis
58
 
# version?
59
 
 
60
 
# TODO: Reweave can possibly be made faster by remembering diffs
61
 
# where the basis and destination are unchanged.
62
 
 
63
 
# FIXME: Sometimes we will be given a parents list for a revision
64
 
# that includes some redundant parents (i.e. already a parent of 
65
 
# something in the list.)  We should eliminate them.  This can 
66
 
# be done fairly efficiently because the sequence numbers constrain
67
 
# the possible relationships.
68
 
 
69
 
# FIXME: the conflict markers should be *7* characters
70
 
 
71
 
from copy import copy
72
 
from cStringIO import StringIO
73
 
from difflib import SequenceMatcher
74
 
import os
 
84
# TODO: Perhaps the API should work only in names to hide the integer
 
85
# indexes from the user?
 
86
 
 
87
 
 
88
 
75
89
import sha
76
 
import time
77
 
 
78
 
from bzrlib.trace import mutter
79
 
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
80
 
        RevisionAlreadyPresent,
81
 
        RevisionNotPresent,
82
 
        WeaveRevisionAlreadyPresent,
83
 
        WeaveRevisionNotPresent,
84
 
        )
85
 
import bzrlib.errors as errors
86
 
from bzrlib.osutils import sha_strings
87
 
from bzrlib.symbol_versioning import *
88
 
from bzrlib.tsort import topo_sort
89
 
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
90
 
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
91
 
 
92
 
 
93
 
class Weave(VersionedFile):
 
90
 
 
91
 
 
92
 
 
93
class WeaveError(Exception):
 
94
    """Exception in processing weave"""
 
95
 
 
96
 
 
97
class WeaveFormatError(WeaveError):
 
98
    """Weave invariant violated"""
 
99
    
 
100
 
 
101
class Weave(object):
94
102
    """weave - versioned text file storage.
95
103
    
96
104
    A Weave manages versions of line-based text files, keeping track
105
113
 
106
114
    * a nonnegative index number.
107
115
 
108
 
    * a version-id string.
 
116
    * a version-id string. (not implemented yet)
109
117
 
110
118
    Typically the index number will be valid only inside this weave and
111
119
    the version-id is used to reference it in the larger world.
173
181
 
174
182
    _name_map
175
183
        For each name, the version number.
176
 
 
177
 
    _weave_name
178
 
        Descriptive name of this weave; typically the filename if known.
179
 
        Set by read_weave.
180
184
    """
181
185
 
182
 
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
183
 
                 '_weave_name']
 
186
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map']
184
187
    
185
 
    def __init__(self, weave_name=None, access_mode='w'):
186
 
        super(Weave, self).__init__(access_mode)
 
188
    def __init__(self):
187
189
        self._weave = []
188
190
        self._parents = []
189
191
        self._sha1s = []
190
192
        self._names = []
191
193
        self._name_map = {}
192
 
        self._weave_name = weave_name
193
 
 
194
 
    def __repr__(self):
195
 
        return "Weave(%r)" % self._weave_name
196
 
 
197
 
    def copy(self):
198
 
        """Return a deep copy of self.
199
 
        
200
 
        The copy can be modified without affecting the original weave."""
201
 
        other = Weave()
202
 
        other._weave = self._weave[:]
203
 
        other._parents = self._parents[:]
204
 
        other._sha1s = self._sha1s[:]
205
 
        other._names = self._names[:]
206
 
        other._name_map = self._name_map.copy()
207
 
        other._weave_name = self._weave_name
208
 
        return other
 
194
 
209
195
 
210
196
    def __eq__(self, other):
211
197
        if not isinstance(other, Weave):
213
199
        return self._parents == other._parents \
214
200
               and self._weave == other._weave \
215
201
               and self._sha1s == other._sha1s 
 
202
 
216
203
    
217
204
    def __ne__(self, other):
218
205
        return not self.__eq__(other)
219
206
 
220
 
    @deprecated_method(zero_eight)
221
 
    def idx_to_name(self, index):
222
 
        """Old public interface, the public interface is all names now."""
223
 
        return index
224
 
 
225
 
    def _idx_to_name(self, version):
226
 
        return self._names[version]
227
 
 
228
 
    @deprecated_method(zero_eight)
 
207
 
229
208
    def lookup(self, name):
230
 
        """Backwards compatability thunk:
231
 
 
232
 
        Return name, as name is valid in the api now, and spew deprecation
233
 
        warnings everywhere.
234
 
        """
235
 
        return name
236
 
 
237
 
    def _lookup(self, name):
238
 
        """Convert symbolic version name to index."""
239
209
        try:
240
210
            return self._name_map[name]
241
211
        except KeyError:
242
 
            raise RevisionNotPresent(name, self._weave_name)
243
 
 
244
 
    @deprecated_method(zero_eight)
245
 
    def iter_names(self):
246
 
        """Deprecated convenience function, please see VersionedFile.names()."""
247
 
        return iter(self.names())
248
 
 
249
 
    @deprecated_method(zero_eight)
250
 
    def names(self):
251
 
        """See Weave.versions for the current api."""
252
 
        return self.versions()
253
 
 
254
 
    def versions(self):
255
 
        """See VersionedFile.versions."""
256
 
        return self._names[:]
257
 
 
258
 
    def has_version(self, version_id):
259
 
        """See VersionedFile.has_version."""
260
 
        return self._name_map.has_key(version_id)
261
 
 
262
 
    __contains__ = has_version
263
 
 
264
 
    def get_delta(self, version_id):
265
 
        """See VersionedFile.get_delta."""
266
 
        return self.get_deltas([version_id])[version_id]
267
 
 
268
 
    def get_deltas(self, version_ids):
269
 
        """See VersionedFile.get_deltas."""
270
 
        version_ids = self.get_ancestry(version_ids)
271
 
        for version_id in version_ids:
272
 
            if not self.has_version(version_id):
273
 
                raise RevisionNotPresent(version_id, self)
274
 
        # try extracting all versions; parallel extraction is used
275
 
        nv = self.num_versions()
276
 
        sha1s = {}
277
 
        deltas = {}
278
 
        texts = {}
279
 
        inclusions = {}
280
 
        noeols = {}
281
 
        last_parent_lines = {}
282
 
        parents = {}
283
 
        parent_inclusions = {}
284
 
        parent_linenums = {}
285
 
        parent_noeols = {}
286
 
        current_hunks = {}
287
 
        diff_hunks = {}
288
 
        # its simplest to generate a full set of prepared variables.
289
 
        for i in range(nv):
290
 
            name = self._names[i]
291
 
            sha1s[name] = self.get_sha1(name)
292
 
            parents_list = self.get_parents(name)
293
 
            try:
294
 
                parent = parents_list[0]
295
 
                parents[name] = parent
296
 
                parent_inclusions[name] = inclusions[parent]
297
 
            except IndexError:
298
 
                parents[name] = None
299
 
                parent_inclusions[name] = set()
300
 
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
301
 
            diff_hunks[name] = []
302
 
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
303
 
            parent_linenums[name] = 0
304
 
            noeols[name] = False
305
 
            parent_noeols[name] = False
306
 
            last_parent_lines[name] = None
307
 
            new_inc = set([name])
308
 
            for p in self._parents[i]:
309
 
                new_inc.update(inclusions[self._idx_to_name(p)])
310
 
            # debug only, known good so far.
311
 
            #assert set(new_inc) == set(self.get_ancestry(name)), \
312
 
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
313
 
            inclusions[name] = new_inc
314
 
 
315
 
        nlines = len(self._weave)
316
 
 
317
 
        for lineno, inserted, deletes, line in self._walk_internal():
318
 
            # a line is active in a version if:
319
 
            # insert is in the versions inclusions
320
 
            # and
321
 
            # deleteset & the versions inclusions is an empty set.
322
 
            # so - if we have a included by mapping - version is included by
323
 
            # children, we get a list of children to examine for deletes affect
324
 
            # ing them, which is less than the entire set of children.
325
 
            for version_id in version_ids:  
326
 
                # The active inclusion must be an ancestor,
327
 
                # and no ancestors must have deleted this line,
328
 
                # because we don't support resurrection.
329
 
                parent_inclusion = parent_inclusions[version_id]
330
 
                inclusion = inclusions[version_id]
331
 
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
332
 
                version_active = inserted in inclusion and not (deletes & inclusion)
333
 
                if not parent_active and not version_active:
334
 
                    # unrelated line of ancestry
335
 
                    continue
336
 
                elif parent_active and version_active:
337
 
                    # shared line
338
 
                    parent_linenum = parent_linenums[version_id]
339
 
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
340
 
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
341
 
                    parent_linenum += 1
342
 
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
343
 
                    parent_linenums[version_id] = parent_linenum
344
 
                    try:
345
 
                        if line[-1] != '\n':
346
 
                            noeols[version_id] = True
347
 
                    except IndexError:
348
 
                        pass
349
 
                elif parent_active and not version_active:
350
 
                    # deleted line
351
 
                    current_hunks[version_id][1] += 1
352
 
                    parent_linenums[version_id] += 1
353
 
                    last_parent_lines[version_id] = line
354
 
                elif not parent_active and version_active:
355
 
                    # replacement line
356
 
                    # noeol only occurs at the end of a file because we 
357
 
                    # diff linewise. We want to show noeol changes as a
358
 
                    # empty diff unless the actual eol-less content changed.
359
 
                    theline = line
360
 
                    try:
361
 
                        if last_parent_lines[version_id][-1] != '\n':
362
 
                            parent_noeols[version_id] = True
363
 
                    except (TypeError, IndexError):
364
 
                        pass
365
 
                    try:
366
 
                        if theline[-1] != '\n':
367
 
                            noeols[version_id] = True
368
 
                    except IndexError:
369
 
                        pass
370
 
                    new_line = False
371
 
                    parent_should_go = False
372
 
 
373
 
                    if parent_noeols[version_id] == noeols[version_id]:
374
 
                        # no noeol toggle, so trust the weaves statement
375
 
                        # that this line is changed.
376
 
                        new_line = True
377
 
                        if parent_noeols[version_id]:
378
 
                            theline = theline + '\n'
379
 
                    elif parent_noeols[version_id]:
380
 
                        # parent has no eol, we do:
381
 
                        # our line is new, report as such..
382
 
                        new_line = True
383
 
                    elif noeols[version_id]:
384
 
                        # append a eol so that it looks like
385
 
                        # a normalised delta
386
 
                        theline = theline + '\n'
387
 
                        if parents[version_id] is not None:
388
 
                        #if last_parent_lines[version_id] is not None:
389
 
                            parent_should_go = True
390
 
                        if last_parent_lines[version_id] != theline:
391
 
                            # but changed anyway
392
 
                            new_line = True
393
 
                            #parent_should_go = False
394
 
                    if new_line:
395
 
                        current_hunks[version_id][2] += 1
396
 
                        current_hunks[version_id][3].append((inserted, theline))
397
 
                    if parent_should_go:
398
 
                        # last hunk last parent line is not eaten
399
 
                        current_hunks[version_id][1] -= 1
400
 
                    if current_hunks[version_id][1] < 0:
401
 
                        current_hunks[version_id][1] = 0
402
 
                        # import pdb;pdb.set_trace()
403
 
                    # assert current_hunks[version_id][1] >= 0
404
 
 
405
 
        # flush last hunk
406
 
        for i in range(nv):
407
 
            version = self._idx_to_name(i)
408
 
            if current_hunks[version] != [0, 0, 0, []]:
409
 
                diff_hunks[version].append(tuple(current_hunks[version]))
410
 
        result = {}
411
 
        for version_id in version_ids:
412
 
            result[version_id] = (
413
 
                                  parents[version_id],
414
 
                                  sha1s[version_id],
415
 
                                  noeols[version_id],
416
 
                                  diff_hunks[version_id],
417
 
                                  )
418
 
        return result
419
 
 
420
 
    def get_parents(self, version_id):
421
 
        """See VersionedFile.get_parent."""
422
 
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
423
 
 
424
 
    def _check_repeated_add(self, name, parents, text, sha1):
425
 
        """Check that a duplicated add is OK.
426
 
 
427
 
        If it is, return the (old) index; otherwise raise an exception.
428
 
        """
429
 
        idx = self._lookup(name)
430
 
        if sorted(self._parents[idx]) != sorted(parents) \
431
 
            or sha1 != self._sha1s[idx]:
432
 
            raise RevisionAlreadyPresent(name, self._weave_name)
433
 
        return idx
434
 
 
435
 
    @deprecated_method(zero_eight)
436
 
    def add_identical(self, old_rev_id, new_rev_id, parents):
437
 
        """Please use Weave.clone_text now."""
438
 
        return self.clone_text(new_rev_id, old_rev_id, parents)
439
 
 
440
 
    def _add_lines(self, version_id, parents, lines, parent_texts):
441
 
        """See VersionedFile.add_lines."""
442
 
        return self._add(version_id, lines, map(self._lookup, parents))
443
 
 
444
 
    @deprecated_method(zero_eight)
445
 
    def add(self, name, parents, text, sha1=None):
446
 
        """See VersionedFile.add_lines for the non deprecated api."""
447
 
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
448
 
 
449
 
    def _add(self, version_id, lines, parents, sha1=None):
 
212
            raise WeaveError("name %s not present in weave" % name)
 
213
 
 
214
        
 
215
    def add(self, name, parents, text):
450
216
        """Add a single text on top of the weave.
451
217
  
452
218
        Returns the index number of the newly added version.
453
219
 
454
 
        version_id
 
220
        name
455
221
            Symbolic name for this version.
456
222
            (Typically the revision-id of the revision that added it.)
457
223
 
458
224
        parents
459
225
            List or set of direct parent version numbers.
460
226
            
461
 
        lines
462
 
            Sequence of lines to be added in the new version.
463
 
        """
464
 
 
465
 
        assert isinstance(version_id, basestring)
466
 
        if not sha1:
467
 
            sha1 = sha_strings(lines)
468
 
        if version_id in self._name_map:
469
 
            return self._check_repeated_add(version_id, parents, lines, sha1)
470
 
 
 
227
        text
 
228
            Sequence of lines to be added in the new version."""
 
229
 
 
230
        assert isinstance(name, basestring)
 
231
        if name in self._name_map:
 
232
            raise WeaveError("name %r already present in weave" % name)
 
233
        
471
234
        self._check_versions(parents)
472
 
        ## self._check_lines(lines)
 
235
        ## self._check_lines(text)
473
236
        new_version = len(self._parents)
474
237
 
 
238
        s = sha.new()
 
239
        map(s.update, text)
 
240
        sha1 = s.hexdigest()
 
241
        del s
 
242
 
475
243
        # if we abort after here the (in-memory) weave will be corrupt because only
476
244
        # some fields are updated
477
 
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
478
 
        #      - Robert Collins 20060226
479
245
        self._parents.append(parents[:])
480
246
        self._sha1s.append(sha1)
481
 
        self._names.append(version_id)
482
 
        self._name_map[version_id] = new_version
 
247
        self._names.append(name)
 
248
        self._name_map[name] = new_version
483
249
 
484
250
            
485
251
        if not parents:
487
253
            # this more quickly by just appending unconditionally.
488
254
            # even more specially, if we're adding an empty text we
489
255
            # need do nothing at all.
490
 
            if lines:
 
256
            if text:
491
257
                self._weave.append(('{', new_version))
492
 
                self._weave.extend(lines)
 
258
                self._weave.extend(text)
493
259
                self._weave.append(('}', None))
 
260
        
494
261
            return new_version
495
262
 
496
263
        if len(parents) == 1:
500
267
                return new_version
501
268
            
502
269
 
503
 
        ancestors = self._inclusions(parents)
 
270
        ancestors = self.inclusions(parents)
504
271
 
505
272
        l = self._weave
506
273
 
513
280
 
514
281
        # another small special case: a merge, producing the same text
515
282
        # as auto-merge
516
 
        if lines == basis_lines:
 
283
        if text == basis_lines:
517
284
            return new_version            
518
285
 
519
286
        # add a sentinal, because we can also match against the final line
526
293
        #print 'basis_lines:', basis_lines
527
294
        #print 'new_lines:  ', lines
528
295
 
529
 
        s = SequenceMatcher(None, basis_lines, lines)
 
296
        from difflib import SequenceMatcher
 
297
        s = SequenceMatcher(None, basis_lines, text)
530
298
 
531
299
        # offset gives the number of lines that have been inserted
532
300
        # into the weave up to the current point; if the original edit instruction
543
311
            i1 = basis_lineno[i1]
544
312
            i2 = basis_lineno[i2]
545
313
 
546
 
            assert 0 <= j1 <= j2 <= len(lines)
 
314
            assert 0 <= j1 <= j2 <= len(text)
547
315
 
548
316
            #print tag, i1, i2, j1, j2
549
317
 
560
328
                # we don't destroy ourselves
561
329
                i = i2 + offset
562
330
                self._weave[i:i] = ([('{', new_version)] 
563
 
                                    + lines[j1:j2] 
 
331
                                    + text[j1:j2] 
564
332
                                    + [('}', None)])
565
333
                offset += 2 + (j2 - j1)
 
334
 
566
335
        return new_version
567
336
 
568
 
    def _clone_text(self, new_version_id, old_version_id, parents):
569
 
        """See VersionedFile.clone_text."""
570
 
        old_lines = self.get_text(old_version_id)
571
 
        self.add_lines(new_version_id, parents, old_lines)
572
337
 
573
 
    def _inclusions(self, versions):
 
338
    def inclusions(self, versions):
574
339
        """Return set of all ancestors of given version(s)."""
575
 
        if not len(versions):
576
 
            return []
577
340
        i = set(versions)
578
 
        for v in xrange(max(versions), 0, -1):
579
 
            if v in i:
580
 
                # include all its parents
581
 
                i.update(self._parents[v])
582
 
        return i
583
 
        ## except IndexError:
584
 
        ##     raise ValueError("version %d not present in weave" % v)
585
 
 
586
 
    @deprecated_method(zero_eight)
587
 
    def inclusions(self, version_ids):
588
 
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
589
 
        if not version_ids:
 
341
        v = max(versions)
 
342
        try:
 
343
            while v >= 0:
 
344
                if v in i:
 
345
                    # include all its parents
 
346
                    i.update(self._parents[v])
 
347
                v -= 1
 
348
            return i
 
349
        except IndexError:
 
350
            raise ValueError("version %d not present in weave" % v)
 
351
 
 
352
 
 
353
    def minimal_parents(self, version):
 
354
        """Find the minimal set of parents for the version."""
 
355
        included = self._parents[version]
 
356
        if not included:
590
357
            return []
591
 
        if isinstance(version_ids[0], int):
592
 
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
593
 
        else:
594
 
            return self.get_ancestry(version_ids)
595
 
 
596
 
    def get_ancestry(self, version_ids):
597
 
        """See VersionedFile.get_ancestry."""
598
 
        if isinstance(version_ids, basestring):
599
 
            version_ids = [version_ids]
600
 
        i = self._inclusions([self._lookup(v) for v in version_ids])
601
 
        return [self._idx_to_name(v) for v in i]
 
358
        
 
359
        li = list(included)
 
360
        li.sort(reverse=True)
 
361
 
 
362
        mininc = []
 
363
        gotit = set()
 
364
 
 
365
        for pv in li:
 
366
            if pv not in gotit:
 
367
                mininc.append(pv)
 
368
                gotit.update(self.inclusions(pv))
 
369
 
 
370
        assert mininc[0] >= 0
 
371
        assert mininc[-1] < version
 
372
        return mininc
 
373
 
 
374
 
602
375
 
603
376
    def _check_lines(self, text):
604
377
        if not isinstance(text, list):
619
392
            except IndexError:
620
393
                raise IndexError("invalid version number %r" % i)
621
394
 
622
 
    def _compatible_parents(self, my_parents, other_parents):
623
 
        """During join check that other_parents are joinable with my_parents.
624
 
 
625
 
        Joinable is defined as 'is a subset of' - supersets may require 
626
 
        regeneration of diffs, but subsets do not.
627
 
        """
628
 
        return len(other_parents.difference(my_parents)) == 0
629
 
 
630
 
    def annotate(self, version_id):
631
 
        if isinstance(version_id, int):
632
 
            warn('Weave.annotate(int) is deprecated. Please use version names'
633
 
                 ' in all circumstances as of 0.8',
634
 
                 DeprecationWarning,
635
 
                 stacklevel=2
636
 
                 )
637
 
            result = []
638
 
            for origin, lineno, text in self._extract([version_id]):
639
 
                result.append((origin, text))
640
 
            return result
641
 
        else:
642
 
            return super(Weave, self).annotate(version_id)
643
395
    
644
 
    def annotate_iter(self, version_id):
645
 
        """Yield list of (version-id, line) pairs for the specified version.
 
396
    def annotate(self, index):
 
397
        return list(self.annotate_iter(index))
 
398
 
 
399
 
 
400
    def annotate_iter(self, version):
 
401
        """Yield list of (index-id, line) pairs for the specified version.
646
402
 
647
403
        The index indicates when the line originated in the weave."""
648
 
        incls = [self._lookup(version_id)]
649
 
        for origin, lineno, text in self._extract(incls):
650
 
            yield self._idx_to_name(origin), text
651
 
 
652
 
    @deprecated_method(zero_eight)
 
404
        for origin, lineno, text in self._extract([version]):
 
405
            yield origin, text
 
406
 
 
407
 
653
408
    def _walk(self):
654
 
        """_walk has become visit, a supported api."""
655
 
        return self._walk_internal()
656
 
 
657
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None):
658
 
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
659
 
        if version_ids is None:
660
 
            version_ids = self.versions()
661
 
        version_ids = set(version_ids)
662
 
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
663
 
            # if inserted not in version_ids then it was inserted before the
664
 
            # versions we care about, but because weaves cannot represent ghosts
665
 
            # properly, we do not filter down to that
666
 
            # if inserted not in version_ids: continue
667
 
            if line[-1] != '\n':
668
 
                yield line + '\n'
669
 
            else:
670
 
                yield line
671
 
 
672
 
    #@deprecated_method(zero_eight)
673
 
    def walk(self, version_ids=None):
674
 
        """See VersionedFile.walk."""
675
 
        return self._walk_internal(version_ids)
676
 
 
677
 
    def _walk_internal(self, version_ids=None):
678
 
        """Helper method for weave actions."""
 
409
        """Walk the weave.
 
410
 
 
411
        Yields sequence of
 
412
        (lineno, insert, deletes, text)
 
413
        for each literal line.
 
414
        """
679
415
        
680
416
        istack = []
681
417
        dset = set()
683
419
        lineno = 0         # line of weave, 0-based
684
420
 
685
421
        for l in self._weave:
686
 
            if l.__class__ == tuple:
 
422
            if isinstance(l, tuple):
687
423
                c, v = l
688
424
                isactive = None
689
425
                if c == '{':
690
 
                    istack.append(self._names[v])
 
426
                    istack.append(v)
691
427
                elif c == '}':
692
428
                    istack.pop()
693
429
                elif c == '[':
694
 
                    assert self._names[v] not in dset
695
 
                    dset.add(self._names[v])
 
430
                    assert v not in dset
 
431
                    dset.add(v)
696
432
                elif c == ']':
697
 
                    dset.remove(self._names[v])
 
433
                    dset.remove(v)
698
434
                else:
699
 
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
435
                    raise WeaveFormatError('unexpected instruction %r'
 
436
                                           % v)
700
437
            else:
701
 
                assert l.__class__ in (str, unicode)
 
438
                assert isinstance(l, basestring)
702
439
                assert istack
703
 
                yield lineno, istack[-1], frozenset(dset), l
 
440
                yield lineno, istack[-1], dset, l
704
441
            lineno += 1
705
442
 
706
 
        if istack:
707
 
            raise WeaveFormatError("unclosed insertion blocks "
708
 
                    "at end of weave: %s" % istack)
709
 
        if dset:
710
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
711
 
                                   % dset)
712
 
 
713
 
    def plan_merge(self, ver_a, ver_b):
714
 
        """Return pseudo-annotation indicating how the two versions merge.
715
 
 
716
 
        This is computed between versions a and b and their common
717
 
        base.
718
 
 
719
 
        Weave lines present in none of them are skipped entirely.
720
 
        """
721
 
        inc_a = set(self.get_ancestry([ver_a]))
722
 
        inc_b = set(self.get_ancestry([ver_b]))
723
 
        inc_c = inc_a & inc_b
724
 
 
725
 
        for lineno, insert, deleteset, line in\
726
 
            self.walk([ver_a, ver_b]):
727
 
            if deleteset & inc_c:
728
 
                # killed in parent; can't be in either a or b
729
 
                # not relevant to our work
730
 
                yield 'killed-base', line
731
 
            elif insert in inc_c:
732
 
                # was inserted in base
733
 
                killed_a = bool(deleteset & inc_a)
734
 
                killed_b = bool(deleteset & inc_b)
735
 
                if killed_a and killed_b:
736
 
                    yield 'killed-both', line
737
 
                elif killed_a:
738
 
                    yield 'killed-a', line
739
 
                elif killed_b:
740
 
                    yield 'killed-b', line
741
 
                else:
742
 
                    yield 'unchanged', line
743
 
            elif insert in inc_a:
744
 
                if deleteset & inc_a:
745
 
                    yield 'ghost-a', line
746
 
                else:
747
 
                    # new in A; not in B
748
 
                    yield 'new-a', line
749
 
            elif insert in inc_b:
750
 
                if deleteset & inc_b:
751
 
                    yield 'ghost-b', line
752
 
                else:
753
 
                    yield 'new-b', line
754
 
            else:
755
 
                # not in either revision
756
 
                yield 'irrelevant', line
757
 
 
758
 
        yield 'unchanged', ''           # terminator
 
443
 
759
444
 
760
445
    def _extract(self, versions):
761
446
        """Yield annotation of lines in included set.
766
451
 
767
452
        The set typically but not necessarily corresponds to a version.
768
453
        """
769
 
        for i in versions:
770
 
            if not isinstance(i, int):
771
 
                raise ValueError(i)
772
 
            
773
 
        included = self._inclusions(versions)
 
454
        included = self.inclusions(versions)
774
455
 
775
456
        istack = []
776
 
        iset = set()
777
457
        dset = set()
778
458
 
779
459
        lineno = 0         # line of weave, 0-based
784
464
 
785
465
        WFE = WeaveFormatError
786
466
 
787
 
        # wow. 
788
 
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
789
 
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
790
 
        # 1.6 seconds in 'isinstance'.
791
 
        # changing the first isinstance:
792
 
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
793
 
        #  +140414   0    762.8050    762.8050   +<isinstance>
794
 
        # note that the inline time actually dropped (less function calls)
795
 
        # and total processing time was halved.
796
 
        # we're still spending ~1/4 of the method in isinstance though.
797
 
        # so lets hard code the acceptable string classes we expect:
798
 
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
799
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
800
 
        #                                          objects>
801
 
        # yay, down to ~1/4 the initial extract time, and our inline time
802
 
        # has shrunk again, with isinstance no longer dominating.
803
 
        # tweaking the stack inclusion test to use a set gives:
804
 
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
805
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
806
 
        #                                          objects>
807
 
        # - a 5% win, or possibly just noise. However with large istacks that
808
 
        # 'in' test could dominate, so I'm leaving this change in place -
809
 
        # when its fast enough to consider profiling big datasets we can review.
810
 
 
811
 
              
812
 
             
813
 
 
814
467
        for l in self._weave:
815
 
            if l.__class__ == tuple:
 
468
            if isinstance(l, tuple):
816
469
                c, v = l
817
470
                isactive = None
818
471
                if c == '{':
819
 
                    assert v not in iset
 
472
                    assert v not in istack
820
473
                    istack.append(v)
821
 
                    iset.add(v)
822
474
                elif c == '}':
823
 
                    iset.remove(istack.pop())
 
475
                    istack.pop()
824
476
                elif c == '[':
825
477
                    if v in included:
826
478
                        assert v not in dset
831
483
                        assert v in dset
832
484
                        dset.remove(v)
833
485
            else:
834
 
                assert l.__class__ in (str, unicode)
 
486
                assert isinstance(l, basestring)
835
487
                if isactive is None:
836
488
                    isactive = (not dset) and istack and (istack[-1] in included)
837
489
                if isactive:
838
490
                    result.append((istack[-1], lineno, l))
839
491
            lineno += 1
 
492
 
840
493
        if istack:
841
 
            raise WeaveFormatError("unclosed insertion blocks "
842
 
                    "at end of weave: %s" % istack)
 
494
            raise WFE("unclosed insertion blocks at end of weave",
 
495
                                   istack)
843
496
        if dset:
844
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
845
 
                                   % dset)
846
 
        return result
847
 
 
848
 
    @deprecated_method(zero_eight)
849
 
    def get_iter(self, name_or_index):
850
 
        """Deprecated, please do not use. Lookups are not not needed.
851
 
        
852
 
        Please use get_lines now.
853
 
        """
854
 
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
855
 
 
856
 
    @deprecated_method(zero_eight)
857
 
    def maybe_lookup(self, name_or_index):
858
 
        """Deprecated, please do not use. Lookups are not not needed."""
859
 
        return self._maybe_lookup(name_or_index)
860
 
 
861
 
    def _maybe_lookup(self, name_or_index):
862
 
        """Convert possible symbolic name to index, or pass through indexes.
863
 
        
864
 
        NOT FOR PUBLIC USE.
865
 
        """
866
 
        if isinstance(name_or_index, (int, long)):
867
 
            return name_or_index
868
 
        else:
869
 
            return self._lookup(name_or_index)
870
 
 
871
 
    @deprecated_method(zero_eight)
872
 
    def get(self, version_id):
873
 
        """Please use either Weave.get_text or Weave.get_lines as desired."""
874
 
        return self.get_lines(version_id)
875
 
 
876
 
    def get_lines(self, version_id):
877
 
        """See VersionedFile.get_lines()."""
878
 
        int_index = self._maybe_lookup(version_id)
879
 
        result = [line for (origin, lineno, line) in self._extract([int_index])]
880
 
        expected_sha1 = self._sha1s[int_index]
881
 
        measured_sha1 = sha_strings(result)
882
 
        if measured_sha1 != expected_sha1:
883
 
            raise errors.WeaveInvalidChecksum(
884
 
                    'file %s, revision %s, expected: %s, measured %s' 
885
 
                    % (self._weave_name, version_id,
886
 
                       expected_sha1, measured_sha1))
887
 
        return result
888
 
 
889
 
    def get_sha1(self, name):
890
 
        """Get the stored sha1 sum for the given revision.
891
 
        
892
 
        :param name: The name of the version to lookup
893
 
        """
894
 
        return self._sha1s[self._lookup(name)]
895
 
 
896
 
    @deprecated_method(zero_eight)
 
497
            raise WFE("unclosed deletion blocks at end of weave",
 
498
                                   dset)
 
499
 
 
500
        return result
 
501
    
 
502
 
 
503
 
 
504
    def get_iter(self, version):
 
505
        """Yield lines for the specified version."""
 
506
        for origin, lineno, line in self._extract([version]):
 
507
            yield line
 
508
 
 
509
 
 
510
    def get(self, index):
 
511
        return list(self.get_iter(index))
 
512
 
 
513
 
 
514
    def mash_iter(self, included):
 
515
        """Return composed version of multiple included versions."""
 
516
        for origin, lineno, text in self._extract(included):
 
517
            yield text
 
518
 
 
519
 
 
520
    def dump(self, to_file):
 
521
        from pprint import pprint
 
522
        print >>to_file, "Weave._weave = ",
 
523
        pprint(self._weave, to_file)
 
524
        print >>to_file, "Weave._parents = ",
 
525
        pprint(self._parents, to_file)
 
526
 
 
527
 
 
528
 
897
529
    def numversions(self):
898
 
        """How many versions are in this weave?
899
 
 
900
 
        Deprecated in favour of num_versions.
901
 
        """
902
 
        return self.num_versions()
903
 
 
904
 
    def num_versions(self):
905
 
        """How many versions are in this weave?"""
906
530
        l = len(self._parents)
907
531
        assert l == len(self._sha1s)
908
532
        return l
909
533
 
910
 
    __len__ = num_versions
 
534
 
 
535
    def __len__(self):
 
536
        return self.numversions()
 
537
 
911
538
 
912
539
    def check(self, progress_bar=None):
913
 
        # TODO evaluate performance hit of using string sets in this routine.
914
 
        # TODO: check no circular inclusions
915
 
        # TODO: create a nested progress bar
916
 
        for version in range(self.num_versions()):
 
540
        # check no circular inclusions
 
541
        for version in range(self.numversions()):
917
542
            inclusions = list(self._parents[version])
918
543
            if inclusions:
919
544
                inclusions.sort()
921
546
                    raise WeaveFormatError("invalid included version %d for index %d"
922
547
                                           % (inclusions[-1], version))
923
548
 
924
 
        # try extracting all versions; parallel extraction is used
925
 
        nv = self.num_versions()
926
 
        sha1s = {}
927
 
        texts = {}
928
 
        inclusions = {}
929
 
        for i in range(nv):
930
 
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
931
 
            # The problem is that set membership is much more expensive
932
 
            name = self._idx_to_name(i)
933
 
            sha1s[name] = sha.new()
934
 
            texts[name] = []
935
 
            new_inc = set([name])
936
 
            for p in self._parents[i]:
937
 
                new_inc.update(inclusions[self._idx_to_name(p)])
938
 
 
939
 
            assert set(new_inc) == set(self.get_ancestry(name)), \
940
 
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
941
 
            inclusions[name] = new_inc
942
 
 
943
 
        nlines = len(self._weave)
944
 
 
945
 
        update_text = 'checking weave'
946
 
        if self._weave_name:
947
 
            short_name = os.path.basename(self._weave_name)
948
 
            update_text = 'checking %s' % (short_name,)
949
 
            update_text = update_text[:25]
950
 
 
951
 
        for lineno, insert, deleteset, line in self._walk_internal():
 
549
        # try extracting all versions; this is a bit slow and parallel
 
550
        # extraction could be used
 
551
        nv = self.numversions()
 
552
        for version in range(nv):
952
553
            if progress_bar:
953
 
                progress_bar.update(update_text, lineno, nlines)
954
 
 
955
 
            for name, name_inclusions in inclusions.items():
956
 
                # The active inclusion must be an ancestor,
957
 
                # and no ancestors must have deleted this line,
958
 
                # because we don't support resurrection.
959
 
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
960
 
                    sha1s[name].update(line)
961
 
 
962
 
        for i in range(nv):
963
 
            version = self._idx_to_name(i)
964
 
            hd = sha1s[version].hexdigest()
965
 
            expected = self._sha1s[i]
 
554
                progress_bar.update('checking text', version, nv)
 
555
            s = sha.new()
 
556
            for l in self.get_iter(version):
 
557
                s.update(l)
 
558
            hd = s.hexdigest()
 
559
            expected = self._sha1s[version]
966
560
            if hd != expected:
967
 
                raise errors.WeaveInvalidChecksum(
968
 
                        "mismatched sha1 for version %s: "
969
 
                        "got %s, expected %s"
970
 
                        % (version, hd, expected))
 
561
                raise WeaveError("mismatched sha1 for version %d; "
 
562
                                 "got %s, expected %s"
 
563
                                 % (version, hd, expected))
971
564
 
972
565
        # TODO: check insertions are properly nested, that there are
973
566
        # no lines outside of insertion blocks, that deletions are
974
567
        # properly paired, etc.
975
568
 
976
 
    def _join(self, other, pb, msg, version_ids, ignore_missing):
977
 
        """Worker routine for join()."""
978
 
        if not other.versions():
979
 
            return          # nothing to update, easy
980
 
 
981
 
        if version_ids:
982
 
            for version_id in version_ids:
983
 
                if not other.has_version(version_id) and not ignore_missing:
984
 
                    raise RevisionNotPresent(version_id, self._weave_name)
985
 
        else:
986
 
            version_ids = other.versions()
987
 
 
988
 
        # two loops so that we do not change ourselves before verifying it
989
 
        # will be ok
990
 
        # work through in index order to make sure we get all dependencies
991
 
        names_to_join = []
992
 
        processed = 0
993
 
        # get the selected versions only that are in other.versions.
994
 
        version_ids = set(other.versions()).intersection(set(version_ids))
995
 
        # pull in the referenced graph.
996
 
        version_ids = other.get_ancestry(version_ids)
997
 
        pending_graph = [(version, other.get_parents(version)) for
998
 
                         version in version_ids]
999
 
        for name in topo_sort(pending_graph):
1000
 
            other_idx = other._name_map[name]
1001
 
            # returns True if we have it, False if we need it.
1002
 
            if not self._check_version_consistent(other, other_idx, name):
1003
 
                names_to_join.append((other_idx, name))
1004
 
            processed += 1
1005
 
 
1006
 
 
1007
 
        if pb and not msg:
1008
 
            msg = 'weave join'
1009
 
 
1010
 
        merged = 0
1011
 
        time0 = time.time()
1012
 
        for other_idx, name in names_to_join:
1013
 
            # TODO: If all the parents of the other version are already
1014
 
            # present then we can avoid some work by just taking the delta
1015
 
            # and adjusting the offsets.
1016
 
            new_parents = self._imported_parents(other, other_idx)
1017
 
            sha1 = other._sha1s[other_idx]
1018
 
 
1019
 
            merged += 1
1020
 
 
1021
 
            if pb:
1022
 
                pb.update(msg, merged, len(names_to_join))
1023
 
           
1024
 
            lines = other.get_lines(other_idx)
1025
 
            self._add(name, lines, new_parents, sha1)
1026
 
 
1027
 
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
1028
 
                merged, processed, self._weave_name, time.time()-time0))
1029
 
 
1030
 
    def _imported_parents(self, other, other_idx):
1031
 
        """Return list of parents in self corresponding to indexes in other."""
1032
 
        new_parents = []
1033
 
        for parent_idx in other._parents[other_idx]:
1034
 
            parent_name = other._names[parent_idx]
1035
 
            if parent_name not in self._name_map:
1036
 
                # should not be possible
1037
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
1038
 
                                 % (parent_name, other._name_map[other_idx], self))
1039
 
            new_parents.append(self._name_map[parent_name])
1040
 
        return new_parents
1041
 
 
1042
 
    def _check_version_consistent(self, other, other_idx, name):
1043
 
        """Check if a version in consistent in this and other.
1044
 
 
1045
 
        To be consistent it must have:
1046
 
 
1047
 
         * the same text
1048
 
         * the same direct parents (by name, not index, and disregarding
1049
 
           order)
1050
 
        
1051
 
        If present & correct return True;
1052
 
        if not present in self return False; 
1053
 
        if inconsistent raise error."""
1054
 
        this_idx = self._name_map.get(name, -1)
1055
 
        if this_idx != -1:
1056
 
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
1057
 
                raise errors.WeaveTextDiffers(name, self, other)
1058
 
            self_parents = self._parents[this_idx]
1059
 
            other_parents = other._parents[other_idx]
1060
 
            n1 = set([self._names[i] for i in self_parents])
1061
 
            n2 = set([other._names[i] for i in other_parents])
1062
 
            if not self._compatible_parents(n1, n2):
1063
 
                raise WeaveParentMismatch("inconsistent parents "
1064
 
                    "for version {%s}: %s vs %s" % (name, n1, n2))
1065
 
            else:
1066
 
                return True         # ok!
1067
 
        else:
1068
 
            return False
1069
 
 
1070
 
    @deprecated_method(zero_eight)
1071
 
    def reweave(self, other, pb=None, msg=None):
1072
 
        """reweave has been superceded by plain use of join."""
1073
 
        return self.join(other, pb, msg)
1074
 
 
1075
 
    def _reweave(self, other, pb, msg):
1076
 
        """Reweave self with other - internal helper for join().
1077
 
 
1078
 
        :param other: The other weave to merge
1079
 
        :param pb: An optional progress bar, indicating how far done we are
1080
 
        :param msg: An optional message for the progress
1081
 
        """
1082
 
        new_weave = _reweave(self, other, pb=pb, msg=msg)
1083
 
        self._copy_weave_content(new_weave)
1084
 
 
1085
 
    def _copy_weave_content(self, otherweave):
1086
 
        """adsorb the content from otherweave."""
1087
 
        for attr in self.__slots__:
1088
 
            if attr != '_weave_name':
1089
 
                setattr(self, attr, copy(getattr(otherweave, attr)))
1090
 
 
1091
 
 
1092
 
class WeaveFile(Weave):
1093
 
    """A WeaveFile represents a Weave on disk and writes on change."""
1094
 
 
1095
 
    WEAVE_SUFFIX = '.weave'
1096
 
    
1097
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
1098
 
        """Create a WeaveFile.
1099
 
        
1100
 
        :param create: If not True, only open an existing knit.
1101
 
        """
1102
 
        super(WeaveFile, self).__init__(name, access_mode)
1103
 
        self._transport = transport
1104
 
        self._filemode = filemode
1105
 
        try:
1106
 
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
1107
 
        except errors.NoSuchFile:
1108
 
            if not create:
1109
 
                raise
1110
 
            # new file, save it
1111
 
            self._save()
1112
 
 
1113
 
    def _add_lines(self, version_id, parents, lines, parent_texts):
1114
 
        """Add a version and save the weave."""
1115
 
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
1116
 
                                                   parent_texts)
1117
 
        self._save()
1118
 
        return result
1119
 
 
1120
 
    def _clone_text(self, new_version_id, old_version_id, parents):
1121
 
        """See VersionedFile.clone_text."""
1122
 
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
1123
 
        self._save
1124
 
 
1125
 
    def copy_to(self, name, transport):
1126
 
        """See VersionedFile.copy_to()."""
1127
 
        # as we are all in memory always, just serialise to the new place.
1128
 
        sio = StringIO()
1129
 
        write_weave_v5(self, sio)
1130
 
        sio.seek(0)
1131
 
        transport.put(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
1132
 
 
1133
 
    def create_empty(self, name, transport, filemode=None):
1134
 
        return WeaveFile(name, transport, filemode, create=True)
1135
 
 
1136
 
    def _save(self):
1137
 
        """Save the weave."""
1138
 
        self._check_write_ok()
1139
 
        sio = StringIO()
1140
 
        write_weave_v5(self, sio)
1141
 
        sio.seek(0)
1142
 
        self._transport.put(self._weave_name + WeaveFile.WEAVE_SUFFIX,
1143
 
                            sio,
1144
 
                            self._filemode)
1145
 
 
1146
 
    @staticmethod
1147
 
    def get_suffixes():
1148
 
        """See VersionedFile.get_suffixes()."""
1149
 
        return [WeaveFile.WEAVE_SUFFIX]
1150
 
 
1151
 
    def join(self, other, pb=None, msg=None, version_ids=None,
1152
 
             ignore_missing=False):
1153
 
        """Join other into self and save."""
1154
 
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
1155
 
        self._save()
1156
 
 
1157
 
 
1158
 
@deprecated_function(zero_eight)
1159
 
def reweave(wa, wb, pb=None, msg=None):
1160
 
    """reweaving is deprecation, please just use weave.join()."""
1161
 
    _reweave(wa, wb, pb, msg)
1162
 
 
1163
 
def _reweave(wa, wb, pb=None, msg=None):
1164
 
    """Combine two weaves and return the result.
1165
 
 
1166
 
    This works even if a revision R has different parents in 
1167
 
    wa and wb.  In the resulting weave all the parents are given.
1168
 
 
1169
 
    This is done by just building up a new weave, maintaining ordering 
1170
 
    of the versions in the two inputs.  More efficient approaches
1171
 
    might be possible but it should only be necessary to do 
1172
 
    this operation rarely, when a new previously ghost version is 
1173
 
    inserted.
1174
 
 
1175
 
    :param pb: An optional progress bar, indicating how far done we are
1176
 
    :param msg: An optional message for the progress
1177
 
    """
1178
 
    wr = Weave()
1179
 
    ia = ib = 0
1180
 
    queue_a = range(wa.num_versions())
1181
 
    queue_b = range(wb.num_versions())
1182
 
    # first determine combined parents of all versions
1183
 
    # map from version name -> all parent names
1184
 
    combined_parents = _reweave_parent_graphs(wa, wb)
1185
 
    mutter("combined parents: %r", combined_parents)
1186
 
    order = topo_sort(combined_parents.iteritems())
1187
 
    mutter("order to reweave: %r", order)
1188
 
 
1189
 
    if pb and not msg:
1190
 
        msg = 'reweave'
1191
 
 
1192
 
    for idx, name in enumerate(order):
1193
 
        if pb:
1194
 
            pb.update(msg, idx, len(order))
1195
 
        if name in wa._name_map:
1196
 
            lines = wa.get_lines(name)
1197
 
            if name in wb._name_map:
1198
 
                lines_b = wb.get_lines(name)
1199
 
                if lines != lines_b:
1200
 
                    mutter('Weaves differ on content. rev_id {%s}', name)
1201
 
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
1202
 
                    import difflib
1203
 
                    lines = list(difflib.unified_diff(lines, lines_b,
1204
 
                            wa._weave_name, wb._weave_name))
1205
 
                    mutter('lines:\n%s', ''.join(lines))
1206
 
                    raise errors.WeaveTextDiffers(name, wa, wb)
1207
 
        else:
1208
 
            lines = wb.get_lines(name)
1209
 
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1210
 
    return wr
1211
 
 
1212
 
def _reweave_parent_graphs(wa, wb):
1213
 
    """Return combined parent ancestry for two weaves.
1214
 
    
1215
 
    Returned as a list of (version_name, set(parent_names))"""
1216
 
    combined = {}
1217
 
    for weave in [wa, wb]:
1218
 
        for idx, name in enumerate(weave._names):
1219
 
            p = combined.setdefault(name, set())
1220
 
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1221
 
    return combined
 
569
 
 
570
 
 
571
    def merge(self, merge_versions):
 
572
        """Automerge and mark conflicts between versions.
 
573
 
 
574
        This returns a sequence, each entry describing alternatives
 
575
        for a chunk of the file.  Each of the alternatives is given as
 
576
        a list of lines.
 
577
 
 
578
        If there is a chunk of the file where there's no diagreement,
 
579
        only one alternative is given.
 
580
        """
 
581
 
 
582
        # approach: find the included versions common to all the
 
583
        # merged versions
 
584
        raise NotImplementedError()
 
585
 
 
586
 
 
587
 
 
588
    def _delta(self, included, lines):
 
589
        """Return changes from basis to new revision.
 
590
 
 
591
        The old text for comparison is the union of included revisions.
 
592
 
 
593
        This is used in inserting a new text.
 
594
 
 
595
        Delta is returned as a sequence of
 
596
        (weave1, weave2, newlines).
 
597
 
 
598
        This indicates that weave1:weave2 of the old weave should be
 
599
        replaced by the sequence of lines in newlines.  Note that
 
600
        these line numbers are positions in the total weave and don't
 
601
        correspond to the lines in any extracted version, or even the
 
602
        extracted union of included versions.
 
603
 
 
604
        If line1=line2, this is a pure insert; if newlines=[] this is a
 
605
        pure delete.  (Similar to difflib.)
 
606
        """
 
607
 
 
608
 
 
609
            
 
610
    def plan_merge(self, ver_a, ver_b):
 
611
        """Return pseudo-annotation indicating how the two versions merge.
 
612
 
 
613
        This is computed between versions a and b and their common
 
614
        base.
 
615
 
 
616
        Weave lines present in none of them are skipped entirely.
 
617
        """
 
618
        inc_a = self.inclusions([ver_a])
 
619
        inc_b = self.inclusions([ver_b])
 
620
        inc_c = inc_a & inc_b
 
621
 
 
622
        for lineno, insert, deleteset, line in self._walk():
 
623
            if deleteset & inc_c:
 
624
                # killed in parent; can't be in either a or b
 
625
                # not relevant to our work
 
626
                yield 'killed-base', line
 
627
            elif insert in inc_c:
 
628
                # was inserted in base
 
629
                killed_a = bool(deleteset & inc_a)
 
630
                killed_b = bool(deleteset & inc_b)
 
631
                if killed_a and killed_b:
 
632
                    yield 'killed-both', line
 
633
                elif killed_a:
 
634
                    yield 'killed-a', line
 
635
                elif killed_b:
 
636
                    yield 'killed-b', line
 
637
                else:
 
638
                    yield 'unchanged', line
 
639
            elif insert in inc_a:
 
640
                if deleteset & inc_a:
 
641
                    yield 'ghost-a', line
 
642
                else:
 
643
                    # new in A; not in B
 
644
                    yield 'new-a', line
 
645
            elif insert in inc_b:
 
646
                if deleteset & inc_b:
 
647
                    yield 'ghost-b', line
 
648
                else:
 
649
                    yield 'new-b', line
 
650
            else:
 
651
                # not in either revision
 
652
                yield 'irrelevant', line
 
653
 
 
654
        yield 'unchanged', ''           # terminator
 
655
 
 
656
 
 
657
 
 
658
    def weave_merge(self, plan):
 
659
        lines_a = []
 
660
        lines_b = []
 
661
        ch_a = ch_b = False
 
662
 
 
663
        for state, line in plan:
 
664
            if state == 'unchanged' or state == 'killed-both':
 
665
                # resync and flush queued conflicts changes if any
 
666
                if not lines_a and not lines_b:
 
667
                    pass
 
668
                elif ch_a and not ch_b:
 
669
                    # one-sided change:                    
 
670
                    for l in lines_a: yield l
 
671
                elif ch_b and not ch_a:
 
672
                    for l in lines_b: yield l
 
673
                elif lines_a == lines_b:
 
674
                    for l in lines_a: yield l
 
675
                else:
 
676
                    yield '<<<<\n'
 
677
                    for l in lines_a: yield l
 
678
                    yield '====\n'
 
679
                    for l in lines_b: yield l
 
680
                    yield '>>>>\n'
 
681
 
 
682
                del lines_a[:]
 
683
                del lines_b[:]
 
684
                ch_a = ch_b = False
 
685
                
 
686
            if state == 'unchanged':
 
687
                if line:
 
688
                    yield line
 
689
            elif state == 'killed-a':
 
690
                ch_a = True
 
691
                lines_b.append(line)
 
692
            elif state == 'killed-b':
 
693
                ch_b = True
 
694
                lines_a.append(line)
 
695
            elif state == 'new-a':
 
696
                ch_a = True
 
697
                lines_a.append(line)
 
698
            elif state == 'new-b':
 
699
                ch_b = True
 
700
                lines_b.append(line)
 
701
            else:
 
702
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
 
703
                                 'killed-both'), \
 
704
                       state
 
705
 
 
706
                
 
707
 
 
708
 
 
709
 
1222
710
 
1223
711
 
1224
712
def weave_toc(w):
1227
715
    for i in (6, 50, 10, 10):
1228
716
        print '-' * i,
1229
717
    print
1230
 
    for i in range(w.num_versions()):
 
718
    for i in range(w.numversions()):
1231
719
        sha1 = w._sha1s[i]
1232
720
        name = w._names[i]
1233
721
        parent_str = ' '.join(map(str, w._parents[i]))
1235
723
 
1236
724
 
1237
725
 
1238
 
def weave_stats(weave_file, pb):
 
726
def weave_stats(weave_file):
 
727
    from bzrlib.progress import ProgressBar
1239
728
    from bzrlib.weavefile import read_weave
1240
729
 
 
730
    pb = ProgressBar()
 
731
 
1241
732
    wf = file(weave_file, 'rb')
1242
 
    w = read_weave(wf, WeaveVersionedFile)
 
733
    w = read_weave(wf)
1243
734
    # FIXME: doesn't work on pipes
1244
735
    weave_size = wf.tell()
1245
736
 
1247
738
    vers = len(w)
1248
739
    for i in range(vers):
1249
740
        pb.update('checking sizes', i, vers)
1250
 
        for origin, lineno, line in w._extract([i]):
 
741
        for line in w.get_iter(i):
1251
742
            total += len(line)
1252
743
 
1253
744
    pb.clear()
1280
771
        Add NEWTEXT, with specified parent versions.
1281
772
    weave annotate WEAVEFILE VERSION
1282
773
        Display origin of each line.
 
774
    weave mash WEAVEFILE VERSION...
 
775
        Display composite of all selected versions.
1283
776
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1284
777
        Auto-merge two versions and display conflicts.
1285
 
    weave diff WEAVEFILE VERSION1 VERSION2 
1286
 
        Show differences between two versions.
1287
778
 
1288
779
example:
1289
780
 
1314
805
def main(argv):
1315
806
    import sys
1316
807
    import os
1317
 
    try:
1318
 
        import bzrlib
1319
 
    except ImportError:
1320
 
        # in case we're run directly from the subdirectory
1321
 
        sys.path.append('..')
1322
 
        import bzrlib
1323
 
    from bzrlib.weavefile import write_weave, read_weave
 
808
    from weavefile import write_weave, read_weave
1324
809
    from bzrlib.progress import ProgressBar
1325
810
 
1326
811
    try:
1359
844
        w = readit()
1360
845
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1361
846
        
1362
 
    elif cmd == 'diff':
1363
 
        from difflib import unified_diff
 
847
    elif cmd == 'mash': # get composite
1364
848
        w = readit()
1365
 
        fn = argv[2]
1366
 
        v1, v2 = map(int, argv[3:5])
1367
 
        lines1 = w.get(v1)
1368
 
        lines2 = w.get(v2)
1369
 
        diff_gen = unified_diff(lines1, lines2,
1370
 
                                '%s version %d' % (fn, v1),
1371
 
                                '%s version %d' % (fn, v2))
1372
 
        sys.stdout.writelines(diff_gen)
1373
 
            
 
849
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
850
 
1374
851
    elif cmd == 'annotate':
1375
852
        w = readit()
1376
853
        # newline is added to all lines regardless; too hard to get
1388
865
        weave_toc(readit())
1389
866
 
1390
867
    elif cmd == 'stats':
1391
 
        weave_stats(argv[2], ProgressBar())
 
868
        weave_stats(argv[2])
1392
869
        
1393
870
    elif cmd == 'check':
1394
871
        w = readit()
1395
872
        pb = ProgressBar()
1396
873
        w.check(pb)
1397
874
        pb.clear()
1398
 
        print '%d versions ok' % w.num_versions()
 
875
        print '%d versions ok' % w.numversions()
1399
876
 
1400
877
    elif cmd == 'inclusions':
1401
878
        w = readit()
1406
883
        print ' '.join(map(str, w._parents[int(argv[3])]))
1407
884
 
1408
885
    elif cmd == 'plan-merge':
1409
 
        # replaced by 'bzr weave-plan-merge'
1410
886
        w = readit()
1411
887
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1412
888
            if line:
1413
889
                print '%14s | %s' % (state, line),
 
890
 
1414
891
    elif cmd == 'merge':
1415
 
        # replaced by 'bzr weave-merge-text'
1416
892
        w = readit()
1417
893
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1418
894
        sys.stdout.writelines(w.weave_merge(p))
 
895
            
 
896
    elif cmd == 'mash-merge':
 
897
        if len(argv) != 5:
 
898
            usage()
 
899
            return 1
 
900
 
 
901
        w = readit()
 
902
        v1, v2 = map(int, argv[3:5])
 
903
 
 
904
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
 
905
 
 
906
        base_lines = list(w.mash_iter(basis))
 
907
        a_lines = list(w.get(v1))
 
908
        b_lines = list(w.get(v2))
 
909
 
 
910
        from bzrlib.merge3 import Merge3
 
911
        m3 = Merge3(base_lines, a_lines, b_lines)
 
912
 
 
913
        name_a = 'version %d' % v1
 
914
        name_b = 'version %d' % v2
 
915
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
1419
916
    else:
1420
917
        raise ValueError('unknown command %r' % cmd)
1421
918
    
1422
919
 
1423
920
 
1424
 
def profile_main(argv):
 
921
def profile_main(argv): 
1425
922
    import tempfile, hotshot, hotshot.stats
1426
923
 
1427
924
    prof_f = tempfile.NamedTemporaryFile()
1441
938
    return ret
1442
939
 
1443
940
 
1444
 
def lsprofile_main(argv): 
1445
 
    from bzrlib.lsprof import profile
1446
 
    ret,stats = profile(main, argv)
1447
 
    stats.sort()
1448
 
    stats.pprint()
1449
 
    return ret
1450
 
 
1451
 
 
1452
941
if __name__ == '__main__':
1453
942
    import sys
1454
943
    if '--profile' in sys.argv:
1455
944
        args = sys.argv[:]
1456
945
        args.remove('--profile')
1457
946
        sys.exit(profile_main(args))
1458
 
    elif '--lsprof' in sys.argv:
1459
 
        args = sys.argv[:]
1460
 
        args.remove('--lsprof')
1461
 
        sys.exit(lsprofile_main(args))
1462
947
    else:
1463
948
        sys.exit(main(sys.argv))
1464
949
 
1465
 
 
1466
 
class InterWeave(InterVersionedFile):
1467
 
    """Optimised code paths for weave to weave operations."""
1468
 
    
1469
 
    _matching_file_factory = staticmethod(WeaveFile)
1470
 
    
1471
 
    @staticmethod
1472
 
    def is_compatible(source, target):
1473
 
        """Be compatible with weaves."""
1474
 
        try:
1475
 
            return (isinstance(source, Weave) and
1476
 
                    isinstance(target, Weave))
1477
 
        except AttributeError:
1478
 
            return False
1479
 
 
1480
 
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1481
 
        """See InterVersionedFile.join."""
1482
 
        if self.target.versions() == []:
1483
 
            # optimised copy
1484
 
            self.target._copy_weave_content(self.source)
1485
 
            return
1486
 
        try:
1487
 
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1488
 
        except errors.WeaveParentMismatch:
1489
 
            self.target._reweave(self.source, pb, msg)
1490
 
 
1491
 
 
1492
 
InterVersionedFile.register_optimiser(InterWeave)