~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2005-10-04 10:10:48 UTC
  • mto: (1185.13.3)
  • mto: This revision was merged to the branch mainline in revision 1403.
  • Revision ID: mbp@sourcefrog.net-20051004101047-bd75d2b341134eff
- capture_tree tool to help in preparing test cases

- capture_tree code should cope with directories containing fifos, etc

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
 
20
22
"""Weave - storage of related text file versions"""
21
23
 
22
24
 
 
25
# TODO: Perhaps have copy method for Weave instances?
 
26
 
23
27
# XXX: If we do weaves this way, will a merge still behave the same
24
28
# way if it's done in a different order?  That's a pretty desirable
25
29
# property.
26
30
 
27
31
# 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
 
32
# rather than being split up in some other way.  We could accomodate
29
33
# binaries, perhaps by naively splitting on \n or perhaps using
30
34
# something like a rolling checksum.
31
35
 
48
52
# have slight specializations for different ways its used: annotate,
49
53
# basis for add, get, etc.
50
54
 
51
 
# TODO: Probably the API should work only in names to hide the integer
52
 
# indexes from the user.
 
55
# TODO: Perhaps the API should work only in names to hide the integer
 
56
# indexes from the user?
53
57
 
54
58
# TODO: Is there any potential performance win by having an add()
55
59
# variant that is passed a pre-cooked version of the single basis
56
60
# version?
57
61
 
58
 
# TODO: Reweave can possibly be made faster by remembering diffs
59
 
# where the basis and destination are unchanged.
60
 
 
61
 
# 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
 
# be done fairly efficiently because the sequence numbers constrain
65
 
# the possible relationships.
66
 
 
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
 
    )
81
 
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):
 
62
 
 
63
 
 
64
import sha
 
65
from difflib import SequenceMatcher
 
66
 
 
67
 
 
68
 
 
69
 
 
70
class WeaveError(Exception):
 
71
    """Exception in processing weave"""
 
72
 
 
73
 
 
74
class WeaveFormatError(WeaveError):
 
75
    """Weave invariant violated"""
 
76
    
 
77
 
 
78
class Weave(object):
127
79
    """weave - versioned text file storage.
128
 
 
 
80
    
129
81
    A Weave manages versions of line-based text files, keeping track
130
82
    of the originating version for each line.
131
83
 
177
129
 
178
130
    * It doesn't seem very useful to have an active insertion
179
131
      inside an inactive insertion, but it might happen.
180
 
 
 
132
      
181
133
    * Therefore, all instructions are always"considered"; that
182
134
      is passed onto and off the stack.  An outer inactive block
183
135
      doesn't disable an inner block.
213
165
    """
214
166
 
215
167
    __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__()
 
168
                 '_weave_name']
 
169
    
 
170
    def __init__(self, weave_name=None):
227
171
        self._weave = []
228
172
        self._parents = []
229
173
        self._sha1s = []
230
174
        self._names = []
231
175
        self._name_map = {}
232
176
        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
 
 
244
 
    def __repr__(self):
245
 
        return "Weave(%r)" % self._weave_name
246
 
 
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
 
 
254
 
    def copy(self):
255
 
        """Return a deep copy of self.
256
 
 
257
 
        The copy can be modified without affecting the original weave."""
258
 
        other = Weave()
259
 
        other._weave = self._weave[:]
260
 
        other._parents = self._parents[:]
261
 
        other._sha1s = self._sha1s[:]
262
 
        other._names = self._names[:]
263
 
        other._name_map = self._name_map.copy()
264
 
        other._weave_name = self._weave_name
265
 
        return other
 
177
 
266
178
 
267
179
    def __eq__(self, other):
268
180
        if not isinstance(other, Weave):
269
181
            return False
270
182
        return self._parents == other._parents \
271
183
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
 
184
               and self._sha1s == other._sha1s 
273
185
 
 
186
    
274
187
    def __ne__(self, other):
275
188
        return not self.__eq__(other)
276
189
 
277
 
    def _idx_to_name(self, version):
278
 
        return self._names[version]
279
 
 
280
 
    def _lookup(self, name):
 
190
 
 
191
    def maybe_lookup(self, name_or_index):
 
192
        """Convert possible symbolic name to index, or pass through indexes."""
 
193
        if isinstance(name_or_index, (int, long)):
 
194
            return name_or_index
 
195
        else:
 
196
            return self.lookup(name_or_index)
 
197
 
 
198
        
 
199
    def lookup(self, name):
281
200
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
284
201
        try:
285
202
            return self._name_map[name]
286
203
        except KeyError:
287
 
            raise RevisionNotPresent(name, self._weave_name)
288
 
 
289
 
    def versions(self):
290
 
        """See VersionedFile.versions."""
291
 
        return self._names[:]
292
 
 
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
 
204
            raise WeaveError("name %r not present in weave %r" %
 
205
                             (name, self._weave_name))
 
206
 
 
207
 
 
208
    def idx_to_name(self, version):
 
209
        return self._names[version]
 
210
 
379
211
 
380
212
    def _check_repeated_add(self, name, parents, text, sha1):
381
213
        """Check that a duplicated add is OK.
382
214
 
383
215
        If it is, return the (old) index; otherwise raise an exception.
384
216
        """
385
 
        idx = self._lookup(name)
386
 
        if sorted(self._parents[idx]) != sorted(parents) \
387
 
            or sha1 != self._sha1s[idx]:
388
 
            raise RevisionAlreadyPresent(name, self._weave_name)
 
217
        idx = self.lookup(name)
 
218
        if sorted(self._parents[idx]) != sorted(parents):
 
219
            raise WeaveError("name \"%s\" already present in weave "
 
220
                             "with different parents" % name)
 
221
        if sha1 != self._sha1s[idx]:
 
222
            raise WeaveError("name \"%s\" already present in weave "
 
223
                             "with different text" % name)            
389
224
        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):
 
225
        
 
226
 
 
227
        
 
228
    def add(self, name, parents, text, sha1=None):
399
229
        """Add a single text on top of the weave.
400
 
 
 
230
  
401
231
        Returns the index number of the newly added version.
402
232
 
403
 
        version_id
 
233
        name
404
234
            Symbolic name for this version.
405
235
            (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
236
 
408
237
        parents
409
238
            List or set of direct parent version numbers.
410
 
 
411
 
        lines
 
239
            
 
240
        text
412
241
            Sequence of lines to be added in the new version.
413
242
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
 
243
        sha -- SHA-1 of the file, if known.  This is trusted to be
 
244
            correct if supplied.
415
245
        """
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
 
 
 
246
        from bzrlib.osutils import sha_strings
 
247
 
 
248
        assert isinstance(name, basestring)
 
249
        if sha1 is None:
 
250
            sha1 = sha_strings(text)
 
251
        if name in self._name_map:
 
252
            return self._check_repeated_add(name, parents, text, sha1)
 
253
 
 
254
        parents = map(self.maybe_lookup, parents)
427
255
        self._check_versions(parents)
428
 
        ## self._check_lines(lines)
 
256
        ## self._check_lines(text)
429
257
        new_version = len(self._parents)
430
258
 
 
259
 
431
260
        # if we abort after here the (in-memory) weave will be corrupt because only
432
261
        # some fields are updated
433
 
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
434
 
        #      - Robert Collins 20060226
435
262
        self._parents.append(parents[:])
436
263
        self._sha1s.append(sha1)
437
 
        self._names.append(version_id)
438
 
        self._name_map[version_id] = new_version
439
 
 
440
 
 
 
264
        self._names.append(name)
 
265
        self._name_map[name] = new_version
 
266
 
 
267
            
441
268
        if not parents:
442
269
            # special case; adding with no parents revision; can do
443
270
            # this more quickly by just appending unconditionally.
444
271
            # even more specially, if we're adding an empty text we
445
272
            # need do nothing at all.
446
 
            if lines:
 
273
            if text:
447
274
                self._weave.append(('{', new_version))
448
 
                self._weave.extend(lines)
 
275
                self._weave.extend(text)
449
276
                self._weave.append(('}', None))
 
277
        
450
278
            return new_version
451
279
 
452
280
        if len(parents) == 1:
454
282
            if sha1 == self._sha1s[pv]:
455
283
                # special case: same as the single parent
456
284
                return new_version
457
 
 
458
 
 
459
 
        ancestors = self._inclusions(parents)
 
285
            
 
286
 
 
287
        ancestors = self.inclusions(parents)
460
288
 
461
289
        l = self._weave
462
290
 
469
297
 
470
298
        # another small special case: a merge, producing the same text
471
299
        # as auto-merge
472
 
        if lines == basis_lines:
473
 
            return new_version
 
300
        if text == basis_lines:
 
301
            return new_version            
474
302
 
475
 
        # add a sentinel, because we can also match against the final line
 
303
        # add a sentinal, because we can also match against the final line
476
304
        basis_lineno.append(len(self._weave))
477
305
 
478
306
        # XXX: which line of the weave should we really consider
482
310
        #print 'basis_lines:', basis_lines
483
311
        #print 'new_lines:  ', lines
484
312
 
485
 
        s = self._matcher(None, basis_lines, lines)
 
313
        s = SequenceMatcher(None, basis_lines, text)
486
314
 
487
315
        # offset gives the number of lines that have been inserted
488
316
        # into the weave up to the current point; if the original edit instruction
495
323
            #print 'raw match', tag, i1, i2, j1, j2
496
324
            if tag == 'equal':
497
325
                continue
 
326
 
498
327
            i1 = basis_lineno[i1]
499
328
            i2 = basis_lineno[i2]
 
329
 
 
330
            assert 0 <= j1 <= j2 <= len(text)
 
331
 
 
332
            #print tag, i1, i2, j1, j2
 
333
 
500
334
            # the deletion and insertion are handled separately.
501
335
            # first delete the region.
502
336
            if i1 != i2:
509
343
                # i2; we want to insert after this region to make sure
510
344
                # we don't destroy ourselves
511
345
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
346
                self._weave[i:i] = ([('{', new_version)] 
 
347
                                    + text[j1:j2] 
514
348
                                    + [('}', None)])
515
349
                offset += 2 + (j2 - j1)
 
350
 
516
351
        return new_version
517
352
 
518
 
    def _inclusions(self, versions):
 
353
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
354
        """Add an identical text to old_rev_id as new_rev_id."""
 
355
        old_lines = self.get(self.lookup(old_rev_id))
 
356
        self.add(new_rev_id, parents, old_lines)
 
357
 
 
358
    def inclusions(self, versions):
519
359
        """Return set of all ancestors of given version(s)."""
520
 
        if not len(versions):
521
 
            return []
522
360
        i = set(versions)
523
361
        for v in xrange(max(versions), 0, -1):
524
362
            if v in i:
528
366
        ## except IndexError:
529
367
        ##     raise ValueError("version %d not present in weave" % v)
530
368
 
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]
 
369
 
 
370
    def parents(self, version):
 
371
        return self._parents[version]
 
372
 
 
373
 
 
374
    def minimal_parents(self, version):
 
375
        """Find the minimal set of parents for the version."""
 
376
        included = self._parents[version]
 
377
        if not included:
 
378
            return []
 
379
        
 
380
        li = list(included)
 
381
        li.sort(reverse=True)
 
382
 
 
383
        mininc = []
 
384
        gotit = set()
 
385
 
 
386
        for pv in li:
 
387
            if pv not in gotit:
 
388
                mininc.append(pv)
 
389
                gotit.update(self.inclusions(pv))
 
390
 
 
391
        assert mininc[0] >= 0
 
392
        assert mininc[-1] < version
 
393
        return mininc
 
394
 
 
395
 
537
396
 
538
397
    def _check_lines(self, text):
539
398
        if not isinstance(text, list):
543
402
            if not isinstance(l, basestring):
544
403
                raise ValueError("text line should be a string or unicode, not %s"
545
404
                                 % type(l))
546
 
 
 
405
        
547
406
 
548
407
 
549
408
    def _check_versions(self, indexes):
554
413
            except IndexError:
555
414
                raise IndexError("invalid version number %r" % i)
556
415
 
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.
 
416
    
 
417
    def annotate(self, name_or_index):
 
418
        return list(self.annotate_iter(name_or_index))
 
419
 
 
420
 
 
421
    def annotate_iter(self, name_or_index):
 
422
        """Yield list of (index-id, line) pairs for the specified version.
567
423
 
568
424
        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
 
 
 
425
        incls = [self.maybe_lookup(name_or_index)]
 
426
        for origin, lineno, text in self._extract(incls):
 
427
            yield origin, text
 
428
 
 
429
 
 
430
    def _walk(self):
 
431
        """Walk the weave.
 
432
 
 
433
        Yields sequence of
 
434
        (lineno, insert, deletes, text)
 
435
        for each literal line.
 
436
        """
 
437
        
589
438
        istack = []
590
439
        dset = set()
591
440
 
592
441
        lineno = 0         # line of weave, 0-based
593
442
 
594
443
        for l in self._weave:
595
 
            if l.__class__ == tuple:
 
444
            if isinstance(l, tuple):
596
445
                c, v = l
597
446
                isactive = None
598
447
                if c == '{':
599
 
                    istack.append(self._names[v])
 
448
                    istack.append(v)
600
449
                elif c == '}':
601
450
                    istack.pop()
602
451
                elif c == '[':
603
 
                    dset.add(self._names[v])
 
452
                    assert v not in dset
 
453
                    dset.add(v)
604
454
                elif c == ']':
605
 
                    dset.remove(self._names[v])
606
 
                else:
607
 
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
 
            else:
609
 
                yield lineno, istack[-1], frozenset(dset), l
 
455
                    dset.remove(v)
 
456
                else:
 
457
                    raise WeaveFormatError('unexpected instruction %r'
 
458
                                           % v)
 
459
            else:
 
460
                assert isinstance(l, basestring)
 
461
                assert istack
 
462
                yield lineno, istack[-1], dset, l
 
463
            lineno += 1
 
464
 
 
465
 
 
466
 
 
467
    def _extract(self, versions):
 
468
        """Yield annotation of lines in included set.
 
469
 
 
470
        Yields a sequence of tuples (origin, lineno, text), where
 
471
        origin is the origin version, lineno the index in the weave,
 
472
        and text the text of the line.
 
473
 
 
474
        The set typically but not necessarily corresponds to a version.
 
475
        """
 
476
        for i in versions:
 
477
            if not isinstance(i, int):
 
478
                raise ValueError(i)
 
479
            
 
480
        included = self.inclusions(versions)
 
481
 
 
482
        istack = []
 
483
        dset = set()
 
484
 
 
485
        lineno = 0         # line of weave, 0-based
 
486
 
 
487
        isactive = None
 
488
 
 
489
        result = []
 
490
 
 
491
        WFE = WeaveFormatError
 
492
 
 
493
        for l in self._weave:
 
494
            if isinstance(l, tuple):
 
495
                c, v = l
 
496
                isactive = None
 
497
                if c == '{':
 
498
                    assert v not in istack
 
499
                    istack.append(v)
 
500
                elif c == '}':
 
501
                    istack.pop()
 
502
                elif c == '[':
 
503
                    if v in included:
 
504
                        assert v not in dset
 
505
                        dset.add(v)
 
506
                else:
 
507
                    assert c == ']'
 
508
                    if v in included:
 
509
                        assert v in dset
 
510
                        dset.remove(v)
 
511
            else:
 
512
                assert isinstance(l, basestring)
 
513
                if isactive is None:
 
514
                    isactive = (not dset) and istack and (istack[-1] in included)
 
515
                if isactive:
 
516
                    result.append((istack[-1], lineno, l))
610
517
            lineno += 1
611
518
 
612
519
        if istack:
613
 
            raise WeaveFormatError("unclosed insertion blocks "
614
 
                    "at end of weave: %s" % istack)
 
520
            raise WFE("unclosed insertion blocks at end of weave",
 
521
                                   istack)
615
522
        if dset:
616
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
617
 
                                   % dset)
618
 
 
 
523
            raise WFE("unclosed deletion blocks at end of weave",
 
524
                                   dset)
 
525
 
 
526
        return result
 
527
    
 
528
 
 
529
 
 
530
    def get_iter(self, name_or_index):
 
531
        """Yield lines for the specified version."""
 
532
        incls = [self.maybe_lookup(name_or_index)]
 
533
        for origin, lineno, line in self._extract(incls):
 
534
            yield line
 
535
 
 
536
 
 
537
    def get_text(self, name_or_index):
 
538
        return ''.join(self.get_iter(name_or_index))
 
539
        assert isinstance(version, int)
 
540
 
 
541
 
 
542
    def get_lines(self, name_or_index):
 
543
        return list(self.get_iter(name_or_index))
 
544
 
 
545
 
 
546
    get = get_lines
 
547
 
 
548
 
 
549
    def mash_iter(self, included):
 
550
        """Return composed version of multiple included versions."""
 
551
        included = map(self.maybe_lookup, included)
 
552
        for origin, lineno, text in self._extract(included):
 
553
            yield text
 
554
 
 
555
 
 
556
    def dump(self, to_file):
 
557
        from pprint import pprint
 
558
        print >>to_file, "Weave._weave = ",
 
559
        pprint(self._weave, to_file)
 
560
        print >>to_file, "Weave._parents = ",
 
561
        pprint(self._parents, to_file)
 
562
 
 
563
 
 
564
 
 
565
    def numversions(self):
 
566
        l = len(self._parents)
 
567
        assert l == len(self._sha1s)
 
568
        return l
 
569
 
 
570
 
 
571
    def __len__(self):
 
572
        return self.numversions()
 
573
 
 
574
 
 
575
    def check(self, progress_bar=None):
 
576
        # check no circular inclusions
 
577
        for version in range(self.numversions()):
 
578
            inclusions = list(self._parents[version])
 
579
            if inclusions:
 
580
                inclusions.sort()
 
581
                if inclusions[-1] >= version:
 
582
                    raise WeaveFormatError("invalid included version %d for index %d"
 
583
                                           % (inclusions[-1], version))
 
584
 
 
585
        # try extracting all versions; this is a bit slow and parallel
 
586
        # extraction could be used
 
587
        nv = self.numversions()
 
588
        for version in range(nv):
 
589
            if progress_bar:
 
590
                progress_bar.update('checking text', version, nv)
 
591
            s = sha.new()
 
592
            for l in self.get_iter(version):
 
593
                s.update(l)
 
594
            hd = s.hexdigest()
 
595
            expected = self._sha1s[version]
 
596
            if hd != expected:
 
597
                raise WeaveError("mismatched sha1 for version %d; "
 
598
                                 "got %s, expected %s"
 
599
                                 % (version, hd, expected))
 
600
 
 
601
        # TODO: check insertions are properly nested, that there are
 
602
        # no lines outside of insertion blocks, that deletions are
 
603
        # properly paired, etc.
 
604
 
 
605
 
 
606
 
 
607
    def merge(self, merge_versions):
 
608
        """Automerge and mark conflicts between versions.
 
609
 
 
610
        This returns a sequence, each entry describing alternatives
 
611
        for a chunk of the file.  Each of the alternatives is given as
 
612
        a list of lines.
 
613
 
 
614
        If there is a chunk of the file where there's no diagreement,
 
615
        only one alternative is given.
 
616
        """
 
617
 
 
618
        # approach: find the included versions common to all the
 
619
        # merged versions
 
620
        raise NotImplementedError()
 
621
 
 
622
 
 
623
 
 
624
    def _delta(self, included, lines):
 
625
        """Return changes from basis to new revision.
 
626
 
 
627
        The old text for comparison is the union of included revisions.
 
628
 
 
629
        This is used in inserting a new text.
 
630
 
 
631
        Delta is returned as a sequence of
 
632
        (weave1, weave2, newlines).
 
633
 
 
634
        This indicates that weave1:weave2 of the old weave should be
 
635
        replaced by the sequence of lines in newlines.  Note that
 
636
        these line numbers are positions in the total weave and don't
 
637
        correspond to the lines in any extracted version, or even the
 
638
        extracted union of included versions.
 
639
 
 
640
        If line1=line2, this is a pure insert; if newlines=[] this is a
 
641
        pure delete.  (Similar to difflib.)
 
642
        """
 
643
 
 
644
 
 
645
            
619
646
    def plan_merge(self, ver_a, ver_b):
620
647
        """Return pseudo-annotation indicating how the two versions merge.
621
648
 
624
651
 
625
652
        Weave lines present in none of them are skipped entirely.
626
653
        """
627
 
        inc_a = set(self.get_ancestry([ver_a]))
628
 
        inc_b = set(self.get_ancestry([ver_b]))
 
654
        inc_a = self.inclusions([ver_a])
 
655
        inc_b = self.inclusions([ver_b])
629
656
        inc_c = inc_a & inc_b
630
657
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
658
        for lineno, insert, deleteset, line in self._walk():
632
659
            if deleteset & inc_c:
633
660
                # killed in parent; can't be in either a or b
634
661
                # not relevant to our work
660
687
                # not in either revision
661
688
                yield 'irrelevant', line
662
689
 
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)
 
690
        yield 'unchanged', ''           # terminator
 
691
 
 
692
 
 
693
 
 
694
    def weave_merge(self, plan):
 
695
        lines_a = []
 
696
        lines_b = []
 
697
        ch_a = ch_b = False
 
698
 
 
699
        for state, line in plan:
 
700
            if state == 'unchanged' or state == 'killed-both':
 
701
                # resync and flush queued conflicts changes if any
 
702
                if not lines_a and not lines_b:
 
703
                    pass
 
704
                elif ch_a and not ch_b:
 
705
                    # one-sided change:                    
 
706
                    for l in lines_a: yield l
 
707
                elif ch_b and not ch_a:
 
708
                    for l in lines_b: yield l
 
709
                elif lines_a == lines_b:
 
710
                    for l in lines_a: yield l
732
711
                else:
733
 
                    raise AssertionError()
734
 
            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.
752
 
        """
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
 
 
851
 
    def _imported_parents(self, other, other_idx):
852
 
        """Return list of parents in self corresponding to indexes in other."""
853
 
        new_parents = []
854
 
        for parent_idx in other._parents[other_idx]:
855
 
            parent_name = other._names[parent_idx]
856
 
            if parent_name not in self._name_map:
857
 
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
859
 
                                 % (parent_name, other._name_map[other_idx], self))
860
 
            new_parents.append(self._name_map[parent_name])
861
 
        return new_parents
862
 
 
863
 
    def _check_version_consistent(self, other, other_idx, name):
864
 
        """Check if a version in consistent in this and other.
865
 
 
866
 
        To be consistent it must have:
867
 
 
868
 
         * the same text
869
 
         * the same direct parents (by name, not index, and disregarding
870
 
           order)
871
 
 
872
 
        If present & correct return True;
873
 
        if not present in self return False;
874
 
        if inconsistent raise error."""
875
 
        this_idx = self._name_map.get(name, -1)
876
 
        if this_idx != -1:
877
 
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
878
 
                raise errors.WeaveTextDiffers(name, self, other)
879
 
            self_parents = self._parents[this_idx]
880
 
            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):
884
 
                raise WeaveParentMismatch("inconsistent parents "
885
 
                    "for version {%s}: %s vs %s" % (name, n1, n2))
886
 
            else:
887
 
                return True         # ok!
888
 
        else:
889
 
            return False
890
 
 
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."""
903
 
        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):
973
 
    """Combine two weaves and return the result.
974
 
 
975
 
    This works even if a revision R has different parents in
976
 
    wa and wb.  In the resulting weave all the parents are given.
977
 
 
978
 
    This is done by just building up a new weave, maintaining ordering
979
 
    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
982
 
    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
 
    """
987
 
    wr = Weave()
988
 
    ia = ib = 0
989
 
    queue_a = range(wa.num_versions())
990
 
    queue_b = range(wb.num_versions())
991
 
    # first determine combined parents of all versions
992
 
    # map from version name -> all parent names
993
 
    combined_parents = _reweave_parent_graphs(wa, wb)
994
 
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
996
 
    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))
1004
 
        if name in wa._name_map:
1005
 
            lines = wa.get_lines(name)
1006
 
            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)
1016
 
        else:
1017
 
            lines = wb.get_lines(name)
1018
 
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
 
    return wr
1020
 
 
1021
 
 
1022
 
def _reweave_parent_graphs(wa, wb):
1023
 
    """Return combined parent ancestry for two weaves.
1024
 
 
1025
 
    Returned as a list of (version_name, set(parent_names))"""
1026
 
    combined = {}
1027
 
    for weave in [wa, wb]:
1028
 
        for idx, name in enumerate(weave._names):
1029
 
            p = combined.setdefault(name, set())
1030
 
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
 
    return combined
 
712
                    yield '<<<<\n'
 
713
                    for l in lines_a: yield l
 
714
                    yield '====\n'
 
715
                    for l in lines_b: yield l
 
716
                    yield '>>>>\n'
 
717
 
 
718
                del lines_a[:]
 
719
                del lines_b[:]
 
720
                ch_a = ch_b = False
 
721
                
 
722
            if state == 'unchanged':
 
723
                if line:
 
724
                    yield line
 
725
            elif state == 'killed-a':
 
726
                ch_a = True
 
727
                lines_b.append(line)
 
728
            elif state == 'killed-b':
 
729
                ch_b = True
 
730
                lines_a.append(line)
 
731
            elif state == 'new-a':
 
732
                ch_a = True
 
733
                lines_a.append(line)
 
734
            elif state == 'new-b':
 
735
                ch_b = True
 
736
                lines_b.append(line)
 
737
            else:
 
738
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
 
739
                                 'killed-both'), \
 
740
                       state
 
741
 
 
742
                
 
743
 
 
744
 
 
745
 
 
746
 
 
747
 
 
748
def weave_toc(w):
 
749
    """Show the weave's table-of-contents"""
 
750
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
751
    for i in (6, 50, 10, 10):
 
752
        print '-' * i,
 
753
    print
 
754
    for i in range(w.numversions()):
 
755
        sha1 = w._sha1s[i]
 
756
        name = w._names[i]
 
757
        parent_str = ' '.join(map(str, w._parents[i]))
 
758
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
759
 
 
760
 
 
761
 
 
762
def weave_stats(weave_file, pb):
 
763
    from bzrlib.weavefile import read_weave
 
764
 
 
765
    wf = file(weave_file, 'rb')
 
766
    w = read_weave(wf)
 
767
    # FIXME: doesn't work on pipes
 
768
    weave_size = wf.tell()
 
769
 
 
770
    total = 0
 
771
    vers = len(w)
 
772
    for i in range(vers):
 
773
        pb.update('checking sizes', i, vers)
 
774
        for origin, lineno, line in w._extract([i]):
 
775
            total += len(line)
 
776
 
 
777
    pb.clear()
 
778
 
 
779
    print 'versions          %9d' % vers
 
780
    print 'weave file        %9d bytes' % weave_size
 
781
    print 'total contents    %9d bytes' % total
 
782
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
783
    if vers:
 
784
        avg = total/vers
 
785
        print 'average size      %9d bytes' % avg
 
786
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
787
 
 
788
 
 
789
def usage():
 
790
    print """bzr weave tool
 
791
 
 
792
Experimental tool for weave algorithm.
 
793
 
 
794
usage:
 
795
    weave init WEAVEFILE
 
796
        Create an empty weave file
 
797
    weave get WEAVEFILE VERSION
 
798
        Write out specified version.
 
799
    weave check WEAVEFILE
 
800
        Check consistency of all versions.
 
801
    weave toc WEAVEFILE
 
802
        Display table of contents.
 
803
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
804
        Add NEWTEXT, with specified parent versions.
 
805
    weave annotate WEAVEFILE VERSION
 
806
        Display origin of each line.
 
807
    weave mash WEAVEFILE VERSION...
 
808
        Display composite of all selected versions.
 
809
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
810
        Auto-merge two versions and display conflicts.
 
811
    weave diff WEAVEFILE VERSION1 VERSION2 
 
812
        Show differences between two versions.
 
813
 
 
814
example:
 
815
 
 
816
    % weave init foo.weave
 
817
    % vi foo.txt
 
818
    % weave add foo.weave ver0 < foo.txt
 
819
    added version 0
 
820
 
 
821
    (create updated version)
 
822
    % vi foo.txt
 
823
    % weave get foo.weave 0 | diff -u - foo.txt
 
824
    % weave add foo.weave ver1 0 < foo.txt
 
825
    added version 1
 
826
 
 
827
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
828
    % vi foo.txt
 
829
    % weave add foo.weave ver2 0 < foo.txt
 
830
    added version 2
 
831
 
 
832
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
833
    % vi foo.txt                            (resolve conflicts)
 
834
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
835
    
 
836
"""
 
837
    
 
838
 
 
839
 
 
840
def main(argv):
 
841
    import sys
 
842
    import os
 
843
    try:
 
844
        import bzrlib
 
845
    except ImportError:
 
846
        # in case we're run directly from the subdirectory
 
847
        sys.path.append('..')
 
848
        import bzrlib
 
849
    from bzrlib.weavefile import write_weave, read_weave
 
850
    from bzrlib.progress import ProgressBar
 
851
 
 
852
    try:
 
853
        import psyco
 
854
        psyco.full()
 
855
    except ImportError:
 
856
        pass
 
857
 
 
858
    if len(argv) < 2:
 
859
        usage()
 
860
        return 0
 
861
 
 
862
    cmd = argv[1]
 
863
 
 
864
    def readit():
 
865
        return read_weave(file(argv[2], 'rb'))
 
866
    
 
867
    if cmd == 'help':
 
868
        usage()
 
869
    elif cmd == 'add':
 
870
        w = readit()
 
871
        # at the moment, based on everything in the file
 
872
        name = argv[3]
 
873
        parents = map(int, argv[4:])
 
874
        lines = sys.stdin.readlines()
 
875
        ver = w.add(name, parents, lines)
 
876
        write_weave(w, file(argv[2], 'wb'))
 
877
        print 'added version %r %d' % (name, ver)
 
878
    elif cmd == 'init':
 
879
        fn = argv[2]
 
880
        if os.path.exists(fn):
 
881
            raise IOError("file exists")
 
882
        w = Weave()
 
883
        write_weave(w, file(fn, 'wb'))
 
884
    elif cmd == 'get': # get one version
 
885
        w = readit()
 
886
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
887
        
 
888
    elif cmd == 'mash': # get composite
 
889
        w = readit()
 
890
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
 
891
 
 
892
    elif cmd == 'diff':
 
893
        from difflib import unified_diff
 
894
        w = readit()
 
895
        fn = argv[2]
 
896
        v1, v2 = map(int, argv[3:5])
 
897
        lines1 = w.get(v1)
 
898
        lines2 = w.get(v2)
 
899
        diff_gen = unified_diff(lines1, lines2,
 
900
                                '%s version %d' % (fn, v1),
 
901
                                '%s version %d' % (fn, v2))
 
902
        sys.stdout.writelines(diff_gen)
 
903
            
 
904
    elif cmd == 'annotate':
 
905
        w = readit()
 
906
        # newline is added to all lines regardless; too hard to get
 
907
        # reasonable formatting otherwise
 
908
        lasto = None
 
909
        for origin, text in w.annotate(int(argv[3])):
 
910
            text = text.rstrip('\r\n')
 
911
            if origin == lasto:
 
912
                print '      | %s' % (text)
 
913
            else:
 
914
                print '%5d | %s' % (origin, text)
 
915
                lasto = origin
 
916
                
 
917
    elif cmd == 'toc':
 
918
        weave_toc(readit())
 
919
 
 
920
    elif cmd == 'stats':
 
921
        weave_stats(argv[2], ProgressBar())
 
922
        
 
923
    elif cmd == 'check':
 
924
        w = readit()
 
925
        pb = ProgressBar()
 
926
        w.check(pb)
 
927
        pb.clear()
 
928
        print '%d versions ok' % w.numversions()
 
929
 
 
930
    elif cmd == 'inclusions':
 
931
        w = readit()
 
932
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
933
 
 
934
    elif cmd == 'parents':
 
935
        w = readit()
 
936
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
937
 
 
938
    elif cmd == 'plan-merge':
 
939
        w = readit()
 
940
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
941
            if line:
 
942
                print '%14s | %s' % (state, line),
 
943
 
 
944
    elif cmd == 'merge':
 
945
        w = readit()
 
946
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
947
        sys.stdout.writelines(w.weave_merge(p))
 
948
            
 
949
    elif cmd == 'mash-merge':
 
950
        if len(argv) != 5:
 
951
            usage()
 
952
            return 1
 
953
 
 
954
        w = readit()
 
955
        v1, v2 = map(int, argv[3:5])
 
956
 
 
957
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
 
958
 
 
959
        base_lines = list(w.mash_iter(basis))
 
960
        a_lines = list(w.get(v1))
 
961
        b_lines = list(w.get(v2))
 
962
 
 
963
        from bzrlib.merge3 import Merge3
 
964
        m3 = Merge3(base_lines, a_lines, b_lines)
 
965
 
 
966
        name_a = 'version %d' % v1
 
967
        name_b = 'version %d' % v2
 
968
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
 
969
    else:
 
970
        raise ValueError('unknown command %r' % cmd)
 
971
    
 
972
 
 
973
 
 
974
def profile_main(argv): 
 
975
    import tempfile, hotshot, hotshot.stats
 
976
 
 
977
    prof_f = tempfile.NamedTemporaryFile()
 
978
 
 
979
    prof = hotshot.Profile(prof_f.name)
 
980
 
 
981
    ret = prof.runcall(main, argv)
 
982
    prof.close()
 
983
 
 
984
    stats = hotshot.stats.load(prof_f.name)
 
985
    #stats.strip_dirs()
 
986
    stats.sort_stats('cumulative')
 
987
    ## XXX: Might like to write to stderr or the trace file instead but
 
988
    ## print_stats seems hardcoded to stdout
 
989
    stats.print_stats(20)
 
990
            
 
991
    return ret
 
992
 
 
993
 
 
994
if __name__ == '__main__':
 
995
    import sys
 
996
    if '--profile' in sys.argv:
 
997
        args = sys.argv[:]
 
998
        args.remove('--profile')
 
999
        sys.exit(profile_main(args))
 
1000
    else:
 
1001
        sys.exit(main(sys.argv))
 
1002