← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Wouter van Heyst
  • Date: 2007-01-18 18:37:21 UTC
  • mto: (2234.3.3 0.14)
  • mto: This revision was merged to the branch mainline in revision 2243.
  • Revision ID: larstiq@larstiq.dyndns.org-20070118183721-78uzxifyyyoqxja9
(Alexander Belchenko) add windows installer check for python2.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
1
#! /usr/bin/python
2
2
 
3
3
# Copyright (C) 2005 Canonical Ltd
4
 
 
 
4
#
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
9
 
 
 
9
#
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
13
# GNU General Public License for more details.
14
 
 
 
14
#
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21
21
 
22
22
"""Weave - storage of related text file versions"""
23
23
 
24
 
# before intset (r923) 2000 versions in 41.5s
25
 
# with intset (r926) 2000 versions in 93s !!!
26
 
# better to just use plain sets.
27
 
 
28
 
# making _extract build and return a list, rather than being a generator
29
 
# takes 37.94s
30
 
 
31
 
# with python -O, r923 does 2000 versions in 36.87s
32
 
 
33
 
# with optimizations to avoid mutating lists - 35.75!  I guess copying
34
 
# all the elements every time costs more than the small manipulations.
35
 
# a surprisingly small change.
36
 
 
37
 
# r931, which avoids using a generator for extract, does 36.98s
38
 
 
39
 
# with memoized inclusions, takes 41.49s; not very good
40
 
 
41
 
# with slots, takes 37.35s; without takes 39.16, a bit surprising
42
 
 
43
 
# with the delta calculation mixed in with the add method, rather than
44
 
# separated, takes 36.78s
45
 
 
46
 
# with delta folded in and mutation of the list, 36.13s
47
 
 
48
 
# with all this and simplification of add code, 33s
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
# TODO: Perhaps have copy method for Weave instances?
55
24
 
56
25
# XXX: If we do weaves this way, will a merge still behave the same
57
26
# way if it's done in a different order?  That's a pretty desirable
58
27
# property.
59
28
 
60
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
61
 
# rather than being split up in some other way.  We could accomodate
 
30
# rather than being split up in some other way.  We could accommodate
62
31
# binaries, perhaps by naively splitting on \n or perhaps using
63
32
# something like a rolling checksum.
64
33
 
74
43
 
75
44
# TODO: Parallel-extract that passes back each line along with a
76
45
# description of which revisions include it.  Nice for checking all
77
 
# shas in parallel.
 
46
# shas or calculating stats in parallel.
78
47
 
79
48
# TODO: Using a single _extract routine and then processing the output
80
49
# is probably inefficient.  It's simple enough that we can afford to
81
50
# have slight specializations for different ways its used: annotate,
82
51
# basis for add, get, etc.
83
52
 
84
 
# TODO: Perhaps the API should work only in names to hide the integer
85
 
# indexes from the user?
86
 
 
87
 
 
88
 
 
 
53
# TODO: Probably the API should work only in names to hide the integer
 
54
# indexes from the user.
 
55
 
 
56
# TODO: Is there any potential performance win by having an add()
 
57
# variant that is passed a pre-cooked version of the single basis
 
58
# version?
 
59
 
 
60
# TODO: Reweave can possibly be made faster by remembering diffs
 
61
# where the basis and destination are unchanged.
 
62
 
 
63
# FIXME: Sometimes we will be given a parents list for a revision
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
 
66
# be done fairly efficiently because the sequence numbers constrain
 
67
# the possible relationships.
 
68
 
 
69
# FIXME: the conflict markers should be *7* characters
 
70
 
 
71
from copy import copy
 
72
from cStringIO import StringIO
 
73
import os
89
74
import sha
90
 
from cStringIO import StringIO
91
 
 
92
 
 
93
 
class WeaveError(Exception):
94
 
    """Exception in processing weave"""
95
 
 
96
 
 
97
 
class WeaveFormatError(WeaveError):
98
 
    """Weave invariant violated"""
99
 
    
100
 
 
101
 
class Weave(object):
 
75
import time
 
76
import warnings
 
77
 
 
78
from bzrlib import (
 
79
    progress,
 
80
    )
 
81
from bzrlib.trace import mutter
 
82
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
83
        RevisionAlreadyPresent,
 
84
        RevisionNotPresent,
 
85
        WeaveRevisionAlreadyPresent,
 
86
        WeaveRevisionNotPresent,
 
87
        )
 
88
import bzrlib.errors as errors
 
89
from bzrlib.osutils import sha_strings
 
90
import bzrlib.patiencediff
 
91
from bzrlib.symbol_versioning import (deprecated_method,
 
92
        deprecated_function,
 
93
        zero_eight,
 
94
        )
 
95
from bzrlib.tsort import topo_sort
 
96
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
97
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
98
 
 
99
 
 
100
class Weave(VersionedFile):
102
101
    """weave - versioned text file storage.
103
102
    
104
103
    A Weave manages versions of line-based text files, keeping track
113
112
 
114
113
    * a nonnegative index number.
115
114
 
116
 
    * a version-id string. (not implemented yet)
 
115
    * a version-id string.
117
116
 
118
117
    Typically the index number will be valid only inside this weave and
119
118
    the version-id is used to reference it in the larger world.
188
187
    """
189
188
 
190
189
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
191
 
                 '_weave_name']
 
190
                 '_weave_name', '_matcher']
192
191
    
193
 
    def __init__(self, weave_name=None):
 
192
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
 
193
        super(Weave, self).__init__(access_mode)
194
194
        self._weave = []
195
195
        self._parents = []
196
196
        self._sha1s = []
197
197
        self._names = []
198
198
        self._name_map = {}
199
199
        self._weave_name = weave_name
200
 
 
 
200
        if matcher is None:
 
201
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
202
        else:
 
203
            self._matcher = matcher
 
204
 
 
205
    def __repr__(self):
 
206
        return "Weave(%r)" % self._weave_name
 
207
 
 
208
    def copy(self):
 
209
        """Return a deep copy of self.
 
210
        
 
211
        The copy can be modified without affecting the original weave."""
 
212
        other = Weave()
 
213
        other._weave = self._weave[:]
 
214
        other._parents = self._parents[:]
 
215
        other._sha1s = self._sha1s[:]
 
216
        other._names = self._names[:]
 
217
        other._name_map = self._name_map.copy()
 
218
        other._weave_name = self._weave_name
 
219
        return other
201
220
 
202
221
    def __eq__(self, other):
203
222
        if not isinstance(other, Weave):
205
224
        return self._parents == other._parents \
206
225
               and self._weave == other._weave \
207
226
               and self._sha1s == other._sha1s 
208
 
 
209
227
    
210
228
    def __ne__(self, other):
211
229
        return not self.__eq__(other)
212
230
 
213
 
 
 
231
    @deprecated_method(zero_eight)
 
232
    def idx_to_name(self, index):
 
233
        """Old public interface, the public interface is all names now."""
 
234
        return index
 
235
 
 
236
    def _idx_to_name(self, version):
 
237
        return self._names[version]
 
238
 
 
239
    @deprecated_method(zero_eight)
214
240
    def lookup(self, name):
 
241
        """Backwards compatibility thunk:
 
242
 
 
243
        Return name, as name is valid in the api now, and spew deprecation
 
244
        warnings everywhere.
 
245
        """
 
246
        return name
 
247
 
 
248
    def _lookup(self, name):
 
249
        """Convert symbolic version name to index."""
215
250
        try:
216
251
            return self._name_map[name]
217
252
        except KeyError:
218
 
            raise WeaveError("name %s not present in weave %s" %
219
 
                             (name, self._weave_name))
220
 
 
221
 
        
222
 
    def add(self, name, parents, text):
 
253
            raise RevisionNotPresent(name, self._weave_name)
 
254
 
 
255
    @deprecated_method(zero_eight)
 
256
    def iter_names(self):
 
257
        """Deprecated convenience function, please see VersionedFile.names()."""
 
258
        return iter(self.names())
 
259
 
 
260
    @deprecated_method(zero_eight)
 
261
    def names(self):
 
262
        """See Weave.versions for the current api."""
 
263
        return self.versions()
 
264
 
 
265
    def versions(self):
 
266
        """See VersionedFile.versions."""
 
267
        return self._names[:]
 
268
 
 
269
    def has_version(self, version_id):
 
270
        """See VersionedFile.has_version."""
 
271
        return (version_id in self._name_map)
 
272
 
 
273
    __contains__ = has_version
 
274
 
 
275
    def get_delta(self, version_id):
 
276
        """See VersionedFile.get_delta."""
 
277
        return self.get_deltas([version_id])[version_id]
 
278
 
 
279
    def get_deltas(self, version_ids):
 
280
        """See VersionedFile.get_deltas."""
 
281
        version_ids = self.get_ancestry(version_ids)
 
282
        for version_id in version_ids:
 
283
            if not self.has_version(version_id):
 
284
                raise RevisionNotPresent(version_id, self)
 
285
        # try extracting all versions; parallel extraction is used
 
286
        nv = self.num_versions()
 
287
        sha1s = {}
 
288
        deltas = {}
 
289
        texts = {}
 
290
        inclusions = {}
 
291
        noeols = {}
 
292
        last_parent_lines = {}
 
293
        parents = {}
 
294
        parent_inclusions = {}
 
295
        parent_linenums = {}
 
296
        parent_noeols = {}
 
297
        current_hunks = {}
 
298
        diff_hunks = {}
 
299
        # its simplest to generate a full set of prepared variables.
 
300
        for i in range(nv):
 
301
            name = self._names[i]
 
302
            sha1s[name] = self.get_sha1(name)
 
303
            parents_list = self.get_parents(name)
 
304
            try:
 
305
                parent = parents_list[0]
 
306
                parents[name] = parent
 
307
                parent_inclusions[name] = inclusions[parent]
 
308
            except IndexError:
 
309
                parents[name] = None
 
310
                parent_inclusions[name] = set()
 
311
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
 
312
            diff_hunks[name] = []
 
313
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
 
314
            parent_linenums[name] = 0
 
315
            noeols[name] = False
 
316
            parent_noeols[name] = False
 
317
            last_parent_lines[name] = None
 
318
            new_inc = set([name])
 
319
            for p in self._parents[i]:
 
320
                new_inc.update(inclusions[self._idx_to_name(p)])
 
321
            # debug only, known good so far.
 
322
            #assert set(new_inc) == set(self.get_ancestry(name)), \
 
323
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
324
            inclusions[name] = new_inc
 
325
 
 
326
        nlines = len(self._weave)
 
327
 
 
328
        for lineno, inserted, deletes, line in self._walk_internal():
 
329
            # a line is active in a version if:
 
330
            # insert is in the versions inclusions
 
331
            # and
 
332
            # deleteset & the versions inclusions is an empty set.
 
333
            # so - if we have a included by mapping - version is included by
 
334
            # children, we get a list of children to examine for deletes affect
 
335
            # ing them, which is less than the entire set of children.
 
336
            for version_id in version_ids:  
 
337
                # The active inclusion must be an ancestor,
 
338
                # and no ancestors must have deleted this line,
 
339
                # because we don't support resurrection.
 
340
                parent_inclusion = parent_inclusions[version_id]
 
341
                inclusion = inclusions[version_id]
 
342
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
 
343
                version_active = inserted in inclusion and not (deletes & inclusion)
 
344
                if not parent_active and not version_active:
 
345
                    # unrelated line of ancestry
 
346
                    continue
 
347
                elif parent_active and version_active:
 
348
                    # shared line
 
349
                    parent_linenum = parent_linenums[version_id]
 
350
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
 
351
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
 
352
                    parent_linenum += 1
 
353
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
 
354
                    parent_linenums[version_id] = parent_linenum
 
355
                    try:
 
356
                        if line[-1] != '\n':
 
357
                            noeols[version_id] = True
 
358
                    except IndexError:
 
359
                        pass
 
360
                elif parent_active and not version_active:
 
361
                    # deleted line
 
362
                    current_hunks[version_id][1] += 1
 
363
                    parent_linenums[version_id] += 1
 
364
                    last_parent_lines[version_id] = line
 
365
                elif not parent_active and version_active:
 
366
                    # replacement line
 
367
                    # noeol only occurs at the end of a file because we 
 
368
                    # diff linewise. We want to show noeol changes as a
 
369
                    # empty diff unless the actual eol-less content changed.
 
370
                    theline = line
 
371
                    try:
 
372
                        if last_parent_lines[version_id][-1] != '\n':
 
373
                            parent_noeols[version_id] = True
 
374
                    except (TypeError, IndexError):
 
375
                        pass
 
376
                    try:
 
377
                        if theline[-1] != '\n':
 
378
                            noeols[version_id] = True
 
379
                    except IndexError:
 
380
                        pass
 
381
                    new_line = False
 
382
                    parent_should_go = False
 
383
 
 
384
                    if parent_noeols[version_id] == noeols[version_id]:
 
385
                        # no noeol toggle, so trust the weaves statement
 
386
                        # that this line is changed.
 
387
                        new_line = True
 
388
                        if parent_noeols[version_id]:
 
389
                            theline = theline + '\n'
 
390
                    elif parent_noeols[version_id]:
 
391
                        # parent has no eol, we do:
 
392
                        # our line is new, report as such..
 
393
                        new_line = True
 
394
                    elif noeols[version_id]:
 
395
                        # append a eol so that it looks like
 
396
                        # a normalised delta
 
397
                        theline = theline + '\n'
 
398
                        if parents[version_id] is not None:
 
399
                        #if last_parent_lines[version_id] is not None:
 
400
                            parent_should_go = True
 
401
                        if last_parent_lines[version_id] != theline:
 
402
                            # but changed anyway
 
403
                            new_line = True
 
404
                            #parent_should_go = False
 
405
                    if new_line:
 
406
                        current_hunks[version_id][2] += 1
 
407
                        current_hunks[version_id][3].append((inserted, theline))
 
408
                    if parent_should_go:
 
409
                        # last hunk last parent line is not eaten
 
410
                        current_hunks[version_id][1] -= 1
 
411
                    if current_hunks[version_id][1] < 0:
 
412
                        current_hunks[version_id][1] = 0
 
413
                        # import pdb;pdb.set_trace()
 
414
                    # assert current_hunks[version_id][1] >= 0
 
415
 
 
416
        # flush last hunk
 
417
        for i in range(nv):
 
418
            version = self._idx_to_name(i)
 
419
            if current_hunks[version] != [0, 0, 0, []]:
 
420
                diff_hunks[version].append(tuple(current_hunks[version]))
 
421
        result = {}
 
422
        for version_id in version_ids:
 
423
            result[version_id] = (
 
424
                                  parents[version_id],
 
425
                                  sha1s[version_id],
 
426
                                  noeols[version_id],
 
427
                                  diff_hunks[version_id],
 
428
                                  )
 
429
        return result
 
430
 
 
431
    def get_parents(self, version_id):
 
432
        """See VersionedFile.get_parent."""
 
433
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
 
434
 
 
435
    def _check_repeated_add(self, name, parents, text, sha1):
 
436
        """Check that a duplicated add is OK.
 
437
 
 
438
        If it is, return the (old) index; otherwise raise an exception.
 
439
        """
 
440
        idx = self._lookup(name)
 
441
        if sorted(self._parents[idx]) != sorted(parents) \
 
442
            or sha1 != self._sha1s[idx]:
 
443
            raise RevisionAlreadyPresent(name, self._weave_name)
 
444
        return idx
 
445
 
 
446
    @deprecated_method(zero_eight)
 
447
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
448
        """Please use Weave.clone_text now."""
 
449
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
450
 
 
451
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
452
        """See VersionedFile.add_lines."""
 
453
        return self._add(version_id, lines, map(self._lookup, parents))
 
454
 
 
455
    @deprecated_method(zero_eight)
 
456
    def add(self, name, parents, text, sha1=None):
 
457
        """See VersionedFile.add_lines for the non deprecated api."""
 
458
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
 
459
 
 
460
    def _add(self, version_id, lines, parents, sha1=None):
223
461
        """Add a single text on top of the weave.
224
462
  
225
463
        Returns the index number of the newly added version.
226
464
 
227
 
        name
 
465
        version_id
228
466
            Symbolic name for this version.
229
467
            (Typically the revision-id of the revision that added it.)
230
468
 
231
469
        parents
232
470
            List or set of direct parent version numbers.
233
471
            
234
 
        text
235
 
            Sequence of lines to be added in the new version."""
236
 
 
237
 
        assert isinstance(name, basestring)
238
 
        if name in self._name_map:
239
 
            raise WeaveError("name %r already present in weave" % name)
240
 
        
 
472
        lines
 
473
            Sequence of lines to be added in the new version.
 
474
        """
 
475
 
 
476
        assert isinstance(version_id, basestring)
 
477
        self._check_lines_not_unicode(lines)
 
478
        self._check_lines_are_lines(lines)
 
479
        if not sha1:
 
480
            sha1 = sha_strings(lines)
 
481
        if version_id in self._name_map:
 
482
            return self._check_repeated_add(version_id, parents, lines, sha1)
 
483
 
241
484
        self._check_versions(parents)
242
 
        ## self._check_lines(text)
 
485
        ## self._check_lines(lines)
243
486
        new_version = len(self._parents)
244
487
 
245
 
        s = sha.new()
246
 
        map(s.update, text)
247
 
        sha1 = s.hexdigest()
248
 
        del s
249
 
 
250
488
        # if we abort after here the (in-memory) weave will be corrupt because only
251
489
        # some fields are updated
 
490
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
491
        #      - Robert Collins 20060226
252
492
        self._parents.append(parents[:])
253
493
        self._sha1s.append(sha1)
254
 
        self._names.append(name)
255
 
        self._name_map[name] = new_version
 
494
        self._names.append(version_id)
 
495
        self._name_map[version_id] = new_version
256
496
 
257
497
            
258
498
        if not parents:
260
500
            # this more quickly by just appending unconditionally.
261
501
            # even more specially, if we're adding an empty text we
262
502
            # need do nothing at all.
263
 
            if text:
 
503
            if lines:
264
504
                self._weave.append(('{', new_version))
265
 
                self._weave.extend(text)
 
505
                self._weave.extend(lines)
266
506
                self._weave.append(('}', None))
267
 
        
268
507
            return new_version
269
508
 
270
509
        if len(parents) == 1:
274
513
                return new_version
275
514
            
276
515
 
277
 
        ancestors = self.inclusions(parents)
 
516
        ancestors = self._inclusions(parents)
278
517
 
279
518
        l = self._weave
280
519
 
287
526
 
288
527
        # another small special case: a merge, producing the same text
289
528
        # as auto-merge
290
 
        if text == basis_lines:
 
529
        if lines == basis_lines:
291
530
            return new_version            
292
531
 
293
 
        # add a sentinal, because we can also match against the final line
 
532
        # add a sentinel, because we can also match against the final line
294
533
        basis_lineno.append(len(self._weave))
295
534
 
296
535
        # XXX: which line of the weave should we really consider
300
539
        #print 'basis_lines:', basis_lines
301
540
        #print 'new_lines:  ', lines
302
541
 
303
 
        from difflib import SequenceMatcher
304
 
        s = SequenceMatcher(None, basis_lines, text)
 
542
        s = self._matcher(None, basis_lines, lines)
305
543
 
306
544
        # offset gives the number of lines that have been inserted
307
545
        # into the weave up to the current point; if the original edit instruction
318
556
            i1 = basis_lineno[i1]
319
557
            i2 = basis_lineno[i2]
320
558
 
321
 
            assert 0 <= j1 <= j2 <= len(text)
 
559
            assert 0 <= j1 <= j2 <= len(lines)
322
560
 
323
561
            #print tag, i1, i2, j1, j2
324
562
 
335
573
                # we don't destroy ourselves
336
574
                i = i2 + offset
337
575
                self._weave[i:i] = ([('{', new_version)] 
338
 
                                    + text[j1:j2] 
 
576
                                    + lines[j1:j2] 
339
577
                                    + [('}', None)])
340
578
                offset += 2 + (j2 - j1)
341
 
 
342
579
        return new_version
343
580
 
 
581
    def _clone_text(self, new_version_id, old_version_id, parents):
 
582
        """See VersionedFile.clone_text."""
 
583
        old_lines = self.get_text(old_version_id)
 
584
        self.add_lines(new_version_id, parents, old_lines)
344
585
 
345
 
    def inclusions(self, versions):
 
586
    def _inclusions(self, versions):
346
587
        """Return set of all ancestors of given version(s)."""
 
588
        if not len(versions):
 
589
            return []
347
590
        i = set(versions)
348
 
        v = max(versions)
349
 
        try:
350
 
            while v >= 0:
351
 
                if v in i:
352
 
                    # include all its parents
353
 
                    i.update(self._parents[v])
354
 
                v -= 1
355
 
            return i
356
 
        except IndexError:
357
 
            raise ValueError("version %d not present in weave" % v)
358
 
 
359
 
 
360
 
    def minimal_parents(self, version):
361
 
        """Find the minimal set of parents for the version."""
362
 
        included = self._parents[version]
363
 
        if not included:
 
591
        for v in xrange(max(versions), 0, -1):
 
592
            if v in i:
 
593
                # include all its parents
 
594
                i.update(self._parents[v])
 
595
        return i
 
596
        ## except IndexError:
 
597
        ##     raise ValueError("version %d not present in weave" % v)
 
598
 
 
599
    @deprecated_method(zero_eight)
 
600
    def inclusions(self, version_ids):
 
601
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
 
602
        if not version_ids:
364
603
            return []
365
 
        
366
 
        li = list(included)
367
 
        li.sort(reverse=True)
368
 
 
369
 
        mininc = []
370
 
        gotit = set()
371
 
 
372
 
        for pv in li:
373
 
            if pv not in gotit:
374
 
                mininc.append(pv)
375
 
                gotit.update(self.inclusions(pv))
376
 
 
377
 
        assert mininc[0] >= 0
378
 
        assert mininc[-1] < version
379
 
        return mininc
380
 
 
381
 
 
 
604
        if isinstance(version_ids[0], int):
 
605
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
 
606
        else:
 
607
            return self.get_ancestry(version_ids)
 
608
 
 
609
    def get_ancestry(self, version_ids):
 
610
        """See VersionedFile.get_ancestry."""
 
611
        if isinstance(version_ids, basestring):
 
612
            version_ids = [version_ids]
 
613
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
614
        return [self._idx_to_name(v) for v in i]
382
615
 
383
616
    def _check_lines(self, text):
384
617
        if not isinstance(text, list):
399
632
            except IndexError:
400
633
                raise IndexError("invalid version number %r" % i)
401
634
 
 
635
    def _compatible_parents(self, my_parents, other_parents):
 
636
        """During join check that other_parents are joinable with my_parents.
 
637
 
 
638
        Joinable is defined as 'is a subset of' - supersets may require 
 
639
        regeneration of diffs, but subsets do not.
 
640
        """
 
641
        return len(other_parents.difference(my_parents)) == 0
 
642
 
 
643
    def annotate(self, version_id):
 
644
        if isinstance(version_id, int):
 
645
            warnings.warn('Weave.annotate(int) is deprecated. Please use version names'
 
646
                 ' in all circumstances as of 0.8',
 
647
                 DeprecationWarning,
 
648
                 stacklevel=2
 
649
                 )
 
650
            result = []
 
651
            for origin, lineno, text in self._extract([version_id]):
 
652
                result.append((origin, text))
 
653
            return result
 
654
        else:
 
655
            return super(Weave, self).annotate(version_id)
402
656
    
403
 
    def annotate(self, index):
404
 
        return list(self.annotate_iter(index))
405
 
 
406
 
 
407
 
    def annotate_iter(self, version):
408
 
        """Yield list of (index-id, line) pairs for the specified version.
 
657
    def annotate_iter(self, version_id):
 
658
        """Yield list of (version-id, line) pairs for the specified version.
409
659
 
410
660
        The index indicates when the line originated in the weave."""
411
 
        for origin, lineno, text in self._extract([version]):
412
 
            yield origin, text
413
 
 
414
 
 
 
661
        incls = [self._lookup(version_id)]
 
662
        for origin, lineno, text in self._extract(incls):
 
663
            yield self._idx_to_name(origin), text
 
664
 
 
665
    @deprecated_method(zero_eight)
415
666
    def _walk(self):
416
 
        """Walk the weave.
417
 
 
418
 
        Yields sequence of
419
 
        (lineno, insert, deletes, text)
420
 
        for each literal line.
421
 
        """
 
667
        """_walk has become visit, a supported api."""
 
668
        return self._walk_internal()
 
669
 
 
670
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
671
                                                pb=None):
 
672
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
673
        if version_ids is None:
 
674
            version_ids = self.versions()
 
675
        version_ids = set(version_ids)
 
676
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
677
            # if inserted not in version_ids then it was inserted before the
 
678
            # versions we care about, but because weaves cannot represent ghosts
 
679
            # properly, we do not filter down to that
 
680
            # if inserted not in version_ids: continue
 
681
            if line[-1] != '\n':
 
682
                yield line + '\n'
 
683
            else:
 
684
                yield line
 
685
 
 
686
    #@deprecated_method(zero_eight)
 
687
    def walk(self, version_ids=None):
 
688
        """See VersionedFile.walk."""
 
689
        return self._walk_internal(version_ids)
 
690
 
 
691
    def _walk_internal(self, version_ids=None):
 
692
        """Helper method for weave actions."""
422
693
        
423
694
        istack = []
424
695
        dset = set()
426
697
        lineno = 0         # line of weave, 0-based
427
698
 
428
699
        for l in self._weave:
429
 
            if isinstance(l, tuple):
 
700
            if l.__class__ == tuple:
430
701
                c, v = l
431
702
                isactive = None
432
703
                if c == '{':
433
 
                    istack.append(v)
 
704
                    istack.append(self._names[v])
434
705
                elif c == '}':
435
706
                    istack.pop()
436
707
                elif c == '[':
437
 
                    assert v not in dset
438
 
                    dset.add(v)
 
708
                    assert self._names[v] not in dset
 
709
                    dset.add(self._names[v])
439
710
                elif c == ']':
440
 
                    dset.remove(v)
 
711
                    dset.remove(self._names[v])
441
712
                else:
442
 
                    raise WeaveFormatError('unexpected instruction %r'
443
 
                                           % v)
 
713
                    raise WeaveFormatError('unexpected instruction %r' % v)
444
714
            else:
445
 
                assert isinstance(l, basestring)
 
715
                assert l.__class__ in (str, unicode)
446
716
                assert istack
447
 
                yield lineno, istack[-1], dset, l
 
717
                yield lineno, istack[-1], frozenset(dset), l
448
718
            lineno += 1
449
719
 
450
 
 
 
720
        if istack:
 
721
            raise WeaveFormatError("unclosed insertion blocks "
 
722
                    "at end of weave: %s" % istack)
 
723
        if dset:
 
724
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
725
                                   % dset)
 
726
 
 
727
    def plan_merge(self, ver_a, ver_b):
 
728
        """Return pseudo-annotation indicating how the two versions merge.
 
729
 
 
730
        This is computed between versions a and b and their common
 
731
        base.
 
732
 
 
733
        Weave lines present in none of them are skipped entirely.
 
734
        """
 
735
        inc_a = set(self.get_ancestry([ver_a]))
 
736
        inc_b = set(self.get_ancestry([ver_b]))
 
737
        inc_c = inc_a & inc_b
 
738
 
 
739
        for lineno, insert, deleteset, line in\
 
740
            self.walk([ver_a, ver_b]):
 
741
            if deleteset & inc_c:
 
742
                # killed in parent; can't be in either a or b
 
743
                # not relevant to our work
 
744
                yield 'killed-base', line
 
745
            elif insert in inc_c:
 
746
                # was inserted in base
 
747
                killed_a = bool(deleteset & inc_a)
 
748
                killed_b = bool(deleteset & inc_b)
 
749
                if killed_a and killed_b:
 
750
                    yield 'killed-both', line
 
751
                elif killed_a:
 
752
                    yield 'killed-a', line
 
753
                elif killed_b:
 
754
                    yield 'killed-b', line
 
755
                else:
 
756
                    yield 'unchanged', line
 
757
            elif insert in inc_a:
 
758
                if deleteset & inc_a:
 
759
                    yield 'ghost-a', line
 
760
                else:
 
761
                    # new in A; not in B
 
762
                    yield 'new-a', line
 
763
            elif insert in inc_b:
 
764
                if deleteset & inc_b:
 
765
                    yield 'ghost-b', line
 
766
                else:
 
767
                    yield 'new-b', line
 
768
            else:
 
769
                # not in either revision
 
770
                yield 'irrelevant', line
 
771
 
 
772
        yield 'unchanged', ''           # terminator
451
773
 
452
774
    def _extract(self, versions):
453
775
        """Yield annotation of lines in included set.
462
784
            if not isinstance(i, int):
463
785
                raise ValueError(i)
464
786
            
465
 
        included = self.inclusions(versions)
 
787
        included = self._inclusions(versions)
466
788
 
467
789
        istack = []
 
790
        iset = set()
468
791
        dset = set()
469
792
 
470
793
        lineno = 0         # line of weave, 0-based
475
798
 
476
799
        WFE = WeaveFormatError
477
800
 
 
801
        # wow. 
 
802
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
803
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
804
        # 1.6 seconds in 'isinstance'.
 
805
        # changing the first isinstance:
 
806
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
807
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
808
        # note that the inline time actually dropped (less function calls)
 
809
        # and total processing time was halved.
 
810
        # we're still spending ~1/4 of the method in isinstance though.
 
811
        # so lets hard code the acceptable string classes we expect:
 
812
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
813
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
814
        #                                          objects>
 
815
        # yay, down to ~1/4 the initial extract time, and our inline time
 
816
        # has shrunk again, with isinstance no longer dominating.
 
817
        # tweaking the stack inclusion test to use a set gives:
 
818
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
819
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
820
        #                                          objects>
 
821
        # - a 5% win, or possibly just noise. However with large istacks that
 
822
        # 'in' test could dominate, so I'm leaving this change in place -
 
823
        # when its fast enough to consider profiling big datasets we can review.
 
824
 
 
825
              
 
826
             
 
827
 
478
828
        for l in self._weave:
479
 
            if isinstance(l, tuple):
 
829
            if l.__class__ == tuple:
480
830
                c, v = l
481
831
                isactive = None
482
832
                if c == '{':
483
 
                    assert v not in istack
 
833
                    assert v not in iset
484
834
                    istack.append(v)
 
835
                    iset.add(v)
485
836
                elif c == '}':
486
 
                    istack.pop()
 
837
                    iset.remove(istack.pop())
487
838
                elif c == '[':
488
839
                    if v in included:
489
840
                        assert v not in dset
494
845
                        assert v in dset
495
846
                        dset.remove(v)
496
847
            else:
497
 
                assert isinstance(l, basestring)
 
848
                assert l.__class__ in (str, unicode)
498
849
                if isactive is None:
499
850
                    isactive = (not dset) and istack and (istack[-1] in included)
500
851
                if isactive:
501
852
                    result.append((istack[-1], lineno, l))
502
853
            lineno += 1
503
 
 
504
854
        if istack:
505
 
            raise WFE("unclosed insertion blocks at end of weave",
506
 
                                   istack)
 
855
            raise WeaveFormatError("unclosed insertion blocks "
 
856
                    "at end of weave: %s" % istack)
507
857
        if dset:
508
 
            raise WFE("unclosed deletion blocks at end of weave",
509
 
                                   dset)
510
 
 
511
 
        return result
512
 
    
513
 
 
514
 
 
515
 
    def get_iter(self, version):
516
 
        """Yield lines for the specified version."""
517
 
        for origin, lineno, line in self._extract([version]):
518
 
            yield line
519
 
 
520
 
 
521
 
    def get_text(self, version):
522
 
        assert isinstance(version, int)
523
 
        s = StringIO()
524
 
        s.writelines(self.get_iter(version))
525
 
        return s.getvalue()
526
 
 
527
 
 
528
 
    def get(self, index):
529
 
        return list(self.get_iter(index))
530
 
 
531
 
 
532
 
    def mash_iter(self, included):
533
 
        """Return composed version of multiple included versions."""
534
 
        for origin, lineno, text in self._extract(included):
535
 
            yield text
536
 
 
537
 
 
538
 
    def dump(self, to_file):
539
 
        from pprint import pprint
540
 
        print >>to_file, "Weave._weave = ",
541
 
        pprint(self._weave, to_file)
542
 
        print >>to_file, "Weave._parents = ",
543
 
        pprint(self._parents, to_file)
544
 
 
545
 
 
546
 
 
 
858
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
859
                                   % dset)
 
860
        return result
 
861
 
 
862
    @deprecated_method(zero_eight)
 
863
    def get_iter(self, name_or_index):
 
864
        """Deprecated, please do not use. Lookups are not not needed.
 
865
        
 
866
        Please use get_lines now.
 
867
        """
 
868
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
869
 
 
870
    @deprecated_method(zero_eight)
 
871
    def maybe_lookup(self, name_or_index):
 
872
        """Deprecated, please do not use. Lookups are not not needed."""
 
873
        return self._maybe_lookup(name_or_index)
 
874
 
 
875
    def _maybe_lookup(self, name_or_index):
 
876
        """Convert possible symbolic name to index, or pass through indexes.
 
877
        
 
878
        NOT FOR PUBLIC USE.
 
879
        """
 
880
        if isinstance(name_or_index, (int, long)):
 
881
            return name_or_index
 
882
        else:
 
883
            return self._lookup(name_or_index)
 
884
 
 
885
    @deprecated_method(zero_eight)
 
886
    def get(self, version_id):
 
887
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
888
        return self.get_lines(version_id)
 
889
 
 
890
    def get_lines(self, version_id):
 
891
        """See VersionedFile.get_lines()."""
 
892
        int_index = self._maybe_lookup(version_id)
 
893
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
894
        expected_sha1 = self._sha1s[int_index]
 
895
        measured_sha1 = sha_strings(result)
 
896
        if measured_sha1 != expected_sha1:
 
897
            raise errors.WeaveInvalidChecksum(
 
898
                    'file %s, revision %s, expected: %s, measured %s' 
 
899
                    % (self._weave_name, version_id,
 
900
                       expected_sha1, measured_sha1))
 
901
        return result
 
902
 
 
903
    def get_sha1(self, version_id):
 
904
        """See VersionedFile.get_sha1()."""
 
905
        return self._sha1s[self._lookup(version_id)]
 
906
 
 
907
    @deprecated_method(zero_eight)
547
908
    def numversions(self):
 
909
        """How many versions are in this weave?
 
910
 
 
911
        Deprecated in favour of num_versions.
 
912
        """
 
913
        return self.num_versions()
 
914
 
 
915
    def num_versions(self):
 
916
        """How many versions are in this weave?"""
548
917
        l = len(self._parents)
549
918
        assert l == len(self._sha1s)
550
919
        return l
551
920
 
552
 
 
553
 
    def __len__(self):
554
 
        return self.numversions()
555
 
 
 
921
    __len__ = num_versions
556
922
 
557
923
    def check(self, progress_bar=None):
558
 
        # check no circular inclusions
559
 
        for version in range(self.numversions()):
 
924
        # TODO evaluate performance hit of using string sets in this routine.
 
925
        # TODO: check no circular inclusions
 
926
        # TODO: create a nested progress bar
 
927
        for version in range(self.num_versions()):
560
928
            inclusions = list(self._parents[version])
561
929
            if inclusions:
562
930
                inclusions.sort()
564
932
                    raise WeaveFormatError("invalid included version %d for index %d"
565
933
                                           % (inclusions[-1], version))
566
934
 
567
 
        # try extracting all versions; this is a bit slow and parallel
568
 
        # extraction could be used
569
 
        nv = self.numversions()
570
 
        for version in range(nv):
 
935
        # try extracting all versions; parallel extraction is used
 
936
        nv = self.num_versions()
 
937
        sha1s = {}
 
938
        texts = {}
 
939
        inclusions = {}
 
940
        for i in range(nv):
 
941
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
942
            # The problem is that set membership is much more expensive
 
943
            name = self._idx_to_name(i)
 
944
            sha1s[name] = sha.new()
 
945
            texts[name] = []
 
946
            new_inc = set([name])
 
947
            for p in self._parents[i]:
 
948
                new_inc.update(inclusions[self._idx_to_name(p)])
 
949
 
 
950
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
951
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
952
            inclusions[name] = new_inc
 
953
 
 
954
        nlines = len(self._weave)
 
955
 
 
956
        update_text = 'checking weave'
 
957
        if self._weave_name:
 
958
            short_name = os.path.basename(self._weave_name)
 
959
            update_text = 'checking %s' % (short_name,)
 
960
            update_text = update_text[:25]
 
961
 
 
962
        for lineno, insert, deleteset, line in self._walk_internal():
571
963
            if progress_bar:
572
 
                progress_bar.update('checking text', version, nv)
573
 
            s = sha.new()
574
 
            for l in self.get_iter(version):
575
 
                s.update(l)
576
 
            hd = s.hexdigest()
577
 
            expected = self._sha1s[version]
 
964
                progress_bar.update(update_text, lineno, nlines)
 
965
 
 
966
            for name, name_inclusions in inclusions.items():
 
967
                # The active inclusion must be an ancestor,
 
968
                # and no ancestors must have deleted this line,
 
969
                # because we don't support resurrection.
 
970
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
971
                    sha1s[name].update(line)
 
972
 
 
973
        for i in range(nv):
 
974
            version = self._idx_to_name(i)
 
975
            hd = sha1s[version].hexdigest()
 
976
            expected = self._sha1s[i]
578
977
            if hd != expected:
579
 
                raise WeaveError("mismatched sha1 for version %d; "
580
 
                                 "got %s, expected %s"
581
 
                                 % (version, hd, expected))
 
978
                raise errors.WeaveInvalidChecksum(
 
979
                        "mismatched sha1 for version %s: "
 
980
                        "got %s, expected %s"
 
981
                        % (version, hd, expected))
582
982
 
583
983
        # TODO: check insertions are properly nested, that there are
584
984
        # no lines outside of insertion blocks, that deletions are
585
985
        # properly paired, etc.
586
986
 
587
 
 
588
 
 
589
 
    def merge(self, merge_versions):
590
 
        """Automerge and mark conflicts between versions.
591
 
 
592
 
        This returns a sequence, each entry describing alternatives
593
 
        for a chunk of the file.  Each of the alternatives is given as
594
 
        a list of lines.
595
 
 
596
 
        If there is a chunk of the file where there's no diagreement,
597
 
        only one alternative is given.
598
 
        """
599
 
 
600
 
        # approach: find the included versions common to all the
601
 
        # merged versions
602
 
        raise NotImplementedError()
603
 
 
604
 
 
605
 
 
606
 
    def _delta(self, included, lines):
607
 
        """Return changes from basis to new revision.
608
 
 
609
 
        The old text for comparison is the union of included revisions.
610
 
 
611
 
        This is used in inserting a new text.
612
 
 
613
 
        Delta is returned as a sequence of
614
 
        (weave1, weave2, newlines).
615
 
 
616
 
        This indicates that weave1:weave2 of the old weave should be
617
 
        replaced by the sequence of lines in newlines.  Note that
618
 
        these line numbers are positions in the total weave and don't
619
 
        correspond to the lines in any extracted version, or even the
620
 
        extracted union of included versions.
621
 
 
622
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
623
 
        pure delete.  (Similar to difflib.)
624
 
        """
625
 
 
626
 
 
627
 
            
628
 
    def plan_merge(self, ver_a, ver_b):
629
 
        """Return pseudo-annotation indicating how the two versions merge.
630
 
 
631
 
        This is computed between versions a and b and their common
632
 
        base.
633
 
 
634
 
        Weave lines present in none of them are skipped entirely.
635
 
        """
636
 
        inc_a = self.inclusions([ver_a])
637
 
        inc_b = self.inclusions([ver_b])
638
 
        inc_c = inc_a & inc_b
639
 
 
640
 
        for lineno, insert, deleteset, line in self._walk():
641
 
            if deleteset & inc_c:
642
 
                # killed in parent; can't be in either a or b
643
 
                # not relevant to our work
644
 
                yield 'killed-base', line
645
 
            elif insert in inc_c:
646
 
                # was inserted in base
647
 
                killed_a = bool(deleteset & inc_a)
648
 
                killed_b = bool(deleteset & inc_b)
649
 
                if killed_a and killed_b:
650
 
                    yield 'killed-both', line
651
 
                elif killed_a:
652
 
                    yield 'killed-a', line
653
 
                elif killed_b:
654
 
                    yield 'killed-b', line
655
 
                else:
656
 
                    yield 'unchanged', line
657
 
            elif insert in inc_a:
658
 
                if deleteset & inc_a:
659
 
                    yield 'ghost-a', line
660
 
                else:
661
 
                    # new in A; not in B
662
 
                    yield 'new-a', line
663
 
            elif insert in inc_b:
664
 
                if deleteset & inc_b:
665
 
                    yield 'ghost-b', line
666
 
                else:
667
 
                    yield 'new-b', line
668
 
            else:
669
 
                # not in either revision
670
 
                yield 'irrelevant', line
671
 
 
672
 
        yield 'unchanged', ''           # terminator
673
 
 
674
 
 
675
 
 
676
 
    def weave_merge(self, plan):
677
 
        lines_a = []
678
 
        lines_b = []
679
 
        ch_a = ch_b = False
680
 
 
681
 
        for state, line in plan:
682
 
            if state == 'unchanged' or state == 'killed-both':
683
 
                # resync and flush queued conflicts changes if any
684
 
                if not lines_a and not lines_b:
685
 
                    pass
686
 
                elif ch_a and not ch_b:
687
 
                    # one-sided change:                    
688
 
                    for l in lines_a: yield l
689
 
                elif ch_b and not ch_a:
690
 
                    for l in lines_b: yield l
691
 
                elif lines_a == lines_b:
692
 
                    for l in lines_a: yield l
693
 
                else:
694
 
                    yield '<<<<\n'
695
 
                    for l in lines_a: yield l
696
 
                    yield '====\n'
697
 
                    for l in lines_b: yield l
698
 
                    yield '>>>>\n'
699
 
 
700
 
                del lines_a[:]
701
 
                del lines_b[:]
702
 
                ch_a = ch_b = False
703
 
                
704
 
            if state == 'unchanged':
705
 
                if line:
706
 
                    yield line
707
 
            elif state == 'killed-a':
708
 
                ch_a = True
709
 
                lines_b.append(line)
710
 
            elif state == 'killed-b':
711
 
                ch_b = True
712
 
                lines_a.append(line)
713
 
            elif state == 'new-a':
714
 
                ch_a = True
715
 
                lines_a.append(line)
716
 
            elif state == 'new-b':
717
 
                ch_b = True
718
 
                lines_b.append(line)
719
 
            else:
720
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
721
 
                                 'killed-both'), \
722
 
                       state
723
 
 
724
 
                
725
 
 
726
 
 
727
 
 
 
987
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
988
        """Worker routine for join()."""
 
989
        if not other.versions():
 
990
            return          # nothing to update, easy
 
991
 
 
992
        if not version_ids:
 
993
            # versions is never none, InterWeave checks this.
 
994
            return 0
 
995
 
 
996
        # two loops so that we do not change ourselves before verifying it
 
997
        # will be ok
 
998
        # work through in index order to make sure we get all dependencies
 
999
        names_to_join = []
 
1000
        processed = 0
 
1001
        # get the selected versions only that are in other.versions.
 
1002
        version_ids = set(other.versions()).intersection(set(version_ids))
 
1003
        # pull in the referenced graph.
 
1004
        version_ids = other.get_ancestry(version_ids)
 
1005
        pending_graph = [(version, other.get_parents(version)) for
 
1006
                         version in version_ids]
 
1007
        for name in topo_sort(pending_graph):
 
1008
            other_idx = other._name_map[name]
 
1009
            # returns True if we have it, False if we need it.
 
1010
            if not self._check_version_consistent(other, other_idx, name):
 
1011
                names_to_join.append((other_idx, name))
 
1012
            processed += 1
 
1013
 
 
1014
 
 
1015
        if pb and not msg:
 
1016
            msg = 'weave join'
 
1017
 
 
1018
        merged = 0
 
1019
        time0 = time.time()
 
1020
        for other_idx, name in names_to_join:
 
1021
            # TODO: If all the parents of the other version are already
 
1022
            # present then we can avoid some work by just taking the delta
 
1023
            # and adjusting the offsets.
 
1024
            new_parents = self._imported_parents(other, other_idx)
 
1025
            sha1 = other._sha1s[other_idx]
 
1026
 
 
1027
            merged += 1
 
1028
 
 
1029
            if pb:
 
1030
                pb.update(msg, merged, len(names_to_join))
 
1031
           
 
1032
            lines = other.get_lines(other_idx)
 
1033
            self._add(name, lines, new_parents, sha1)
 
1034
 
 
1035
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
1036
                merged, processed, self._weave_name, time.time()-time0))
 
1037
 
 
1038
    def _imported_parents(self, other, other_idx):
 
1039
        """Return list of parents in self corresponding to indexes in other."""
 
1040
        new_parents = []
 
1041
        for parent_idx in other._parents[other_idx]:
 
1042
            parent_name = other._names[parent_idx]
 
1043
            if parent_name not in self._name_map:
 
1044
                # should not be possible
 
1045
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
1046
                                 % (parent_name, other._name_map[other_idx], self))
 
1047
            new_parents.append(self._name_map[parent_name])
 
1048
        return new_parents
 
1049
 
 
1050
    def _check_version_consistent(self, other, other_idx, name):
 
1051
        """Check if a version in consistent in this and other.
 
1052
 
 
1053
        To be consistent it must have:
 
1054
 
 
1055
         * the same text
 
1056
         * the same direct parents (by name, not index, and disregarding
 
1057
           order)
 
1058
        
 
1059
        If present & correct return True;
 
1060
        if not present in self return False; 
 
1061
        if inconsistent raise error."""
 
1062
        this_idx = self._name_map.get(name, -1)
 
1063
        if this_idx != -1:
 
1064
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
1065
                raise errors.WeaveTextDiffers(name, self, other)
 
1066
            self_parents = self._parents[this_idx]
 
1067
            other_parents = other._parents[other_idx]
 
1068
            n1 = set([self._names[i] for i in self_parents])
 
1069
            n2 = set([other._names[i] for i in other_parents])
 
1070
            if not self._compatible_parents(n1, n2):
 
1071
                raise WeaveParentMismatch("inconsistent parents "
 
1072
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
1073
            else:
 
1074
                return True         # ok!
 
1075
        else:
 
1076
            return False
 
1077
 
 
1078
    @deprecated_method(zero_eight)
 
1079
    def reweave(self, other, pb=None, msg=None):
 
1080
        """reweave has been superseded by plain use of join."""
 
1081
        return self.join(other, pb, msg)
 
1082
 
 
1083
    def _reweave(self, other, pb, msg):
 
1084
        """Reweave self with other - internal helper for join().
 
1085
 
 
1086
        :param other: The other weave to merge
 
1087
        :param pb: An optional progress bar, indicating how far done we are
 
1088
        :param msg: An optional message for the progress
 
1089
        """
 
1090
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
1091
        self._copy_weave_content(new_weave)
 
1092
 
 
1093
    def _copy_weave_content(self, otherweave):
 
1094
        """adsorb the content from otherweave."""
 
1095
        for attr in self.__slots__:
 
1096
            if attr != '_weave_name':
 
1097
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
1098
 
 
1099
 
 
1100
class WeaveFile(Weave):
 
1101
    """A WeaveFile represents a Weave on disk and writes on change."""
 
1102
 
 
1103
    WEAVE_SUFFIX = '.weave'
 
1104
    
 
1105
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
1106
        """Create a WeaveFile.
 
1107
        
 
1108
        :param create: If not True, only open an existing knit.
 
1109
        """
 
1110
        super(WeaveFile, self).__init__(name, access_mode)
 
1111
        self._transport = transport
 
1112
        self._filemode = filemode
 
1113
        try:
 
1114
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
1115
        except errors.NoSuchFile:
 
1116
            if not create:
 
1117
                raise
 
1118
            # new file, save it
 
1119
            self._save()
 
1120
 
 
1121
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
1122
        """Add a version and save the weave."""
 
1123
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
1124
                                                   parent_texts)
 
1125
        self._save()
 
1126
        return result
 
1127
 
 
1128
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1129
        """See VersionedFile.clone_text."""
 
1130
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1131
        self._save
 
1132
 
 
1133
    def copy_to(self, name, transport):
 
1134
        """See VersionedFile.copy_to()."""
 
1135
        # as we are all in memory always, just serialise to the new place.
 
1136
        sio = StringIO()
 
1137
        write_weave_v5(self, sio)
 
1138
        sio.seek(0)
 
1139
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1140
 
 
1141
    def create_empty(self, name, transport, filemode=None):
 
1142
        return WeaveFile(name, transport, filemode, create=True)
 
1143
 
 
1144
    def _save(self):
 
1145
        """Save the weave."""
 
1146
        self._check_write_ok()
 
1147
        sio = StringIO()
 
1148
        write_weave_v5(self, sio)
 
1149
        sio.seek(0)
 
1150
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1151
                                 sio,
 
1152
                                 self._filemode)
 
1153
 
 
1154
    @staticmethod
 
1155
    def get_suffixes():
 
1156
        """See VersionedFile.get_suffixes()."""
 
1157
        return [WeaveFile.WEAVE_SUFFIX]
 
1158
 
 
1159
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1160
             ignore_missing=False):
 
1161
        """Join other into self and save."""
 
1162
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
1163
        self._save()
 
1164
 
 
1165
 
 
1166
@deprecated_function(zero_eight)
 
1167
def reweave(wa, wb, pb=None, msg=None):
 
1168
    """reweaving is deprecation, please just use weave.join()."""
 
1169
    _reweave(wa, wb, pb, msg)
 
1170
 
 
1171
def _reweave(wa, wb, pb=None, msg=None):
 
1172
    """Combine two weaves and return the result.
 
1173
 
 
1174
    This works even if a revision R has different parents in 
 
1175
    wa and wb.  In the resulting weave all the parents are given.
 
1176
 
 
1177
    This is done by just building up a new weave, maintaining ordering 
 
1178
    of the versions in the two inputs.  More efficient approaches
 
1179
    might be possible but it should only be necessary to do 
 
1180
    this operation rarely, when a new previously ghost version is 
 
1181
    inserted.
 
1182
 
 
1183
    :param pb: An optional progress bar, indicating how far done we are
 
1184
    :param msg: An optional message for the progress
 
1185
    """
 
1186
    wr = Weave()
 
1187
    ia = ib = 0
 
1188
    queue_a = range(wa.num_versions())
 
1189
    queue_b = range(wb.num_versions())
 
1190
    # first determine combined parents of all versions
 
1191
    # map from version name -> all parent names
 
1192
    combined_parents = _reweave_parent_graphs(wa, wb)
 
1193
    mutter("combined parents: %r", combined_parents)
 
1194
    order = topo_sort(combined_parents.iteritems())
 
1195
    mutter("order to reweave: %r", order)
 
1196
 
 
1197
    if pb and not msg:
 
1198
        msg = 'reweave'
 
1199
 
 
1200
    for idx, name in enumerate(order):
 
1201
        if pb:
 
1202
            pb.update(msg, idx, len(order))
 
1203
        if name in wa._name_map:
 
1204
            lines = wa.get_lines(name)
 
1205
            if name in wb._name_map:
 
1206
                lines_b = wb.get_lines(name)
 
1207
                if lines != lines_b:
 
1208
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1209
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1210
                    import difflib
 
1211
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1212
                            wa._weave_name, wb._weave_name))
 
1213
                    mutter('lines:\n%s', ''.join(lines))
 
1214
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1215
        else:
 
1216
            lines = wb.get_lines(name)
 
1217
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1218
    return wr
 
1219
 
 
1220
def _reweave_parent_graphs(wa, wb):
 
1221
    """Return combined parent ancestry for two weaves.
 
1222
    
 
1223
    Returned as a list of (version_name, set(parent_names))"""
 
1224
    combined = {}
 
1225
    for weave in [wa, wb]:
 
1226
        for idx, name in enumerate(weave._names):
 
1227
            p = combined.setdefault(name, set())
 
1228
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1229
    return combined
728
1230
 
729
1231
 
730
1232
def weave_toc(w):
733
1235
    for i in (6, 50, 10, 10):
734
1236
        print '-' * i,
735
1237
    print
736
 
    for i in range(w.numversions()):
 
1238
    for i in range(w.num_versions()):
737
1239
        sha1 = w._sha1s[i]
738
1240
        name = w._names[i]
739
1241
        parent_str = ' '.join(map(str, w._parents[i]))
741
1243
 
742
1244
 
743
1245
 
744
 
def weave_stats(weave_file):
745
 
    from bzrlib.progress import ProgressBar
 
1246
def weave_stats(weave_file, pb):
746
1247
    from bzrlib.weavefile import read_weave
747
1248
 
748
 
    pb = ProgressBar()
749
 
 
750
1249
    wf = file(weave_file, 'rb')
751
1250
    w = read_weave(wf)
752
1251
    # FIXME: doesn't work on pipes
756
1255
    vers = len(w)
757
1256
    for i in range(vers):
758
1257
        pb.update('checking sizes', i, vers)
759
 
        for line in w.get_iter(i):
 
1258
        for origin, lineno, line in w._extract([i]):
760
1259
            total += len(line)
761
1260
 
762
1261
    pb.clear()
789
1288
        Add NEWTEXT, with specified parent versions.
790
1289
    weave annotate WEAVEFILE VERSION
791
1290
        Display origin of each line.
792
 
    weave mash WEAVEFILE VERSION...
793
 
        Display composite of all selected versions.
794
1291
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
795
1292
        Auto-merge two versions and display conflicts.
 
1293
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1294
        Show differences between two versions.
796
1295
 
797
1296
example:
798
1297
 
823
1322
def main(argv):
824
1323
    import sys
825
1324
    import os
826
 
    from weavefile import write_weave, read_weave
 
1325
    try:
 
1326
        import bzrlib
 
1327
    except ImportError:
 
1328
        # in case we're run directly from the subdirectory
 
1329
        sys.path.append('..')
 
1330
        import bzrlib
 
1331
    from bzrlib.weavefile import write_weave, read_weave
827
1332
    from bzrlib.progress import ProgressBar
828
1333
 
829
1334
    try:
862
1367
        w = readit()
863
1368
        sys.stdout.writelines(w.get_iter(int(argv[3])))
864
1369
        
865
 
    elif cmd == 'mash': # get composite
 
1370
    elif cmd == 'diff':
866
1371
        w = readit()
867
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
868
 
 
 
1372
        fn = argv[2]
 
1373
        v1, v2 = map(int, argv[3:5])
 
1374
        lines1 = w.get(v1)
 
1375
        lines2 = w.get(v2)
 
1376
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1377
                                '%s version %d' % (fn, v1),
 
1378
                                '%s version %d' % (fn, v2))
 
1379
        sys.stdout.writelines(diff_gen)
 
1380
            
869
1381
    elif cmd == 'annotate':
870
1382
        w = readit()
871
1383
        # newline is added to all lines regardless; too hard to get
883
1395
        weave_toc(readit())
884
1396
 
885
1397
    elif cmd == 'stats':
886
 
        weave_stats(argv[2])
 
1398
        weave_stats(argv[2], ProgressBar())
887
1399
        
888
1400
    elif cmd == 'check':
889
1401
        w = readit()
890
1402
        pb = ProgressBar()
891
1403
        w.check(pb)
892
1404
        pb.clear()
893
 
        print '%d versions ok' % w.numversions()
 
1405
        print '%d versions ok' % w.num_versions()
894
1406
 
895
1407
    elif cmd == 'inclusions':
896
1408
        w = readit()
901
1413
        print ' '.join(map(str, w._parents[int(argv[3])]))
902
1414
 
903
1415
    elif cmd == 'plan-merge':
 
1416
        # replaced by 'bzr weave-plan-merge'
904
1417
        w = readit()
905
1418
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
906
1419
            if line:
907
1420
                print '%14s | %s' % (state, line),
908
 
 
909
1421
    elif cmd == 'merge':
 
1422
        # replaced by 'bzr weave-merge-text'
910
1423
        w = readit()
911
1424
        p = w.plan_merge(int(argv[3]), int(argv[4]))
912
1425
        sys.stdout.writelines(w.weave_merge(p))
913
 
            
914
 
    elif cmd == 'mash-merge':
915
 
        if len(argv) != 5:
916
 
            usage()
917
 
            return 1
918
 
 
919
 
        w = readit()
920
 
        v1, v2 = map(int, argv[3:5])
921
 
 
922
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
923
 
 
924
 
        base_lines = list(w.mash_iter(basis))
925
 
        a_lines = list(w.get(v1))
926
 
        b_lines = list(w.get(v2))
927
 
 
928
 
        from bzrlib.merge3 import Merge3
929
 
        m3 = Merge3(base_lines, a_lines, b_lines)
930
 
 
931
 
        name_a = 'version %d' % v1
932
 
        name_b = 'version %d' % v2
933
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
934
1426
    else:
935
1427
        raise ValueError('unknown command %r' % cmd)
936
1428
    
937
1429
 
938
 
 
939
 
def profile_main(argv): 
940
 
    import tempfile, hotshot, hotshot.stats
941
 
 
942
 
    prof_f = tempfile.NamedTemporaryFile()
943
 
 
944
 
    prof = hotshot.Profile(prof_f.name)
945
 
 
946
 
    ret = prof.runcall(main, argv)
947
 
    prof.close()
948
 
 
949
 
    stats = hotshot.stats.load(prof_f.name)
950
 
    #stats.strip_dirs()
951
 
    stats.sort_stats('cumulative')
952
 
    ## XXX: Might like to write to stderr or the trace file instead but
953
 
    ## print_stats seems hardcoded to stdout
954
 
    stats.print_stats(20)
955
 
            
956
 
    return ret
957
 
 
958
 
 
959
1430
if __name__ == '__main__':
960
1431
    import sys
961
 
    if '--profile' in sys.argv:
962
 
        args = sys.argv[:]
963
 
        args.remove('--profile')
964
 
        sys.exit(profile_main(args))
965
 
    else:
966
 
        sys.exit(main(sys.argv))
967
 
 
 
1432
    sys.exit(main(sys.argv))
 
1433
 
 
1434
 
 
1435
class InterWeave(InterVersionedFile):
 
1436
    """Optimised code paths for weave to weave operations."""
 
1437
    
 
1438
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1439
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1440
    
 
1441
    @staticmethod
 
1442
    def is_compatible(source, target):
 
1443
        """Be compatible with weaves."""
 
1444
        try:
 
1445
            return (isinstance(source, Weave) and
 
1446
                    isinstance(target, Weave))
 
1447
        except AttributeError:
 
1448
            return False
 
1449
 
 
1450
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1451
        """See InterVersionedFile.join."""
 
1452
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1453
        if self.target.versions() == [] and version_ids is None:
 
1454
            self.target._copy_weave_content(self.source)
 
1455
            return
 
1456
        try:
 
1457
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1458
        except errors.WeaveParentMismatch:
 
1459
            self.target._reweave(self.source, pb, msg)
 
1460
 
 
1461
 
 
1462
InterVersionedFile.register_optimiser(InterWeave)