← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Colin Watson
  • Date: 2015-07-02 10:37:05 UTC
  • mto: This revision was merged to the branch mainline in revision 6605.
  • Revision ID: cjwatson@canonical.com-20150702103705-zdfslk3wb70sz37n
Avoid associating dirty patch headers with the previous file in the patch.

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
 
 
73
from bzrlib.lazy_import import lazy_import
 
74
lazy_import(globals(), """
 
75
from bzrlib import tsort
 
76
""")
78
77
from bzrlib import (
79
 
    progress,
 
78
    errors,
 
79
    osutils,
80
80
    )
81
 
from bzrlib.trace import mutter
82
81
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
83
82
        RevisionAlreadyPresent,
84
83
        RevisionNotPresent,
85
 
        WeaveRevisionAlreadyPresent,
86
 
        WeaveRevisionNotPresent,
 
84
        UnavailableRepresentation,
87
85
        )
88
 
import bzrlib.errors as errors
89
 
from bzrlib.osutils import sha_strings
 
86
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
90
87
import bzrlib.patiencediff
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
 
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
    )
97
98
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
98
99
 
99
100
 
 
101
class WeaveContentFactory(ContentFactory):
 
102
    """Content factory for streaming from weaves.
 
103
 
 
104
    :seealso ContentFactory:
 
105
    """
 
106
 
 
107
    def __init__(self, version, weave):
 
108
        """Create a WeaveContentFactory for version from weave."""
 
109
        ContentFactory.__init__(self)
 
110
        self.sha1 = weave.get_sha1s([version])[version]
 
111
        self.key = (version,)
 
112
        parents = weave.get_parent_map([version])[version]
 
113
        self.parents = tuple((parent,) for parent in parents)
 
114
        self.storage_kind = 'fulltext'
 
115
        self._weave = weave
 
116
 
 
117
    def get_bytes_as(self, storage_kind):
 
118
        if storage_kind == 'fulltext':
 
119
            return self._weave.get_text(self.key[-1])
 
120
        elif storage_kind == 'chunked':
 
121
            return self._weave.get_lines(self.key[-1])
 
122
        else:
 
123
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
 
124
 
 
125
 
100
126
class Weave(VersionedFile):
101
127
    """weave - versioned text file storage.
102
 
    
 
128
 
103
129
    A Weave manages versions of line-based text files, keeping track
104
130
    of the originating version for each line.
105
131
 
151
177
 
152
178
    * It doesn't seem very useful to have an active insertion
153
179
      inside an inactive insertion, but it might happen.
154
 
      
 
180
 
155
181
    * Therefore, all instructions are always"considered"; that
156
182
      is passed onto and off the stack.  An outer inactive block
157
183
      doesn't disable an inner block.
187
213
    """
188
214
 
189
215
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
190
 
                 '_weave_name', '_matcher']
191
 
    
192
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
193
 
        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__()
194
227
        self._weave = []
195
228
        self._parents = []
196
229
        self._sha1s = []
201
234
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
202
235
        else:
203
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
204
243
 
205
244
    def __repr__(self):
206
245
        return "Weave(%r)" % self._weave_name
207
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
 
208
254
    def copy(self):
209
255
        """Return a deep copy of self.
210
 
        
 
256
 
211
257
        The copy can be modified without affecting the original weave."""
212
258
        other = Weave()
213
259
        other._weave = self._weave[:]
223
269
            return False
224
270
        return self._parents == other._parents \
225
271
               and self._weave == other._weave \
226
 
               and self._sha1s == other._sha1s 
227
 
    
 
272
               and self._sha1s == other._sha1s
 
273
 
228
274
    def __ne__(self, other):
229
275
        return not self.__eq__(other)
230
276
 
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
 
 
236
277
    def _idx_to_name(self, version):
237
278
        return self._names[version]
238
279
 
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
 
 
248
280
    def _lookup(self, name):
249
281
        """Convert symbolic version name to index."""
250
 
        self.check_not_reserved_id(name)
 
282
        if not self._allow_reserved:
 
283
            self.check_not_reserved_id(name)
251
284
        try:
252
285
            return self._name_map[name]
253
286
        except KeyError:
254
287
            raise RevisionNotPresent(name, self._weave_name)
255
288
 
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
 
 
266
289
    def versions(self):
267
290
        """See VersionedFile.versions."""
268
291
        return self._names[:]
273
296
 
274
297
    __contains__ = has_version
275
298
 
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)
 
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 = {}
283
332
        for version_id in version_ids:
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
 
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:
347
341
                    continue
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
 
                                  )
 
342
            result[version_id] = parents
430
343
        return result
431
344
 
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)])
 
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
435
379
 
436
380
    def _check_repeated_add(self, name, parents, text, sha1):
437
381
        """Check that a duplicated add is OK.
444
388
            raise RevisionAlreadyPresent(name, self._weave_name)
445
389
        return idx
446
390
 
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):
 
391
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
392
       left_matching_blocks, nostore_sha, random_id, check_content):
453
393
        """See VersionedFile.add_lines."""
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):
 
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):
462
399
        """Add a single text on top of the weave.
463
 
  
 
400
 
464
401
        Returns the index number of the newly added version.
465
402
 
466
403
        version_id
467
404
            Symbolic name for this version.
468
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)
469
407
 
470
408
        parents
471
409
            List or set of direct parent version numbers.
472
 
            
 
410
 
473
411
        lines
474
412
            Sequence of lines to be added in the new version.
 
413
 
 
414
        :param nostore_sha: See VersionedFile.add_lines.
475
415
        """
476
 
 
477
 
        assert isinstance(version_id, basestring)
478
416
        self._check_lines_not_unicode(lines)
479
417
        self._check_lines_are_lines(lines)
480
418
        if not sha1:
481
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
482
424
        if version_id in self._name_map:
483
425
            return self._check_repeated_add(version_id, parents, lines, sha1)
484
426
 
495
437
        self._names.append(version_id)
496
438
        self._name_map[version_id] = new_version
497
439
 
498
 
            
 
440
 
499
441
        if not parents:
500
442
            # special case; adding with no parents revision; can do
501
443
            # this more quickly by just appending unconditionally.
512
454
            if sha1 == self._sha1s[pv]:
513
455
                # special case: same as the single parent
514
456
                return new_version
515
 
            
 
457
 
516
458
 
517
459
        ancestors = self._inclusions(parents)
518
460
 
528
470
        # another small special case: a merge, producing the same text
529
471
        # as auto-merge
530
472
        if lines == basis_lines:
531
 
            return new_version            
 
473
            return new_version
532
474
 
533
475
        # add a sentinel, because we can also match against the final line
534
476
        basis_lineno.append(len(self._weave))
553
495
            #print 'raw match', tag, i1, i2, j1, j2
554
496
            if tag == 'equal':
555
497
                continue
556
 
 
557
498
            i1 = basis_lineno[i1]
558
499
            i2 = basis_lineno[i2]
559
 
 
560
 
            assert 0 <= j1 <= j2 <= len(lines)
561
 
 
562
 
            #print tag, i1, i2, j1, j2
563
 
 
564
500
            # the deletion and insertion are handled separately.
565
501
            # first delete the region.
566
502
            if i1 != i2:
573
509
                # i2; we want to insert after this region to make sure
574
510
                # we don't destroy ourselves
575
511
                i = i2 + offset
576
 
                self._weave[i:i] = ([('{', new_version)] 
577
 
                                    + lines[j1:j2] 
 
512
                self._weave[i:i] = ([('{', new_version)]
 
513
                                    + lines[j1:j2]
578
514
                                    + [('}', None)])
579
515
                offset += 2 + (j2 - j1)
580
516
        return new_version
581
517
 
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
 
 
587
518
    def _inclusions(self, versions):
588
519
        """Return set of all ancestors of given version(s)."""
589
520
        if not len(versions):
597
528
        ## except IndexError:
598
529
        ##     raise ValueError("version %d not present in weave" % v)
599
530
 
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):
 
531
    def get_ancestry(self, version_ids, topo_sorted=True):
611
532
        """See VersionedFile.get_ancestry."""
612
533
        if isinstance(version_ids, basestring):
613
534
            version_ids = [version_ids]
622
543
            if not isinstance(l, basestring):
623
544
                raise ValueError("text line should be a string or unicode, not %s"
624
545
                                 % type(l))
625
 
        
 
546
 
626
547
 
627
548
 
628
549
    def _check_versions(self, indexes):
636
557
    def _compatible_parents(self, my_parents, other_parents):
637
558
        """During join check that other_parents are joinable with my_parents.
638
559
 
639
 
        Joinable is defined as 'is a subset of' - supersets may require 
 
560
        Joinable is defined as 'is a subset of' - supersets may require
640
561
        regeneration of diffs, but subsets do not.
641
562
        """
642
563
        return len(other_parents.difference(my_parents)) == 0
643
564
 
644
565
    def annotate(self, version_id):
645
 
        if isinstance(version_id, int):
646
 
            warnings.warn('Weave.annotate(int) is deprecated. Please use version names'
647
 
                 ' in all circumstances as of 0.8',
648
 
                 DeprecationWarning,
649
 
                 stacklevel=2
650
 
                 )
651
 
            result = []
652
 
            for origin, lineno, text in self._extract([version_id]):
653
 
                result.append((origin, text))
654
 
            return result
655
 
        else:
656
 
            return super(Weave, self).annotate(version_id)
657
 
    
658
 
    def annotate_iter(self, version_id):
659
 
        """Yield list of (version-id, line) pairs for the specified version.
 
566
        """Return a list of (version-id, line) tuples for version_id.
660
567
 
661
568
        The index indicates when the line originated in the weave."""
662
569
        incls = [self._lookup(version_id)]
663
 
        for origin, lineno, text in self._extract(incls):
664
 
            yield self._idx_to_name(origin), text
665
 
 
666
 
    @deprecated_method(zero_eight)
667
 
    def _walk(self):
668
 
        """_walk has become visit, a supported api."""
669
 
        return self._walk_internal()
 
570
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
 
571
            self._extract(incls)]
670
572
 
671
573
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
672
574
                                                pb=None):
675
577
            version_ids = self.versions()
676
578
        version_ids = set(version_ids)
677
579
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
678
 
            # if inserted not in version_ids then it was inserted before the
679
 
            # versions we care about, but because weaves cannot represent ghosts
680
 
            # properly, we do not filter down to that
681
 
            # if inserted not in version_ids: continue
 
580
            if inserted not in version_ids: continue
682
581
            if line[-1] != '\n':
683
 
                yield line + '\n'
 
582
                yield line + '\n', inserted
684
583
            else:
685
 
                yield line
686
 
 
687
 
    #@deprecated_method(zero_eight)
688
 
    def walk(self, version_ids=None):
689
 
        """See VersionedFile.walk."""
690
 
        return self._walk_internal(version_ids)
 
584
                yield line, inserted
691
585
 
692
586
    def _walk_internal(self, version_ids=None):
693
587
        """Helper method for weave actions."""
694
 
        
 
588
 
695
589
        istack = []
696
590
        dset = set()
697
591
 
706
600
                elif c == '}':
707
601
                    istack.pop()
708
602
                elif c == '[':
709
 
                    assert self._names[v] not in dset
710
603
                    dset.add(self._names[v])
711
604
                elif c == ']':
712
605
                    dset.remove(self._names[v])
713
606
                else:
714
607
                    raise WeaveFormatError('unexpected instruction %r' % v)
715
608
            else:
716
 
                assert l.__class__ in (str, unicode)
717
 
                assert istack
718
609
                yield lineno, istack[-1], frozenset(dset), l
719
610
            lineno += 1
720
611
 
737
628
        inc_b = set(self.get_ancestry([ver_b]))
738
629
        inc_c = inc_a & inc_b
739
630
 
740
 
        for lineno, insert, deleteset, line in\
741
 
            self.walk([ver_a, ver_b]):
 
631
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
742
632
            if deleteset & inc_c:
743
633
                # killed in parent; can't be in either a or b
744
634
                # not relevant to our work
770
660
                # not in either revision
771
661
                yield 'irrelevant', line
772
662
 
773
 
        yield 'unchanged', ''           # terminator
774
 
 
775
663
    def _extract(self, versions):
776
664
        """Yield annotation of lines in included set.
777
665
 
784
672
        for i in versions:
785
673
            if not isinstance(i, int):
786
674
                raise ValueError(i)
787
 
            
 
675
 
788
676
        included = self._inclusions(versions)
789
677
 
790
678
        istack = []
799
687
 
800
688
        WFE = WeaveFormatError
801
689
 
802
 
        # wow. 
 
690
        # wow.
803
691
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
804
692
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
805
693
        # 1.6 seconds in 'isinstance'.
811
699
        # we're still spending ~1/4 of the method in isinstance though.
812
700
        # so lets hard code the acceptable string classes we expect:
813
701
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
814
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
702
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
815
703
        #                                          objects>
816
704
        # yay, down to ~1/4 the initial extract time, and our inline time
817
705
        # has shrunk again, with isinstance no longer dominating.
818
706
        # tweaking the stack inclusion test to use a set gives:
819
707
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
820
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
708
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
821
709
        #                                          objects>
822
710
        # - a 5% win, or possibly just noise. However with large istacks that
823
711
        # 'in' test could dominate, so I'm leaving this change in place -
824
712
        # when its fast enough to consider profiling big datasets we can review.
825
713
 
826
 
              
827
 
             
 
714
 
 
715
 
828
716
 
829
717
        for l in self._weave:
830
718
            if l.__class__ == tuple:
831
719
                c, v = l
832
720
                isactive = None
833
721
                if c == '{':
834
 
                    assert v not in iset
835
722
                    istack.append(v)
836
723
                    iset.add(v)
837
724
                elif c == '}':
838
725
                    iset.remove(istack.pop())
839
726
                elif c == '[':
840
727
                    if v in included:
841
 
                        assert v not in dset
842
728
                        dset.add(v)
843
 
                else:
844
 
                    assert c == ']'
 
729
                elif c == ']':
845
730
                    if v in included:
846
 
                        assert v in dset
847
731
                        dset.remove(v)
 
732
                else:
 
733
                    raise AssertionError()
848
734
            else:
849
 
                assert l.__class__ in (str, unicode)
850
735
                if isactive is None:
851
736
                    isactive = (not dset) and istack and (istack[-1] in included)
852
737
                if isactive:
860
745
                                   % dset)
861
746
        return result
862
747
 
863
 
    @deprecated_method(zero_eight)
864
 
    def get_iter(self, name_or_index):
865
 
        """Deprecated, please do not use. Lookups are not not needed.
866
 
        
867
 
        Please use get_lines now.
868
 
        """
869
 
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
870
 
 
871
 
    @deprecated_method(zero_eight)
872
 
    def maybe_lookup(self, name_or_index):
873
 
        """Deprecated, please do not use. Lookups are not not needed."""
874
 
        return self._maybe_lookup(name_or_index)
875
 
 
876
748
    def _maybe_lookup(self, name_or_index):
877
749
        """Convert possible symbolic name to index, or pass through indexes.
878
 
        
 
750
 
879
751
        NOT FOR PUBLIC USE.
880
752
        """
881
753
        if isinstance(name_or_index, (int, long)):
883
755
        else:
884
756
            return self._lookup(name_or_index)
885
757
 
886
 
    @deprecated_method(zero_eight)
887
 
    def get(self, version_id):
888
 
        """Please use either Weave.get_text or Weave.get_lines as desired."""
889
 
        return self.get_lines(version_id)
890
 
 
891
758
    def get_lines(self, version_id):
892
759
        """See VersionedFile.get_lines()."""
893
760
        int_index = self._maybe_lookup(version_id)
896
763
        measured_sha1 = sha_strings(result)
897
764
        if measured_sha1 != expected_sha1:
898
765
            raise errors.WeaveInvalidChecksum(
899
 
                    'file %s, revision %s, expected: %s, measured %s' 
 
766
                    'file %s, revision %s, expected: %s, measured %s'
900
767
                    % (self._weave_name, version_id,
901
768
                       expected_sha1, measured_sha1))
902
769
        return result
903
770
 
904
 
    def get_sha1(self, version_id):
905
 
        """See VersionedFile.get_sha1()."""
906
 
        return self._sha1s[self._lookup(version_id)]
907
 
 
908
 
    @deprecated_method(zero_eight)
909
 
    def numversions(self):
910
 
        """How many versions are in this weave?
911
 
 
912
 
        Deprecated in favour of num_versions.
913
 
        """
914
 
        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
915
777
 
916
778
    def num_versions(self):
917
779
        """How many versions are in this weave?"""
918
780
        l = len(self._parents)
919
 
        assert l == len(self._sha1s)
920
781
        return l
921
782
 
922
783
    __len__ = num_versions
942
803
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
943
804
            # The problem is that set membership is much more expensive
944
805
            name = self._idx_to_name(i)
945
 
            sha1s[name] = sha.new()
 
806
            sha1s[name] = sha()
946
807
            texts[name] = []
947
808
            new_inc = set([name])
948
809
            for p in self._parents[i]:
949
810
                new_inc.update(inclusions[self._idx_to_name(p)])
950
811
 
951
 
            assert set(new_inc) == set(self.get_ancestry(name)), \
952
 
                '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))))
953
816
            inclusions[name] = new_inc
954
817
 
955
818
        nlines = len(self._weave)
985
848
        # no lines outside of insertion blocks, that deletions are
986
849
        # properly paired, etc.
987
850
 
988
 
    def _join(self, other, pb, msg, version_ids, ignore_missing):
989
 
        """Worker routine for join()."""
990
 
        if not other.versions():
991
 
            return          # nothing to update, easy
992
 
 
993
 
        if not version_ids:
994
 
            # versions is never none, InterWeave checks this.
995
 
            return 0
996
 
 
997
 
        # two loops so that we do not change ourselves before verifying it
998
 
        # will be ok
999
 
        # work through in index order to make sure we get all dependencies
1000
 
        names_to_join = []
1001
 
        processed = 0
1002
 
        # get the selected versions only that are in other.versions.
1003
 
        version_ids = set(other.versions()).intersection(set(version_ids))
1004
 
        # pull in the referenced graph.
1005
 
        version_ids = other.get_ancestry(version_ids)
1006
 
        pending_graph = [(version, other.get_parents(version)) for
1007
 
                         version in version_ids]
1008
 
        for name in topo_sort(pending_graph):
1009
 
            other_idx = other._name_map[name]
1010
 
            # returns True if we have it, False if we need it.
1011
 
            if not self._check_version_consistent(other, other_idx, name):
1012
 
                names_to_join.append((other_idx, name))
1013
 
            processed += 1
1014
 
 
1015
 
 
1016
 
        if pb and not msg:
1017
 
            msg = 'weave join'
1018
 
 
1019
 
        merged = 0
1020
 
        time0 = time.time()
1021
 
        for other_idx, name in names_to_join:
1022
 
            # TODO: If all the parents of the other version are already
1023
 
            # present then we can avoid some work by just taking the delta
1024
 
            # and adjusting the offsets.
1025
 
            new_parents = self._imported_parents(other, other_idx)
1026
 
            sha1 = other._sha1s[other_idx]
1027
 
 
1028
 
            merged += 1
1029
 
 
1030
 
            if pb:
1031
 
                pb.update(msg, merged, len(names_to_join))
1032
 
           
1033
 
            lines = other.get_lines(other_idx)
1034
 
            self._add(name, lines, new_parents, sha1)
1035
 
 
1036
 
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
1037
 
                merged, processed, self._weave_name, time.time()-time0))
1038
 
 
1039
851
    def _imported_parents(self, other, other_idx):
1040
852
        """Return list of parents in self corresponding to indexes in other."""
1041
853
        new_parents = []
1043
855
            parent_name = other._names[parent_idx]
1044
856
            if parent_name not in self._name_map:
1045
857
                # should not be possible
1046
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
858
                raise WeaveError("missing parent {%s} of {%s} in %r"
1047
859
                                 % (parent_name, other._name_map[other_idx], self))
1048
860
            new_parents.append(self._name_map[parent_name])
1049
861
        return new_parents
1056
868
         * the same text
1057
869
         * the same direct parents (by name, not index, and disregarding
1058
870
           order)
1059
 
        
 
871
 
1060
872
        If present & correct return True;
1061
 
        if not present in self return False; 
 
873
        if not present in self return False;
1062
874
        if inconsistent raise error."""
1063
875
        this_idx = self._name_map.get(name, -1)
1064
876
        if this_idx != -1:
1076
888
        else:
1077
889
            return False
1078
890
 
1079
 
    @deprecated_method(zero_eight)
1080
 
    def reweave(self, other, pb=None, msg=None):
1081
 
        """reweave has been superseded by plain use of join."""
1082
 
        return self.join(other, pb, msg)
1083
 
 
1084
891
    def _reweave(self, other, pb, msg):
1085
892
        """Reweave self with other - internal helper for join().
1086
893
 
1102
909
    """A WeaveFile represents a Weave on disk and writes on change."""
1103
910
 
1104
911
    WEAVE_SUFFIX = '.weave'
1105
 
    
1106
 
    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):
1107
914
        """Create a WeaveFile.
1108
 
        
 
915
 
1109
916
        :param create: If not True, only open an existing knit.
1110
917
        """
1111
 
        super(WeaveFile, self).__init__(name, access_mode)
 
918
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
 
919
            allow_reserved=False)
1112
920
        self._transport = transport
1113
921
        self._filemode = filemode
1114
922
        try:
1115
 
            _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)
1116
925
        except errors.NoSuchFile:
1117
926
            if not create:
1118
927
                raise
1119
928
            # new file, save it
1120
929
            self._save()
1121
930
 
1122
 
    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):
1123
933
        """Add a version and save the weave."""
1124
934
        self.check_not_reserved_id(version_id)
1125
935
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
1126
 
                                                   parent_texts)
 
936
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
937
            check_content)
1127
938
        self._save()
1128
939
        return result
1129
940
 
1130
 
    def _clone_text(self, new_version_id, old_version_id, parents):
1131
 
        """See VersionedFile.clone_text."""
1132
 
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
1133
 
        self._save
1134
 
 
1135
941
    def copy_to(self, name, transport):
1136
942
        """See VersionedFile.copy_to()."""
1137
943
        # as we are all in memory always, just serialise to the new place.
1140
946
        sio.seek(0)
1141
947
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
1142
948
 
1143
 
    def create_empty(self, name, transport, filemode=None):
1144
 
        return WeaveFile(name, transport, filemode, create=True)
1145
 
 
1146
949
    def _save(self):
1147
950
        """Save the weave."""
1148
951
        self._check_write_ok()
1149
952
        sio = StringIO()
1150
953
        write_weave_v5(self, sio)
1151
954
        sio.seek(0)
1152
 
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
1153
 
                                 sio,
1154
 
                                 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)
1155
962
 
1156
963
    @staticmethod
1157
964
    def get_suffixes():
1158
965
        """See VersionedFile.get_suffixes()."""
1159
966
        return [WeaveFile.WEAVE_SUFFIX]
1160
967
 
1161
 
    def join(self, other, pb=None, msg=None, version_ids=None,
1162
 
             ignore_missing=False):
1163
 
        """Join other into self and save."""
1164
 
        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)
1165
970
        self._save()
1166
971
 
1167
972
 
1168
 
@deprecated_function(zero_eight)
1169
 
def reweave(wa, wb, pb=None, msg=None):
1170
 
    """reweaving is deprecation, please just use weave.join()."""
1171
 
    _reweave(wa, wb, pb, msg)
1172
 
 
1173
973
def _reweave(wa, wb, pb=None, msg=None):
1174
974
    """Combine two weaves and return the result.
1175
975
 
1176
 
    This works even if a revision R has different parents in 
 
976
    This works even if a revision R has different parents in
1177
977
    wa and wb.  In the resulting weave all the parents are given.
1178
978
 
1179
 
    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
1180
980
    of the versions in the two inputs.  More efficient approaches
1181
 
    might be possible but it should only be necessary to do 
1182
 
    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
1183
983
    inserted.
1184
984
 
1185
985
    :param pb: An optional progress bar, indicating how far done we are
1193
993
    # map from version name -> all parent names
1194
994
    combined_parents = _reweave_parent_graphs(wa, wb)
1195
995
    mutter("combined parents: %r", combined_parents)
1196
 
    order = topo_sort(combined_parents.iteritems())
 
996
    order = tsort.topo_sort(combined_parents.iteritems())
1197
997
    mutter("order to reweave: %r", order)
1198
998
 
1199
999
    if pb and not msg:
1219
1019
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1220
1020
    return wr
1221
1021
 
 
1022
 
1222
1023
def _reweave_parent_graphs(wa, wb):
1223
1024
    """Return combined parent ancestry for two weaves.
1224
 
    
 
1025
 
1225
1026
    Returned as a list of (version_name, set(parent_names))"""
1226
1027
    combined = {}
1227
1028
    for weave in [wa, wb]:
1229
1030
            p = combined.setdefault(name, set())
1230
1031
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1231
1032
    return combined
1232
 
 
1233
 
 
1234
 
def weave_toc(w):
1235
 
    """Show the weave's table-of-contents"""
1236
 
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
1237
 
    for i in (6, 50, 10, 10):
1238
 
        print '-' * i,
1239
 
    print
1240
 
    for i in range(w.num_versions()):
1241
 
        sha1 = w._sha1s[i]
1242
 
        name = w._names[i]
1243
 
        parent_str = ' '.join(map(str, w._parents[i]))
1244
 
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
1245
 
 
1246
 
 
1247
 
 
1248
 
def weave_stats(weave_file, pb):
1249
 
    from bzrlib.weavefile import read_weave
1250
 
 
1251
 
    wf = file(weave_file, 'rb')
1252
 
    w = read_weave(wf)
1253
 
    # FIXME: doesn't work on pipes
1254
 
    weave_size = wf.tell()
1255
 
 
1256
 
    total = 0
1257
 
    vers = len(w)
1258
 
    for i in range(vers):
1259
 
        pb.update('checking sizes', i, vers)
1260
 
        for origin, lineno, line in w._extract([i]):
1261
 
            total += len(line)
1262
 
 
1263
 
    pb.clear()
1264
 
 
1265
 
    print 'versions          %9d' % vers
1266
 
    print 'weave file        %9d bytes' % weave_size
1267
 
    print 'total contents    %9d bytes' % total
1268
 
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1269
 
    if vers:
1270
 
        avg = total/vers
1271
 
        print 'average size      %9d bytes' % avg
1272
 
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
1273
 
 
1274
 
 
1275
 
def usage():
1276
 
    print """bzr weave tool
1277
 
 
1278
 
Experimental tool for weave algorithm.
1279
 
 
1280
 
usage:
1281
 
    weave init WEAVEFILE
1282
 
        Create an empty weave file
1283
 
    weave get WEAVEFILE VERSION
1284
 
        Write out specified version.
1285
 
    weave check WEAVEFILE
1286
 
        Check consistency of all versions.
1287
 
    weave toc WEAVEFILE
1288
 
        Display table of contents.
1289
 
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1290
 
        Add NEWTEXT, with specified parent versions.
1291
 
    weave annotate WEAVEFILE VERSION
1292
 
        Display origin of each line.
1293
 
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1294
 
        Auto-merge two versions and display conflicts.
1295
 
    weave diff WEAVEFILE VERSION1 VERSION2 
1296
 
        Show differences between two versions.
1297
 
 
1298
 
example:
1299
 
 
1300
 
    % weave init foo.weave
1301
 
    % vi foo.txt
1302
 
    % weave add foo.weave ver0 < foo.txt
1303
 
    added version 0
1304
 
 
1305
 
    (create updated version)
1306
 
    % vi foo.txt
1307
 
    % weave get foo.weave 0 | diff -u - foo.txt
1308
 
    % weave add foo.weave ver1 0 < foo.txt
1309
 
    added version 1
1310
 
 
1311
 
    % weave get foo.weave 0 > foo.txt       (create forked version)
1312
 
    % vi foo.txt
1313
 
    % weave add foo.weave ver2 0 < foo.txt
1314
 
    added version 2
1315
 
 
1316
 
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
1317
 
    % vi foo.txt                            (resolve conflicts)
1318
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
1319
 
    
1320
 
"""
1321
 
    
1322
 
 
1323
 
 
1324
 
def main(argv):
1325
 
    import sys
1326
 
    import os
1327
 
    try:
1328
 
        import bzrlib
1329
 
    except ImportError:
1330
 
        # in case we're run directly from the subdirectory
1331
 
        sys.path.append('..')
1332
 
        import bzrlib
1333
 
    from bzrlib.weavefile import write_weave, read_weave
1334
 
    from bzrlib.progress import ProgressBar
1335
 
 
1336
 
    try:
1337
 
        import psyco
1338
 
        psyco.full()
1339
 
    except ImportError:
1340
 
        pass
1341
 
 
1342
 
    if len(argv) < 2:
1343
 
        usage()
1344
 
        return 0
1345
 
 
1346
 
    cmd = argv[1]
1347
 
 
1348
 
    def readit():
1349
 
        return read_weave(file(argv[2], 'rb'))
1350
 
    
1351
 
    if cmd == 'help':
1352
 
        usage()
1353
 
    elif cmd == 'add':
1354
 
        w = readit()
1355
 
        # at the moment, based on everything in the file
1356
 
        name = argv[3]
1357
 
        parents = map(int, argv[4:])
1358
 
        lines = sys.stdin.readlines()
1359
 
        ver = w.add(name, parents, lines)
1360
 
        write_weave(w, file(argv[2], 'wb'))
1361
 
        print 'added version %r %d' % (name, ver)
1362
 
    elif cmd == 'init':
1363
 
        fn = argv[2]
1364
 
        if os.path.exists(fn):
1365
 
            raise IOError("file exists")
1366
 
        w = Weave()
1367
 
        write_weave(w, file(fn, 'wb'))
1368
 
    elif cmd == 'get': # get one version
1369
 
        w = readit()
1370
 
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1371
 
        
1372
 
    elif cmd == 'diff':
1373
 
        w = readit()
1374
 
        fn = argv[2]
1375
 
        v1, v2 = map(int, argv[3:5])
1376
 
        lines1 = w.get(v1)
1377
 
        lines2 = w.get(v2)
1378
 
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1379
 
                                '%s version %d' % (fn, v1),
1380
 
                                '%s version %d' % (fn, v2))
1381
 
        sys.stdout.writelines(diff_gen)
1382
 
            
1383
 
    elif cmd == 'annotate':
1384
 
        w = readit()
1385
 
        # newline is added to all lines regardless; too hard to get
1386
 
        # reasonable formatting otherwise
1387
 
        lasto = None
1388
 
        for origin, text in w.annotate(int(argv[3])):
1389
 
            text = text.rstrip('\r\n')
1390
 
            if origin == lasto:
1391
 
                print '      | %s' % (text)
1392
 
            else:
1393
 
                print '%5d | %s' % (origin, text)
1394
 
                lasto = origin
1395
 
                
1396
 
    elif cmd == 'toc':
1397
 
        weave_toc(readit())
1398
 
 
1399
 
    elif cmd == 'stats':
1400
 
        weave_stats(argv[2], ProgressBar())
1401
 
        
1402
 
    elif cmd == 'check':
1403
 
        w = readit()
1404
 
        pb = ProgressBar()
1405
 
        w.check(pb)
1406
 
        pb.clear()
1407
 
        print '%d versions ok' % w.num_versions()
1408
 
 
1409
 
    elif cmd == 'inclusions':
1410
 
        w = readit()
1411
 
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
1412
 
 
1413
 
    elif cmd == 'parents':
1414
 
        w = readit()
1415
 
        print ' '.join(map(str, w._parents[int(argv[3])]))
1416
 
 
1417
 
    elif cmd == 'plan-merge':
1418
 
        # replaced by 'bzr weave-plan-merge'
1419
 
        w = readit()
1420
 
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1421
 
            if line:
1422
 
                print '%14s | %s' % (state, line),
1423
 
    elif cmd == 'merge':
1424
 
        # replaced by 'bzr weave-merge-text'
1425
 
        w = readit()
1426
 
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1427
 
        sys.stdout.writelines(w.weave_merge(p))
1428
 
    else:
1429
 
        raise ValueError('unknown command %r' % cmd)
1430
 
    
1431
 
 
1432
 
if __name__ == '__main__':
1433
 
    import sys
1434
 
    sys.exit(main(sys.argv))
1435
 
 
1436
 
 
1437
 
class InterWeave(InterVersionedFile):
1438
 
    """Optimised code paths for weave to weave operations."""
1439
 
    
1440
 
    _matching_file_from_factory = staticmethod(WeaveFile)
1441
 
    _matching_file_to_factory = staticmethod(WeaveFile)
1442
 
    
1443
 
    @staticmethod
1444
 
    def is_compatible(source, target):
1445
 
        """Be compatible with weaves."""
1446
 
        try:
1447
 
            return (isinstance(source, Weave) and
1448
 
                    isinstance(target, Weave))
1449
 
        except AttributeError:
1450
 
            return False
1451
 
 
1452
 
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
1453
 
        """See InterVersionedFile.join."""
1454
 
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
1455
 
        if self.target.versions() == [] and version_ids is None:
1456
 
            self.target._copy_weave_content(self.source)
1457
 
            return
1458
 
        try:
1459
 
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
1460
 
        except errors.WeaveParentMismatch:
1461
 
            self.target._reweave(self.source, pb, msg)
1462
 
 
1463
 
 
1464
 
InterVersionedFile.register_optimiser(InterWeave)