~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2005-09-16 08:23:10 UTC
  • Revision ID: mbp@sourcefrog.net-20050916082310-ecb5a25c40253839
- wrap wide strings when showing exceptions

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