~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2005-07-15 22:55:36 UTC
  • Revision ID: mbp@sourcefrog.net-20050715225536-47d68404108e4eb8
- shell script to set up a weave merge test case

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
 
19
21
 
20
22
"""Weave - storage of related text file versions"""
21
23
 
 
24
# TODO: Perhaps have copy method for Weave instances?
22
25
 
23
26
# XXX: If we do weaves this way, will a merge still behave the same
24
27
# way if it's done in a different order?  That's a pretty desirable
25
28
# property.
26
29
 
27
30
# 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
 
31
# rather than being split up in some other way.  We could accomodate
29
32
# binaries, perhaps by naively splitting on \n or perhaps using
30
33
# something like a rolling checksum.
31
34
 
 
35
# TODO: Track version names as well as indexes. 
 
36
 
32
37
# TODO: End marker for each version so we can stop reading?
33
38
 
34
39
# TODO: Check that no insertion occurs inside a deletion that was
39
44
# properly nested, that there is no text outside of an insertion, that
40
45
# insertions or deletions are not repeated, etc.
41
46
 
 
47
# TODO: Make the info command just show info, not extract everything:
 
48
# it can be much faster.
 
49
 
 
50
# TODO: Perhaps use long integers as sets instead of set objects; may
 
51
# be faster.
 
52
 
42
53
# TODO: Parallel-extract that passes back each line along with a
43
54
# description of which revisions include it.  Nice for checking all
44
 
# shas or calculating stats in parallel.
45
 
 
46
 
# TODO: Using a single _extract routine and then processing the output
47
 
# is probably inefficient.  It's simple enough that we can afford to
48
 
# have slight specializations for different ways its used: annotate,
49
 
# basis for add, get, etc.
50
 
 
51
 
# TODO: Probably the API should work only in names to hide the integer
52
 
# indexes from the user.
53
 
 
54
 
# TODO: Is there any potential performance win by having an add()
55
 
# variant that is passed a pre-cooked version of the single basis
56
 
# version?
57
 
 
58
 
# TODO: Reweave can possibly be made faster by remembering diffs
59
 
# where the basis and destination are unchanged.
60
 
 
61
 
# FIXME: Sometimes we will be given a parents list for a revision
62
 
# that includes some redundant parents (i.e. already a parent of
63
 
# something in the list.)  We should eliminate them.  This can
64
 
# be done fairly efficiently because the sequence numbers constrain
65
 
# the possible relationships.
66
 
 
67
 
# FIXME: the conflict markers should be *7* characters
68
 
 
69
 
from copy import copy
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 *
90
 
from bzrlib.trace import mutter
91
 
from bzrlib.versionedfile import (
92
 
    AbsentContentFactory,
93
 
    adapter_registry,
94
 
    ContentFactory,
95
 
    sort_groupcompress,
96
 
    VersionedFile,
97
 
    )
98
 
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
 
 
100
 
 
101
 
class WeaveContentFactory(ContentFactory):
102
 
    """Content factory for streaming from weaves.
103
 
 
104
 
    :seealso ContentFactory:
105
 
    """
106
 
 
107
 
    def __init__(self, version, weave):
108
 
        """Create a WeaveContentFactory for version from weave."""
109
 
        ContentFactory.__init__(self)
110
 
        self.sha1 = weave.get_sha1s([version])[version]
111
 
        self.key = (version,)
112
 
        parents = weave.get_parent_map([version])[version]
113
 
        self.parents = tuple((parent,) for parent in parents)
114
 
        self.storage_kind = 'fulltext'
115
 
        self._weave = weave
116
 
 
117
 
    def get_bytes_as(self, storage_kind):
118
 
        if storage_kind == 'fulltext':
119
 
            return self._weave.get_text(self.key[-1])
120
 
        elif storage_kind == 'chunked':
121
 
            return self._weave.get_lines(self.key[-1])
122
 
        else:
123
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
124
 
 
125
 
 
126
 
class Weave(VersionedFile):
 
55
# shas in parallel.
 
56
 
 
57
 
 
58
 
 
59
 
 
60
try:
 
61
    set
 
62
    frozenset
 
63
except NameError:
 
64
    from sets import Set, ImmutableSet
 
65
    set = Set
 
66
    frozenset = ImmutableSet
 
67
    del Set, ImmutableSet
 
68
 
 
69
 
 
70
class WeaveError(Exception):
 
71
    """Exception in processing weave"""
 
72
 
 
73
 
 
74
class WeaveFormatError(WeaveError):
 
75
    """Weave invariant violated"""
 
76
    
 
77
 
 
78
class Weave(object):
127
79
    """weave - versioned text file storage.
128
 
 
 
80
    
129
81
    A Weave manages versions of line-based text files, keeping track
130
82
    of the originating version for each line.
131
83
 
144
96
    the version-id is used to reference it in the larger world.
145
97
 
146
98
    The weave is represented as a list mixing edit instructions and
147
 
    literal text.  Each entry in _weave can be either a string (or
 
99
    literal text.  Each entry in _l can be either a string (or
148
100
    unicode), or a tuple.  If a string, it means that the given line
149
101
    should be output in the currently active revisions.
150
102
 
155
107
    The instruction can be '{' or '}' for an insertion block, and '['
156
108
    and ']' for a deletion block respectively.  The version is the
157
109
    integer version index.  There is no replace operator, only deletes
158
 
    and inserts.  For '}', the end of an insertion, there is no
159
 
    version parameter because it always closes the most recently
160
 
    opened insertion.
 
110
    and inserts.
161
111
 
162
112
    Constraints/notes:
163
113
 
177
127
 
178
128
    * It doesn't seem very useful to have an active insertion
179
129
      inside an inactive insertion, but it might happen.
180
 
 
 
130
      
181
131
    * Therefore, all instructions are always"considered"; that
182
132
      is passed onto and off the stack.  An outer inactive block
183
133
      doesn't disable an inner block.
190
140
      should be no way to get an earlier version deleting a later
191
141
      version.
192
142
 
193
 
    _weave
194
 
        Text of the weave; list of control instruction tuples and strings.
 
143
    _l
 
144
        Text of the weave.
195
145
 
196
 
    _parents
 
146
    _v
197
147
        List of parents, indexed by version number.
198
148
        It is only necessary to store the minimal set of parents for
199
149
        each version; the parent's parents are implied.
200
150
 
201
151
    _sha1s
202
 
        List of hex SHA-1 of each version.
203
 
 
204
 
    _names
205
 
        List of symbolic names for each version.  Each should be unique.
206
 
 
207
 
    _name_map
208
 
        For each name, the version number.
209
 
 
210
 
    _weave_name
211
 
        Descriptive name of this weave; typically the filename if known.
212
 
        Set by read_weave.
 
152
        List of hex SHA-1 of each version, or None if not recorded.
213
153
    """
214
 
 
215
 
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
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__()
227
 
        self._weave = []
228
 
        self._parents = []
 
154
    def __init__(self):
 
155
        self._l = []
 
156
        self._v = []
229
157
        self._sha1s = []
230
 
        self._names = []
231
 
        self._name_map = {}
232
 
        self._weave_name = weave_name
233
 
        if matcher is None:
234
 
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
 
        else:
236
 
            self._matcher = matcher
237
 
        if get_scope is None:
238
 
            get_scope = lambda:None
239
 
        self._get_scope = get_scope
240
 
        self._scope = get_scope()
241
 
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
 
 
244
 
    def __repr__(self):
245
 
        return "Weave(%r)" % self._weave_name
246
 
 
247
 
    def _check_write_ok(self):
248
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
249
 
        if self._get_scope() != self._scope:
250
 
            raise errors.OutSideTransaction()
251
 
        if self._access_mode != 'w':
252
 
            raise errors.ReadOnlyObjectDirtiedError(self)
253
 
 
254
 
    def copy(self):
255
 
        """Return a deep copy of self.
256
 
 
257
 
        The copy can be modified without affecting the original weave."""
258
 
        other = Weave()
259
 
        other._weave = self._weave[:]
260
 
        other._parents = self._parents[:]
261
 
        other._sha1s = self._sha1s[:]
262
 
        other._names = self._names[:]
263
 
        other._name_map = self._name_map.copy()
264
 
        other._weave_name = self._weave_name
265
 
        return other
 
158
 
266
159
 
267
160
    def __eq__(self, other):
268
161
        if not isinstance(other, Weave):
269
162
            return False
270
 
        return self._parents == other._parents \
271
 
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
 
163
        return self._v == other._v \
 
164
               and self._l == other._l
 
165
    
273
166
 
274
167
    def __ne__(self, other):
275
168
        return not self.__eq__(other)
276
169
 
277
 
    def _idx_to_name(self, version):
278
 
        return self._names[version]
279
 
 
280
 
    def _lookup(self, name):
281
 
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
284
 
        try:
285
 
            return self._name_map[name]
286
 
        except KeyError:
287
 
            raise RevisionNotPresent(name, self._weave_name)
288
 
 
289
 
    def versions(self):
290
 
        """See VersionedFile.versions."""
291
 
        return self._names[:]
292
 
 
293
 
    def has_version(self, version_id):
294
 
        """See VersionedFile.has_version."""
295
 
        return (version_id in self._name_map)
296
 
 
297
 
    __contains__ = has_version
298
 
 
299
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
300
 
        """Get a stream of records for versions.
301
 
 
302
 
        :param versions: The versions to include. Each version is a tuple
303
 
            (version,).
304
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
305
 
            sorted stream has compression parents strictly before their
306
 
            children.
307
 
        :param include_delta_closure: If True then the closure across any
308
 
            compression parents will be included (in the opaque data).
309
 
        :return: An iterator of ContentFactory objects, each of which is only
310
 
            valid until the iterator is advanced.
311
 
        """
312
 
        versions = [version[-1] for version in versions]
313
 
        if ordering == 'topological':
314
 
            parents = self.get_parent_map(versions)
315
 
            new_versions = tsort.topo_sort(parents)
316
 
            new_versions.extend(set(versions).difference(set(parents)))
317
 
            versions = new_versions
318
 
        elif ordering == 'groupcompress':
319
 
            parents = self.get_parent_map(versions)
320
 
            new_versions = sort_groupcompress(parents)
321
 
            new_versions.extend(set(versions).difference(set(parents)))
322
 
            versions = new_versions
323
 
        for version in versions:
324
 
            if version in self:
325
 
                yield WeaveContentFactory(version, self)
326
 
            else:
327
 
                yield AbsentContentFactory((version,))
328
 
 
329
 
    def get_parent_map(self, version_ids):
330
 
        """See VersionedFile.get_parent_map."""
331
 
        result = {}
332
 
        for version_id in version_ids:
333
 
            if version_id == NULL_REVISION:
334
 
                parents = ()
335
 
            else:
336
 
                try:
337
 
                    parents = tuple(
338
 
                        map(self._idx_to_name,
339
 
                            self._parents[self._lookup(version_id)]))
340
 
                except RevisionNotPresent:
341
 
                    continue
342
 
            result[version_id] = parents
343
 
        return result
344
 
 
345
 
    def get_parents_with_ghosts(self, version_id):
346
 
        raise NotImplementedError(self.get_parents_with_ghosts)
347
 
 
348
 
    def insert_record_stream(self, stream):
349
 
        """Insert a record stream into this versioned file.
350
 
 
351
 
        :param stream: A stream of records to insert.
352
 
        :return: None
353
 
        :seealso VersionedFile.get_record_stream:
354
 
        """
355
 
        adapters = {}
356
 
        for record in stream:
357
 
            # Raise an error when a record is missing.
358
 
            if record.storage_kind == 'absent':
359
 
                raise RevisionNotPresent([record.key[0]], self)
360
 
            # adapt to non-tuple interface
361
 
            parents = [parent[0] for parent in record.parents]
362
 
            if (record.storage_kind == 'fulltext'
363
 
                or record.storage_kind == 'chunked'):
364
 
                self.add_lines(record.key[0], parents,
365
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
366
 
            else:
367
 
                adapter_key = record.storage_kind, 'fulltext'
368
 
                try:
369
 
                    adapter = adapters[adapter_key]
370
 
                except KeyError:
371
 
                    adapter_factory = adapter_registry.get(adapter_key)
372
 
                    adapter = adapter_factory(self)
373
 
                    adapters[adapter_key] = adapter
374
 
                lines = split_lines(adapter.get_bytes(record))
375
 
                try:
376
 
                    self.add_lines(record.key[0], parents, lines)
377
 
                except RevisionAlreadyPresent:
378
 
                    pass
379
 
 
380
 
    def _check_repeated_add(self, name, parents, text, sha1):
381
 
        """Check that a duplicated add is OK.
382
 
 
383
 
        If it is, return the (old) index; otherwise raise an exception.
384
 
        """
385
 
        idx = self._lookup(name)
386
 
        if sorted(self._parents[idx]) != sorted(parents) \
387
 
            or sha1 != self._sha1s[idx]:
388
 
            raise RevisionAlreadyPresent(name, self._weave_name)
389
 
        return idx
390
 
 
391
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
392
 
       left_matching_blocks, nostore_sha, random_id, check_content):
393
 
        """See VersionedFile.add_lines."""
394
 
        idx = self._add(version_id, lines, map(self._lookup, parents),
395
 
            nostore_sha=nostore_sha)
396
 
        return sha_strings(lines), sum(map(len, lines)), idx
397
 
 
398
 
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
 
170
        
 
171
    def add(self, parents, text):
399
172
        """Add a single text on top of the weave.
400
 
 
 
173
  
401
174
        Returns the index number of the newly added version.
402
175
 
403
 
        version_id
404
 
            Symbolic name for this version.
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)
407
 
 
408
176
        parents
409
177
            List or set of direct parent version numbers.
410
 
 
411
 
        lines
412
 
            Sequence of lines to be added in the new version.
413
 
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
415
 
        """
416
 
        self._check_lines_not_unicode(lines)
417
 
        self._check_lines_are_lines(lines)
418
 
        if not sha1:
419
 
            sha1 = sha_strings(lines)
420
 
        if sha1 == nostore_sha:
421
 
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
 
        if version_id in self._name_map:
425
 
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
 
 
427
 
        self._check_versions(parents)
428
 
        ## self._check_lines(lines)
429
 
        new_version = len(self._parents)
430
 
 
431
 
        # if we abort after here the (in-memory) weave will be corrupt because only
432
 
        # some fields are updated
433
 
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
434
 
        #      - Robert Collins 20060226
435
 
        self._parents.append(parents[:])
 
178
            
 
179
        text
 
180
            Sequence of lines to be added in the new version."""
 
181
        ## self._check_versions(parents)
 
182
        ## self._check_lines(text)
 
183
        idx = len(self._v)
 
184
 
 
185
        import sha
 
186
        s = sha.new()
 
187
        for l in text:
 
188
            s.update(l)
 
189
        sha1 = s.hexdigest()
 
190
        del s
 
191
 
 
192
        # TODO: It'd probably be faster to append things on to a new
 
193
        # list rather than modifying the existing one, which is likely
 
194
        # to cause a lot of copying.
 
195
 
 
196
        if parents:
 
197
            ancestors = self.inclusions(parents)
 
198
            delta = self._delta(ancestors, text)
 
199
 
 
200
            # offset gives the number of lines that have been inserted
 
201
            # into the weave up to the current point; if the original edit instruction
 
202
            # says to change line A then we actually change (A+offset)
 
203
            offset = 0
 
204
 
 
205
            for i1, i2, newlines in delta:
 
206
                assert 0 <= i1
 
207
                assert i1 <= i2
 
208
                assert i2 <= len(self._l)
 
209
 
 
210
                # the deletion and insertion are handled separately.
 
211
                # first delete the region.
 
212
                if i1 != i2:
 
213
                    self._l.insert(i1+offset, ('[', idx))
 
214
                    self._l.insert(i2+offset+1, (']', idx))
 
215
                    offset += 2
 
216
                    # is this OK???
 
217
 
 
218
                if newlines:
 
219
                    # there may have been a deletion spanning up to
 
220
                    # i2; we want to insert after this region to make sure
 
221
                    # we don't destroy ourselves
 
222
                    i = i2 + offset
 
223
                    self._l[i:i] = [('{', idx)] \
 
224
                                   + newlines \
 
225
                                   + [('}', idx)]
 
226
                    offset += 2 + len(newlines)
 
227
 
 
228
            self._addversion(parents)
 
229
        else:
 
230
            # special case; adding with no parents revision; can do this
 
231
            # more quickly by just appending unconditionally
 
232
            self._l.append(('{', idx))
 
233
            self._l += text
 
234
            self._l.append(('}', idx))
 
235
 
 
236
            self._addversion(None)
 
237
 
436
238
        self._sha1s.append(sha1)
437
 
        self._names.append(version_id)
438
 
        self._name_map[version_id] = new_version
439
 
 
440
 
 
441
 
        if not parents:
442
 
            # special case; adding with no parents revision; can do
443
 
            # this more quickly by just appending unconditionally.
444
 
            # even more specially, if we're adding an empty text we
445
 
            # need do nothing at all.
446
 
            if lines:
447
 
                self._weave.append(('{', new_version))
448
 
                self._weave.extend(lines)
449
 
                self._weave.append(('}', None))
450
 
            return new_version
451
 
 
452
 
        if len(parents) == 1:
453
 
            pv = list(parents)[0]
454
 
            if sha1 == self._sha1s[pv]:
455
 
                # special case: same as the single parent
456
 
                return new_version
457
 
 
458
 
 
459
 
        ancestors = self._inclusions(parents)
460
 
 
461
 
        l = self._weave
462
 
 
463
 
        # basis a list of (origin, lineno, line)
464
 
        basis_lineno = []
465
 
        basis_lines = []
466
 
        for origin, lineno, line in self._extract(ancestors):
467
 
            basis_lineno.append(lineno)
468
 
            basis_lines.append(line)
469
 
 
470
 
        # another small special case: a merge, producing the same text
471
 
        # as auto-merge
472
 
        if lines == basis_lines:
473
 
            return new_version
474
 
 
475
 
        # add a sentinel, because we can also match against the final line
476
 
        basis_lineno.append(len(self._weave))
477
 
 
478
 
        # XXX: which line of the weave should we really consider
479
 
        # matches the end of the file?  the current code says it's the
480
 
        # last line of the weave?
481
 
 
482
 
        #print 'basis_lines:', basis_lines
483
 
        #print 'new_lines:  ', lines
484
 
 
485
 
        s = self._matcher(None, basis_lines, lines)
486
 
 
487
 
        # offset gives the number of lines that have been inserted
488
 
        # into the weave up to the current point; if the original edit instruction
489
 
        # says to change line A then we actually change (A+offset)
490
 
        offset = 0
491
 
 
492
 
        for tag, i1, i2, j1, j2 in s.get_opcodes():
493
 
            # i1,i2 are given in offsets within basis_lines; we need to map them
494
 
            # back to offsets within the entire weave
495
 
            #print 'raw match', tag, i1, i2, j1, j2
496
 
            if tag == 'equal':
497
 
                continue
498
 
            i1 = basis_lineno[i1]
499
 
            i2 = basis_lineno[i2]
500
 
            # the deletion and insertion are handled separately.
501
 
            # first delete the region.
502
 
            if i1 != i2:
503
 
                self._weave.insert(i1+offset, ('[', new_version))
504
 
                self._weave.insert(i2+offset+1, (']', new_version))
505
 
                offset += 2
506
 
 
507
 
            if j1 != j2:
508
 
                # there may have been a deletion spanning up to
509
 
                # i2; we want to insert after this region to make sure
510
 
                # we don't destroy ourselves
511
 
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
514
 
                                    + [('}', None)])
515
 
                offset += 2 + (j2 - j1)
516
 
        return new_version
517
 
 
518
 
    def _inclusions(self, versions):
 
239
            
 
240
        return idx
 
241
 
 
242
 
 
243
    def inclusions_bitset(self, versions):
 
244
        i = 0
 
245
        for v in versions:
 
246
            i |= (1L << v)
 
247
        v = max(versions)
 
248
        while v >= 0:
 
249
            if i & (1L << v):
 
250
                # if v is included, include all its parents
 
251
                for pv in self._v[v]:
 
252
                    i |= (1L << pv)
 
253
            v -= 1
 
254
        return i
 
255
 
 
256
 
 
257
    def inclusions(self, versions):
519
258
        """Return set of all ancestors of given version(s)."""
520
 
        if not len(versions):
 
259
        i = set(versions)
 
260
        v = max(versions)
 
261
        try:
 
262
            while v >= 0:
 
263
                if v in i:
 
264
                    # include all its parents
 
265
                    i.update(self._v[v])
 
266
                v -= 1
 
267
            return i
 
268
        except IndexError:
 
269
            raise ValueError("version %d not present in weave" % v)
 
270
 
 
271
 
 
272
    def minimal_parents(self, version):
 
273
        """Find the minimal set of parents for the version."""
 
274
        included = self._v[version]
 
275
        if not included:
521
276
            return []
522
 
        i = set(versions)
523
 
        for v in xrange(max(versions), 0, -1):
524
 
            if v in i:
525
 
                # include all its parents
526
 
                i.update(self._parents[v])
527
 
        return i
528
 
        ## except IndexError:
529
 
        ##     raise ValueError("version %d not present in weave" % v)
530
 
 
531
 
    def get_ancestry(self, version_ids, topo_sorted=True):
532
 
        """See VersionedFile.get_ancestry."""
533
 
        if isinstance(version_ids, basestring):
534
 
            version_ids = [version_ids]
535
 
        i = self._inclusions([self._lookup(v) for v in version_ids])
536
 
        return [self._idx_to_name(v) for v in i]
 
277
        
 
278
        li = list(included)
 
279
        li.sort(reverse=True)
 
280
 
 
281
        mininc = []
 
282
        gotit = set()
 
283
 
 
284
        for pv in li:
 
285
            if pv not in gotit:
 
286
                mininc.append(pv)
 
287
                gotit.update(self.inclusions(pv))
 
288
 
 
289
        assert mininc[0] >= 0
 
290
        assert mininc[-1] < version
 
291
        return mininc
 
292
 
 
293
 
 
294
    def _addversion(self, parents):
 
295
        if parents:
 
296
            self._v.append(parents)
 
297
        else:
 
298
            self._v.append(frozenset())
 
299
 
537
300
 
538
301
    def _check_lines(self, text):
539
302
        if not isinstance(text, list):
543
306
            if not isinstance(l, basestring):
544
307
                raise ValueError("text line should be a string or unicode, not %s"
545
308
                                 % type(l))
546
 
 
 
309
        
547
310
 
548
311
 
549
312
    def _check_versions(self, indexes):
550
313
        """Check everything in the sequence of indexes is valid"""
551
314
        for i in indexes:
552
315
            try:
553
 
                self._parents[i]
 
316
                self._v[i]
554
317
            except IndexError:
555
318
                raise IndexError("invalid version number %r" % i)
556
319
 
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.
 
320
    
 
321
    def annotate(self, index):
 
322
        return list(self.annotate_iter(index))
 
323
 
 
324
 
 
325
    def annotate_iter(self, version):
 
326
        """Yield list of (index-id, line) pairs for the specified version.
567
327
 
568
328
        The index indicates when the line originated in the weave."""
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
 
329
        for origin, lineno, text in self._extract([version]):
 
330
            yield origin, text
 
331
 
 
332
 
 
333
    def _walk(self):
 
334
        """Walk the weave.
 
335
 
 
336
        Yields sequence of
 
337
        (lineno, insert, deletes, text)
 
338
        for each literal line.
 
339
        """
 
340
        
 
341
        istack = []
 
342
        dset = 0L
 
343
 
 
344
        lineno = 0         # line of weave, 0-based
 
345
 
 
346
        for l in self._l:
 
347
            if isinstance(l, tuple):
 
348
                c, v = l
 
349
                isactive = None
 
350
                if c == '{':
 
351
                    istack.append(v)
 
352
                elif c == '}':
 
353
                    oldv = istack.pop()
 
354
                elif c == '[':
 
355
                    vs = (1L << v)
 
356
                    assert not (dset & vs)
 
357
                    dset |= vs
 
358
                elif c == ']':
 
359
                    vs = (1L << v)
 
360
                    assert dset & vs
 
361
                    dset ^= vs
 
362
                else:
 
363
                    raise WeaveFormatError('unexpected instruction %r'
 
364
                                           % v)
583
365
            else:
584
 
                yield line, inserted
585
 
 
586
 
    def _walk_internal(self, version_ids=None):
587
 
        """Helper method for weave actions."""
 
366
                assert isinstance(l, basestring)
 
367
                assert istack
 
368
                yield lineno, istack[-1], dset, l
 
369
            lineno += 1
 
370
 
 
371
 
 
372
 
 
373
    def _extract(self, versions):
 
374
        """Yield annotation of lines in included set.
 
375
 
 
376
        Yields a sequence of tuples (origin, lineno, text), where
 
377
        origin is the origin version, lineno the index in the weave,
 
378
        and text the text of the line.
 
379
 
 
380
        The set typically but not necessarily corresponds to a version.
 
381
        """
 
382
        included = self.inclusions(versions)
588
383
 
589
384
        istack = []
590
385
        dset = set()
591
386
 
592
387
        lineno = 0         # line of weave, 0-based
593
388
 
594
 
        for l in self._weave:
595
 
            if l.__class__ == tuple:
 
389
        isactive = None
 
390
 
 
391
        WFE = WeaveFormatError
 
392
 
 
393
        for l in self._l:
 
394
            if isinstance(l, tuple):
596
395
                c, v = l
597
396
                isactive = None
598
397
                if c == '{':
599
 
                    istack.append(self._names[v])
 
398
                    assert v not in istack
 
399
                    istack.append(v)
600
400
                elif c == '}':
601
 
                    istack.pop()
 
401
                    oldv = istack.pop()
 
402
                    assert oldv == v
602
403
                elif c == '[':
603
 
                    dset.add(self._names[v])
604
 
                elif c == ']':
605
 
                    dset.remove(self._names[v])
 
404
                    if v in included:
 
405
                        assert v not in dset
 
406
                        dset.add(v)
606
407
                else:
607
 
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
408
                    assert c == ']'
 
409
                    if v in included:
 
410
                        assert v in dset
 
411
                        dset.remove(v)
608
412
            else:
609
 
                yield lineno, istack[-1], frozenset(dset), l
 
413
                assert isinstance(l, basestring)
 
414
                if isactive is None:
 
415
                    isactive = (not dset) and istack and (istack[-1] in included)
 
416
                if isactive:
 
417
                    yield istack[-1], lineno, l
610
418
            lineno += 1
611
419
 
612
420
        if istack:
613
 
            raise WeaveFormatError("unclosed insertion blocks "
614
 
                    "at end of weave: %s" % istack)
 
421
            raise WFE("unclosed insertion blocks at end of weave",
 
422
                                   istack)
615
423
        if dset:
616
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
617
 
                                   % dset)
618
 
 
 
424
            raise WFE("unclosed deletion blocks at end of weave",
 
425
                                   dset)
 
426
 
 
427
 
 
428
    def get_iter(self, version):
 
429
        """Yield lines for the specified version."""
 
430
        for origin, lineno, line in self._extract([version]):
 
431
            yield line
 
432
 
 
433
 
 
434
    def get(self, index):
 
435
        return list(self.get_iter(index))
 
436
 
 
437
 
 
438
    def mash_iter(self, included):
 
439
        """Return composed version of multiple included versions."""
 
440
        included = frozenset(included)
 
441
        for origin, lineno, text in self._extract(included):
 
442
            yield text
 
443
 
 
444
 
 
445
    def dump(self, to_file):
 
446
        from pprint import pprint
 
447
        print >>to_file, "Weave._l = ",
 
448
        pprint(self._l, to_file)
 
449
        print >>to_file, "Weave._v = ",
 
450
        pprint(self._v, to_file)
 
451
 
 
452
 
 
453
 
 
454
    def numversions(self):
 
455
        l = len(self._v)
 
456
        assert l == len(self._sha1s)
 
457
        return l
 
458
 
 
459
 
 
460
    def check(self, progress_bar=None):
 
461
        # check no circular inclusions
 
462
        for version in range(self.numversions()):
 
463
            inclusions = list(self._v[version])
 
464
            if inclusions:
 
465
                inclusions.sort()
 
466
                if inclusions[-1] >= version:
 
467
                    raise WeaveFormatError("invalid included version %d for index %d"
 
468
                                           % (inclusions[-1], version))
 
469
 
 
470
        # try extracting all versions; this is a bit slow and parallel
 
471
        # extraction could be used
 
472
        import sha
 
473
        nv = self.numversions()
 
474
        for version in range(nv):
 
475
            if progress_bar:
 
476
                progress_bar.update('checking text', version, nv)
 
477
            s = sha.new()
 
478
            for l in self.get_iter(version):
 
479
                s.update(l)
 
480
            hd = s.hexdigest()
 
481
            expected = self._sha1s[version]
 
482
            if hd != expected:
 
483
                raise WeaveError("mismatched sha1 for version %d; "
 
484
                                 "got %s, expected %s"
 
485
                                 % (version, hd, expected))
 
486
 
 
487
        # TODO: check insertions are properly nested, that there are
 
488
        # no lines outside of insertion blocks, that deletions are
 
489
        # properly paired, etc.
 
490
 
 
491
 
 
492
 
 
493
    def merge(self, merge_versions):
 
494
        """Automerge and mark conflicts between versions.
 
495
 
 
496
        This returns a sequence, each entry describing alternatives
 
497
        for a chunk of the file.  Each of the alternatives is given as
 
498
        a list of lines.
 
499
 
 
500
        If there is a chunk of the file where there's no diagreement,
 
501
        only one alternative is given.
 
502
        """
 
503
 
 
504
        # approach: find the included versions common to all the
 
505
        # merged versions
 
506
        raise NotImplementedError()
 
507
 
 
508
 
 
509
 
 
510
    def _delta(self, included, lines):
 
511
        """Return changes from basis to new revision.
 
512
 
 
513
        The old text for comparison is the union of included revisions.
 
514
 
 
515
        This is used in inserting a new text.
 
516
 
 
517
        Delta is returned as a sequence of
 
518
        (weave1, weave2, newlines).
 
519
 
 
520
        This indicates that weave1:weave2 of the old weave should be
 
521
        replaced by the sequence of lines in newlines.  Note that
 
522
        these line numbers are positions in the total weave and don't
 
523
        correspond to the lines in any extracted version, or even the
 
524
        extracted union of included versions.
 
525
 
 
526
        If line1=line2, this is a pure insert; if newlines=[] this is a
 
527
        pure delete.  (Similar to difflib.)
 
528
        """
 
529
        # basis a list of (origin, lineno, line)
 
530
        basis_lineno = []
 
531
        basis_lines = []
 
532
        for origin, lineno, line in self._extract(included):
 
533
            basis_lineno.append(lineno)
 
534
            basis_lines.append(line)
 
535
 
 
536
        # add a sentinal, because we can also match against the final line
 
537
        basis_lineno.append(len(self._l))
 
538
 
 
539
        # XXX: which line of the weave should we really consider
 
540
        # matches the end of the file?  the current code says it's the
 
541
        # last line of the weave?
 
542
 
 
543
        from difflib import SequenceMatcher
 
544
        s = SequenceMatcher(None, basis_lines, lines)
 
545
 
 
546
        # TODO: Perhaps return line numbers from composed weave as well?
 
547
 
 
548
        for tag, i1, i2, j1, j2 in s.get_opcodes():
 
549
            ##print tag, i1, i2, j1, j2
 
550
 
 
551
            if tag == 'equal':
 
552
                continue
 
553
 
 
554
            # i1,i2 are given in offsets within basis_lines; we need to map them
 
555
            # back to offsets within the entire weave
 
556
            real_i1 = basis_lineno[i1]
 
557
            real_i2 = basis_lineno[i2]
 
558
 
 
559
            assert 0 <= j1
 
560
            assert j1 <= j2
 
561
            assert j2 <= len(lines)
 
562
 
 
563
            yield real_i1, real_i2, lines[j1:j2]
 
564
 
 
565
 
 
566
            
619
567
    def plan_merge(self, ver_a, ver_b):
620
568
        """Return pseudo-annotation indicating how the two versions merge.
621
569
 
624
572
 
625
573
        Weave lines present in none of them are skipped entirely.
626
574
        """
627
 
        inc_a = set(self.get_ancestry([ver_a]))
628
 
        inc_b = set(self.get_ancestry([ver_b]))
 
575
        inc_a = self.inclusions_bitset([ver_a])
 
576
        inc_b = self.inclusions_bitset([ver_b])
629
577
        inc_c = inc_a & inc_b
630
578
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
579
        for lineno, insert, deleteset, line in self._walk():
 
580
            insertset = (1L << insert)
632
581
            if deleteset & inc_c:
633
582
                # killed in parent; can't be in either a or b
634
583
                # not relevant to our work
635
584
                yield 'killed-base', line
636
 
            elif insert in inc_c:
 
585
            elif insertset & inc_c:
637
586
                # was inserted in base
638
587
                killed_a = bool(deleteset & inc_a)
639
588
                killed_b = bool(deleteset & inc_b)
645
594
                    yield 'killed-b', line
646
595
                else:
647
596
                    yield 'unchanged', line
648
 
            elif insert in inc_a:
 
597
            elif insertset & inc_a:
649
598
                if deleteset & inc_a:
650
599
                    yield 'ghost-a', line
651
600
                else:
652
601
                    # new in A; not in B
653
602
                    yield 'new-a', line
654
 
            elif insert in inc_b:
 
603
            elif insertset & inc_b:
655
604
                if deleteset & inc_b:
656
605
                    yield 'ghost-b', line
657
606
                else:
660
609
                # not in either revision
661
610
                yield 'irrelevant', line
662
611
 
663
 
    def _extract(self, versions):
664
 
        """Yield annotation of lines in included set.
665
 
 
666
 
        Yields a sequence of tuples (origin, lineno, text), where
667
 
        origin is the origin version, lineno the index in the weave,
668
 
        and text the text of the line.
669
 
 
670
 
        The set typically but not necessarily corresponds to a version.
671
 
        """
672
 
        for i in versions:
673
 
            if not isinstance(i, int):
674
 
                raise ValueError(i)
675
 
 
676
 
        included = self._inclusions(versions)
677
 
 
678
 
        istack = []
679
 
        iset = set()
680
 
        dset = set()
681
 
 
682
 
        lineno = 0         # line of weave, 0-based
683
 
 
684
 
        isactive = None
685
 
 
686
 
        result = []
687
 
 
688
 
        WFE = WeaveFormatError
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
 
 
717
 
        for l in self._weave:
718
 
            if l.__class__ == tuple:
719
 
                c, v = l
720
 
                isactive = None
721
 
                if c == '{':
722
 
                    istack.append(v)
723
 
                    iset.add(v)
724
 
                elif c == '}':
725
 
                    iset.remove(istack.pop())
726
 
                elif c == '[':
727
 
                    if v in included:
728
 
                        dset.add(v)
729
 
                elif c == ']':
730
 
                    if v in included:
731
 
                        dset.remove(v)
 
612
        yield 'unchanged', ''           # terminator
 
613
 
 
614
 
 
615
 
 
616
    def weave_merge(self, plan):
 
617
        lines_a = []
 
618
        lines_b = []
 
619
        ch_a = ch_b = False
 
620
 
 
621
        for state, line in plan:
 
622
            if state == 'unchanged' or state == 'killed-both':
 
623
                # resync and flush queued conflicts changes if any
 
624
                if not lines_a and not lines_b:
 
625
                    pass
 
626
                elif ch_a and not ch_b:
 
627
                    # one-sided change:                    
 
628
                    for l in lines_a: yield l
 
629
                elif ch_b and not ch_a:
 
630
                    for l in lines_b: yield l
 
631
                elif lines_a == lines_b:
 
632
                    for l in lines_a: yield l
732
633
                else:
733
 
                    raise AssertionError()
734
 
            else:
735
 
                if isactive is None:
736
 
                    isactive = (not dset) and istack and (istack[-1] in included)
737
 
                if isactive:
738
 
                    result.append((istack[-1], lineno, l))
739
 
            lineno += 1
740
 
        if istack:
741
 
            raise WeaveFormatError("unclosed insertion blocks "
742
 
                    "at end of weave: %s" % istack)
743
 
        if dset:
744
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
745
 
                                   % dset)
746
 
        return result
747
 
 
748
 
    def _maybe_lookup(self, name_or_index):
749
 
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
751
 
        NOT FOR PUBLIC USE.
752
 
        """
753
 
        if isinstance(name_or_index, (int, long)):
754
 
            return name_or_index
755
 
        else:
756
 
            return self._lookup(name_or_index)
757
 
 
758
 
    def get_lines(self, version_id):
759
 
        """See VersionedFile.get_lines()."""
760
 
        int_index = self._maybe_lookup(version_id)
761
 
        result = [line for (origin, lineno, line) in self._extract([int_index])]
762
 
        expected_sha1 = self._sha1s[int_index]
763
 
        measured_sha1 = sha_strings(result)
764
 
        if measured_sha1 != expected_sha1:
765
 
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
767
 
                    % (self._weave_name, version_id,
768
 
                       expected_sha1, measured_sha1))
769
 
        return result
770
 
 
771
 
    def get_sha1s(self, version_ids):
772
 
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
777
 
 
778
 
    def num_versions(self):
779
 
        """How many versions are in this weave?"""
780
 
        l = len(self._parents)
781
 
        return l
782
 
 
783
 
    __len__ = num_versions
784
 
 
785
 
    def check(self, progress_bar=None):
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()):
790
 
            inclusions = list(self._parents[version])
791
 
            if inclusions:
792
 
                inclusions.sort()
793
 
                if inclusions[-1] >= version:
794
 
                    raise WeaveFormatError("invalid included version %d for index %d"
795
 
                                           % (inclusions[-1], version))
796
 
 
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():
827
 
            if progress_bar:
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]
841
 
            if hd != expected:
842
 
                raise errors.WeaveInvalidChecksum(
843
 
                        "mismatched sha1 for version %s: "
844
 
                        "got %s, expected %s"
845
 
                        % (version, hd, expected))
846
 
 
847
 
        # TODO: check insertions are properly nested, that there are
848
 
        # no lines outside of insertion blocks, that deletions are
849
 
        # properly paired, etc.
850
 
 
851
 
    def _imported_parents(self, other, other_idx):
852
 
        """Return list of parents in self corresponding to indexes in other."""
853
 
        new_parents = []
854
 
        for parent_idx in other._parents[other_idx]:
855
 
            parent_name = other._names[parent_idx]
856
 
            if parent_name not in self._name_map:
857
 
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
859
 
                                 % (parent_name, other._name_map[other_idx], self))
860
 
            new_parents.append(self._name_map[parent_name])
861
 
        return new_parents
862
 
 
863
 
    def _check_version_consistent(self, other, other_idx, name):
864
 
        """Check if a version in consistent in this and other.
865
 
 
866
 
        To be consistent it must have:
867
 
 
868
 
         * the same text
869
 
         * the same direct parents (by name, not index, and disregarding
870
 
           order)
871
 
 
872
 
        If present & correct return True;
873
 
        if not present in self return False;
874
 
        if inconsistent raise error."""
875
 
        this_idx = self._name_map.get(name, -1)
876
 
        if this_idx != -1:
877
 
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
878
 
                raise errors.WeaveTextDiffers(name, self, other)
879
 
            self_parents = self._parents[this_idx]
880
 
            other_parents = other._parents[other_idx]
881
 
            n1 = set([self._names[i] for i in self_parents])
882
 
            n2 = set([other._names[i] for i in other_parents])
883
 
            if not self._compatible_parents(n1, n2):
884
 
                raise WeaveParentMismatch("inconsistent parents "
885
 
                    "for version {%s}: %s vs %s" % (name, n1, n2))
886
 
            else:
887
 
                return True         # ok!
888
 
        else:
889
 
            return False
890
 
 
891
 
    def _reweave(self, other, pb, msg):
892
 
        """Reweave self with other - internal helper for join().
893
 
 
894
 
        :param other: The other weave to merge
895
 
        :param pb: An optional progress bar, indicating how far done we are
896
 
        :param msg: An optional message for the progress
897
 
        """
898
 
        new_weave = _reweave(self, other, pb=pb, msg=msg)
899
 
        self._copy_weave_content(new_weave)
900
 
 
901
 
    def _copy_weave_content(self, otherweave):
902
 
        """adsorb the content from otherweave."""
903
 
        for attr in self.__slots__:
904
 
            if attr != '_weave_name':
905
 
                setattr(self, attr, copy(getattr(otherweave, attr)))
906
 
 
907
 
 
908
 
class WeaveFile(Weave):
909
 
    """A WeaveFile represents a Weave on disk and writes on change."""
910
 
 
911
 
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
914
 
        """Create a WeaveFile.
915
 
 
916
 
        :param create: If not True, only open an existing knit.
917
 
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
920
 
        self._transport = transport
921
 
        self._filemode = filemode
922
 
        try:
923
 
            _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):
973
 
    """Combine two weaves and return the result.
974
 
 
975
 
    This works even if a revision R has different parents in
976
 
    wa and wb.  In the resulting weave all the parents are given.
977
 
 
978
 
    This is done by just building up a new weave, maintaining ordering
979
 
    of the versions in the two inputs.  More efficient approaches
980
 
    might be possible but it should only be necessary to do
981
 
    this operation rarely, when a new previously ghost version is
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
986
 
    """
987
 
    wr = Weave()
988
 
    ia = ib = 0
989
 
    queue_a = range(wa.num_versions())
990
 
    queue_b = range(wb.num_versions())
991
 
    # first determine combined parents of all versions
992
 
    # map from version name -> all parent names
993
 
    combined_parents = _reweave_parent_graphs(wa, wb)
994
 
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
996
 
    mutter("order to reweave: %r", 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))
1004
 
        if name in wa._name_map:
1005
 
            lines = wa.get_lines(name)
1006
 
            if name in wb._name_map:
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)
1016
 
        else:
1017
 
            lines = wb.get_lines(name)
1018
 
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
 
    return wr
1020
 
 
1021
 
 
1022
 
def _reweave_parent_graphs(wa, wb):
1023
 
    """Return combined parent ancestry for two weaves.
1024
 
 
1025
 
    Returned as a list of (version_name, set(parent_names))"""
1026
 
    combined = {}
1027
 
    for weave in [wa, wb]:
1028
 
        for idx, name in enumerate(weave._names):
1029
 
            p = combined.setdefault(name, set())
1030
 
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
 
    return combined
 
634
                    yield '<<<<\n'
 
635
                    for l in lines_a: yield l
 
636
                    yield '====\n'
 
637
                    for l in lines_b: yield l
 
638
                    yield '>>>>\n'
 
639
 
 
640
                del lines_a[:]
 
641
                del lines_b[:]
 
642
                ch_a = ch_b = False
 
643
                
 
644
            if state == 'unchanged':
 
645
                if line:
 
646
                    yield line
 
647
            elif state == 'killed-a':
 
648
                ch_a = True
 
649
                lines_b.append(line)
 
650
            elif state == 'killed-b':
 
651
                ch_b = True
 
652
                lines_a.append(line)
 
653
            elif state == 'new-a':
 
654
                ch_a = True
 
655
                lines_a.append(line)
 
656
            elif state == 'new-b':
 
657
                ch_b = True
 
658
                lines_b.append(line)
 
659
            else:
 
660
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
 
661
                                 'killed-both'), \
 
662
                       state
 
663
 
 
664
                
 
665
 
 
666
 
 
667
 
 
668
 
 
669
 
 
670
def weave_info(filename, out):
 
671
    """Show some text information about the weave."""
 
672
    from weavefile import read_weave
 
673
    wf = file(filename, 'rb')
 
674
    w = read_weave(wf)
 
675
    # FIXME: doesn't work on pipes
 
676
    weave_size = wf.tell()
 
677
    print >>out, "weave file size %d bytes" % weave_size
 
678
    print >>out, "weave contains %d versions" % len(w._v)
 
679
 
 
680
    total = 0
 
681
    print '%6s %6s %8s %40s %20s' % ('ver', 'lines', 'bytes', 'sha1', 'parents')
 
682
    for i in (6, 6, 8, 40, 20):
 
683
        print '-' * i,
 
684
    print
 
685
    for i in range(len(w._v)):
 
686
        text = w.get(i)
 
687
        lines = len(text)
 
688
        bytes = sum((len(a) for a in text))
 
689
        sha1 = w._sha1s[i]
 
690
        print '%6d %6d %8d %40s' % (i, lines, bytes, sha1),
 
691
        for pv in w._v[i]:
 
692
            print pv,
 
693
        print
 
694
        total += bytes
 
695
 
 
696
    print >>out, "versions total %d bytes" % total
 
697
    print >>out, "compression ratio %.3f" % (float(total)/float(weave_size))
 
698
 
 
699
 
 
700
def usage():
 
701
    print """bzr weave tool
 
702
 
 
703
Experimental tool for weave algorithm.
 
704
 
 
705
usage:
 
706
    weave init WEAVEFILE
 
707
        Create an empty weave file
 
708
    weave get WEAVEFILE VERSION
 
709
        Write out specified version.
 
710
    weave check WEAVEFILE
 
711
        Check consistency of all versions.
 
712
    weave info WEAVEFILE
 
713
        Display table of contents.
 
714
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
715
        Add NEWTEXT, with specified parent versions.
 
716
    weave annotate WEAVEFILE VERSION
 
717
        Display origin of each line.
 
718
    weave mash WEAVEFILE VERSION...
 
719
        Display composite of all selected versions.
 
720
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
721
        Auto-merge two versions and display conflicts.
 
722
 
 
723
example:
 
724
 
 
725
    % weave init foo.weave
 
726
    % vi foo.txt
 
727
    % weave add foo.weave < foo.txt
 
728
    added version 0
 
729
 
 
730
    (create updated version)
 
731
    % vi foo.txt
 
732
    % weave get foo.weave 0 | diff -u - foo.txt
 
733
    % weave add foo.weave 0 < foo.txt
 
734
    added version 1
 
735
 
 
736
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
737
    % vi foo.txt
 
738
    % weave add foo.weave 0 < foo.txt
 
739
    added version 2
 
740
 
 
741
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
742
    % vi foo.txt                            (resolve conflicts)
 
743
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
744
    
 
745
"""
 
746
    
 
747
 
 
748
 
 
749
def main(argv):
 
750
    import sys
 
751
    import os
 
752
    from weavefile import write_weave, read_weave
 
753
    from bzrlib.progress import ProgressBar
 
754
 
 
755
    #import psyco
 
756
    #psyco.full()
 
757
 
 
758
    cmd = argv[1]
 
759
 
 
760
    def readit():
 
761
        return read_weave(file(argv[2], 'rb'))
 
762
    
 
763
    if cmd == 'help':
 
764
        usage()
 
765
    elif cmd == 'add':
 
766
        w = readit()
 
767
        # at the moment, based on everything in the file
 
768
        parents = map(int, argv[3:])
 
769
        lines = sys.stdin.readlines()
 
770
        ver = w.add(parents, lines)
 
771
        write_weave(w, file(argv[2], 'wb'))
 
772
        print 'added version %d' % ver
 
773
    elif cmd == 'init':
 
774
        fn = argv[2]
 
775
        if os.path.exists(fn):
 
776
            raise IOError("file exists")
 
777
        w = Weave()
 
778
        write_weave(w, file(fn, 'wb'))
 
779
    elif cmd == 'get': # get one version
 
780
        w = readit()
 
781
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
782
        
 
783
    elif cmd == 'mash': # get composite
 
784
        w = readit()
 
785
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
786
 
 
787
    elif cmd == 'annotate':
 
788
        w = readit()
 
789
        # newline is added to all lines regardless; too hard to get
 
790
        # reasonable formatting otherwise
 
791
        lasto = None
 
792
        for origin, text in w.annotate(int(argv[3])):
 
793
            text = text.rstrip('\r\n')
 
794
            if origin == lasto:
 
795
                print '      | %s' % (text)
 
796
            else:
 
797
                print '%5d | %s' % (origin, text)
 
798
                lasto = origin
 
799
                
 
800
    elif cmd == 'info':
 
801
        weave_info(argv[2], sys.stdout)
 
802
        
 
803
    elif cmd == 'check':
 
804
        w = readit()
 
805
        pb = ProgressBar()
 
806
        w.check(pb)
 
807
        pb.clear()
 
808
 
 
809
    elif cmd == 'inclusions':
 
810
        w = readit()
 
811
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
812
 
 
813
    elif cmd == 'parents':
 
814
        w = readit()
 
815
        print ' '.join(map(str, w._v[int(argv[3])]))
 
816
 
 
817
    elif cmd == 'plan-merge':
 
818
        w = readit()
 
819
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
820
            if line:
 
821
                print '%14s | %s' % (state, line),
 
822
 
 
823
    elif cmd == 'merge':
 
824
        w = readit()
 
825
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
826
        sys.stdout.writelines(w.weave_merge(p))
 
827
            
 
828
    elif cmd == 'mash-merge':
 
829
        if len(argv) != 5:
 
830
            usage()
 
831
            return 1
 
832
 
 
833
        w = readit()
 
834
        v1, v2 = map(int, argv[3:5])
 
835
 
 
836
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
 
837
 
 
838
        base_lines = list(w.mash_iter(basis))
 
839
        a_lines = list(w.get(v1))
 
840
        b_lines = list(w.get(v2))
 
841
 
 
842
        from bzrlib.merge3 import Merge3
 
843
        m3 = Merge3(base_lines, a_lines, b_lines)
 
844
 
 
845
        name_a = 'version %d' % v1
 
846
        name_b = 'version %d' % v2
 
847
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
 
848
    else:
 
849
        raise ValueError('unknown command %r' % cmd)
 
850
    
 
851
 
 
852
if __name__ == '__main__':
 
853
    import sys
 
854
    sys.exit(main(sys.argv))