~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2005-08-25 05:58:05 UTC
  • mfrom: (974.1.36)
  • Revision ID: mbp@sourcefrog.net-20050825055805-8c892bc3c2d75131
- merge aaron's merge improvements:

  * When merging, pull in all missing revisions from the source
    branch. 

  * Detect common ancestors by looking at the whole ancestry graph, 
    rather than just mainline history.

  Some changes to reconcile this with parallel updates to the test and
  trace code.

aaron.bentley@utoronto.ca-20050823052551-f3401a8b57d9126f

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
 
        self._check_lines_not_unicode(lines)
467
 
        self._check_lines_are_lines(lines)
468
 
        if not sha1:
469
 
            sha1 = sha_strings(lines)
470
 
        if version_id in self._name_map:
471
 
            return self._check_repeated_add(version_id, parents, lines, sha1)
472
 
 
 
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
        
473
234
        self._check_versions(parents)
474
 
        ## self._check_lines(lines)
 
235
        ## self._check_lines(text)
475
236
        new_version = len(self._parents)
476
237
 
 
238
        s = sha.new()
 
239
        map(s.update, text)
 
240
        sha1 = s.hexdigest()
 
241
        del s
 
242
 
477
243
        # if we abort after here the (in-memory) weave will be corrupt because only
478
244
        # some fields are updated
479
 
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
480
 
        #      - Robert Collins 20060226
481
245
        self._parents.append(parents[:])
482
246
        self._sha1s.append(sha1)
483
 
        self._names.append(version_id)
484
 
        self._name_map[version_id] = new_version
 
247
        self._names.append(name)
 
248
        self._name_map[name] = new_version
485
249
 
486
250
            
487
251
        if not parents:
489
253
            # this more quickly by just appending unconditionally.
490
254
            # even more specially, if we're adding an empty text we
491
255
            # need do nothing at all.
492
 
            if lines:
 
256
            if text:
493
257
                self._weave.append(('{', new_version))
494
 
                self._weave.extend(lines)
 
258
                self._weave.extend(text)
495
259
                self._weave.append(('}', None))
 
260
        
496
261
            return new_version
497
262
 
498
263
        if len(parents) == 1:
502
267
                return new_version
503
268
            
504
269
 
505
 
        ancestors = self._inclusions(parents)
 
270
        ancestors = self.inclusions(parents)
506
271
 
507
272
        l = self._weave
508
273
 
515
280
 
516
281
        # another small special case: a merge, producing the same text
517
282
        # as auto-merge
518
 
        if lines == basis_lines:
 
283
        if text == basis_lines:
519
284
            return new_version            
520
285
 
521
286
        # add a sentinal, because we can also match against the final line
528
293
        #print 'basis_lines:', basis_lines
529
294
        #print 'new_lines:  ', lines
530
295
 
531
 
        s = SequenceMatcher(None, basis_lines, lines)
 
296
        from difflib import SequenceMatcher
 
297
        s = SequenceMatcher(None, basis_lines, text)
532
298
 
533
299
        # offset gives the number of lines that have been inserted
534
300
        # into the weave up to the current point; if the original edit instruction
545
311
            i1 = basis_lineno[i1]
546
312
            i2 = basis_lineno[i2]
547
313
 
548
 
            assert 0 <= j1 <= j2 <= len(lines)
 
314
            assert 0 <= j1 <= j2 <= len(text)
549
315
 
550
316
            #print tag, i1, i2, j1, j2
551
317
 
562
328
                # we don't destroy ourselves
563
329
                i = i2 + offset
564
330
                self._weave[i:i] = ([('{', new_version)] 
565
 
                                    + lines[j1:j2] 
 
331
                                    + text[j1:j2] 
566
332
                                    + [('}', None)])
567
333
                offset += 2 + (j2 - j1)
 
334
 
568
335
        return new_version
569
336
 
570
 
    def _clone_text(self, new_version_id, old_version_id, parents):
571
 
        """See VersionedFile.clone_text."""
572
 
        old_lines = self.get_text(old_version_id)
573
 
        self.add_lines(new_version_id, parents, old_lines)
574
337
 
575
 
    def _inclusions(self, versions):
 
338
    def inclusions(self, versions):
576
339
        """Return set of all ancestors of given version(s)."""
577
 
        if not len(versions):
578
 
            return []
579
340
        i = set(versions)
580
 
        for v in xrange(max(versions), 0, -1):
581
 
            if v in i:
582
 
                # include all its parents
583
 
                i.update(self._parents[v])
584
 
        return i
585
 
        ## except IndexError:
586
 
        ##     raise ValueError("version %d not present in weave" % v)
587
 
 
588
 
    @deprecated_method(zero_eight)
589
 
    def inclusions(self, version_ids):
590
 
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
591
 
        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:
592
357
            return []
593
 
        if isinstance(version_ids[0], int):
594
 
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
595
 
        else:
596
 
            return self.get_ancestry(version_ids)
597
 
 
598
 
    def get_ancestry(self, version_ids):
599
 
        """See VersionedFile.get_ancestry."""
600
 
        if isinstance(version_ids, basestring):
601
 
            version_ids = [version_ids]
602
 
        i = self._inclusions([self._lookup(v) for v in version_ids])
603
 
        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
 
604
375
 
605
376
    def _check_lines(self, text):
606
377
        if not isinstance(text, list):
621
392
            except IndexError:
622
393
                raise IndexError("invalid version number %r" % i)
623
394
 
624
 
    def _compatible_parents(self, my_parents, other_parents):
625
 
        """During join check that other_parents are joinable with my_parents.
626
 
 
627
 
        Joinable is defined as 'is a subset of' - supersets may require 
628
 
        regeneration of diffs, but subsets do not.
629
 
        """
630
 
        return len(other_parents.difference(my_parents)) == 0
631
 
 
632
 
    def annotate(self, version_id):
633
 
        if isinstance(version_id, int):
634
 
            warn('Weave.annotate(int) is deprecated. Please use version names'
635
 
                 ' in all circumstances as of 0.8',
636
 
                 DeprecationWarning,
637
 
                 stacklevel=2
638
 
                 )
639
 
            result = []
640
 
            for origin, lineno, text in self._extract([version_id]):
641
 
                result.append((origin, text))
642
 
            return result
643
 
        else:
644
 
            return super(Weave, self).annotate(version_id)
645
395
    
646
 
    def annotate_iter(self, version_id):
647
 
        """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.
648
402
 
649
403
        The index indicates when the line originated in the weave."""
650
 
        incls = [self._lookup(version_id)]
651
 
        for origin, lineno, text in self._extract(incls):
652
 
            yield self._idx_to_name(origin), text
653
 
 
654
 
    @deprecated_method(zero_eight)
 
404
        for origin, lineno, text in self._extract([version]):
 
405
            yield origin, text
 
406
 
 
407
 
655
408
    def _walk(self):
656
 
        """_walk has become visit, a supported api."""
657
 
        return self._walk_internal()
658
 
 
659
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None):
660
 
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
661
 
        if version_ids is None:
662
 
            version_ids = self.versions()
663
 
        version_ids = set(version_ids)
664
 
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
665
 
            # if inserted not in version_ids then it was inserted before the
666
 
            # versions we care about, but because weaves cannot represent ghosts
667
 
            # properly, we do not filter down to that
668
 
            # if inserted not in version_ids: continue
669
 
            if line[-1] != '\n':
670
 
                yield line + '\n'
671
 
            else:
672
 
                yield line
673
 
 
674
 
    #@deprecated_method(zero_eight)
675
 
    def walk(self, version_ids=None):
676
 
        """See VersionedFile.walk."""
677
 
        return self._walk_internal(version_ids)
678
 
 
679
 
    def _walk_internal(self, version_ids=None):
680
 
        """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
        """
681
415
        
682
416
        istack = []
683
417
        dset = set()
685
419
        lineno = 0         # line of weave, 0-based
686
420
 
687
421
        for l in self._weave:
688
 
            if l.__class__ == tuple:
 
422
            if isinstance(l, tuple):
689
423
                c, v = l
690
424
                isactive = None
691
425
                if c == '{':
692
 
                    istack.append(self._names[v])
 
426
                    istack.append(v)
693
427
                elif c == '}':
694
428
                    istack.pop()
695
429
                elif c == '[':
696
 
                    assert self._names[v] not in dset
697
 
                    dset.add(self._names[v])
 
430
                    assert v not in dset
 
431
                    dset.add(v)
698
432
                elif c == ']':
699
 
                    dset.remove(self._names[v])
 
433
                    dset.remove(v)
700
434
                else:
701
 
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
435
                    raise WeaveFormatError('unexpected instruction %r'
 
436
                                           % v)
702
437
            else:
703
 
                assert l.__class__ in (str, unicode)
 
438
                assert isinstance(l, basestring)
704
439
                assert istack
705
 
                yield lineno, istack[-1], frozenset(dset), l
 
440
                yield lineno, istack[-1], dset, l
706
441
            lineno += 1
707
442
 
708
 
        if istack:
709
 
            raise WeaveFormatError("unclosed insertion blocks "
710
 
                    "at end of weave: %s" % istack)
711
 
        if dset:
712
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
713
 
                                   % dset)
714
 
 
715
 
    def plan_merge(self, ver_a, ver_b):
716
 
        """Return pseudo-annotation indicating how the two versions merge.
717
 
 
718
 
        This is computed between versions a and b and their common
719
 
        base.
720
 
 
721
 
        Weave lines present in none of them are skipped entirely.
722
 
        """
723
 
        inc_a = set(self.get_ancestry([ver_a]))
724
 
        inc_b = set(self.get_ancestry([ver_b]))
725
 
        inc_c = inc_a & inc_b
726
 
 
727
 
        for lineno, insert, deleteset, line in\
728
 
            self.walk([ver_a, ver_b]):
729
 
            if deleteset & inc_c:
730
 
                # killed in parent; can't be in either a or b
731
 
                # not relevant to our work
732
 
                yield 'killed-base', line
733
 
            elif insert in inc_c:
734
 
                # was inserted in base
735
 
                killed_a = bool(deleteset & inc_a)
736
 
                killed_b = bool(deleteset & inc_b)
737
 
                if killed_a and killed_b:
738
 
                    yield 'killed-both', line
739
 
                elif killed_a:
740
 
                    yield 'killed-a', line
741
 
                elif killed_b:
742
 
                    yield 'killed-b', line
743
 
                else:
744
 
                    yield 'unchanged', line
745
 
            elif insert in inc_a:
746
 
                if deleteset & inc_a:
747
 
                    yield 'ghost-a', line
748
 
                else:
749
 
                    # new in A; not in B
750
 
                    yield 'new-a', line
751
 
            elif insert in inc_b:
752
 
                if deleteset & inc_b:
753
 
                    yield 'ghost-b', line
754
 
                else:
755
 
                    yield 'new-b', line
756
 
            else:
757
 
                # not in either revision
758
 
                yield 'irrelevant', line
759
 
 
760
 
        yield 'unchanged', ''           # terminator
 
443
 
761
444
 
762
445
    def _extract(self, versions):
763
446
        """Yield annotation of lines in included set.
768
451
 
769
452
        The set typically but not necessarily corresponds to a version.
770
453
        """
771
 
        for i in versions:
772
 
            if not isinstance(i, int):
773
 
                raise ValueError(i)
774
 
            
775
 
        included = self._inclusions(versions)
 
454
        included = self.inclusions(versions)
776
455
 
777
456
        istack = []
778
 
        iset = set()
779
457
        dset = set()
780
458
 
781
459
        lineno = 0         # line of weave, 0-based
786
464
 
787
465
        WFE = WeaveFormatError
788
466
 
789
 
        # wow. 
790
 
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
791
 
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
792
 
        # 1.6 seconds in 'isinstance'.
793
 
        # changing the first isinstance:
794
 
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
795
 
        #  +140414   0    762.8050    762.8050   +<isinstance>
796
 
        # note that the inline time actually dropped (less function calls)
797
 
        # and total processing time was halved.
798
 
        # we're still spending ~1/4 of the method in isinstance though.
799
 
        # so lets hard code the acceptable string classes we expect:
800
 
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
801
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
802
 
        #                                          objects>
803
 
        # yay, down to ~1/4 the initial extract time, and our inline time
804
 
        # has shrunk again, with isinstance no longer dominating.
805
 
        # tweaking the stack inclusion test to use a set gives:
806
 
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
807
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
808
 
        #                                          objects>
809
 
        # - a 5% win, or possibly just noise. However with large istacks that
810
 
        # 'in' test could dominate, so I'm leaving this change in place -
811
 
        # when its fast enough to consider profiling big datasets we can review.
812
 
 
813
 
              
814
 
             
815
 
 
816
467
        for l in self._weave:
817
 
            if l.__class__ == tuple:
 
468
            if isinstance(l, tuple):
818
469
                c, v = l
819
470
                isactive = None
820
471
                if c == '{':
821
 
                    assert v not in iset
 
472
                    assert v not in istack
822
473
                    istack.append(v)
823
 
                    iset.add(v)
824
474
                elif c == '}':
825
 
                    iset.remove(istack.pop())
 
475
                    istack.pop()
826
476
                elif c == '[':
827
477
                    if v in included:
828
478
                        assert v not in dset
833
483
                        assert v in dset
834
484
                        dset.remove(v)
835
485
            else:
836
 
                assert l.__class__ in (str, unicode)
 
486
                assert isinstance(l, basestring)
837
487
                if isactive is None:
838
488
                    isactive = (not dset) and istack and (istack[-1] in included)
839
489
                if isactive:
840
490
                    result.append((istack[-1], lineno, l))
841
491
            lineno += 1
 
492
 
842
493
        if istack:
843
 
            raise WeaveFormatError("unclosed insertion blocks "
844
 
                    "at end of weave: %s" % istack)
 
494
            raise WFE("unclosed insertion blocks at end of weave",
 
495
                                   istack)
845
496
        if dset:
846
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
847
 
                                   % dset)
848
 
        return result
849
 
 
850
 
    @deprecated_method(zero_eight)
851
 
    def get_iter(self, name_or_index):
852
 
        """Deprecated, please do not use. Lookups are not not needed.
853
 
        
854
 
        Please use get_lines now.
855
 
        """
856
 
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
857
 
 
858
 
    @deprecated_method(zero_eight)
859
 
    def maybe_lookup(self, name_or_index):
860
 
        """Deprecated, please do not use. Lookups are not not needed."""
861
 
        return self._maybe_lookup(name_or_index)
862
 
 
863
 
    def _maybe_lookup(self, name_or_index):
864
 
        """Convert possible symbolic name to index, or pass through indexes.
865
 
        
866
 
        NOT FOR PUBLIC USE.
867
 
        """
868
 
        if isinstance(name_or_index, (int, long)):
869
 
            return name_or_index
870
 
        else:
871
 
            return self._lookup(name_or_index)
872
 
 
873
 
    @deprecated_method(zero_eight)
874
 
    def get(self, version_id):
875
 
        """Please use either Weave.get_text or Weave.get_lines as desired."""
876
 
        return self.get_lines(version_id)
877
 
 
878
 
    def get_lines(self, version_id):
879
 
        """See VersionedFile.get_lines()."""
880
 
        int_index = self._maybe_lookup(version_id)
881
 
        result = [line for (origin, lineno, line) in self._extract([int_index])]
882
 
        expected_sha1 = self._sha1s[int_index]
883
 
        measured_sha1 = sha_strings(result)
884
 
        if measured_sha1 != expected_sha1:
885
 
            raise errors.WeaveInvalidChecksum(
886
 
                    'file %s, revision %s, expected: %s, measured %s' 
887
 
                    % (self._weave_name, version_id,
888
 
                       expected_sha1, measured_sha1))
889
 
        return result
890
 
 
891
 
    def get_sha1(self, version_id):
892
 
        """See VersionedFile.get_sha1()."""
893
 
        return self._sha1s[self._lookup(version_id)]
894
 
 
895
 
    @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
 
896
529
    def numversions(self):
897
 
        """How many versions are in this weave?
898
 
 
899
 
        Deprecated in favour of num_versions.
900
 
        """
901
 
        return self.num_versions()
902
 
 
903
 
    def num_versions(self):
904
 
        """How many versions are in this weave?"""
905
530
        l = len(self._parents)
906
531
        assert l == len(self._sha1s)
907
532
        return l
908
533
 
909
 
    __len__ = num_versions
 
534
 
 
535
    def __len__(self):
 
536
        return self.numversions()
 
537
 
910
538
 
911
539
    def check(self, progress_bar=None):
912
 
        # TODO evaluate performance hit of using string sets in this routine.
913
 
        # TODO: check no circular inclusions
914
 
        # TODO: create a nested progress bar
915
 
        for version in range(self.num_versions()):
 
540
        # check no circular inclusions
 
541
        for version in range(self.numversions()):
916
542
            inclusions = list(self._parents[version])
917
543
            if inclusions:
918
544
                inclusions.sort()
920
546
                    raise WeaveFormatError("invalid included version %d for index %d"
921
547
                                           % (inclusions[-1], version))
922
548
 
923
 
        # try extracting all versions; parallel extraction is used
924
 
        nv = self.num_versions()
925
 
        sha1s = {}
926
 
        texts = {}
927
 
        inclusions = {}
928
 
        for i in range(nv):
929
 
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
930
 
            # The problem is that set membership is much more expensive
931
 
            name = self._idx_to_name(i)
932
 
            sha1s[name] = sha.new()
933
 
            texts[name] = []
934
 
            new_inc = set([name])
935
 
            for p in self._parents[i]:
936
 
                new_inc.update(inclusions[self._idx_to_name(p)])
937
 
 
938
 
            assert set(new_inc) == set(self.get_ancestry(name)), \
939
 
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
940
 
            inclusions[name] = new_inc
941
 
 
942
 
        nlines = len(self._weave)
943
 
 
944
 
        update_text = 'checking weave'
945
 
        if self._weave_name:
946
 
            short_name = os.path.basename(self._weave_name)
947
 
            update_text = 'checking %s' % (short_name,)
948
 
            update_text = update_text[:25]
949
 
 
950
 
        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):
951
553
            if progress_bar:
952
 
                progress_bar.update(update_text, lineno, nlines)
953
 
 
954
 
            for name, name_inclusions in inclusions.items():
955
 
                # The active inclusion must be an ancestor,
956
 
                # and no ancestors must have deleted this line,
957
 
                # because we don't support resurrection.
958
 
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
959
 
                    sha1s[name].update(line)
960
 
 
961
 
        for i in range(nv):
962
 
            version = self._idx_to_name(i)
963
 
            hd = sha1s[version].hexdigest()
964
 
            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]
965
560
            if hd != expected:
966
 
                raise errors.WeaveInvalidChecksum(
967
 
                        "mismatched sha1 for version %s: "
968
 
                        "got %s, expected %s"
969
 
                        % (version, hd, expected))
 
561
                raise WeaveError("mismatched sha1 for version %d; "
 
562
                                 "got %s, expected %s"
 
563
                                 % (version, hd, expected))
970
564
 
971
565
        # TODO: check insertions are properly nested, that there are
972
566
        # no lines outside of insertion blocks, that deletions are
973
567
        # properly paired, etc.
974
568
 
975
 
    def _join(self, other, pb, msg, version_ids, ignore_missing):
976
 
        """Worker routine for join()."""
977
 
        if not other.versions():
978
 
            return          # nothing to update, easy
979
 
 
980
 
        if not version_ids:
981
 
            # versions is never none, InterWeave checks this.
982
 
            return 0
983
 
 
984
 
        # two loops so that we do not change ourselves before verifying it
985
 
        # will be ok
986
 
        # work through in index order to make sure we get all dependencies
987
 
        names_to_join = []
988
 
        processed = 0
989
 
        # get the selected versions only that are in other.versions.
990
 
        version_ids = set(other.versions()).intersection(set(version_ids))
991
 
        # pull in the referenced graph.
992
 
        version_ids = other.get_ancestry(version_ids)
993
 
        pending_graph = [(version, other.get_parents(version)) for
994
 
                         version in version_ids]
995
 
        for name in topo_sort(pending_graph):
996
 
            other_idx = other._name_map[name]
997
 
            # returns True if we have it, False if we need it.
998
 
            if not self._check_version_consistent(other, other_idx, name):
999
 
                names_to_join.append((other_idx, name))
1000
 
            processed += 1
1001
 
 
1002
 
 
1003
 
        if pb and not msg:
1004
 
            msg = 'weave join'
1005
 
 
1006
 
        merged = 0
1007
 
        time0 = time.time()
1008
 
        for other_idx, name in names_to_join:
1009
 
            # TODO: If all the parents of the other version are already
1010
 
            # present then we can avoid some work by just taking the delta
1011
 
            # and adjusting the offsets.
1012
 
            new_parents = self._imported_parents(other, other_idx)
1013
 
            sha1 = other._sha1s[other_idx]
1014
 
 
1015
 
            merged += 1
1016
 
 
1017
 
            if pb:
1018
 
                pb.update(msg, merged, len(names_to_join))
1019
 
           
1020
 
            lines = other.get_lines(other_idx)
1021
 
            self._add(name, lines, new_parents, sha1)
1022
 
 
1023
 
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
1024
 
                merged, processed, self._weave_name, time.time()-time0))
1025
 
 
1026
 
    def _imported_parents(self, other, other_idx):
1027
 
        """Return list of parents in self corresponding to indexes in other."""
1028
 
        new_parents = []
1029
 
        for parent_idx in other._parents[other_idx]:
1030
 
            parent_name = other._names[parent_idx]
1031
 
            if parent_name not in self._name_map:
1032
 
                # should not be possible
1033
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
1034
 
                                 % (parent_name, other._name_map[other_idx], self))
1035
 
            new_parents.append(self._name_map[parent_name])
1036
 
        return new_parents
1037
 
 
1038
 
    def _check_version_consistent(self, other, other_idx, name):
1039
 
        """Check if a version in consistent in this and other.
1040
 
 
1041
 
        To be consistent it must have:
1042
 
 
1043
 
         * the same text
1044
 
         * the same direct parents (by name, not index, and disregarding
1045
 
           order)
1046
 
        
1047
 
        If present & correct return True;
1048
 
        if not present in self return False; 
1049
 
        if inconsistent raise error."""
1050
 
        this_idx = self._name_map.get(name, -1)
1051
 
        if this_idx != -1:
1052
 
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
1053
 
                raise errors.WeaveTextDiffers(name, self, other)
1054
 
            self_parents = self._parents[this_idx]
1055
 
            other_parents = other._parents[other_idx]
1056
 
            n1 = set([self._names[i] for i in self_parents])
1057
 
            n2 = set([other._names[i] for i in other_parents])
1058
 
            if not self._compatible_parents(n1, n2):
1059
 
                raise WeaveParentMismatch("inconsistent parents "
1060
 
                    "for version {%s}: %s vs %s" % (name, n1, n2))
1061
 
            else:
1062
 
                return True         # ok!
1063
 
        else:
1064
 
            return False
1065
 
 
1066
 
    @deprecated_method(zero_eight)
1067
 
    def reweave(self, other, pb=None, msg=None):
1068
 
        """reweave has been superceded by plain use of join."""
1069
 
        return self.join(other, pb, msg)
1070
 
 
1071
 
    def _reweave(self, other, pb, msg):
1072
 
        """Reweave self with other - internal helper for join().
1073
 
 
1074
 
        :param other: The other weave to merge
1075
 
        :param pb: An optional progress bar, indicating how far done we are
1076
 
        :param msg: An optional message for the progress
1077
 
        """
1078
 
        new_weave = _reweave(self, other, pb=pb, msg=msg)
1079
 
        self._copy_weave_content(new_weave)
1080
 
 
1081
 
    def _copy_weave_content(self, otherweave):
1082
 
        """adsorb the content from otherweave."""
1083
 
        for attr in self.__slots__:
1084
 
            if attr != '_weave_name':
1085
 
                setattr(self, attr, copy(getattr(otherweave, attr)))
1086
 
 
1087
 
 
1088
 
class WeaveFile(Weave):
1089
 
    """A WeaveFile represents a Weave on disk and writes on change."""
1090
 
 
1091
 
    WEAVE_SUFFIX = '.weave'
1092
 
    
1093
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
1094
 
        """Create a WeaveFile.
1095
 
        
1096
 
        :param create: If not True, only open an existing knit.
1097
 
        """
1098
 
        super(WeaveFile, self).__init__(name, access_mode)
1099
 
        self._transport = transport
1100
 
        self._filemode = filemode
1101
 
        try:
1102
 
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
1103
 
        except errors.NoSuchFile:
1104
 
            if not create:
1105
 
                raise
1106
 
            # new file, save it
1107
 
            self._save()
1108
 
 
1109
 
    def _add_lines(self, version_id, parents, lines, parent_texts):
1110
 
        """Add a version and save the weave."""
1111
 
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
1112
 
                                                   parent_texts)
1113
 
        self._save()
1114
 
        return result
1115
 
 
1116
 
    def _clone_text(self, new_version_id, old_version_id, parents):
1117
 
        """See VersionedFile.clone_text."""
1118
 
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
1119
 
        self._save
1120
 
 
1121
 
    def copy_to(self, name, transport):
1122
 
        """See VersionedFile.copy_to()."""
1123
 
        # as we are all in memory always, just serialise to the new place.
1124
 
        sio = StringIO()
1125
 
        write_weave_v5(self, sio)
1126
 
        sio.seek(0)
1127
 
        transport.put(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
1128
 
 
1129
 
    def create_empty(self, name, transport, filemode=None):
1130
 
        return WeaveFile(name, transport, filemode, create=True)
1131
 
 
1132
 
    def _save(self):
1133
 
        """Save the weave."""
1134
 
        self._check_write_ok()
1135
 
        sio = StringIO()
1136
 
        write_weave_v5(self, sio)
1137
 
        sio.seek(0)
1138
 
        self._transport.put(self._weave_name + WeaveFile.WEAVE_SUFFIX,
1139
 
                            sio,
1140
 
                            self._filemode)
1141
 
 
1142
 
    @staticmethod
1143
 
    def get_suffixes():
1144
 
        """See VersionedFile.get_suffixes()."""
1145
 
        return [WeaveFile.WEAVE_SUFFIX]
1146
 
 
1147
 
    def join(self, other, pb=None, msg=None, version_ids=None,
1148
 
             ignore_missing=False):
1149
 
        """Join other into self and save."""
1150
 
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
1151
 
        self._save()
1152
 
 
1153
 
 
1154
 
@deprecated_function(zero_eight)
1155
 
def reweave(wa, wb, pb=None, msg=None):
1156
 
    """reweaving is deprecation, please just use weave.join()."""
1157
 
    _reweave(wa, wb, pb, msg)
1158
 
 
1159
 
def _reweave(wa, wb, pb=None, msg=None):
1160
 
    """Combine two weaves and return the result.
1161
 
 
1162
 
    This works even if a revision R has different parents in 
1163
 
    wa and wb.  In the resulting weave all the parents are given.
1164
 
 
1165
 
    This is done by just building up a new weave, maintaining ordering 
1166
 
    of the versions in the two inputs.  More efficient approaches
1167
 
    might be possible but it should only be necessary to do 
1168
 
    this operation rarely, when a new previously ghost version is 
1169
 
    inserted.
1170
 
 
1171
 
    :param pb: An optional progress bar, indicating how far done we are
1172
 
    :param msg: An optional message for the progress
1173
 
    """
1174
 
    wr = Weave()
1175
 
    ia = ib = 0
1176
 
    queue_a = range(wa.num_versions())
1177
 
    queue_b = range(wb.num_versions())
1178
 
    # first determine combined parents of all versions
1179
 
    # map from version name -> all parent names
1180
 
    combined_parents = _reweave_parent_graphs(wa, wb)
1181
 
    mutter("combined parents: %r", combined_parents)
1182
 
    order = topo_sort(combined_parents.iteritems())
1183
 
    mutter("order to reweave: %r", order)
1184
 
 
1185
 
    if pb and not msg:
1186
 
        msg = 'reweave'
1187
 
 
1188
 
    for idx, name in enumerate(order):
1189
 
        if pb:
1190
 
            pb.update(msg, idx, len(order))
1191
 
        if name in wa._name_map:
1192
 
            lines = wa.get_lines(name)
1193
 
            if name in wb._name_map:
1194
 
                lines_b = wb.get_lines(name)
1195
 
                if lines != lines_b:
1196
 
                    mutter('Weaves differ on content. rev_id {%s}', name)
1197
 
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
1198
 
                    import difflib
1199
 
                    lines = list(difflib.unified_diff(lines, lines_b,
1200
 
                            wa._weave_name, wb._weave_name))
1201
 
                    mutter('lines:\n%s', ''.join(lines))
1202
 
                    raise errors.WeaveTextDiffers(name, wa, wb)
1203
 
        else:
1204
 
            lines = wb.get_lines(name)
1205
 
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1206
 
    return wr
1207
 
 
1208
 
def _reweave_parent_graphs(wa, wb):
1209
 
    """Return combined parent ancestry for two weaves.
1210
 
    
1211
 
    Returned as a list of (version_name, set(parent_names))"""
1212
 
    combined = {}
1213
 
    for weave in [wa, wb]:
1214
 
        for idx, name in enumerate(weave._names):
1215
 
            p = combined.setdefault(name, set())
1216
 
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1217
 
    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
 
1218
710
 
1219
711
 
1220
712
def weave_toc(w):
1223
715
    for i in (6, 50, 10, 10):
1224
716
        print '-' * i,
1225
717
    print
1226
 
    for i in range(w.num_versions()):
 
718
    for i in range(w.numversions()):
1227
719
        sha1 = w._sha1s[i]
1228
720
        name = w._names[i]
1229
721
        parent_str = ' '.join(map(str, w._parents[i]))
1231
723
 
1232
724
 
1233
725
 
1234
 
def weave_stats(weave_file, pb):
 
726
def weave_stats(weave_file):
 
727
    from bzrlib.progress import ProgressBar
1235
728
    from bzrlib.weavefile import read_weave
1236
729
 
 
730
    pb = ProgressBar()
 
731
 
1237
732
    wf = file(weave_file, 'rb')
1238
 
    w = read_weave(wf, WeaveVersionedFile)
 
733
    w = read_weave(wf)
1239
734
    # FIXME: doesn't work on pipes
1240
735
    weave_size = wf.tell()
1241
736
 
1243
738
    vers = len(w)
1244
739
    for i in range(vers):
1245
740
        pb.update('checking sizes', i, vers)
1246
 
        for origin, lineno, line in w._extract([i]):
 
741
        for line in w.get_iter(i):
1247
742
            total += len(line)
1248
743
 
1249
744
    pb.clear()
1276
771
        Add NEWTEXT, with specified parent versions.
1277
772
    weave annotate WEAVEFILE VERSION
1278
773
        Display origin of each line.
 
774
    weave mash WEAVEFILE VERSION...
 
775
        Display composite of all selected versions.
1279
776
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1280
777
        Auto-merge two versions and display conflicts.
1281
 
    weave diff WEAVEFILE VERSION1 VERSION2 
1282
 
        Show differences between two versions.
1283
778
 
1284
779
example:
1285
780
 
1310
805
def main(argv):
1311
806
    import sys
1312
807
    import os
1313
 
    try:
1314
 
        import bzrlib
1315
 
    except ImportError:
1316
 
        # in case we're run directly from the subdirectory
1317
 
        sys.path.append('..')
1318
 
        import bzrlib
1319
 
    from bzrlib.weavefile import write_weave, read_weave
 
808
    from weavefile import write_weave, read_weave
1320
809
    from bzrlib.progress import ProgressBar
1321
810
 
1322
811
    try:
1355
844
        w = readit()
1356
845
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1357
846
        
1358
 
    elif cmd == 'diff':
1359
 
        from difflib import unified_diff
 
847
    elif cmd == 'mash': # get composite
1360
848
        w = readit()
1361
 
        fn = argv[2]
1362
 
        v1, v2 = map(int, argv[3:5])
1363
 
        lines1 = w.get(v1)
1364
 
        lines2 = w.get(v2)
1365
 
        diff_gen = unified_diff(lines1, lines2,
1366
 
                                '%s version %d' % (fn, v1),
1367
 
                                '%s version %d' % (fn, v2))
1368
 
        sys.stdout.writelines(diff_gen)
1369
 
            
 
849
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
850
 
1370
851
    elif cmd == 'annotate':
1371
852
        w = readit()
1372
853
        # newline is added to all lines regardless; too hard to get
1384
865
        weave_toc(readit())
1385
866
 
1386
867
    elif cmd == 'stats':
1387
 
        weave_stats(argv[2], ProgressBar())
 
868
        weave_stats(argv[2])
1388
869
        
1389
870
    elif cmd == 'check':
1390
871
        w = readit()
1391
872
        pb = ProgressBar()
1392
873
        w.check(pb)
1393
874
        pb.clear()
1394
 
        print '%d versions ok' % w.num_versions()
 
875
        print '%d versions ok' % w.numversions()
1395
876
 
1396
877
    elif cmd == 'inclusions':
1397
878
        w = readit()
1402
883
        print ' '.join(map(str, w._parents[int(argv[3])]))
1403
884
 
1404
885
    elif cmd == 'plan-merge':
1405
 
        # replaced by 'bzr weave-plan-merge'
1406
886
        w = readit()
1407
887
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1408
888
            if line:
1409
889
                print '%14s | %s' % (state, line),
 
890
 
1410
891
    elif cmd == 'merge':
1411
 
        # replaced by 'bzr weave-merge-text'
1412
892
        w = readit()
1413
893
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1414
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))
1415
916
    else:
1416
917
        raise ValueError('unknown command %r' % cmd)
1417
918
    
1418
919
 
1419
920
 
1420
 
def profile_main(argv):
 
921
def profile_main(argv): 
1421
922
    import tempfile, hotshot, hotshot.stats
1422
923
 
1423
924
    prof_f = tempfile.NamedTemporaryFile()
1437
938
    return ret
1438
939
 
1439
940
 
1440
 
def lsprofile_main(argv): 
1441
 
    from bzrlib.lsprof import profile
1442
 
    ret,stats = profile(main, argv)
1443
 
    stats.sort()
1444
 
    stats.pprint()
1445
 
    return ret
1446
 
 
1447
 
 
1448
941
if __name__ == '__main__':
1449
942
    import sys
1450
943
    if '--profile' in sys.argv:
1451
944
        args = sys.argv[:]
1452
945
        args.remove('--profile')
1453
946
        sys.exit(profile_main(args))
1454
 
    elif '--lsprof' in sys.argv:
1455
 
        args = sys.argv[:]
1456
 
        args.remove('--lsprof')
1457
 
        sys.exit(lsprofile_main(args))
1458
947
    else:
1459
948
        sys.exit(main(sys.argv))
1460
949
 
1461
 
 
1462
 
class InterWeave(InterVersionedFile):
1463
 
    """Optimised code paths for weave to weave operations."""
1464
 
    
1465
 
    _matching_file_from_factory = staticmethod(WeaveFile)
1466
 
    _matching_file_to_factory = staticmethod(WeaveFile)
1467
 
    
1468
 
    @staticmethod
1469
 
    def is_compatible(source, target):
1470
 
        """Be compatible with weaves."""
1471
 
        try:
1472
 
            return (isinstance(source, Weave) and
1473
 
                    isinstance(target, Weave))
1474
 
        except AttributeError:
1475
 
            return False
1476
 
 
1477
 
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1478
 
        """See InterVersionedFile.join."""
1479
 
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1480
 
        if self.target.versions() == [] and version_ids is None:
1481
 
            self.target._copy_weave_content(self.source)
1482
 
            return
1483
 
        try:
1484
 
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1485
 
        except errors.WeaveParentMismatch:
1486
 
            self.target._reweave(self.source, pb, msg)
1487
 
 
1488
 
 
1489
 
InterVersionedFile.register_optimiser(InterWeave)