~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

Merge bzr.dev

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)
291
250
        try:
292
251
            return self._name_map[name]
293
252
        except KeyError:
294
253
            raise RevisionNotPresent(name, self._weave_name)
295
254
 
 
255
    @deprecated_method(zero_eight)
 
256
    def iter_names(self):
 
257
        """Deprecated convenience function, please see VersionedFile.names()."""
 
258
        return iter(self.names())
 
259
 
 
260
    @deprecated_method(zero_eight)
 
261
    def names(self):
 
262
        """See Weave.versions for the current api."""
 
263
        return self.versions()
 
264
 
296
265
    def versions(self):
297
266
        """See VersionedFile.versions."""
298
267
        return self._names[:]
303
272
 
304
273
    __contains__ = has_version
305
274
 
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 = {}
 
275
    def get_delta(self, version_id):
 
276
        """See VersionedFile.get_delta."""
 
277
        return self.get_deltas([version_id])[version_id]
 
278
 
 
279
    def get_deltas(self, version_ids):
 
280
        """See VersionedFile.get_deltas."""
 
281
        version_ids = self.get_ancestry(version_ids)
339
282
        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:
 
283
            if not self.has_version(version_id):
 
284
                raise RevisionNotPresent(version_id, self)
 
285
        # try extracting all versions; parallel extraction is used
 
286
        nv = self.num_versions()
 
287
        sha1s = {}
 
288
        deltas = {}
 
289
        texts = {}
 
290
        inclusions = {}
 
291
        noeols = {}
 
292
        last_parent_lines = {}
 
293
        parents = {}
 
294
        parent_inclusions = {}
 
295
        parent_linenums = {}
 
296
        parent_noeols = {}
 
297
        current_hunks = {}
 
298
        diff_hunks = {}
 
299
        # its simplest to generate a full set of prepared variables.
 
300
        for i in range(nv):
 
301
            name = self._names[i]
 
302
            sha1s[name] = self.get_sha1(name)
 
303
            parents_list = self.get_parents(name)
 
304
            try:
 
305
                parent = parents_list[0]
 
306
                parents[name] = parent
 
307
                parent_inclusions[name] = inclusions[parent]
 
308
            except IndexError:
 
309
                parents[name] = None
 
310
                parent_inclusions[name] = set()
 
311
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
 
312
            diff_hunks[name] = []
 
313
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
 
314
            parent_linenums[name] = 0
 
315
            noeols[name] = False
 
316
            parent_noeols[name] = False
 
317
            last_parent_lines[name] = None
 
318
            new_inc = set([name])
 
319
            for p in self._parents[i]:
 
320
                new_inc.update(inclusions[self._idx_to_name(p)])
 
321
            # debug only, known good so far.
 
322
            #assert set(new_inc) == set(self.get_ancestry(name)), \
 
323
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
324
            inclusions[name] = new_inc
 
325
 
 
326
        nlines = len(self._weave)
 
327
 
 
328
        for lineno, inserted, deletes, line in self._walk_internal():
 
329
            # a line is active in a version if:
 
330
            # insert is in the versions inclusions
 
331
            # and
 
332
            # deleteset & the versions inclusions is an empty set.
 
333
            # so - if we have a included by mapping - version is included by
 
334
            # children, we get a list of children to examine for deletes affect
 
335
            # ing them, which is less than the entire set of children.
 
336
            for version_id in version_ids:  
 
337
                # The active inclusion must be an ancestor,
 
338
                # and no ancestors must have deleted this line,
 
339
                # because we don't support resurrection.
 
340
                parent_inclusion = parent_inclusions[version_id]
 
341
                inclusion = inclusions[version_id]
 
342
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
 
343
                version_active = inserted in inclusion and not (deletes & inclusion)
 
344
                if not parent_active and not version_active:
 
345
                    # unrelated line of ancestry
348
346
                    continue
349
 
            result[version_id] = parents
 
347
                elif parent_active and version_active:
 
348
                    # shared line
 
349
                    parent_linenum = parent_linenums[version_id]
 
350
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
 
351
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
 
352
                    parent_linenum += 1
 
353
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
 
354
                    parent_linenums[version_id] = parent_linenum
 
355
                    try:
 
356
                        if line[-1] != '\n':
 
357
                            noeols[version_id] = True
 
358
                    except IndexError:
 
359
                        pass
 
360
                elif parent_active and not version_active:
 
361
                    # deleted line
 
362
                    current_hunks[version_id][1] += 1
 
363
                    parent_linenums[version_id] += 1
 
364
                    last_parent_lines[version_id] = line
 
365
                elif not parent_active and version_active:
 
366
                    # replacement line
 
367
                    # noeol only occurs at the end of a file because we 
 
368
                    # diff linewise. We want to show noeol changes as a
 
369
                    # empty diff unless the actual eol-less content changed.
 
370
                    theline = line
 
371
                    try:
 
372
                        if last_parent_lines[version_id][-1] != '\n':
 
373
                            parent_noeols[version_id] = True
 
374
                    except (TypeError, IndexError):
 
375
                        pass
 
376
                    try:
 
377
                        if theline[-1] != '\n':
 
378
                            noeols[version_id] = True
 
379
                    except IndexError:
 
380
                        pass
 
381
                    new_line = False
 
382
                    parent_should_go = False
 
383
 
 
384
                    if parent_noeols[version_id] == noeols[version_id]:
 
385
                        # no noeol toggle, so trust the weaves statement
 
386
                        # that this line is changed.
 
387
                        new_line = True
 
388
                        if parent_noeols[version_id]:
 
389
                            theline = theline + '\n'
 
390
                    elif parent_noeols[version_id]:
 
391
                        # parent has no eol, we do:
 
392
                        # our line is new, report as such..
 
393
                        new_line = True
 
394
                    elif noeols[version_id]:
 
395
                        # append a eol so that it looks like
 
396
                        # a normalised delta
 
397
                        theline = theline + '\n'
 
398
                        if parents[version_id] is not None:
 
399
                        #if last_parent_lines[version_id] is not None:
 
400
                            parent_should_go = True
 
401
                        if last_parent_lines[version_id] != theline:
 
402
                            # but changed anyway
 
403
                            new_line = True
 
404
                            #parent_should_go = False
 
405
                    if new_line:
 
406
                        current_hunks[version_id][2] += 1
 
407
                        current_hunks[version_id][3].append((inserted, theline))
 
408
                    if parent_should_go:
 
409
                        # last hunk last parent line is not eaten
 
410
                        current_hunks[version_id][1] -= 1
 
411
                    if current_hunks[version_id][1] < 0:
 
412
                        current_hunks[version_id][1] = 0
 
413
                        # import pdb;pdb.set_trace()
 
414
                    # assert current_hunks[version_id][1] >= 0
 
415
 
 
416
        # flush last hunk
 
417
        for i in range(nv):
 
418
            version = self._idx_to_name(i)
 
419
            if current_hunks[version] != [0, 0, 0, []]:
 
420
                diff_hunks[version].append(tuple(current_hunks[version]))
 
421
        result = {}
 
422
        for version_id in version_ids:
 
423
            result[version_id] = (
 
424
                                  parents[version_id],
 
425
                                  sha1s[version_id],
 
426
                                  noeols[version_id],
 
427
                                  diff_hunks[version_id],
 
428
                                  )
350
429
        return result
351
430
 
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
 
431
    def get_parents(self, version_id):
 
432
        """See VersionedFile.get_parent."""
 
433
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
386
434
 
387
435
    def _check_repeated_add(self, name, parents, text, sha1):
388
436
        """Check that a duplicated add is OK.
395
443
            raise RevisionAlreadyPresent(name, self._weave_name)
396
444
        return idx
397
445
 
398
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
399
 
       left_matching_blocks, nostore_sha, random_id, check_content):
 
446
    @deprecated_method(zero_eight)
 
447
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
448
        """Please use Weave.clone_text now."""
 
449
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
450
 
 
451
    def _add_lines(self, version_id, parents, lines, parent_texts):
400
452
        """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):
 
453
        return self._add(version_id, lines, map(self._lookup, parents))
 
454
 
 
455
    @deprecated_method(zero_eight)
 
456
    def add(self, name, parents, text, sha1=None):
 
457
        """See VersionedFile.add_lines for the non deprecated api."""
 
458
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
 
459
 
 
460
    def _add(self, version_id, lines, parents, sha1=None):
406
461
        """Add a single text on top of the weave.
407
 
 
 
462
  
408
463
        Returns the index number of the newly added version.
409
464
 
410
465
        version_id
411
466
            Symbolic name for this version.
412
467
            (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
468
 
415
469
        parents
416
470
            List or set of direct parent version numbers.
417
 
 
 
471
            
418
472
        lines
419
473
            Sequence of lines to be added in the new version.
 
474
        """
420
475
 
421
 
        :param nostore_sha: See VersionedFile.add_lines.
422
 
        """
 
476
        assert isinstance(version_id, basestring)
423
477
        self._check_lines_not_unicode(lines)
424
478
        self._check_lines_are_lines(lines)
425
479
        if not sha1:
426
480
            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
481
        if version_id in self._name_map:
432
482
            return self._check_repeated_add(version_id, parents, lines, sha1)
433
483
 
444
494
        self._names.append(version_id)
445
495
        self._name_map[version_id] = new_version
446
496
 
447
 
 
 
497
            
448
498
        if not parents:
449
499
            # special case; adding with no parents revision; can do
450
500
            # this more quickly by just appending unconditionally.
461
511
            if sha1 == self._sha1s[pv]:
462
512
                # special case: same as the single parent
463
513
                return new_version
464
 
 
 
514
            
465
515
 
466
516
        ancestors = self._inclusions(parents)
467
517
 
477
527
        # another small special case: a merge, producing the same text
478
528
        # as auto-merge
479
529
        if lines == basis_lines:
480
 
            return new_version
 
530
            return new_version            
481
531
 
482
532
        # add a sentinel, because we can also match against the final line
483
533
        basis_lineno.append(len(self._weave))
502
552
            #print 'raw match', tag, i1, i2, j1, j2
503
553
            if tag == 'equal':
504
554
                continue
 
555
 
505
556
            i1 = basis_lineno[i1]
506
557
            i2 = basis_lineno[i2]
 
558
 
 
559
            assert 0 <= j1 <= j2 <= len(lines)
 
560
 
 
561
            #print tag, i1, i2, j1, j2
 
562
 
507
563
            # the deletion and insertion are handled separately.
508
564
            # first delete the region.
509
565
            if i1 != i2:
516
572
                # i2; we want to insert after this region to make sure
517
573
                # we don't destroy ourselves
518
574
                i = i2 + offset
519
 
                self._weave[i:i] = ([('{', new_version)]
520
 
                                    + lines[j1:j2]
 
575
                self._weave[i:i] = ([('{', new_version)] 
 
576
                                    + lines[j1:j2] 
521
577
                                    + [('}', None)])
522
578
                offset += 2 + (j2 - j1)
523
579
        return new_version
524
580
 
 
581
    def _clone_text(self, new_version_id, old_version_id, parents):
 
582
        """See VersionedFile.clone_text."""
 
583
        old_lines = self.get_text(old_version_id)
 
584
        self.add_lines(new_version_id, parents, old_lines)
 
585
 
525
586
    def _inclusions(self, versions):
526
587
        """Return set of all ancestors of given version(s)."""
527
588
        if not len(versions):
535
596
        ## except IndexError:
536
597
        ##     raise ValueError("version %d not present in weave" % v)
537
598
 
538
 
    def get_ancestry(self, version_ids, topo_sorted=True):
 
599
    @deprecated_method(zero_eight)
 
600
    def inclusions(self, version_ids):
 
601
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
 
602
        if not version_ids:
 
603
            return []
 
604
        if isinstance(version_ids[0], int):
 
605
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
 
606
        else:
 
607
            return self.get_ancestry(version_ids)
 
608
 
 
609
    def get_ancestry(self, version_ids):
539
610
        """See VersionedFile.get_ancestry."""
540
611
        if isinstance(version_ids, basestring):
541
612
            version_ids = [version_ids]
550
621
            if not isinstance(l, basestring):
551
622
                raise ValueError("text line should be a string or unicode, not %s"
552
623
                                 % type(l))
553
 
 
 
624
        
554
625
 
555
626
 
556
627
    def _check_versions(self, indexes):
564
635
    def _compatible_parents(self, my_parents, other_parents):
565
636
        """During join check that other_parents are joinable with my_parents.
566
637
 
567
 
        Joinable is defined as 'is a subset of' - supersets may require
 
638
        Joinable is defined as 'is a subset of' - supersets may require 
568
639
        regeneration of diffs, but subsets do not.
569
640
        """
570
641
        return len(other_parents.difference(my_parents)) == 0
571
642
 
572
643
    def annotate(self, version_id):
573
 
        """Return a list of (version-id, line) tuples for version_id.
 
644
        if isinstance(version_id, int):
 
645
            warnings.warn('Weave.annotate(int) is deprecated. Please use version names'
 
646
                 ' in all circumstances as of 0.8',
 
647
                 DeprecationWarning,
 
648
                 stacklevel=2
 
649
                 )
 
650
            result = []
 
651
            for origin, lineno, text in self._extract([version_id]):
 
652
                result.append((origin, text))
 
653
            return result
 
654
        else:
 
655
            return super(Weave, self).annotate(version_id)
 
656
    
 
657
    def annotate_iter(self, version_id):
 
658
        """Yield list of (version-id, line) pairs for the specified version.
574
659
 
575
660
        The index indicates when the line originated in the weave."""
576
661
        incls = [self._lookup(version_id)]
577
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
578
 
            self._extract(incls)]
 
662
        for origin, lineno, text in self._extract(incls):
 
663
            yield self._idx_to_name(origin), text
 
664
 
 
665
    @deprecated_method(zero_eight)
 
666
    def _walk(self):
 
667
        """_walk has become visit, a supported api."""
 
668
        return self._walk_internal()
579
669
 
580
670
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
581
671
                                                pb=None):
584
674
            version_ids = self.versions()
585
675
        version_ids = set(version_ids)
586
676
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
587
 
            if inserted not in version_ids: continue
 
677
            # if inserted not in version_ids then it was inserted before the
 
678
            # versions we care about, but because weaves cannot represent ghosts
 
679
            # properly, we do not filter down to that
 
680
            # if inserted not in version_ids: continue
588
681
            if line[-1] != '\n':
589
 
                yield line + '\n', inserted
 
682
                yield line + '\n'
590
683
            else:
591
 
                yield line, inserted
 
684
                yield line
 
685
 
 
686
    #@deprecated_method(zero_eight)
 
687
    def walk(self, version_ids=None):
 
688
        """See VersionedFile.walk."""
 
689
        return self._walk_internal(version_ids)
592
690
 
593
691
    def _walk_internal(self, version_ids=None):
594
692
        """Helper method for weave actions."""
595
 
 
 
693
        
596
694
        istack = []
597
695
        dset = set()
598
696
 
607
705
                elif c == '}':
608
706
                    istack.pop()
609
707
                elif c == '[':
 
708
                    assert self._names[v] not in dset
610
709
                    dset.add(self._names[v])
611
710
                elif c == ']':
612
711
                    dset.remove(self._names[v])
613
712
                else:
614
713
                    raise WeaveFormatError('unexpected instruction %r' % v)
615
714
            else:
 
715
                assert l.__class__ in (str, unicode)
 
716
                assert istack
616
717
                yield lineno, istack[-1], frozenset(dset), l
617
718
            lineno += 1
618
719
 
635
736
        inc_b = set(self.get_ancestry([ver_b]))
636
737
        inc_c = inc_a & inc_b
637
738
 
638
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
739
        for lineno, insert, deleteset, line in\
 
740
            self.walk([ver_a, ver_b]):
639
741
            if deleteset & inc_c:
640
742
                # killed in parent; can't be in either a or b
641
743
                # not relevant to our work
667
769
                # not in either revision
668
770
                yield 'irrelevant', line
669
771
 
 
772
        yield 'unchanged', ''           # terminator
 
773
 
670
774
    def _extract(self, versions):
671
775
        """Yield annotation of lines in included set.
672
776
 
679
783
        for i in versions:
680
784
            if not isinstance(i, int):
681
785
                raise ValueError(i)
682
 
 
 
786
            
683
787
        included = self._inclusions(versions)
684
788
 
685
789
        istack = []
694
798
 
695
799
        WFE = WeaveFormatError
696
800
 
697
 
        # wow.
 
801
        # wow. 
698
802
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
699
803
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
700
804
        # 1.6 seconds in 'isinstance'.
706
810
        # we're still spending ~1/4 of the method in isinstance though.
707
811
        # so lets hard code the acceptable string classes we expect:
708
812
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
709
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
813
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
710
814
        #                                          objects>
711
815
        # yay, down to ~1/4 the initial extract time, and our inline time
712
816
        # has shrunk again, with isinstance no longer dominating.
713
817
        # tweaking the stack inclusion test to use a set gives:
714
818
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
715
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
819
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
716
820
        #                                          objects>
717
821
        # - a 5% win, or possibly just noise. However with large istacks that
718
822
        # 'in' test could dominate, so I'm leaving this change in place -
719
823
        # when its fast enough to consider profiling big datasets we can review.
720
824
 
721
 
 
722
 
 
 
825
              
 
826
             
723
827
 
724
828
        for l in self._weave:
725
829
            if l.__class__ == tuple:
726
830
                c, v = l
727
831
                isactive = None
728
832
                if c == '{':
 
833
                    assert v not in iset
729
834
                    istack.append(v)
730
835
                    iset.add(v)
731
836
                elif c == '}':
732
837
                    iset.remove(istack.pop())
733
838
                elif c == '[':
734
839
                    if v in included:
 
840
                        assert v not in dset
735
841
                        dset.add(v)
736
 
                elif c == ']':
 
842
                else:
 
843
                    assert c == ']'
737
844
                    if v in included:
 
845
                        assert v in dset
738
846
                        dset.remove(v)
739
 
                else:
740
 
                    raise AssertionError()
741
847
            else:
 
848
                assert l.__class__ in (str, unicode)
742
849
                if isactive is None:
743
850
                    isactive = (not dset) and istack and (istack[-1] in included)
744
851
                if isactive:
752
859
                                   % dset)
753
860
        return result
754
861
 
 
862
    @deprecated_method(zero_eight)
 
863
    def get_iter(self, name_or_index):
 
864
        """Deprecated, please do not use. Lookups are not not needed.
 
865
        
 
866
        Please use get_lines now.
 
867
        """
 
868
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
869
 
 
870
    @deprecated_method(zero_eight)
 
871
    def maybe_lookup(self, name_or_index):
 
872
        """Deprecated, please do not use. Lookups are not not needed."""
 
873
        return self._maybe_lookup(name_or_index)
 
874
 
755
875
    def _maybe_lookup(self, name_or_index):
756
876
        """Convert possible symbolic name to index, or pass through indexes.
757
 
 
 
877
        
758
878
        NOT FOR PUBLIC USE.
759
879
        """
760
880
        if isinstance(name_or_index, (int, long)):
762
882
        else:
763
883
            return self._lookup(name_or_index)
764
884
 
 
885
    @deprecated_method(zero_eight)
 
886
    def get(self, version_id):
 
887
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
888
        return self.get_lines(version_id)
 
889
 
765
890
    def get_lines(self, version_id):
766
891
        """See VersionedFile.get_lines()."""
767
892
        int_index = self._maybe_lookup(version_id)
770
895
        measured_sha1 = sha_strings(result)
771
896
        if measured_sha1 != expected_sha1:
772
897
            raise errors.WeaveInvalidChecksum(
773
 
                    'file %s, revision %s, expected: %s, measured %s'
 
898
                    'file %s, revision %s, expected: %s, measured %s' 
774
899
                    % (self._weave_name, version_id,
775
900
                       expected_sha1, measured_sha1))
776
901
        return result
777
902
 
778
 
    def get_sha1s(self, version_ids):
779
 
        """See VersionedFile.get_sha1s()."""
780
 
        result = {}
781
 
        for v in version_ids:
782
 
            result[v] = self._sha1s[self._lookup(v)]
783
 
        return result
 
903
    def get_sha1(self, version_id):
 
904
        """See VersionedFile.get_sha1()."""
 
905
        return self._sha1s[self._lookup(version_id)]
 
906
 
 
907
    @deprecated_method(zero_eight)
 
908
    def numversions(self):
 
909
        """How many versions are in this weave?
 
910
 
 
911
        Deprecated in favour of num_versions.
 
912
        """
 
913
        return self.num_versions()
784
914
 
785
915
    def num_versions(self):
786
916
        """How many versions are in this weave?"""
787
917
        l = len(self._parents)
 
918
        assert l == len(self._sha1s)
788
919
        return l
789
920
 
790
921
    __len__ = num_versions
810
941
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
811
942
            # The problem is that set membership is much more expensive
812
943
            name = self._idx_to_name(i)
813
 
            sha1s[name] = sha()
 
944
            sha1s[name] = sha.new()
814
945
            texts[name] = []
815
946
            new_inc = set([name])
816
947
            for p in self._parents[i]:
817
948
                new_inc.update(inclusions[self._idx_to_name(p)])
818
949
 
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))))
 
950
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
951
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
823
952
            inclusions[name] = new_inc
824
953
 
825
954
        nlines = len(self._weave)
855
984
        # no lines outside of insertion blocks, that deletions are
856
985
        # properly paired, etc.
857
986
 
 
987
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
988
        """Worker routine for join()."""
 
989
        if not other.versions():
 
990
            return          # nothing to update, easy
 
991
 
 
992
        if not version_ids:
 
993
            # versions is never none, InterWeave checks this.
 
994
            return 0
 
995
 
 
996
        # two loops so that we do not change ourselves before verifying it
 
997
        # will be ok
 
998
        # work through in index order to make sure we get all dependencies
 
999
        names_to_join = []
 
1000
        processed = 0
 
1001
        # get the selected versions only that are in other.versions.
 
1002
        version_ids = set(other.versions()).intersection(set(version_ids))
 
1003
        # pull in the referenced graph.
 
1004
        version_ids = other.get_ancestry(version_ids)
 
1005
        pending_graph = [(version, other.get_parents(version)) for
 
1006
                         version in version_ids]
 
1007
        for name in topo_sort(pending_graph):
 
1008
            other_idx = other._name_map[name]
 
1009
            # returns True if we have it, False if we need it.
 
1010
            if not self._check_version_consistent(other, other_idx, name):
 
1011
                names_to_join.append((other_idx, name))
 
1012
            processed += 1
 
1013
 
 
1014
 
 
1015
        if pb and not msg:
 
1016
            msg = 'weave join'
 
1017
 
 
1018
        merged = 0
 
1019
        time0 = time.time()
 
1020
        for other_idx, name in names_to_join:
 
1021
            # TODO: If all the parents of the other version are already
 
1022
            # present then we can avoid some work by just taking the delta
 
1023
            # and adjusting the offsets.
 
1024
            new_parents = self._imported_parents(other, other_idx)
 
1025
            sha1 = other._sha1s[other_idx]
 
1026
 
 
1027
            merged += 1
 
1028
 
 
1029
            if pb:
 
1030
                pb.update(msg, merged, len(names_to_join))
 
1031
           
 
1032
            lines = other.get_lines(other_idx)
 
1033
            self._add(name, lines, new_parents, sha1)
 
1034
 
 
1035
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
1036
                merged, processed, self._weave_name, time.time()-time0))
 
1037
 
858
1038
    def _imported_parents(self, other, other_idx):
859
1039
        """Return list of parents in self corresponding to indexes in other."""
860
1040
        new_parents = []
862
1042
            parent_name = other._names[parent_idx]
863
1043
            if parent_name not in self._name_map:
864
1044
                # should not be possible
865
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
1045
                raise WeaveError("missing parent {%s} of {%s} in %r" 
866
1046
                                 % (parent_name, other._name_map[other_idx], self))
867
1047
            new_parents.append(self._name_map[parent_name])
868
1048
        return new_parents
875
1055
         * the same text
876
1056
         * the same direct parents (by name, not index, and disregarding
877
1057
           order)
878
 
 
 
1058
        
879
1059
        If present & correct return True;
880
 
        if not present in self return False;
 
1060
        if not present in self return False; 
881
1061
        if inconsistent raise error."""
882
1062
        this_idx = self._name_map.get(name, -1)
883
1063
        if this_idx != -1:
895
1075
        else:
896
1076
            return False
897
1077
 
 
1078
    @deprecated_method(zero_eight)
 
1079
    def reweave(self, other, pb=None, msg=None):
 
1080
        """reweave has been superseded by plain use of join."""
 
1081
        return self.join(other, pb, msg)
 
1082
 
898
1083
    def _reweave(self, other, pb, msg):
899
1084
        """Reweave self with other - internal helper for join().
900
1085
 
916
1101
    """A WeaveFile represents a Weave on disk and writes on change."""
917
1102
 
918
1103
    WEAVE_SUFFIX = '.weave'
919
 
 
920
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
1104
    
 
1105
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
921
1106
        """Create a WeaveFile.
922
 
 
 
1107
        
923
1108
        :param create: If not True, only open an existing knit.
924
1109
        """
925
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
926
 
            allow_reserved=False)
 
1110
        super(WeaveFile, self).__init__(name, access_mode)
927
1111
        self._transport = transport
928
1112
        self._filemode = filemode
929
1113
        try:
934
1118
            # new file, save it
935
1119
            self._save()
936
1120
 
937
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
938
 
        left_matching_blocks, nostore_sha, random_id, check_content):
 
1121
    def _add_lines(self, version_id, parents, lines, parent_texts):
939
1122
        """Add a version and save the weave."""
940
 
        self.check_not_reserved_id(version_id)
941
1123
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
942
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
943
 
            check_content)
 
1124
                                                   parent_texts)
944
1125
        self._save()
945
1126
        return result
946
1127
 
 
1128
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1129
        """See VersionedFile.clone_text."""
 
1130
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1131
        self._save
 
1132
 
947
1133
    def copy_to(self, name, transport):
948
1134
        """See VersionedFile.copy_to()."""
949
1135
        # as we are all in memory always, just serialise to the new place.
952
1138
        sio.seek(0)
953
1139
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
954
1140
 
 
1141
    def create_empty(self, name, transport, filemode=None):
 
1142
        return WeaveFile(name, transport, filemode, create=True)
 
1143
 
955
1144
    def _save(self):
956
1145
        """Save the weave."""
957
1146
        self._check_write_ok()
958
1147
        sio = StringIO()
959
1148
        write_weave_v5(self, sio)
960
1149
        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)
 
1150
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1151
                                 sio,
 
1152
                                 self._filemode)
968
1153
 
969
1154
    @staticmethod
970
1155
    def get_suffixes():
971
1156
        """See VersionedFile.get_suffixes()."""
972
1157
        return [WeaveFile.WEAVE_SUFFIX]
973
1158
 
974
 
    def insert_record_stream(self, stream):
975
 
        super(WeaveFile, self).insert_record_stream(stream)
 
1159
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1160
             ignore_missing=False):
 
1161
        """Join other into self and save."""
 
1162
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
976
1163
        self._save()
977
1164
 
978
1165
 
 
1166
@deprecated_function(zero_eight)
 
1167
def reweave(wa, wb, pb=None, msg=None):
 
1168
    """reweaving is deprecation, please just use weave.join()."""
 
1169
    _reweave(wa, wb, pb, msg)
 
1170
 
979
1171
def _reweave(wa, wb, pb=None, msg=None):
980
1172
    """Combine two weaves and return the result.
981
1173
 
982
 
    This works even if a revision R has different parents in
 
1174
    This works even if a revision R has different parents in 
983
1175
    wa and wb.  In the resulting weave all the parents are given.
984
1176
 
985
 
    This is done by just building up a new weave, maintaining ordering
 
1177
    This is done by just building up a new weave, maintaining ordering 
986
1178
    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
 
1179
    might be possible but it should only be necessary to do 
 
1180
    this operation rarely, when a new previously ghost version is 
989
1181
    inserted.
990
1182
 
991
1183
    :param pb: An optional progress bar, indicating how far done we are
999
1191
    # map from version name -> all parent names
1000
1192
    combined_parents = _reweave_parent_graphs(wa, wb)
1001
1193
    mutter("combined parents: %r", combined_parents)
1002
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
1194
    order = topo_sort(combined_parents.iteritems())
1003
1195
    mutter("order to reweave: %r", order)
1004
1196
 
1005
1197
    if pb and not msg:
1027
1219
 
1028
1220
def _reweave_parent_graphs(wa, wb):
1029
1221
    """Return combined parent ancestry for two weaves.
1030
 
 
 
1222
    
1031
1223
    Returned as a list of (version_name, set(parent_names))"""
1032
1224
    combined = {}
1033
1225
    for weave in [wa, wb]:
1098
1290
        Display origin of each line.
1099
1291
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1100
1292
        Auto-merge two versions and display conflicts.
1101
 
    weave diff WEAVEFILE VERSION1 VERSION2
 
1293
    weave diff WEAVEFILE VERSION1 VERSION2 
1102
1294
        Show differences between two versions.
1103
1295
 
1104
1296
example:
1121
1313
 
1122
1314
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
1123
1315
    % vi foo.txt                            (resolve conflicts)
1124
 
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)
1125
 
 
 
1316
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1317
    
1126
1318
"""
1127
 
 
 
1319
    
1128
1320
 
1129
1321
 
1130
1322
def main(argv):
1153
1345
 
1154
1346
    def readit():
1155
1347
        return read_weave(file(argv[2], 'rb'))
1156
 
 
 
1348
    
1157
1349
    if cmd == 'help':
1158
1350
        usage()
1159
1351
    elif cmd == 'add':
1174
1366
    elif cmd == 'get': # get one version
1175
1367
        w = readit()
1176
1368
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1177
 
 
 
1369
        
1178
1370
    elif cmd == 'diff':
1179
1371
        w = readit()
1180
1372
        fn = argv[2]
1185
1377
                                '%s version %d' % (fn, v1),
1186
1378
                                '%s version %d' % (fn, v2))
1187
1379
        sys.stdout.writelines(diff_gen)
1188
 
 
 
1380
            
1189
1381
    elif cmd == 'annotate':
1190
1382
        w = readit()
1191
1383
        # newline is added to all lines regardless; too hard to get
1198
1390
            else:
1199
1391
                print '%5d | %s' % (origin, text)
1200
1392
                lasto = origin
1201
 
 
 
1393
                
1202
1394
    elif cmd == 'toc':
1203
1395
        weave_toc(readit())
1204
1396
 
1205
1397
    elif cmd == 'stats':
1206
1398
        weave_stats(argv[2], ProgressBar())
1207
 
 
 
1399
        
1208
1400
    elif cmd == 'check':
1209
1401
        w = readit()
1210
1402
        pb = ProgressBar()
1233
1425
        sys.stdout.writelines(w.weave_merge(p))
1234
1426
    else:
1235
1427
        raise ValueError('unknown command %r' % cmd)
1236
 
 
 
1428
    
1237
1429
 
1238
1430
if __name__ == '__main__':
1239
1431
    import sys
1240
1432
    sys.exit(main(sys.argv))
 
1433
 
 
1434
 
 
1435
class InterWeave(InterVersionedFile):
 
1436
    """Optimised code paths for weave to weave operations."""
 
1437
    
 
1438
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1439
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1440
    
 
1441
    @staticmethod
 
1442
    def is_compatible(source, target):
 
1443
        """Be compatible with weaves."""
 
1444
        try:
 
1445
            return (isinstance(source, Weave) and
 
1446
                    isinstance(target, Weave))
 
1447
        except AttributeError:
 
1448
            return False
 
1449
 
 
1450
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1451
        """See InterVersionedFile.join."""
 
1452
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1453
        if self.target.versions() == [] and version_ids is None:
 
1454
            self.target._copy_weave_content(self.source)
 
1455
            return
 
1456
        try:
 
1457
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1458
        except errors.WeaveParentMismatch:
 
1459
            self.target._reweave(self.source, pb, msg)
 
1460
 
 
1461
 
 
1462
InterVersionedFile.register_optimiser(InterWeave)