~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2006-03-05 02:20:07 UTC
  • mto: This revision was merged to the branch mainline in revision 1590.
  • Revision ID: robertc@robertcollins.net-20060305022007-53e5907d083453e8
Local commits appear to be working properly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2009 Canonical Ltd
2
 
#
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
 
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
7
 
#
 
9
 
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
13
# GNU General Public License for more details.
12
 
#
 
14
 
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
# Author: Martin Pool <mbp@canonical.com>
18
20
 
25
27
# property.
26
28
 
27
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
28
 
# rather than being split up in some other way.  We could accommodate
 
30
# rather than being split up in some other way.  We could accomodate
29
31
# binaries, perhaps by naively splitting on \n or perhaps using
30
32
# something like a rolling checksum.
31
33
 
59
61
# where the basis and destination are unchanged.
60
62
 
61
63
# FIXME: Sometimes we will be given a parents list for a revision
62
 
# that includes some redundant parents (i.e. already a parent of
63
 
# 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 
64
66
# be done fairly efficiently because the sequence numbers constrain
65
67
# the possible relationships.
66
68
 
67
 
# FIXME: the conflict markers should be *7* characters
68
69
 
69
 
from copy import copy
70
 
from cStringIO import StringIO
71
70
import os
 
71
import sha
 
72
from difflib import SequenceMatcher
72
73
 
73
 
from bzrlib.lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from bzrlib import tsort
76
 
""")
77
 
from bzrlib import (
78
 
    errors,
79
 
    osutils,
80
 
    )
 
74
from bzrlib.trace import mutter
81
75
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
 
        RevisionAlreadyPresent,
83
 
        RevisionNotPresent,
84
 
        UnavailableRepresentation,
85
 
        )
86
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
87
 
import bzrlib.patiencediff
88
 
from bzrlib.revision import NULL_REVISION
89
 
from bzrlib.symbol_versioning import *
90
 
from bzrlib.trace import mutter
91
 
from bzrlib.versionedfile import (
92
 
    AbsentContentFactory,
93
 
    adapter_registry,
94
 
    ContentFactory,
95
 
    sort_groupcompress,
96
 
    VersionedFile,
97
 
    )
98
 
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
 
 
100
 
 
101
 
class WeaveContentFactory(ContentFactory):
102
 
    """Content factory for streaming from weaves.
103
 
 
104
 
    :seealso ContentFactory:
105
 
    """
106
 
 
107
 
    def __init__(self, version, weave):
108
 
        """Create a WeaveContentFactory for version from weave."""
109
 
        ContentFactory.__init__(self)
110
 
        self.sha1 = weave.get_sha1s([version])[version]
111
 
        self.key = (version,)
112
 
        parents = weave.get_parent_map([version])[version]
113
 
        self.parents = tuple((parent,) for parent in parents)
114
 
        self.storage_kind = 'fulltext'
115
 
        self._weave = weave
116
 
 
117
 
    def get_bytes_as(self, storage_kind):
118
 
        if storage_kind == 'fulltext':
119
 
            return self._weave.get_text(self.key[-1])
120
 
        elif storage_kind == 'chunked':
121
 
            return self._weave.get_lines(self.key[-1])
122
 
        else:
123
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
124
 
 
125
 
 
126
 
class Weave(VersionedFile):
 
76
        WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent)
 
77
import bzrlib.errors as errors
 
78
from bzrlib.tsort import topo_sort
 
79
 
 
80
 
 
81
class Weave(object):
127
82
    """weave - versioned text file storage.
128
 
 
 
83
    
129
84
    A Weave manages versions of line-based text files, keeping track
130
85
    of the originating version for each line.
131
86
 
177
132
 
178
133
    * It doesn't seem very useful to have an active insertion
179
134
      inside an inactive insertion, but it might happen.
180
 
 
 
135
      
181
136
    * Therefore, all instructions are always"considered"; that
182
137
      is passed onto and off the stack.  An outer inactive block
183
138
      doesn't disable an inner block.
213
168
    """
214
169
 
215
170
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
216
 
                 '_weave_name', '_matcher', '_allow_reserved']
217
 
 
218
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
219
 
                 get_scope=None, allow_reserved=False):
220
 
        """Create a weave.
221
 
 
222
 
        :param get_scope: A callable that returns an opaque object to be used
223
 
            for detecting when this weave goes out of scope (should stop
224
 
            answering requests or allowing mutation).
225
 
        """
226
 
        super(Weave, self).__init__()
 
171
                 '_weave_name']
 
172
    
 
173
    def __init__(self, weave_name=None):
227
174
        self._weave = []
228
175
        self._parents = []
229
176
        self._sha1s = []
230
177
        self._names = []
231
178
        self._name_map = {}
232
179
        self._weave_name = weave_name
233
 
        if matcher is None:
234
 
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
 
        else:
236
 
            self._matcher = matcher
237
 
        if get_scope is None:
238
 
            get_scope = lambda:None
239
 
        self._get_scope = get_scope
240
 
        self._scope = get_scope()
241
 
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
180
 
244
181
    def __repr__(self):
245
182
        return "Weave(%r)" % self._weave_name
246
183
 
247
 
    def _check_write_ok(self):
248
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
249
 
        if self._get_scope() != self._scope:
250
 
            raise errors.OutSideTransaction()
251
 
        if self._access_mode != 'w':
252
 
            raise errors.ReadOnlyObjectDirtiedError(self)
253
184
 
254
185
    def copy(self):
255
186
        """Return a deep copy of self.
256
 
 
 
187
        
257
188
        The copy can be modified without affecting the original weave."""
258
189
        other = Weave()
259
190
        other._weave = self._weave[:]
269
200
            return False
270
201
        return self._parents == other._parents \
271
202
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
 
203
               and self._sha1s == other._sha1s 
273
204
 
 
205
    
274
206
    def __ne__(self, other):
275
207
        return not self.__eq__(other)
276
208
 
277
 
    def _idx_to_name(self, version):
278
 
        return self._names[version]
279
 
 
280
 
    def _lookup(self, name):
 
209
    def __contains__(self, name):
 
210
        return self._name_map.has_key(name)
 
211
 
 
212
    def maybe_lookup(self, name_or_index):
 
213
        """Convert possible symbolic name to index, or pass through indexes."""
 
214
        if isinstance(name_or_index, (int, long)):
 
215
            return name_or_index
 
216
        else:
 
217
            return self.lookup(name_or_index)
 
218
 
 
219
        
 
220
    def lookup(self, name):
281
221
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
284
222
        try:
285
223
            return self._name_map[name]
286
224
        except KeyError:
287
 
            raise RevisionNotPresent(name, self._weave_name)
 
225
            raise WeaveRevisionNotPresent(name, self)
288
226
 
289
 
    def versions(self):
290
 
        """See VersionedFile.versions."""
 
227
    def names(self):
291
228
        return self._names[:]
292
229
 
293
 
    def has_version(self, version_id):
294
 
        """See VersionedFile.has_version."""
295
 
        return (version_id in self._name_map)
296
 
 
297
 
    __contains__ = has_version
298
 
 
299
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
300
 
        """Get a stream of records for versions.
301
 
 
302
 
        :param versions: The versions to include. Each version is a tuple
303
 
            (version,).
304
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
305
 
            sorted stream has compression parents strictly before their
306
 
            children.
307
 
        :param include_delta_closure: If True then the closure across any
308
 
            compression parents will be included (in the opaque data).
309
 
        :return: An iterator of ContentFactory objects, each of which is only
310
 
            valid until the iterator is advanced.
311
 
        """
312
 
        versions = [version[-1] for version in versions]
313
 
        if ordering == 'topological':
314
 
            parents = self.get_parent_map(versions)
315
 
            new_versions = tsort.topo_sort(parents)
316
 
            new_versions.extend(set(versions).difference(set(parents)))
317
 
            versions = new_versions
318
 
        elif ordering == 'groupcompress':
319
 
            parents = self.get_parent_map(versions)
320
 
            new_versions = sort_groupcompress(parents)
321
 
            new_versions.extend(set(versions).difference(set(parents)))
322
 
            versions = new_versions
323
 
        for version in versions:
324
 
            if version in self:
325
 
                yield WeaveContentFactory(version, self)
326
 
            else:
327
 
                yield AbsentContentFactory((version,))
328
 
 
329
 
    def get_parent_map(self, version_ids):
330
 
        """See VersionedFile.get_parent_map."""
331
 
        result = {}
332
 
        for version_id in version_ids:
333
 
            if version_id == NULL_REVISION:
334
 
                parents = ()
335
 
            else:
336
 
                try:
337
 
                    parents = tuple(
338
 
                        map(self._idx_to_name,
339
 
                            self._parents[self._lookup(version_id)]))
340
 
                except RevisionNotPresent:
341
 
                    continue
342
 
            result[version_id] = parents
343
 
        return result
344
 
 
345
 
    def get_parents_with_ghosts(self, version_id):
346
 
        raise NotImplementedError(self.get_parents_with_ghosts)
347
 
 
348
 
    def insert_record_stream(self, stream):
349
 
        """Insert a record stream into this versioned file.
350
 
 
351
 
        :param stream: A stream of records to insert.
352
 
        :return: None
353
 
        :seealso VersionedFile.get_record_stream:
354
 
        """
355
 
        adapters = {}
356
 
        for record in stream:
357
 
            # Raise an error when a record is missing.
358
 
            if record.storage_kind == 'absent':
359
 
                raise RevisionNotPresent([record.key[0]], self)
360
 
            # adapt to non-tuple interface
361
 
            parents = [parent[0] for parent in record.parents]
362
 
            if (record.storage_kind == 'fulltext'
363
 
                or record.storage_kind == 'chunked'):
364
 
                self.add_lines(record.key[0], parents,
365
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
366
 
            else:
367
 
                adapter_key = record.storage_kind, 'fulltext'
368
 
                try:
369
 
                    adapter = adapters[adapter_key]
370
 
                except KeyError:
371
 
                    adapter_factory = adapter_registry.get(adapter_key)
372
 
                    adapter = adapter_factory(self)
373
 
                    adapters[adapter_key] = adapter
374
 
                lines = split_lines(adapter.get_bytes(record))
375
 
                try:
376
 
                    self.add_lines(record.key[0], parents, lines)
377
 
                except RevisionAlreadyPresent:
378
 
                    pass
 
230
    def iter_names(self):
 
231
        """Yield a list of all names in this weave."""
 
232
        return iter(self._names)
 
233
 
 
234
    def idx_to_name(self, version):
 
235
        return self._names[version]
379
236
 
380
237
    def _check_repeated_add(self, name, parents, text, sha1):
381
238
        """Check that a duplicated add is OK.
382
239
 
383
240
        If it is, return the (old) index; otherwise raise an exception.
384
241
        """
385
 
        idx = self._lookup(name)
 
242
        idx = self.lookup(name)
386
243
        if sorted(self._parents[idx]) != sorted(parents) \
387
244
            or sha1 != self._sha1s[idx]:
388
 
            raise RevisionAlreadyPresent(name, self._weave_name)
 
245
            raise WeaveRevisionAlreadyPresent(name, self)
389
246
        return idx
390
 
 
391
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
392
 
       left_matching_blocks, nostore_sha, random_id, check_content):
393
 
        """See VersionedFile.add_lines."""
394
 
        idx = self._add(version_id, lines, map(self._lookup, parents),
395
 
            nostore_sha=nostore_sha)
396
 
        return sha_strings(lines), sum(map(len, lines)), idx
397
 
 
398
 
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
 
247
        
 
248
    def add(self, name, parents, text, sha1=None):
399
249
        """Add a single text on top of the weave.
400
 
 
 
250
  
401
251
        Returns the index number of the newly added version.
402
252
 
403
 
        version_id
 
253
        name
404
254
            Symbolic name for this version.
405
255
            (Typically the revision-id of the revision that added it.)
406
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
407
256
 
408
257
        parents
409
258
            List or set of direct parent version numbers.
410
 
 
411
 
        lines
 
259
            
 
260
        text
412
261
            Sequence of lines to be added in the new version.
413
262
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
 
263
        sha -- SHA-1 of the file, if known.  This is trusted to be
 
264
            correct if supplied.
415
265
        """
416
 
        self._check_lines_not_unicode(lines)
417
 
        self._check_lines_are_lines(lines)
418
 
        if not sha1:
419
 
            sha1 = sha_strings(lines)
420
 
        if sha1 == nostore_sha:
421
 
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
 
        if version_id in self._name_map:
425
 
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
 
 
 
266
        from bzrlib.osutils import sha_strings
 
267
 
 
268
        assert isinstance(name, basestring)
 
269
        if sha1 is None:
 
270
            sha1 = sha_strings(text)
 
271
        if name in self._name_map:
 
272
            return self._check_repeated_add(name, parents, text, sha1)
 
273
 
 
274
        parents = map(self.maybe_lookup, parents)
427
275
        self._check_versions(parents)
428
 
        ## self._check_lines(lines)
 
276
        ## self._check_lines(text)
429
277
        new_version = len(self._parents)
430
278
 
 
279
 
431
280
        # if we abort after here the (in-memory) weave will be corrupt because only
432
281
        # some fields are updated
433
282
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
434
283
        #      - Robert Collins 20060226
435
284
        self._parents.append(parents[:])
436
285
        self._sha1s.append(sha1)
437
 
        self._names.append(version_id)
438
 
        self._name_map[version_id] = new_version
439
 
 
440
 
 
 
286
        self._names.append(name)
 
287
        self._name_map[name] = new_version
 
288
 
 
289
            
441
290
        if not parents:
442
291
            # special case; adding with no parents revision; can do
443
292
            # this more quickly by just appending unconditionally.
444
293
            # even more specially, if we're adding an empty text we
445
294
            # need do nothing at all.
446
 
            if lines:
 
295
            if text:
447
296
                self._weave.append(('{', new_version))
448
 
                self._weave.extend(lines)
 
297
                self._weave.extend(text)
449
298
                self._weave.append(('}', None))
 
299
        
450
300
            return new_version
451
301
 
452
302
        if len(parents) == 1:
454
304
            if sha1 == self._sha1s[pv]:
455
305
                # special case: same as the single parent
456
306
                return new_version
457
 
 
458
 
 
459
 
        ancestors = self._inclusions(parents)
 
307
            
 
308
 
 
309
        ancestors = self.inclusions(parents)
460
310
 
461
311
        l = self._weave
462
312
 
469
319
 
470
320
        # another small special case: a merge, producing the same text
471
321
        # as auto-merge
472
 
        if lines == basis_lines:
 
322
        if text == basis_lines:
473
323
            return new_version
474
324
 
475
 
        # add a sentinel, because we can also match against the final line
 
325
        # add a sentinal, because we can also match against the final line
476
326
        basis_lineno.append(len(self._weave))
477
327
 
478
328
        # XXX: which line of the weave should we really consider
482
332
        #print 'basis_lines:', basis_lines
483
333
        #print 'new_lines:  ', lines
484
334
 
485
 
        s = self._matcher(None, basis_lines, lines)
 
335
        s = SequenceMatcher(None, basis_lines, text)
486
336
 
487
337
        # offset gives the number of lines that have been inserted
488
338
        # into the weave up to the current point; if the original edit instruction
495
345
            #print 'raw match', tag, i1, i2, j1, j2
496
346
            if tag == 'equal':
497
347
                continue
 
348
 
498
349
            i1 = basis_lineno[i1]
499
350
            i2 = basis_lineno[i2]
 
351
 
 
352
            assert 0 <= j1 <= j2 <= len(text)
 
353
 
 
354
            #print tag, i1, i2, j1, j2
 
355
 
500
356
            # the deletion and insertion are handled separately.
501
357
            # first delete the region.
502
358
            if i1 != i2:
509
365
                # i2; we want to insert after this region to make sure
510
366
                # we don't destroy ourselves
511
367
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
368
                self._weave[i:i] = ([('{', new_version)] 
 
369
                                    + text[j1:j2] 
514
370
                                    + [('}', None)])
515
371
                offset += 2 + (j2 - j1)
 
372
 
516
373
        return new_version
517
374
 
518
 
    def _inclusions(self, versions):
 
375
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
376
        """Add an identical text to old_rev_id as new_rev_id."""
 
377
        old_lines = self.get(self.lookup(old_rev_id))
 
378
        self.add(new_rev_id, parents, old_lines)
 
379
 
 
380
    def inclusions(self, versions):
519
381
        """Return set of all ancestors of given version(s)."""
520
 
        if not len(versions):
521
 
            return []
522
382
        i = set(versions)
523
383
        for v in xrange(max(versions), 0, -1):
524
384
            if v in i:
528
388
        ## except IndexError:
529
389
        ##     raise ValueError("version %d not present in weave" % v)
530
390
 
531
 
    def get_ancestry(self, version_ids, topo_sorted=True):
532
 
        """See VersionedFile.get_ancestry."""
533
 
        if isinstance(version_ids, basestring):
534
 
            version_ids = [version_ids]
535
 
        i = self._inclusions([self._lookup(v) for v in version_ids])
536
 
        return [self._idx_to_name(v) for v in i]
 
391
 
 
392
    def parents(self, version):
 
393
        return self._parents[version]
 
394
 
 
395
 
 
396
    def parent_names(self, version):
 
397
        """Return version names for parents of a version."""
 
398
        return map(self.idx_to_name, self._parents[self.lookup(version)])
 
399
 
 
400
 
 
401
    def minimal_parents(self, version):
 
402
        """Find the minimal set of parents for the version."""
 
403
        included = self._parents[version]
 
404
        if not included:
 
405
            return []
 
406
        
 
407
        li = list(included)
 
408
        li.sort(reverse=True)
 
409
 
 
410
        mininc = []
 
411
        gotit = set()
 
412
 
 
413
        for pv in li:
 
414
            if pv not in gotit:
 
415
                mininc.append(pv)
 
416
                gotit.update(self.inclusions(pv))
 
417
 
 
418
        assert mininc[0] >= 0
 
419
        assert mininc[-1] < version
 
420
        return mininc
 
421
 
 
422
 
537
423
 
538
424
    def _check_lines(self, text):
539
425
        if not isinstance(text, list):
543
429
            if not isinstance(l, basestring):
544
430
                raise ValueError("text line should be a string or unicode, not %s"
545
431
                                 % type(l))
546
 
 
 
432
        
547
433
 
548
434
 
549
435
    def _check_versions(self, indexes):
554
440
            except IndexError:
555
441
                raise IndexError("invalid version number %r" % i)
556
442
 
557
 
    def _compatible_parents(self, my_parents, other_parents):
558
 
        """During join check that other_parents are joinable with my_parents.
559
 
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
561
 
        regeneration of diffs, but subsets do not.
562
 
        """
563
 
        return len(other_parents.difference(my_parents)) == 0
564
 
 
565
 
    def annotate(self, version_id):
566
 
        """Return a list of (version-id, line) tuples for version_id.
 
443
    
 
444
    def annotate(self, name_or_index):
 
445
        return list(self.annotate_iter(name_or_index))
 
446
 
 
447
 
 
448
    def annotate_iter(self, name_or_index):
 
449
        """Yield list of (index-id, line) pairs for the specified version.
567
450
 
568
451
        The index indicates when the line originated in the weave."""
569
 
        incls = [self._lookup(version_id)]
570
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
 
            self._extract(incls)]
572
 
 
573
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
574
 
                                                pb=None):
575
 
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
576
 
        if version_ids is None:
577
 
            version_ids = self.versions()
578
 
        version_ids = set(version_ids)
579
 
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
581
 
            if line[-1] != '\n':
582
 
                yield line + '\n', inserted
583
 
            else:
584
 
                yield line, inserted
585
 
 
586
 
    def _walk_internal(self, version_ids=None):
587
 
        """Helper method for weave actions."""
588
 
 
 
452
        incls = [self.maybe_lookup(name_or_index)]
 
453
        for origin, lineno, text in self._extract(incls):
 
454
            yield origin, text
 
455
 
 
456
    def _walk(self):
 
457
        """Walk the weave.
 
458
 
 
459
        Yields sequence of
 
460
        (lineno, insert, deletes, text)
 
461
        for each literal line.
 
462
        """
 
463
        
589
464
        istack = []
590
465
        dset = set()
591
466
 
592
467
        lineno = 0         # line of weave, 0-based
593
468
 
594
469
        for l in self._weave:
595
 
            if l.__class__ == tuple:
 
470
            if isinstance(l, tuple):
596
471
                c, v = l
597
472
                isactive = None
598
473
                if c == '{':
599
 
                    istack.append(self._names[v])
 
474
                    istack.append(v)
600
475
                elif c == '}':
601
476
                    istack.pop()
602
477
                elif c == '[':
603
 
                    dset.add(self._names[v])
 
478
                    assert v not in dset
 
479
                    dset.add(v)
604
480
                elif c == ']':
605
 
                    dset.remove(self._names[v])
 
481
                    dset.remove(v)
606
482
                else:
607
483
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
484
            else:
609
 
                yield lineno, istack[-1], frozenset(dset), l
 
485
                assert isinstance(l, basestring)
 
486
                assert istack
 
487
                yield lineno, istack[-1], dset, l
610
488
            lineno += 1
611
489
 
612
490
        if istack:
616
494
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
617
495
                                   % dset)
618
496
 
619
 
    def plan_merge(self, ver_a, ver_b):
620
 
        """Return pseudo-annotation indicating how the two versions merge.
621
 
 
622
 
        This is computed between versions a and b and their common
623
 
        base.
624
 
 
625
 
        Weave lines present in none of them are skipped entirely.
626
 
        """
627
 
        inc_a = set(self.get_ancestry([ver_a]))
628
 
        inc_b = set(self.get_ancestry([ver_b]))
629
 
        inc_c = inc_a & inc_b
630
 
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
632
 
            if deleteset & inc_c:
633
 
                # killed in parent; can't be in either a or b
634
 
                # not relevant to our work
635
 
                yield 'killed-base', line
636
 
            elif insert in inc_c:
637
 
                # was inserted in base
638
 
                killed_a = bool(deleteset & inc_a)
639
 
                killed_b = bool(deleteset & inc_b)
640
 
                if killed_a and killed_b:
641
 
                    yield 'killed-both', line
642
 
                elif killed_a:
643
 
                    yield 'killed-a', line
644
 
                elif killed_b:
645
 
                    yield 'killed-b', line
646
 
                else:
647
 
                    yield 'unchanged', line
648
 
            elif insert in inc_a:
649
 
                if deleteset & inc_a:
650
 
                    yield 'ghost-a', line
651
 
                else:
652
 
                    # new in A; not in B
653
 
                    yield 'new-a', line
654
 
            elif insert in inc_b:
655
 
                if deleteset & inc_b:
656
 
                    yield 'ghost-b', line
657
 
                else:
658
 
                    yield 'new-b', line
659
 
            else:
660
 
                # not in either revision
661
 
                yield 'irrelevant', line
662
 
 
663
497
    def _extract(self, versions):
664
498
        """Yield annotation of lines in included set.
665
499
 
672
506
        for i in versions:
673
507
            if not isinstance(i, int):
674
508
                raise ValueError(i)
675
 
 
676
 
        included = self._inclusions(versions)
 
509
            
 
510
        included = self.inclusions(versions)
677
511
 
678
512
        istack = []
679
 
        iset = set()
680
513
        dset = set()
681
514
 
682
515
        lineno = 0         # line of weave, 0-based
687
520
 
688
521
        WFE = WeaveFormatError
689
522
 
690
 
        # wow.
691
 
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
 
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
 
        # 1.6 seconds in 'isinstance'.
694
 
        # changing the first isinstance:
695
 
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
696
 
        #  +140414   0    762.8050    762.8050   +<isinstance>
697
 
        # note that the inline time actually dropped (less function calls)
698
 
        # and total processing time was halved.
699
 
        # we're still spending ~1/4 of the method in isinstance though.
700
 
        # so lets hard code the acceptable string classes we expect:
701
 
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
703
 
        #                                          objects>
704
 
        # yay, down to ~1/4 the initial extract time, and our inline time
705
 
        # has shrunk again, with isinstance no longer dominating.
706
 
        # tweaking the stack inclusion test to use a set gives:
707
 
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
709
 
        #                                          objects>
710
 
        # - a 5% win, or possibly just noise. However with large istacks that
711
 
        # 'in' test could dominate, so I'm leaving this change in place -
712
 
        # when its fast enough to consider profiling big datasets we can review.
713
 
 
714
 
 
715
 
 
716
 
 
717
523
        for l in self._weave:
718
 
            if l.__class__ == tuple:
 
524
            if isinstance(l, tuple):
719
525
                c, v = l
720
526
                isactive = None
721
527
                if c == '{':
 
528
                    assert v not in istack
722
529
                    istack.append(v)
723
 
                    iset.add(v)
724
530
                elif c == '}':
725
 
                    iset.remove(istack.pop())
 
531
                    istack.pop()
726
532
                elif c == '[':
727
533
                    if v in included:
 
534
                        assert v not in dset
728
535
                        dset.add(v)
729
 
                elif c == ']':
 
536
                else:
 
537
                    assert c == ']'
730
538
                    if v in included:
 
539
                        assert v in dset
731
540
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
541
            else:
 
542
                assert isinstance(l, basestring)
735
543
                if isactive is None:
736
544
                    isactive = (not dset) and istack and (istack[-1] in included)
737
545
                if isactive:
745
553
                                   % dset)
746
554
        return result
747
555
 
748
 
    def _maybe_lookup(self, name_or_index):
749
 
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
751
 
        NOT FOR PUBLIC USE.
 
556
 
 
557
    def get_iter(self, name_or_index):
 
558
        """Yield lines for the specified version."""
 
559
        incls = [self.maybe_lookup(name_or_index)]
 
560
        if len(incls) == 1:
 
561
            index = incls[0]
 
562
            cur_sha = sha.new()
 
563
        else:
 
564
            # We don't have sha1 sums for multiple entries
 
565
            cur_sha = None
 
566
        for origin, lineno, line in self._extract(incls):
 
567
            if cur_sha:
 
568
                cur_sha.update(line)
 
569
            yield line
 
570
        if cur_sha:
 
571
            expected_sha1 = self._sha1s[index]
 
572
            measured_sha1 = cur_sha.hexdigest() 
 
573
            if measured_sha1 != expected_sha1:
 
574
                raise errors.WeaveInvalidChecksum(
 
575
                        'file %s, revision %s, expected: %s, measured %s' 
 
576
                        % (self._weave_name, self._names[index],
 
577
                           expected_sha1, measured_sha1))
 
578
 
 
579
 
 
580
    def get_text(self, name_or_index):
 
581
        return ''.join(self.get_iter(name_or_index))
 
582
        assert isinstance(version, int)
 
583
 
 
584
 
 
585
    def get_lines(self, name_or_index):
 
586
        return list(self.get_iter(name_or_index))
 
587
 
 
588
 
 
589
    get = get_lines
 
590
 
 
591
 
 
592
    def get_sha1(self, name):
 
593
        """Get the stored sha1 sum for the given revision.
 
594
        
 
595
        :param name: The name of the version to lookup
752
596
        """
753
 
        if isinstance(name_or_index, (int, long)):
754
 
            return name_or_index
755
 
        else:
756
 
            return self._lookup(name_or_index)
757
 
 
758
 
    def get_lines(self, version_id):
759
 
        """See VersionedFile.get_lines()."""
760
 
        int_index = self._maybe_lookup(version_id)
761
 
        result = [line for (origin, lineno, line) in self._extract([int_index])]
762
 
        expected_sha1 = self._sha1s[int_index]
763
 
        measured_sha1 = sha_strings(result)
764
 
        if measured_sha1 != expected_sha1:
765
 
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
767
 
                    % (self._weave_name, version_id,
768
 
                       expected_sha1, measured_sha1))
769
 
        return result
770
 
 
771
 
    def get_sha1s(self, version_ids):
772
 
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
777
 
 
778
 
    def num_versions(self):
779
 
        """How many versions are in this weave?"""
 
597
        return self._sha1s[self.lookup(name)]
 
598
 
 
599
    def mash_iter(self, included):
 
600
        """Return composed version of multiple included versions."""
 
601
        included = map(self.maybe_lookup, included)
 
602
        for origin, lineno, text in self._extract(included):
 
603
            yield text
 
604
 
 
605
 
 
606
    def dump(self, to_file):
 
607
        from pprint import pprint
 
608
        print >>to_file, "Weave._weave = ",
 
609
        pprint(self._weave, to_file)
 
610
        print >>to_file, "Weave._parents = ",
 
611
        pprint(self._parents, to_file)
 
612
 
 
613
 
 
614
 
 
615
    def numversions(self):
780
616
        l = len(self._parents)
 
617
        assert l == len(self._sha1s)
781
618
        return l
782
619
 
783
 
    __len__ = num_versions
 
620
 
 
621
    def __len__(self):
 
622
        return self.numversions()
784
623
 
785
624
    def check(self, progress_bar=None):
786
 
        # TODO evaluate performance hit of using string sets in this routine.
787
 
        # TODO: check no circular inclusions
788
 
        # TODO: create a nested progress bar
789
 
        for version in range(self.num_versions()):
 
625
        # check no circular inclusions
 
626
        for version in range(self.numversions()):
790
627
            inclusions = list(self._parents[version])
791
628
            if inclusions:
792
629
                inclusions.sort()
795
632
                                           % (inclusions[-1], version))
796
633
 
797
634
        # try extracting all versions; parallel extraction is used
798
 
        nv = self.num_versions()
799
 
        sha1s = {}
800
 
        texts = {}
801
 
        inclusions = {}
 
635
        nv = self.numversions()
 
636
        sha1s = [sha.new() for i in range(nv)]
 
637
        texts = [[] for i in range(nv)]
 
638
        inclusions = []
802
639
        for i in range(nv):
803
640
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
641
            # The problem is that set membership is much more expensive
805
 
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
807
 
            texts[name] = []
808
 
            new_inc = set([name])
 
642
            new_inc = set([i])
809
643
            for p in self._parents[i]:
810
 
                new_inc.update(inclusions[self._idx_to_name(p)])
 
644
                new_inc.update(inclusions[p])
811
645
 
812
 
            if set(new_inc) != set(self.get_ancestry(name)):
813
 
                raise AssertionError(
814
 
                    'failed %s != %s'
815
 
                    % (set(new_inc), set(self.get_ancestry(name))))
816
 
            inclusions[name] = new_inc
 
646
            #assert set(new_inc) == self.inclusions([i]), 'failed %s != %s' % (new_inc, self.inclusions([i]))
 
647
            inclusions.append(new_inc)
817
648
 
818
649
        nlines = len(self._weave)
819
650
 
823
654
            update_text = 'checking %s' % (short_name,)
824
655
            update_text = update_text[:25]
825
656
 
826
 
        for lineno, insert, deleteset, line in self._walk_internal():
 
657
        for lineno, insert, deleteset, line in self._walk():
827
658
            if progress_bar:
828
659
                progress_bar.update(update_text, lineno, nlines)
829
660
 
830
 
            for name, name_inclusions in inclusions.items():
 
661
            for j, j_inc in enumerate(inclusions):
831
662
                # The active inclusion must be an ancestor,
832
663
                # and no ancestors must have deleted this line,
833
664
                # because we don't support resurrection.
834
 
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
835
 
                    sha1s[name].update(line)
 
665
                if (insert in j_inc) and not (deleteset & j_inc):
 
666
                    sha1s[j].update(line)
836
667
 
837
 
        for i in range(nv):
838
 
            version = self._idx_to_name(i)
 
668
        for version in range(nv):
839
669
            hd = sha1s[version].hexdigest()
840
 
            expected = self._sha1s[i]
 
670
            expected = self._sha1s[version]
841
671
            if hd != expected:
842
672
                raise errors.WeaveInvalidChecksum(
843
673
                        "mismatched sha1 for version %s: "
844
674
                        "got %s, expected %s"
845
 
                        % (version, hd, expected))
 
675
                        % (self._names[version], hd, expected))
846
676
 
847
677
        # TODO: check insertions are properly nested, that there are
848
678
        # no lines outside of insertion blocks, that deletions are
849
679
        # properly paired, etc.
850
680
 
 
681
    def _delta(self, included, lines):
 
682
        """Return changes from basis to new revision.
 
683
 
 
684
        The old text for comparison is the union of included revisions.
 
685
 
 
686
        This is used in inserting a new text.
 
687
 
 
688
        Delta is returned as a sequence of
 
689
        (weave1, weave2, newlines).
 
690
 
 
691
        This indicates that weave1:weave2 of the old weave should be
 
692
        replaced by the sequence of lines in newlines.  Note that
 
693
        these line numbers are positions in the total weave and don't
 
694
        correspond to the lines in any extracted version, or even the
 
695
        extracted union of included versions.
 
696
 
 
697
        If line1=line2, this is a pure insert; if newlines=[] this is a
 
698
        pure delete.  (Similar to difflib.)
 
699
        """
 
700
        raise NotImplementedError()
 
701
 
 
702
            
 
703
    def plan_merge(self, ver_a, ver_b):
 
704
        """Return pseudo-annotation indicating how the two versions merge.
 
705
 
 
706
        This is computed between versions a and b and their common
 
707
        base.
 
708
 
 
709
        Weave lines present in none of them are skipped entirely.
 
710
        """
 
711
        inc_a = self.inclusions([ver_a])
 
712
        inc_b = self.inclusions([ver_b])
 
713
        inc_c = inc_a & inc_b
 
714
 
 
715
        for lineno, insert, deleteset, line in self._walk():
 
716
            if deleteset & inc_c:
 
717
                # killed in parent; can't be in either a or b
 
718
                # not relevant to our work
 
719
                yield 'killed-base', line
 
720
            elif insert in inc_c:
 
721
                # was inserted in base
 
722
                killed_a = bool(deleteset & inc_a)
 
723
                killed_b = bool(deleteset & inc_b)
 
724
                if killed_a and killed_b:
 
725
                    yield 'killed-both', line
 
726
                elif killed_a:
 
727
                    yield 'killed-a', line
 
728
                elif killed_b:
 
729
                    yield 'killed-b', line
 
730
                else:
 
731
                    yield 'unchanged', line
 
732
            elif insert in inc_a:
 
733
                if deleteset & inc_a:
 
734
                    yield 'ghost-a', line
 
735
                else:
 
736
                    # new in A; not in B
 
737
                    yield 'new-a', line
 
738
            elif insert in inc_b:
 
739
                if deleteset & inc_b:
 
740
                    yield 'ghost-b', line
 
741
                else:
 
742
                    yield 'new-b', line
 
743
            else:
 
744
                # not in either revision
 
745
                yield 'irrelevant', line
 
746
 
 
747
        yield 'unchanged', ''           # terminator
 
748
 
 
749
 
 
750
 
 
751
    def weave_merge(self, plan, a_marker='<<<<<<< \n', b_marker='>>>>>>> \n'):
 
752
        lines_a = []
 
753
        lines_b = []
 
754
        ch_a = ch_b = False
 
755
        # TODO: Return a structured form of the conflicts (e.g. 2-tuples for
 
756
        # conflicted regions), rather than just inserting the markers.
 
757
        # 
 
758
        # TODO: Show some version information (e.g. author, date) on 
 
759
        # conflicted regions.
 
760
        for state, line in plan:
 
761
            if state == 'unchanged' or state == 'killed-both':
 
762
                # resync and flush queued conflicts changes if any
 
763
                if not lines_a and not lines_b:
 
764
                    pass
 
765
                elif ch_a and not ch_b:
 
766
                    # one-sided change:                    
 
767
                    for l in lines_a: yield l
 
768
                elif ch_b and not ch_a:
 
769
                    for l in lines_b: yield l
 
770
                elif lines_a == lines_b:
 
771
                    for l in lines_a: yield l
 
772
                else:
 
773
                    yield a_marker
 
774
                    for l in lines_a: yield l
 
775
                    yield '=======\n'
 
776
                    for l in lines_b: yield l
 
777
                    yield b_marker
 
778
 
 
779
                del lines_a[:]
 
780
                del lines_b[:]
 
781
                ch_a = ch_b = False
 
782
                
 
783
            if state == 'unchanged':
 
784
                if line:
 
785
                    yield line
 
786
            elif state == 'killed-a':
 
787
                ch_a = True
 
788
                lines_b.append(line)
 
789
            elif state == 'killed-b':
 
790
                ch_b = True
 
791
                lines_a.append(line)
 
792
            elif state == 'new-a':
 
793
                ch_a = True
 
794
                lines_a.append(line)
 
795
            elif state == 'new-b':
 
796
                ch_b = True
 
797
                lines_b.append(line)
 
798
            else:
 
799
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
 
800
                                 'killed-both'), \
 
801
                       state
 
802
 
 
803
 
 
804
    def join(self, other, pb=None, msg=None):
 
805
        import sys, time
 
806
        """Integrate versions from other into this weave.
 
807
 
 
808
        The resulting weave contains all the history of both weaves; 
 
809
        any version you could retrieve from either self or other can be 
 
810
        retrieved from self after this call.
 
811
 
 
812
        It is illegal for the two weaves to contain different values 
 
813
        or different parents for any version.  See also reweave().
 
814
 
 
815
        :param other: The other weave to pull into this one
 
816
        :param pb: An optional progress bar
 
817
        :param msg: An optional message to display for progress
 
818
        """
 
819
        if other.numversions() == 0:
 
820
            return          # nothing to update, easy
 
821
        # two loops so that we do not change ourselves before verifying it
 
822
        # will be ok
 
823
        # work through in index order to make sure we get all dependencies
 
824
        names_to_join = []
 
825
        processed = 0
 
826
        for other_idx, name in enumerate(other._names):
 
827
            self._check_version_consistent(other, other_idx, name)
 
828
            sha1 = other._sha1s[other_idx]
 
829
 
 
830
            processed += 1
 
831
 
 
832
            if name in self._name_map:
 
833
                idx = self.lookup(name)
 
834
                n1 = set(map(other.idx_to_name, other._parents[other_idx]))
 
835
                n2 = set(map(self.idx_to_name, self._parents[idx]))
 
836
                if sha1 ==  self._sha1s[idx] and n1 == n2:
 
837
                        continue
 
838
 
 
839
            names_to_join.append((other_idx, name))
 
840
 
 
841
        if pb and not msg:
 
842
            msg = 'weave join'
 
843
 
 
844
        merged = 0
 
845
        time0 = time.time( )
 
846
        for other_idx, name in names_to_join:
 
847
            # TODO: If all the parents of the other version are already
 
848
            # present then we can avoid some work by just taking the delta
 
849
            # and adjusting the offsets.
 
850
            new_parents = self._imported_parents(other, other_idx)
 
851
            sha1 = other._sha1s[other_idx]
 
852
 
 
853
            merged += 1
 
854
 
 
855
            if pb:
 
856
                pb.update(msg, merged, len(names_to_join))
 
857
           
 
858
            lines = other.get_lines(other_idx)
 
859
            self.add(name, new_parents, lines, sha1)
 
860
 
 
861
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
862
                merged, processed, self._weave_name, time.time( )-time0))
 
863
 
851
864
    def _imported_parents(self, other, other_idx):
852
865
        """Return list of parents in self corresponding to indexes in other."""
853
866
        new_parents = []
854
867
        for parent_idx in other._parents[other_idx]:
855
868
            parent_name = other._names[parent_idx]
856
 
            if parent_name not in self._name_map:
 
869
            if parent_name not in self._names:
857
870
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
871
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
872
                                 % (parent_name, other._name_map[other_idx], self))
860
873
            new_parents.append(self._name_map[parent_name])
861
874
        return new_parents
868
881
         * the same text
869
882
         * the same direct parents (by name, not index, and disregarding
870
883
           order)
871
 
 
 
884
        
872
885
        If present & correct return True;
873
 
        if not present in self return False;
 
886
        if not present in self return False; 
874
887
        if inconsistent raise error."""
875
888
        this_idx = self._name_map.get(name, -1)
876
889
        if this_idx != -1:
877
890
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
878
 
                raise errors.WeaveTextDiffers(name, self, other)
 
891
                raise WeaveError("inconsistent texts for version {%s} "
 
892
                                 "when joining weaves"
 
893
                                 % (name))
879
894
            self_parents = self._parents[this_idx]
880
895
            other_parents = other._parents[other_idx]
881
896
            n1 = set([self._names[i] for i in self_parents])
882
897
            n2 = set([other._names[i] for i in other_parents])
883
 
            if not self._compatible_parents(n1, n2):
 
898
            if n1 != n2:
884
899
                raise WeaveParentMismatch("inconsistent parents "
885
900
                    "for version {%s}: %s vs %s" % (name, n1, n2))
886
901
            else:
888
903
        else:
889
904
            return False
890
905
 
891
 
    def _reweave(self, other, pb, msg):
892
 
        """Reweave self with other - internal helper for join().
 
906
    def reweave(self, other, pb=None, msg=None):
 
907
        """Reweave self with other.
893
908
 
894
909
        :param other: The other weave to merge
895
910
        :param pb: An optional progress bar, indicating how far done we are
896
911
        :param msg: An optional message for the progress
897
912
        """
898
 
        new_weave = _reweave(self, other, pb=pb, msg=msg)
899
 
        self._copy_weave_content(new_weave)
900
 
 
901
 
    def _copy_weave_content(self, otherweave):
902
 
        """adsorb the content from otherweave."""
 
913
        new_weave = reweave(self, other, pb=pb, msg=msg)
903
914
        for attr in self.__slots__:
904
 
            if attr != '_weave_name':
905
 
                setattr(self, attr, copy(getattr(otherweave, attr)))
906
 
 
907
 
 
908
 
class WeaveFile(Weave):
909
 
    """A WeaveFile represents a Weave on disk and writes on change."""
910
 
 
911
 
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
914
 
        """Create a WeaveFile.
915
 
 
916
 
        :param create: If not True, only open an existing knit.
917
 
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
920
 
        self._transport = transport
921
 
        self._filemode = filemode
922
 
        try:
923
 
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
924
 
        except errors.NoSuchFile:
925
 
            if not create:
926
 
                raise
927
 
            # new file, save it
928
 
            self._save()
929
 
 
930
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
931
 
        left_matching_blocks, nostore_sha, random_id, check_content):
932
 
        """Add a version and save the weave."""
933
 
        self.check_not_reserved_id(version_id)
934
 
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
935
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
936
 
            check_content)
937
 
        self._save()
938
 
        return result
939
 
 
940
 
    def copy_to(self, name, transport):
941
 
        """See VersionedFile.copy_to()."""
942
 
        # as we are all in memory always, just serialise to the new place.
943
 
        sio = StringIO()
944
 
        write_weave_v5(self, sio)
945
 
        sio.seek(0)
946
 
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
947
 
 
948
 
    def _save(self):
949
 
        """Save the weave."""
950
 
        self._check_write_ok()
951
 
        sio = StringIO()
952
 
        write_weave_v5(self, sio)
953
 
        sio.seek(0)
954
 
        bytes = sio.getvalue()
955
 
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
956
 
        try:
957
 
            self._transport.put_bytes(path, bytes, self._filemode)
958
 
        except errors.NoSuchFile:
959
 
            self._transport.mkdir(dirname(path))
960
 
            self._transport.put_bytes(path, bytes, self._filemode)
961
 
 
962
 
    @staticmethod
963
 
    def get_suffixes():
964
 
        """See VersionedFile.get_suffixes()."""
965
 
        return [WeaveFile.WEAVE_SUFFIX]
966
 
 
967
 
    def insert_record_stream(self, stream):
968
 
        super(WeaveFile, self).insert_record_stream(stream)
969
 
        self._save()
970
 
 
971
 
 
972
 
def _reweave(wa, wb, pb=None, msg=None):
 
915
            setattr(self, attr, getattr(new_weave, attr))
 
916
 
 
917
 
 
918
def reweave(wa, wb, pb=None, msg=None):
973
919
    """Combine two weaves and return the result.
974
920
 
975
 
    This works even if a revision R has different parents in
 
921
    This works even if a revision R has different parents in 
976
922
    wa and wb.  In the resulting weave all the parents are given.
977
923
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
924
    This is done by just building up a new weave, maintaining ordering 
979
925
    of the versions in the two inputs.  More efficient approaches
980
 
    might be possible but it should only be necessary to do
981
 
    this operation rarely, when a new previously ghost version is
 
926
    might be possible but it should only be necessary to do 
 
927
    this operation rarely, when a new previously ghost version is 
982
928
    inserted.
983
929
 
984
930
    :param pb: An optional progress bar, indicating how far done we are
986
932
    """
987
933
    wr = Weave()
988
934
    ia = ib = 0
989
 
    queue_a = range(wa.num_versions())
990
 
    queue_b = range(wb.num_versions())
 
935
    queue_a = range(wa.numversions())
 
936
    queue_b = range(wb.numversions())
991
937
    # first determine combined parents of all versions
992
938
    # map from version name -> all parent names
993
939
    combined_parents = _reweave_parent_graphs(wa, wb)
994
940
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
941
    order = topo_sort(combined_parents.iteritems())
996
942
    mutter("order to reweave: %r", order)
997
943
 
998
944
    if pb and not msg:
1015
961
                    raise errors.WeaveTextDiffers(name, wa, wb)
1016
962
        else:
1017
963
            lines = wb.get_lines(name)
1018
 
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
964
        wr.add(name, combined_parents[name], lines)
1019
965
    return wr
1020
966
 
1021
967
 
1022
968
def _reweave_parent_graphs(wa, wb):
1023
969
    """Return combined parent ancestry for two weaves.
1024
 
 
 
970
    
1025
971
    Returned as a list of (version_name, set(parent_names))"""
1026
972
    combined = {}
1027
973
    for weave in [wa, wb]:
1028
974
        for idx, name in enumerate(weave._names):
1029
975
            p = combined.setdefault(name, set())
1030
 
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
976
            p.update(map(weave.idx_to_name, weave._parents[idx]))
1031
977
    return combined
 
978
 
 
979
 
 
980
def weave_toc(w):
 
981
    """Show the weave's table-of-contents"""
 
982
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
983
    for i in (6, 50, 10, 10):
 
984
        print '-' * i,
 
985
    print
 
986
    for i in range(w.numversions()):
 
987
        sha1 = w._sha1s[i]
 
988
        name = w._names[i]
 
989
        parent_str = ' '.join(map(str, w._parents[i]))
 
990
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
991
 
 
992
 
 
993
 
 
994
def weave_stats(weave_file, pb):
 
995
    from bzrlib.weavefile import read_weave
 
996
 
 
997
    wf = file(weave_file, 'rb')
 
998
    w = read_weave(wf)
 
999
    # FIXME: doesn't work on pipes
 
1000
    weave_size = wf.tell()
 
1001
 
 
1002
    total = 0
 
1003
    vers = len(w)
 
1004
    for i in range(vers):
 
1005
        pb.update('checking sizes', i, vers)
 
1006
        for origin, lineno, line in w._extract([i]):
 
1007
            total += len(line)
 
1008
 
 
1009
    pb.clear()
 
1010
 
 
1011
    print 'versions          %9d' % vers
 
1012
    print 'weave file        %9d bytes' % weave_size
 
1013
    print 'total contents    %9d bytes' % total
 
1014
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1015
    if vers:
 
1016
        avg = total/vers
 
1017
        print 'average size      %9d bytes' % avg
 
1018
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1019
 
 
1020
 
 
1021
def usage():
 
1022
    print """bzr weave tool
 
1023
 
 
1024
Experimental tool for weave algorithm.
 
1025
 
 
1026
usage:
 
1027
    weave init WEAVEFILE
 
1028
        Create an empty weave file
 
1029
    weave get WEAVEFILE VERSION
 
1030
        Write out specified version.
 
1031
    weave check WEAVEFILE
 
1032
        Check consistency of all versions.
 
1033
    weave toc WEAVEFILE
 
1034
        Display table of contents.
 
1035
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1036
        Add NEWTEXT, with specified parent versions.
 
1037
    weave annotate WEAVEFILE VERSION
 
1038
        Display origin of each line.
 
1039
    weave mash WEAVEFILE VERSION...
 
1040
        Display composite of all selected versions.
 
1041
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1042
        Auto-merge two versions and display conflicts.
 
1043
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1044
        Show differences between two versions.
 
1045
 
 
1046
example:
 
1047
 
 
1048
    % weave init foo.weave
 
1049
    % vi foo.txt
 
1050
    % weave add foo.weave ver0 < foo.txt
 
1051
    added version 0
 
1052
 
 
1053
    (create updated version)
 
1054
    % vi foo.txt
 
1055
    % weave get foo.weave 0 | diff -u - foo.txt
 
1056
    % weave add foo.weave ver1 0 < foo.txt
 
1057
    added version 1
 
1058
 
 
1059
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1060
    % vi foo.txt
 
1061
    % weave add foo.weave ver2 0 < foo.txt
 
1062
    added version 2
 
1063
 
 
1064
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1065
    % vi foo.txt                            (resolve conflicts)
 
1066
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1067
    
 
1068
"""
 
1069
    
 
1070
 
 
1071
 
 
1072
def main(argv):
 
1073
    import sys
 
1074
    import os
 
1075
    try:
 
1076
        import bzrlib
 
1077
    except ImportError:
 
1078
        # in case we're run directly from the subdirectory
 
1079
        sys.path.append('..')
 
1080
        import bzrlib
 
1081
    from bzrlib.weavefile import write_weave, read_weave
 
1082
    from bzrlib.progress import ProgressBar
 
1083
 
 
1084
    try:
 
1085
        import psyco
 
1086
        psyco.full()
 
1087
    except ImportError:
 
1088
        pass
 
1089
 
 
1090
    if len(argv) < 2:
 
1091
        usage()
 
1092
        return 0
 
1093
 
 
1094
    cmd = argv[1]
 
1095
 
 
1096
    def readit():
 
1097
        return read_weave(file(argv[2], 'rb'))
 
1098
    
 
1099
    if cmd == 'help':
 
1100
        usage()
 
1101
    elif cmd == 'add':
 
1102
        w = readit()
 
1103
        # at the moment, based on everything in the file
 
1104
        name = argv[3]
 
1105
        parents = map(int, argv[4:])
 
1106
        lines = sys.stdin.readlines()
 
1107
        ver = w.add(name, parents, lines)
 
1108
        write_weave(w, file(argv[2], 'wb'))
 
1109
        print 'added version %r %d' % (name, ver)
 
1110
    elif cmd == 'init':
 
1111
        fn = argv[2]
 
1112
        if os.path.exists(fn):
 
1113
            raise IOError("file exists")
 
1114
        w = Weave()
 
1115
        write_weave(w, file(fn, 'wb'))
 
1116
    elif cmd == 'get': # get one version
 
1117
        w = readit()
 
1118
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1119
        
 
1120
    elif cmd == 'mash': # get composite
 
1121
        w = readit()
 
1122
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
1123
 
 
1124
    elif cmd == 'diff':
 
1125
        from difflib import unified_diff
 
1126
        w = readit()
 
1127
        fn = argv[2]
 
1128
        v1, v2 = map(int, argv[3:5])
 
1129
        lines1 = w.get(v1)
 
1130
        lines2 = w.get(v2)
 
1131
        diff_gen = unified_diff(lines1, lines2,
 
1132
                                '%s version %d' % (fn, v1),
 
1133
                                '%s version %d' % (fn, v2))
 
1134
        sys.stdout.writelines(diff_gen)
 
1135
            
 
1136
    elif cmd == 'annotate':
 
1137
        w = readit()
 
1138
        # newline is added to all lines regardless; too hard to get
 
1139
        # reasonable formatting otherwise
 
1140
        lasto = None
 
1141
        for origin, text in w.annotate(int(argv[3])):
 
1142
            text = text.rstrip('\r\n')
 
1143
            if origin == lasto:
 
1144
                print '      | %s' % (text)
 
1145
            else:
 
1146
                print '%5d | %s' % (origin, text)
 
1147
                lasto = origin
 
1148
                
 
1149
    elif cmd == 'toc':
 
1150
        weave_toc(readit())
 
1151
 
 
1152
    elif cmd == 'stats':
 
1153
        weave_stats(argv[2], ProgressBar())
 
1154
        
 
1155
    elif cmd == 'check':
 
1156
        w = readit()
 
1157
        pb = ProgressBar()
 
1158
        w.check(pb)
 
1159
        pb.clear()
 
1160
        print '%d versions ok' % w.numversions()
 
1161
 
 
1162
    elif cmd == 'inclusions':
 
1163
        w = readit()
 
1164
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1165
 
 
1166
    elif cmd == 'parents':
 
1167
        w = readit()
 
1168
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1169
 
 
1170
    elif cmd == 'plan-merge':
 
1171
        w = readit()
 
1172
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1173
            if line:
 
1174
                print '%14s | %s' % (state, line),
 
1175
 
 
1176
    elif cmd == 'merge':
 
1177
        w = readit()
 
1178
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1179
        sys.stdout.writelines(w.weave_merge(p))
 
1180
            
 
1181
    elif cmd == 'mash-merge':
 
1182
        if len(argv) != 5:
 
1183
            usage()
 
1184
            return 1
 
1185
 
 
1186
        w = readit()
 
1187
        v1, v2 = map(int, argv[3:5])
 
1188
 
 
1189
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
 
1190
 
 
1191
        base_lines = list(w.mash_iter(basis))
 
1192
        a_lines = list(w.get(v1))
 
1193
        b_lines = list(w.get(v2))
 
1194
 
 
1195
        from bzrlib.merge3 import Merge3
 
1196
        m3 = Merge3(base_lines, a_lines, b_lines)
 
1197
 
 
1198
        name_a = 'version %d' % v1
 
1199
        name_b = 'version %d' % v2
 
1200
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
 
1201
    else:
 
1202
        raise ValueError('unknown command %r' % cmd)
 
1203
    
 
1204
 
 
1205
 
 
1206
def profile_main(argv): 
 
1207
    import tempfile, hotshot, hotshot.stats
 
1208
 
 
1209
    prof_f = tempfile.NamedTemporaryFile()
 
1210
 
 
1211
    prof = hotshot.Profile(prof_f.name)
 
1212
 
 
1213
    ret = prof.runcall(main, argv)
 
1214
    prof.close()
 
1215
 
 
1216
    stats = hotshot.stats.load(prof_f.name)
 
1217
    #stats.strip_dirs()
 
1218
    stats.sort_stats('cumulative')
 
1219
    ## XXX: Might like to write to stderr or the trace file instead but
 
1220
    ## print_stats seems hardcoded to stdout
 
1221
    stats.print_stats(20)
 
1222
            
 
1223
    return ret
 
1224
 
 
1225
 
 
1226
def lsprofile_main(argv): 
 
1227
    from bzrlib.lsprof import profile
 
1228
    ret,stats = profile(main, argv)
 
1229
    stats.sort()
 
1230
    stats.pprint()
 
1231
    return ret
 
1232
 
 
1233
 
 
1234
if __name__ == '__main__':
 
1235
    import sys
 
1236
    if '--profile' in sys.argv:
 
1237
        args = sys.argv[:]
 
1238
        args.remove('--profile')
 
1239
        sys.exit(profile_main(args))
 
1240
    elif '--lsprof' in sys.argv:
 
1241
        args = sys.argv[:]
 
1242
        args.remove('--lsprof')
 
1243
        sys.exit(lsprofile_main(args))
 
1244
    else:
 
1245
        sys.exit(main(sys.argv))
 
1246