← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Aaron Bentley
  • Date: 2007-06-11 14:59:52 UTC
  • mto: (2520.5.2 bzr.mpbundle)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070611145952-cwt4480gphdhen6l
Get installation started

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
# Copyright (C) 2005, 2009 Canonical Ltd
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
2
4
#
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
12
14
#
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
# Author: Martin Pool <mbp@canonical.com>
18
20
 
 
21
 
19
22
"""Weave - storage of related text file versions"""
20
23
 
21
 
from __future__ import absolute_import
22
24
 
23
25
# XXX: If we do weaves this way, will a merge still behave the same
24
26
# way if it's done in a different order?  That's a pretty desirable
59
61
# where the basis and destination are unchanged.
60
62
 
61
63
# FIXME: Sometimes we will be given a parents list for a revision
62
 
# that includes some redundant parents (i.e. already a parent of
63
 
# something in the list.)  We should eliminate them.  This can
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
64
66
# be done fairly efficiently because the sequence numbers constrain
65
67
# the possible relationships.
66
68
 
69
71
from copy import copy
70
72
from cStringIO import StringIO
71
73
import os
 
74
import sha
 
75
import time
 
76
import warnings
72
77
 
73
 
from bzrlib.lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from bzrlib import tsort
76
 
""")
77
78
from bzrlib import (
78
 
    errors,
79
 
    osutils,
 
79
    progress,
80
80
    )
 
81
from bzrlib.trace import mutter
81
82
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
83
        RevisionAlreadyPresent,
83
84
        RevisionNotPresent,
84
 
        UnavailableRepresentation,
 
85
        WeaveRevisionAlreadyPresent,
 
86
        WeaveRevisionNotPresent,
85
87
        )
86
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
 
88
import bzrlib.errors as errors
 
89
from bzrlib.osutils import sha_strings
87
90
import bzrlib.patiencediff
88
 
from bzrlib.revision import NULL_REVISION
89
 
from bzrlib.symbol_versioning import *
90
 
from bzrlib.trace import mutter
91
 
from bzrlib.versionedfile import (
92
 
    AbsentContentFactory,
93
 
    adapter_registry,
94
 
    ContentFactory,
95
 
    sort_groupcompress,
96
 
    VersionedFile,
97
 
    )
 
91
from bzrlib.symbol_versioning import (deprecated_method,
 
92
        deprecated_function,
 
93
        zero_eight,
 
94
        )
 
95
from bzrlib.tsort import topo_sort
 
96
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
98
97
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
98
 
100
99
 
101
 
class WeaveContentFactory(ContentFactory):
102
 
    """Content factory for streaming from weaves.
103
 
 
104
 
    :seealso ContentFactory:
105
 
    """
106
 
 
107
 
    def __init__(self, version, weave):
108
 
        """Create a WeaveContentFactory for version from weave."""
109
 
        ContentFactory.__init__(self)
110
 
        self.sha1 = weave.get_sha1s([version])[version]
111
 
        self.key = (version,)
112
 
        parents = weave.get_parent_map([version])[version]
113
 
        self.parents = tuple((parent,) for parent in parents)
114
 
        self.storage_kind = 'fulltext'
115
 
        self._weave = weave
116
 
 
117
 
    def get_bytes_as(self, storage_kind):
118
 
        if storage_kind == 'fulltext':
119
 
            return self._weave.get_text(self.key[-1])
120
 
        elif storage_kind == 'chunked':
121
 
            return self._weave.get_lines(self.key[-1])
122
 
        else:
123
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
124
 
 
125
 
 
126
100
class Weave(VersionedFile):
127
101
    """weave - versioned text file storage.
128
 
 
 
102
    
129
103
    A Weave manages versions of line-based text files, keeping track
130
104
    of the originating version for each line.
131
105
 
177
151
 
178
152
    * It doesn't seem very useful to have an active insertion
179
153
      inside an inactive insertion, but it might happen.
180
 
 
 
154
      
181
155
    * Therefore, all instructions are always"considered"; that
182
156
      is passed onto and off the stack.  An outer inactive block
183
157
      doesn't disable an inner block.
213
187
    """
214
188
 
215
189
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
216
 
                 '_weave_name', '_matcher', '_allow_reserved']
217
 
 
218
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
219
 
                 get_scope=None, allow_reserved=False):
220
 
        """Create a weave.
221
 
 
222
 
        :param get_scope: A callable that returns an opaque object to be used
223
 
            for detecting when this weave goes out of scope (should stop
224
 
            answering requests or allowing mutation).
225
 
        """
226
 
        super(Weave, self).__init__()
 
190
                 '_weave_name', '_matcher']
 
191
    
 
192
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
 
193
        super(Weave, self).__init__(access_mode)
227
194
        self._weave = []
228
195
        self._parents = []
229
196
        self._sha1s = []
234
201
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
202
        else:
236
203
            self._matcher = matcher
237
 
        if get_scope is None:
238
 
            get_scope = lambda:None
239
 
        self._get_scope = get_scope
240
 
        self._scope = get_scope()
241
 
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
204
 
244
205
    def __repr__(self):
245
206
        return "Weave(%r)" % self._weave_name
246
207
 
247
 
    def _check_write_ok(self):
248
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
249
 
        if self._get_scope() != self._scope:
250
 
            raise errors.OutSideTransaction()
251
 
        if self._access_mode != 'w':
252
 
            raise errors.ReadOnlyObjectDirtiedError(self)
253
 
 
254
208
    def copy(self):
255
209
        """Return a deep copy of self.
256
 
 
 
210
        
257
211
        The copy can be modified without affecting the original weave."""
258
212
        other = Weave()
259
213
        other._weave = self._weave[:]
269
223
            return False
270
224
        return self._parents == other._parents \
271
225
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
273
 
 
 
226
               and self._sha1s == other._sha1s 
 
227
    
274
228
    def __ne__(self, other):
275
229
        return not self.__eq__(other)
276
230
 
 
231
    @deprecated_method(zero_eight)
 
232
    def idx_to_name(self, index):
 
233
        """Old public interface, the public interface is all names now."""
 
234
        return index
 
235
 
277
236
    def _idx_to_name(self, version):
278
237
        return self._names[version]
279
238
 
 
239
    @deprecated_method(zero_eight)
 
240
    def lookup(self, name):
 
241
        """Backwards compatibility thunk:
 
242
 
 
243
        Return name, as name is valid in the api now, and spew deprecation
 
244
        warnings everywhere.
 
245
        """
 
246
        return name
 
247
 
280
248
    def _lookup(self, name):
281
249
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
 
250
        self.check_not_reserved_id(name)
284
251
        try:
285
252
            return self._name_map[name]
286
253
        except KeyError:
287
254
            raise RevisionNotPresent(name, self._weave_name)
288
255
 
 
256
    @deprecated_method(zero_eight)
 
257
    def iter_names(self):
 
258
        """Deprecated convenience function, please see VersionedFile.names()."""
 
259
        return iter(self.names())
 
260
 
 
261
    @deprecated_method(zero_eight)
 
262
    def names(self):
 
263
        """See Weave.versions for the current api."""
 
264
        return self.versions()
 
265
 
289
266
    def versions(self):
290
267
        """See VersionedFile.versions."""
291
268
        return self._names[:]
296
273
 
297
274
    __contains__ = has_version
298
275
 
299
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
300
 
        """Get a stream of records for versions.
301
 
 
302
 
        :param versions: The versions to include. Each version is a tuple
303
 
            (version,).
304
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
305
 
            sorted stream has compression parents strictly before their
306
 
            children.
307
 
        :param include_delta_closure: If True then the closure across any
308
 
            compression parents will be included (in the opaque data).
309
 
        :return: An iterator of ContentFactory objects, each of which is only
310
 
            valid until the iterator is advanced.
311
 
        """
312
 
        versions = [version[-1] for version in versions]
313
 
        if ordering == 'topological':
314
 
            parents = self.get_parent_map(versions)
315
 
            new_versions = tsort.topo_sort(parents)
316
 
            new_versions.extend(set(versions).difference(set(parents)))
317
 
            versions = new_versions
318
 
        elif ordering == 'groupcompress':
319
 
            parents = self.get_parent_map(versions)
320
 
            new_versions = sort_groupcompress(parents)
321
 
            new_versions.extend(set(versions).difference(set(parents)))
322
 
            versions = new_versions
323
 
        for version in versions:
324
 
            if version in self:
325
 
                yield WeaveContentFactory(version, self)
326
 
            else:
327
 
                yield AbsentContentFactory((version,))
328
 
 
329
 
    def get_parent_map(self, version_ids):
330
 
        """See VersionedFile.get_parent_map."""
331
 
        result = {}
 
276
    def get_delta(self, version_id):
 
277
        """See VersionedFile.get_delta."""
 
278
        return self.get_deltas([version_id])[version_id]
 
279
 
 
280
    def get_deltas(self, version_ids):
 
281
        """See VersionedFile.get_deltas."""
 
282
        version_ids = self.get_ancestry(version_ids)
332
283
        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:
 
284
            if not self.has_version(version_id):
 
285
                raise RevisionNotPresent(version_id, self)
 
286
        # try extracting all versions; parallel extraction is used
 
287
        nv = self.num_versions()
 
288
        sha1s = {}
 
289
        deltas = {}
 
290
        texts = {}
 
291
        inclusions = {}
 
292
        noeols = {}
 
293
        last_parent_lines = {}
 
294
        parents = {}
 
295
        parent_inclusions = {}
 
296
        parent_linenums = {}
 
297
        parent_noeols = {}
 
298
        current_hunks = {}
 
299
        diff_hunks = {}
 
300
        # its simplest to generate a full set of prepared variables.
 
301
        for i in range(nv):
 
302
            name = self._names[i]
 
303
            sha1s[name] = self.get_sha1(name)
 
304
            parents_list = self.get_parents(name)
 
305
            try:
 
306
                parent = parents_list[0]
 
307
                parents[name] = parent
 
308
                parent_inclusions[name] = inclusions[parent]
 
309
            except IndexError:
 
310
                parents[name] = None
 
311
                parent_inclusions[name] = set()
 
312
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
 
313
            diff_hunks[name] = []
 
314
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
 
315
            parent_linenums[name] = 0
 
316
            noeols[name] = False
 
317
            parent_noeols[name] = False
 
318
            last_parent_lines[name] = None
 
319
            new_inc = set([name])
 
320
            for p in self._parents[i]:
 
321
                new_inc.update(inclusions[self._idx_to_name(p)])
 
322
            # debug only, known good so far.
 
323
            #assert set(new_inc) == set(self.get_ancestry(name)), \
 
324
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
325
            inclusions[name] = new_inc
 
326
 
 
327
        nlines = len(self._weave)
 
328
 
 
329
        for lineno, inserted, deletes, line in self._walk_internal():
 
330
            # a line is active in a version if:
 
331
            # insert is in the versions inclusions
 
332
            # and
 
333
            # deleteset & the versions inclusions is an empty set.
 
334
            # so - if we have a included by mapping - version is included by
 
335
            # children, we get a list of children to examine for deletes affect
 
336
            # ing them, which is less than the entire set of children.
 
337
            for version_id in version_ids:  
 
338
                # The active inclusion must be an ancestor,
 
339
                # and no ancestors must have deleted this line,
 
340
                # because we don't support resurrection.
 
341
                parent_inclusion = parent_inclusions[version_id]
 
342
                inclusion = inclusions[version_id]
 
343
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
 
344
                version_active = inserted in inclusion and not (deletes & inclusion)
 
345
                if not parent_active and not version_active:
 
346
                    # unrelated line of ancestry
341
347
                    continue
342
 
            result[version_id] = parents
 
348
                elif parent_active and version_active:
 
349
                    # shared line
 
350
                    parent_linenum = parent_linenums[version_id]
 
351
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
 
352
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
 
353
                    parent_linenum += 1
 
354
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
 
355
                    parent_linenums[version_id] = parent_linenum
 
356
                    try:
 
357
                        if line[-1] != '\n':
 
358
                            noeols[version_id] = True
 
359
                    except IndexError:
 
360
                        pass
 
361
                elif parent_active and not version_active:
 
362
                    # deleted line
 
363
                    current_hunks[version_id][1] += 1
 
364
                    parent_linenums[version_id] += 1
 
365
                    last_parent_lines[version_id] = line
 
366
                elif not parent_active and version_active:
 
367
                    # replacement line
 
368
                    # noeol only occurs at the end of a file because we 
 
369
                    # diff linewise. We want to show noeol changes as a
 
370
                    # empty diff unless the actual eol-less content changed.
 
371
                    theline = line
 
372
                    try:
 
373
                        if last_parent_lines[version_id][-1] != '\n':
 
374
                            parent_noeols[version_id] = True
 
375
                    except (TypeError, IndexError):
 
376
                        pass
 
377
                    try:
 
378
                        if theline[-1] != '\n':
 
379
                            noeols[version_id] = True
 
380
                    except IndexError:
 
381
                        pass
 
382
                    new_line = False
 
383
                    parent_should_go = False
 
384
 
 
385
                    if parent_noeols[version_id] == noeols[version_id]:
 
386
                        # no noeol toggle, so trust the weaves statement
 
387
                        # that this line is changed.
 
388
                        new_line = True
 
389
                        if parent_noeols[version_id]:
 
390
                            theline = theline + '\n'
 
391
                    elif parent_noeols[version_id]:
 
392
                        # parent has no eol, we do:
 
393
                        # our line is new, report as such..
 
394
                        new_line = True
 
395
                    elif noeols[version_id]:
 
396
                        # append a eol so that it looks like
 
397
                        # a normalised delta
 
398
                        theline = theline + '\n'
 
399
                        if parents[version_id] is not None:
 
400
                        #if last_parent_lines[version_id] is not None:
 
401
                            parent_should_go = True
 
402
                        if last_parent_lines[version_id] != theline:
 
403
                            # but changed anyway
 
404
                            new_line = True
 
405
                            #parent_should_go = False
 
406
                    if new_line:
 
407
                        current_hunks[version_id][2] += 1
 
408
                        current_hunks[version_id][3].append((inserted, theline))
 
409
                    if parent_should_go:
 
410
                        # last hunk last parent line is not eaten
 
411
                        current_hunks[version_id][1] -= 1
 
412
                    if current_hunks[version_id][1] < 0:
 
413
                        current_hunks[version_id][1] = 0
 
414
                        # import pdb;pdb.set_trace()
 
415
                    # assert current_hunks[version_id][1] >= 0
 
416
 
 
417
        # flush last hunk
 
418
        for i in range(nv):
 
419
            version = self._idx_to_name(i)
 
420
            if current_hunks[version] != [0, 0, 0, []]:
 
421
                diff_hunks[version].append(tuple(current_hunks[version]))
 
422
        result = {}
 
423
        for version_id in version_ids:
 
424
            result[version_id] = (
 
425
                                  parents[version_id],
 
426
                                  sha1s[version_id],
 
427
                                  noeols[version_id],
 
428
                                  diff_hunks[version_id],
 
429
                                  )
343
430
        return result
344
431
 
345
 
    def get_parents_with_ghosts(self, version_id):
346
 
        raise NotImplementedError(self.get_parents_with_ghosts)
347
 
 
348
 
    def insert_record_stream(self, stream):
349
 
        """Insert a record stream into this versioned file.
350
 
 
351
 
        :param stream: A stream of records to insert.
352
 
        :return: None
353
 
        :seealso VersionedFile.get_record_stream:
354
 
        """
355
 
        adapters = {}
356
 
        for record in stream:
357
 
            # Raise an error when a record is missing.
358
 
            if record.storage_kind == 'absent':
359
 
                raise RevisionNotPresent([record.key[0]], self)
360
 
            # adapt to non-tuple interface
361
 
            parents = [parent[0] for parent in record.parents]
362
 
            if (record.storage_kind == 'fulltext'
363
 
                or record.storage_kind == 'chunked'):
364
 
                self.add_lines(record.key[0], parents,
365
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
366
 
            else:
367
 
                adapter_key = record.storage_kind, 'fulltext'
368
 
                try:
369
 
                    adapter = adapters[adapter_key]
370
 
                except KeyError:
371
 
                    adapter_factory = adapter_registry.get(adapter_key)
372
 
                    adapter = adapter_factory(self)
373
 
                    adapters[adapter_key] = adapter
374
 
                lines = split_lines(adapter.get_bytes(record))
375
 
                try:
376
 
                    self.add_lines(record.key[0], parents, lines)
377
 
                except RevisionAlreadyPresent:
378
 
                    pass
 
432
    def get_parents(self, version_id):
 
433
        """See VersionedFile.get_parent."""
 
434
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
379
435
 
380
436
    def _check_repeated_add(self, name, parents, text, sha1):
381
437
        """Check that a duplicated add is OK.
388
444
            raise RevisionAlreadyPresent(name, self._weave_name)
389
445
        return idx
390
446
 
391
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
392
 
       left_matching_blocks, nostore_sha, random_id, check_content):
 
447
    @deprecated_method(zero_eight)
 
448
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
449
        """Please use Weave.clone_text now."""
 
450
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
451
 
 
452
    def _add_lines(self, version_id, parents, lines, parent_texts):
393
453
        """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):
 
454
        return self._add(version_id, lines, map(self._lookup, parents))
 
455
 
 
456
    @deprecated_method(zero_eight)
 
457
    def add(self, name, parents, text, sha1=None):
 
458
        """See VersionedFile.add_lines for the non deprecated api."""
 
459
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
 
460
 
 
461
    def _add(self, version_id, lines, parents, sha1=None):
399
462
        """Add a single text on top of the weave.
400
 
 
 
463
  
401
464
        Returns the index number of the newly added version.
402
465
 
403
466
        version_id
404
467
            Symbolic name for this version.
405
468
            (Typically the revision-id of the revision that added it.)
406
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
407
469
 
408
470
        parents
409
471
            List or set of direct parent version numbers.
410
 
 
 
472
            
411
473
        lines
412
474
            Sequence of lines to be added in the new version.
 
475
        """
413
476
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
415
 
        """
 
477
        assert isinstance(version_id, basestring)
416
478
        self._check_lines_not_unicode(lines)
417
479
        self._check_lines_are_lines(lines)
418
480
        if not sha1:
419
481
            sha1 = sha_strings(lines)
420
 
        if sha1 == nostore_sha:
421
 
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
482
        if version_id in self._name_map:
425
483
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
484
 
437
495
        self._names.append(version_id)
438
496
        self._name_map[version_id] = new_version
439
497
 
440
 
 
 
498
            
441
499
        if not parents:
442
500
            # special case; adding with no parents revision; can do
443
501
            # this more quickly by just appending unconditionally.
454
512
            if sha1 == self._sha1s[pv]:
455
513
                # special case: same as the single parent
456
514
                return new_version
457
 
 
 
515
            
458
516
 
459
517
        ancestors = self._inclusions(parents)
460
518
 
470
528
        # another small special case: a merge, producing the same text
471
529
        # as auto-merge
472
530
        if lines == basis_lines:
473
 
            return new_version
 
531
            return new_version            
474
532
 
475
533
        # add a sentinel, because we can also match against the final line
476
534
        basis_lineno.append(len(self._weave))
495
553
            #print 'raw match', tag, i1, i2, j1, j2
496
554
            if tag == 'equal':
497
555
                continue
 
556
 
498
557
            i1 = basis_lineno[i1]
499
558
            i2 = basis_lineno[i2]
 
559
 
 
560
            assert 0 <= j1 <= j2 <= len(lines)
 
561
 
 
562
            #print tag, i1, i2, j1, j2
 
563
 
500
564
            # the deletion and insertion are handled separately.
501
565
            # first delete the region.
502
566
            if i1 != i2:
509
573
                # i2; we want to insert after this region to make sure
510
574
                # we don't destroy ourselves
511
575
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
576
                self._weave[i:i] = ([('{', new_version)] 
 
577
                                    + lines[j1:j2] 
514
578
                                    + [('}', None)])
515
579
                offset += 2 + (j2 - j1)
516
580
        return new_version
517
581
 
 
582
    def _clone_text(self, new_version_id, old_version_id, parents):
 
583
        """See VersionedFile.clone_text."""
 
584
        old_lines = self.get_text(old_version_id)
 
585
        self.add_lines(new_version_id, parents, old_lines)
 
586
 
518
587
    def _inclusions(self, versions):
519
588
        """Return set of all ancestors of given version(s)."""
520
589
        if not len(versions):
528
597
        ## except IndexError:
529
598
        ##     raise ValueError("version %d not present in weave" % v)
530
599
 
531
 
    def get_ancestry(self, version_ids, topo_sorted=True):
 
600
    @deprecated_method(zero_eight)
 
601
    def inclusions(self, version_ids):
 
602
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
 
603
        if not version_ids:
 
604
            return []
 
605
        if isinstance(version_ids[0], int):
 
606
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
 
607
        else:
 
608
            return self.get_ancestry(version_ids)
 
609
 
 
610
    def get_ancestry(self, version_ids):
532
611
        """See VersionedFile.get_ancestry."""
533
612
        if isinstance(version_ids, basestring):
534
613
            version_ids = [version_ids]
543
622
            if not isinstance(l, basestring):
544
623
                raise ValueError("text line should be a string or unicode, not %s"
545
624
                                 % type(l))
546
 
 
 
625
        
547
626
 
548
627
 
549
628
    def _check_versions(self, indexes):
557
636
    def _compatible_parents(self, my_parents, other_parents):
558
637
        """During join check that other_parents are joinable with my_parents.
559
638
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
639
        Joinable is defined as 'is a subset of' - supersets may require 
561
640
        regeneration of diffs, but subsets do not.
562
641
        """
563
642
        return len(other_parents.difference(my_parents)) == 0
564
643
 
565
 
    def annotate(self, version_id):
566
 
        """Return a list of (version-id, line) tuples for version_id.
 
644
    def annotate_iter(self, version_id):
 
645
        """Yield list of (version-id, line) pairs for the specified version.
567
646
 
568
647
        The index indicates when the line originated in the weave."""
569
648
        incls = [self._lookup(version_id)]
570
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
 
            self._extract(incls)]
 
649
        for origin, lineno, text in self._extract(incls):
 
650
            yield self._idx_to_name(origin), text
 
651
 
 
652
    @deprecated_method(zero_eight)
 
653
    def _walk(self):
 
654
        """_walk has become visit, a supported api."""
 
655
        return self._walk_internal()
572
656
 
573
657
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
574
658
                                                pb=None):
577
661
            version_ids = self.versions()
578
662
        version_ids = set(version_ids)
579
663
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
 
664
            # if inserted not in version_ids then it was inserted before the
 
665
            # versions we care about, but because weaves cannot represent ghosts
 
666
            # properly, we do not filter down to that
 
667
            # if inserted not in version_ids: continue
581
668
            if line[-1] != '\n':
582
 
                yield line + '\n', inserted
 
669
                yield line + '\n'
583
670
            else:
584
 
                yield line, inserted
 
671
                yield line
 
672
 
 
673
    #@deprecated_method(zero_eight)
 
674
    def walk(self, version_ids=None):
 
675
        """See VersionedFile.walk."""
 
676
        return self._walk_internal(version_ids)
585
677
 
586
678
    def _walk_internal(self, version_ids=None):
587
679
        """Helper method for weave actions."""
588
 
 
 
680
        
589
681
        istack = []
590
682
        dset = set()
591
683
 
600
692
                elif c == '}':
601
693
                    istack.pop()
602
694
                elif c == '[':
 
695
                    assert self._names[v] not in dset
603
696
                    dset.add(self._names[v])
604
697
                elif c == ']':
605
698
                    dset.remove(self._names[v])
606
699
                else:
607
700
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
701
            else:
 
702
                assert l.__class__ in (str, unicode)
 
703
                assert istack
609
704
                yield lineno, istack[-1], frozenset(dset), l
610
705
            lineno += 1
611
706
 
628
723
        inc_b = set(self.get_ancestry([ver_b]))
629
724
        inc_c = inc_a & inc_b
630
725
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
726
        for lineno, insert, deleteset, line in\
 
727
            self.walk([ver_a, ver_b]):
632
728
            if deleteset & inc_c:
633
729
                # killed in parent; can't be in either a or b
634
730
                # not relevant to our work
660
756
                # not in either revision
661
757
                yield 'irrelevant', line
662
758
 
 
759
        yield 'unchanged', ''           # terminator
 
760
 
663
761
    def _extract(self, versions):
664
762
        """Yield annotation of lines in included set.
665
763
 
672
770
        for i in versions:
673
771
            if not isinstance(i, int):
674
772
                raise ValueError(i)
675
 
 
 
773
            
676
774
        included = self._inclusions(versions)
677
775
 
678
776
        istack = []
687
785
 
688
786
        WFE = WeaveFormatError
689
787
 
690
 
        # wow.
 
788
        # wow. 
691
789
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
790
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
791
        # 1.6 seconds in 'isinstance'.
699
797
        # we're still spending ~1/4 of the method in isinstance though.
700
798
        # so lets hard code the acceptable string classes we expect:
701
799
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
800
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
801
        #                                          objects>
704
802
        # yay, down to ~1/4 the initial extract time, and our inline time
705
803
        # has shrunk again, with isinstance no longer dominating.
706
804
        # tweaking the stack inclusion test to use a set gives:
707
805
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
806
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
807
        #                                          objects>
710
808
        # - a 5% win, or possibly just noise. However with large istacks that
711
809
        # 'in' test could dominate, so I'm leaving this change in place -
712
810
        # when its fast enough to consider profiling big datasets we can review.
713
811
 
714
 
 
715
 
 
 
812
              
 
813
             
716
814
 
717
815
        for l in self._weave:
718
816
            if l.__class__ == tuple:
719
817
                c, v = l
720
818
                isactive = None
721
819
                if c == '{':
 
820
                    assert v not in iset
722
821
                    istack.append(v)
723
822
                    iset.add(v)
724
823
                elif c == '}':
725
824
                    iset.remove(istack.pop())
726
825
                elif c == '[':
727
826
                    if v in included:
 
827
                        assert v not in dset
728
828
                        dset.add(v)
729
 
                elif c == ']':
 
829
                else:
 
830
                    assert c == ']'
730
831
                    if v in included:
 
832
                        assert v in dset
731
833
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
834
            else:
 
835
                assert l.__class__ in (str, unicode)
735
836
                if isactive is None:
736
837
                    isactive = (not dset) and istack and (istack[-1] in included)
737
838
                if isactive:
745
846
                                   % dset)
746
847
        return result
747
848
 
 
849
    @deprecated_method(zero_eight)
 
850
    def get_iter(self, name_or_index):
 
851
        """Deprecated, please do not use. Lookups are not not needed.
 
852
        
 
853
        Please use get_lines now.
 
854
        """
 
855
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
856
 
 
857
    @deprecated_method(zero_eight)
 
858
    def maybe_lookup(self, name_or_index):
 
859
        """Deprecated, please do not use. Lookups are not not needed."""
 
860
        return self._maybe_lookup(name_or_index)
 
861
 
748
862
    def _maybe_lookup(self, name_or_index):
749
863
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
 
864
        
751
865
        NOT FOR PUBLIC USE.
752
866
        """
753
867
        if isinstance(name_or_index, (int, long)):
755
869
        else:
756
870
            return self._lookup(name_or_index)
757
871
 
 
872
    @deprecated_method(zero_eight)
 
873
    def get(self, version_id):
 
874
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
875
        return self.get_lines(version_id)
 
876
 
758
877
    def get_lines(self, version_id):
759
878
        """See VersionedFile.get_lines()."""
760
879
        int_index = self._maybe_lookup(version_id)
763
882
        measured_sha1 = sha_strings(result)
764
883
        if measured_sha1 != expected_sha1:
765
884
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
 
885
                    'file %s, revision %s, expected: %s, measured %s' 
767
886
                    % (self._weave_name, version_id,
768
887
                       expected_sha1, measured_sha1))
769
888
        return result
770
889
 
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
 
890
    def get_sha1(self, version_id):
 
891
        """See VersionedFile.get_sha1()."""
 
892
        return self._sha1s[self._lookup(version_id)]
 
893
 
 
894
    @deprecated_method(zero_eight)
 
895
    def numversions(self):
 
896
        """How many versions are in this weave?
 
897
 
 
898
        Deprecated in favour of num_versions.
 
899
        """
 
900
        return self.num_versions()
777
901
 
778
902
    def num_versions(self):
779
903
        """How many versions are in this weave?"""
780
904
        l = len(self._parents)
 
905
        assert l == len(self._sha1s)
781
906
        return l
782
907
 
783
908
    __len__ = num_versions
803
928
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
929
            # The problem is that set membership is much more expensive
805
930
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
931
            sha1s[name] = sha.new()
807
932
            texts[name] = []
808
933
            new_inc = set([name])
809
934
            for p in self._parents[i]:
810
935
                new_inc.update(inclusions[self._idx_to_name(p)])
811
936
 
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))))
 
937
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
938
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
816
939
            inclusions[name] = new_inc
817
940
 
818
941
        nlines = len(self._weave)
848
971
        # no lines outside of insertion blocks, that deletions are
849
972
        # properly paired, etc.
850
973
 
 
974
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
975
        """Worker routine for join()."""
 
976
        if not other.versions():
 
977
            return          # nothing to update, easy
 
978
 
 
979
        if not version_ids:
 
980
            # versions is never none, InterWeave checks this.
 
981
            return 0
 
982
 
 
983
        # two loops so that we do not change ourselves before verifying it
 
984
        # will be ok
 
985
        # work through in index order to make sure we get all dependencies
 
986
        names_to_join = []
 
987
        processed = 0
 
988
        # get the selected versions only that are in other.versions.
 
989
        version_ids = set(other.versions()).intersection(set(version_ids))
 
990
        # pull in the referenced graph.
 
991
        version_ids = other.get_ancestry(version_ids)
 
992
        pending_graph = [(version, other.get_parents(version)) for
 
993
                         version in version_ids]
 
994
        for name in topo_sort(pending_graph):
 
995
            other_idx = other._name_map[name]
 
996
            # returns True if we have it, False if we need it.
 
997
            if not self._check_version_consistent(other, other_idx, name):
 
998
                names_to_join.append((other_idx, name))
 
999
            processed += 1
 
1000
 
 
1001
 
 
1002
        if pb and not msg:
 
1003
            msg = 'weave join'
 
1004
 
 
1005
        merged = 0
 
1006
        time0 = time.time()
 
1007
        for other_idx, name in names_to_join:
 
1008
            # TODO: If all the parents of the other version are already
 
1009
            # present then we can avoid some work by just taking the delta
 
1010
            # and adjusting the offsets.
 
1011
            new_parents = self._imported_parents(other, other_idx)
 
1012
            sha1 = other._sha1s[other_idx]
 
1013
 
 
1014
            merged += 1
 
1015
 
 
1016
            if pb:
 
1017
                pb.update(msg, merged, len(names_to_join))
 
1018
           
 
1019
            lines = other.get_lines(other_idx)
 
1020
            self._add(name, lines, new_parents, sha1)
 
1021
 
 
1022
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
1023
                merged, processed, self._weave_name, time.time()-time0))
 
1024
 
851
1025
    def _imported_parents(self, other, other_idx):
852
1026
        """Return list of parents in self corresponding to indexes in other."""
853
1027
        new_parents = []
855
1029
            parent_name = other._names[parent_idx]
856
1030
            if parent_name not in self._name_map:
857
1031
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
1032
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
1033
                                 % (parent_name, other._name_map[other_idx], self))
860
1034
            new_parents.append(self._name_map[parent_name])
861
1035
        return new_parents
868
1042
         * the same text
869
1043
         * the same direct parents (by name, not index, and disregarding
870
1044
           order)
871
 
 
 
1045
        
872
1046
        If present & correct return True;
873
 
        if not present in self return False;
 
1047
        if not present in self return False; 
874
1048
        if inconsistent raise error."""
875
1049
        this_idx = self._name_map.get(name, -1)
876
1050
        if this_idx != -1:
888
1062
        else:
889
1063
            return False
890
1064
 
 
1065
    @deprecated_method(zero_eight)
 
1066
    def reweave(self, other, pb=None, msg=None):
 
1067
        """reweave has been superseded by plain use of join."""
 
1068
        return self.join(other, pb, msg)
 
1069
 
891
1070
    def _reweave(self, other, pb, msg):
892
1071
        """Reweave self with other - internal helper for join().
893
1072
 
909
1088
    """A WeaveFile represents a Weave on disk and writes on change."""
910
1089
 
911
1090
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
1091
    
 
1092
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
914
1093
        """Create a WeaveFile.
915
 
 
 
1094
        
916
1095
        :param create: If not True, only open an existing knit.
917
1096
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
1097
        super(WeaveFile, self).__init__(name, access_mode)
920
1098
        self._transport = transport
921
1099
        self._filemode = filemode
922
1100
        try:
927
1105
            # new file, save it
928
1106
            self._save()
929
1107
 
930
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
931
 
        left_matching_blocks, nostore_sha, random_id, check_content):
 
1108
    def _add_lines(self, version_id, parents, lines, parent_texts):
932
1109
        """Add a version and save the weave."""
933
1110
        self.check_not_reserved_id(version_id)
934
1111
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
935
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
936
 
            check_content)
 
1112
                                                   parent_texts)
937
1113
        self._save()
938
1114
        return result
939
1115
 
 
1116
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1117
        """See VersionedFile.clone_text."""
 
1118
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1119
        self._save
 
1120
 
940
1121
    def copy_to(self, name, transport):
941
1122
        """See VersionedFile.copy_to()."""
942
1123
        # as we are all in memory always, just serialise to the new place.
945
1126
        sio.seek(0)
946
1127
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
947
1128
 
 
1129
    def create_empty(self, name, transport, filemode=None):
 
1130
        return WeaveFile(name, transport, filemode, create=True)
 
1131
 
948
1132
    def _save(self):
949
1133
        """Save the weave."""
950
1134
        self._check_write_ok()
951
1135
        sio = StringIO()
952
1136
        write_weave_v5(self, sio)
953
1137
        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)
 
1138
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1139
                                 sio,
 
1140
                                 self._filemode)
961
1141
 
962
1142
    @staticmethod
963
1143
    def get_suffixes():
964
1144
        """See VersionedFile.get_suffixes()."""
965
1145
        return [WeaveFile.WEAVE_SUFFIX]
966
1146
 
967
 
    def insert_record_stream(self, stream):
968
 
        super(WeaveFile, self).insert_record_stream(stream)
 
1147
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1148
             ignore_missing=False):
 
1149
        """Join other into self and save."""
 
1150
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
969
1151
        self._save()
970
1152
 
971
1153
 
 
1154
@deprecated_function(zero_eight)
 
1155
def reweave(wa, wb, pb=None, msg=None):
 
1156
    """reweaving is deprecation, please just use weave.join()."""
 
1157
    _reweave(wa, wb, pb, msg)
 
1158
 
972
1159
def _reweave(wa, wb, pb=None, msg=None):
973
1160
    """Combine two weaves and return the result.
974
1161
 
975
 
    This works even if a revision R has different parents in
 
1162
    This works even if a revision R has different parents in 
976
1163
    wa and wb.  In the resulting weave all the parents are given.
977
1164
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
1165
    This is done by just building up a new weave, maintaining ordering 
979
1166
    of the versions in the two inputs.  More efficient approaches
980
 
    might be possible but it should only be necessary to do
981
 
    this operation rarely, when a new previously ghost version is
 
1167
    might be possible but it should only be necessary to do 
 
1168
    this operation rarely, when a new previously ghost version is 
982
1169
    inserted.
983
1170
 
984
1171
    :param pb: An optional progress bar, indicating how far done we are
992
1179
    # map from version name -> all parent names
993
1180
    combined_parents = _reweave_parent_graphs(wa, wb)
994
1181
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
1182
    order = topo_sort(combined_parents.iteritems())
996
1183
    mutter("order to reweave: %r", order)
997
1184
 
998
1185
    if pb and not msg:
1018
1205
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
1206
    return wr
1020
1207
 
1021
 
 
1022
1208
def _reweave_parent_graphs(wa, wb):
1023
1209
    """Return combined parent ancestry for two weaves.
1024
 
 
 
1210
    
1025
1211
    Returned as a list of (version_name, set(parent_names))"""
1026
1212
    combined = {}
1027
1213
    for weave in [wa, wb]:
1029
1215
            p = combined.setdefault(name, set())
1030
1216
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
1217
    return combined
 
1218
 
 
1219
 
 
1220
def weave_toc(w):
 
1221
    """Show the weave's table-of-contents"""
 
1222
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1223
    for i in (6, 50, 10, 10):
 
1224
        print '-' * i,
 
1225
    print
 
1226
    for i in range(w.num_versions()):
 
1227
        sha1 = w._sha1s[i]
 
1228
        name = w._names[i]
 
1229
        parent_str = ' '.join(map(str, w._parents[i]))
 
1230
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1231
 
 
1232
 
 
1233
 
 
1234
def weave_stats(weave_file, pb):
 
1235
    from bzrlib.weavefile import read_weave
 
1236
 
 
1237
    wf = file(weave_file, 'rb')
 
1238
    w = read_weave(wf)
 
1239
    # FIXME: doesn't work on pipes
 
1240
    weave_size = wf.tell()
 
1241
 
 
1242
    total = 0
 
1243
    vers = len(w)
 
1244
    for i in range(vers):
 
1245
        pb.update('checking sizes', i, vers)
 
1246
        for origin, lineno, line in w._extract([i]):
 
1247
            total += len(line)
 
1248
 
 
1249
    pb.clear()
 
1250
 
 
1251
    print 'versions          %9d' % vers
 
1252
    print 'weave file        %9d bytes' % weave_size
 
1253
    print 'total contents    %9d bytes' % total
 
1254
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1255
    if vers:
 
1256
        avg = total/vers
 
1257
        print 'average size      %9d bytes' % avg
 
1258
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1259
 
 
1260
 
 
1261
def usage():
 
1262
    print """bzr weave tool
 
1263
 
 
1264
Experimental tool for weave algorithm.
 
1265
 
 
1266
usage:
 
1267
    weave init WEAVEFILE
 
1268
        Create an empty weave file
 
1269
    weave get WEAVEFILE VERSION
 
1270
        Write out specified version.
 
1271
    weave check WEAVEFILE
 
1272
        Check consistency of all versions.
 
1273
    weave toc WEAVEFILE
 
1274
        Display table of contents.
 
1275
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1276
        Add NEWTEXT, with specified parent versions.
 
1277
    weave annotate WEAVEFILE VERSION
 
1278
        Display origin of each line.
 
1279
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1280
        Auto-merge two versions and display conflicts.
 
1281
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1282
        Show differences between two versions.
 
1283
 
 
1284
example:
 
1285
 
 
1286
    % weave init foo.weave
 
1287
    % vi foo.txt
 
1288
    % weave add foo.weave ver0 < foo.txt
 
1289
    added version 0
 
1290
 
 
1291
    (create updated version)
 
1292
    % vi foo.txt
 
1293
    % weave get foo.weave 0 | diff -u - foo.txt
 
1294
    % weave add foo.weave ver1 0 < foo.txt
 
1295
    added version 1
 
1296
 
 
1297
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1298
    % vi foo.txt
 
1299
    % weave add foo.weave ver2 0 < foo.txt
 
1300
    added version 2
 
1301
 
 
1302
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1303
    % vi foo.txt                            (resolve conflicts)
 
1304
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1305
    
 
1306
"""
 
1307
    
 
1308
 
 
1309
 
 
1310
def main(argv):
 
1311
    import sys
 
1312
    import os
 
1313
    try:
 
1314
        import bzrlib
 
1315
    except ImportError:
 
1316
        # in case we're run directly from the subdirectory
 
1317
        sys.path.append('..')
 
1318
        import bzrlib
 
1319
    from bzrlib.weavefile import write_weave, read_weave
 
1320
    from bzrlib.progress import ProgressBar
 
1321
 
 
1322
    try:
 
1323
        import psyco
 
1324
        psyco.full()
 
1325
    except ImportError:
 
1326
        pass
 
1327
 
 
1328
    if len(argv) < 2:
 
1329
        usage()
 
1330
        return 0
 
1331
 
 
1332
    cmd = argv[1]
 
1333
 
 
1334
    def readit():
 
1335
        return read_weave(file(argv[2], 'rb'))
 
1336
    
 
1337
    if cmd == 'help':
 
1338
        usage()
 
1339
    elif cmd == 'add':
 
1340
        w = readit()
 
1341
        # at the moment, based on everything in the file
 
1342
        name = argv[3]
 
1343
        parents = map(int, argv[4:])
 
1344
        lines = sys.stdin.readlines()
 
1345
        ver = w.add(name, parents, lines)
 
1346
        write_weave(w, file(argv[2], 'wb'))
 
1347
        print 'added version %r %d' % (name, ver)
 
1348
    elif cmd == 'init':
 
1349
        fn = argv[2]
 
1350
        if os.path.exists(fn):
 
1351
            raise IOError("file exists")
 
1352
        w = Weave()
 
1353
        write_weave(w, file(fn, 'wb'))
 
1354
    elif cmd == 'get': # get one version
 
1355
        w = readit()
 
1356
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1357
        
 
1358
    elif cmd == 'diff':
 
1359
        w = readit()
 
1360
        fn = argv[2]
 
1361
        v1, v2 = map(int, argv[3:5])
 
1362
        lines1 = w.get(v1)
 
1363
        lines2 = w.get(v2)
 
1364
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1365
                                '%s version %d' % (fn, v1),
 
1366
                                '%s version %d' % (fn, v2))
 
1367
        sys.stdout.writelines(diff_gen)
 
1368
            
 
1369
    elif cmd == 'annotate':
 
1370
        w = readit()
 
1371
        # newline is added to all lines regardless; too hard to get
 
1372
        # reasonable formatting otherwise
 
1373
        lasto = None
 
1374
        for origin, text in w.annotate(int(argv[3])):
 
1375
            text = text.rstrip('\r\n')
 
1376
            if origin == lasto:
 
1377
                print '      | %s' % (text)
 
1378
            else:
 
1379
                print '%5d | %s' % (origin, text)
 
1380
                lasto = origin
 
1381
                
 
1382
    elif cmd == 'toc':
 
1383
        weave_toc(readit())
 
1384
 
 
1385
    elif cmd == 'stats':
 
1386
        weave_stats(argv[2], ProgressBar())
 
1387
        
 
1388
    elif cmd == 'check':
 
1389
        w = readit()
 
1390
        pb = ProgressBar()
 
1391
        w.check(pb)
 
1392
        pb.clear()
 
1393
        print '%d versions ok' % w.num_versions()
 
1394
 
 
1395
    elif cmd == 'inclusions':
 
1396
        w = readit()
 
1397
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1398
 
 
1399
    elif cmd == 'parents':
 
1400
        w = readit()
 
1401
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1402
 
 
1403
    elif cmd == 'plan-merge':
 
1404
        # replaced by 'bzr weave-plan-merge'
 
1405
        w = readit()
 
1406
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1407
            if line:
 
1408
                print '%14s | %s' % (state, line),
 
1409
    elif cmd == 'merge':
 
1410
        # replaced by 'bzr weave-merge-text'
 
1411
        w = readit()
 
1412
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1413
        sys.stdout.writelines(w.weave_merge(p))
 
1414
    else:
 
1415
        raise ValueError('unknown command %r' % cmd)
 
1416
    
 
1417
 
 
1418
if __name__ == '__main__':
 
1419
    import sys
 
1420
    sys.exit(main(sys.argv))
 
1421
 
 
1422
 
 
1423
class InterWeave(InterVersionedFile):
 
1424
    """Optimised code paths for weave to weave operations."""
 
1425
    
 
1426
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1427
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1428
    
 
1429
    @staticmethod
 
1430
    def is_compatible(source, target):
 
1431
        """Be compatible with weaves."""
 
1432
        try:
 
1433
            return (isinstance(source, Weave) and
 
1434
                    isinstance(target, Weave))
 
1435
        except AttributeError:
 
1436
            return False
 
1437
 
 
1438
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1439
        """See InterVersionedFile.join."""
 
1440
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1441
        if self.target.versions() == [] and version_ids is None:
 
1442
            self.target._copy_weave_content(self.source)
 
1443
            return
 
1444
        try:
 
1445
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1446
        except errors.WeaveParentMismatch:
 
1447
            self.target._reweave(self.source, pb, msg)
 
1448
 
 
1449
 
 
1450
InterVersionedFile.register_optimiser(InterWeave)