/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: John Arbash Meinel
  • Date: 2008-05-30 21:44:30 UTC
  • mfrom: (3462 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3463.
  • Revision ID: john@arbash-meinel.com-20080530214430-nbo0wxzbid6z22ml
merge bzr.dev, resolve NEWS

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