/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

Added set_remove to get the set delete function to IntSet

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