← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 23:43:18 UTC
  • mto: This revision was merged to the branch mainline in revision 2027.
  • Revision ID: john@arbash-meinel.com-20060920234318-05de23e98f7e7876
Move out export tests from test_too_much, refactor
and re-enable doc tests for export.get_root_name()

Show diffs side-by-side

added added

removed removed

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