/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-11 00:23:23 UTC
  • mfrom: (2070 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2071.
  • Revision ID: john@arbash-meinel.com-20061011002323-82ba88c293d7caff
[merge] bzr.dev 2070

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
        try:
 
251
            return self._name_map[name]
 
252
        except KeyError:
 
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):
186
461
        """Add a single text on top of the weave.
187
462
  
188
463
        Returns the index number of the newly added version.
189
464
 
 
465
        version_id
 
466
            Symbolic name for this version.
 
467
            (Typically the revision-id of the revision that added it.)
 
468
 
190
469
        parents
191
470
            List or set of direct parent version numbers.
192
471
            
193
 
        text
194
 
            Sequence of lines to be added in the new version."""
 
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)
195
483
 
196
484
        self._check_versions(parents)
197
 
        ## self._check_lines(text)
 
485
        ## self._check_lines(lines)
198
486
        new_version = len(self._parents)
199
487
 
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))
 
488
        # if we abort after here the (in-memory) weave will be corrupt because only
 
489
        # some fields are updated
 
490
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
491
        #      - Robert Collins 20060226
 
492
        self._parents.append(parents[:])
208
493
        self._sha1s.append(sha1)
 
494
        self._names.append(version_id)
 
495
        self._name_map[version_id] = new_version
209
496
 
210
497
            
211
498
        if not parents:
213
500
            # this more quickly by just appending unconditionally.
214
501
            # even more specially, if we're adding an empty text we
215
502
            # need do nothing at all.
216
 
            if text:
 
503
            if lines:
217
504
                self._weave.append(('{', new_version))
218
 
                self._weave.extend(text)
219
 
                self._weave.append(('}', new_version))
220
 
        
 
505
                self._weave.extend(lines)
 
506
                self._weave.append(('}', None))
221
507
            return new_version
222
508
 
223
509
        if len(parents) == 1:
227
513
                return new_version
228
514
            
229
515
 
230
 
        ancestors = self.inclusions(parents)
 
516
        ancestors = self._inclusions(parents)
231
517
 
232
518
        l = self._weave
233
519
 
238
524
            basis_lineno.append(lineno)
239
525
            basis_lines.append(line)
240
526
 
241
 
        # another small special case: a merge, producing the same text as auto-merge
242
 
        if text == basis_lines:
 
527
        # another small special case: a merge, producing the same text
 
528
        # as auto-merge
 
529
        if lines == basis_lines:
243
530
            return new_version            
244
531
 
245
 
        # 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
246
533
        basis_lineno.append(len(self._weave))
247
534
 
248
535
        # XXX: which line of the weave should we really consider
252
539
        #print 'basis_lines:', basis_lines
253
540
        #print 'new_lines:  ', lines
254
541
 
255
 
        from difflib import SequenceMatcher
256
 
        s = SequenceMatcher(None, basis_lines, text)
 
542
        s = self._matcher(None, basis_lines, lines)
257
543
 
258
544
        # offset gives the number of lines that have been inserted
259
545
        # into the weave up to the current point; if the original edit instruction
270
556
            i1 = basis_lineno[i1]
271
557
            i2 = basis_lineno[i2]
272
558
 
273
 
            assert 0 <= j1 <= j2 <= len(text)
 
559
            assert 0 <= j1 <= j2 <= len(lines)
274
560
 
275
561
            #print tag, i1, i2, j1, j2
276
562
 
287
573
                # we don't destroy ourselves
288
574
                i = i2 + offset
289
575
                self._weave[i:i] = ([('{', new_version)] 
290
 
                                + text[j1:j2] 
291
 
                                + [('}', new_version)])
 
576
                                    + lines[j1:j2] 
 
577
                                    + [('}', None)])
292
578
                offset += 2 + (j2 - j1)
293
 
 
294
579
        return new_version
295
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)
296
585
 
297
 
    def inclusions(self, versions):
 
586
    def _inclusions(self, versions):
298
587
        """Return set of all ancestors of given version(s)."""
 
588
        if not len(versions):
 
589
            return []
299
590
        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:
 
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:
316
603
            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
 
 
 
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]
334
615
 
335
616
    def _check_lines(self, text):
336
617
        if not isinstance(text, list):
351
632
            except IndexError:
352
633
                raise IndexError("invalid version number %r" % i)
353
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)
354
656
    
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.
 
657
    def annotate_iter(self, version_id):
 
658
        """Yield list of (version-id, line) pairs for the specified version.
361
659
 
362
660
        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
 
 
 
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)
367
666
    def _walk(self):
368
 
        """Walk the weave.
369
 
 
370
 
        Yields sequence of
371
 
        (lineno, insert, deletes, text)
372
 
        for each literal line.
373
 
        """
 
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."""
374
693
        
375
694
        istack = []
376
695
        dset = set()
378
697
        lineno = 0         # line of weave, 0-based
379
698
 
380
699
        for l in self._weave:
381
 
            if isinstance(l, tuple):
 
700
            if l.__class__ == tuple:
382
701
                c, v = l
383
702
                isactive = None
384
703
                if c == '{':
385
 
                    istack.append(v)
 
704
                    istack.append(self._names[v])
386
705
                elif c == '}':
387
 
                    oldv = istack.pop()
 
706
                    istack.pop()
388
707
                elif c == '[':
389
 
                    assert v not in dset
390
 
                    dset.add(v)
 
708
                    assert self._names[v] not in dset
 
709
                    dset.add(self._names[v])
391
710
                elif c == ']':
392
 
                    dset.remove(v)
 
711
                    dset.remove(self._names[v])
393
712
                else:
394
 
                    raise WeaveFormatError('unexpected instruction %r'
395
 
                                           % v)
 
713
                    raise WeaveFormatError('unexpected instruction %r' % v)
396
714
            else:
397
 
                assert isinstance(l, basestring)
 
715
                assert l.__class__ in (str, unicode)
398
716
                assert istack
399
 
                yield lineno, istack[-1], dset, l
 
717
                yield lineno, istack[-1], frozenset(dset), l
400
718
            lineno += 1
401
719
 
402
 
 
 
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
403
773
 
404
774
    def _extract(self, versions):
405
775
        """Yield annotation of lines in included set.
410
780
 
411
781
        The set typically but not necessarily corresponds to a version.
412
782
        """
413
 
        included = self.inclusions(versions)
 
783
        for i in versions:
 
784
            if not isinstance(i, int):
 
785
                raise ValueError(i)
 
786
            
 
787
        included = self._inclusions(versions)
414
788
 
415
789
        istack = []
 
790
        iset = set()
416
791
        dset = set()
417
792
 
418
793
        lineno = 0         # line of weave, 0-based
423
798
 
424
799
        WFE = WeaveFormatError
425
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
 
426
828
        for l in self._weave:
427
 
            if isinstance(l, tuple):
 
829
            if l.__class__ == tuple:
428
830
                c, v = l
429
831
                isactive = None
430
832
                if c == '{':
431
 
                    assert v not in istack
 
833
                    assert v not in iset
432
834
                    istack.append(v)
 
835
                    iset.add(v)
433
836
                elif c == '}':
434
 
                    oldv = istack.pop()
435
 
                    assert oldv == v
 
837
                    iset.remove(istack.pop())
436
838
                elif c == '[':
437
839
                    if v in included:
438
840
                        assert v not in dset
443
845
                        assert v in dset
444
846
                        dset.remove(v)
445
847
            else:
446
 
                assert isinstance(l, basestring)
 
848
                assert l.__class__ in (str, unicode)
447
849
                if isactive is None:
448
850
                    isactive = (not dset) and istack and (istack[-1] in included)
449
851
                if isactive:
450
852
                    result.append((istack[-1], lineno, l))
451
853
            lineno += 1
452
 
 
453
854
        if istack:
454
 
            raise WFE("unclosed insertion blocks at end of weave",
455
 
                                   istack)
 
855
            raise WeaveFormatError("unclosed insertion blocks "
 
856
                    "at end of weave: %s" % istack)
456
857
        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
 
 
 
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)
489
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?"""
490
917
        l = len(self._parents)
491
918
        assert l == len(self._sha1s)
492
919
        return l
493
920
 
494
 
 
495
 
    def __len__(self):
496
 
        return self.numversions()
497
 
 
 
921
    __len__ = num_versions
498
922
 
499
923
    def check(self, progress_bar=None):
500
 
        # check no circular inclusions
501
 
        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()):
502
928
            inclusions = list(self._parents[version])
503
929
            if inclusions:
504
930
                inclusions.sort()
506
932
                    raise WeaveFormatError("invalid included version %d for index %d"
507
933
                                           % (inclusions[-1], version))
508
934
 
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):
 
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():
514
963
            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]
 
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]
521
977
            if hd != expected:
522
 
                raise WeaveError("mismatched sha1 for version %d; "
523
 
                                 "got %s, expected %s"
524
 
                                 % (version, hd, expected))
 
978
                raise errors.WeaveInvalidChecksum(
 
979
                        "mismatched sha1 for version %s: "
 
980
                        "got %s, expected %s"
 
981
                        % (version, hd, expected))
525
982
 
526
983
        # TODO: check insertions are properly nested, that there are
527
984
        # no lines outside of insertion blocks, that deletions are
528
985
        # properly paired, etc.
529
986
 
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):
 
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
 
1230
 
 
1231
 
 
1232
def weave_toc(w):
 
1233
    """Show the weave's table-of-contents"""
 
1234
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1235
    for i in (6, 50, 10, 10):
677
1236
        print '-' * i,
678
1237
    print
679
 
    for i in range(w.numversions()):
 
1238
    for i in range(w.num_versions()):
680
1239
        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
 
1240
        name = w._names[i]
 
1241
        parent_str = ' '.join(map(str, w._parents[i]))
 
1242
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1243
 
 
1244
 
 
1245
 
 
1246
def weave_stats(weave_file, pb):
687
1247
    from bzrlib.weavefile import read_weave
688
1248
 
689
 
    pb = ProgressBar()
690
 
 
691
1249
    wf = file(weave_file, 'rb')
692
1250
    w = read_weave(wf)
693
1251
    # FIXME: doesn't work on pipes
697
1255
    vers = len(w)
698
1256
    for i in range(vers):
699
1257
        pb.update('checking sizes', i, vers)
700
 
        for line in w.get_iter(i):
 
1258
        for origin, lineno, line in w._extract([i]):
701
1259
            total += len(line)
702
1260
 
703
1261
    pb.clear()
706
1264
    print 'weave file        %9d bytes' % weave_size
707
1265
    print 'total contents    %9d bytes' % total
708
1266
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
709
 
 
 
1267
    if vers:
 
1268
        avg = total/vers
 
1269
        print 'average size      %9d bytes' % avg
 
1270
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
710
1271
 
711
1272
 
712
1273
def usage():
721
1282
        Write out specified version.
722
1283
    weave check WEAVEFILE
723
1284
        Check consistency of all versions.
724
 
    weave info WEAVEFILE
 
1285
    weave toc WEAVEFILE
725
1286
        Display table of contents.
726
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
1287
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
727
1288
        Add NEWTEXT, with specified parent versions.
728
1289
    weave annotate WEAVEFILE VERSION
729
1290
        Display origin of each line.
730
 
    weave mash WEAVEFILE VERSION...
731
 
        Display composite of all selected versions.
732
1291
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
733
1292
        Auto-merge two versions and display conflicts.
 
1293
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1294
        Show differences between two versions.
734
1295
 
735
1296
example:
736
1297
 
737
1298
    % weave init foo.weave
738
1299
    % vi foo.txt
739
 
    % weave add foo.weave < foo.txt
 
1300
    % weave add foo.weave ver0 < foo.txt
740
1301
    added version 0
741
1302
 
742
1303
    (create updated version)
743
1304
    % vi foo.txt
744
1305
    % weave get foo.weave 0 | diff -u - foo.txt
745
 
    % weave add foo.weave 0 < foo.txt
 
1306
    % weave add foo.weave ver1 0 < foo.txt
746
1307
    added version 1
747
1308
 
748
1309
    % weave get foo.weave 0 > foo.txt       (create forked version)
749
1310
    % vi foo.txt
750
 
    % weave add foo.weave 0 < foo.txt
 
1311
    % weave add foo.weave ver2 0 < foo.txt
751
1312
    added version 2
752
1313
 
753
1314
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
754
1315
    % vi foo.txt                            (resolve conflicts)
755
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
1316
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
756
1317
    
757
1318
"""
758
1319
    
761
1322
def main(argv):
762
1323
    import sys
763
1324
    import os
764
 
    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
765
1332
    from bzrlib.progress import ProgressBar
766
1333
 
767
 
    #import psyco
768
 
    #psyco.full()
 
1334
    try:
 
1335
        import psyco
 
1336
        psyco.full()
 
1337
    except ImportError:
 
1338
        pass
 
1339
 
 
1340
    if len(argv) < 2:
 
1341
        usage()
 
1342
        return 0
769
1343
 
770
1344
    cmd = argv[1]
771
1345
 
777
1351
    elif cmd == 'add':
778
1352
        w = readit()
779
1353
        # at the moment, based on everything in the file
780
 
        parents = map(int, argv[3:])
 
1354
        name = argv[3]
 
1355
        parents = map(int, argv[4:])
781
1356
        lines = sys.stdin.readlines()
782
 
        ver = w.add(parents, lines)
 
1357
        ver = w.add(name, parents, lines)
783
1358
        write_weave(w, file(argv[2], 'wb'))
784
 
        print 'added version %d' % ver
 
1359
        print 'added version %r %d' % (name, ver)
785
1360
    elif cmd == 'init':
786
1361
        fn = argv[2]
787
1362
        if os.path.exists(fn):
792
1367
        w = readit()
793
1368
        sys.stdout.writelines(w.get_iter(int(argv[3])))
794
1369
        
795
 
    elif cmd == 'mash': # get composite
 
1370
    elif cmd == 'diff':
796
1371
        w = readit()
797
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
798
 
 
 
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
            
799
1381
    elif cmd == 'annotate':
800
1382
        w = readit()
801
1383
        # newline is added to all lines regardless; too hard to get
809
1391
                print '%5d | %s' % (origin, text)
810
1392
                lasto = origin
811
1393
                
812
 
    elif cmd == 'info':
813
 
        weave_info(readit())
 
1394
    elif cmd == 'toc':
 
1395
        weave_toc(readit())
814
1396
 
815
1397
    elif cmd == 'stats':
816
 
        weave_stats(argv[2])
 
1398
        weave_stats(argv[2], ProgressBar())
817
1399
        
818
1400
    elif cmd == 'check':
819
1401
        w = readit()
820
1402
        pb = ProgressBar()
821
1403
        w.check(pb)
822
1404
        pb.clear()
823
 
        print '%d versions ok' % w.numversions()
 
1405
        print '%d versions ok' % w.num_versions()
824
1406
 
825
1407
    elif cmd == 'inclusions':
826
1408
        w = readit()
831
1413
        print ' '.join(map(str, w._parents[int(argv[3])]))
832
1414
 
833
1415
    elif cmd == 'plan-merge':
 
1416
        # replaced by 'bzr weave-plan-merge'
834
1417
        w = readit()
835
1418
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
836
1419
            if line:
837
1420
                print '%14s | %s' % (state, line),
838
 
 
839
1421
    elif cmd == 'merge':
 
1422
        # replaced by 'bzr weave-merge-text'
840
1423
        w = readit()
841
1424
        p = w.plan_merge(int(argv[3]), int(argv[4]))
842
1425
        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
1426
    else:
865
1427
        raise ValueError('unknown command %r' % cmd)
866
1428
    
868
1430
if __name__ == '__main__':
869
1431
    import sys
870
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)