← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Launchpad Translations on behalf of bzr-core
  • Date: 2012-05-29 04:30:47 UTC
  • mto: (6581.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6582.
  • Revision ID: launchpad_translations_on_behalf_of_bzr-core-20120529043047-mmj2hkq63ke8kl81
Launchpad automatic translations update.

Show diffs side-by-side

added added

removed removed

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