/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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