/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: James Westby
  • Date: 2009-04-06 22:31:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4263.
  • Revision ID: james.westby@canonical.com-20090406223135-f7os74eyxlbpxtal
Update the comments based on those in the test.

Show diffs side-by-side

added added

removed removed

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