/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

Deprecate VersionedFile.join.

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
 
# 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
import warnings
 
77
 
 
78
from bzrlib import (
 
79
    progress,
 
80
    )
 
81
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
82
        RevisionAlreadyPresent,
 
83
        RevisionNotPresent,
 
84
        UnavailableRepresentation,
 
85
        WeaveRevisionAlreadyPresent,
 
86
        WeaveRevisionNotPresent,
 
87
        )
 
88
import bzrlib.errors as errors
 
89
from bzrlib.osutils import sha_strings, split_lines
 
90
import bzrlib.patiencediff
 
91
from bzrlib.trace import mutter
 
92
from bzrlib.tsort import topo_sort
 
93
from bzrlib.versionedfile import (
 
94
    AbsentContentFactory,
 
95
    adapter_registry,
 
96
    ContentFactory,
 
97
    InterVersionedFile,
 
98
    VersionedFile,
 
99
    )
 
100
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
101
 
 
102
 
 
103
class WeaveContentFactory(ContentFactory):
 
104
    """Content factory for streaming from weaves.
 
105
 
 
106
    :seealso ContentFactory:
 
107
    """
 
108
 
 
109
    def __init__(self, version, weave):
 
110
        """Create a WeaveContentFactory for version from weave."""
 
111
        ContentFactory.__init__(self)
 
112
        self.sha1 = weave.get_sha1s([version])[0]
 
113
        self.key = (version,)
 
114
        parents = weave.get_parent_map([version])[version]
 
115
        self.parents = tuple((parent,) for parent in parents)
 
116
        self.storage_kind = 'fulltext'
 
117
        self._weave = weave
 
118
 
 
119
    def get_bytes_as(self, storage_kind):
 
120
        if storage_kind == 'fulltext':
 
121
            return self._weave.get_text(self.key[0])
 
122
        else:
 
123
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
 
124
 
 
125
 
 
126
class Weave(VersionedFile):
90
127
    """weave - versioned text file storage.
91
128
    
92
129
    A Weave manages versions of line-based text files, keeping track
118
155
    The instruction can be '{' or '}' for an insertion block, and '['
119
156
    and ']' for a deletion block respectively.  The version is the
120
157
    integer version index.  There is no replace operator, only deletes
121
 
    and inserts.
 
158
    and inserts.  For '}', the end of an insertion, there is no
 
159
    version parameter because it always closes the most recently
 
160
    opened insertion.
122
161
 
123
162
    Constraints/notes:
124
163
 
160
199
        each version; the parent's parents are implied.
161
200
 
162
201
    _sha1s
163
 
        List of hex SHA-1 of each version, or None if not recorded.
 
202
        List of hex SHA-1 of each version.
 
203
 
 
204
    _names
 
205
        List of symbolic names for each version.  Each should be unique.
 
206
 
 
207
    _name_map
 
208
        For each name, the version number.
 
209
 
 
210
    _weave_name
 
211
        Descriptive name of this weave; typically the filename if known.
 
212
        Set by read_weave.
164
213
    """
165
214
 
166
 
    __slots__ = ['_weave', '_parents', '_sha1s']
 
215
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
216
                 '_weave_name', '_matcher']
167
217
    
168
 
    def __init__(self):
 
218
    def __init__(self, weave_name=None, access_mode='w', matcher=None, get_scope=None):
 
219
        """Create a weave.
 
220
 
 
221
        :param get_scope: A callable that returns an opaque object to be used
 
222
            for detecting when this weave goes out of scope (should stop
 
223
            answering requests or allowing mutation).
 
224
        """
 
225
        super(Weave, self).__init__(access_mode)
169
226
        self._weave = []
170
227
        self._parents = []
171
228
        self._sha1s = []
172
 
 
 
229
        self._names = []
 
230
        self._name_map = {}
 
231
        self._weave_name = weave_name
 
232
        if matcher is None:
 
233
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
234
        else:
 
235
            self._matcher = matcher
 
236
        if get_scope is None:
 
237
            get_scope = lambda:None
 
238
        self._get_scope = get_scope
 
239
        self._scope = get_scope()
 
240
        self._access_mode = access_mode
 
241
 
 
242
    def __repr__(self):
 
243
        return "Weave(%r)" % self._weave_name
 
244
 
 
245
    def _check_write_ok(self):
 
246
        """Is the versioned file marked as 'finished' ? Raise if it is."""
 
247
        if self._get_scope() != self._scope:
 
248
            raise errors.OutSideTransaction()
 
249
        if self._access_mode != 'w':
 
250
            raise errors.ReadOnlyObjectDirtiedError(self)
 
251
 
 
252
    def copy(self):
 
253
        """Return a deep copy of self.
 
254
        
 
255
        The copy can be modified without affecting the original weave."""
 
256
        other = Weave()
 
257
        other._weave = self._weave[:]
 
258
        other._parents = self._parents[:]
 
259
        other._sha1s = self._sha1s[:]
 
260
        other._names = self._names[:]
 
261
        other._name_map = self._name_map.copy()
 
262
        other._weave_name = self._weave_name
 
263
        return other
173
264
 
174
265
    def __eq__(self, other):
175
266
        if not isinstance(other, Weave):
176
267
            return False
177
268
        return self._parents == other._parents \
178
 
               and self._weave == other._weave
 
269
               and self._weave == other._weave \
 
270
               and self._sha1s == other._sha1s 
179
271
    
180
 
 
181
272
    def __ne__(self, other):
182
273
        return not self.__eq__(other)
183
274
 
184
 
        
185
 
    def add(self, parents, text):
 
275
    def _idx_to_name(self, version):
 
276
        return self._names[version]
 
277
 
 
278
    def _lookup(self, name):
 
279
        """Convert symbolic version name to index."""
 
280
        self.check_not_reserved_id(name)
 
281
        try:
 
282
            return self._name_map[name]
 
283
        except KeyError:
 
284
            raise RevisionNotPresent(name, self._weave_name)
 
285
 
 
286
    def versions(self):
 
287
        """See VersionedFile.versions."""
 
288
        return self._names[:]
 
289
 
 
290
    def has_version(self, version_id):
 
291
        """See VersionedFile.has_version."""
 
292
        return (version_id in self._name_map)
 
293
 
 
294
    __contains__ = has_version
 
295
 
 
296
    def get_record_stream(self, versions, ordering, include_delta_closure):
 
297
        """Get a stream of records for versions.
 
298
 
 
299
        :param versions: The versions to include. Each version is a tuple
 
300
            (version,).
 
301
        :param ordering: Either 'unordered' or 'topological'. A topologically
 
302
            sorted stream has compression parents strictly before their
 
303
            children.
 
304
        :param include_delta_closure: If True then the closure across any
 
305
            compression parents will be included (in the opaque data).
 
306
        :return: An iterator of ContentFactory objects, each of which is only
 
307
            valid until the iterator is advanced.
 
308
        """
 
309
        if ordering == 'topological':
 
310
            parents = self.get_parent_map(versions)
 
311
            versions = topo_sort(parents)
 
312
        for version in versions:
 
313
            if version in self:
 
314
                yield WeaveContentFactory(version, self)
 
315
            else:
 
316
                yield AbsentContentFactory((version,))
 
317
 
 
318
    def get_parent_map(self, version_ids):
 
319
        """See VersionedFile.get_parent_map."""
 
320
        result = {}
 
321
        for version_id in version_ids:
 
322
            try:
 
323
                result[version_id] = tuple(
 
324
                    map(self._idx_to_name, self._parents[self._lookup(version_id)]))
 
325
            except RevisionNotPresent:
 
326
                pass
 
327
        return result
 
328
 
 
329
    def get_parents_with_ghosts(self, version_id):
 
330
        raise NotImplementedError(self.get_parents_with_ghosts)
 
331
 
 
332
    def insert_record_stream(self, stream):
 
333
        """Insert a record stream into this versioned file.
 
334
 
 
335
        :param stream: A stream of records to insert. 
 
336
        :return: None
 
337
        :seealso VersionedFile.get_record_stream:
 
338
        """
 
339
        adapters = {}
 
340
        for record in stream:
 
341
            # adapt to non-tuple interface
 
342
            parents = [parent[0] for parent in record.parents]
 
343
            if record.storage_kind == 'fulltext':
 
344
                self.add_lines(record.key[0], parents,
 
345
                    split_lines(record.get_bytes_as('fulltext')))
 
346
            else:
 
347
                adapter_key = record.storage_kind, 'fulltext'
 
348
                try:
 
349
                    adapter = adapters[adapter_key]
 
350
                except KeyError:
 
351
                    adapter_factory = adapter_registry.get(adapter_key)
 
352
                    adapter = adapter_factory(self)
 
353
                    adapters[adapter_key] = adapter
 
354
                lines = split_lines(adapter.get_bytes(
 
355
                    record, record.get_bytes_as(record.storage_kind)))
 
356
                try:
 
357
                    self.add_lines(record.key[0], parents, lines)
 
358
                except RevisionAlreadyPresent:
 
359
                    pass
 
360
 
 
361
    def _check_repeated_add(self, name, parents, text, sha1):
 
362
        """Check that a duplicated add is OK.
 
363
 
 
364
        If it is, return the (old) index; otherwise raise an exception.
 
365
        """
 
366
        idx = self._lookup(name)
 
367
        if sorted(self._parents[idx]) != sorted(parents) \
 
368
            or sha1 != self._sha1s[idx]:
 
369
            raise RevisionAlreadyPresent(name, self._weave_name)
 
370
        return idx
 
371
 
 
372
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
373
       left_matching_blocks, nostore_sha, random_id, check_content):
 
374
        """See VersionedFile.add_lines."""
 
375
        idx = self._add(version_id, lines, map(self._lookup, parents),
 
376
            nostore_sha=nostore_sha)
 
377
        return sha_strings(lines), sum(map(len, lines)), idx
 
378
 
 
379
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
186
380
        """Add a single text on top of the weave.
187
381
  
188
382
        Returns the index number of the newly added version.
189
383
 
 
384
        version_id
 
385
            Symbolic name for this version.
 
386
            (Typically the revision-id of the revision that added it.)
 
387
 
190
388
        parents
191
389
            List or set of direct parent version numbers.
192
390
            
193
 
        text
194
 
            Sequence of lines to be added in the new version."""
 
391
        lines
 
392
            Sequence of lines to be added in the new version.
 
393
 
 
394
        :param nostore_sha: See VersionedFile.add_lines.
 
395
        """
 
396
        assert isinstance(version_id, basestring)
 
397
        self._check_lines_not_unicode(lines)
 
398
        self._check_lines_are_lines(lines)
 
399
        if not sha1:
 
400
            sha1 = sha_strings(lines)
 
401
        if sha1 == nostore_sha:
 
402
            raise errors.ExistingContent
 
403
        if version_id in self._name_map:
 
404
            return self._check_repeated_add(version_id, parents, lines, sha1)
195
405
 
196
406
        self._check_versions(parents)
197
 
        ## self._check_lines(text)
 
407
        ## self._check_lines(lines)
198
408
        new_version = len(self._parents)
199
409
 
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))
 
410
        # if we abort after here the (in-memory) weave will be corrupt because only
 
411
        # some fields are updated
 
412
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
413
        #      - Robert Collins 20060226
 
414
        self._parents.append(parents[:])
208
415
        self._sha1s.append(sha1)
 
416
        self._names.append(version_id)
 
417
        self._name_map[version_id] = new_version
209
418
 
210
419
            
211
420
        if not parents:
213
422
            # this more quickly by just appending unconditionally.
214
423
            # even more specially, if we're adding an empty text we
215
424
            # need do nothing at all.
216
 
            if text:
 
425
            if lines:
217
426
                self._weave.append(('{', new_version))
218
 
                self._weave.extend(text)
219
 
                self._weave.append(('}', new_version))
220
 
        
 
427
                self._weave.extend(lines)
 
428
                self._weave.append(('}', None))
221
429
            return new_version
222
430
 
223
431
        if len(parents) == 1:
227
435
                return new_version
228
436
            
229
437
 
230
 
        ancestors = self.inclusions(parents)
 
438
        ancestors = self._inclusions(parents)
231
439
 
232
440
        l = self._weave
233
441
 
238
446
            basis_lineno.append(lineno)
239
447
            basis_lines.append(line)
240
448
 
241
 
        # another small special case: a merge, producing the same text as auto-merge
242
 
        if text == basis_lines:
243
 
            return new_version            
 
449
        # another small special case: a merge, producing the same text
 
450
        # as auto-merge
 
451
        if lines == basis_lines:
 
452
            return new_version
244
453
 
245
 
        # add a sentinal, because we can also match against the final line
 
454
        # add a sentinel, because we can also match against the final line
246
455
        basis_lineno.append(len(self._weave))
247
456
 
248
457
        # XXX: which line of the weave should we really consider
252
461
        #print 'basis_lines:', basis_lines
253
462
        #print 'new_lines:  ', lines
254
463
 
255
 
        from difflib import SequenceMatcher
256
 
        s = SequenceMatcher(None, basis_lines, text)
 
464
        s = self._matcher(None, basis_lines, lines)
257
465
 
258
466
        # offset gives the number of lines that have been inserted
259
467
        # into the weave up to the current point; if the original edit instruction
270
478
            i1 = basis_lineno[i1]
271
479
            i2 = basis_lineno[i2]
272
480
 
273
 
            assert 0 <= j1 <= j2 <= len(text)
 
481
            assert 0 <= j1 <= j2 <= len(lines)
274
482
 
275
483
            #print tag, i1, i2, j1, j2
276
484
 
287
495
                # we don't destroy ourselves
288
496
                i = i2 + offset
289
497
                self._weave[i:i] = ([('{', new_version)] 
290
 
                                + text[j1:j2] 
291
 
                                + [('}', new_version)])
 
498
                                    + lines[j1:j2] 
 
499
                                    + [('}', None)])
292
500
                offset += 2 + (j2 - j1)
293
 
 
294
501
        return new_version
295
502
 
296
 
 
297
 
    def inclusions(self, versions):
 
503
    def _inclusions(self, versions):
298
504
        """Return set of all ancestors of given version(s)."""
 
505
        if not len(versions):
 
506
            return []
299
507
        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:
316
 
            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
 
 
 
508
        for v in xrange(max(versions), 0, -1):
 
509
            if v in i:
 
510
                # include all its parents
 
511
                i.update(self._parents[v])
 
512
        return i
 
513
        ## except IndexError:
 
514
        ##     raise ValueError("version %d not present in weave" % v)
 
515
 
 
516
    def get_ancestry(self, version_ids, topo_sorted=True):
 
517
        """See VersionedFile.get_ancestry."""
 
518
        if isinstance(version_ids, basestring):
 
519
            version_ids = [version_ids]
 
520
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
521
        return [self._idx_to_name(v) for v in i]
334
522
 
335
523
    def _check_lines(self, text):
336
524
        if not isinstance(text, list):
351
539
            except IndexError:
352
540
                raise IndexError("invalid version number %r" % i)
353
541
 
354
 
    
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.
 
542
    def _compatible_parents(self, my_parents, other_parents):
 
543
        """During join check that other_parents are joinable with my_parents.
 
544
 
 
545
        Joinable is defined as 'is a subset of' - supersets may require 
 
546
        regeneration of diffs, but subsets do not.
 
547
        """
 
548
        return len(other_parents.difference(my_parents)) == 0
 
549
 
 
550
    def annotate(self, version_id):
 
551
        """Return a list of (version-id, line) tuples for version_id.
361
552
 
362
553
        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
 
 
367
 
    def _walk(self):
368
 
        """Walk the weave.
369
 
 
370
 
        Yields sequence of
371
 
        (lineno, insert, deletes, text)
372
 
        for each literal line.
373
 
        """
 
554
        incls = [self._lookup(version_id)]
 
555
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
556
            self._extract(incls)]
 
557
 
 
558
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
559
                                                pb=None):
 
560
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
561
        if version_ids is None:
 
562
            version_ids = self.versions()
 
563
        version_ids = set(version_ids)
 
564
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
565
            # if inserted not in version_ids then it was inserted before the
 
566
            # versions we care about, but because weaves cannot represent ghosts
 
567
            # properly, we do not filter down to that
 
568
            # if inserted not in version_ids: continue
 
569
            if line[-1] != '\n':
 
570
                yield line + '\n', inserted
 
571
            else:
 
572
                yield line, inserted
 
573
 
 
574
    def _walk_internal(self, version_ids=None):
 
575
        """Helper method for weave actions."""
374
576
        
375
577
        istack = []
376
578
        dset = set()
378
580
        lineno = 0         # line of weave, 0-based
379
581
 
380
582
        for l in self._weave:
381
 
            if isinstance(l, tuple):
 
583
            if l.__class__ == tuple:
382
584
                c, v = l
383
585
                isactive = None
384
586
                if c == '{':
385
 
                    istack.append(v)
 
587
                    istack.append(self._names[v])
386
588
                elif c == '}':
387
 
                    oldv = istack.pop()
 
589
                    istack.pop()
388
590
                elif c == '[':
389
 
                    assert v not in dset
390
 
                    dset.add(v)
 
591
                    assert self._names[v] not in dset
 
592
                    dset.add(self._names[v])
391
593
                elif c == ']':
392
 
                    dset.remove(v)
 
594
                    dset.remove(self._names[v])
393
595
                else:
394
 
                    raise WeaveFormatError('unexpected instruction %r'
395
 
                                           % v)
 
596
                    raise WeaveFormatError('unexpected instruction %r' % v)
396
597
            else:
397
 
                assert isinstance(l, basestring)
 
598
                assert l.__class__ in (str, unicode)
398
599
                assert istack
399
 
                yield lineno, istack[-1], dset, l
 
600
                yield lineno, istack[-1], frozenset(dset), l
400
601
            lineno += 1
401
602
 
402
 
 
 
603
        if istack:
 
604
            raise WeaveFormatError("unclosed insertion blocks "
 
605
                    "at end of weave: %s" % istack)
 
606
        if dset:
 
607
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
608
                                   % dset)
 
609
 
 
610
    def plan_merge(self, ver_a, ver_b):
 
611
        """Return pseudo-annotation indicating how the two versions merge.
 
612
 
 
613
        This is computed between versions a and b and their common
 
614
        base.
 
615
 
 
616
        Weave lines present in none of them are skipped entirely.
 
617
        """
 
618
        inc_a = set(self.get_ancestry([ver_a]))
 
619
        inc_b = set(self.get_ancestry([ver_b]))
 
620
        inc_c = inc_a & inc_b
 
621
 
 
622
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
623
            if deleteset & inc_c:
 
624
                # killed in parent; can't be in either a or b
 
625
                # not relevant to our work
 
626
                yield 'killed-base', line
 
627
            elif insert in inc_c:
 
628
                # was inserted in base
 
629
                killed_a = bool(deleteset & inc_a)
 
630
                killed_b = bool(deleteset & inc_b)
 
631
                if killed_a and killed_b:
 
632
                    yield 'killed-both', line
 
633
                elif killed_a:
 
634
                    yield 'killed-a', line
 
635
                elif killed_b:
 
636
                    yield 'killed-b', line
 
637
                else:
 
638
                    yield 'unchanged', line
 
639
            elif insert in inc_a:
 
640
                if deleteset & inc_a:
 
641
                    yield 'ghost-a', line
 
642
                else:
 
643
                    # new in A; not in B
 
644
                    yield 'new-a', line
 
645
            elif insert in inc_b:
 
646
                if deleteset & inc_b:
 
647
                    yield 'ghost-b', line
 
648
                else:
 
649
                    yield 'new-b', line
 
650
            else:
 
651
                # not in either revision
 
652
                yield 'irrelevant', line
 
653
 
 
654
        yield 'unchanged', ''           # terminator
403
655
 
404
656
    def _extract(self, versions):
405
657
        """Yield annotation of lines in included set.
410
662
 
411
663
        The set typically but not necessarily corresponds to a version.
412
664
        """
413
 
        included = self.inclusions(versions)
 
665
        for i in versions:
 
666
            if not isinstance(i, int):
 
667
                raise ValueError(i)
 
668
            
 
669
        included = self._inclusions(versions)
414
670
 
415
671
        istack = []
 
672
        iset = set()
416
673
        dset = set()
417
674
 
418
675
        lineno = 0         # line of weave, 0-based
423
680
 
424
681
        WFE = WeaveFormatError
425
682
 
 
683
        # wow. 
 
684
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
685
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
686
        # 1.6 seconds in 'isinstance'.
 
687
        # changing the first isinstance:
 
688
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
689
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
690
        # note that the inline time actually dropped (less function calls)
 
691
        # and total processing time was halved.
 
692
        # we're still spending ~1/4 of the method in isinstance though.
 
693
        # so lets hard code the acceptable string classes we expect:
 
694
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
695
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
696
        #                                          objects>
 
697
        # yay, down to ~1/4 the initial extract time, and our inline time
 
698
        # has shrunk again, with isinstance no longer dominating.
 
699
        # tweaking the stack inclusion test to use a set gives:
 
700
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
701
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
702
        #                                          objects>
 
703
        # - a 5% win, or possibly just noise. However with large istacks that
 
704
        # 'in' test could dominate, so I'm leaving this change in place -
 
705
        # when its fast enough to consider profiling big datasets we can review.
 
706
 
 
707
              
 
708
             
 
709
 
426
710
        for l in self._weave:
427
 
            if isinstance(l, tuple):
 
711
            if l.__class__ == tuple:
428
712
                c, v = l
429
713
                isactive = None
430
714
                if c == '{':
431
 
                    assert v not in istack
 
715
                    assert v not in iset
432
716
                    istack.append(v)
 
717
                    iset.add(v)
433
718
                elif c == '}':
434
 
                    oldv = istack.pop()
435
 
                    assert oldv == v
 
719
                    iset.remove(istack.pop())
436
720
                elif c == '[':
437
721
                    if v in included:
438
722
                        assert v not in dset
443
727
                        assert v in dset
444
728
                        dset.remove(v)
445
729
            else:
446
 
                assert isinstance(l, basestring)
 
730
                assert l.__class__ in (str, unicode)
447
731
                if isactive is None:
448
732
                    isactive = (not dset) and istack and (istack[-1] in included)
449
733
                if isactive:
450
734
                    result.append((istack[-1], lineno, l))
451
735
            lineno += 1
452
 
 
453
736
        if istack:
454
 
            raise WFE("unclosed insertion blocks at end of weave",
455
 
                                   istack)
 
737
            raise WeaveFormatError("unclosed insertion blocks "
 
738
                    "at end of weave: %s" % istack)
456
739
        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
 
 
489
 
    def numversions(self):
 
740
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
741
                                   % dset)
 
742
        return result
 
743
 
 
744
    def _maybe_lookup(self, name_or_index):
 
745
        """Convert possible symbolic name to index, or pass through indexes.
 
746
        
 
747
        NOT FOR PUBLIC USE.
 
748
        """
 
749
        if isinstance(name_or_index, (int, long)):
 
750
            return name_or_index
 
751
        else:
 
752
            return self._lookup(name_or_index)
 
753
 
 
754
    def get_lines(self, version_id):
 
755
        """See VersionedFile.get_lines()."""
 
756
        int_index = self._maybe_lookup(version_id)
 
757
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
758
        expected_sha1 = self._sha1s[int_index]
 
759
        measured_sha1 = sha_strings(result)
 
760
        if measured_sha1 != expected_sha1:
 
761
            raise errors.WeaveInvalidChecksum(
 
762
                    'file %s, revision %s, expected: %s, measured %s' 
 
763
                    % (self._weave_name, version_id,
 
764
                       expected_sha1, measured_sha1))
 
765
        return result
 
766
 
 
767
    def get_sha1s(self, version_ids):
 
768
        """See VersionedFile.get_sha1s()."""
 
769
        return [self._sha1s[self._lookup(v)] for v in version_ids]
 
770
 
 
771
    def num_versions(self):
 
772
        """How many versions are in this weave?"""
490
773
        l = len(self._parents)
491
774
        assert l == len(self._sha1s)
492
775
        return l
493
776
 
494
 
 
495
 
    def __len__(self):
496
 
        return self.numversions()
497
 
 
 
777
    __len__ = num_versions
498
778
 
499
779
    def check(self, progress_bar=None):
500
 
        # check no circular inclusions
501
 
        for version in range(self.numversions()):
 
780
        # TODO evaluate performance hit of using string sets in this routine.
 
781
        # TODO: check no circular inclusions
 
782
        # TODO: create a nested progress bar
 
783
        for version in range(self.num_versions()):
502
784
            inclusions = list(self._parents[version])
503
785
            if inclusions:
504
786
                inclusions.sort()
506
788
                    raise WeaveFormatError("invalid included version %d for index %d"
507
789
                                           % (inclusions[-1], version))
508
790
 
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):
 
791
        # try extracting all versions; parallel extraction is used
 
792
        nv = self.num_versions()
 
793
        sha1s = {}
 
794
        texts = {}
 
795
        inclusions = {}
 
796
        for i in range(nv):
 
797
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
798
            # The problem is that set membership is much more expensive
 
799
            name = self._idx_to_name(i)
 
800
            sha1s[name] = sha.new()
 
801
            texts[name] = []
 
802
            new_inc = set([name])
 
803
            for p in self._parents[i]:
 
804
                new_inc.update(inclusions[self._idx_to_name(p)])
 
805
 
 
806
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
807
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
808
            inclusions[name] = new_inc
 
809
 
 
810
        nlines = len(self._weave)
 
811
 
 
812
        update_text = 'checking weave'
 
813
        if self._weave_name:
 
814
            short_name = os.path.basename(self._weave_name)
 
815
            update_text = 'checking %s' % (short_name,)
 
816
            update_text = update_text[:25]
 
817
 
 
818
        for lineno, insert, deleteset, line in self._walk_internal():
514
819
            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]
 
820
                progress_bar.update(update_text, lineno, nlines)
 
821
 
 
822
            for name, name_inclusions in inclusions.items():
 
823
                # The active inclusion must be an ancestor,
 
824
                # and no ancestors must have deleted this line,
 
825
                # because we don't support resurrection.
 
826
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
827
                    sha1s[name].update(line)
 
828
 
 
829
        for i in range(nv):
 
830
            version = self._idx_to_name(i)
 
831
            hd = sha1s[version].hexdigest()
 
832
            expected = self._sha1s[i]
521
833
            if hd != expected:
522
 
                raise WeaveError("mismatched sha1 for version %d; "
523
 
                                 "got %s, expected %s"
524
 
                                 % (version, hd, expected))
 
834
                raise errors.WeaveInvalidChecksum(
 
835
                        "mismatched sha1 for version %s: "
 
836
                        "got %s, expected %s"
 
837
                        % (version, hd, expected))
525
838
 
526
839
        # TODO: check insertions are properly nested, that there are
527
840
        # no lines outside of insertion blocks, that deletions are
528
841
        # properly paired, etc.
529
842
 
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):
 
843
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
844
        """Worker routine for join()."""
 
845
        if not other.versions():
 
846
            return          # nothing to update, easy
 
847
 
 
848
        if not version_ids:
 
849
            # versions is never none, InterWeave checks this.
 
850
            return 0
 
851
 
 
852
        # two loops so that we do not change ourselves before verifying it
 
853
        # will be ok
 
854
        # work through in index order to make sure we get all dependencies
 
855
        names_to_join = []
 
856
        processed = 0
 
857
        # get the selected versions only that are in other.versions.
 
858
        version_ids = set(other.versions()).intersection(set(version_ids))
 
859
        # pull in the referenced graph.
 
860
        version_ids = other.get_ancestry(version_ids)
 
861
        pending_parents = other.get_parent_map(version_ids)
 
862
        pending_graph = pending_parents.items()
 
863
        if len(pending_graph) != len(version_ids):
 
864
            raise RevisionNotPresent(
 
865
                set(version_ids) - set(pending_parents.keys()), self)
 
866
        for name in topo_sort(pending_graph):
 
867
            other_idx = other._name_map[name]
 
868
            # returns True if we have it, False if we need it.
 
869
            if not self._check_version_consistent(other, other_idx, name):
 
870
                names_to_join.append((other_idx, name))
 
871
            processed += 1
 
872
 
 
873
        if pb and not msg:
 
874
            msg = 'weave join'
 
875
 
 
876
        merged = 0
 
877
        time0 = time.time()
 
878
        for other_idx, name in names_to_join:
 
879
            # TODO: If all the parents of the other version are already
 
880
            # present then we can avoid some work by just taking the delta
 
881
            # and adjusting the offsets.
 
882
            new_parents = self._imported_parents(other, other_idx)
 
883
            sha1 = other._sha1s[other_idx]
 
884
 
 
885
            merged += 1
 
886
 
 
887
            if pb:
 
888
                pb.update(msg, merged, len(names_to_join))
 
889
           
 
890
            lines = other.get_lines(other_idx)
 
891
            self._add(name, lines, new_parents, sha1)
 
892
 
 
893
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
894
                merged, processed, self._weave_name, time.time()-time0))
 
895
 
 
896
    def _imported_parents(self, other, other_idx):
 
897
        """Return list of parents in self corresponding to indexes in other."""
 
898
        new_parents = []
 
899
        for parent_idx in other._parents[other_idx]:
 
900
            parent_name = other._names[parent_idx]
 
901
            if parent_name not in self._name_map:
 
902
                # should not be possible
 
903
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
904
                                 % (parent_name, other._name_map[other_idx], self))
 
905
            new_parents.append(self._name_map[parent_name])
 
906
        return new_parents
 
907
 
 
908
    def _check_version_consistent(self, other, other_idx, name):
 
909
        """Check if a version in consistent in this and other.
 
910
 
 
911
        To be consistent it must have:
 
912
 
 
913
         * the same text
 
914
         * the same direct parents (by name, not index, and disregarding
 
915
           order)
 
916
        
 
917
        If present & correct return True;
 
918
        if not present in self return False; 
 
919
        if inconsistent raise error."""
 
920
        this_idx = self._name_map.get(name, -1)
 
921
        if this_idx != -1:
 
922
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
923
                raise errors.WeaveTextDiffers(name, self, other)
 
924
            self_parents = self._parents[this_idx]
 
925
            other_parents = other._parents[other_idx]
 
926
            n1 = set([self._names[i] for i in self_parents])
 
927
            n2 = set([other._names[i] for i in other_parents])
 
928
            if not self._compatible_parents(n1, n2):
 
929
                raise WeaveParentMismatch("inconsistent parents "
 
930
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
931
            else:
 
932
                return True         # ok!
 
933
        else:
 
934
            return False
 
935
 
 
936
    def _reweave(self, other, pb, msg):
 
937
        """Reweave self with other - internal helper for join().
 
938
 
 
939
        :param other: The other weave to merge
 
940
        :param pb: An optional progress bar, indicating how far done we are
 
941
        :param msg: An optional message for the progress
 
942
        """
 
943
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
944
        self._copy_weave_content(new_weave)
 
945
 
 
946
    def _copy_weave_content(self, otherweave):
 
947
        """adsorb the content from otherweave."""
 
948
        for attr in self.__slots__:
 
949
            if attr != '_weave_name':
 
950
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
951
 
 
952
 
 
953
class WeaveFile(Weave):
 
954
    """A WeaveFile represents a Weave on disk and writes on change."""
 
955
 
 
956
    WEAVE_SUFFIX = '.weave'
 
957
    
 
958
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
959
        """Create a WeaveFile.
 
960
        
 
961
        :param create: If not True, only open an existing knit.
 
962
        """
 
963
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope)
 
964
        self._transport = transport
 
965
        self._filemode = filemode
 
966
        try:
 
967
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
968
        except errors.NoSuchFile:
 
969
            if not create:
 
970
                raise
 
971
            # new file, save it
 
972
            self._save()
 
973
 
 
974
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
975
        left_matching_blocks, nostore_sha, random_id, check_content):
 
976
        """Add a version and save the weave."""
 
977
        self.check_not_reserved_id(version_id)
 
978
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
979
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
980
            check_content)
 
981
        self._save()
 
982
        return result
 
983
 
 
984
    def copy_to(self, name, transport):
 
985
        """See VersionedFile.copy_to()."""
 
986
        # as we are all in memory always, just serialise to the new place.
 
987
        sio = StringIO()
 
988
        write_weave_v5(self, sio)
 
989
        sio.seek(0)
 
990
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
991
 
 
992
    def _save(self):
 
993
        """Save the weave."""
 
994
        self._check_write_ok()
 
995
        sio = StringIO()
 
996
        write_weave_v5(self, sio)
 
997
        sio.seek(0)
 
998
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
999
                                 sio,
 
1000
                                 self._filemode)
 
1001
 
 
1002
    @staticmethod
 
1003
    def get_suffixes():
 
1004
        """See VersionedFile.get_suffixes()."""
 
1005
        return [WeaveFile.WEAVE_SUFFIX]
 
1006
 
 
1007
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1008
             ignore_missing=False):
 
1009
        """Join other into self and save."""
 
1010
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
1011
        self._save()
 
1012
 
 
1013
 
 
1014
def _reweave(wa, wb, pb=None, msg=None):
 
1015
    """Combine two weaves and return the result.
 
1016
 
 
1017
    This works even if a revision R has different parents in 
 
1018
    wa and wb.  In the resulting weave all the parents are given.
 
1019
 
 
1020
    This is done by just building up a new weave, maintaining ordering 
 
1021
    of the versions in the two inputs.  More efficient approaches
 
1022
    might be possible but it should only be necessary to do 
 
1023
    this operation rarely, when a new previously ghost version is 
 
1024
    inserted.
 
1025
 
 
1026
    :param pb: An optional progress bar, indicating how far done we are
 
1027
    :param msg: An optional message for the progress
 
1028
    """
 
1029
    wr = Weave()
 
1030
    ia = ib = 0
 
1031
    queue_a = range(wa.num_versions())
 
1032
    queue_b = range(wb.num_versions())
 
1033
    # first determine combined parents of all versions
 
1034
    # map from version name -> all parent names
 
1035
    combined_parents = _reweave_parent_graphs(wa, wb)
 
1036
    mutter("combined parents: %r", combined_parents)
 
1037
    order = topo_sort(combined_parents.iteritems())
 
1038
    mutter("order to reweave: %r", order)
 
1039
 
 
1040
    if pb and not msg:
 
1041
        msg = 'reweave'
 
1042
 
 
1043
    for idx, name in enumerate(order):
 
1044
        if pb:
 
1045
            pb.update(msg, idx, len(order))
 
1046
        if name in wa._name_map:
 
1047
            lines = wa.get_lines(name)
 
1048
            if name in wb._name_map:
 
1049
                lines_b = wb.get_lines(name)
 
1050
                if lines != lines_b:
 
1051
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1052
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1053
                    import difflib
 
1054
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1055
                            wa._weave_name, wb._weave_name))
 
1056
                    mutter('lines:\n%s', ''.join(lines))
 
1057
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1058
        else:
 
1059
            lines = wb.get_lines(name)
 
1060
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1061
    return wr
 
1062
 
 
1063
def _reweave_parent_graphs(wa, wb):
 
1064
    """Return combined parent ancestry for two weaves.
 
1065
    
 
1066
    Returned as a list of (version_name, set(parent_names))"""
 
1067
    combined = {}
 
1068
    for weave in [wa, wb]:
 
1069
        for idx, name in enumerate(weave._names):
 
1070
            p = combined.setdefault(name, set())
 
1071
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1072
    return combined
 
1073
 
 
1074
 
 
1075
def weave_toc(w):
 
1076
    """Show the weave's table-of-contents"""
 
1077
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1078
    for i in (6, 50, 10, 10):
677
1079
        print '-' * i,
678
1080
    print
679
 
    for i in range(w.numversions()):
 
1081
    for i in range(w.num_versions()):
680
1082
        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
 
1083
        name = w._names[i]
 
1084
        parent_str = ' '.join(map(str, w._parents[i]))
 
1085
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1086
 
 
1087
 
 
1088
 
 
1089
def weave_stats(weave_file, pb):
687
1090
    from bzrlib.weavefile import read_weave
688
1091
 
689
 
    pb = ProgressBar()
690
 
 
691
1092
    wf = file(weave_file, 'rb')
692
1093
    w = read_weave(wf)
693
1094
    # FIXME: doesn't work on pipes
697
1098
    vers = len(w)
698
1099
    for i in range(vers):
699
1100
        pb.update('checking sizes', i, vers)
700
 
        for line in w.get_iter(i):
 
1101
        for origin, lineno, line in w._extract([i]):
701
1102
            total += len(line)
702
1103
 
703
1104
    pb.clear()
706
1107
    print 'weave file        %9d bytes' % weave_size
707
1108
    print 'total contents    %9d bytes' % total
708
1109
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
709
 
 
 
1110
    if vers:
 
1111
        avg = total/vers
 
1112
        print 'average size      %9d bytes' % avg
 
1113
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
710
1114
 
711
1115
 
712
1116
def usage():
721
1125
        Write out specified version.
722
1126
    weave check WEAVEFILE
723
1127
        Check consistency of all versions.
724
 
    weave info WEAVEFILE
 
1128
    weave toc WEAVEFILE
725
1129
        Display table of contents.
726
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
1130
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
727
1131
        Add NEWTEXT, with specified parent versions.
728
1132
    weave annotate WEAVEFILE VERSION
729
1133
        Display origin of each line.
730
 
    weave mash WEAVEFILE VERSION...
731
 
        Display composite of all selected versions.
732
1134
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
733
1135
        Auto-merge two versions and display conflicts.
 
1136
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1137
        Show differences between two versions.
734
1138
 
735
1139
example:
736
1140
 
737
1141
    % weave init foo.weave
738
1142
    % vi foo.txt
739
 
    % weave add foo.weave < foo.txt
 
1143
    % weave add foo.weave ver0 < foo.txt
740
1144
    added version 0
741
1145
 
742
1146
    (create updated version)
743
1147
    % vi foo.txt
744
1148
    % weave get foo.weave 0 | diff -u - foo.txt
745
 
    % weave add foo.weave 0 < foo.txt
 
1149
    % weave add foo.weave ver1 0 < foo.txt
746
1150
    added version 1
747
1151
 
748
1152
    % weave get foo.weave 0 > foo.txt       (create forked version)
749
1153
    % vi foo.txt
750
 
    % weave add foo.weave 0 < foo.txt
 
1154
    % weave add foo.weave ver2 0 < foo.txt
751
1155
    added version 2
752
1156
 
753
1157
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
754
1158
    % vi foo.txt                            (resolve conflicts)
755
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
1159
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
756
1160
    
757
1161
"""
758
1162
    
761
1165
def main(argv):
762
1166
    import sys
763
1167
    import os
764
 
    from weavefile import write_weave, read_weave
 
1168
    try:
 
1169
        import bzrlib
 
1170
    except ImportError:
 
1171
        # in case we're run directly from the subdirectory
 
1172
        sys.path.append('..')
 
1173
        import bzrlib
 
1174
    from bzrlib.weavefile import write_weave, read_weave
765
1175
    from bzrlib.progress import ProgressBar
766
1176
 
767
 
    #import psyco
768
 
    #psyco.full()
 
1177
    try:
 
1178
        import psyco
 
1179
        psyco.full()
 
1180
    except ImportError:
 
1181
        pass
 
1182
 
 
1183
    if len(argv) < 2:
 
1184
        usage()
 
1185
        return 0
769
1186
 
770
1187
    cmd = argv[1]
771
1188
 
777
1194
    elif cmd == 'add':
778
1195
        w = readit()
779
1196
        # at the moment, based on everything in the file
780
 
        parents = map(int, argv[3:])
 
1197
        name = argv[3]
 
1198
        parents = map(int, argv[4:])
781
1199
        lines = sys.stdin.readlines()
782
 
        ver = w.add(parents, lines)
 
1200
        ver = w.add(name, parents, lines)
783
1201
        write_weave(w, file(argv[2], 'wb'))
784
 
        print 'added version %d' % ver
 
1202
        print 'added version %r %d' % (name, ver)
785
1203
    elif cmd == 'init':
786
1204
        fn = argv[2]
787
1205
        if os.path.exists(fn):
792
1210
        w = readit()
793
1211
        sys.stdout.writelines(w.get_iter(int(argv[3])))
794
1212
        
795
 
    elif cmd == 'mash': # get composite
 
1213
    elif cmd == 'diff':
796
1214
        w = readit()
797
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
798
 
 
 
1215
        fn = argv[2]
 
1216
        v1, v2 = map(int, argv[3:5])
 
1217
        lines1 = w.get(v1)
 
1218
        lines2 = w.get(v2)
 
1219
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1220
                                '%s version %d' % (fn, v1),
 
1221
                                '%s version %d' % (fn, v2))
 
1222
        sys.stdout.writelines(diff_gen)
 
1223
            
799
1224
    elif cmd == 'annotate':
800
1225
        w = readit()
801
1226
        # newline is added to all lines regardless; too hard to get
809
1234
                print '%5d | %s' % (origin, text)
810
1235
                lasto = origin
811
1236
                
812
 
    elif cmd == 'info':
813
 
        weave_info(readit())
 
1237
    elif cmd == 'toc':
 
1238
        weave_toc(readit())
814
1239
 
815
1240
    elif cmd == 'stats':
816
 
        weave_stats(argv[2])
 
1241
        weave_stats(argv[2], ProgressBar())
817
1242
        
818
1243
    elif cmd == 'check':
819
1244
        w = readit()
820
1245
        pb = ProgressBar()
821
1246
        w.check(pb)
822
1247
        pb.clear()
823
 
        print '%d versions ok' % w.numversions()
 
1248
        print '%d versions ok' % w.num_versions()
824
1249
 
825
1250
    elif cmd == 'inclusions':
826
1251
        w = readit()
831
1256
        print ' '.join(map(str, w._parents[int(argv[3])]))
832
1257
 
833
1258
    elif cmd == 'plan-merge':
 
1259
        # replaced by 'bzr weave-plan-merge'
834
1260
        w = readit()
835
1261
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
836
1262
            if line:
837
1263
                print '%14s | %s' % (state, line),
838
 
 
839
1264
    elif cmd == 'merge':
 
1265
        # replaced by 'bzr weave-merge-text'
840
1266
        w = readit()
841
1267
        p = w.plan_merge(int(argv[3]), int(argv[4]))
842
1268
        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
1269
    else:
865
1270
        raise ValueError('unknown command %r' % cmd)
866
1271
    
868
1273
if __name__ == '__main__':
869
1274
    import sys
870
1275
    sys.exit(main(sys.argv))
 
1276
 
 
1277
 
 
1278
class InterWeave(InterVersionedFile):
 
1279
    """Optimised code paths for weave to weave operations."""
 
1280
    
 
1281
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1282
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1283
    
 
1284
    @staticmethod
 
1285
    def is_compatible(source, target):
 
1286
        """Be compatible with weaves."""
 
1287
        try:
 
1288
            return (isinstance(source, Weave) and
 
1289
                    isinstance(target, Weave))
 
1290
        except AttributeError:
 
1291
            return False
 
1292
 
 
1293
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1294
        """See InterVersionedFile.join."""
 
1295
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1296
        if self.target.versions() == [] and version_ids is None:
 
1297
            self.target._copy_weave_content(self.source)
 
1298
            return
 
1299
        self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1300
 
 
1301
 
 
1302
InterVersionedFile.register_optimiser(InterWeave)