/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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