/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Aaron Bentley
  • Date: 2006-06-15 03:10:51 UTC
  • mto: This revision was merged to the branch mainline in revision 1771.
  • Revision ID: aaron.bentley@utoronto.ca-20060615031051-94c53f386edc1f8c
Ignore lines that start with '#' in patch parser

Show diffs side-by-side

added added

removed removed

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