/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: 2005-10-19 10:11:57 UTC
  • mfrom: (1185.16.78)
  • mto: This revision was merged to the branch mainline in revision 1470.
  • Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
mergeĀ fromĀ upstream

Show diffs side-by-side

added added

removed removed

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