~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-03-31 00:43:21 UTC
  • mfrom: (1551.2.51 win32fixes)
  • Revision ID: pqm@pqm.ubuntu.com-20060331004321-2171d32febcbfe4d
Various fixes for win32

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
 
# TODO: Perhaps have copy method for Weave instances?
52
24
 
53
25
# XXX: If we do weaves this way, will a merge still behave the same
54
26
# way if it's done in a different order?  That's a pretty desirable
59
31
# binaries, perhaps by naively splitting on \n or perhaps using
60
32
# something like a rolling checksum.
61
33
 
62
 
# TODO: Track version names as well as indexes. 
63
 
 
64
34
# TODO: End marker for each version so we can stop reading?
65
35
 
66
36
# TODO: Check that no insertion occurs inside a deletion that was
73
43
 
74
44
# TODO: Parallel-extract that passes back each line along with a
75
45
# description of which revisions include it.  Nice for checking all
76
 
# shas in parallel.
77
 
 
78
 
 
79
 
 
80
 
 
81
 
class WeaveError(Exception):
82
 
    """Exception in processing weave"""
83
 
 
84
 
 
85
 
class WeaveFormatError(WeaveError):
86
 
    """Weave invariant violated"""
87
 
    
88
 
 
89
 
class Weave(object):
 
46
# shas or calculating stats in parallel.
 
47
 
 
48
# TODO: Using a single _extract routine and then processing the output
 
49
# is probably inefficient.  It's simple enough that we can afford to
 
50
# have slight specializations for different ways its used: annotate,
 
51
# basis for add, get, etc.
 
52
 
 
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
 
75
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
94
    """weave - versioned text file storage.
91
95
    
92
96
    A Weave manages versions of line-based text files, keeping track
118
122
    The instruction can be '{' or '}' for an insertion block, and '['
119
123
    and ']' for a deletion block respectively.  The version is the
120
124
    integer version index.  There is no replace operator, only deletes
121
 
    and inserts.
 
125
    and inserts.  For '}', the end of an insertion, there is no
 
126
    version parameter because it always closes the most recently
 
127
    opened insertion.
122
128
 
123
129
    Constraints/notes:
124
130
 
160
166
        each version; the parent's parents are implied.
161
167
 
162
168
    _sha1s
163
 
        List of hex SHA-1 of each version, or None if not recorded.
 
169
        List of hex SHA-1 of each version.
 
170
 
 
171
    _names
 
172
        List of symbolic names for each version.  Each should be unique.
 
173
 
 
174
    _name_map
 
175
        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.
164
180
    """
165
181
 
166
 
    __slots__ = ['_weave', '_parents', '_sha1s']
 
182
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
183
                 '_weave_name']
167
184
    
168
 
    def __init__(self):
 
185
    def __init__(self, weave_name=None, access_mode='w'):
 
186
        super(Weave, self).__init__(access_mode)
169
187
        self._weave = []
170
188
        self._parents = []
171
189
        self._sha1s = []
172
 
 
 
190
        self._names = []
 
191
        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
173
209
 
174
210
    def __eq__(self, other):
175
211
        if not isinstance(other, Weave):
176
212
            return False
177
213
        return self._parents == other._parents \
178
 
               and self._weave == other._weave
 
214
               and self._weave == other._weave \
 
215
               and self._sha1s == other._sha1s 
179
216
    
180
 
 
181
217
    def __ne__(self, other):
182
218
        return not self.__eq__(other)
183
219
 
184
 
        
185
 
    def add(self, parents, text):
 
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)
 
229
    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
        try:
 
240
            return self._name_map[name]
 
241
        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):
186
450
        """Add a single text on top of the weave.
187
451
  
188
452
        Returns the index number of the newly added version.
189
453
 
 
454
        version_id
 
455
            Symbolic name for this version.
 
456
            (Typically the revision-id of the revision that added it.)
 
457
 
190
458
        parents
191
459
            List or set of direct parent version numbers.
192
460
            
193
 
        text
194
 
            Sequence of lines to be added in the new version."""
 
461
        lines
 
462
            Sequence of lines to be added in the new version.
 
463
        """
 
464
 
 
465
        assert isinstance(version_id, basestring)
 
466
        if not sha1:
 
467
            sha1 = sha_strings(lines)
 
468
        if version_id in self._name_map:
 
469
            return self._check_repeated_add(version_id, parents, lines, sha1)
195
470
 
196
471
        self._check_versions(parents)
197
 
        ## self._check_lines(text)
 
472
        ## self._check_lines(lines)
198
473
        new_version = len(self._parents)
199
474
 
200
 
        import sha
201
 
        s = sha.new()
202
 
        map(s.update, text)
203
 
        sha1 = s.hexdigest()
204
 
        del s
205
 
 
206
 
        # if we abort after here the weave will be corrupt
207
 
        self._parents.append(frozenset(parents))
 
475
        # if we abort after here the (in-memory) weave will be corrupt because only
 
476
        # some fields are updated
 
477
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
478
        #      - Robert Collins 20060226
 
479
        self._parents.append(parents[:])
208
480
        self._sha1s.append(sha1)
 
481
        self._names.append(version_id)
 
482
        self._name_map[version_id] = new_version
209
483
 
210
484
            
211
485
        if not parents:
213
487
            # this more quickly by just appending unconditionally.
214
488
            # even more specially, if we're adding an empty text we
215
489
            # need do nothing at all.
216
 
            if text:
 
490
            if lines:
217
491
                self._weave.append(('{', new_version))
218
 
                self._weave.extend(text)
219
 
                self._weave.append(('}', new_version))
220
 
        
 
492
                self._weave.extend(lines)
 
493
                self._weave.append(('}', None))
221
494
            return new_version
222
495
 
223
496
        if len(parents) == 1:
227
500
                return new_version
228
501
            
229
502
 
230
 
        ancestors = self.inclusions(parents)
 
503
        ancestors = self._inclusions(parents)
231
504
 
232
505
        l = self._weave
233
506
 
240
513
 
241
514
        # another small special case: a merge, producing the same text
242
515
        # as auto-merge
243
 
        if text == basis_lines:
 
516
        if lines == basis_lines:
244
517
            return new_version            
245
518
 
246
519
        # add a sentinal, because we can also match against the final line
253
526
        #print 'basis_lines:', basis_lines
254
527
        #print 'new_lines:  ', lines
255
528
 
256
 
        from difflib import SequenceMatcher
257
 
        s = SequenceMatcher(None, basis_lines, text)
 
529
        s = SequenceMatcher(None, basis_lines, lines)
258
530
 
259
531
        # offset gives the number of lines that have been inserted
260
532
        # into the weave up to the current point; if the original edit instruction
271
543
            i1 = basis_lineno[i1]
272
544
            i2 = basis_lineno[i2]
273
545
 
274
 
            assert 0 <= j1 <= j2 <= len(text)
 
546
            assert 0 <= j1 <= j2 <= len(lines)
275
547
 
276
548
            #print tag, i1, i2, j1, j2
277
549
 
288
560
                # we don't destroy ourselves
289
561
                i = i2 + offset
290
562
                self._weave[i:i] = ([('{', new_version)] 
291
 
                                + text[j1:j2] 
292
 
                                + [('}', new_version)])
 
563
                                    + lines[j1:j2] 
 
564
                                    + [('}', None)])
293
565
                offset += 2 + (j2 - j1)
294
 
 
295
566
        return new_version
296
567
 
 
568
    def _clone_text(self, new_version_id, old_version_id, parents):
 
569
        """See VersionedFile.clone_text."""
 
570
        old_lines = self.get_text(old_version_id)
 
571
        self.add_lines(new_version_id, parents, old_lines)
297
572
 
298
 
    def inclusions(self, versions):
 
573
    def _inclusions(self, versions):
299
574
        """Return set of all ancestors of given version(s)."""
 
575
        if not len(versions):
 
576
            return []
300
577
        i = set(versions)
301
 
        v = max(versions)
302
 
        try:
303
 
            while v >= 0:
304
 
                if v in i:
305
 
                    # include all its parents
306
 
                    i.update(self._parents[v])
307
 
                v -= 1
308
 
            return i
309
 
        except IndexError:
310
 
            raise ValueError("version %d not present in weave" % v)
311
 
 
312
 
 
313
 
    def minimal_parents(self, version):
314
 
        """Find the minimal set of parents for the version."""
315
 
        included = self._parents[version]
316
 
        if not included:
 
578
        for v in xrange(max(versions), 0, -1):
 
579
            if v in i:
 
580
                # include all its parents
 
581
                i.update(self._parents[v])
 
582
        return i
 
583
        ## except IndexError:
 
584
        ##     raise ValueError("version %d not present in weave" % v)
 
585
 
 
586
    @deprecated_method(zero_eight)
 
587
    def inclusions(self, version_ids):
 
588
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
 
589
        if not version_ids:
317
590
            return []
318
 
        
319
 
        li = list(included)
320
 
        li.sort(reverse=True)
321
 
 
322
 
        mininc = []
323
 
        gotit = set()
324
 
 
325
 
        for pv in li:
326
 
            if pv not in gotit:
327
 
                mininc.append(pv)
328
 
                gotit.update(self.inclusions(pv))
329
 
 
330
 
        assert mininc[0] >= 0
331
 
        assert mininc[-1] < version
332
 
        return mininc
333
 
 
334
 
 
 
591
        if isinstance(version_ids[0], int):
 
592
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
 
593
        else:
 
594
            return self.get_ancestry(version_ids)
 
595
 
 
596
    def get_ancestry(self, version_ids):
 
597
        """See VersionedFile.get_ancestry."""
 
598
        if isinstance(version_ids, basestring):
 
599
            version_ids = [version_ids]
 
600
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
601
        return [self._idx_to_name(v) for v in i]
335
602
 
336
603
    def _check_lines(self, text):
337
604
        if not isinstance(text, list):
352
619
            except IndexError:
353
620
                raise IndexError("invalid version number %r" % i)
354
621
 
 
622
    def _compatible_parents(self, my_parents, other_parents):
 
623
        """During join check that other_parents are joinable with my_parents.
 
624
 
 
625
        Joinable is defined as 'is a subset of' - supersets may require 
 
626
        regeneration of diffs, but subsets do not.
 
627
        """
 
628
        return len(other_parents.difference(my_parents)) == 0
 
629
 
 
630
    def annotate(self, version_id):
 
631
        if isinstance(version_id, int):
 
632
            warn('Weave.annotate(int) is deprecated. Please use version names'
 
633
                 ' in all circumstances as of 0.8',
 
634
                 DeprecationWarning,
 
635
                 stacklevel=2
 
636
                 )
 
637
            result = []
 
638
            for origin, lineno, text in self._extract([version_id]):
 
639
                result.append((origin, text))
 
640
            return result
 
641
        else:
 
642
            return super(Weave, self).annotate(version_id)
355
643
    
356
 
    def annotate(self, index):
357
 
        return list(self.annotate_iter(index))
358
 
 
359
 
 
360
 
    def annotate_iter(self, version):
361
 
        """Yield list of (index-id, line) pairs for the specified version.
 
644
    def annotate_iter(self, version_id):
 
645
        """Yield list of (version-id, line) pairs for the specified version.
362
646
 
363
647
        The index indicates when the line originated in the weave."""
364
 
        for origin, lineno, text in self._extract([version]):
365
 
            yield origin, text
366
 
 
367
 
 
 
648
        incls = [self._lookup(version_id)]
 
649
        for origin, lineno, text in self._extract(incls):
 
650
            yield self._idx_to_name(origin), text
 
651
 
 
652
    @deprecated_method(zero_eight)
368
653
    def _walk(self):
369
 
        """Walk the weave.
370
 
 
371
 
        Yields sequence of
372
 
        (lineno, insert, deletes, text)
373
 
        for each literal line.
374
 
        """
 
654
        """_walk has become visit, a supported api."""
 
655
        return self._walk_internal()
 
656
 
 
657
    def iter_lines_added_or_present_in_versions(self, version_ids=None):
 
658
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
659
        if version_ids is None:
 
660
            version_ids = self.versions()
 
661
        version_ids = set(version_ids)
 
662
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
663
            # if inserted not in version_ids then it was inserted before the
 
664
            # versions we care about, but because weaves cannot represent ghosts
 
665
            # properly, we do not filter down to that
 
666
            # if inserted not in version_ids: continue
 
667
            if line[-1] != '\n':
 
668
                yield line + '\n'
 
669
            else:
 
670
                yield line
 
671
 
 
672
    #@deprecated_method(zero_eight)
 
673
    def walk(self, version_ids=None):
 
674
        """See VersionedFile.walk."""
 
675
        return self._walk_internal(version_ids)
 
676
 
 
677
    def _walk_internal(self, version_ids=None):
 
678
        """Helper method for weave actions."""
375
679
        
376
680
        istack = []
377
681
        dset = set()
379
683
        lineno = 0         # line of weave, 0-based
380
684
 
381
685
        for l in self._weave:
382
 
            if isinstance(l, tuple):
 
686
            if l.__class__ == tuple:
383
687
                c, v = l
384
688
                isactive = None
385
689
                if c == '{':
386
 
                    istack.append(v)
 
690
                    istack.append(self._names[v])
387
691
                elif c == '}':
388
 
                    oldv = istack.pop()
 
692
                    istack.pop()
389
693
                elif c == '[':
390
 
                    assert v not in dset
391
 
                    dset.add(v)
 
694
                    assert self._names[v] not in dset
 
695
                    dset.add(self._names[v])
392
696
                elif c == ']':
393
 
                    dset.remove(v)
 
697
                    dset.remove(self._names[v])
394
698
                else:
395
 
                    raise WeaveFormatError('unexpected instruction %r'
396
 
                                           % v)
 
699
                    raise WeaveFormatError('unexpected instruction %r' % v)
397
700
            else:
398
 
                assert isinstance(l, basestring)
 
701
                assert l.__class__ in (str, unicode)
399
702
                assert istack
400
 
                yield lineno, istack[-1], dset, l
 
703
                yield lineno, istack[-1], frozenset(dset), l
401
704
            lineno += 1
402
705
 
403
 
 
 
706
        if istack:
 
707
            raise WeaveFormatError("unclosed insertion blocks "
 
708
                    "at end of weave: %s" % istack)
 
709
        if dset:
 
710
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
711
                                   % dset)
404
712
 
405
713
    def _extract(self, versions):
406
714
        """Yield annotation of lines in included set.
411
719
 
412
720
        The set typically but not necessarily corresponds to a version.
413
721
        """
414
 
        included = self.inclusions(versions)
 
722
        for i in versions:
 
723
            if not isinstance(i, int):
 
724
                raise ValueError(i)
 
725
            
 
726
        included = self._inclusions(versions)
415
727
 
416
728
        istack = []
 
729
        iset = set()
417
730
        dset = set()
418
731
 
419
732
        lineno = 0         # line of weave, 0-based
424
737
 
425
738
        WFE = WeaveFormatError
426
739
 
 
740
        # wow. 
 
741
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
742
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
743
        # 1.6 seconds in 'isinstance'.
 
744
        # changing the first isinstance:
 
745
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
746
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
747
        # note that the inline time actually dropped (less function calls)
 
748
        # and total processing time was halved.
 
749
        # we're still spending ~1/4 of the method in isinstance though.
 
750
        # so lets hard code the acceptable string classes we expect:
 
751
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
752
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
753
        #                                          objects>
 
754
        # yay, down to ~1/4 the initial extract time, and our inline time
 
755
        # has shrunk again, with isinstance no longer dominating.
 
756
        # tweaking the stack inclusion test to use a set gives:
 
757
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
758
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
759
        #                                          objects>
 
760
        # - a 5% win, or possibly just noise. However with large istacks that
 
761
        # 'in' test could dominate, so I'm leaving this change in place -
 
762
        # when its fast enough to consider profiling big datasets we can review.
 
763
 
 
764
              
 
765
             
 
766
 
427
767
        for l in self._weave:
428
 
            if isinstance(l, tuple):
 
768
            if l.__class__ == tuple:
429
769
                c, v = l
430
770
                isactive = None
431
771
                if c == '{':
432
 
                    assert v not in istack
 
772
                    assert v not in iset
433
773
                    istack.append(v)
 
774
                    iset.add(v)
434
775
                elif c == '}':
435
 
                    oldv = istack.pop()
436
 
                    assert oldv == v
 
776
                    iset.remove(istack.pop())
437
777
                elif c == '[':
438
778
                    if v in included:
439
779
                        assert v not in dset
444
784
                        assert v in dset
445
785
                        dset.remove(v)
446
786
            else:
447
 
                assert isinstance(l, basestring)
 
787
                assert l.__class__ in (str, unicode)
448
788
                if isactive is None:
449
789
                    isactive = (not dset) and istack and (istack[-1] in included)
450
790
                if isactive:
451
791
                    result.append((istack[-1], lineno, l))
452
792
            lineno += 1
453
 
 
454
793
        if istack:
455
 
            raise WFE("unclosed insertion blocks at end of weave",
456
 
                                   istack)
 
794
            raise WeaveFormatError("unclosed insertion blocks "
 
795
                    "at end of weave: %s" % istack)
457
796
        if dset:
458
 
            raise WFE("unclosed deletion blocks at end of weave",
459
 
                                   dset)
460
 
 
461
 
        return result
462
 
    
463
 
 
464
 
 
465
 
    def get_iter(self, version):
466
 
        """Yield lines for the specified version."""
467
 
        for origin, lineno, line in self._extract([version]):
468
 
            yield line
469
 
 
470
 
 
471
 
    def get(self, index):
472
 
        return list(self.get_iter(index))
473
 
 
474
 
 
475
 
    def mash_iter(self, included):
476
 
        """Return composed version of multiple included versions."""
477
 
        for origin, lineno, text in self._extract(included):
478
 
            yield text
479
 
 
480
 
 
481
 
    def dump(self, to_file):
482
 
        from pprint import pprint
483
 
        print >>to_file, "Weave._weave = ",
484
 
        pprint(self._weave, to_file)
485
 
        print >>to_file, "Weave._parents = ",
486
 
        pprint(self._parents, to_file)
487
 
 
488
 
 
489
 
 
 
797
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
798
                                   % dset)
 
799
        return result
 
800
 
 
801
    @deprecated_method(zero_eight)
 
802
    def get_iter(self, name_or_index):
 
803
        """Deprecated, please do not use. Lookups are not not needed.
 
804
        
 
805
        Please use get_lines now.
 
806
        """
 
807
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
808
 
 
809
    @deprecated_method(zero_eight)
 
810
    def maybe_lookup(self, name_or_index):
 
811
        """Deprecated, please do not use. Lookups are not not needed."""
 
812
        return self._maybe_lookup(name_or_index)
 
813
 
 
814
    def _maybe_lookup(self, name_or_index):
 
815
        """Convert possible symbolic name to index, or pass through indexes.
 
816
        
 
817
        NOT FOR PUBLIC USE.
 
818
        """
 
819
        if isinstance(name_or_index, (int, long)):
 
820
            return name_or_index
 
821
        else:
 
822
            return self._lookup(name_or_index)
 
823
 
 
824
    @deprecated_method(zero_eight)
 
825
    def get(self, version_id):
 
826
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
827
        return self.get_lines(version_id)
 
828
 
 
829
    def get_lines(self, version_id):
 
830
        """See VersionedFile.get_lines()."""
 
831
        int_index = self._maybe_lookup(version_id)
 
832
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
833
        expected_sha1 = self._sha1s[int_index]
 
834
        measured_sha1 = sha_strings(result)
 
835
        if measured_sha1 != expected_sha1:
 
836
            raise errors.WeaveInvalidChecksum(
 
837
                    'file %s, revision %s, expected: %s, measured %s' 
 
838
                    % (self._weave_name, version_id,
 
839
                       expected_sha1, measured_sha1))
 
840
        return result
 
841
 
 
842
    def get_sha1(self, name):
 
843
        """Get the stored sha1 sum for the given revision.
 
844
        
 
845
        :param name: The name of the version to lookup
 
846
        """
 
847
        return self._sha1s[self._lookup(name)]
 
848
 
 
849
    @deprecated_method(zero_eight)
490
850
    def numversions(self):
 
851
        """How many versions are in this weave?
 
852
 
 
853
        Deprecated in favour of num_versions.
 
854
        """
 
855
        return self.num_versions()
 
856
 
 
857
    def num_versions(self):
 
858
        """How many versions are in this weave?"""
491
859
        l = len(self._parents)
492
860
        assert l == len(self._sha1s)
493
861
        return l
494
862
 
495
 
 
496
 
    def __len__(self):
497
 
        return self.numversions()
498
 
 
 
863
    __len__ = num_versions
499
864
 
500
865
    def check(self, progress_bar=None):
501
 
        # check no circular inclusions
502
 
        for version in range(self.numversions()):
 
866
        # TODO evaluate performance hit of using string sets in this routine.
 
867
        # TODO: check no circular inclusions
 
868
        # TODO: create a nested progress bar
 
869
        for version in range(self.num_versions()):
503
870
            inclusions = list(self._parents[version])
504
871
            if inclusions:
505
872
                inclusions.sort()
507
874
                    raise WeaveFormatError("invalid included version %d for index %d"
508
875
                                           % (inclusions[-1], version))
509
876
 
510
 
        # try extracting all versions; this is a bit slow and parallel
511
 
        # extraction could be used
512
 
        import sha
513
 
        nv = self.numversions()
514
 
        for version in range(nv):
 
877
        # try extracting all versions; parallel extraction is used
 
878
        nv = self.num_versions()
 
879
        sha1s = {}
 
880
        texts = {}
 
881
        inclusions = {}
 
882
        for i in range(nv):
 
883
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
884
            # The problem is that set membership is much more expensive
 
885
            name = self._idx_to_name(i)
 
886
            sha1s[name] = sha.new()
 
887
            texts[name] = []
 
888
            new_inc = set([name])
 
889
            for p in self._parents[i]:
 
890
                new_inc.update(inclusions[self._idx_to_name(p)])
 
891
 
 
892
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
893
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
894
            inclusions[name] = new_inc
 
895
 
 
896
        nlines = len(self._weave)
 
897
 
 
898
        update_text = 'checking weave'
 
899
        if self._weave_name:
 
900
            short_name = os.path.basename(self._weave_name)
 
901
            update_text = 'checking %s' % (short_name,)
 
902
            update_text = update_text[:25]
 
903
 
 
904
        for lineno, insert, deleteset, line in self._walk_internal():
515
905
            if progress_bar:
516
 
                progress_bar.update('checking text', version, nv)
517
 
            s = sha.new()
518
 
            for l in self.get_iter(version):
519
 
                s.update(l)
520
 
            hd = s.hexdigest()
521
 
            expected = self._sha1s[version]
 
906
                progress_bar.update(update_text, lineno, nlines)
 
907
 
 
908
            for name, name_inclusions in inclusions.items():
 
909
                # The active inclusion must be an ancestor,
 
910
                # and no ancestors must have deleted this line,
 
911
                # because we don't support resurrection.
 
912
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
913
                    sha1s[name].update(line)
 
914
 
 
915
        for i in range(nv):
 
916
            version = self._idx_to_name(i)
 
917
            hd = sha1s[version].hexdigest()
 
918
            expected = self._sha1s[i]
522
919
            if hd != expected:
523
 
                raise WeaveError("mismatched sha1 for version %d; "
524
 
                                 "got %s, expected %s"
525
 
                                 % (version, hd, expected))
 
920
                raise errors.WeaveInvalidChecksum(
 
921
                        "mismatched sha1 for version %s: "
 
922
                        "got %s, expected %s"
 
923
                        % (version, hd, expected))
526
924
 
527
925
        # TODO: check insertions are properly nested, that there are
528
926
        # no lines outside of insertion blocks, that deletions are
529
927
        # properly paired, etc.
530
928
 
531
 
 
532
 
 
533
 
    def merge(self, merge_versions):
534
 
        """Automerge and mark conflicts between versions.
535
 
 
536
 
        This returns a sequence, each entry describing alternatives
537
 
        for a chunk of the file.  Each of the alternatives is given as
538
 
        a list of lines.
539
 
 
540
 
        If there is a chunk of the file where there's no diagreement,
541
 
        only one alternative is given.
542
 
        """
543
 
 
544
 
        # approach: find the included versions common to all the
545
 
        # merged versions
546
 
        raise NotImplementedError()
547
 
 
548
 
 
549
 
 
550
 
    def _delta(self, included, lines):
551
 
        """Return changes from basis to new revision.
552
 
 
553
 
        The old text for comparison is the union of included revisions.
554
 
 
555
 
        This is used in inserting a new text.
556
 
 
557
 
        Delta is returned as a sequence of
558
 
        (weave1, weave2, newlines).
559
 
 
560
 
        This indicates that weave1:weave2 of the old weave should be
561
 
        replaced by the sequence of lines in newlines.  Note that
562
 
        these line numbers are positions in the total weave and don't
563
 
        correspond to the lines in any extracted version, or even the
564
 
        extracted union of included versions.
565
 
 
566
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
567
 
        pure delete.  (Similar to difflib.)
568
 
        """
569
 
 
570
 
 
571
 
            
572
 
    def plan_merge(self, ver_a, ver_b):
573
 
        """Return pseudo-annotation indicating how the two versions merge.
574
 
 
575
 
        This is computed between versions a and b and their common
576
 
        base.
577
 
 
578
 
        Weave lines present in none of them are skipped entirely.
579
 
        """
580
 
        inc_a = self.inclusions([ver_a])
581
 
        inc_b = self.inclusions([ver_b])
582
 
        inc_c = inc_a & inc_b
583
 
 
584
 
        for lineno, insert, deleteset, line in self._walk():
585
 
            if deleteset & inc_c:
586
 
                # killed in parent; can't be in either a or b
587
 
                # not relevant to our work
588
 
                yield 'killed-base', line
589
 
            elif insert in inc_c:
590
 
                # was inserted in base
591
 
                killed_a = bool(deleteset & inc_a)
592
 
                killed_b = bool(deleteset & inc_b)
593
 
                if killed_a and killed_b:
594
 
                    yield 'killed-both', line
595
 
                elif killed_a:
596
 
                    yield 'killed-a', line
597
 
                elif killed_b:
598
 
                    yield 'killed-b', line
599
 
                else:
600
 
                    yield 'unchanged', line
601
 
            elif insert in inc_a:
602
 
                if deleteset & inc_a:
603
 
                    yield 'ghost-a', line
604
 
                else:
605
 
                    # new in A; not in B
606
 
                    yield 'new-a', line
607
 
            elif insert in inc_b:
608
 
                if deleteset & inc_b:
609
 
                    yield 'ghost-b', line
610
 
                else:
611
 
                    yield 'new-b', line
612
 
            else:
613
 
                # not in either revision
614
 
                yield 'irrelevant', line
615
 
 
616
 
        yield 'unchanged', ''           # terminator
617
 
 
618
 
 
619
 
 
620
 
    def weave_merge(self, plan):
621
 
        lines_a = []
622
 
        lines_b = []
623
 
        ch_a = ch_b = False
624
 
 
625
 
        for state, line in plan:
626
 
            if state == 'unchanged' or state == 'killed-both':
627
 
                # resync and flush queued conflicts changes if any
628
 
                if not lines_a and not lines_b:
629
 
                    pass
630
 
                elif ch_a and not ch_b:
631
 
                    # one-sided change:                    
632
 
                    for l in lines_a: yield l
633
 
                elif ch_b and not ch_a:
634
 
                    for l in lines_b: yield l
635
 
                elif lines_a == lines_b:
636
 
                    for l in lines_a: yield l
637
 
                else:
638
 
                    yield '<<<<\n'
639
 
                    for l in lines_a: yield l
640
 
                    yield '====\n'
641
 
                    for l in lines_b: yield l
642
 
                    yield '>>>>\n'
643
 
 
644
 
                del lines_a[:]
645
 
                del lines_b[:]
646
 
                ch_a = ch_b = False
647
 
                
648
 
            if state == 'unchanged':
649
 
                if line:
650
 
                    yield line
651
 
            elif state == 'killed-a':
652
 
                ch_a = True
653
 
                lines_b.append(line)
654
 
            elif state == 'killed-b':
655
 
                ch_b = True
656
 
                lines_a.append(line)
657
 
            elif state == 'new-a':
658
 
                ch_a = True
659
 
                lines_a.append(line)
660
 
            elif state == 'new-b':
661
 
                ch_b = True
662
 
                lines_b.append(line)
663
 
            else:
664
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
665
 
                                 'killed-both'), \
666
 
                       state
667
 
 
668
 
                
669
 
 
670
 
 
671
 
 
672
 
 
673
 
 
674
 
def weave_info(w):
675
 
    """Show some text information about the weave."""
676
 
    print '%6s %40s %20s' % ('ver', 'sha1', 'parents')
677
 
    for i in (6, 40, 20):
 
929
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
930
        """Worker routine for join()."""
 
931
        if not other.versions():
 
932
            return          # nothing to update, easy
 
933
 
 
934
        if version_ids:
 
935
            for version_id in version_ids:
 
936
                if not other.has_version(version_id) and not ignore_missing:
 
937
                    raise RevisionNotPresent(version_id, self._weave_name)
 
938
        else:
 
939
            version_ids = other.versions()
 
940
 
 
941
        # two loops so that we do not change ourselves before verifying it
 
942
        # will be ok
 
943
        # work through in index order to make sure we get all dependencies
 
944
        names_to_join = []
 
945
        processed = 0
 
946
        # get the selected versions only that are in other.versions.
 
947
        version_ids = set(other.versions()).intersection(set(version_ids))
 
948
        # pull in the referenced graph.
 
949
        version_ids = other.get_ancestry(version_ids)
 
950
        pending_graph = [(version, other.get_parents(version)) for
 
951
                         version in version_ids]
 
952
        for name in topo_sort(pending_graph):
 
953
            other_idx = other._name_map[name]
 
954
            # returns True if we have it, False if we need it.
 
955
            if not self._check_version_consistent(other, other_idx, name):
 
956
                names_to_join.append((other_idx, name))
 
957
            processed += 1
 
958
 
 
959
 
 
960
        if pb and not msg:
 
961
            msg = 'weave join'
 
962
 
 
963
        merged = 0
 
964
        time0 = time.time()
 
965
        for other_idx, name in names_to_join:
 
966
            # TODO: If all the parents of the other version are already
 
967
            # present then we can avoid some work by just taking the delta
 
968
            # and adjusting the offsets.
 
969
            new_parents = self._imported_parents(other, other_idx)
 
970
            sha1 = other._sha1s[other_idx]
 
971
 
 
972
            merged += 1
 
973
 
 
974
            if pb:
 
975
                pb.update(msg, merged, len(names_to_join))
 
976
           
 
977
            lines = other.get_lines(other_idx)
 
978
            self._add(name, lines, new_parents, sha1)
 
979
 
 
980
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
981
                merged, processed, self._weave_name, time.time()-time0))
 
982
 
 
983
    def _imported_parents(self, other, other_idx):
 
984
        """Return list of parents in self corresponding to indexes in other."""
 
985
        new_parents = []
 
986
        for parent_idx in other._parents[other_idx]:
 
987
            parent_name = other._names[parent_idx]
 
988
            if parent_name not in self._name_map:
 
989
                # should not be possible
 
990
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
991
                                 % (parent_name, other._name_map[other_idx], self))
 
992
            new_parents.append(self._name_map[parent_name])
 
993
        return new_parents
 
994
 
 
995
    def _check_version_consistent(self, other, other_idx, name):
 
996
        """Check if a version in consistent in this and other.
 
997
 
 
998
        To be consistent it must have:
 
999
 
 
1000
         * the same text
 
1001
         * the same direct parents (by name, not index, and disregarding
 
1002
           order)
 
1003
        
 
1004
        If present & correct return True;
 
1005
        if not present in self return False; 
 
1006
        if inconsistent raise error."""
 
1007
        this_idx = self._name_map.get(name, -1)
 
1008
        if this_idx != -1:
 
1009
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
1010
                raise errors.WeaveTextDiffers(name, self, other)
 
1011
            self_parents = self._parents[this_idx]
 
1012
            other_parents = other._parents[other_idx]
 
1013
            n1 = set([self._names[i] for i in self_parents])
 
1014
            n2 = set([other._names[i] for i in other_parents])
 
1015
            if not self._compatible_parents(n1, n2):
 
1016
                raise WeaveParentMismatch("inconsistent parents "
 
1017
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
1018
            else:
 
1019
                return True         # ok!
 
1020
        else:
 
1021
            return False
 
1022
 
 
1023
    @deprecated_method(zero_eight)
 
1024
    def reweave(self, other, pb=None, msg=None):
 
1025
        """reweave has been superceded by plain use of join."""
 
1026
        return self.join(other, pb, msg)
 
1027
 
 
1028
    def _reweave(self, other, pb, msg):
 
1029
        """Reweave self with other - internal helper for join().
 
1030
 
 
1031
        :param other: The other weave to merge
 
1032
        :param pb: An optional progress bar, indicating how far done we are
 
1033
        :param msg: An optional message for the progress
 
1034
        """
 
1035
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
1036
        self._copy_weave_content(new_weave)
 
1037
 
 
1038
    def _copy_weave_content(self, otherweave):
 
1039
        """adsorb the content from otherweave."""
 
1040
        for attr in self.__slots__:
 
1041
            if attr != '_weave_name':
 
1042
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
1043
 
 
1044
 
 
1045
class WeaveFile(Weave):
 
1046
    """A WeaveFile represents a Weave on disk and writes on change."""
 
1047
 
 
1048
    WEAVE_SUFFIX = '.weave'
 
1049
    
 
1050
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
1051
        """Create a WeaveFile.
 
1052
        
 
1053
        :param create: If not True, only open an existing knit.
 
1054
        """
 
1055
        super(WeaveFile, self).__init__(name, access_mode)
 
1056
        self._transport = transport
 
1057
        self._filemode = filemode
 
1058
        try:
 
1059
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
1060
        except errors.NoSuchFile:
 
1061
            if not create:
 
1062
                raise
 
1063
            # new file, save it
 
1064
            self._save()
 
1065
 
 
1066
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
1067
        """Add a version and save the weave."""
 
1068
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
1069
                                                   parent_texts)
 
1070
        self._save()
 
1071
        return result
 
1072
 
 
1073
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1074
        """See VersionedFile.clone_text."""
 
1075
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1076
        self._save
 
1077
 
 
1078
    def copy_to(self, name, transport):
 
1079
        """See VersionedFile.copy_to()."""
 
1080
        # as we are all in memory always, just serialise to the new place.
 
1081
        sio = StringIO()
 
1082
        write_weave_v5(self, sio)
 
1083
        sio.seek(0)
 
1084
        transport.put(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1085
 
 
1086
    def create_empty(self, name, transport, filemode=None):
 
1087
        return WeaveFile(name, transport, filemode, create=True)
 
1088
 
 
1089
    def _save(self):
 
1090
        """Save the weave."""
 
1091
        self._check_write_ok()
 
1092
        sio = StringIO()
 
1093
        write_weave_v5(self, sio)
 
1094
        sio.seek(0)
 
1095
        self._transport.put(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1096
                            sio,
 
1097
                            self._filemode)
 
1098
 
 
1099
    @staticmethod
 
1100
    def get_suffixes():
 
1101
        """See VersionedFile.get_suffixes()."""
 
1102
        return [WeaveFile.WEAVE_SUFFIX]
 
1103
 
 
1104
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1105
             ignore_missing=False):
 
1106
        """Join other into self and save."""
 
1107
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
1108
        self._save()
 
1109
 
 
1110
 
 
1111
@deprecated_function(zero_eight)
 
1112
def reweave(wa, wb, pb=None, msg=None):
 
1113
    """reweaving is deprecation, please just use weave.join()."""
 
1114
    _reweave(wa, wb, pb, msg)
 
1115
 
 
1116
def _reweave(wa, wb, pb=None, msg=None):
 
1117
    """Combine two weaves and return the result.
 
1118
 
 
1119
    This works even if a revision R has different parents in 
 
1120
    wa and wb.  In the resulting weave all the parents are given.
 
1121
 
 
1122
    This is done by just building up a new weave, maintaining ordering 
 
1123
    of the versions in the two inputs.  More efficient approaches
 
1124
    might be possible but it should only be necessary to do 
 
1125
    this operation rarely, when a new previously ghost version is 
 
1126
    inserted.
 
1127
 
 
1128
    :param pb: An optional progress bar, indicating how far done we are
 
1129
    :param msg: An optional message for the progress
 
1130
    """
 
1131
    wr = Weave()
 
1132
    ia = ib = 0
 
1133
    queue_a = range(wa.num_versions())
 
1134
    queue_b = range(wb.num_versions())
 
1135
    # first determine combined parents of all versions
 
1136
    # map from version name -> all parent names
 
1137
    combined_parents = _reweave_parent_graphs(wa, wb)
 
1138
    mutter("combined parents: %r", combined_parents)
 
1139
    order = topo_sort(combined_parents.iteritems())
 
1140
    mutter("order to reweave: %r", order)
 
1141
 
 
1142
    if pb and not msg:
 
1143
        msg = 'reweave'
 
1144
 
 
1145
    for idx, name in enumerate(order):
 
1146
        if pb:
 
1147
            pb.update(msg, idx, len(order))
 
1148
        if name in wa._name_map:
 
1149
            lines = wa.get_lines(name)
 
1150
            if name in wb._name_map:
 
1151
                lines_b = wb.get_lines(name)
 
1152
                if lines != lines_b:
 
1153
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1154
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1155
                    import difflib
 
1156
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1157
                            wa._weave_name, wb._weave_name))
 
1158
                    mutter('lines:\n%s', ''.join(lines))
 
1159
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1160
        else:
 
1161
            lines = wb.get_lines(name)
 
1162
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1163
    return wr
 
1164
 
 
1165
def _reweave_parent_graphs(wa, wb):
 
1166
    """Return combined parent ancestry for two weaves.
 
1167
    
 
1168
    Returned as a list of (version_name, set(parent_names))"""
 
1169
    combined = {}
 
1170
    for weave in [wa, wb]:
 
1171
        for idx, name in enumerate(weave._names):
 
1172
            p = combined.setdefault(name, set())
 
1173
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1174
    return combined
 
1175
 
 
1176
 
 
1177
def weave_toc(w):
 
1178
    """Show the weave's table-of-contents"""
 
1179
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1180
    for i in (6, 50, 10, 10):
678
1181
        print '-' * i,
679
1182
    print
680
 
    for i in range(w.numversions()):
 
1183
    for i in range(w.num_versions()):
681
1184
        sha1 = w._sha1s[i]
682
 
        print '%6d %40s %s' % (i, sha1, ' '.join(map(str, w._parents[i])))
683
 
 
684
 
 
685
 
 
686
 
def weave_stats(weave_file):
687
 
    from bzrlib.progress import ProgressBar
 
1185
        name = w._names[i]
 
1186
        parent_str = ' '.join(map(str, w._parents[i]))
 
1187
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1188
 
 
1189
 
 
1190
 
 
1191
def weave_stats(weave_file, pb):
688
1192
    from bzrlib.weavefile import read_weave
689
1193
 
690
 
    pb = ProgressBar()
691
 
 
692
1194
    wf = file(weave_file, 'rb')
693
 
    w = read_weave(wf)
 
1195
    w = read_weave(wf, WeaveVersionedFile)
694
1196
    # FIXME: doesn't work on pipes
695
1197
    weave_size = wf.tell()
696
1198
 
698
1200
    vers = len(w)
699
1201
    for i in range(vers):
700
1202
        pb.update('checking sizes', i, vers)
701
 
        for line in w.get_iter(i):
 
1203
        for origin, lineno, line in w._extract([i]):
702
1204
            total += len(line)
703
1205
 
704
1206
    pb.clear()
725
1227
        Write out specified version.
726
1228
    weave check WEAVEFILE
727
1229
        Check consistency of all versions.
728
 
    weave info WEAVEFILE
 
1230
    weave toc WEAVEFILE
729
1231
        Display table of contents.
730
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
1232
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
731
1233
        Add NEWTEXT, with specified parent versions.
732
1234
    weave annotate WEAVEFILE VERSION
733
1235
        Display origin of each line.
734
 
    weave mash WEAVEFILE VERSION...
735
 
        Display composite of all selected versions.
736
1236
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
737
1237
        Auto-merge two versions and display conflicts.
 
1238
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1239
        Show differences between two versions.
738
1240
 
739
1241
example:
740
1242
 
741
1243
    % weave init foo.weave
742
1244
    % vi foo.txt
743
 
    % weave add foo.weave < foo.txt
 
1245
    % weave add foo.weave ver0 < foo.txt
744
1246
    added version 0
745
1247
 
746
1248
    (create updated version)
747
1249
    % vi foo.txt
748
1250
    % weave get foo.weave 0 | diff -u - foo.txt
749
 
    % weave add foo.weave 0 < foo.txt
 
1251
    % weave add foo.weave ver1 0 < foo.txt
750
1252
    added version 1
751
1253
 
752
1254
    % weave get foo.weave 0 > foo.txt       (create forked version)
753
1255
    % vi foo.txt
754
 
    % weave add foo.weave 0 < foo.txt
 
1256
    % weave add foo.weave ver2 0 < foo.txt
755
1257
    added version 2
756
1258
 
757
1259
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
758
1260
    % vi foo.txt                            (resolve conflicts)
759
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
1261
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
760
1262
    
761
1263
"""
762
1264
    
765
1267
def main(argv):
766
1268
    import sys
767
1269
    import os
768
 
    from weavefile import write_weave, read_weave
 
1270
    try:
 
1271
        import bzrlib
 
1272
    except ImportError:
 
1273
        # in case we're run directly from the subdirectory
 
1274
        sys.path.append('..')
 
1275
        import bzrlib
 
1276
    from bzrlib.weavefile import write_weave, read_weave
769
1277
    from bzrlib.progress import ProgressBar
770
1278
 
771
 
    #import psyco
772
 
    #psyco.full()
 
1279
    try:
 
1280
        import psyco
 
1281
        psyco.full()
 
1282
    except ImportError:
 
1283
        pass
 
1284
 
 
1285
    if len(argv) < 2:
 
1286
        usage()
 
1287
        return 0
773
1288
 
774
1289
    cmd = argv[1]
775
1290
 
781
1296
    elif cmd == 'add':
782
1297
        w = readit()
783
1298
        # at the moment, based on everything in the file
784
 
        parents = map(int, argv[3:])
 
1299
        name = argv[3]
 
1300
        parents = map(int, argv[4:])
785
1301
        lines = sys.stdin.readlines()
786
 
        ver = w.add(parents, lines)
 
1302
        ver = w.add(name, parents, lines)
787
1303
        write_weave(w, file(argv[2], 'wb'))
788
 
        print 'added version %d' % ver
 
1304
        print 'added version %r %d' % (name, ver)
789
1305
    elif cmd == 'init':
790
1306
        fn = argv[2]
791
1307
        if os.path.exists(fn):
796
1312
        w = readit()
797
1313
        sys.stdout.writelines(w.get_iter(int(argv[3])))
798
1314
        
799
 
    elif cmd == 'mash': # get composite
 
1315
    elif cmd == 'diff':
 
1316
        from difflib import unified_diff
800
1317
        w = readit()
801
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
802
 
 
 
1318
        fn = argv[2]
 
1319
        v1, v2 = map(int, argv[3:5])
 
1320
        lines1 = w.get(v1)
 
1321
        lines2 = w.get(v2)
 
1322
        diff_gen = unified_diff(lines1, lines2,
 
1323
                                '%s version %d' % (fn, v1),
 
1324
                                '%s version %d' % (fn, v2))
 
1325
        sys.stdout.writelines(diff_gen)
 
1326
            
803
1327
    elif cmd == 'annotate':
804
1328
        w = readit()
805
1329
        # newline is added to all lines regardless; too hard to get
813
1337
                print '%5d | %s' % (origin, text)
814
1338
                lasto = origin
815
1339
                
816
 
    elif cmd == 'info':
817
 
        weave_info(readit())
 
1340
    elif cmd == 'toc':
 
1341
        weave_toc(readit())
818
1342
 
819
1343
    elif cmd == 'stats':
820
 
        weave_stats(argv[2])
 
1344
        weave_stats(argv[2], ProgressBar())
821
1345
        
822
1346
    elif cmd == 'check':
823
1347
        w = readit()
824
1348
        pb = ProgressBar()
825
1349
        w.check(pb)
826
1350
        pb.clear()
827
 
        print '%d versions ok' % w.numversions()
 
1351
        print '%d versions ok' % w.num_versions()
828
1352
 
829
1353
    elif cmd == 'inclusions':
830
1354
        w = readit()
835
1359
        print ' '.join(map(str, w._parents[int(argv[3])]))
836
1360
 
837
1361
    elif cmd == 'plan-merge':
 
1362
        # replaced by 'bzr weave-plan-merge'
838
1363
        w = readit()
839
1364
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
840
1365
            if line:
841
1366
                print '%14s | %s' % (state, line),
842
 
 
843
1367
    elif cmd == 'merge':
 
1368
        # replaced by 'bzr weave-merge-text'
844
1369
        w = readit()
845
1370
        p = w.plan_merge(int(argv[3]), int(argv[4]))
846
1371
        sys.stdout.writelines(w.weave_merge(p))
847
 
            
848
 
    elif cmd == 'mash-merge':
849
 
        if len(argv) != 5:
850
 
            usage()
851
 
            return 1
852
 
 
853
 
        w = readit()
854
 
        v1, v2 = map(int, argv[3:5])
855
 
 
856
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
857
 
 
858
 
        base_lines = list(w.mash_iter(basis))
859
 
        a_lines = list(w.get(v1))
860
 
        b_lines = list(w.get(v2))
861
 
 
862
 
        from bzrlib.merge3 import Merge3
863
 
        m3 = Merge3(base_lines, a_lines, b_lines)
864
 
 
865
 
        name_a = 'version %d' % v1
866
 
        name_b = 'version %d' % v2
867
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
868
1372
    else:
869
1373
        raise ValueError('unknown command %r' % cmd)
870
1374
    
871
1375
 
 
1376
 
 
1377
def profile_main(argv):
 
1378
    import tempfile, hotshot, hotshot.stats
 
1379
 
 
1380
    prof_f = tempfile.NamedTemporaryFile()
 
1381
 
 
1382
    prof = hotshot.Profile(prof_f.name)
 
1383
 
 
1384
    ret = prof.runcall(main, argv)
 
1385
    prof.close()
 
1386
 
 
1387
    stats = hotshot.stats.load(prof_f.name)
 
1388
    #stats.strip_dirs()
 
1389
    stats.sort_stats('cumulative')
 
1390
    ## XXX: Might like to write to stderr or the trace file instead but
 
1391
    ## print_stats seems hardcoded to stdout
 
1392
    stats.print_stats(20)
 
1393
            
 
1394
    return ret
 
1395
 
 
1396
 
 
1397
def lsprofile_main(argv): 
 
1398
    from bzrlib.lsprof import profile
 
1399
    ret,stats = profile(main, argv)
 
1400
    stats.sort()
 
1401
    stats.pprint()
 
1402
    return ret
 
1403
 
 
1404
 
872
1405
if __name__ == '__main__':
873
1406
    import sys
874
 
    sys.exit(main(sys.argv))
 
1407
    if '--profile' in sys.argv:
 
1408
        args = sys.argv[:]
 
1409
        args.remove('--profile')
 
1410
        sys.exit(profile_main(args))
 
1411
    elif '--lsprof' in sys.argv:
 
1412
        args = sys.argv[:]
 
1413
        args.remove('--lsprof')
 
1414
        sys.exit(lsprofile_main(args))
 
1415
    else:
 
1416
        sys.exit(main(sys.argv))
 
1417
 
 
1418
 
 
1419
class InterWeave(InterVersionedFile):
 
1420
    """Optimised code paths for weave to weave operations."""
 
1421
    
 
1422
    _matching_file_factory = staticmethod(WeaveFile)
 
1423
    
 
1424
    @staticmethod
 
1425
    def is_compatible(source, target):
 
1426
        """Be compatible with weaves."""
 
1427
        try:
 
1428
            return (isinstance(source, Weave) and
 
1429
                    isinstance(target, Weave))
 
1430
        except AttributeError:
 
1431
            return False
 
1432
 
 
1433
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1434
        """See InterVersionedFile.join."""
 
1435
        if self.target.versions() == []:
 
1436
            # optimised copy
 
1437
            self.target._copy_weave_content(self.source)
 
1438
            return
 
1439
        try:
 
1440
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1441
        except errors.WeaveParentMismatch:
 
1442
            self.target._reweave(self.source, pb, msg)
 
1443
 
 
1444
 
 
1445
InterVersionedFile.register_optimiser(InterWeave)