~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Vincent Ladeuil
  • Date: 2016-02-07 18:23:13 UTC
  • mto: (6615.3.1 2.7)
  • mto: This revision was merged to the branch mainline in revision 6620.
  • Revision ID: v.ladeuil+lp@free.fr-20160207182313-jwz7z3vj4mpyjn7y
Ensure http://pad.lv/1323805 won't come back.

Since the 2.6.0 release pypi policy changed and release tarballs can't be
hosted on launchpad anymore, they have to be uploaded to
http://pypi.python.org/pypi


This fixes setup.py sdist to generate the right tarball with nearly the same
content as the one produced for 2.7.0.

Such a tarball have been uploaded to pypi properly signed and tested for
installation in venv.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2009 Canonical Ltd
 
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
# Author: Martin Pool <mbp@canonical.com>
20
18
 
21
 
 
22
19
"""Weave - storage of related text file versions"""
23
20
 
24
 
# before intset (r923) 2000 versions in 41.5s
25
 
# with intset (r926) 2000 versions in 93s !!!
26
 
# better to just use plain sets.
27
 
 
28
 
# making _extract build and return a list, rather than being a generator
29
 
# takes 37.94s
30
 
 
31
 
# with python -O, r923 does 2000 versions in 36.87s
32
 
 
33
 
# with optimizations to avoid mutating lists - 35.75!  I guess copying
34
 
# all the elements every time costs more than the small manipulations.
35
 
# a surprisingly small change.
36
 
 
37
 
# r931, which avoids using a generator for extract, does 36.98s
38
 
 
39
 
# with memoized inclusions, takes 41.49s; not very good
40
 
 
41
 
# with slots, takes 37.35s; without takes 39.16, a bit surprising
42
 
 
43
 
# with the delta calculation mixed in with the add method, rather than
44
 
# separated, takes 36.78s
45
 
 
46
 
# with delta folded in and mutation of the list, 36.13s
47
 
 
48
 
# with all this and simplification of add code, 33s
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
# TODO: Perhaps have copy method for Weave instances?
 
21
from __future__ import absolute_import
55
22
 
56
23
# XXX: If we do weaves this way, will a merge still behave the same
57
24
# way if it's done in a different order?  That's a pretty desirable
58
25
# property.
59
26
 
60
27
# TODO: Nothing here so far assumes the lines are really \n newlines,
61
 
# rather than being split up in some other way.  We could accomodate
 
28
# rather than being split up in some other way.  We could accommodate
62
29
# binaries, perhaps by naively splitting on \n or perhaps using
63
30
# something like a rolling checksum.
64
31
 
74
41
 
75
42
# TODO: Parallel-extract that passes back each line along with a
76
43
# description of which revisions include it.  Nice for checking all
77
 
# shas in parallel.
 
44
# shas or calculating stats in parallel.
78
45
 
79
46
# TODO: Using a single _extract routine and then processing the output
80
47
# is probably inefficient.  It's simple enough that we can afford to
81
48
# have slight specializations for different ways its used: annotate,
82
49
# basis for add, get, etc.
83
50
 
84
 
# TODO: Perhaps the API should work only in names to hide the integer
85
 
# indexes from the user?
86
 
 
87
 
 
88
 
 
89
 
import sha
 
51
# TODO: Probably the API should work only in names to hide the integer
 
52
# indexes from the user.
 
53
 
 
54
# TODO: Is there any potential performance win by having an add()
 
55
# variant that is passed a pre-cooked version of the single basis
 
56
# version?
 
57
 
 
58
# TODO: Reweave can possibly be made faster by remembering diffs
 
59
# where the basis and destination are unchanged.
 
60
 
 
61
# FIXME: Sometimes we will be given a parents list for a revision
 
62
# that includes some redundant parents (i.e. already a parent of
 
63
# something in the list.)  We should eliminate them.  This can
 
64
# be done fairly efficiently because the sequence numbers constrain
 
65
# the possible relationships.
 
66
 
 
67
# FIXME: the conflict markers should be *7* characters
 
68
 
 
69
from copy import copy
90
70
from cStringIO import StringIO
91
 
 
92
 
 
93
 
class WeaveError(Exception):
94
 
    """Exception in processing weave"""
95
 
 
96
 
 
97
 
class WeaveFormatError(WeaveError):
98
 
    """Weave invariant violated"""
99
 
    
100
 
 
101
 
class Weave(object):
 
71
import os
 
72
 
 
73
from bzrlib.lazy_import import lazy_import
 
74
lazy_import(globals(), """
 
75
from bzrlib import tsort
 
76
""")
 
77
from bzrlib import (
 
78
    errors,
 
79
    osutils,
 
80
    )
 
81
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
82
        RevisionAlreadyPresent,
 
83
        RevisionNotPresent,
 
84
        UnavailableRepresentation,
 
85
        )
 
86
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
 
87
import bzrlib.patiencediff
 
88
from bzrlib.revision import NULL_REVISION
 
89
from bzrlib.symbol_versioning import *
 
90
from bzrlib.trace import mutter
 
91
from bzrlib.versionedfile import (
 
92
    AbsentContentFactory,
 
93
    adapter_registry,
 
94
    ContentFactory,
 
95
    sort_groupcompress,
 
96
    VersionedFile,
 
97
    )
 
98
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
99
 
 
100
 
 
101
class WeaveContentFactory(ContentFactory):
 
102
    """Content factory for streaming from weaves.
 
103
 
 
104
    :seealso ContentFactory:
 
105
    """
 
106
 
 
107
    def __init__(self, version, weave):
 
108
        """Create a WeaveContentFactory for version from weave."""
 
109
        ContentFactory.__init__(self)
 
110
        self.sha1 = weave.get_sha1s([version])[version]
 
111
        self.key = (version,)
 
112
        parents = weave.get_parent_map([version])[version]
 
113
        self.parents = tuple((parent,) for parent in parents)
 
114
        self.storage_kind = 'fulltext'
 
115
        self._weave = weave
 
116
 
 
117
    def get_bytes_as(self, storage_kind):
 
118
        if storage_kind == 'fulltext':
 
119
            return self._weave.get_text(self.key[-1])
 
120
        elif storage_kind == 'chunked':
 
121
            return self._weave.get_lines(self.key[-1])
 
122
        else:
 
123
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
 
124
 
 
125
 
 
126
class Weave(VersionedFile):
102
127
    """weave - versioned text file storage.
103
 
    
 
128
 
104
129
    A Weave manages versions of line-based text files, keeping track
105
130
    of the originating version for each line.
106
131
 
113
138
 
114
139
    * a nonnegative index number.
115
140
 
116
 
    * a version-id string. (not implemented yet)
 
141
    * a version-id string.
117
142
 
118
143
    Typically the index number will be valid only inside this weave and
119
144
    the version-id is used to reference it in the larger world.
152
177
 
153
178
    * It doesn't seem very useful to have an active insertion
154
179
      inside an inactive insertion, but it might happen.
155
 
      
 
180
 
156
181
    * Therefore, all instructions are always"considered"; that
157
182
      is passed onto and off the stack.  An outer inactive block
158
183
      doesn't disable an inner block.
188
213
    """
189
214
 
190
215
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
191
 
                 '_weave_name']
192
 
    
193
 
    def __init__(self, weave_name=None):
 
216
                 '_weave_name', '_matcher', '_allow_reserved']
 
217
 
 
218
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
 
219
                 get_scope=None, allow_reserved=False):
 
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__()
194
227
        self._weave = []
195
228
        self._parents = []
196
229
        self._sha1s = []
197
230
        self._names = []
198
231
        self._name_map = {}
199
232
        self._weave_name = weave_name
200
 
 
 
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
        self._allow_reserved = allow_reserved
 
243
 
 
244
    def __repr__(self):
 
245
        return "Weave(%r)" % self._weave_name
 
246
 
 
247
    def _check_write_ok(self):
 
248
        """Is the versioned file marked as 'finished' ? Raise if it is."""
 
249
        if self._get_scope() != self._scope:
 
250
            raise errors.OutSideTransaction()
 
251
        if self._access_mode != 'w':
 
252
            raise errors.ReadOnlyObjectDirtiedError(self)
 
253
 
 
254
    def copy(self):
 
255
        """Return a deep copy of self.
 
256
 
 
257
        The copy can be modified without affecting the original weave."""
 
258
        other = Weave()
 
259
        other._weave = self._weave[:]
 
260
        other._parents = self._parents[:]
 
261
        other._sha1s = self._sha1s[:]
 
262
        other._names = self._names[:]
 
263
        other._name_map = self._name_map.copy()
 
264
        other._weave_name = self._weave_name
 
265
        return other
201
266
 
202
267
    def __eq__(self, other):
203
268
        if not isinstance(other, Weave):
204
269
            return False
205
270
        return self._parents == other._parents \
206
271
               and self._weave == other._weave \
207
 
               and self._sha1s == other._sha1s 
 
272
               and self._sha1s == other._sha1s
208
273
 
209
 
    
210
274
    def __ne__(self, other):
211
275
        return not self.__eq__(other)
212
276
 
 
277
    def _idx_to_name(self, version):
 
278
        return self._names[version]
213
279
 
214
 
    def lookup(self, name):
 
280
    def _lookup(self, name):
 
281
        """Convert symbolic version name to index."""
 
282
        if not self._allow_reserved:
 
283
            self.check_not_reserved_id(name)
215
284
        try:
216
285
            return self._name_map[name]
217
286
        except KeyError:
218
 
            raise WeaveError("name %s not present in weave %s" %
219
 
                             (name, self._weave_name))
220
 
 
221
 
        
222
 
    def add(self, name, parents, text):
 
287
            raise RevisionNotPresent(name, self._weave_name)
 
288
 
 
289
    def versions(self):
 
290
        """See VersionedFile.versions."""
 
291
        return self._names[:]
 
292
 
 
293
    def has_version(self, version_id):
 
294
        """See VersionedFile.has_version."""
 
295
        return (version_id in self._name_map)
 
296
 
 
297
    __contains__ = has_version
 
298
 
 
299
    def get_record_stream(self, versions, ordering, include_delta_closure):
 
300
        """Get a stream of records for versions.
 
301
 
 
302
        :param versions: The versions to include. Each version is a tuple
 
303
            (version,).
 
304
        :param ordering: Either 'unordered' or 'topological'. A topologically
 
305
            sorted stream has compression parents strictly before their
 
306
            children.
 
307
        :param include_delta_closure: If True then the closure across any
 
308
            compression parents will be included (in the opaque data).
 
309
        :return: An iterator of ContentFactory objects, each of which is only
 
310
            valid until the iterator is advanced.
 
311
        """
 
312
        versions = [version[-1] for version in versions]
 
313
        if ordering == 'topological':
 
314
            parents = self.get_parent_map(versions)
 
315
            new_versions = tsort.topo_sort(parents)
 
316
            new_versions.extend(set(versions).difference(set(parents)))
 
317
            versions = new_versions
 
318
        elif ordering == 'groupcompress':
 
319
            parents = self.get_parent_map(versions)
 
320
            new_versions = sort_groupcompress(parents)
 
321
            new_versions.extend(set(versions).difference(set(parents)))
 
322
            versions = new_versions
 
323
        for version in versions:
 
324
            if version in self:
 
325
                yield WeaveContentFactory(version, self)
 
326
            else:
 
327
                yield AbsentContentFactory((version,))
 
328
 
 
329
    def get_parent_map(self, version_ids):
 
330
        """See VersionedFile.get_parent_map."""
 
331
        result = {}
 
332
        for version_id in version_ids:
 
333
            if version_id == NULL_REVISION:
 
334
                parents = ()
 
335
            else:
 
336
                try:
 
337
                    parents = tuple(
 
338
                        map(self._idx_to_name,
 
339
                            self._parents[self._lookup(version_id)]))
 
340
                except RevisionNotPresent:
 
341
                    continue
 
342
            result[version_id] = parents
 
343
        return result
 
344
 
 
345
    def get_parents_with_ghosts(self, version_id):
 
346
        raise NotImplementedError(self.get_parents_with_ghosts)
 
347
 
 
348
    def insert_record_stream(self, stream):
 
349
        """Insert a record stream into this versioned file.
 
350
 
 
351
        :param stream: A stream of records to insert.
 
352
        :return: None
 
353
        :seealso VersionedFile.get_record_stream:
 
354
        """
 
355
        adapters = {}
 
356
        for record in stream:
 
357
            # Raise an error when a record is missing.
 
358
            if record.storage_kind == 'absent':
 
359
                raise RevisionNotPresent([record.key[0]], self)
 
360
            # adapt to non-tuple interface
 
361
            parents = [parent[0] for parent in record.parents]
 
362
            if (record.storage_kind == 'fulltext'
 
363
                or record.storage_kind == 'chunked'):
 
364
                self.add_lines(record.key[0], parents,
 
365
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
 
366
            else:
 
367
                adapter_key = record.storage_kind, 'fulltext'
 
368
                try:
 
369
                    adapter = adapters[adapter_key]
 
370
                except KeyError:
 
371
                    adapter_factory = adapter_registry.get(adapter_key)
 
372
                    adapter = adapter_factory(self)
 
373
                    adapters[adapter_key] = adapter
 
374
                lines = split_lines(adapter.get_bytes(record))
 
375
                try:
 
376
                    self.add_lines(record.key[0], parents, lines)
 
377
                except RevisionAlreadyPresent:
 
378
                    pass
 
379
 
 
380
    def _check_repeated_add(self, name, parents, text, sha1):
 
381
        """Check that a duplicated add is OK.
 
382
 
 
383
        If it is, return the (old) index; otherwise raise an exception.
 
384
        """
 
385
        idx = self._lookup(name)
 
386
        if sorted(self._parents[idx]) != sorted(parents) \
 
387
            or sha1 != self._sha1s[idx]:
 
388
            raise RevisionAlreadyPresent(name, self._weave_name)
 
389
        return idx
 
390
 
 
391
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
392
       left_matching_blocks, nostore_sha, random_id, check_content):
 
393
        """See VersionedFile.add_lines."""
 
394
        idx = self._add(version_id, lines, map(self._lookup, parents),
 
395
            nostore_sha=nostore_sha)
 
396
        return sha_strings(lines), sum(map(len, lines)), idx
 
397
 
 
398
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
223
399
        """Add a single text on top of the weave.
224
 
  
 
400
 
225
401
        Returns the index number of the newly added version.
226
402
 
227
 
        name
 
403
        version_id
228
404
            Symbolic name for this version.
229
405
            (Typically the revision-id of the revision that added it.)
 
406
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
230
407
 
231
408
        parents
232
409
            List or set of direct parent version numbers.
233
 
            
234
 
        text
235
 
            Sequence of lines to be added in the new version."""
236
 
 
237
 
        assert isinstance(name, basestring)
238
 
        if name in self._name_map:
239
 
            raise WeaveError("name %r already present in weave" % name)
240
 
        
 
410
 
 
411
        lines
 
412
            Sequence of lines to be added in the new version.
 
413
 
 
414
        :param nostore_sha: See VersionedFile.add_lines.
 
415
        """
 
416
        self._check_lines_not_unicode(lines)
 
417
        self._check_lines_are_lines(lines)
 
418
        if not sha1:
 
419
            sha1 = sha_strings(lines)
 
420
        if sha1 == nostore_sha:
 
421
            raise errors.ExistingContent
 
422
        if version_id is None:
 
423
            version_id = "sha1:" + sha1
 
424
        if version_id in self._name_map:
 
425
            return self._check_repeated_add(version_id, parents, lines, sha1)
 
426
 
241
427
        self._check_versions(parents)
242
 
        ## self._check_lines(text)
 
428
        ## self._check_lines(lines)
243
429
        new_version = len(self._parents)
244
430
 
245
 
        s = sha.new()
246
 
        map(s.update, text)
247
 
        sha1 = s.hexdigest()
248
 
        del s
249
 
 
250
431
        # if we abort after here the (in-memory) weave will be corrupt because only
251
432
        # some fields are updated
 
433
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
434
        #      - Robert Collins 20060226
252
435
        self._parents.append(parents[:])
253
436
        self._sha1s.append(sha1)
254
 
        self._names.append(name)
255
 
        self._name_map[name] = new_version
256
 
 
257
 
            
 
437
        self._names.append(version_id)
 
438
        self._name_map[version_id] = new_version
 
439
 
 
440
 
258
441
        if not parents:
259
442
            # special case; adding with no parents revision; can do
260
443
            # this more quickly by just appending unconditionally.
261
444
            # even more specially, if we're adding an empty text we
262
445
            # need do nothing at all.
263
 
            if text:
 
446
            if lines:
264
447
                self._weave.append(('{', new_version))
265
 
                self._weave.extend(text)
 
448
                self._weave.extend(lines)
266
449
                self._weave.append(('}', None))
267
 
        
268
450
            return new_version
269
451
 
270
452
        if len(parents) == 1:
272
454
            if sha1 == self._sha1s[pv]:
273
455
                # special case: same as the single parent
274
456
                return new_version
275
 
            
276
 
 
277
 
        ancestors = self.inclusions(parents)
 
457
 
 
458
 
 
459
        ancestors = self._inclusions(parents)
278
460
 
279
461
        l = self._weave
280
462
 
287
469
 
288
470
        # another small special case: a merge, producing the same text
289
471
        # as auto-merge
290
 
        if text == basis_lines:
291
 
            return new_version            
 
472
        if lines == basis_lines:
 
473
            return new_version
292
474
 
293
 
        # add a sentinal, because we can also match against the final line
 
475
        # add a sentinel, because we can also match against the final line
294
476
        basis_lineno.append(len(self._weave))
295
477
 
296
478
        # XXX: which line of the weave should we really consider
300
482
        #print 'basis_lines:', basis_lines
301
483
        #print 'new_lines:  ', lines
302
484
 
303
 
        from difflib import SequenceMatcher
304
 
        s = SequenceMatcher(None, basis_lines, text)
 
485
        s = self._matcher(None, basis_lines, lines)
305
486
 
306
487
        # offset gives the number of lines that have been inserted
307
488
        # into the weave up to the current point; if the original edit instruction
314
495
            #print 'raw match', tag, i1, i2, j1, j2
315
496
            if tag == 'equal':
316
497
                continue
317
 
 
318
498
            i1 = basis_lineno[i1]
319
499
            i2 = basis_lineno[i2]
320
 
 
321
 
            assert 0 <= j1 <= j2 <= len(text)
322
 
 
323
 
            #print tag, i1, i2, j1, j2
324
 
 
325
500
            # the deletion and insertion are handled separately.
326
501
            # first delete the region.
327
502
            if i1 != i2:
334
509
                # i2; we want to insert after this region to make sure
335
510
                # we don't destroy ourselves
336
511
                i = i2 + offset
337
 
                self._weave[i:i] = ([('{', new_version)] 
338
 
                                    + text[j1:j2] 
 
512
                self._weave[i:i] = ([('{', new_version)]
 
513
                                    + lines[j1:j2]
339
514
                                    + [('}', None)])
340
515
                offset += 2 + (j2 - j1)
341
 
 
342
516
        return new_version
343
517
 
344
 
 
345
 
    def inclusions(self, versions):
 
518
    def _inclusions(self, versions):
346
519
        """Return set of all ancestors of given version(s)."""
 
520
        if not len(versions):
 
521
            return []
347
522
        i = set(versions)
348
 
        v = max(versions)
349
 
        try:
350
 
            while v >= 0:
351
 
                if v in i:
352
 
                    # include all its parents
353
 
                    i.update(self._parents[v])
354
 
                v -= 1
355
 
            return i
356
 
        except IndexError:
357
 
            raise ValueError("version %d not present in weave" % v)
358
 
 
359
 
 
360
 
    def minimal_parents(self, version):
361
 
        """Find the minimal set of parents for the version."""
362
 
        included = self._parents[version]
363
 
        if not included:
364
 
            return []
365
 
        
366
 
        li = list(included)
367
 
        li.sort(reverse=True)
368
 
 
369
 
        mininc = []
370
 
        gotit = set()
371
 
 
372
 
        for pv in li:
373
 
            if pv not in gotit:
374
 
                mininc.append(pv)
375
 
                gotit.update(self.inclusions(pv))
376
 
 
377
 
        assert mininc[0] >= 0
378
 
        assert mininc[-1] < version
379
 
        return mininc
380
 
 
381
 
 
 
523
        for v in xrange(max(versions), 0, -1):
 
524
            if v in i:
 
525
                # include all its parents
 
526
                i.update(self._parents[v])
 
527
        return i
 
528
        ## except IndexError:
 
529
        ##     raise ValueError("version %d not present in weave" % v)
 
530
 
 
531
    def get_ancestry(self, version_ids, topo_sorted=True):
 
532
        """See VersionedFile.get_ancestry."""
 
533
        if isinstance(version_ids, basestring):
 
534
            version_ids = [version_ids]
 
535
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
536
        return [self._idx_to_name(v) for v in i]
382
537
 
383
538
    def _check_lines(self, text):
384
539
        if not isinstance(text, list):
388
543
            if not isinstance(l, basestring):
389
544
                raise ValueError("text line should be a string or unicode, not %s"
390
545
                                 % type(l))
391
 
        
 
546
 
392
547
 
393
548
 
394
549
    def _check_versions(self, indexes):
399
554
            except IndexError:
400
555
                raise IndexError("invalid version number %r" % i)
401
556
 
402
 
    
403
 
    def annotate(self, index):
404
 
        return list(self.annotate_iter(index))
405
 
 
406
 
 
407
 
    def annotate_iter(self, version):
408
 
        """Yield list of (index-id, line) pairs for the specified version.
 
557
    def _compatible_parents(self, my_parents, other_parents):
 
558
        """During join check that other_parents are joinable with my_parents.
 
559
 
 
560
        Joinable is defined as 'is a subset of' - supersets may require
 
561
        regeneration of diffs, but subsets do not.
 
562
        """
 
563
        return len(other_parents.difference(my_parents)) == 0
 
564
 
 
565
    def annotate(self, version_id):
 
566
        """Return a list of (version-id, line) tuples for version_id.
409
567
 
410
568
        The index indicates when the line originated in the weave."""
411
 
        for origin, lineno, text in self._extract([version]):
412
 
            yield origin, text
413
 
 
414
 
 
415
 
    def _walk(self):
416
 
        """Walk the weave.
417
 
 
418
 
        Yields sequence of
419
 
        (lineno, insert, deletes, text)
420
 
        for each literal line.
421
 
        """
422
 
        
 
569
        incls = [self._lookup(version_id)]
 
570
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
571
            self._extract(incls)]
 
572
 
 
573
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
574
                                                pb=None):
 
575
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
576
        if version_ids is None:
 
577
            version_ids = self.versions()
 
578
        version_ids = set(version_ids)
 
579
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
580
            if inserted not in version_ids: continue
 
581
            if line[-1] != '\n':
 
582
                yield line + '\n', inserted
 
583
            else:
 
584
                yield line, inserted
 
585
 
 
586
    def _walk_internal(self, version_ids=None):
 
587
        """Helper method for weave actions."""
 
588
 
423
589
        istack = []
424
590
        dset = set()
425
591
 
426
592
        lineno = 0         # line of weave, 0-based
427
593
 
428
594
        for l in self._weave:
429
 
            if isinstance(l, tuple):
 
595
            if l.__class__ == tuple:
430
596
                c, v = l
431
597
                isactive = None
432
598
                if c == '{':
433
 
                    istack.append(v)
 
599
                    istack.append(self._names[v])
434
600
                elif c == '}':
435
601
                    istack.pop()
436
602
                elif c == '[':
437
 
                    assert v not in dset
438
 
                    dset.add(v)
 
603
                    dset.add(self._names[v])
439
604
                elif c == ']':
440
 
                    dset.remove(v)
 
605
                    dset.remove(self._names[v])
441
606
                else:
442
 
                    raise WeaveFormatError('unexpected instruction %r'
443
 
                                           % v)
 
607
                    raise WeaveFormatError('unexpected instruction %r' % v)
444
608
            else:
445
 
                assert isinstance(l, basestring)
446
 
                assert istack
447
 
                yield lineno, istack[-1], dset, l
 
609
                yield lineno, istack[-1], frozenset(dset), l
448
610
            lineno += 1
449
611
 
450
 
 
 
612
        if istack:
 
613
            raise WeaveFormatError("unclosed insertion blocks "
 
614
                    "at end of weave: %s" % istack)
 
615
        if dset:
 
616
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
617
                                   % dset)
 
618
 
 
619
    def plan_merge(self, ver_a, ver_b):
 
620
        """Return pseudo-annotation indicating how the two versions merge.
 
621
 
 
622
        This is computed between versions a and b and their common
 
623
        base.
 
624
 
 
625
        Weave lines present in none of them are skipped entirely.
 
626
        """
 
627
        inc_a = set(self.get_ancestry([ver_a]))
 
628
        inc_b = set(self.get_ancestry([ver_b]))
 
629
        inc_c = inc_a & inc_b
 
630
 
 
631
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
632
            if deleteset & inc_c:
 
633
                # killed in parent; can't be in either a or b
 
634
                # not relevant to our work
 
635
                yield 'killed-base', line
 
636
            elif insert in inc_c:
 
637
                # was inserted in base
 
638
                killed_a = bool(deleteset & inc_a)
 
639
                killed_b = bool(deleteset & inc_b)
 
640
                if killed_a and killed_b:
 
641
                    yield 'killed-both', line
 
642
                elif killed_a:
 
643
                    yield 'killed-a', line
 
644
                elif killed_b:
 
645
                    yield 'killed-b', line
 
646
                else:
 
647
                    yield 'unchanged', line
 
648
            elif insert in inc_a:
 
649
                if deleteset & inc_a:
 
650
                    yield 'ghost-a', line
 
651
                else:
 
652
                    # new in A; not in B
 
653
                    yield 'new-a', line
 
654
            elif insert in inc_b:
 
655
                if deleteset & inc_b:
 
656
                    yield 'ghost-b', line
 
657
                else:
 
658
                    yield 'new-b', line
 
659
            else:
 
660
                # not in either revision
 
661
                yield 'irrelevant', line
451
662
 
452
663
    def _extract(self, versions):
453
664
        """Yield annotation of lines in included set.
461
672
        for i in versions:
462
673
            if not isinstance(i, int):
463
674
                raise ValueError(i)
464
 
            
465
 
        included = self.inclusions(versions)
 
675
 
 
676
        included = self._inclusions(versions)
466
677
 
467
678
        istack = []
 
679
        iset = set()
468
680
        dset = set()
469
681
 
470
682
        lineno = 0         # line of weave, 0-based
475
687
 
476
688
        WFE = WeaveFormatError
477
689
 
 
690
        # wow.
 
691
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
692
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
693
        # 1.6 seconds in 'isinstance'.
 
694
        # changing the first isinstance:
 
695
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
696
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
697
        # note that the inline time actually dropped (less function calls)
 
698
        # and total processing time was halved.
 
699
        # we're still spending ~1/4 of the method in isinstance though.
 
700
        # so lets hard code the acceptable string classes we expect:
 
701
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
702
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
703
        #                                          objects>
 
704
        # yay, down to ~1/4 the initial extract time, and our inline time
 
705
        # has shrunk again, with isinstance no longer dominating.
 
706
        # tweaking the stack inclusion test to use a set gives:
 
707
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
708
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
709
        #                                          objects>
 
710
        # - a 5% win, or possibly just noise. However with large istacks that
 
711
        # 'in' test could dominate, so I'm leaving this change in place -
 
712
        # when its fast enough to consider profiling big datasets we can review.
 
713
 
 
714
 
 
715
 
 
716
 
478
717
        for l in self._weave:
479
 
            if isinstance(l, tuple):
 
718
            if l.__class__ == tuple:
480
719
                c, v = l
481
720
                isactive = None
482
721
                if c == '{':
483
 
                    assert v not in istack
484
722
                    istack.append(v)
 
723
                    iset.add(v)
485
724
                elif c == '}':
486
 
                    istack.pop()
 
725
                    iset.remove(istack.pop())
487
726
                elif c == '[':
488
727
                    if v in included:
489
 
                        assert v not in dset
490
728
                        dset.add(v)
491
 
                else:
492
 
                    assert c == ']'
 
729
                elif c == ']':
493
730
                    if v in included:
494
 
                        assert v in dset
495
731
                        dset.remove(v)
 
732
                else:
 
733
                    raise AssertionError()
496
734
            else:
497
 
                assert isinstance(l, basestring)
498
735
                if isactive is None:
499
736
                    isactive = (not dset) and istack and (istack[-1] in included)
500
737
                if isactive:
501
738
                    result.append((istack[-1], lineno, l))
502
739
            lineno += 1
503
 
 
504
740
        if istack:
505
 
            raise WFE("unclosed insertion blocks at end of weave",
506
 
                                   istack)
 
741
            raise WeaveFormatError("unclosed insertion blocks "
 
742
                    "at end of weave: %s" % istack)
507
743
        if dset:
508
 
            raise WFE("unclosed deletion blocks at end of weave",
509
 
                                   dset)
510
 
 
511
 
        return result
512
 
    
513
 
 
514
 
 
515
 
    def get_iter(self, version):
516
 
        """Yield lines for the specified version."""
517
 
        for origin, lineno, line in self._extract([version]):
518
 
            yield line
519
 
 
520
 
 
521
 
    def get_text(self, version):
522
 
        assert isinstance(version, int)
523
 
        s = StringIO()
524
 
        s.writelines(self.get_iter(version))
525
 
        return s.getvalue()
526
 
 
527
 
 
528
 
    def get(self, index):
529
 
        return list(self.get_iter(index))
530
 
 
531
 
 
532
 
    def mash_iter(self, included):
533
 
        """Return composed version of multiple included versions."""
534
 
        for origin, lineno, text in self._extract(included):
535
 
            yield text
536
 
 
537
 
 
538
 
    def dump(self, to_file):
539
 
        from pprint import pprint
540
 
        print >>to_file, "Weave._weave = ",
541
 
        pprint(self._weave, to_file)
542
 
        print >>to_file, "Weave._parents = ",
543
 
        pprint(self._parents, to_file)
544
 
 
545
 
 
546
 
 
547
 
    def numversions(self):
 
744
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
745
                                   % dset)
 
746
        return result
 
747
 
 
748
    def _maybe_lookup(self, name_or_index):
 
749
        """Convert possible symbolic name to index, or pass through indexes.
 
750
 
 
751
        NOT FOR PUBLIC USE.
 
752
        """
 
753
        if isinstance(name_or_index, (int, long)):
 
754
            return name_or_index
 
755
        else:
 
756
            return self._lookup(name_or_index)
 
757
 
 
758
    def get_lines(self, version_id):
 
759
        """See VersionedFile.get_lines()."""
 
760
        int_index = self._maybe_lookup(version_id)
 
761
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
762
        expected_sha1 = self._sha1s[int_index]
 
763
        measured_sha1 = sha_strings(result)
 
764
        if measured_sha1 != expected_sha1:
 
765
            raise errors.WeaveInvalidChecksum(
 
766
                    'file %s, revision %s, expected: %s, measured %s'
 
767
                    % (self._weave_name, version_id,
 
768
                       expected_sha1, measured_sha1))
 
769
        return result
 
770
 
 
771
    def get_sha1s(self, version_ids):
 
772
        """See VersionedFile.get_sha1s()."""
 
773
        result = {}
 
774
        for v in version_ids:
 
775
            result[v] = self._sha1s[self._lookup(v)]
 
776
        return result
 
777
 
 
778
    def num_versions(self):
 
779
        """How many versions are in this weave?"""
548
780
        l = len(self._parents)
549
 
        assert l == len(self._sha1s)
550
781
        return l
551
782
 
552
 
 
553
 
    def __len__(self):
554
 
        return self.numversions()
555
 
 
 
783
    __len__ = num_versions
556
784
 
557
785
    def check(self, progress_bar=None):
558
 
        # check no circular inclusions
559
 
        for version in range(self.numversions()):
 
786
        # TODO evaluate performance hit of using string sets in this routine.
 
787
        # TODO: check no circular inclusions
 
788
        # TODO: create a nested progress bar
 
789
        for version in range(self.num_versions()):
560
790
            inclusions = list(self._parents[version])
561
791
            if inclusions:
562
792
                inclusions.sort()
564
794
                    raise WeaveFormatError("invalid included version %d for index %d"
565
795
                                           % (inclusions[-1], version))
566
796
 
567
 
        # try extracting all versions; this is a bit slow and parallel
568
 
        # extraction could be used
569
 
        nv = self.numversions()
570
 
        for version in range(nv):
 
797
        # try extracting all versions; parallel extraction is used
 
798
        nv = self.num_versions()
 
799
        sha1s = {}
 
800
        texts = {}
 
801
        inclusions = {}
 
802
        for i in range(nv):
 
803
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
804
            # The problem is that set membership is much more expensive
 
805
            name = self._idx_to_name(i)
 
806
            sha1s[name] = sha()
 
807
            texts[name] = []
 
808
            new_inc = set([name])
 
809
            for p in self._parents[i]:
 
810
                new_inc.update(inclusions[self._idx_to_name(p)])
 
811
 
 
812
            if set(new_inc) != set(self.get_ancestry(name)):
 
813
                raise AssertionError(
 
814
                    'failed %s != %s'
 
815
                    % (set(new_inc), set(self.get_ancestry(name))))
 
816
            inclusions[name] = new_inc
 
817
 
 
818
        nlines = len(self._weave)
 
819
 
 
820
        update_text = 'checking weave'
 
821
        if self._weave_name:
 
822
            short_name = os.path.basename(self._weave_name)
 
823
            update_text = 'checking %s' % (short_name,)
 
824
            update_text = update_text[:25]
 
825
 
 
826
        for lineno, insert, deleteset, line in self._walk_internal():
571
827
            if progress_bar:
572
 
                progress_bar.update('checking text', version, nv)
573
 
            s = sha.new()
574
 
            for l in self.get_iter(version):
575
 
                s.update(l)
576
 
            hd = s.hexdigest()
577
 
            expected = self._sha1s[version]
 
828
                progress_bar.update(update_text, lineno, nlines)
 
829
 
 
830
            for name, name_inclusions in inclusions.items():
 
831
                # The active inclusion must be an ancestor,
 
832
                # and no ancestors must have deleted this line,
 
833
                # because we don't support resurrection.
 
834
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
835
                    sha1s[name].update(line)
 
836
 
 
837
        for i in range(nv):
 
838
            version = self._idx_to_name(i)
 
839
            hd = sha1s[version].hexdigest()
 
840
            expected = self._sha1s[i]
578
841
            if hd != expected:
579
 
                raise WeaveError("mismatched sha1 for version %d; "
580
 
                                 "got %s, expected %s"
581
 
                                 % (version, hd, expected))
 
842
                raise errors.WeaveInvalidChecksum(
 
843
                        "mismatched sha1 for version %s: "
 
844
                        "got %s, expected %s"
 
845
                        % (version, hd, expected))
582
846
 
583
847
        # TODO: check insertions are properly nested, that there are
584
848
        # no lines outside of insertion blocks, that deletions are
585
849
        # properly paired, etc.
586
850
 
587
 
 
588
 
 
589
 
    def merge(self, merge_versions):
590
 
        """Automerge and mark conflicts between versions.
591
 
 
592
 
        This returns a sequence, each entry describing alternatives
593
 
        for a chunk of the file.  Each of the alternatives is given as
594
 
        a list of lines.
595
 
 
596
 
        If there is a chunk of the file where there's no diagreement,
597
 
        only one alternative is given.
598
 
        """
599
 
 
600
 
        # approach: find the included versions common to all the
601
 
        # merged versions
602
 
        raise NotImplementedError()
603
 
 
604
 
 
605
 
 
606
 
    def _delta(self, included, lines):
607
 
        """Return changes from basis to new revision.
608
 
 
609
 
        The old text for comparison is the union of included revisions.
610
 
 
611
 
        This is used in inserting a new text.
612
 
 
613
 
        Delta is returned as a sequence of
614
 
        (weave1, weave2, newlines).
615
 
 
616
 
        This indicates that weave1:weave2 of the old weave should be
617
 
        replaced by the sequence of lines in newlines.  Note that
618
 
        these line numbers are positions in the total weave and don't
619
 
        correspond to the lines in any extracted version, or even the
620
 
        extracted union of included versions.
621
 
 
622
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
623
 
        pure delete.  (Similar to difflib.)
624
 
        """
625
 
 
626
 
 
627
 
            
628
 
    def plan_merge(self, ver_a, ver_b):
629
 
        """Return pseudo-annotation indicating how the two versions merge.
630
 
 
631
 
        This is computed between versions a and b and their common
632
 
        base.
633
 
 
634
 
        Weave lines present in none of them are skipped entirely.
635
 
        """
636
 
        inc_a = self.inclusions([ver_a])
637
 
        inc_b = self.inclusions([ver_b])
638
 
        inc_c = inc_a & inc_b
639
 
 
640
 
        for lineno, insert, deleteset, line in self._walk():
641
 
            if deleteset & inc_c:
642
 
                # killed in parent; can't be in either a or b
643
 
                # not relevant to our work
644
 
                yield 'killed-base', line
645
 
            elif insert in inc_c:
646
 
                # was inserted in base
647
 
                killed_a = bool(deleteset & inc_a)
648
 
                killed_b = bool(deleteset & inc_b)
649
 
                if killed_a and killed_b:
650
 
                    yield 'killed-both', line
651
 
                elif killed_a:
652
 
                    yield 'killed-a', line
653
 
                elif killed_b:
654
 
                    yield 'killed-b', line
655
 
                else:
656
 
                    yield 'unchanged', line
657
 
            elif insert in inc_a:
658
 
                if deleteset & inc_a:
659
 
                    yield 'ghost-a', line
660
 
                else:
661
 
                    # new in A; not in B
662
 
                    yield 'new-a', line
663
 
            elif insert in inc_b:
664
 
                if deleteset & inc_b:
665
 
                    yield 'ghost-b', line
666
 
                else:
667
 
                    yield 'new-b', line
668
 
            else:
669
 
                # not in either revision
670
 
                yield 'irrelevant', line
671
 
 
672
 
        yield 'unchanged', ''           # terminator
673
 
 
674
 
 
675
 
 
676
 
    def weave_merge(self, plan):
677
 
        lines_a = []
678
 
        lines_b = []
679
 
        ch_a = ch_b = False
680
 
 
681
 
        for state, line in plan:
682
 
            if state == 'unchanged' or state == 'killed-both':
683
 
                # resync and flush queued conflicts changes if any
684
 
                if not lines_a and not lines_b:
685
 
                    pass
686
 
                elif ch_a and not ch_b:
687
 
                    # one-sided change:                    
688
 
                    for l in lines_a: yield l
689
 
                elif ch_b and not ch_a:
690
 
                    for l in lines_b: yield l
691
 
                elif lines_a == lines_b:
692
 
                    for l in lines_a: yield l
693
 
                else:
694
 
                    yield '<<<<\n'
695
 
                    for l in lines_a: yield l
696
 
                    yield '====\n'
697
 
                    for l in lines_b: yield l
698
 
                    yield '>>>>\n'
699
 
 
700
 
                del lines_a[:]
701
 
                del lines_b[:]
702
 
                ch_a = ch_b = False
703
 
                
704
 
            if state == 'unchanged':
705
 
                if line:
706
 
                    yield line
707
 
            elif state == 'killed-a':
708
 
                ch_a = True
709
 
                lines_b.append(line)
710
 
            elif state == 'killed-b':
711
 
                ch_b = True
712
 
                lines_a.append(line)
713
 
            elif state == 'new-a':
714
 
                ch_a = True
715
 
                lines_a.append(line)
716
 
            elif state == 'new-b':
717
 
                ch_b = True
718
 
                lines_b.append(line)
719
 
            else:
720
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
721
 
                                 'killed-both'), \
722
 
                       state
723
 
 
724
 
                
725
 
 
726
 
 
727
 
 
728
 
 
729
 
 
730
 
def weave_toc(w):
731
 
    """Show the weave's table-of-contents"""
732
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
733
 
    for i in (6, 50, 10, 10):
734
 
        print '-' * i,
735
 
    print
736
 
    for i in range(w.numversions()):
737
 
        sha1 = w._sha1s[i]
738
 
        name = w._names[i]
739
 
        parent_str = ' '.join(map(str, w._parents[i]))
740
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
741
 
 
742
 
 
743
 
 
744
 
def weave_stats(weave_file):
745
 
    from bzrlib.progress import ProgressBar
746
 
    from bzrlib.weavefile import read_weave
747
 
 
748
 
    pb = ProgressBar()
749
 
 
750
 
    wf = file(weave_file, 'rb')
751
 
    w = read_weave(wf)
752
 
    # FIXME: doesn't work on pipes
753
 
    weave_size = wf.tell()
754
 
 
755
 
    total = 0
756
 
    vers = len(w)
757
 
    for i in range(vers):
758
 
        pb.update('checking sizes', i, vers)
759
 
        for line in w.get_iter(i):
760
 
            total += len(line)
761
 
 
762
 
    pb.clear()
763
 
 
764
 
    print 'versions          %9d' % vers
765
 
    print 'weave file        %9d bytes' % weave_size
766
 
    print 'total contents    %9d bytes' % total
767
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
768
 
    if vers:
769
 
        avg = total/vers
770
 
        print 'average size      %9d bytes' % avg
771
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
772
 
 
773
 
 
774
 
def usage():
775
 
    print """bzr weave tool
776
 
 
777
 
Experimental tool for weave algorithm.
778
 
 
779
 
usage:
780
 
    weave init WEAVEFILE
781
 
        Create an empty weave file
782
 
    weave get WEAVEFILE VERSION
783
 
        Write out specified version.
784
 
    weave check WEAVEFILE
785
 
        Check consistency of all versions.
786
 
    weave toc WEAVEFILE
787
 
        Display table of contents.
788
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
789
 
        Add NEWTEXT, with specified parent versions.
790
 
    weave annotate WEAVEFILE VERSION
791
 
        Display origin of each line.
792
 
    weave mash WEAVEFILE VERSION...
793
 
        Display composite of all selected versions.
794
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
795
 
        Auto-merge two versions and display conflicts.
796
 
 
797
 
example:
798
 
 
799
 
    % weave init foo.weave
800
 
    % vi foo.txt
801
 
    % weave add foo.weave ver0 < foo.txt
802
 
    added version 0
803
 
 
804
 
    (create updated version)
805
 
    % vi foo.txt
806
 
    % weave get foo.weave 0 | diff -u - foo.txt
807
 
    % weave add foo.weave ver1 0 < foo.txt
808
 
    added version 1
809
 
 
810
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
811
 
    % vi foo.txt
812
 
    % weave add foo.weave ver2 0 < foo.txt
813
 
    added version 2
814
 
 
815
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
816
 
    % vi foo.txt                            (resolve conflicts)
817
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
818
 
    
819
 
"""
820
 
    
821
 
 
822
 
 
823
 
def main(argv):
824
 
    import sys
825
 
    import os
826
 
    from weavefile import write_weave, read_weave
827
 
    from bzrlib.progress import ProgressBar
828
 
 
829
 
    try:
830
 
        import psyco
831
 
        psyco.full()
832
 
    except ImportError:
833
 
        pass
834
 
 
835
 
    if len(argv) < 2:
836
 
        usage()
837
 
        return 0
838
 
 
839
 
    cmd = argv[1]
840
 
 
841
 
    def readit():
842
 
        return read_weave(file(argv[2], 'rb'))
843
 
    
844
 
    if cmd == 'help':
845
 
        usage()
846
 
    elif cmd == 'add':
847
 
        w = readit()
848
 
        # at the moment, based on everything in the file
849
 
        name = argv[3]
850
 
        parents = map(int, argv[4:])
851
 
        lines = sys.stdin.readlines()
852
 
        ver = w.add(name, parents, lines)
853
 
        write_weave(w, file(argv[2], 'wb'))
854
 
        print 'added version %r %d' % (name, ver)
855
 
    elif cmd == 'init':
856
 
        fn = argv[2]
857
 
        if os.path.exists(fn):
858
 
            raise IOError("file exists")
859
 
        w = Weave()
860
 
        write_weave(w, file(fn, 'wb'))
861
 
    elif cmd == 'get': # get one version
862
 
        w = readit()
863
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
864
 
        
865
 
    elif cmd == 'mash': # get composite
866
 
        w = readit()
867
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
868
 
 
869
 
    elif cmd == 'annotate':
870
 
        w = readit()
871
 
        # newline is added to all lines regardless; too hard to get
872
 
        # reasonable formatting otherwise
873
 
        lasto = None
874
 
        for origin, text in w.annotate(int(argv[3])):
875
 
            text = text.rstrip('\r\n')
876
 
            if origin == lasto:
877
 
                print '      | %s' % (text)
878
 
            else:
879
 
                print '%5d | %s' % (origin, text)
880
 
                lasto = origin
881
 
                
882
 
    elif cmd == 'toc':
883
 
        weave_toc(readit())
884
 
 
885
 
    elif cmd == 'stats':
886
 
        weave_stats(argv[2])
887
 
        
888
 
    elif cmd == 'check':
889
 
        w = readit()
890
 
        pb = ProgressBar()
891
 
        w.check(pb)
892
 
        pb.clear()
893
 
        print '%d versions ok' % w.numversions()
894
 
 
895
 
    elif cmd == 'inclusions':
896
 
        w = readit()
897
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
898
 
 
899
 
    elif cmd == 'parents':
900
 
        w = readit()
901
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
902
 
 
903
 
    elif cmd == 'plan-merge':
904
 
        w = readit()
905
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
906
 
            if line:
907
 
                print '%14s | %s' % (state, line),
908
 
 
909
 
    elif cmd == 'merge':
910
 
        w = readit()
911
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
912
 
        sys.stdout.writelines(w.weave_merge(p))
913
 
            
914
 
    elif cmd == 'mash-merge':
915
 
        if len(argv) != 5:
916
 
            usage()
917
 
            return 1
918
 
 
919
 
        w = readit()
920
 
        v1, v2 = map(int, argv[3:5])
921
 
 
922
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
923
 
 
924
 
        base_lines = list(w.mash_iter(basis))
925
 
        a_lines = list(w.get(v1))
926
 
        b_lines = list(w.get(v2))
927
 
 
928
 
        from bzrlib.merge3 import Merge3
929
 
        m3 = Merge3(base_lines, a_lines, b_lines)
930
 
 
931
 
        name_a = 'version %d' % v1
932
 
        name_b = 'version %d' % v2
933
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
934
 
    else:
935
 
        raise ValueError('unknown command %r' % cmd)
936
 
    
937
 
 
938
 
 
939
 
def profile_main(argv): 
940
 
    import tempfile, hotshot, hotshot.stats
941
 
 
942
 
    prof_f = tempfile.NamedTemporaryFile()
943
 
 
944
 
    prof = hotshot.Profile(prof_f.name)
945
 
 
946
 
    ret = prof.runcall(main, argv)
947
 
    prof.close()
948
 
 
949
 
    stats = hotshot.stats.load(prof_f.name)
950
 
    #stats.strip_dirs()
951
 
    stats.sort_stats('cumulative')
952
 
    ## XXX: Might like to write to stderr or the trace file instead but
953
 
    ## print_stats seems hardcoded to stdout
954
 
    stats.print_stats(20)
955
 
            
956
 
    return ret
957
 
 
958
 
 
959
 
if __name__ == '__main__':
960
 
    import sys
961
 
    if '--profile' in sys.argv:
962
 
        args = sys.argv[:]
963
 
        args.remove('--profile')
964
 
        sys.exit(profile_main(args))
965
 
    else:
966
 
        sys.exit(main(sys.argv))
967
 
 
 
851
    def _imported_parents(self, other, other_idx):
 
852
        """Return list of parents in self corresponding to indexes in other."""
 
853
        new_parents = []
 
854
        for parent_idx in other._parents[other_idx]:
 
855
            parent_name = other._names[parent_idx]
 
856
            if parent_name not in self._name_map:
 
857
                # should not be possible
 
858
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
859
                                 % (parent_name, other._name_map[other_idx], self))
 
860
            new_parents.append(self._name_map[parent_name])
 
861
        return new_parents
 
862
 
 
863
    def _check_version_consistent(self, other, other_idx, name):
 
864
        """Check if a version in consistent in this and other.
 
865
 
 
866
        To be consistent it must have:
 
867
 
 
868
         * the same text
 
869
         * the same direct parents (by name, not index, and disregarding
 
870
           order)
 
871
 
 
872
        If present & correct return True;
 
873
        if not present in self return False;
 
874
        if inconsistent raise error."""
 
875
        this_idx = self._name_map.get(name, -1)
 
876
        if this_idx != -1:
 
877
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
878
                raise errors.WeaveTextDiffers(name, self, other)
 
879
            self_parents = self._parents[this_idx]
 
880
            other_parents = other._parents[other_idx]
 
881
            n1 = set([self._names[i] for i in self_parents])
 
882
            n2 = set([other._names[i] for i in other_parents])
 
883
            if not self._compatible_parents(n1, n2):
 
884
                raise WeaveParentMismatch("inconsistent parents "
 
885
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
886
            else:
 
887
                return True         # ok!
 
888
        else:
 
889
            return False
 
890
 
 
891
    def _reweave(self, other, pb, msg):
 
892
        """Reweave self with other - internal helper for join().
 
893
 
 
894
        :param other: The other weave to merge
 
895
        :param pb: An optional progress bar, indicating how far done we are
 
896
        :param msg: An optional message for the progress
 
897
        """
 
898
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
899
        self._copy_weave_content(new_weave)
 
900
 
 
901
    def _copy_weave_content(self, otherweave):
 
902
        """adsorb the content from otherweave."""
 
903
        for attr in self.__slots__:
 
904
            if attr != '_weave_name':
 
905
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
906
 
 
907
 
 
908
class WeaveFile(Weave):
 
909
    """A WeaveFile represents a Weave on disk and writes on change."""
 
910
 
 
911
    WEAVE_SUFFIX = '.weave'
 
912
 
 
913
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
914
        """Create a WeaveFile.
 
915
 
 
916
        :param create: If not True, only open an existing knit.
 
917
        """
 
918
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
 
919
            allow_reserved=False)
 
920
        self._transport = transport
 
921
        self._filemode = filemode
 
922
        try:
 
923
            f = self._transport.get(name + WeaveFile.WEAVE_SUFFIX)
 
924
            _read_weave_v5(StringIO(f.read()), self)
 
925
        except errors.NoSuchFile:
 
926
            if not create:
 
927
                raise
 
928
            # new file, save it
 
929
            self._save()
 
930
 
 
931
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
932
        left_matching_blocks, nostore_sha, random_id, check_content):
 
933
        """Add a version and save the weave."""
 
934
        self.check_not_reserved_id(version_id)
 
935
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
936
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
937
            check_content)
 
938
        self._save()
 
939
        return result
 
940
 
 
941
    def copy_to(self, name, transport):
 
942
        """See VersionedFile.copy_to()."""
 
943
        # as we are all in memory always, just serialise to the new place.
 
944
        sio = StringIO()
 
945
        write_weave_v5(self, sio)
 
946
        sio.seek(0)
 
947
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
948
 
 
949
    def _save(self):
 
950
        """Save the weave."""
 
951
        self._check_write_ok()
 
952
        sio = StringIO()
 
953
        write_weave_v5(self, sio)
 
954
        sio.seek(0)
 
955
        bytes = sio.getvalue()
 
956
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
 
957
        try:
 
958
            self._transport.put_bytes(path, bytes, self._filemode)
 
959
        except errors.NoSuchFile:
 
960
            self._transport.mkdir(dirname(path))
 
961
            self._transport.put_bytes(path, bytes, self._filemode)
 
962
 
 
963
    @staticmethod
 
964
    def get_suffixes():
 
965
        """See VersionedFile.get_suffixes()."""
 
966
        return [WeaveFile.WEAVE_SUFFIX]
 
967
 
 
968
    def insert_record_stream(self, stream):
 
969
        super(WeaveFile, self).insert_record_stream(stream)
 
970
        self._save()
 
971
 
 
972
 
 
973
def _reweave(wa, wb, pb=None, msg=None):
 
974
    """Combine two weaves and return the result.
 
975
 
 
976
    This works even if a revision R has different parents in
 
977
    wa and wb.  In the resulting weave all the parents are given.
 
978
 
 
979
    This is done by just building up a new weave, maintaining ordering
 
980
    of the versions in the two inputs.  More efficient approaches
 
981
    might be possible but it should only be necessary to do
 
982
    this operation rarely, when a new previously ghost version is
 
983
    inserted.
 
984
 
 
985
    :param pb: An optional progress bar, indicating how far done we are
 
986
    :param msg: An optional message for the progress
 
987
    """
 
988
    wr = Weave()
 
989
    ia = ib = 0
 
990
    queue_a = range(wa.num_versions())
 
991
    queue_b = range(wb.num_versions())
 
992
    # first determine combined parents of all versions
 
993
    # map from version name -> all parent names
 
994
    combined_parents = _reweave_parent_graphs(wa, wb)
 
995
    mutter("combined parents: %r", combined_parents)
 
996
    order = tsort.topo_sort(combined_parents.iteritems())
 
997
    mutter("order to reweave: %r", order)
 
998
 
 
999
    if pb and not msg:
 
1000
        msg = 'reweave'
 
1001
 
 
1002
    for idx, name in enumerate(order):
 
1003
        if pb:
 
1004
            pb.update(msg, idx, len(order))
 
1005
        if name in wa._name_map:
 
1006
            lines = wa.get_lines(name)
 
1007
            if name in wb._name_map:
 
1008
                lines_b = wb.get_lines(name)
 
1009
                if lines != lines_b:
 
1010
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1011
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1012
                    import difflib
 
1013
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1014
                            wa._weave_name, wb._weave_name))
 
1015
                    mutter('lines:\n%s', ''.join(lines))
 
1016
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1017
        else:
 
1018
            lines = wb.get_lines(name)
 
1019
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1020
    return wr
 
1021
 
 
1022
 
 
1023
def _reweave_parent_graphs(wa, wb):
 
1024
    """Return combined parent ancestry for two weaves.
 
1025
 
 
1026
    Returned as a list of (version_name, set(parent_names))"""
 
1027
    combined = {}
 
1028
    for weave in [wa, wb]:
 
1029
        for idx, name in enumerate(weave._names):
 
1030
            p = combined.setdefault(name, set())
 
1031
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1032
    return combined