~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: John Arbash Meinel
  • Date: 2007-08-02 21:00:51 UTC
  • mto: This revision was merged to the branch mainline in revision 2670.
  • Revision ID: john@arbash-meinel.com-20070802210051-lqpg4mgbeyl3h2ld
(Lukáš Lalinský) Add a special header for intptr_t for MSVC which doesn't have it in the standard place

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
#
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
 
# 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
18
18
 
19
19
# Author: Martin Pool <mbp@canonical.com>
20
20
 
61
61
# where the basis and destination are unchanged.
62
62
 
63
63
# FIXME: Sometimes we will be given a parents list for a revision
64
 
# that includes some redundant parents (i.e. already a parent of
65
 
# something in the list.)  We should eliminate them.  This can
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
66
66
# be done fairly efficiently because the sequence numbers constrain
67
67
# the possible relationships.
68
68
 
71
71
from copy import copy
72
72
from cStringIO import StringIO
73
73
import os
 
74
import sha
74
75
import time
75
76
import warnings
76
77
 
77
 
from bzrlib.lazy_import import lazy_import
78
 
lazy_import(globals(), """
79
 
from bzrlib import tsort
80
 
""")
81
78
from bzrlib import (
82
 
    errors,
83
 
    osutils,
84
79
    progress,
85
80
    )
 
81
from bzrlib.trace import mutter
86
82
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
87
83
        RevisionAlreadyPresent,
88
84
        RevisionNotPresent,
89
 
        UnavailableRepresentation,
90
85
        WeaveRevisionAlreadyPresent,
91
86
        WeaveRevisionNotPresent,
92
87
        )
93
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
 
88
import bzrlib.errors as errors
 
89
from bzrlib.osutils import sha_strings
94
90
import bzrlib.patiencediff
95
 
from bzrlib.revision import NULL_REVISION
96
 
from bzrlib.symbol_versioning import *
97
 
from bzrlib.trace import mutter
98
 
from bzrlib.versionedfile import (
99
 
    AbsentContentFactory,
100
 
    adapter_registry,
101
 
    ContentFactory,
102
 
    sort_groupcompress,
103
 
    VersionedFile,
104
 
    )
 
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
105
97
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
106
98
 
107
99
 
108
 
class WeaveContentFactory(ContentFactory):
109
 
    """Content factory for streaming from weaves.
110
 
 
111
 
    :seealso ContentFactory:
112
 
    """
113
 
 
114
 
    def __init__(self, version, weave):
115
 
        """Create a WeaveContentFactory for version from weave."""
116
 
        ContentFactory.__init__(self)
117
 
        self.sha1 = weave.get_sha1s([version])[version]
118
 
        self.key = (version,)
119
 
        parents = weave.get_parent_map([version])[version]
120
 
        self.parents = tuple((parent,) for parent in parents)
121
 
        self.storage_kind = 'fulltext'
122
 
        self._weave = weave
123
 
 
124
 
    def get_bytes_as(self, storage_kind):
125
 
        if storage_kind == 'fulltext':
126
 
            return self._weave.get_text(self.key[-1])
127
 
        elif storage_kind == 'chunked':
128
 
            return self._weave.get_lines(self.key[-1])
129
 
        else:
130
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
131
 
 
132
 
 
133
100
class Weave(VersionedFile):
134
101
    """weave - versioned text file storage.
135
 
 
 
102
    
136
103
    A Weave manages versions of line-based text files, keeping track
137
104
    of the originating version for each line.
138
105
 
184
151
 
185
152
    * It doesn't seem very useful to have an active insertion
186
153
      inside an inactive insertion, but it might happen.
187
 
 
 
154
      
188
155
    * Therefore, all instructions are always"considered"; that
189
156
      is passed onto and off the stack.  An outer inactive block
190
157
      doesn't disable an inner block.
220
187
    """
221
188
 
222
189
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
223
 
                 '_weave_name', '_matcher', '_allow_reserved']
224
 
 
225
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
226
 
                 get_scope=None, allow_reserved=False):
227
 
        """Create a weave.
228
 
 
229
 
        :param get_scope: A callable that returns an opaque object to be used
230
 
            for detecting when this weave goes out of scope (should stop
231
 
            answering requests or allowing mutation).
232
 
        """
233
 
        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)
234
194
        self._weave = []
235
195
        self._parents = []
236
196
        self._sha1s = []
241
201
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
242
202
        else:
243
203
            self._matcher = matcher
244
 
        if get_scope is None:
245
 
            get_scope = lambda:None
246
 
        self._get_scope = get_scope
247
 
        self._scope = get_scope()
248
 
        self._access_mode = access_mode
249
 
        self._allow_reserved = allow_reserved
250
204
 
251
205
    def __repr__(self):
252
206
        return "Weave(%r)" % self._weave_name
253
207
 
254
 
    def _check_write_ok(self):
255
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
256
 
        if self._get_scope() != self._scope:
257
 
            raise errors.OutSideTransaction()
258
 
        if self._access_mode != 'w':
259
 
            raise errors.ReadOnlyObjectDirtiedError(self)
260
 
 
261
208
    def copy(self):
262
209
        """Return a deep copy of self.
263
 
 
 
210
        
264
211
        The copy can be modified without affecting the original weave."""
265
212
        other = Weave()
266
213
        other._weave = self._weave[:]
276
223
            return False
277
224
        return self._parents == other._parents \
278
225
               and self._weave == other._weave \
279
 
               and self._sha1s == other._sha1s
280
 
 
 
226
               and self._sha1s == other._sha1s 
 
227
    
281
228
    def __ne__(self, other):
282
229
        return not self.__eq__(other)
283
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
 
284
236
    def _idx_to_name(self, version):
285
237
        return self._names[version]
286
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
 
287
248
    def _lookup(self, name):
288
249
        """Convert symbolic version name to index."""
289
 
        if not self._allow_reserved:
290
 
            self.check_not_reserved_id(name)
 
250
        self.check_not_reserved_id(name)
291
251
        try:
292
252
            return self._name_map[name]
293
253
        except KeyError:
294
254
            raise RevisionNotPresent(name, self._weave_name)
295
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
 
296
266
    def versions(self):
297
267
        """See VersionedFile.versions."""
298
268
        return self._names[:]
303
273
 
304
274
    __contains__ = has_version
305
275
 
306
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
307
 
        """Get a stream of records for versions.
308
 
 
309
 
        :param versions: The versions to include. Each version is a tuple
310
 
            (version,).
311
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
312
 
            sorted stream has compression parents strictly before their
313
 
            children.
314
 
        :param include_delta_closure: If True then the closure across any
315
 
            compression parents will be included (in the opaque data).
316
 
        :return: An iterator of ContentFactory objects, each of which is only
317
 
            valid until the iterator is advanced.
318
 
        """
319
 
        versions = [version[-1] for version in versions]
320
 
        if ordering == 'topological':
321
 
            parents = self.get_parent_map(versions)
322
 
            new_versions = tsort.topo_sort(parents)
323
 
            new_versions.extend(set(versions).difference(set(parents)))
324
 
            versions = new_versions
325
 
        elif ordering == 'groupcompress':
326
 
            parents = self.get_parent_map(versions)
327
 
            new_versions = sort_groupcompress(parents)
328
 
            new_versions.extend(set(versions).difference(set(parents)))
329
 
            versions = new_versions
330
 
        for version in versions:
331
 
            if version in self:
332
 
                yield WeaveContentFactory(version, self)
333
 
            else:
334
 
                yield AbsentContentFactory((version,))
335
 
 
336
 
    def get_parent_map(self, version_ids):
337
 
        """See VersionedFile.get_parent_map."""
338
 
        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)
339
283
        for version_id in version_ids:
340
 
            if version_id == NULL_REVISION:
341
 
                parents = ()
342
 
            else:
343
 
                try:
344
 
                    parents = tuple(
345
 
                        map(self._idx_to_name,
346
 
                            self._parents[self._lookup(version_id)]))
347
 
                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
348
347
                    continue
349
 
            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
                                  )
350
430
        return result
351
431
 
352
 
    def get_parents_with_ghosts(self, version_id):
353
 
        raise NotImplementedError(self.get_parents_with_ghosts)
354
 
 
355
 
    def insert_record_stream(self, stream):
356
 
        """Insert a record stream into this versioned file.
357
 
 
358
 
        :param stream: A stream of records to insert.
359
 
        :return: None
360
 
        :seealso VersionedFile.get_record_stream:
361
 
        """
362
 
        adapters = {}
363
 
        for record in stream:
364
 
            # Raise an error when a record is missing.
365
 
            if record.storage_kind == 'absent':
366
 
                raise RevisionNotPresent([record.key[0]], self)
367
 
            # adapt to non-tuple interface
368
 
            parents = [parent[0] for parent in record.parents]
369
 
            if (record.storage_kind == 'fulltext'
370
 
                or record.storage_kind == 'chunked'):
371
 
                self.add_lines(record.key[0], parents,
372
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
373
 
            else:
374
 
                adapter_key = record.storage_kind, 'fulltext'
375
 
                try:
376
 
                    adapter = adapters[adapter_key]
377
 
                except KeyError:
378
 
                    adapter_factory = adapter_registry.get(adapter_key)
379
 
                    adapter = adapter_factory(self)
380
 
                    adapters[adapter_key] = adapter
381
 
                lines = split_lines(adapter.get_bytes(record))
382
 
                try:
383
 
                    self.add_lines(record.key[0], parents, lines)
384
 
                except RevisionAlreadyPresent:
385
 
                    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)])
386
435
 
387
436
    def _check_repeated_add(self, name, parents, text, sha1):
388
437
        """Check that a duplicated add is OK.
395
444
            raise RevisionAlreadyPresent(name, self._weave_name)
396
445
        return idx
397
446
 
398
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
399
 
       left_matching_blocks, nostore_sha, random_id, check_content):
 
447
    @deprecated_method(zero_eight)
 
448
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
449
        """Please use Weave.clone_text now."""
 
450
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
451
 
 
452
    def _add_lines(self, version_id, parents, lines, parent_texts):
400
453
        """See VersionedFile.add_lines."""
401
 
        idx = self._add(version_id, lines, map(self._lookup, parents),
402
 
            nostore_sha=nostore_sha)
403
 
        return sha_strings(lines), sum(map(len, lines)), idx
404
 
 
405
 
    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):
406
462
        """Add a single text on top of the weave.
407
 
 
 
463
  
408
464
        Returns the index number of the newly added version.
409
465
 
410
466
        version_id
411
467
            Symbolic name for this version.
412
468
            (Typically the revision-id of the revision that added it.)
413
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
414
469
 
415
470
        parents
416
471
            List or set of direct parent version numbers.
417
 
 
 
472
            
418
473
        lines
419
474
            Sequence of lines to be added in the new version.
 
475
        """
420
476
 
421
 
        :param nostore_sha: See VersionedFile.add_lines.
422
 
        """
 
477
        assert isinstance(version_id, basestring)
423
478
        self._check_lines_not_unicode(lines)
424
479
        self._check_lines_are_lines(lines)
425
480
        if not sha1:
426
481
            sha1 = sha_strings(lines)
427
 
        if sha1 == nostore_sha:
428
 
            raise errors.ExistingContent
429
 
        if version_id is None:
430
 
            version_id = "sha1:" + sha1
431
482
        if version_id in self._name_map:
432
483
            return self._check_repeated_add(version_id, parents, lines, sha1)
433
484
 
444
495
        self._names.append(version_id)
445
496
        self._name_map[version_id] = new_version
446
497
 
447
 
 
 
498
            
448
499
        if not parents:
449
500
            # special case; adding with no parents revision; can do
450
501
            # this more quickly by just appending unconditionally.
461
512
            if sha1 == self._sha1s[pv]:
462
513
                # special case: same as the single parent
463
514
                return new_version
464
 
 
 
515
            
465
516
 
466
517
        ancestors = self._inclusions(parents)
467
518
 
477
528
        # another small special case: a merge, producing the same text
478
529
        # as auto-merge
479
530
        if lines == basis_lines:
480
 
            return new_version
 
531
            return new_version            
481
532
 
482
533
        # add a sentinel, because we can also match against the final line
483
534
        basis_lineno.append(len(self._weave))
502
553
            #print 'raw match', tag, i1, i2, j1, j2
503
554
            if tag == 'equal':
504
555
                continue
 
556
 
505
557
            i1 = basis_lineno[i1]
506
558
            i2 = basis_lineno[i2]
 
559
 
 
560
            assert 0 <= j1 <= j2 <= len(lines)
 
561
 
 
562
            #print tag, i1, i2, j1, j2
 
563
 
507
564
            # the deletion and insertion are handled separately.
508
565
            # first delete the region.
509
566
            if i1 != i2:
516
573
                # i2; we want to insert after this region to make sure
517
574
                # we don't destroy ourselves
518
575
                i = i2 + offset
519
 
                self._weave[i:i] = ([('{', new_version)]
520
 
                                    + lines[j1:j2]
 
576
                self._weave[i:i] = ([('{', new_version)] 
 
577
                                    + lines[j1:j2] 
521
578
                                    + [('}', None)])
522
579
                offset += 2 + (j2 - j1)
523
580
        return new_version
524
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
 
525
587
    def _inclusions(self, versions):
526
588
        """Return set of all ancestors of given version(s)."""
527
589
        if not len(versions):
535
597
        ## except IndexError:
536
598
        ##     raise ValueError("version %d not present in weave" % v)
537
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
 
538
610
    def get_ancestry(self, version_ids, topo_sorted=True):
539
611
        """See VersionedFile.get_ancestry."""
540
612
        if isinstance(version_ids, basestring):
550
622
            if not isinstance(l, basestring):
551
623
                raise ValueError("text line should be a string or unicode, not %s"
552
624
                                 % type(l))
553
 
 
 
625
        
554
626
 
555
627
 
556
628
    def _check_versions(self, indexes):
564
636
    def _compatible_parents(self, my_parents, other_parents):
565
637
        """During join check that other_parents are joinable with my_parents.
566
638
 
567
 
        Joinable is defined as 'is a subset of' - supersets may require
 
639
        Joinable is defined as 'is a subset of' - supersets may require 
568
640
        regeneration of diffs, but subsets do not.
569
641
        """
570
642
        return len(other_parents.difference(my_parents)) == 0
571
643
 
572
 
    def annotate(self, version_id):
573
 
        """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.
574
646
 
575
647
        The index indicates when the line originated in the weave."""
576
648
        incls = [self._lookup(version_id)]
577
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
578
 
            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()
579
656
 
580
657
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
581
658
                                                pb=None):
584
661
            version_ids = self.versions()
585
662
        version_ids = set(version_ids)
586
663
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
587
 
            if inserted not in version_ids: continue
 
664
            # if inserted not in version_ids then it was inserted before the
 
665
            # versions we care about, but because weaves cannot represent ghosts
 
666
            # properly, we do not filter down to that
 
667
            # if inserted not in version_ids: continue
588
668
            if line[-1] != '\n':
589
 
                yield line + '\n', inserted
 
669
                yield line + '\n'
590
670
            else:
591
 
                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)
592
677
 
593
678
    def _walk_internal(self, version_ids=None):
594
679
        """Helper method for weave actions."""
595
 
 
 
680
        
596
681
        istack = []
597
682
        dset = set()
598
683
 
607
692
                elif c == '}':
608
693
                    istack.pop()
609
694
                elif c == '[':
 
695
                    assert self._names[v] not in dset
610
696
                    dset.add(self._names[v])
611
697
                elif c == ']':
612
698
                    dset.remove(self._names[v])
613
699
                else:
614
700
                    raise WeaveFormatError('unexpected instruction %r' % v)
615
701
            else:
 
702
                assert l.__class__ in (str, unicode)
 
703
                assert istack
616
704
                yield lineno, istack[-1], frozenset(dset), l
617
705
            lineno += 1
618
706
 
635
723
        inc_b = set(self.get_ancestry([ver_b]))
636
724
        inc_c = inc_a & inc_b
637
725
 
638
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
726
        for lineno, insert, deleteset, line in\
 
727
            self.walk([ver_a, ver_b]):
639
728
            if deleteset & inc_c:
640
729
                # killed in parent; can't be in either a or b
641
730
                # not relevant to our work
667
756
                # not in either revision
668
757
                yield 'irrelevant', line
669
758
 
 
759
        yield 'unchanged', ''           # terminator
 
760
 
670
761
    def _extract(self, versions):
671
762
        """Yield annotation of lines in included set.
672
763
 
679
770
        for i in versions:
680
771
            if not isinstance(i, int):
681
772
                raise ValueError(i)
682
 
 
 
773
            
683
774
        included = self._inclusions(versions)
684
775
 
685
776
        istack = []
694
785
 
695
786
        WFE = WeaveFormatError
696
787
 
697
 
        # wow.
 
788
        # wow. 
698
789
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
699
790
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
700
791
        # 1.6 seconds in 'isinstance'.
706
797
        # we're still spending ~1/4 of the method in isinstance though.
707
798
        # so lets hard code the acceptable string classes we expect:
708
799
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
709
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
800
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
710
801
        #                                          objects>
711
802
        # yay, down to ~1/4 the initial extract time, and our inline time
712
803
        # has shrunk again, with isinstance no longer dominating.
713
804
        # tweaking the stack inclusion test to use a set gives:
714
805
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
715
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
806
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
716
807
        #                                          objects>
717
808
        # - a 5% win, or possibly just noise. However with large istacks that
718
809
        # 'in' test could dominate, so I'm leaving this change in place -
719
810
        # when its fast enough to consider profiling big datasets we can review.
720
811
 
721
 
 
722
 
 
 
812
              
 
813
             
723
814
 
724
815
        for l in self._weave:
725
816
            if l.__class__ == tuple:
726
817
                c, v = l
727
818
                isactive = None
728
819
                if c == '{':
 
820
                    assert v not in iset
729
821
                    istack.append(v)
730
822
                    iset.add(v)
731
823
                elif c == '}':
732
824
                    iset.remove(istack.pop())
733
825
                elif c == '[':
734
826
                    if v in included:
 
827
                        assert v not in dset
735
828
                        dset.add(v)
736
 
                elif c == ']':
 
829
                else:
 
830
                    assert c == ']'
737
831
                    if v in included:
 
832
                        assert v in dset
738
833
                        dset.remove(v)
739
 
                else:
740
 
                    raise AssertionError()
741
834
            else:
 
835
                assert l.__class__ in (str, unicode)
742
836
                if isactive is None:
743
837
                    isactive = (not dset) and istack and (istack[-1] in included)
744
838
                if isactive:
752
846
                                   % dset)
753
847
        return result
754
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
 
755
862
    def _maybe_lookup(self, name_or_index):
756
863
        """Convert possible symbolic name to index, or pass through indexes.
757
 
 
 
864
        
758
865
        NOT FOR PUBLIC USE.
759
866
        """
760
867
        if isinstance(name_or_index, (int, long)):
762
869
        else:
763
870
            return self._lookup(name_or_index)
764
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
 
765
877
    def get_lines(self, version_id):
766
878
        """See VersionedFile.get_lines()."""
767
879
        int_index = self._maybe_lookup(version_id)
770
882
        measured_sha1 = sha_strings(result)
771
883
        if measured_sha1 != expected_sha1:
772
884
            raise errors.WeaveInvalidChecksum(
773
 
                    'file %s, revision %s, expected: %s, measured %s'
 
885
                    'file %s, revision %s, expected: %s, measured %s' 
774
886
                    % (self._weave_name, version_id,
775
887
                       expected_sha1, measured_sha1))
776
888
        return result
777
889
 
 
890
    def get_sha1(self, version_id):
 
891
        """See VersionedFile.get_sha1()."""
 
892
        return self._sha1s[self._lookup(version_id)]
 
893
 
778
894
    def get_sha1s(self, version_ids):
779
895
        """See VersionedFile.get_sha1s()."""
780
 
        result = {}
781
 
        for v in version_ids:
782
 
            result[v] = self._sha1s[self._lookup(v)]
783
 
        return result
 
896
        return [self._sha1s[self._lookup(v)] for v in version_ids]
 
897
 
 
898
    @deprecated_method(zero_eight)
 
899
    def numversions(self):
 
900
        """How many versions are in this weave?
 
901
 
 
902
        Deprecated in favour of num_versions.
 
903
        """
 
904
        return self.num_versions()
784
905
 
785
906
    def num_versions(self):
786
907
        """How many versions are in this weave?"""
787
908
        l = len(self._parents)
 
909
        assert l == len(self._sha1s)
788
910
        return l
789
911
 
790
912
    __len__ = num_versions
810
932
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
811
933
            # The problem is that set membership is much more expensive
812
934
            name = self._idx_to_name(i)
813
 
            sha1s[name] = sha()
 
935
            sha1s[name] = sha.new()
814
936
            texts[name] = []
815
937
            new_inc = set([name])
816
938
            for p in self._parents[i]:
817
939
                new_inc.update(inclusions[self._idx_to_name(p)])
818
940
 
819
 
            if set(new_inc) != set(self.get_ancestry(name)):
820
 
                raise AssertionError(
821
 
                    'failed %s != %s'
822
 
                    % (set(new_inc), set(self.get_ancestry(name))))
 
941
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
942
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
823
943
            inclusions[name] = new_inc
824
944
 
825
945
        nlines = len(self._weave)
855
975
        # no lines outside of insertion blocks, that deletions are
856
976
        # properly paired, etc.
857
977
 
 
978
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
979
        """Worker routine for join()."""
 
980
        if not other.versions():
 
981
            return          # nothing to update, easy
 
982
 
 
983
        if not version_ids:
 
984
            # versions is never none, InterWeave checks this.
 
985
            return 0
 
986
 
 
987
        # two loops so that we do not change ourselves before verifying it
 
988
        # will be ok
 
989
        # work through in index order to make sure we get all dependencies
 
990
        names_to_join = []
 
991
        processed = 0
 
992
        # get the selected versions only that are in other.versions.
 
993
        version_ids = set(other.versions()).intersection(set(version_ids))
 
994
        # pull in the referenced graph.
 
995
        version_ids = other.get_ancestry(version_ids)
 
996
        pending_graph = [(version, other.get_parents(version)) for
 
997
                         version in version_ids]
 
998
        for name in topo_sort(pending_graph):
 
999
            other_idx = other._name_map[name]
 
1000
            # returns True if we have it, False if we need it.
 
1001
            if not self._check_version_consistent(other, other_idx, name):
 
1002
                names_to_join.append((other_idx, name))
 
1003
            processed += 1
 
1004
 
 
1005
 
 
1006
        if pb and not msg:
 
1007
            msg = 'weave join'
 
1008
 
 
1009
        merged = 0
 
1010
        time0 = time.time()
 
1011
        for other_idx, name in names_to_join:
 
1012
            # TODO: If all the parents of the other version are already
 
1013
            # present then we can avoid some work by just taking the delta
 
1014
            # and adjusting the offsets.
 
1015
            new_parents = self._imported_parents(other, other_idx)
 
1016
            sha1 = other._sha1s[other_idx]
 
1017
 
 
1018
            merged += 1
 
1019
 
 
1020
            if pb:
 
1021
                pb.update(msg, merged, len(names_to_join))
 
1022
           
 
1023
            lines = other.get_lines(other_idx)
 
1024
            self._add(name, lines, new_parents, sha1)
 
1025
 
 
1026
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
1027
                merged, processed, self._weave_name, time.time()-time0))
 
1028
 
858
1029
    def _imported_parents(self, other, other_idx):
859
1030
        """Return list of parents in self corresponding to indexes in other."""
860
1031
        new_parents = []
862
1033
            parent_name = other._names[parent_idx]
863
1034
            if parent_name not in self._name_map:
864
1035
                # should not be possible
865
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
1036
                raise WeaveError("missing parent {%s} of {%s} in %r" 
866
1037
                                 % (parent_name, other._name_map[other_idx], self))
867
1038
            new_parents.append(self._name_map[parent_name])
868
1039
        return new_parents
875
1046
         * the same text
876
1047
         * the same direct parents (by name, not index, and disregarding
877
1048
           order)
878
 
 
 
1049
        
879
1050
        If present & correct return True;
880
 
        if not present in self return False;
 
1051
        if not present in self return False; 
881
1052
        if inconsistent raise error."""
882
1053
        this_idx = self._name_map.get(name, -1)
883
1054
        if this_idx != -1:
895
1066
        else:
896
1067
            return False
897
1068
 
 
1069
    @deprecated_method(zero_eight)
 
1070
    def reweave(self, other, pb=None, msg=None):
 
1071
        """reweave has been superseded by plain use of join."""
 
1072
        return self.join(other, pb, msg)
 
1073
 
898
1074
    def _reweave(self, other, pb, msg):
899
1075
        """Reweave self with other - internal helper for join().
900
1076
 
916
1092
    """A WeaveFile represents a Weave on disk and writes on change."""
917
1093
 
918
1094
    WEAVE_SUFFIX = '.weave'
919
 
 
920
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
1095
    
 
1096
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
921
1097
        """Create a WeaveFile.
922
 
 
 
1098
        
923
1099
        :param create: If not True, only open an existing knit.
924
1100
        """
925
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
926
 
            allow_reserved=False)
 
1101
        super(WeaveFile, self).__init__(name, access_mode)
927
1102
        self._transport = transport
928
1103
        self._filemode = filemode
929
1104
        try:
934
1109
            # new file, save it
935
1110
            self._save()
936
1111
 
937
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
938
 
        left_matching_blocks, nostore_sha, random_id, check_content):
 
1112
    def _add_lines(self, version_id, parents, lines, parent_texts):
939
1113
        """Add a version and save the weave."""
940
1114
        self.check_not_reserved_id(version_id)
941
1115
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
942
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
943
 
            check_content)
 
1116
                                                   parent_texts)
944
1117
        self._save()
945
1118
        return result
946
1119
 
 
1120
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1121
        """See VersionedFile.clone_text."""
 
1122
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1123
        self._save
 
1124
 
947
1125
    def copy_to(self, name, transport):
948
1126
        """See VersionedFile.copy_to()."""
949
1127
        # as we are all in memory always, just serialise to the new place.
952
1130
        sio.seek(0)
953
1131
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
954
1132
 
 
1133
    def create_empty(self, name, transport, filemode=None):
 
1134
        return WeaveFile(name, transport, filemode, create=True)
 
1135
 
955
1136
    def _save(self):
956
1137
        """Save the weave."""
957
1138
        self._check_write_ok()
958
1139
        sio = StringIO()
959
1140
        write_weave_v5(self, sio)
960
1141
        sio.seek(0)
961
 
        bytes = sio.getvalue()
962
 
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
963
 
        try:
964
 
            self._transport.put_bytes(path, bytes, self._filemode)
965
 
        except errors.NoSuchFile:
966
 
            self._transport.mkdir(dirname(path))
967
 
            self._transport.put_bytes(path, bytes, self._filemode)
 
1142
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1143
                                 sio,
 
1144
                                 self._filemode)
968
1145
 
969
1146
    @staticmethod
970
1147
    def get_suffixes():
971
1148
        """See VersionedFile.get_suffixes()."""
972
1149
        return [WeaveFile.WEAVE_SUFFIX]
973
1150
 
974
 
    def insert_record_stream(self, stream):
975
 
        super(WeaveFile, self).insert_record_stream(stream)
 
1151
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1152
             ignore_missing=False):
 
1153
        """Join other into self and save."""
 
1154
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
976
1155
        self._save()
977
1156
 
978
1157
 
 
1158
@deprecated_function(zero_eight)
 
1159
def reweave(wa, wb, pb=None, msg=None):
 
1160
    """reweaving is deprecation, please just use weave.join()."""
 
1161
    _reweave(wa, wb, pb, msg)
 
1162
 
979
1163
def _reweave(wa, wb, pb=None, msg=None):
980
1164
    """Combine two weaves and return the result.
981
1165
 
982
 
    This works even if a revision R has different parents in
 
1166
    This works even if a revision R has different parents in 
983
1167
    wa and wb.  In the resulting weave all the parents are given.
984
1168
 
985
 
    This is done by just building up a new weave, maintaining ordering
 
1169
    This is done by just building up a new weave, maintaining ordering 
986
1170
    of the versions in the two inputs.  More efficient approaches
987
 
    might be possible but it should only be necessary to do
988
 
    this operation rarely, when a new previously ghost version is
 
1171
    might be possible but it should only be necessary to do 
 
1172
    this operation rarely, when a new previously ghost version is 
989
1173
    inserted.
990
1174
 
991
1175
    :param pb: An optional progress bar, indicating how far done we are
999
1183
    # map from version name -> all parent names
1000
1184
    combined_parents = _reweave_parent_graphs(wa, wb)
1001
1185
    mutter("combined parents: %r", combined_parents)
1002
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
1186
    order = topo_sort(combined_parents.iteritems())
1003
1187
    mutter("order to reweave: %r", order)
1004
1188
 
1005
1189
    if pb and not msg:
1027
1211
 
1028
1212
def _reweave_parent_graphs(wa, wb):
1029
1213
    """Return combined parent ancestry for two weaves.
1030
 
 
 
1214
    
1031
1215
    Returned as a list of (version_name, set(parent_names))"""
1032
1216
    combined = {}
1033
1217
    for weave in [wa, wb]:
1098
1282
        Display origin of each line.
1099
1283
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1100
1284
        Auto-merge two versions and display conflicts.
1101
 
    weave diff WEAVEFILE VERSION1 VERSION2
 
1285
    weave diff WEAVEFILE VERSION1 VERSION2 
1102
1286
        Show differences between two versions.
1103
1287
 
1104
1288
example:
1121
1305
 
1122
1306
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
1123
1307
    % vi foo.txt                            (resolve conflicts)
1124
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)
1125
 
 
 
1308
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1309
    
1126
1310
"""
1127
 
 
 
1311
    
1128
1312
 
1129
1313
 
1130
1314
def main(argv):
1153
1337
 
1154
1338
    def readit():
1155
1339
        return read_weave(file(argv[2], 'rb'))
1156
 
 
 
1340
    
1157
1341
    if cmd == 'help':
1158
1342
        usage()
1159
1343
    elif cmd == 'add':
1174
1358
    elif cmd == 'get': # get one version
1175
1359
        w = readit()
1176
1360
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1177
 
 
 
1361
        
1178
1362
    elif cmd == 'diff':
1179
1363
        w = readit()
1180
1364
        fn = argv[2]
1185
1369
                                '%s version %d' % (fn, v1),
1186
1370
                                '%s version %d' % (fn, v2))
1187
1371
        sys.stdout.writelines(diff_gen)
1188
 
 
 
1372
            
1189
1373
    elif cmd == 'annotate':
1190
1374
        w = readit()
1191
1375
        # newline is added to all lines regardless; too hard to get
1198
1382
            else:
1199
1383
                print '%5d | %s' % (origin, text)
1200
1384
                lasto = origin
1201
 
 
 
1385
                
1202
1386
    elif cmd == 'toc':
1203
1387
        weave_toc(readit())
1204
1388
 
1205
1389
    elif cmd == 'stats':
1206
1390
        weave_stats(argv[2], ProgressBar())
1207
 
 
 
1391
        
1208
1392
    elif cmd == 'check':
1209
1393
        w = readit()
1210
1394
        pb = ProgressBar()
1233
1417
        sys.stdout.writelines(w.weave_merge(p))
1234
1418
    else:
1235
1419
        raise ValueError('unknown command %r' % cmd)
1236
 
 
 
1420
    
1237
1421
 
1238
1422
if __name__ == '__main__':
1239
1423
    import sys
1240
1424
    sys.exit(main(sys.argv))
 
1425
 
 
1426
 
 
1427
class InterWeave(InterVersionedFile):
 
1428
    """Optimised code paths for weave to weave operations."""
 
1429
    
 
1430
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1431
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1432
    
 
1433
    @staticmethod
 
1434
    def is_compatible(source, target):
 
1435
        """Be compatible with weaves."""
 
1436
        try:
 
1437
            return (isinstance(source, Weave) and
 
1438
                    isinstance(target, Weave))
 
1439
        except AttributeError:
 
1440
            return False
 
1441
 
 
1442
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1443
        """See InterVersionedFile.join."""
 
1444
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1445
        if self.target.versions() == [] and version_ids is None:
 
1446
            self.target._copy_weave_content(self.source)
 
1447
            return
 
1448
        try:
 
1449
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1450
        except errors.WeaveParentMismatch:
 
1451
            self.target._reweave(self.source, pb, msg)
 
1452
 
 
1453
 
 
1454
InterVersionedFile.register_optimiser(InterWeave)