← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Martin Pool
  • Date: 2007-04-04 01:22:11 UTC
  • mfrom: (2393.1.1 bzr.docs)
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404012211-sq269me6bai9m6xk
merge trunk and doc fix from elliot

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