~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-19 19:15:58 UTC
  • mfrom: (6388 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6404.
  • Revision ID: jelmer@canonical.com-20111219191558-p1k7cvhjq8l6v2gm
Merge bzr.dev.

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
 
 
21
from __future__ import absolute_import
24
22
 
25
23
# XXX: If we do weaves this way, will a merge still behave the same
26
24
# way if it's done in a different order?  That's a pretty desirable
27
25
# property.
28
26
 
29
27
# TODO: Nothing here so far assumes the lines are really \n newlines,
30
 
# 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
31
29
# binaries, perhaps by naively splitting on \n or perhaps using
32
30
# something like a rolling checksum.
33
31
 
61
59
# where the basis and destination are unchanged.
62
60
 
63
61
# 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 
 
62
# that includes some redundant parents (i.e. already a parent of
 
63
# something in the list.)  We should eliminate them.  This can
66
64
# be done fairly efficiently because the sequence numbers constrain
67
65
# the possible relationships.
68
66
 
69
 
 
70
 
import sha
71
 
from difflib import SequenceMatcher
72
 
 
 
67
# FIXME: the conflict markers should be *7* characters
 
68
 
 
69
from copy import copy
 
70
from cStringIO import StringIO
 
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 *
73
90
from bzrlib.trace import mutter
74
 
from bzrlib.errors import WeaveError, WeaveFormatError, WeaveParentMismatch, \
75
 
        WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent
76
 
from bzrlib.tsort import topo_sort
77
 
 
78
 
 
79
 
class Weave(object):
 
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):
80
127
    """weave - versioned text file storage.
81
 
    
 
128
 
82
129
    A Weave manages versions of line-based text files, keeping track
83
130
    of the originating version for each line.
84
131
 
130
177
 
131
178
    * It doesn't seem very useful to have an active insertion
132
179
      inside an inactive insertion, but it might happen.
133
 
      
 
180
 
134
181
    * Therefore, all instructions are always"considered"; that
135
182
      is passed onto and off the stack.  An outer inactive block
136
183
      doesn't disable an inner block.
166
213
    """
167
214
 
168
215
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
169
 
                 '_weave_name']
170
 
    
171
 
    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__()
172
227
        self._weave = []
173
228
        self._parents = []
174
229
        self._sha1s = []
175
230
        self._names = []
176
231
        self._name_map = {}
177
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
        self._allow_reserved = allow_reserved
178
243
 
179
244
    def __repr__(self):
180
245
        return "Weave(%r)" % self._weave_name
181
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)
182
253
 
183
254
    def copy(self):
184
255
        """Return a deep copy of self.
185
 
        
 
256
 
186
257
        The copy can be modified without affecting the original weave."""
187
258
        other = Weave()
188
259
        other._weave = self._weave[:]
198
269
            return False
199
270
        return self._parents == other._parents \
200
271
               and self._weave == other._weave \
201
 
               and self._sha1s == other._sha1s 
 
272
               and self._sha1s == other._sha1s
202
273
 
203
 
    
204
274
    def __ne__(self, other):
205
275
        return not self.__eq__(other)
206
276
 
207
 
    def __contains__(self, name):
208
 
        return self._name_map.has_key(name)
209
 
 
210
 
    def maybe_lookup(self, name_or_index):
211
 
        """Convert possible symbolic name to index, or pass through indexes."""
212
 
        if isinstance(name_or_index, (int, long)):
213
 
            return name_or_index
214
 
        else:
215
 
            return self.lookup(name_or_index)
216
 
 
217
 
        
218
 
    def lookup(self, name):
 
277
    def _idx_to_name(self, version):
 
278
        return self._names[version]
 
279
 
 
280
    def _lookup(self, name):
219
281
        """Convert symbolic version name to index."""
 
282
        if not self._allow_reserved:
 
283
            self.check_not_reserved_id(name)
220
284
        try:
221
285
            return self._name_map[name]
222
286
        except KeyError:
223
 
            raise WeaveRevisionNotPresent(name, self)
 
287
            raise RevisionNotPresent(name, self._weave_name)
224
288
 
225
 
    def names(self):
 
289
    def versions(self):
 
290
        """See VersionedFile.versions."""
226
291
        return self._names[:]
227
292
 
228
 
    def iter_names(self):
229
 
        """Yield a list of all names in this weave."""
230
 
        return iter(self._names)
231
 
 
232
 
    def idx_to_name(self, version):
233
 
        return self._names[version]
 
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
234
379
 
235
380
    def _check_repeated_add(self, name, parents, text, sha1):
236
381
        """Check that a duplicated add is OK.
237
382
 
238
383
        If it is, return the (old) index; otherwise raise an exception.
239
384
        """
240
 
        idx = self.lookup(name)
 
385
        idx = self._lookup(name)
241
386
        if sorted(self._parents[idx]) != sorted(parents) \
242
387
            or sha1 != self._sha1s[idx]:
243
 
            raise WeaveRevisionAlreadyPresent(name, self)
 
388
            raise RevisionAlreadyPresent(name, self._weave_name)
244
389
        return idx
245
 
        
246
 
    def add(self, name, parents, text, sha1=None):
 
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):
247
399
        """Add a single text on top of the weave.
248
 
  
 
400
 
249
401
        Returns the index number of the newly added version.
250
402
 
251
 
        name
 
403
        version_id
252
404
            Symbolic name for this version.
253
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)
254
407
 
255
408
        parents
256
409
            List or set of direct parent version numbers.
257
 
            
258
 
        text
 
410
 
 
411
        lines
259
412
            Sequence of lines to be added in the new version.
260
413
 
261
 
        sha -- SHA-1 of the file, if known.  This is trusted to be
262
 
            correct if supplied.
 
414
        :param nostore_sha: See VersionedFile.add_lines.
263
415
        """
264
 
        from bzrlib.osutils import sha_strings
265
 
 
266
 
        assert isinstance(name, basestring)
267
 
        if sha1 is None:
268
 
            sha1 = sha_strings(text)
269
 
        if name in self._name_map:
270
 
            return self._check_repeated_add(name, parents, text, sha1)
271
 
 
272
 
        parents = map(self.maybe_lookup, parents)
 
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
 
273
427
        self._check_versions(parents)
274
 
        ## self._check_lines(text)
 
428
        ## self._check_lines(lines)
275
429
        new_version = len(self._parents)
276
430
 
277
 
 
278
431
        # if we abort after here the (in-memory) weave will be corrupt because only
279
432
        # some fields are updated
 
433
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
434
        #      - Robert Collins 20060226
280
435
        self._parents.append(parents[:])
281
436
        self._sha1s.append(sha1)
282
 
        self._names.append(name)
283
 
        self._name_map[name] = new_version
284
 
 
285
 
            
 
437
        self._names.append(version_id)
 
438
        self._name_map[version_id] = new_version
 
439
 
 
440
 
286
441
        if not parents:
287
442
            # special case; adding with no parents revision; can do
288
443
            # this more quickly by just appending unconditionally.
289
444
            # even more specially, if we're adding an empty text we
290
445
            # need do nothing at all.
291
 
            if text:
 
446
            if lines:
292
447
                self._weave.append(('{', new_version))
293
 
                self._weave.extend(text)
 
448
                self._weave.extend(lines)
294
449
                self._weave.append(('}', None))
295
 
        
296
450
            return new_version
297
451
 
298
452
        if len(parents) == 1:
300
454
            if sha1 == self._sha1s[pv]:
301
455
                # special case: same as the single parent
302
456
                return new_version
303
 
            
304
 
 
305
 
        ancestors = self.inclusions(parents)
 
457
 
 
458
 
 
459
        ancestors = self._inclusions(parents)
306
460
 
307
461
        l = self._weave
308
462
 
315
469
 
316
470
        # another small special case: a merge, producing the same text
317
471
        # as auto-merge
318
 
        if text == basis_lines:
319
 
            return new_version            
 
472
        if lines == basis_lines:
 
473
            return new_version
320
474
 
321
 
        # 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
322
476
        basis_lineno.append(len(self._weave))
323
477
 
324
478
        # XXX: which line of the weave should we really consider
328
482
        #print 'basis_lines:', basis_lines
329
483
        #print 'new_lines:  ', lines
330
484
 
331
 
        s = SequenceMatcher(None, basis_lines, text)
 
485
        s = self._matcher(None, basis_lines, lines)
332
486
 
333
487
        # offset gives the number of lines that have been inserted
334
488
        # into the weave up to the current point; if the original edit instruction
341
495
            #print 'raw match', tag, i1, i2, j1, j2
342
496
            if tag == 'equal':
343
497
                continue
344
 
 
345
498
            i1 = basis_lineno[i1]
346
499
            i2 = basis_lineno[i2]
347
 
 
348
 
            assert 0 <= j1 <= j2 <= len(text)
349
 
 
350
 
            #print tag, i1, i2, j1, j2
351
 
 
352
500
            # the deletion and insertion are handled separately.
353
501
            # first delete the region.
354
502
            if i1 != i2:
361
509
                # i2; we want to insert after this region to make sure
362
510
                # we don't destroy ourselves
363
511
                i = i2 + offset
364
 
                self._weave[i:i] = ([('{', new_version)] 
365
 
                                    + text[j1:j2] 
 
512
                self._weave[i:i] = ([('{', new_version)]
 
513
                                    + lines[j1:j2]
366
514
                                    + [('}', None)])
367
515
                offset += 2 + (j2 - j1)
368
 
 
369
516
        return new_version
370
517
 
371
 
    def add_identical(self, old_rev_id, new_rev_id, parents):
372
 
        """Add an identical text to old_rev_id as new_rev_id."""
373
 
        old_lines = self.get(self.lookup(old_rev_id))
374
 
        self.add(new_rev_id, parents, old_lines)
375
 
 
376
 
    def inclusions(self, versions):
 
518
    def _inclusions(self, versions):
377
519
        """Return set of all ancestors of given version(s)."""
 
520
        if not len(versions):
 
521
            return []
378
522
        i = set(versions)
379
523
        for v in xrange(max(versions), 0, -1):
380
524
            if v in i:
384
528
        ## except IndexError:
385
529
        ##     raise ValueError("version %d not present in weave" % v)
386
530
 
387
 
 
388
 
    def parents(self, version):
389
 
        return self._parents[version]
390
 
 
391
 
 
392
 
    def parent_names(self, version):
393
 
        """Return version names for parents of a version."""
394
 
        return map(self.idx_to_name, self._parents[self.lookup(version)])
395
 
 
396
 
 
397
 
    def minimal_parents(self, version):
398
 
        """Find the minimal set of parents for the version."""
399
 
        included = self._parents[version]
400
 
        if not included:
401
 
            return []
402
 
        
403
 
        li = list(included)
404
 
        li.sort(reverse=True)
405
 
 
406
 
        mininc = []
407
 
        gotit = set()
408
 
 
409
 
        for pv in li:
410
 
            if pv not in gotit:
411
 
                mininc.append(pv)
412
 
                gotit.update(self.inclusions(pv))
413
 
 
414
 
        assert mininc[0] >= 0
415
 
        assert mininc[-1] < version
416
 
        return mininc
417
 
 
418
 
 
 
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]
419
537
 
420
538
    def _check_lines(self, text):
421
539
        if not isinstance(text, list):
425
543
            if not isinstance(l, basestring):
426
544
                raise ValueError("text line should be a string or unicode, not %s"
427
545
                                 % type(l))
428
 
        
 
546
 
429
547
 
430
548
 
431
549
    def _check_versions(self, indexes):
436
554
            except IndexError:
437
555
                raise IndexError("invalid version number %r" % i)
438
556
 
439
 
    
440
 
    def annotate(self, name_or_index):
441
 
        return list(self.annotate_iter(name_or_index))
442
 
 
443
 
 
444
 
    def annotate_iter(self, name_or_index):
445
 
        """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.
446
567
 
447
568
        The index indicates when the line originated in the weave."""
448
 
        incls = [self.maybe_lookup(name_or_index)]
449
 
        for origin, lineno, text in self._extract(incls):
450
 
            yield origin, text
451
 
 
452
 
    def _walk(self):
453
 
        """Walk the weave.
454
 
 
455
 
        Yields sequence of
456
 
        (lineno, insert, deletes, text)
457
 
        for each literal line.
458
 
        """
459
 
        
 
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
 
460
589
        istack = []
461
590
        dset = set()
462
591
 
463
592
        lineno = 0         # line of weave, 0-based
464
593
 
465
594
        for l in self._weave:
466
 
            if isinstance(l, tuple):
 
595
            if l.__class__ == tuple:
467
596
                c, v = l
468
597
                isactive = None
469
598
                if c == '{':
470
 
                    istack.append(v)
 
599
                    istack.append(self._names[v])
471
600
                elif c == '}':
472
601
                    istack.pop()
473
602
                elif c == '[':
474
 
                    assert v not in dset
475
 
                    dset.add(v)
 
603
                    dset.add(self._names[v])
476
604
                elif c == ']':
477
 
                    dset.remove(v)
 
605
                    dset.remove(self._names[v])
478
606
                else:
479
607
                    raise WeaveFormatError('unexpected instruction %r' % v)
480
608
            else:
481
 
                assert isinstance(l, basestring)
482
 
                assert istack
483
 
                yield lineno, istack[-1], dset, l
 
609
                yield lineno, istack[-1], frozenset(dset), l
484
610
            lineno += 1
485
611
 
486
 
 
 
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
487
662
 
488
663
    def _extract(self, versions):
489
664
        """Yield annotation of lines in included set.
497
672
        for i in versions:
498
673
            if not isinstance(i, int):
499
674
                raise ValueError(i)
500
 
            
501
 
        included = self.inclusions(versions)
 
675
 
 
676
        included = self._inclusions(versions)
502
677
 
503
678
        istack = []
 
679
        iset = set()
504
680
        dset = set()
505
681
 
506
682
        lineno = 0         # line of weave, 0-based
511
687
 
512
688
        WFE = WeaveFormatError
513
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
 
514
717
        for l in self._weave:
515
 
            if isinstance(l, tuple):
 
718
            if l.__class__ == tuple:
516
719
                c, v = l
517
720
                isactive = None
518
721
                if c == '{':
519
 
                    assert v not in istack
520
722
                    istack.append(v)
 
723
                    iset.add(v)
521
724
                elif c == '}':
522
 
                    istack.pop()
 
725
                    iset.remove(istack.pop())
523
726
                elif c == '[':
524
727
                    if v in included:
525
 
                        assert v not in dset
526
728
                        dset.add(v)
527
 
                else:
528
 
                    assert c == ']'
 
729
                elif c == ']':
529
730
                    if v in included:
530
 
                        assert v in dset
531
731
                        dset.remove(v)
 
732
                else:
 
733
                    raise AssertionError()
532
734
            else:
533
 
                assert isinstance(l, basestring)
534
735
                if isactive is None:
535
736
                    isactive = (not dset) and istack and (istack[-1] in included)
536
737
                if isactive:
544
745
                                   % dset)
545
746
        return result
546
747
 
547
 
 
548
 
    def get_iter(self, name_or_index):
549
 
        """Yield lines for the specified version."""
550
 
        incls = [self.maybe_lookup(name_or_index)]
551
 
        for origin, lineno, line in self._extract(incls):
552
 
            yield line
553
 
 
554
 
 
555
 
    def get_text(self, name_or_index):
556
 
        return ''.join(self.get_iter(name_or_index))
557
 
        assert isinstance(version, int)
558
 
 
559
 
 
560
 
    def get_lines(self, name_or_index):
561
 
        return list(self.get_iter(name_or_index))
562
 
 
563
 
 
564
 
    get = get_lines
565
 
 
566
 
 
567
 
    def mash_iter(self, included):
568
 
        """Return composed version of multiple included versions."""
569
 
        included = map(self.maybe_lookup, included)
570
 
        for origin, lineno, text in self._extract(included):
571
 
            yield text
572
 
 
573
 
 
574
 
    def dump(self, to_file):
575
 
        from pprint import pprint
576
 
        print >>to_file, "Weave._weave = ",
577
 
        pprint(self._weave, to_file)
578
 
        print >>to_file, "Weave._parents = ",
579
 
        pprint(self._parents, to_file)
580
 
 
581
 
 
582
 
 
583
 
    def numversions(self):
 
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?"""
584
780
        l = len(self._parents)
585
 
        assert l == len(self._sha1s)
586
781
        return l
587
782
 
588
 
 
589
 
    def __len__(self):
590
 
        return self.numversions()
591
 
 
 
783
    __len__ = num_versions
592
784
 
593
785
    def check(self, progress_bar=None):
594
 
        # check no circular inclusions
595
 
        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()):
596
790
            inclusions = list(self._parents[version])
597
791
            if inclusions:
598
792
                inclusions.sort()
600
794
                    raise WeaveFormatError("invalid included version %d for index %d"
601
795
                                           % (inclusions[-1], version))
602
796
 
603
 
        # try extracting all versions; this is a bit slow and parallel
604
 
        # extraction could be used
605
 
        nv = self.numversions()
606
 
        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():
607
827
            if progress_bar:
608
 
                progress_bar.update('checking text', version, nv)
609
 
            s = sha.new()
610
 
            for l in self.get_iter(version):
611
 
                s.update(l)
612
 
            hd = s.hexdigest()
613
 
            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]
614
841
            if hd != expected:
615
 
                raise WeaveError("mismatched sha1 for version %d; "
616
 
                                 "got %s, expected %s"
617
 
                                 % (version, hd, expected))
 
842
                raise errors.WeaveInvalidChecksum(
 
843
                        "mismatched sha1 for version %s: "
 
844
                        "got %s, expected %s"
 
845
                        % (version, hd, expected))
618
846
 
619
847
        # TODO: check insertions are properly nested, that there are
620
848
        # no lines outside of insertion blocks, that deletions are
621
849
        # properly paired, etc.
622
850
 
623
 
 
624
 
 
625
 
    def merge(self, merge_versions):
626
 
        """Automerge and mark conflicts between versions.
627
 
 
628
 
        This returns a sequence, each entry describing alternatives
629
 
        for a chunk of the file.  Each of the alternatives is given as
630
 
        a list of lines.
631
 
 
632
 
        If there is a chunk of the file where there's no diagreement,
633
 
        only one alternative is given.
634
 
        """
635
 
        # approach: find the included versions common to all the
636
 
        # merged versions
637
 
        raise NotImplementedError()
638
 
 
639
 
 
640
 
 
641
 
    def _delta(self, included, lines):
642
 
        """Return changes from basis to new revision.
643
 
 
644
 
        The old text for comparison is the union of included revisions.
645
 
 
646
 
        This is used in inserting a new text.
647
 
 
648
 
        Delta is returned as a sequence of
649
 
        (weave1, weave2, newlines).
650
 
 
651
 
        This indicates that weave1:weave2 of the old weave should be
652
 
        replaced by the sequence of lines in newlines.  Note that
653
 
        these line numbers are positions in the total weave and don't
654
 
        correspond to the lines in any extracted version, or even the
655
 
        extracted union of included versions.
656
 
 
657
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
658
 
        pure delete.  (Similar to difflib.)
659
 
        """
660
 
        raise NotImplementedError()
661
 
 
662
 
            
663
 
    def plan_merge(self, ver_a, ver_b):
664
 
        """Return pseudo-annotation indicating how the two versions merge.
665
 
 
666
 
        This is computed between versions a and b and their common
667
 
        base.
668
 
 
669
 
        Weave lines present in none of them are skipped entirely.
670
 
        """
671
 
        inc_a = self.inclusions([ver_a])
672
 
        inc_b = self.inclusions([ver_b])
673
 
        inc_c = inc_a & inc_b
674
 
 
675
 
        for lineno, insert, deleteset, line in self._walk():
676
 
            if deleteset & inc_c:
677
 
                # killed in parent; can't be in either a or b
678
 
                # not relevant to our work
679
 
                yield 'killed-base', line
680
 
            elif insert in inc_c:
681
 
                # was inserted in base
682
 
                killed_a = bool(deleteset & inc_a)
683
 
                killed_b = bool(deleteset & inc_b)
684
 
                if killed_a and killed_b:
685
 
                    yield 'killed-both', line
686
 
                elif killed_a:
687
 
                    yield 'killed-a', line
688
 
                elif killed_b:
689
 
                    yield 'killed-b', line
690
 
                else:
691
 
                    yield 'unchanged', line
692
 
            elif insert in inc_a:
693
 
                if deleteset & inc_a:
694
 
                    yield 'ghost-a', line
695
 
                else:
696
 
                    # new in A; not in B
697
 
                    yield 'new-a', line
698
 
            elif insert in inc_b:
699
 
                if deleteset & inc_b:
700
 
                    yield 'ghost-b', line
701
 
                else:
702
 
                    yield 'new-b', line
703
 
            else:
704
 
                # not in either revision
705
 
                yield 'irrelevant', line
706
 
 
707
 
        yield 'unchanged', ''           # terminator
708
 
 
709
 
 
710
 
 
711
 
    def weave_merge(self, plan):
712
 
        lines_a = []
713
 
        lines_b = []
714
 
        ch_a = ch_b = False
715
 
 
716
 
        for state, line in plan:
717
 
            if state == 'unchanged' or state == 'killed-both':
718
 
                # resync and flush queued conflicts changes if any
719
 
                if not lines_a and not lines_b:
720
 
                    pass
721
 
                elif ch_a and not ch_b:
722
 
                    # one-sided change:                    
723
 
                    for l in lines_a: yield l
724
 
                elif ch_b and not ch_a:
725
 
                    for l in lines_b: yield l
726
 
                elif lines_a == lines_b:
727
 
                    for l in lines_a: yield l
728
 
                else:
729
 
                    yield '<<<<<<<\n'
730
 
                    for l in lines_a: yield l
731
 
                    yield '=======\n'
732
 
                    for l in lines_b: yield l
733
 
                    yield '>>>>>>>\n'
734
 
 
735
 
                del lines_a[:]
736
 
                del lines_b[:]
737
 
                ch_a = ch_b = False
738
 
                
739
 
            if state == 'unchanged':
740
 
                if line:
741
 
                    yield line
742
 
            elif state == 'killed-a':
743
 
                ch_a = True
744
 
                lines_b.append(line)
745
 
            elif state == 'killed-b':
746
 
                ch_b = True
747
 
                lines_a.append(line)
748
 
            elif state == 'new-a':
749
 
                ch_a = True
750
 
                lines_a.append(line)
751
 
            elif state == 'new-b':
752
 
                ch_b = True
753
 
                lines_b.append(line)
754
 
            else:
755
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
756
 
                                 'killed-both'), \
757
 
                       state
758
 
 
759
 
                
760
 
    def join(self, other):
761
 
        """Integrate versions from other into this weave.
762
 
 
763
 
        The resulting weave contains all the history of both weaves; 
764
 
        any version you could retrieve from either self or other can be 
765
 
        retrieved from self after this call.
766
 
 
767
 
        It is illegal for the two weaves to contain different values 
768
 
        or different parents for any version.  See also reweave().
769
 
        """
770
 
        if other.numversions() == 0:
771
 
            return          # nothing to update, easy
772
 
        # two loops so that we do not change ourselves before verifying it
773
 
        # will be ok
774
 
        # work through in index order to make sure we get all dependencies
775
 
        for other_idx, name in enumerate(other._names):
776
 
            if self._check_version_consistent(other, other_idx, name):
777
 
                continue
778
 
        for other_idx, name in enumerate(other._names):
779
 
            # TODO: If all the parents of the other version are already 
780
 
            # present then we can avoid some work by just taking the delta
781
 
            # and adjusting the offsets.
782
 
            new_parents = self._imported_parents(other, other_idx)
783
 
            lines = other.get_lines(other_idx)
784
 
            sha1 = other._sha1s[other_idx]
785
 
            self.add(name, new_parents, lines, sha1)
786
 
 
787
 
 
788
851
    def _imported_parents(self, other, other_idx):
789
852
        """Return list of parents in self corresponding to indexes in other."""
790
853
        new_parents = []
791
854
        for parent_idx in other._parents[other_idx]:
792
855
            parent_name = other._names[parent_idx]
793
 
            if parent_name not in self._names:
 
856
            if parent_name not in self._name_map:
794
857
                # should not be possible
795
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
858
                raise WeaveError("missing parent {%s} of {%s} in %r"
796
859
                                 % (parent_name, other._name_map[other_idx], self))
797
860
            new_parents.append(self._name_map[parent_name])
798
861
        return new_parents
805
868
         * the same text
806
869
         * the same direct parents (by name, not index, and disregarding
807
870
           order)
808
 
        
 
871
 
809
872
        If present & correct return True;
810
 
        if not present in self return False; 
 
873
        if not present in self return False;
811
874
        if inconsistent raise error."""
812
875
        this_idx = self._name_map.get(name, -1)
813
876
        if this_idx != -1:
814
877
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
815
 
                raise WeaveError("inconsistent texts for version {%s} "
816
 
                                 "when joining weaves"
817
 
                                 % (name))
 
878
                raise errors.WeaveTextDiffers(name, self, other)
818
879
            self_parents = self._parents[this_idx]
819
880
            other_parents = other._parents[other_idx]
820
 
            n1 = [self._names[i] for i in self_parents]
821
 
            n2 = [other._names[i] for i in other_parents]
822
 
            n1.sort()
823
 
            n2.sort()
824
 
            if n1 != n2:
 
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):
825
884
                raise WeaveParentMismatch("inconsistent parents "
826
885
                    "for version {%s}: %s vs %s" % (name, n1, n2))
827
886
            else:
829
888
        else:
830
889
            return False
831
890
 
832
 
    def reweave(self, other):
833
 
        """Reweave self with other."""
834
 
        new_weave = reweave(self, other)
 
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."""
835
903
        for attr in self.__slots__:
836
 
            setattr(self, attr, getattr(new_weave, attr))
837
 
 
838
 
 
839
 
def reweave(wa, wb):
 
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
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
924
        except errors.NoSuchFile:
 
925
            if not create:
 
926
                raise
 
927
            # new file, save it
 
928
            self._save()
 
929
 
 
930
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
931
        left_matching_blocks, nostore_sha, random_id, check_content):
 
932
        """Add a version and save the weave."""
 
933
        self.check_not_reserved_id(version_id)
 
934
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
935
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
936
            check_content)
 
937
        self._save()
 
938
        return result
 
939
 
 
940
    def copy_to(self, name, transport):
 
941
        """See VersionedFile.copy_to()."""
 
942
        # as we are all in memory always, just serialise to the new place.
 
943
        sio = StringIO()
 
944
        write_weave_v5(self, sio)
 
945
        sio.seek(0)
 
946
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
947
 
 
948
    def _save(self):
 
949
        """Save the weave."""
 
950
        self._check_write_ok()
 
951
        sio = StringIO()
 
952
        write_weave_v5(self, sio)
 
953
        sio.seek(0)
 
954
        bytes = sio.getvalue()
 
955
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
 
956
        try:
 
957
            self._transport.put_bytes(path, bytes, self._filemode)
 
958
        except errors.NoSuchFile:
 
959
            self._transport.mkdir(dirname(path))
 
960
            self._transport.put_bytes(path, bytes, self._filemode)
 
961
 
 
962
    @staticmethod
 
963
    def get_suffixes():
 
964
        """See VersionedFile.get_suffixes()."""
 
965
        return [WeaveFile.WEAVE_SUFFIX]
 
966
 
 
967
    def insert_record_stream(self, stream):
 
968
        super(WeaveFile, self).insert_record_stream(stream)
 
969
        self._save()
 
970
 
 
971
 
 
972
def _reweave(wa, wb, pb=None, msg=None):
840
973
    """Combine two weaves and return the result.
841
974
 
842
 
    This works even if a revision R has different parents in 
 
975
    This works even if a revision R has different parents in
843
976
    wa and wb.  In the resulting weave all the parents are given.
844
977
 
845
 
    This is done by just building up a new weave, maintaining ordering 
 
978
    This is done by just building up a new weave, maintaining ordering
846
979
    of the versions in the two inputs.  More efficient approaches
847
 
    might be possible but it should only be necessary to do 
848
 
    this operation rarely, when a new previously ghost version is 
 
980
    might be possible but it should only be necessary to do
 
981
    this operation rarely, when a new previously ghost version is
849
982
    inserted.
 
983
 
 
984
    :param pb: An optional progress bar, indicating how far done we are
 
985
    :param msg: An optional message for the progress
850
986
    """
851
987
    wr = Weave()
852
988
    ia = ib = 0
853
 
    queue_a = range(wa.numversions())
854
 
    queue_b = range(wb.numversions())
 
989
    queue_a = range(wa.num_versions())
 
990
    queue_b = range(wb.num_versions())
855
991
    # first determine combined parents of all versions
856
992
    # map from version name -> all parent names
857
993
    combined_parents = _reweave_parent_graphs(wa, wb)
858
994
    mutter("combined parents: %r", combined_parents)
859
 
    order = topo_sort(combined_parents.iteritems())
 
995
    order = tsort.topo_sort(combined_parents.iteritems())
860
996
    mutter("order to reweave: %r", order)
861
 
    for name in order:
 
997
 
 
998
    if pb and not msg:
 
999
        msg = 'reweave'
 
1000
 
 
1001
    for idx, name in enumerate(order):
 
1002
        if pb:
 
1003
            pb.update(msg, idx, len(order))
862
1004
        if name in wa._name_map:
863
1005
            lines = wa.get_lines(name)
864
1006
            if name in wb._name_map:
865
 
                assert lines == wb.get_lines(name)
 
1007
                lines_b = wb.get_lines(name)
 
1008
                if lines != lines_b:
 
1009
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1010
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1011
                    import difflib
 
1012
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1013
                            wa._weave_name, wb._weave_name))
 
1014
                    mutter('lines:\n%s', ''.join(lines))
 
1015
                    raise errors.WeaveTextDiffers(name, wa, wb)
866
1016
        else:
867
1017
            lines = wb.get_lines(name)
868
 
        wr.add(name, combined_parents[name], lines)
 
1018
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
869
1019
    return wr
870
1020
 
871
1021
 
872
1022
def _reweave_parent_graphs(wa, wb):
873
1023
    """Return combined parent ancestry for two weaves.
874
 
    
 
1024
 
875
1025
    Returned as a list of (version_name, set(parent_names))"""
876
1026
    combined = {}
877
1027
    for weave in [wa, wb]:
878
1028
        for idx, name in enumerate(weave._names):
879
1029
            p = combined.setdefault(name, set())
880
 
            p.update(map(weave.idx_to_name, weave._parents[idx]))
 
1030
            p.update(map(weave._idx_to_name, weave._parents[idx]))
881
1031
    return combined
882
 
 
883
 
 
884
 
def weave_toc(w):
885
 
    """Show the weave's table-of-contents"""
886
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
887
 
    for i in (6, 50, 10, 10):
888
 
        print '-' * i,
889
 
    print
890
 
    for i in range(w.numversions()):
891
 
        sha1 = w._sha1s[i]
892
 
        name = w._names[i]
893
 
        parent_str = ' '.join(map(str, w._parents[i]))
894
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
895
 
 
896
 
 
897
 
 
898
 
def weave_stats(weave_file, pb):
899
 
    from bzrlib.weavefile import read_weave
900
 
 
901
 
    wf = file(weave_file, 'rb')
902
 
    w = read_weave(wf)
903
 
    # FIXME: doesn't work on pipes
904
 
    weave_size = wf.tell()
905
 
 
906
 
    total = 0
907
 
    vers = len(w)
908
 
    for i in range(vers):
909
 
        pb.update('checking sizes', i, vers)
910
 
        for origin, lineno, line in w._extract([i]):
911
 
            total += len(line)
912
 
 
913
 
    pb.clear()
914
 
 
915
 
    print 'versions          %9d' % vers
916
 
    print 'weave file        %9d bytes' % weave_size
917
 
    print 'total contents    %9d bytes' % total
918
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
919
 
    if vers:
920
 
        avg = total/vers
921
 
        print 'average size      %9d bytes' % avg
922
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
923
 
 
924
 
 
925
 
def usage():
926
 
    print """bzr weave tool
927
 
 
928
 
Experimental tool for weave algorithm.
929
 
 
930
 
usage:
931
 
    weave init WEAVEFILE
932
 
        Create an empty weave file
933
 
    weave get WEAVEFILE VERSION
934
 
        Write out specified version.
935
 
    weave check WEAVEFILE
936
 
        Check consistency of all versions.
937
 
    weave toc WEAVEFILE
938
 
        Display table of contents.
939
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
940
 
        Add NEWTEXT, with specified parent versions.
941
 
    weave annotate WEAVEFILE VERSION
942
 
        Display origin of each line.
943
 
    weave mash WEAVEFILE VERSION...
944
 
        Display composite of all selected versions.
945
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
946
 
        Auto-merge two versions and display conflicts.
947
 
    weave diff WEAVEFILE VERSION1 VERSION2 
948
 
        Show differences between two versions.
949
 
 
950
 
example:
951
 
 
952
 
    % weave init foo.weave
953
 
    % vi foo.txt
954
 
    % weave add foo.weave ver0 < foo.txt
955
 
    added version 0
956
 
 
957
 
    (create updated version)
958
 
    % vi foo.txt
959
 
    % weave get foo.weave 0 | diff -u - foo.txt
960
 
    % weave add foo.weave ver1 0 < foo.txt
961
 
    added version 1
962
 
 
963
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
964
 
    % vi foo.txt
965
 
    % weave add foo.weave ver2 0 < foo.txt
966
 
    added version 2
967
 
 
968
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
969
 
    % vi foo.txt                            (resolve conflicts)
970
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
971
 
    
972
 
"""
973
 
    
974
 
 
975
 
 
976
 
def main(argv):
977
 
    import sys
978
 
    import os
979
 
    try:
980
 
        import bzrlib
981
 
    except ImportError:
982
 
        # in case we're run directly from the subdirectory
983
 
        sys.path.append('..')
984
 
        import bzrlib
985
 
    from bzrlib.weavefile import write_weave, read_weave
986
 
    from bzrlib.progress import ProgressBar
987
 
 
988
 
    try:
989
 
        import psyco
990
 
        psyco.full()
991
 
    except ImportError:
992
 
        pass
993
 
 
994
 
    if len(argv) < 2:
995
 
        usage()
996
 
        return 0
997
 
 
998
 
    cmd = argv[1]
999
 
 
1000
 
    def readit():
1001
 
        return read_weave(file(argv[2], 'rb'))
1002
 
    
1003
 
    if cmd == 'help':
1004
 
        usage()
1005
 
    elif cmd == 'add':
1006
 
        w = readit()
1007
 
        # at the moment, based on everything in the file
1008
 
        name = argv[3]
1009
 
        parents = map(int, argv[4:])
1010
 
        lines = sys.stdin.readlines()
1011
 
        ver = w.add(name, parents, lines)
1012
 
        write_weave(w, file(argv[2], 'wb'))
1013
 
        print 'added version %r %d' % (name, ver)
1014
 
    elif cmd == 'init':
1015
 
        fn = argv[2]
1016
 
        if os.path.exists(fn):
1017
 
            raise IOError("file exists")
1018
 
        w = Weave()
1019
 
        write_weave(w, file(fn, 'wb'))
1020
 
    elif cmd == 'get': # get one version
1021
 
        w = readit()
1022
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1023
 
        
1024
 
    elif cmd == 'mash': # get composite
1025
 
        w = readit()
1026
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
1027
 
 
1028
 
    elif cmd == 'diff':
1029
 
        from difflib import unified_diff
1030
 
        w = readit()
1031
 
        fn = argv[2]
1032
 
        v1, v2 = map(int, argv[3:5])
1033
 
        lines1 = w.get(v1)
1034
 
        lines2 = w.get(v2)
1035
 
        diff_gen = unified_diff(lines1, lines2,
1036
 
                                '%s version %d' % (fn, v1),
1037
 
                                '%s version %d' % (fn, v2))
1038
 
        sys.stdout.writelines(diff_gen)
1039
 
            
1040
 
    elif cmd == 'annotate':
1041
 
        w = readit()
1042
 
        # newline is added to all lines regardless; too hard to get
1043
 
        # reasonable formatting otherwise
1044
 
        lasto = None
1045
 
        for origin, text in w.annotate(int(argv[3])):
1046
 
            text = text.rstrip('\r\n')
1047
 
            if origin == lasto:
1048
 
                print '      | %s' % (text)
1049
 
            else:
1050
 
                print '%5d | %s' % (origin, text)
1051
 
                lasto = origin
1052
 
                
1053
 
    elif cmd == 'toc':
1054
 
        weave_toc(readit())
1055
 
 
1056
 
    elif cmd == 'stats':
1057
 
        weave_stats(argv[2], ProgressBar())
1058
 
        
1059
 
    elif cmd == 'check':
1060
 
        w = readit()
1061
 
        pb = ProgressBar()
1062
 
        w.check(pb)
1063
 
        pb.clear()
1064
 
        print '%d versions ok' % w.numversions()
1065
 
 
1066
 
    elif cmd == 'inclusions':
1067
 
        w = readit()
1068
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
1069
 
 
1070
 
    elif cmd == 'parents':
1071
 
        w = readit()
1072
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
1073
 
 
1074
 
    elif cmd == 'plan-merge':
1075
 
        w = readit()
1076
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1077
 
            if line:
1078
 
                print '%14s | %s' % (state, line),
1079
 
 
1080
 
    elif cmd == 'merge':
1081
 
        w = readit()
1082
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1083
 
        sys.stdout.writelines(w.weave_merge(p))
1084
 
            
1085
 
    elif cmd == 'mash-merge':
1086
 
        if len(argv) != 5:
1087
 
            usage()
1088
 
            return 1
1089
 
 
1090
 
        w = readit()
1091
 
        v1, v2 = map(int, argv[3:5])
1092
 
 
1093
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
1094
 
 
1095
 
        base_lines = list(w.mash_iter(basis))
1096
 
        a_lines = list(w.get(v1))
1097
 
        b_lines = list(w.get(v2))
1098
 
 
1099
 
        from bzrlib.merge3 import Merge3
1100
 
        m3 = Merge3(base_lines, a_lines, b_lines)
1101
 
 
1102
 
        name_a = 'version %d' % v1
1103
 
        name_b = 'version %d' % v2
1104
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
1105
 
    else:
1106
 
        raise ValueError('unknown command %r' % cmd)
1107
 
    
1108
 
 
1109
 
 
1110
 
def profile_main(argv): 
1111
 
    import tempfile, hotshot, hotshot.stats
1112
 
 
1113
 
    prof_f = tempfile.NamedTemporaryFile()
1114
 
 
1115
 
    prof = hotshot.Profile(prof_f.name)
1116
 
 
1117
 
    ret = prof.runcall(main, argv)
1118
 
    prof.close()
1119
 
 
1120
 
    stats = hotshot.stats.load(prof_f.name)
1121
 
    #stats.strip_dirs()
1122
 
    stats.sort_stats('cumulative')
1123
 
    ## XXX: Might like to write to stderr or the trace file instead but
1124
 
    ## print_stats seems hardcoded to stdout
1125
 
    stats.print_stats(20)
1126
 
            
1127
 
    return ret
1128
 
 
1129
 
 
1130
 
if __name__ == '__main__':
1131
 
    import sys
1132
 
    if '--profile' in sys.argv:
1133
 
        args = sys.argv[:]
1134
 
        args.remove('--profile')
1135
 
        sys.exit(profile_main(args))
1136
 
    else:
1137
 
        sys.exit(main(sys.argv))
1138