~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2006-01-05 10:49:26 UTC
  • mto: (1534.1.2 integration)
  • mto: This revision was merged to the branch mainline in revision 1536.
  • Revision ID: robertc@robertcollins.net-20060105104926-6e5dc14eff2352ca
Implement deprecated_method

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
 
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
434
 
        #      - Robert Collins 20060226
435
282
        self._parents.append(parents[:])
436
283
        self._sha1s.append(sha1)
437
 
        self._names.append(version_id)
438
 
        self._name_map[version_id] = new_version
439
 
 
440
 
 
 
284
        self._names.append(name)
 
285
        self._name_map[name] = new_version
 
286
 
 
287
            
441
288
        if not parents:
442
289
            # special case; adding with no parents revision; can do
443
290
            # this more quickly by just appending unconditionally.
444
291
            # even more specially, if we're adding an empty text we
445
292
            # need do nothing at all.
446
 
            if lines:
 
293
            if text:
447
294
                self._weave.append(('{', new_version))
448
 
                self._weave.extend(lines)
 
295
                self._weave.extend(text)
449
296
                self._weave.append(('}', None))
 
297
        
450
298
            return new_version
451
299
 
452
300
        if len(parents) == 1:
454
302
            if sha1 == self._sha1s[pv]:
455
303
                # special case: same as the single parent
456
304
                return new_version
457
 
 
458
 
 
459
 
        ancestors = self._inclusions(parents)
 
305
            
 
306
 
 
307
        ancestors = self.inclusions(parents)
460
308
 
461
309
        l = self._weave
462
310
 
469
317
 
470
318
        # another small special case: a merge, producing the same text
471
319
        # as auto-merge
472
 
        if lines == basis_lines:
473
 
            return new_version
 
320
        if text == basis_lines:
 
321
            return new_version            
474
322
 
475
 
        # add a sentinel, because we can also match against the final line
 
323
        # add a sentinal, because we can also match against the final line
476
324
        basis_lineno.append(len(self._weave))
477
325
 
478
326
        # XXX: which line of the weave should we really consider
482
330
        #print 'basis_lines:', basis_lines
483
331
        #print 'new_lines:  ', lines
484
332
 
485
 
        s = self._matcher(None, basis_lines, lines)
 
333
        s = SequenceMatcher(None, basis_lines, text)
486
334
 
487
335
        # offset gives the number of lines that have been inserted
488
336
        # into the weave up to the current point; if the original edit instruction
495
343
            #print 'raw match', tag, i1, i2, j1, j2
496
344
            if tag == 'equal':
497
345
                continue
 
346
 
498
347
            i1 = basis_lineno[i1]
499
348
            i2 = basis_lineno[i2]
 
349
 
 
350
            assert 0 <= j1 <= j2 <= len(text)
 
351
 
 
352
            #print tag, i1, i2, j1, j2
 
353
 
500
354
            # the deletion and insertion are handled separately.
501
355
            # first delete the region.
502
356
            if i1 != i2:
509
363
                # i2; we want to insert after this region to make sure
510
364
                # we don't destroy ourselves
511
365
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
366
                self._weave[i:i] = ([('{', new_version)] 
 
367
                                    + text[j1:j2] 
514
368
                                    + [('}', None)])
515
369
                offset += 2 + (j2 - j1)
 
370
 
516
371
        return new_version
517
372
 
518
 
    def _inclusions(self, versions):
 
373
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
374
        """Add an identical text to old_rev_id as new_rev_id."""
 
375
        old_lines = self.get(self.lookup(old_rev_id))
 
376
        self.add(new_rev_id, parents, old_lines)
 
377
 
 
378
    def inclusions(self, versions):
519
379
        """Return set of all ancestors of given version(s)."""
520
 
        if not len(versions):
521
 
            return []
522
380
        i = set(versions)
523
381
        for v in xrange(max(versions), 0, -1):
524
382
            if v in i:
528
386
        ## except IndexError:
529
387
        ##     raise ValueError("version %d not present in weave" % v)
530
388
 
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]
 
389
 
 
390
    def parents(self, version):
 
391
        return self._parents[version]
 
392
 
 
393
 
 
394
    def parent_names(self, version):
 
395
        """Return version names for parents of a version."""
 
396
        return map(self.idx_to_name, self._parents[self.lookup(version)])
 
397
 
 
398
 
 
399
    def minimal_parents(self, version):
 
400
        """Find the minimal set of parents for the version."""
 
401
        included = self._parents[version]
 
402
        if not included:
 
403
            return []
 
404
        
 
405
        li = list(included)
 
406
        li.sort(reverse=True)
 
407
 
 
408
        mininc = []
 
409
        gotit = set()
 
410
 
 
411
        for pv in li:
 
412
            if pv not in gotit:
 
413
                mininc.append(pv)
 
414
                gotit.update(self.inclusions(pv))
 
415
 
 
416
        assert mininc[0] >= 0
 
417
        assert mininc[-1] < version
 
418
        return mininc
 
419
 
 
420
 
537
421
 
538
422
    def _check_lines(self, text):
539
423
        if not isinstance(text, list):
543
427
            if not isinstance(l, basestring):
544
428
                raise ValueError("text line should be a string or unicode, not %s"
545
429
                                 % type(l))
546
 
 
 
430
        
547
431
 
548
432
 
549
433
    def _check_versions(self, indexes):
554
438
            except IndexError:
555
439
                raise IndexError("invalid version number %r" % i)
556
440
 
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.
 
441
    
 
442
    def annotate(self, name_or_index):
 
443
        return list(self.annotate_iter(name_or_index))
 
444
 
 
445
 
 
446
    def annotate_iter(self, name_or_index):
 
447
        """Yield list of (index-id, line) pairs for the specified version.
567
448
 
568
449
        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
 
 
 
450
        incls = [self.maybe_lookup(name_or_index)]
 
451
        for origin, lineno, text in self._extract(incls):
 
452
            yield origin, text
 
453
 
 
454
    def _walk(self):
 
455
        """Walk the weave.
 
456
 
 
457
        Yields sequence of
 
458
        (lineno, insert, deletes, text)
 
459
        for each literal line.
 
460
        """
 
461
        
589
462
        istack = []
590
463
        dset = set()
591
464
 
592
465
        lineno = 0         # line of weave, 0-based
593
466
 
594
467
        for l in self._weave:
595
 
            if l.__class__ == tuple:
 
468
            if isinstance(l, tuple):
596
469
                c, v = l
597
470
                isactive = None
598
471
                if c == '{':
599
 
                    istack.append(self._names[v])
 
472
                    istack.append(v)
600
473
                elif c == '}':
601
474
                    istack.pop()
602
475
                elif c == '[':
603
 
                    dset.add(self._names[v])
 
476
                    assert v not in dset
 
477
                    dset.add(v)
604
478
                elif c == ']':
605
 
                    dset.remove(self._names[v])
 
479
                    dset.remove(v)
606
480
                else:
607
481
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
482
            else:
609
 
                yield lineno, istack[-1], frozenset(dset), l
 
483
                assert isinstance(l, basestring)
 
484
                assert istack
 
485
                yield lineno, istack[-1], dset, l
610
486
            lineno += 1
611
487
 
612
488
        if istack:
616
492
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
617
493
                                   % dset)
618
494
 
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
495
    def _extract(self, versions):
664
496
        """Yield annotation of lines in included set.
665
497
 
672
504
        for i in versions:
673
505
            if not isinstance(i, int):
674
506
                raise ValueError(i)
675
 
 
676
 
        included = self._inclusions(versions)
 
507
            
 
508
        included = self.inclusions(versions)
677
509
 
678
510
        istack = []
679
 
        iset = set()
680
511
        dset = set()
681
512
 
682
513
        lineno = 0         # line of weave, 0-based
687
518
 
688
519
        WFE = WeaveFormatError
689
520
 
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
521
        for l in self._weave:
718
 
            if l.__class__ == tuple:
 
522
            if isinstance(l, tuple):
719
523
                c, v = l
720
524
                isactive = None
721
525
                if c == '{':
 
526
                    assert v not in istack
722
527
                    istack.append(v)
723
 
                    iset.add(v)
724
528
                elif c == '}':
725
 
                    iset.remove(istack.pop())
 
529
                    istack.pop()
726
530
                elif c == '[':
727
531
                    if v in included:
 
532
                        assert v not in dset
728
533
                        dset.add(v)
729
 
                elif c == ']':
 
534
                else:
 
535
                    assert c == ']'
730
536
                    if v in included:
 
537
                        assert v in dset
731
538
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
539
            else:
 
540
                assert isinstance(l, basestring)
735
541
                if isactive is None:
736
542
                    isactive = (not dset) and istack and (istack[-1] in included)
737
543
                if isactive:
745
551
                                   % dset)
746
552
        return result
747
553
 
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.
 
554
 
 
555
    def get_iter(self, name_or_index):
 
556
        """Yield lines for the specified version."""
 
557
        incls = [self.maybe_lookup(name_or_index)]
 
558
        if len(incls) == 1:
 
559
            index = incls[0]
 
560
            cur_sha = sha.new()
 
561
        else:
 
562
            # We don't have sha1 sums for multiple entries
 
563
            cur_sha = None
 
564
        for origin, lineno, line in self._extract(incls):
 
565
            if cur_sha:
 
566
                cur_sha.update(line)
 
567
            yield line
 
568
        if cur_sha:
 
569
            expected_sha1 = self._sha1s[index]
 
570
            measured_sha1 = cur_sha.hexdigest() 
 
571
            if measured_sha1 != expected_sha1:
 
572
                raise errors.WeaveInvalidChecksum(
 
573
                        'file %s, revision %s, expected: %s, measured %s' 
 
574
                        % (self._weave_name, self._names[index],
 
575
                           expected_sha1, measured_sha1))
 
576
 
 
577
 
 
578
    def get_text(self, name_or_index):
 
579
        return ''.join(self.get_iter(name_or_index))
 
580
        assert isinstance(version, int)
 
581
 
 
582
 
 
583
    def get_lines(self, name_or_index):
 
584
        return list(self.get_iter(name_or_index))
 
585
 
 
586
 
 
587
    get = get_lines
 
588
 
 
589
 
 
590
    def get_sha1(self, name):
 
591
        """Get the stored sha1 sum for the given revision.
 
592
        
 
593
        :param name: The name of the version to lookup
752
594
        """
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?"""
 
595
        return self._sha1s[self.lookup(name)]
 
596
 
 
597
    def mash_iter(self, included):
 
598
        """Return composed version of multiple included versions."""
 
599
        included = map(self.maybe_lookup, included)
 
600
        for origin, lineno, text in self._extract(included):
 
601
            yield text
 
602
 
 
603
 
 
604
    def dump(self, to_file):
 
605
        from pprint import pprint
 
606
        print >>to_file, "Weave._weave = ",
 
607
        pprint(self._weave, to_file)
 
608
        print >>to_file, "Weave._parents = ",
 
609
        pprint(self._parents, to_file)
 
610
 
 
611
 
 
612
 
 
613
    def numversions(self):
780
614
        l = len(self._parents)
 
615
        assert l == len(self._sha1s)
781
616
        return l
782
617
 
783
 
    __len__ = num_versions
 
618
 
 
619
    def __len__(self):
 
620
        return self.numversions()
784
621
 
785
622
    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()):
 
623
        # check no circular inclusions
 
624
        for version in range(self.numversions()):
790
625
            inclusions = list(self._parents[version])
791
626
            if inclusions:
792
627
                inclusions.sort()
795
630
                                           % (inclusions[-1], version))
796
631
 
797
632
        # try extracting all versions; parallel extraction is used
798
 
        nv = self.num_versions()
799
 
        sha1s = {}
800
 
        texts = {}
801
 
        inclusions = {}
 
633
        nv = self.numversions()
 
634
        sha1s = [sha.new() for i in range(nv)]
 
635
        texts = [[] for i in range(nv)]
 
636
        inclusions = []
802
637
        for i in range(nv):
803
638
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
639
            # 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])
 
640
            new_inc = set([i])
809
641
            for p in self._parents[i]:
810
 
                new_inc.update(inclusions[self._idx_to_name(p)])
 
642
                new_inc.update(inclusions[p])
811
643
 
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
 
644
            #assert set(new_inc) == self.inclusions([i]), 'failed %s != %s' % (new_inc, self.inclusions([i]))
 
645
            inclusions.append(new_inc)
817
646
 
818
647
        nlines = len(self._weave)
819
648
 
823
652
            update_text = 'checking %s' % (short_name,)
824
653
            update_text = update_text[:25]
825
654
 
826
 
        for lineno, insert, deleteset, line in self._walk_internal():
 
655
        for lineno, insert, deleteset, line in self._walk():
827
656
            if progress_bar:
828
657
                progress_bar.update(update_text, lineno, nlines)
829
658
 
830
 
            for name, name_inclusions in inclusions.items():
 
659
            for j, j_inc in enumerate(inclusions):
831
660
                # The active inclusion must be an ancestor,
832
661
                # and no ancestors must have deleted this line,
833
662
                # because we don't support resurrection.
834
 
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
835
 
                    sha1s[name].update(line)
 
663
                if (insert in j_inc) and not (deleteset & j_inc):
 
664
                    sha1s[j].update(line)
836
665
 
837
 
        for i in range(nv):
838
 
            version = self._idx_to_name(i)
 
666
        for version in range(nv):
839
667
            hd = sha1s[version].hexdigest()
840
 
            expected = self._sha1s[i]
 
668
            expected = self._sha1s[version]
841
669
            if hd != expected:
842
670
                raise errors.WeaveInvalidChecksum(
843
671
                        "mismatched sha1 for version %s: "
844
672
                        "got %s, expected %s"
845
 
                        % (version, hd, expected))
 
673
                        % (self._names[version], hd, expected))
846
674
 
847
675
        # TODO: check insertions are properly nested, that there are
848
676
        # no lines outside of insertion blocks, that deletions are
849
677
        # properly paired, etc.
850
678
 
 
679
    def _delta(self, included, lines):
 
680
        """Return changes from basis to new revision.
 
681
 
 
682
        The old text for comparison is the union of included revisions.
 
683
 
 
684
        This is used in inserting a new text.
 
685
 
 
686
        Delta is returned as a sequence of
 
687
        (weave1, weave2, newlines).
 
688
 
 
689
        This indicates that weave1:weave2 of the old weave should be
 
690
        replaced by the sequence of lines in newlines.  Note that
 
691
        these line numbers are positions in the total weave and don't
 
692
        correspond to the lines in any extracted version, or even the
 
693
        extracted union of included versions.
 
694
 
 
695
        If line1=line2, this is a pure insert; if newlines=[] this is a
 
696
        pure delete.  (Similar to difflib.)
 
697
        """
 
698
        raise NotImplementedError()
 
699
 
 
700
            
 
701
    def plan_merge(self, ver_a, ver_b):
 
702
        """Return pseudo-annotation indicating how the two versions merge.
 
703
 
 
704
        This is computed between versions a and b and their common
 
705
        base.
 
706
 
 
707
        Weave lines present in none of them are skipped entirely.
 
708
        """
 
709
        inc_a = self.inclusions([ver_a])
 
710
        inc_b = self.inclusions([ver_b])
 
711
        inc_c = inc_a & inc_b
 
712
 
 
713
        for lineno, insert, deleteset, line in self._walk():
 
714
            if deleteset & inc_c:
 
715
                # killed in parent; can't be in either a or b
 
716
                # not relevant to our work
 
717
                yield 'killed-base', line
 
718
            elif insert in inc_c:
 
719
                # was inserted in base
 
720
                killed_a = bool(deleteset & inc_a)
 
721
                killed_b = bool(deleteset & inc_b)
 
722
                if killed_a and killed_b:
 
723
                    yield 'killed-both', line
 
724
                elif killed_a:
 
725
                    yield 'killed-a', line
 
726
                elif killed_b:
 
727
                    yield 'killed-b', line
 
728
                else:
 
729
                    yield 'unchanged', line
 
730
            elif insert in inc_a:
 
731
                if deleteset & inc_a:
 
732
                    yield 'ghost-a', line
 
733
                else:
 
734
                    # new in A; not in B
 
735
                    yield 'new-a', line
 
736
            elif insert in inc_b:
 
737
                if deleteset & inc_b:
 
738
                    yield 'ghost-b', line
 
739
                else:
 
740
                    yield 'new-b', line
 
741
            else:
 
742
                # not in either revision
 
743
                yield 'irrelevant', line
 
744
 
 
745
        yield 'unchanged', ''           # terminator
 
746
 
 
747
 
 
748
 
 
749
    def weave_merge(self, plan):
 
750
        lines_a = []
 
751
        lines_b = []
 
752
        ch_a = ch_b = False
 
753
        # TODO: Return a structured form of the conflicts (e.g. 2-tuples for
 
754
        # conflicted regions), rather than just inserting the markers.
 
755
        # 
 
756
        # TODO: Show some version information (e.g. author, date) on 
 
757
        # conflicted regions.
 
758
        for state, line in plan:
 
759
            if state == 'unchanged' or state == 'killed-both':
 
760
                # resync and flush queued conflicts changes if any
 
761
                if not lines_a and not lines_b:
 
762
                    pass
 
763
                elif ch_a and not ch_b:
 
764
                    # one-sided change:                    
 
765
                    for l in lines_a: yield l
 
766
                elif ch_b and not ch_a:
 
767
                    for l in lines_b: yield l
 
768
                elif lines_a == lines_b:
 
769
                    for l in lines_a: yield l
 
770
                else:
 
771
                    yield '<<<<<<<\n'
 
772
                    for l in lines_a: yield l
 
773
                    yield '=======\n'
 
774
                    for l in lines_b: yield l
 
775
                    yield '>>>>>>>\n'
 
776
 
 
777
                del lines_a[:]
 
778
                del lines_b[:]
 
779
                ch_a = ch_b = False
 
780
                
 
781
            if state == 'unchanged':
 
782
                if line:
 
783
                    yield line
 
784
            elif state == 'killed-a':
 
785
                ch_a = True
 
786
                lines_b.append(line)
 
787
            elif state == 'killed-b':
 
788
                ch_b = True
 
789
                lines_a.append(line)
 
790
            elif state == 'new-a':
 
791
                ch_a = True
 
792
                lines_a.append(line)
 
793
            elif state == 'new-b':
 
794
                ch_b = True
 
795
                lines_b.append(line)
 
796
            else:
 
797
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
 
798
                                 'killed-both'), \
 
799
                       state
 
800
 
 
801
 
 
802
    def join(self, other):
 
803
        import sys, time
 
804
        """Integrate versions from other into this weave.
 
805
 
 
806
        The resulting weave contains all the history of both weaves; 
 
807
        any version you could retrieve from either self or other can be 
 
808
        retrieved from self after this call.
 
809
 
 
810
        It is illegal for the two weaves to contain different values 
 
811
        or different parents for any version.  See also reweave().
 
812
        """
 
813
        if other.numversions() == 0:
 
814
            return          # nothing to update, easy
 
815
        # two loops so that we do not change ourselves before verifying it
 
816
        # will be ok
 
817
        # work through in index order to make sure we get all dependencies
 
818
        for other_idx, name in enumerate(other._names):
 
819
            self._check_version_consistent(other, other_idx, name)
 
820
 
 
821
        merged = 0
 
822
        processed = 0
 
823
        time0 = time.time( )
 
824
        for other_idx, name in enumerate(other._names):
 
825
            # TODO: If all the parents of the other version are already
 
826
            # present then we can avoid some work by just taking the delta
 
827
            # and adjusting the offsets.
 
828
            new_parents = self._imported_parents(other, other_idx)
 
829
            sha1 = other._sha1s[other_idx]
 
830
 
 
831
            processed += 1
 
832
           
 
833
            if name in self._names:
 
834
                idx = self.lookup(name)
 
835
                n1 = map(other.idx_to_name, other._parents[other_idx] )
 
836
                n2 = map(self.idx_to_name, self._parents[other_idx] )
 
837
                if sha1 ==  self._sha1s[idx] and n1 == n2:
 
838
                        continue
 
839
 
 
840
            merged += 1
 
841
            lines = other.get_lines(other_idx)
 
842
            self.add(name, new_parents, lines, sha1)
 
843
 
 
844
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
845
                merged,processed,self._weave_name, time.time( )-time0))
 
846
 
 
847
 
 
848
 
 
849
 
851
850
    def _imported_parents(self, other, other_idx):
852
851
        """Return list of parents in self corresponding to indexes in other."""
853
852
        new_parents = []
854
853
        for parent_idx in other._parents[other_idx]:
855
854
            parent_name = other._names[parent_idx]
856
 
            if parent_name not in self._name_map:
 
855
            if parent_name not in self._names:
857
856
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
857
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
858
                                 % (parent_name, other._name_map[other_idx], self))
860
859
            new_parents.append(self._name_map[parent_name])
861
860
        return new_parents
868
867
         * the same text
869
868
         * the same direct parents (by name, not index, and disregarding
870
869
           order)
871
 
 
 
870
        
872
871
        If present & correct return True;
873
 
        if not present in self return False;
 
872
        if not present in self return False; 
874
873
        if inconsistent raise error."""
875
874
        this_idx = self._name_map.get(name, -1)
876
875
        if this_idx != -1:
877
876
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
878
 
                raise errors.WeaveTextDiffers(name, self, other)
 
877
                raise WeaveError("inconsistent texts for version {%s} "
 
878
                                 "when joining weaves"
 
879
                                 % (name))
879
880
            self_parents = self._parents[this_idx]
880
881
            other_parents = other._parents[other_idx]
881
 
            n1 = set([self._names[i] for i in self_parents])
882
 
            n2 = set([other._names[i] for i in other_parents])
883
 
            if not self._compatible_parents(n1, n2):
 
882
            n1 = [self._names[i] for i in self_parents]
 
883
            n2 = [other._names[i] for i in other_parents]
 
884
            n1.sort()
 
885
            n2.sort()
 
886
            if n1 != n2:
884
887
                raise WeaveParentMismatch("inconsistent parents "
885
888
                    "for version {%s}: %s vs %s" % (name, n1, n2))
886
889
            else:
888
891
        else:
889
892
            return False
890
893
 
891
 
    def _reweave(self, other, pb, msg):
892
 
        """Reweave self with other - internal helper for join().
893
 
 
894
 
        :param other: The other weave to merge
895
 
        :param pb: An optional progress bar, indicating how far done we are
896
 
        :param msg: An optional message for the progress
897
 
        """
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."""
 
894
    def reweave(self, other):
 
895
        """Reweave self with other."""
 
896
        new_weave = reweave(self, other)
903
897
        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):
 
898
            setattr(self, attr, getattr(new_weave, attr))
 
899
 
 
900
 
 
901
def reweave(wa, wb):
973
902
    """Combine two weaves and return the result.
974
903
 
975
 
    This works even if a revision R has different parents in
 
904
    This works even if a revision R has different parents in 
976
905
    wa and wb.  In the resulting weave all the parents are given.
977
906
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
907
    This is done by just building up a new weave, maintaining ordering 
979
908
    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
 
909
    might be possible but it should only be necessary to do 
 
910
    this operation rarely, when a new previously ghost version is 
982
911
    inserted.
983
 
 
984
 
    :param pb: An optional progress bar, indicating how far done we are
985
 
    :param msg: An optional message for the progress
986
912
    """
987
913
    wr = Weave()
988
914
    ia = ib = 0
989
 
    queue_a = range(wa.num_versions())
990
 
    queue_b = range(wb.num_versions())
 
915
    queue_a = range(wa.numversions())
 
916
    queue_b = range(wb.numversions())
991
917
    # first determine combined parents of all versions
992
918
    # map from version name -> all parent names
993
919
    combined_parents = _reweave_parent_graphs(wa, wb)
994
920
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
921
    order = topo_sort(combined_parents.iteritems())
996
922
    mutter("order to reweave: %r", order)
997
 
 
998
 
    if pb and not msg:
999
 
        msg = 'reweave'
1000
 
 
1001
 
    for idx, name in enumerate(order):
1002
 
        if pb:
1003
 
            pb.update(msg, idx, len(order))
 
923
    for name in order:
1004
924
        if name in wa._name_map:
1005
925
            lines = wa.get_lines(name)
1006
926
            if name in wb._name_map:
1007
 
                lines_b = wb.get_lines(name)
1008
 
                if lines != lines_b:
1009
 
                    mutter('Weaves differ on content. rev_id {%s}', name)
1010
 
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
1011
 
                    import difflib
1012
 
                    lines = list(difflib.unified_diff(lines, lines_b,
1013
 
                            wa._weave_name, wb._weave_name))
1014
 
                    mutter('lines:\n%s', ''.join(lines))
1015
 
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
927
                assert lines == wb.get_lines(name)
1016
928
        else:
1017
929
            lines = wb.get_lines(name)
1018
 
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
930
        wr.add(name, combined_parents[name], lines)
1019
931
    return wr
1020
932
 
1021
933
 
1022
934
def _reweave_parent_graphs(wa, wb):
1023
935
    """Return combined parent ancestry for two weaves.
1024
 
 
 
936
    
1025
937
    Returned as a list of (version_name, set(parent_names))"""
1026
938
    combined = {}
1027
939
    for weave in [wa, wb]:
1028
940
        for idx, name in enumerate(weave._names):
1029
941
            p = combined.setdefault(name, set())
1030
 
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
942
            p.update(map(weave.idx_to_name, weave._parents[idx]))
1031
943
    return combined
 
944
 
 
945
 
 
946
def weave_toc(w):
 
947
    """Show the weave's table-of-contents"""
 
948
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
949
    for i in (6, 50, 10, 10):
 
950
        print '-' * i,
 
951
    print
 
952
    for i in range(w.numversions()):
 
953
        sha1 = w._sha1s[i]
 
954
        name = w._names[i]
 
955
        parent_str = ' '.join(map(str, w._parents[i]))
 
956
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
957
 
 
958
 
 
959
 
 
960
def weave_stats(weave_file, pb):
 
961
    from bzrlib.weavefile import read_weave
 
962
 
 
963
    wf = file(weave_file, 'rb')
 
964
    w = read_weave(wf)
 
965
    # FIXME: doesn't work on pipes
 
966
    weave_size = wf.tell()
 
967
 
 
968
    total = 0
 
969
    vers = len(w)
 
970
    for i in range(vers):
 
971
        pb.update('checking sizes', i, vers)
 
972
        for origin, lineno, line in w._extract([i]):
 
973
            total += len(line)
 
974
 
 
975
    pb.clear()
 
976
 
 
977
    print 'versions          %9d' % vers
 
978
    print 'weave file        %9d bytes' % weave_size
 
979
    print 'total contents    %9d bytes' % total
 
980
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
981
    if vers:
 
982
        avg = total/vers
 
983
        print 'average size      %9d bytes' % avg
 
984
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
985
 
 
986
 
 
987
def usage():
 
988
    print """bzr weave tool
 
989
 
 
990
Experimental tool for weave algorithm.
 
991
 
 
992
usage:
 
993
    weave init WEAVEFILE
 
994
        Create an empty weave file
 
995
    weave get WEAVEFILE VERSION
 
996
        Write out specified version.
 
997
    weave check WEAVEFILE
 
998
        Check consistency of all versions.
 
999
    weave toc WEAVEFILE
 
1000
        Display table of contents.
 
1001
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1002
        Add NEWTEXT, with specified parent versions.
 
1003
    weave annotate WEAVEFILE VERSION
 
1004
        Display origin of each line.
 
1005
    weave mash WEAVEFILE VERSION...
 
1006
        Display composite of all selected versions.
 
1007
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1008
        Auto-merge two versions and display conflicts.
 
1009
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1010
        Show differences between two versions.
 
1011
 
 
1012
example:
 
1013
 
 
1014
    % weave init foo.weave
 
1015
    % vi foo.txt
 
1016
    % weave add foo.weave ver0 < foo.txt
 
1017
    added version 0
 
1018
 
 
1019
    (create updated version)
 
1020
    % vi foo.txt
 
1021
    % weave get foo.weave 0 | diff -u - foo.txt
 
1022
    % weave add foo.weave ver1 0 < foo.txt
 
1023
    added version 1
 
1024
 
 
1025
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1026
    % vi foo.txt
 
1027
    % weave add foo.weave ver2 0 < foo.txt
 
1028
    added version 2
 
1029
 
 
1030
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1031
    % vi foo.txt                            (resolve conflicts)
 
1032
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1033
    
 
1034
"""
 
1035
    
 
1036
 
 
1037
 
 
1038
def main(argv):
 
1039
    import sys
 
1040
    import os
 
1041
    try:
 
1042
        import bzrlib
 
1043
    except ImportError:
 
1044
        # in case we're run directly from the subdirectory
 
1045
        sys.path.append('..')
 
1046
        import bzrlib
 
1047
    from bzrlib.weavefile import write_weave, read_weave
 
1048
    from bzrlib.progress import ProgressBar
 
1049
 
 
1050
    try:
 
1051
        import psyco
 
1052
        psyco.full()
 
1053
    except ImportError:
 
1054
        pass
 
1055
 
 
1056
    if len(argv) < 2:
 
1057
        usage()
 
1058
        return 0
 
1059
 
 
1060
    cmd = argv[1]
 
1061
 
 
1062
    def readit():
 
1063
        return read_weave(file(argv[2], 'rb'))
 
1064
    
 
1065
    if cmd == 'help':
 
1066
        usage()
 
1067
    elif cmd == 'add':
 
1068
        w = readit()
 
1069
        # at the moment, based on everything in the file
 
1070
        name = argv[3]
 
1071
        parents = map(int, argv[4:])
 
1072
        lines = sys.stdin.readlines()
 
1073
        ver = w.add(name, parents, lines)
 
1074
        write_weave(w, file(argv[2], 'wb'))
 
1075
        print 'added version %r %d' % (name, ver)
 
1076
    elif cmd == 'init':
 
1077
        fn = argv[2]
 
1078
        if os.path.exists(fn):
 
1079
            raise IOError("file exists")
 
1080
        w = Weave()
 
1081
        write_weave(w, file(fn, 'wb'))
 
1082
    elif cmd == 'get': # get one version
 
1083
        w = readit()
 
1084
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1085
        
 
1086
    elif cmd == 'mash': # get composite
 
1087
        w = readit()
 
1088
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
1089
 
 
1090
    elif cmd == 'diff':
 
1091
        from difflib import unified_diff
 
1092
        w = readit()
 
1093
        fn = argv[2]
 
1094
        v1, v2 = map(int, argv[3:5])
 
1095
        lines1 = w.get(v1)
 
1096
        lines2 = w.get(v2)
 
1097
        diff_gen = unified_diff(lines1, lines2,
 
1098
                                '%s version %d' % (fn, v1),
 
1099
                                '%s version %d' % (fn, v2))
 
1100
        sys.stdout.writelines(diff_gen)
 
1101
            
 
1102
    elif cmd == 'annotate':
 
1103
        w = readit()
 
1104
        # newline is added to all lines regardless; too hard to get
 
1105
        # reasonable formatting otherwise
 
1106
        lasto = None
 
1107
        for origin, text in w.annotate(int(argv[3])):
 
1108
            text = text.rstrip('\r\n')
 
1109
            if origin == lasto:
 
1110
                print '      | %s' % (text)
 
1111
            else:
 
1112
                print '%5d | %s' % (origin, text)
 
1113
                lasto = origin
 
1114
                
 
1115
    elif cmd == 'toc':
 
1116
        weave_toc(readit())
 
1117
 
 
1118
    elif cmd == 'stats':
 
1119
        weave_stats(argv[2], ProgressBar())
 
1120
        
 
1121
    elif cmd == 'check':
 
1122
        w = readit()
 
1123
        pb = ProgressBar()
 
1124
        w.check(pb)
 
1125
        pb.clear()
 
1126
        print '%d versions ok' % w.numversions()
 
1127
 
 
1128
    elif cmd == 'inclusions':
 
1129
        w = readit()
 
1130
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1131
 
 
1132
    elif cmd == 'parents':
 
1133
        w = readit()
 
1134
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1135
 
 
1136
    elif cmd == 'plan-merge':
 
1137
        w = readit()
 
1138
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1139
            if line:
 
1140
                print '%14s | %s' % (state, line),
 
1141
 
 
1142
    elif cmd == 'merge':
 
1143
        w = readit()
 
1144
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1145
        sys.stdout.writelines(w.weave_merge(p))
 
1146
            
 
1147
    elif cmd == 'mash-merge':
 
1148
        if len(argv) != 5:
 
1149
            usage()
 
1150
            return 1
 
1151
 
 
1152
        w = readit()
 
1153
        v1, v2 = map(int, argv[3:5])
 
1154
 
 
1155
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
 
1156
 
 
1157
        base_lines = list(w.mash_iter(basis))
 
1158
        a_lines = list(w.get(v1))
 
1159
        b_lines = list(w.get(v2))
 
1160
 
 
1161
        from bzrlib.merge3 import Merge3
 
1162
        m3 = Merge3(base_lines, a_lines, b_lines)
 
1163
 
 
1164
        name_a = 'version %d' % v1
 
1165
        name_b = 'version %d' % v2
 
1166
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
 
1167
    else:
 
1168
        raise ValueError('unknown command %r' % cmd)
 
1169
    
 
1170
 
 
1171
 
 
1172
def profile_main(argv): 
 
1173
    import tempfile, hotshot, hotshot.stats
 
1174
 
 
1175
    prof_f = tempfile.NamedTemporaryFile()
 
1176
 
 
1177
    prof = hotshot.Profile(prof_f.name)
 
1178
 
 
1179
    ret = prof.runcall(main, argv)
 
1180
    prof.close()
 
1181
 
 
1182
    stats = hotshot.stats.load(prof_f.name)
 
1183
    #stats.strip_dirs()
 
1184
    stats.sort_stats('cumulative')
 
1185
    ## XXX: Might like to write to stderr or the trace file instead but
 
1186
    ## print_stats seems hardcoded to stdout
 
1187
    stats.print_stats(20)
 
1188
            
 
1189
    return ret
 
1190
 
 
1191
 
 
1192
def lsprofile_main(argv): 
 
1193
    from bzrlib.lsprof import profile
 
1194
    ret,stats = profile(main, argv)
 
1195
    stats.sort()
 
1196
    stats.pprint()
 
1197
    return ret
 
1198
 
 
1199
 
 
1200
if __name__ == '__main__':
 
1201
    import sys
 
1202
    if '--profile' in sys.argv:
 
1203
        args = sys.argv[:]
 
1204
        args.remove('--profile')
 
1205
        sys.exit(profile_main(args))
 
1206
    elif '--lsprof' in sys.argv:
 
1207
        args = sys.argv[:]
 
1208
        args.remove('--lsprof')
 
1209
        sys.exit(lsprofile_main(args))
 
1210
    else:
 
1211
        sys.exit(main(sys.argv))
 
1212