/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: Andrew Bennetts
  • Date: 2008-09-08 13:35:44 UTC
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080908133544-jqm4r8fw0o6pafn3
Remove or lazyify a couple more imports.

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
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
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 sha
 
75
import time
 
76
import warnings
 
77
 
 
78
from bzrlib.lazy_import import lazy_import
 
79
lazy_import(globals(), """
 
80
from bzrlib import tsort
 
81
""")
 
82
from bzrlib import (
 
83
    progress,
 
84
    )
 
85
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
86
        RevisionAlreadyPresent,
 
87
        RevisionNotPresent,
 
88
        UnavailableRepresentation,
 
89
        WeaveRevisionAlreadyPresent,
 
90
        WeaveRevisionNotPresent,
 
91
        )
 
92
import bzrlib.errors as errors
 
93
from bzrlib.osutils import dirname, 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.tsort import topo_sort
 
99
from bzrlib.versionedfile import (
 
100
    AbsentContentFactory,
 
101
    adapter_registry,
 
102
    ContentFactory,
 
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
        else:
 
128
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
 
129
 
 
130
 
 
131
class Weave(VersionedFile):
90
132
    """weave - versioned text file storage.
91
133
    
92
134
    A Weave manages versions of line-based text files, keeping track
118
160
    The instruction can be '{' or '}' for an insertion block, and '['
119
161
    and ']' for a deletion block respectively.  The version is the
120
162
    integer version index.  There is no replace operator, only deletes
121
 
    and inserts.
 
163
    and inserts.  For '}', the end of an insertion, there is no
 
164
    version parameter because it always closes the most recently
 
165
    opened insertion.
122
166
 
123
167
    Constraints/notes:
124
168
 
160
204
        each version; the parent's parents are implied.
161
205
 
162
206
    _sha1s
163
 
        List of hex SHA-1 of each version, or None if not recorded.
 
207
        List of hex SHA-1 of each version.
 
208
 
 
209
    _names
 
210
        List of symbolic names for each version.  Each should be unique.
 
211
 
 
212
    _name_map
 
213
        For each name, the version number.
 
214
 
 
215
    _weave_name
 
216
        Descriptive name of this weave; typically the filename if known.
 
217
        Set by read_weave.
164
218
    """
165
219
 
166
 
    __slots__ = ['_weave', '_parents', '_sha1s']
 
220
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
221
                 '_weave_name', '_matcher', '_allow_reserved']
167
222
    
168
 
    def __init__(self):
 
223
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
 
224
                 get_scope=None, allow_reserved=False):
 
225
        """Create a weave.
 
226
 
 
227
        :param get_scope: A callable that returns an opaque object to be used
 
228
            for detecting when this weave goes out of scope (should stop
 
229
            answering requests or allowing mutation).
 
230
        """
 
231
        super(Weave, self).__init__(access_mode)
169
232
        self._weave = []
170
233
        self._parents = []
171
234
        self._sha1s = []
172
 
 
 
235
        self._names = []
 
236
        self._name_map = {}
 
237
        self._weave_name = weave_name
 
238
        if matcher is None:
 
239
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
240
        else:
 
241
            self._matcher = matcher
 
242
        if get_scope is None:
 
243
            get_scope = lambda:None
 
244
        self._get_scope = get_scope
 
245
        self._scope = get_scope()
 
246
        self._access_mode = access_mode
 
247
        self._allow_reserved = allow_reserved
 
248
 
 
249
    def __repr__(self):
 
250
        return "Weave(%r)" % self._weave_name
 
251
 
 
252
    def _check_write_ok(self):
 
253
        """Is the versioned file marked as 'finished' ? Raise if it is."""
 
254
        if self._get_scope() != self._scope:
 
255
            raise errors.OutSideTransaction()
 
256
        if self._access_mode != 'w':
 
257
            raise errors.ReadOnlyObjectDirtiedError(self)
 
258
 
 
259
    def copy(self):
 
260
        """Return a deep copy of self.
 
261
        
 
262
        The copy can be modified without affecting the original weave."""
 
263
        other = Weave()
 
264
        other._weave = self._weave[:]
 
265
        other._parents = self._parents[:]
 
266
        other._sha1s = self._sha1s[:]
 
267
        other._names = self._names[:]
 
268
        other._name_map = self._name_map.copy()
 
269
        other._weave_name = self._weave_name
 
270
        return other
173
271
 
174
272
    def __eq__(self, other):
175
273
        if not isinstance(other, Weave):
176
274
            return False
177
275
        return self._parents == other._parents \
178
 
               and self._weave == other._weave
 
276
               and self._weave == other._weave \
 
277
               and self._sha1s == other._sha1s 
179
278
    
180
 
 
181
279
    def __ne__(self, other):
182
280
        return not self.__eq__(other)
183
281
 
184
 
        
185
 
    def add(self, parents, text):
 
282
    def _idx_to_name(self, version):
 
283
        return self._names[version]
 
284
 
 
285
    def _lookup(self, name):
 
286
        """Convert symbolic version name to index."""
 
287
        if not self._allow_reserved:
 
288
            self.check_not_reserved_id(name)
 
289
        try:
 
290
            return self._name_map[name]
 
291
        except KeyError:
 
292
            raise RevisionNotPresent(name, self._weave_name)
 
293
 
 
294
    def versions(self):
 
295
        """See VersionedFile.versions."""
 
296
        return self._names[:]
 
297
 
 
298
    def has_version(self, version_id):
 
299
        """See VersionedFile.has_version."""
 
300
        return (version_id in self._name_map)
 
301
 
 
302
    __contains__ = has_version
 
303
 
 
304
    def get_record_stream(self, versions, ordering, include_delta_closure):
 
305
        """Get a stream of records for versions.
 
306
 
 
307
        :param versions: The versions to include. Each version is a tuple
 
308
            (version,).
 
309
        :param ordering: Either 'unordered' or 'topological'. A topologically
 
310
            sorted stream has compression parents strictly before their
 
311
            children.
 
312
        :param include_delta_closure: If True then the closure across any
 
313
            compression parents will be included (in the opaque data).
 
314
        :return: An iterator of ContentFactory objects, each of which is only
 
315
            valid until the iterator is advanced.
 
316
        """
 
317
        versions = [version[-1] for version in versions]
 
318
        if ordering == 'topological':
 
319
            parents = self.get_parent_map(versions)
 
320
            new_versions = topo_sort(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
                self.add_lines(record.key[0], parents,
 
364
                    split_lines(record.get_bytes_as('fulltext')))
 
365
            else:
 
366
                adapter_key = record.storage_kind, 'fulltext'
 
367
                try:
 
368
                    adapter = adapters[adapter_key]
 
369
                except KeyError:
 
370
                    adapter_factory = adapter_registry.get(adapter_key)
 
371
                    adapter = adapter_factory(self)
 
372
                    adapters[adapter_key] = adapter
 
373
                lines = split_lines(adapter.get_bytes(
 
374
                    record, record.get_bytes_as(record.storage_kind)))
 
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):
186
399
        """Add a single text on top of the weave.
187
400
  
188
401
        Returns the index number of the newly added version.
189
402
 
 
403
        version_id
 
404
            Symbolic name for this version.
 
405
            (Typically the revision-id of the revision that added it.)
 
406
 
190
407
        parents
191
408
            List or set of direct parent version numbers.
192
409
            
193
 
        text
194
 
            Sequence of lines to be added in the new version."""
 
410
        lines
 
411
            Sequence of lines to be added in the new version.
 
412
 
 
413
        :param nostore_sha: See VersionedFile.add_lines.
 
414
        """
 
415
        self._check_lines_not_unicode(lines)
 
416
        self._check_lines_are_lines(lines)
 
417
        if not sha1:
 
418
            sha1 = sha_strings(lines)
 
419
        if sha1 == nostore_sha:
 
420
            raise errors.ExistingContent
 
421
        if version_id in self._name_map:
 
422
            return self._check_repeated_add(version_id, parents, lines, sha1)
195
423
 
196
424
        self._check_versions(parents)
197
 
        ## self._check_lines(text)
 
425
        ## self._check_lines(lines)
198
426
        new_version = len(self._parents)
199
427
 
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))
 
428
        # if we abort after here the (in-memory) weave will be corrupt because only
 
429
        # some fields are updated
 
430
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
431
        #      - Robert Collins 20060226
 
432
        self._parents.append(parents[:])
208
433
        self._sha1s.append(sha1)
 
434
        self._names.append(version_id)
 
435
        self._name_map[version_id] = new_version
209
436
 
210
437
            
211
438
        if not parents:
213
440
            # this more quickly by just appending unconditionally.
214
441
            # even more specially, if we're adding an empty text we
215
442
            # need do nothing at all.
216
 
            if text:
 
443
            if lines:
217
444
                self._weave.append(('{', new_version))
218
 
                self._weave.extend(text)
219
 
                self._weave.append(('}', new_version))
220
 
        
 
445
                self._weave.extend(lines)
 
446
                self._weave.append(('}', None))
221
447
            return new_version
222
448
 
223
449
        if len(parents) == 1:
227
453
                return new_version
228
454
            
229
455
 
230
 
        ancestors = self.inclusions(parents)
 
456
        ancestors = self._inclusions(parents)
231
457
 
232
458
        l = self._weave
233
459
 
238
464
            basis_lineno.append(lineno)
239
465
            basis_lines.append(line)
240
466
 
241
 
        # another small special case: a merge, producing the same text as auto-merge
242
 
        if text == basis_lines:
243
 
            return new_version            
 
467
        # another small special case: a merge, producing the same text
 
468
        # as auto-merge
 
469
        if lines == basis_lines:
 
470
            return new_version
244
471
 
245
 
        # add a sentinal, because we can also match against the final line
 
472
        # add a sentinel, because we can also match against the final line
246
473
        basis_lineno.append(len(self._weave))
247
474
 
248
475
        # XXX: which line of the weave should we really consider
252
479
        #print 'basis_lines:', basis_lines
253
480
        #print 'new_lines:  ', lines
254
481
 
255
 
        from difflib import SequenceMatcher
256
 
        s = SequenceMatcher(None, basis_lines, text)
 
482
        s = self._matcher(None, basis_lines, lines)
257
483
 
258
484
        # offset gives the number of lines that have been inserted
259
485
        # into the weave up to the current point; if the original edit instruction
266
492
            #print 'raw match', tag, i1, i2, j1, j2
267
493
            if tag == 'equal':
268
494
                continue
269
 
 
270
495
            i1 = basis_lineno[i1]
271
496
            i2 = basis_lineno[i2]
272
 
 
273
 
            assert 0 <= j1 <= j2 <= len(text)
274
 
 
275
 
            #print tag, i1, i2, j1, j2
276
 
 
277
497
            # the deletion and insertion are handled separately.
278
498
            # first delete the region.
279
499
            if i1 != i2:
287
507
                # we don't destroy ourselves
288
508
                i = i2 + offset
289
509
                self._weave[i:i] = ([('{', new_version)] 
290
 
                                + text[j1:j2] 
291
 
                                + [('}', new_version)])
 
510
                                    + lines[j1:j2] 
 
511
                                    + [('}', None)])
292
512
                offset += 2 + (j2 - j1)
293
 
 
294
513
        return new_version
295
514
 
296
 
 
297
 
    def inclusions(self, versions):
 
515
    def _inclusions(self, versions):
298
516
        """Return set of all ancestors of given version(s)."""
 
517
        if not len(versions):
 
518
            return []
299
519
        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
 
 
 
520
        for v in xrange(max(versions), 0, -1):
 
521
            if v in i:
 
522
                # include all its parents
 
523
                i.update(self._parents[v])
 
524
        return i
 
525
        ## except IndexError:
 
526
        ##     raise ValueError("version %d not present in weave" % v)
 
527
 
 
528
    def get_ancestry(self, version_ids, topo_sorted=True):
 
529
        """See VersionedFile.get_ancestry."""
 
530
        if isinstance(version_ids, basestring):
 
531
            version_ids = [version_ids]
 
532
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
533
        return [self._idx_to_name(v) for v in i]
334
534
 
335
535
    def _check_lines(self, text):
336
536
        if not isinstance(text, list):
351
551
            except IndexError:
352
552
                raise IndexError("invalid version number %r" % i)
353
553
 
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.
 
554
    def _compatible_parents(self, my_parents, other_parents):
 
555
        """During join check that other_parents are joinable with my_parents.
 
556
 
 
557
        Joinable is defined as 'is a subset of' - supersets may require 
 
558
        regeneration of diffs, but subsets do not.
 
559
        """
 
560
        return len(other_parents.difference(my_parents)) == 0
 
561
 
 
562
    def annotate(self, version_id):
 
563
        """Return a list of (version-id, line) tuples for version_id.
361
564
 
362
565
        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
 
        """
 
566
        incls = [self._lookup(version_id)]
 
567
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
568
            self._extract(incls)]
 
569
 
 
570
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
571
                                                pb=None):
 
572
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
573
        if version_ids is None:
 
574
            version_ids = self.versions()
 
575
        version_ids = set(version_ids)
 
576
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
577
            # if inserted not in version_ids then it was inserted before the
 
578
            # versions we care about, but because weaves cannot represent ghosts
 
579
            # properly, we do not filter down to that
 
580
            # if inserted not in version_ids: continue
 
581
            if line[-1] != '\n':
 
582
                yield line + '\n', inserted
 
583
            else:
 
584
                yield line, inserted
 
585
 
 
586
    def _walk_internal(self, version_ids=None):
 
587
        """Helper method for weave actions."""
374
588
        
375
589
        istack = []
376
590
        dset = set()
378
592
        lineno = 0         # line of weave, 0-based
379
593
 
380
594
        for l in self._weave:
381
 
            if isinstance(l, tuple):
 
595
            if l.__class__ == tuple:
382
596
                c, v = l
383
597
                isactive = None
384
598
                if c == '{':
385
 
                    istack.append(v)
 
599
                    istack.append(self._names[v])
386
600
                elif c == '}':
387
 
                    oldv = istack.pop()
 
601
                    istack.pop()
388
602
                elif c == '[':
389
 
                    assert v not in dset
390
 
                    dset.add(v)
 
603
                    dset.add(self._names[v])
391
604
                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))
 
605
                    dset.remove(self._names[v])
 
606
                else:
 
607
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
608
            else:
 
609
                yield lineno, istack[-1], frozenset(dset), l
451
610
            lineno += 1
452
611
 
453
612
        if istack:
454
 
            raise WFE("unclosed insertion blocks at end of weave",
455
 
                                   istack)
 
613
            raise WeaveFormatError("unclosed insertion blocks "
 
614
                    "at end of weave: %s" % istack)
456
615
        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
 
            
 
616
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
617
                                   % dset)
 
618
 
571
619
    def plan_merge(self, ver_a, ver_b):
572
620
        """Return pseudo-annotation indicating how the two versions merge.
573
621
 
576
624
 
577
625
        Weave lines present in none of them are skipped entirely.
578
626
        """
579
 
        inc_a = self.inclusions([ver_a])
580
 
        inc_b = self.inclusions([ver_b])
 
627
        inc_a = set(self.get_ancestry([ver_a]))
 
628
        inc_b = set(self.get_ancestry([ver_b]))
581
629
        inc_c = inc_a & inc_b
582
630
 
583
 
        for lineno, insert, deleteset, line in self._walk():
 
631
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
584
632
            if deleteset & inc_c:
585
633
                # killed in parent; can't be in either a or b
586
634
                # not relevant to our work
612
660
                # not in either revision
613
661
                yield 'irrelevant', line
614
662
 
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
 
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)
636
732
                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):
 
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.new()
 
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
    @deprecated_method(one_five)
 
972
    def join(self, other, pb=None, msg=None, version_ids=None,
 
973
             ignore_missing=False):
 
974
        """Join other into self and save."""
 
975
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
976
        self._save()
 
977
 
 
978
 
 
979
def _reweave(wa, wb, pb=None, msg=None):
 
980
    """Combine two weaves and return the result.
 
981
 
 
982
    This works even if a revision R has different parents in 
 
983
    wa and wb.  In the resulting weave all the parents are given.
 
984
 
 
985
    This is done by just building up a new weave, maintaining ordering 
 
986
    of the versions in the two inputs.  More efficient approaches
 
987
    might be possible but it should only be necessary to do 
 
988
    this operation rarely, when a new previously ghost version is 
 
989
    inserted.
 
990
 
 
991
    :param pb: An optional progress bar, indicating how far done we are
 
992
    :param msg: An optional message for the progress
 
993
    """
 
994
    wr = Weave()
 
995
    ia = ib = 0
 
996
    queue_a = range(wa.num_versions())
 
997
    queue_b = range(wb.num_versions())
 
998
    # first determine combined parents of all versions
 
999
    # map from version name -> all parent names
 
1000
    combined_parents = _reweave_parent_graphs(wa, wb)
 
1001
    mutter("combined parents: %r", combined_parents)
 
1002
    order = tsort.topo_sort(combined_parents.iteritems())
 
1003
    mutter("order to reweave: %r", order)
 
1004
 
 
1005
    if pb and not msg:
 
1006
        msg = 'reweave'
 
1007
 
 
1008
    for idx, name in enumerate(order):
 
1009
        if pb:
 
1010
            pb.update(msg, idx, len(order))
 
1011
        if name in wa._name_map:
 
1012
            lines = wa.get_lines(name)
 
1013
            if name in wb._name_map:
 
1014
                lines_b = wb.get_lines(name)
 
1015
                if lines != lines_b:
 
1016
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1017
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1018
                    import difflib
 
1019
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1020
                            wa._weave_name, wb._weave_name))
 
1021
                    mutter('lines:\n%s', ''.join(lines))
 
1022
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1023
        else:
 
1024
            lines = wb.get_lines(name)
 
1025
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1026
    return wr
 
1027
 
 
1028
def _reweave_parent_graphs(wa, wb):
 
1029
    """Return combined parent ancestry for two weaves.
 
1030
    
 
1031
    Returned as a list of (version_name, set(parent_names))"""
 
1032
    combined = {}
 
1033
    for weave in [wa, wb]:
 
1034
        for idx, name in enumerate(weave._names):
 
1035
            p = combined.setdefault(name, set())
 
1036
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1037
    return combined
 
1038
 
 
1039
 
 
1040
def weave_toc(w):
 
1041
    """Show the weave's table-of-contents"""
 
1042
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1043
    for i in (6, 50, 10, 10):
677
1044
        print '-' * i,
678
1045
    print
679
 
    for i in range(w.numversions()):
 
1046
    for i in range(w.num_versions()):
680
1047
        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
 
1048
        name = w._names[i]
 
1049
        parent_str = ' '.join(map(str, w._parents[i]))
 
1050
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1051
 
 
1052
 
 
1053
 
 
1054
def weave_stats(weave_file, pb):
687
1055
    from bzrlib.weavefile import read_weave
688
1056
 
689
 
    pb = ProgressBar()
690
 
 
691
1057
    wf = file(weave_file, 'rb')
692
1058
    w = read_weave(wf)
693
1059
    # FIXME: doesn't work on pipes
697
1063
    vers = len(w)
698
1064
    for i in range(vers):
699
1065
        pb.update('checking sizes', i, vers)
700
 
        for line in w.get_iter(i):
 
1066
        for origin, lineno, line in w._extract([i]):
701
1067
            total += len(line)
702
1068
 
703
1069
    pb.clear()
706
1072
    print 'weave file        %9d bytes' % weave_size
707
1073
    print 'total contents    %9d bytes' % total
708
1074
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
709
 
 
 
1075
    if vers:
 
1076
        avg = total/vers
 
1077
        print 'average size      %9d bytes' % avg
 
1078
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
710
1079
 
711
1080
 
712
1081
def usage():
721
1090
        Write out specified version.
722
1091
    weave check WEAVEFILE
723
1092
        Check consistency of all versions.
724
 
    weave info WEAVEFILE
 
1093
    weave toc WEAVEFILE
725
1094
        Display table of contents.
726
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
1095
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
727
1096
        Add NEWTEXT, with specified parent versions.
728
1097
    weave annotate WEAVEFILE VERSION
729
1098
        Display origin of each line.
730
 
    weave mash WEAVEFILE VERSION...
731
 
        Display composite of all selected versions.
732
1099
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
733
1100
        Auto-merge two versions and display conflicts.
 
1101
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1102
        Show differences between two versions.
734
1103
 
735
1104
example:
736
1105
 
737
1106
    % weave init foo.weave
738
1107
    % vi foo.txt
739
 
    % weave add foo.weave < foo.txt
 
1108
    % weave add foo.weave ver0 < foo.txt
740
1109
    added version 0
741
1110
 
742
1111
    (create updated version)
743
1112
    % vi foo.txt
744
1113
    % weave get foo.weave 0 | diff -u - foo.txt
745
 
    % weave add foo.weave 0 < foo.txt
 
1114
    % weave add foo.weave ver1 0 < foo.txt
746
1115
    added version 1
747
1116
 
748
1117
    % weave get foo.weave 0 > foo.txt       (create forked version)
749
1118
    % vi foo.txt
750
 
    % weave add foo.weave 0 < foo.txt
 
1119
    % weave add foo.weave ver2 0 < foo.txt
751
1120
    added version 2
752
1121
 
753
1122
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
754
1123
    % vi foo.txt                            (resolve conflicts)
755
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
1124
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
756
1125
    
757
1126
"""
758
1127
    
761
1130
def main(argv):
762
1131
    import sys
763
1132
    import os
764
 
    from weavefile import write_weave, read_weave
 
1133
    try:
 
1134
        import bzrlib
 
1135
    except ImportError:
 
1136
        # in case we're run directly from the subdirectory
 
1137
        sys.path.append('..')
 
1138
        import bzrlib
 
1139
    from bzrlib.weavefile import write_weave, read_weave
765
1140
    from bzrlib.progress import ProgressBar
766
1141
 
767
 
    #import psyco
768
 
    #psyco.full()
 
1142
    try:
 
1143
        import psyco
 
1144
        psyco.full()
 
1145
    except ImportError:
 
1146
        pass
 
1147
 
 
1148
    if len(argv) < 2:
 
1149
        usage()
 
1150
        return 0
769
1151
 
770
1152
    cmd = argv[1]
771
1153
 
777
1159
    elif cmd == 'add':
778
1160
        w = readit()
779
1161
        # at the moment, based on everything in the file
780
 
        parents = map(int, argv[3:])
 
1162
        name = argv[3]
 
1163
        parents = map(int, argv[4:])
781
1164
        lines = sys.stdin.readlines()
782
 
        ver = w.add(parents, lines)
 
1165
        ver = w.add(name, parents, lines)
783
1166
        write_weave(w, file(argv[2], 'wb'))
784
 
        print 'added version %d' % ver
 
1167
        print 'added version %r %d' % (name, ver)
785
1168
    elif cmd == 'init':
786
1169
        fn = argv[2]
787
1170
        if os.path.exists(fn):
792
1175
        w = readit()
793
1176
        sys.stdout.writelines(w.get_iter(int(argv[3])))
794
1177
        
795
 
    elif cmd == 'mash': # get composite
 
1178
    elif cmd == 'diff':
796
1179
        w = readit()
797
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
798
 
 
 
1180
        fn = argv[2]
 
1181
        v1, v2 = map(int, argv[3:5])
 
1182
        lines1 = w.get(v1)
 
1183
        lines2 = w.get(v2)
 
1184
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1185
                                '%s version %d' % (fn, v1),
 
1186
                                '%s version %d' % (fn, v2))
 
1187
        sys.stdout.writelines(diff_gen)
 
1188
            
799
1189
    elif cmd == 'annotate':
800
1190
        w = readit()
801
1191
        # newline is added to all lines regardless; too hard to get
809
1199
                print '%5d | %s' % (origin, text)
810
1200
                lasto = origin
811
1201
                
812
 
    elif cmd == 'info':
813
 
        weave_info(readit())
 
1202
    elif cmd == 'toc':
 
1203
        weave_toc(readit())
814
1204
 
815
1205
    elif cmd == 'stats':
816
 
        weave_stats(argv[2])
 
1206
        weave_stats(argv[2], ProgressBar())
817
1207
        
818
1208
    elif cmd == 'check':
819
1209
        w = readit()
820
1210
        pb = ProgressBar()
821
1211
        w.check(pb)
822
1212
        pb.clear()
823
 
        print '%d versions ok' % w.numversions()
 
1213
        print '%d versions ok' % w.num_versions()
824
1214
 
825
1215
    elif cmd == 'inclusions':
826
1216
        w = readit()
831
1221
        print ' '.join(map(str, w._parents[int(argv[3])]))
832
1222
 
833
1223
    elif cmd == 'plan-merge':
 
1224
        # replaced by 'bzr weave-plan-merge'
834
1225
        w = readit()
835
1226
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
836
1227
            if line:
837
1228
                print '%14s | %s' % (state, line),
838
 
 
839
1229
    elif cmd == 'merge':
 
1230
        # replaced by 'bzr weave-merge-text'
840
1231
        w = readit()
841
1232
        p = w.plan_merge(int(argv[3]), int(argv[4]))
842
1233
        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
1234
    else:
865
1235
        raise ValueError('unknown command %r' % cmd)
866
1236