/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: Aaron Bentley
  • Date: 2007-08-17 13:47:21 UTC
  • mto: (1551.19.24 Aaron's mergeable stuff)
  • mto: This revision was merged to the branch mainline in revision 2725.
  • Revision ID: abentley@panoramicfeedback.com-20070817134721-2urlrk8nqt19jvom
Add support for diff -p-style diffs to patch parser

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
                   left_matching_blocks=None):
 
454
        """See VersionedFile.add_lines."""
 
455
        return self._add(version_id, lines, map(self._lookup, parents))
 
456
 
 
457
    @deprecated_method(zero_eight)
 
458
    def add(self, name, parents, text, sha1=None):
 
459
        """See VersionedFile.add_lines for the non deprecated api."""
 
460
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
 
461
 
 
462
    def _add(self, version_id, lines, parents, sha1=None):
186
463
        """Add a single text on top of the weave.
187
464
  
188
465
        Returns the index number of the newly added version.
189
466
 
 
467
        version_id
 
468
            Symbolic name for this version.
 
469
            (Typically the revision-id of the revision that added it.)
 
470
 
190
471
        parents
191
472
            List or set of direct parent version numbers.
192
473
            
193
 
        text
194
 
            Sequence of lines to be added in the new version."""
 
474
        lines
 
475
            Sequence of lines to be added in the new version.
 
476
        """
 
477
 
 
478
        assert isinstance(version_id, basestring)
 
479
        self._check_lines_not_unicode(lines)
 
480
        self._check_lines_are_lines(lines)
 
481
        if not sha1:
 
482
            sha1 = sha_strings(lines)
 
483
        if version_id in self._name_map:
 
484
            return self._check_repeated_add(version_id, parents, lines, sha1)
195
485
 
196
486
        self._check_versions(parents)
197
 
        ## self._check_lines(text)
 
487
        ## self._check_lines(lines)
198
488
        new_version = len(self._parents)
199
489
 
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))
 
490
        # if we abort after here the (in-memory) weave will be corrupt because only
 
491
        # some fields are updated
 
492
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
493
        #      - Robert Collins 20060226
 
494
        self._parents.append(parents[:])
208
495
        self._sha1s.append(sha1)
 
496
        self._names.append(version_id)
 
497
        self._name_map[version_id] = new_version
209
498
 
210
499
            
211
500
        if not parents:
213
502
            # this more quickly by just appending unconditionally.
214
503
            # even more specially, if we're adding an empty text we
215
504
            # need do nothing at all.
216
 
            if text:
 
505
            if lines:
217
506
                self._weave.append(('{', new_version))
218
 
                self._weave.extend(text)
219
 
                self._weave.append(('}', new_version))
220
 
        
 
507
                self._weave.extend(lines)
 
508
                self._weave.append(('}', None))
221
509
            return new_version
222
510
 
223
511
        if len(parents) == 1:
227
515
                return new_version
228
516
            
229
517
 
230
 
        ancestors = self.inclusions(parents)
 
518
        ancestors = self._inclusions(parents)
231
519
 
232
520
        l = self._weave
233
521
 
238
526
            basis_lineno.append(lineno)
239
527
            basis_lines.append(line)
240
528
 
241
 
        # another small special case: a merge, producing the same text as auto-merge
242
 
        if text == basis_lines:
 
529
        # another small special case: a merge, producing the same text
 
530
        # as auto-merge
 
531
        if lines == basis_lines:
243
532
            return new_version            
244
533
 
245
 
        # add a sentinal, because we can also match against the final line
 
534
        # add a sentinel, because we can also match against the final line
246
535
        basis_lineno.append(len(self._weave))
247
536
 
248
537
        # XXX: which line of the weave should we really consider
252
541
        #print 'basis_lines:', basis_lines
253
542
        #print 'new_lines:  ', lines
254
543
 
255
 
        from difflib import SequenceMatcher
256
 
        s = SequenceMatcher(None, basis_lines, text)
 
544
        s = self._matcher(None, basis_lines, lines)
257
545
 
258
546
        # offset gives the number of lines that have been inserted
259
547
        # into the weave up to the current point; if the original edit instruction
270
558
            i1 = basis_lineno[i1]
271
559
            i2 = basis_lineno[i2]
272
560
 
273
 
            assert 0 <= j1 <= j2 <= len(text)
 
561
            assert 0 <= j1 <= j2 <= len(lines)
274
562
 
275
563
            #print tag, i1, i2, j1, j2
276
564
 
287
575
                # we don't destroy ourselves
288
576
                i = i2 + offset
289
577
                self._weave[i:i] = ([('{', new_version)] 
290
 
                                + text[j1:j2] 
291
 
                                + [('}', new_version)])
 
578
                                    + lines[j1:j2] 
 
579
                                    + [('}', None)])
292
580
                offset += 2 + (j2 - j1)
293
 
 
294
581
        return new_version
295
582
 
 
583
    def _clone_text(self, new_version_id, old_version_id, parents):
 
584
        """See VersionedFile.clone_text."""
 
585
        old_lines = self.get_text(old_version_id)
 
586
        self.add_lines(new_version_id, parents, old_lines)
296
587
 
297
 
    def inclusions(self, versions):
 
588
    def _inclusions(self, versions):
298
589
        """Return set of all ancestors of given version(s)."""
 
590
        if not len(versions):
 
591
            return []
299
592
        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:
 
593
        for v in xrange(max(versions), 0, -1):
 
594
            if v in i:
 
595
                # include all its parents
 
596
                i.update(self._parents[v])
 
597
        return i
 
598
        ## except IndexError:
 
599
        ##     raise ValueError("version %d not present in weave" % v)
 
600
 
 
601
    @deprecated_method(zero_eight)
 
602
    def inclusions(self, version_ids):
 
603
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
 
604
        if not version_ids:
316
605
            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
 
 
 
606
        if isinstance(version_ids[0], int):
 
607
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
 
608
        else:
 
609
            return self.get_ancestry(version_ids)
 
610
 
 
611
    def get_ancestry(self, version_ids, topo_sorted=True):
 
612
        """See VersionedFile.get_ancestry."""
 
613
        if isinstance(version_ids, basestring):
 
614
            version_ids = [version_ids]
 
615
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
616
        return [self._idx_to_name(v) for v in i]
334
617
 
335
618
    def _check_lines(self, text):
336
619
        if not isinstance(text, list):
351
634
            except IndexError:
352
635
                raise IndexError("invalid version number %r" % i)
353
636
 
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.
 
637
    def _compatible_parents(self, my_parents, other_parents):
 
638
        """During join check that other_parents are joinable with my_parents.
 
639
 
 
640
        Joinable is defined as 'is a subset of' - supersets may require 
 
641
        regeneration of diffs, but subsets do not.
 
642
        """
 
643
        return len(other_parents.difference(my_parents)) == 0
 
644
 
 
645
    def annotate_iter(self, version_id):
 
646
        """Yield list of (version-id, line) pairs for the specified version.
361
647
 
362
648
        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
 
 
 
649
        incls = [self._lookup(version_id)]
 
650
        for origin, lineno, text in self._extract(incls):
 
651
            yield self._idx_to_name(origin), text
 
652
 
 
653
    @deprecated_method(zero_eight)
367
654
    def _walk(self):
368
 
        """Walk the weave.
369
 
 
370
 
        Yields sequence of
371
 
        (lineno, insert, deletes, text)
372
 
        for each literal line.
373
 
        """
 
655
        """_walk has become visit, a supported api."""
 
656
        return self._walk_internal()
 
657
 
 
658
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
659
                                                pb=None):
 
660
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
661
        if version_ids is None:
 
662
            version_ids = self.versions()
 
663
        version_ids = set(version_ids)
 
664
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
665
            # if inserted not in version_ids then it was inserted before the
 
666
            # versions we care about, but because weaves cannot represent ghosts
 
667
            # properly, we do not filter down to that
 
668
            # if inserted not in version_ids: continue
 
669
            if line[-1] != '\n':
 
670
                yield line + '\n'
 
671
            else:
 
672
                yield line
 
673
 
 
674
    #@deprecated_method(zero_eight)
 
675
    def walk(self, version_ids=None):
 
676
        """See VersionedFile.walk."""
 
677
        return self._walk_internal(version_ids)
 
678
 
 
679
    def _walk_internal(self, version_ids=None):
 
680
        """Helper method for weave actions."""
374
681
        
375
682
        istack = []
376
683
        dset = set()
378
685
        lineno = 0         # line of weave, 0-based
379
686
 
380
687
        for l in self._weave:
381
 
            if isinstance(l, tuple):
 
688
            if l.__class__ == tuple:
382
689
                c, v = l
383
690
                isactive = None
384
691
                if c == '{':
385
 
                    istack.append(v)
 
692
                    istack.append(self._names[v])
386
693
                elif c == '}':
387
 
                    oldv = istack.pop()
 
694
                    istack.pop()
388
695
                elif c == '[':
389
 
                    assert v not in dset
390
 
                    dset.add(v)
 
696
                    assert self._names[v] not in dset
 
697
                    dset.add(self._names[v])
391
698
                elif c == ']':
392
 
                    dset.remove(v)
 
699
                    dset.remove(self._names[v])
393
700
                else:
394
 
                    raise WeaveFormatError('unexpected instruction %r'
395
 
                                           % v)
 
701
                    raise WeaveFormatError('unexpected instruction %r' % v)
396
702
            else:
397
 
                assert isinstance(l, basestring)
 
703
                assert l.__class__ in (str, unicode)
398
704
                assert istack
399
 
                yield lineno, istack[-1], dset, l
 
705
                yield lineno, istack[-1], frozenset(dset), l
400
706
            lineno += 1
401
707
 
402
 
 
 
708
        if istack:
 
709
            raise WeaveFormatError("unclosed insertion blocks "
 
710
                    "at end of weave: %s" % istack)
 
711
        if dset:
 
712
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
713
                                   % dset)
 
714
 
 
715
    def plan_merge(self, ver_a, ver_b):
 
716
        """Return pseudo-annotation indicating how the two versions merge.
 
717
 
 
718
        This is computed between versions a and b and their common
 
719
        base.
 
720
 
 
721
        Weave lines present in none of them are skipped entirely.
 
722
        """
 
723
        inc_a = set(self.get_ancestry([ver_a]))
 
724
        inc_b = set(self.get_ancestry([ver_b]))
 
725
        inc_c = inc_a & inc_b
 
726
 
 
727
        for lineno, insert, deleteset, line in\
 
728
            self.walk([ver_a, ver_b]):
 
729
            if deleteset & inc_c:
 
730
                # killed in parent; can't be in either a or b
 
731
                # not relevant to our work
 
732
                yield 'killed-base', line
 
733
            elif insert in inc_c:
 
734
                # was inserted in base
 
735
                killed_a = bool(deleteset & inc_a)
 
736
                killed_b = bool(deleteset & inc_b)
 
737
                if killed_a and killed_b:
 
738
                    yield 'killed-both', line
 
739
                elif killed_a:
 
740
                    yield 'killed-a', line
 
741
                elif killed_b:
 
742
                    yield 'killed-b', line
 
743
                else:
 
744
                    yield 'unchanged', line
 
745
            elif insert in inc_a:
 
746
                if deleteset & inc_a:
 
747
                    yield 'ghost-a', line
 
748
                else:
 
749
                    # new in A; not in B
 
750
                    yield 'new-a', line
 
751
            elif insert in inc_b:
 
752
                if deleteset & inc_b:
 
753
                    yield 'ghost-b', line
 
754
                else:
 
755
                    yield 'new-b', line
 
756
            else:
 
757
                # not in either revision
 
758
                yield 'irrelevant', line
 
759
 
 
760
        yield 'unchanged', ''           # terminator
403
761
 
404
762
    def _extract(self, versions):
405
763
        """Yield annotation of lines in included set.
410
768
 
411
769
        The set typically but not necessarily corresponds to a version.
412
770
        """
413
 
        included = self.inclusions(versions)
 
771
        for i in versions:
 
772
            if not isinstance(i, int):
 
773
                raise ValueError(i)
 
774
            
 
775
        included = self._inclusions(versions)
414
776
 
415
777
        istack = []
 
778
        iset = set()
416
779
        dset = set()
417
780
 
418
781
        lineno = 0         # line of weave, 0-based
423
786
 
424
787
        WFE = WeaveFormatError
425
788
 
 
789
        # wow. 
 
790
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
791
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
792
        # 1.6 seconds in 'isinstance'.
 
793
        # changing the first isinstance:
 
794
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
795
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
796
        # note that the inline time actually dropped (less function calls)
 
797
        # and total processing time was halved.
 
798
        # we're still spending ~1/4 of the method in isinstance though.
 
799
        # so lets hard code the acceptable string classes we expect:
 
800
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
801
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
802
        #                                          objects>
 
803
        # yay, down to ~1/4 the initial extract time, and our inline time
 
804
        # has shrunk again, with isinstance no longer dominating.
 
805
        # tweaking the stack inclusion test to use a set gives:
 
806
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
807
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
808
        #                                          objects>
 
809
        # - a 5% win, or possibly just noise. However with large istacks that
 
810
        # 'in' test could dominate, so I'm leaving this change in place -
 
811
        # when its fast enough to consider profiling big datasets we can review.
 
812
 
 
813
              
 
814
             
 
815
 
426
816
        for l in self._weave:
427
 
            if isinstance(l, tuple):
 
817
            if l.__class__ == tuple:
428
818
                c, v = l
429
819
                isactive = None
430
820
                if c == '{':
431
 
                    assert v not in istack
 
821
                    assert v not in iset
432
822
                    istack.append(v)
 
823
                    iset.add(v)
433
824
                elif c == '}':
434
 
                    oldv = istack.pop()
435
 
                    assert oldv == v
 
825
                    iset.remove(istack.pop())
436
826
                elif c == '[':
437
827
                    if v in included:
438
828
                        assert v not in dset
443
833
                        assert v in dset
444
834
                        dset.remove(v)
445
835
            else:
446
 
                assert isinstance(l, basestring)
 
836
                assert l.__class__ in (str, unicode)
447
837
                if isactive is None:
448
838
                    isactive = (not dset) and istack and (istack[-1] in included)
449
839
                if isactive:
450
840
                    result.append((istack[-1], lineno, l))
451
841
            lineno += 1
452
 
 
453
842
        if istack:
454
 
            raise WFE("unclosed insertion blocks at end of weave",
455
 
                                   istack)
 
843
            raise WeaveFormatError("unclosed insertion blocks "
 
844
                    "at end of weave: %s" % istack)
456
845
        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
 
 
 
846
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
847
                                   % dset)
 
848
        return result
 
849
 
 
850
    @deprecated_method(zero_eight)
 
851
    def get_iter(self, name_or_index):
 
852
        """Deprecated, please do not use. Lookups are not not needed.
 
853
        
 
854
        Please use get_lines now.
 
855
        """
 
856
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
857
 
 
858
    @deprecated_method(zero_eight)
 
859
    def maybe_lookup(self, name_or_index):
 
860
        """Deprecated, please do not use. Lookups are not not needed."""
 
861
        return self._maybe_lookup(name_or_index)
 
862
 
 
863
    def _maybe_lookup(self, name_or_index):
 
864
        """Convert possible symbolic name to index, or pass through indexes.
 
865
        
 
866
        NOT FOR PUBLIC USE.
 
867
        """
 
868
        if isinstance(name_or_index, (int, long)):
 
869
            return name_or_index
 
870
        else:
 
871
            return self._lookup(name_or_index)
 
872
 
 
873
    @deprecated_method(zero_eight)
 
874
    def get(self, version_id):
 
875
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
876
        return self.get_lines(version_id)
 
877
 
 
878
    def get_lines(self, version_id):
 
879
        """See VersionedFile.get_lines()."""
 
880
        int_index = self._maybe_lookup(version_id)
 
881
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
882
        expected_sha1 = self._sha1s[int_index]
 
883
        measured_sha1 = sha_strings(result)
 
884
        if measured_sha1 != expected_sha1:
 
885
            raise errors.WeaveInvalidChecksum(
 
886
                    'file %s, revision %s, expected: %s, measured %s' 
 
887
                    % (self._weave_name, version_id,
 
888
                       expected_sha1, measured_sha1))
 
889
        return result
 
890
 
 
891
    def get_sha1(self, version_id):
 
892
        """See VersionedFile.get_sha1()."""
 
893
        return self._sha1s[self._lookup(version_id)]
 
894
 
 
895
    def get_sha1s(self, version_ids):
 
896
        """See VersionedFile.get_sha1s()."""
 
897
        return [self._sha1s[self._lookup(v)] for v in version_ids]
 
898
 
 
899
    @deprecated_method(zero_eight)
489
900
    def numversions(self):
 
901
        """How many versions are in this weave?
 
902
 
 
903
        Deprecated in favour of num_versions.
 
904
        """
 
905
        return self.num_versions()
 
906
 
 
907
    def num_versions(self):
 
908
        """How many versions are in this weave?"""
490
909
        l = len(self._parents)
491
910
        assert l == len(self._sha1s)
492
911
        return l
493
912
 
494
 
 
495
 
    def __len__(self):
496
 
        return self.numversions()
497
 
 
 
913
    __len__ = num_versions
498
914
 
499
915
    def check(self, progress_bar=None):
500
 
        # check no circular inclusions
501
 
        for version in range(self.numversions()):
 
916
        # TODO evaluate performance hit of using string sets in this routine.
 
917
        # TODO: check no circular inclusions
 
918
        # TODO: create a nested progress bar
 
919
        for version in range(self.num_versions()):
502
920
            inclusions = list(self._parents[version])
503
921
            if inclusions:
504
922
                inclusions.sort()
506
924
                    raise WeaveFormatError("invalid included version %d for index %d"
507
925
                                           % (inclusions[-1], version))
508
926
 
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):
 
927
        # try extracting all versions; parallel extraction is used
 
928
        nv = self.num_versions()
 
929
        sha1s = {}
 
930
        texts = {}
 
931
        inclusions = {}
 
932
        for i in range(nv):
 
933
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
934
            # The problem is that set membership is much more expensive
 
935
            name = self._idx_to_name(i)
 
936
            sha1s[name] = sha.new()
 
937
            texts[name] = []
 
938
            new_inc = set([name])
 
939
            for p in self._parents[i]:
 
940
                new_inc.update(inclusions[self._idx_to_name(p)])
 
941
 
 
942
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
943
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
944
            inclusions[name] = new_inc
 
945
 
 
946
        nlines = len(self._weave)
 
947
 
 
948
        update_text = 'checking weave'
 
949
        if self._weave_name:
 
950
            short_name = os.path.basename(self._weave_name)
 
951
            update_text = 'checking %s' % (short_name,)
 
952
            update_text = update_text[:25]
 
953
 
 
954
        for lineno, insert, deleteset, line in self._walk_internal():
514
955
            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]
 
956
                progress_bar.update(update_text, lineno, nlines)
 
957
 
 
958
            for name, name_inclusions in inclusions.items():
 
959
                # The active inclusion must be an ancestor,
 
960
                # and no ancestors must have deleted this line,
 
961
                # because we don't support resurrection.
 
962
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
963
                    sha1s[name].update(line)
 
964
 
 
965
        for i in range(nv):
 
966
            version = self._idx_to_name(i)
 
967
            hd = sha1s[version].hexdigest()
 
968
            expected = self._sha1s[i]
521
969
            if hd != expected:
522
 
                raise WeaveError("mismatched sha1 for version %d; "
523
 
                                 "got %s, expected %s"
524
 
                                 % (version, hd, expected))
 
970
                raise errors.WeaveInvalidChecksum(
 
971
                        "mismatched sha1 for version %s: "
 
972
                        "got %s, expected %s"
 
973
                        % (version, hd, expected))
525
974
 
526
975
        # TODO: check insertions are properly nested, that there are
527
976
        # no lines outside of insertion blocks, that deletions are
528
977
        # properly paired, etc.
529
978
 
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):
 
979
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
980
        """Worker routine for join()."""
 
981
        if not other.versions():
 
982
            return          # nothing to update, easy
 
983
 
 
984
        if not version_ids:
 
985
            # versions is never none, InterWeave checks this.
 
986
            return 0
 
987
 
 
988
        # two loops so that we do not change ourselves before verifying it
 
989
        # will be ok
 
990
        # work through in index order to make sure we get all dependencies
 
991
        names_to_join = []
 
992
        processed = 0
 
993
        # get the selected versions only that are in other.versions.
 
994
        version_ids = set(other.versions()).intersection(set(version_ids))
 
995
        # pull in the referenced graph.
 
996
        version_ids = other.get_ancestry(version_ids)
 
997
        pending_graph = [(version, other.get_parents(version)) for
 
998
                         version in version_ids]
 
999
        for name in topo_sort(pending_graph):
 
1000
            other_idx = other._name_map[name]
 
1001
            # returns True if we have it, False if we need it.
 
1002
            if not self._check_version_consistent(other, other_idx, name):
 
1003
                names_to_join.append((other_idx, name))
 
1004
            processed += 1
 
1005
 
 
1006
 
 
1007
        if pb and not msg:
 
1008
            msg = 'weave join'
 
1009
 
 
1010
        merged = 0
 
1011
        time0 = time.time()
 
1012
        for other_idx, name in names_to_join:
 
1013
            # TODO: If all the parents of the other version are already
 
1014
            # present then we can avoid some work by just taking the delta
 
1015
            # and adjusting the offsets.
 
1016
            new_parents = self._imported_parents(other, other_idx)
 
1017
            sha1 = other._sha1s[other_idx]
 
1018
 
 
1019
            merged += 1
 
1020
 
 
1021
            if pb:
 
1022
                pb.update(msg, merged, len(names_to_join))
 
1023
           
 
1024
            lines = other.get_lines(other_idx)
 
1025
            self._add(name, lines, new_parents, sha1)
 
1026
 
 
1027
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
1028
                merged, processed, self._weave_name, time.time()-time0))
 
1029
 
 
1030
    def _imported_parents(self, other, other_idx):
 
1031
        """Return list of parents in self corresponding to indexes in other."""
 
1032
        new_parents = []
 
1033
        for parent_idx in other._parents[other_idx]:
 
1034
            parent_name = other._names[parent_idx]
 
1035
            if parent_name not in self._name_map:
 
1036
                # should not be possible
 
1037
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
1038
                                 % (parent_name, other._name_map[other_idx], self))
 
1039
            new_parents.append(self._name_map[parent_name])
 
1040
        return new_parents
 
1041
 
 
1042
    def _check_version_consistent(self, other, other_idx, name):
 
1043
        """Check if a version in consistent in this and other.
 
1044
 
 
1045
        To be consistent it must have:
 
1046
 
 
1047
         * the same text
 
1048
         * the same direct parents (by name, not index, and disregarding
 
1049
           order)
 
1050
        
 
1051
        If present & correct return True;
 
1052
        if not present in self return False; 
 
1053
        if inconsistent raise error."""
 
1054
        this_idx = self._name_map.get(name, -1)
 
1055
        if this_idx != -1:
 
1056
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
1057
                raise errors.WeaveTextDiffers(name, self, other)
 
1058
            self_parents = self._parents[this_idx]
 
1059
            other_parents = other._parents[other_idx]
 
1060
            n1 = set([self._names[i] for i in self_parents])
 
1061
            n2 = set([other._names[i] for i in other_parents])
 
1062
            if not self._compatible_parents(n1, n2):
 
1063
                raise WeaveParentMismatch("inconsistent parents "
 
1064
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
1065
            else:
 
1066
                return True         # ok!
 
1067
        else:
 
1068
            return False
 
1069
 
 
1070
    @deprecated_method(zero_eight)
 
1071
    def reweave(self, other, pb=None, msg=None):
 
1072
        """reweave has been superseded by plain use of join."""
 
1073
        return self.join(other, pb, msg)
 
1074
 
 
1075
    def _reweave(self, other, pb, msg):
 
1076
        """Reweave self with other - internal helper for join().
 
1077
 
 
1078
        :param other: The other weave to merge
 
1079
        :param pb: An optional progress bar, indicating how far done we are
 
1080
        :param msg: An optional message for the progress
 
1081
        """
 
1082
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
1083
        self._copy_weave_content(new_weave)
 
1084
 
 
1085
    def _copy_weave_content(self, otherweave):
 
1086
        """adsorb the content from otherweave."""
 
1087
        for attr in self.__slots__:
 
1088
            if attr != '_weave_name':
 
1089
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
1090
 
 
1091
 
 
1092
class WeaveFile(Weave):
 
1093
    """A WeaveFile represents a Weave on disk and writes on change."""
 
1094
 
 
1095
    WEAVE_SUFFIX = '.weave'
 
1096
    
 
1097
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
1098
        """Create a WeaveFile.
 
1099
        
 
1100
        :param create: If not True, only open an existing knit.
 
1101
        """
 
1102
        super(WeaveFile, self).__init__(name, access_mode)
 
1103
        self._transport = transport
 
1104
        self._filemode = filemode
 
1105
        try:
 
1106
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
1107
        except errors.NoSuchFile:
 
1108
            if not create:
 
1109
                raise
 
1110
            # new file, save it
 
1111
            self._save()
 
1112
 
 
1113
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
1114
        left_matching_blocks=None):
 
1115
        """Add a version and save the weave."""
 
1116
        self.check_not_reserved_id(version_id)
 
1117
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
1118
                                                   parent_texts)
 
1119
        self._save()
 
1120
        return result
 
1121
 
 
1122
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1123
        """See VersionedFile.clone_text."""
 
1124
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1125
        self._save
 
1126
 
 
1127
    def copy_to(self, name, transport):
 
1128
        """See VersionedFile.copy_to()."""
 
1129
        # as we are all in memory always, just serialise to the new place.
 
1130
        sio = StringIO()
 
1131
        write_weave_v5(self, sio)
 
1132
        sio.seek(0)
 
1133
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1134
 
 
1135
    def create_empty(self, name, transport, filemode=None):
 
1136
        return WeaveFile(name, transport, filemode, create=True)
 
1137
 
 
1138
    def _save(self):
 
1139
        """Save the weave."""
 
1140
        self._check_write_ok()
 
1141
        sio = StringIO()
 
1142
        write_weave_v5(self, sio)
 
1143
        sio.seek(0)
 
1144
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1145
                                 sio,
 
1146
                                 self._filemode)
 
1147
 
 
1148
    @staticmethod
 
1149
    def get_suffixes():
 
1150
        """See VersionedFile.get_suffixes()."""
 
1151
        return [WeaveFile.WEAVE_SUFFIX]
 
1152
 
 
1153
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1154
             ignore_missing=False):
 
1155
        """Join other into self and save."""
 
1156
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
1157
        self._save()
 
1158
 
 
1159
 
 
1160
@deprecated_function(zero_eight)
 
1161
def reweave(wa, wb, pb=None, msg=None):
 
1162
    """reweaving is deprecation, please just use weave.join()."""
 
1163
    _reweave(wa, wb, pb, msg)
 
1164
 
 
1165
def _reweave(wa, wb, pb=None, msg=None):
 
1166
    """Combine two weaves and return the result.
 
1167
 
 
1168
    This works even if a revision R has different parents in 
 
1169
    wa and wb.  In the resulting weave all the parents are given.
 
1170
 
 
1171
    This is done by just building up a new weave, maintaining ordering 
 
1172
    of the versions in the two inputs.  More efficient approaches
 
1173
    might be possible but it should only be necessary to do 
 
1174
    this operation rarely, when a new previously ghost version is 
 
1175
    inserted.
 
1176
 
 
1177
    :param pb: An optional progress bar, indicating how far done we are
 
1178
    :param msg: An optional message for the progress
 
1179
    """
 
1180
    wr = Weave()
 
1181
    ia = ib = 0
 
1182
    queue_a = range(wa.num_versions())
 
1183
    queue_b = range(wb.num_versions())
 
1184
    # first determine combined parents of all versions
 
1185
    # map from version name -> all parent names
 
1186
    combined_parents = _reweave_parent_graphs(wa, wb)
 
1187
    mutter("combined parents: %r", combined_parents)
 
1188
    order = topo_sort(combined_parents.iteritems())
 
1189
    mutter("order to reweave: %r", order)
 
1190
 
 
1191
    if pb and not msg:
 
1192
        msg = 'reweave'
 
1193
 
 
1194
    for idx, name in enumerate(order):
 
1195
        if pb:
 
1196
            pb.update(msg, idx, len(order))
 
1197
        if name in wa._name_map:
 
1198
            lines = wa.get_lines(name)
 
1199
            if name in wb._name_map:
 
1200
                lines_b = wb.get_lines(name)
 
1201
                if lines != lines_b:
 
1202
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1203
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1204
                    import difflib
 
1205
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1206
                            wa._weave_name, wb._weave_name))
 
1207
                    mutter('lines:\n%s', ''.join(lines))
 
1208
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1209
        else:
 
1210
            lines = wb.get_lines(name)
 
1211
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1212
    return wr
 
1213
 
 
1214
def _reweave_parent_graphs(wa, wb):
 
1215
    """Return combined parent ancestry for two weaves.
 
1216
    
 
1217
    Returned as a list of (version_name, set(parent_names))"""
 
1218
    combined = {}
 
1219
    for weave in [wa, wb]:
 
1220
        for idx, name in enumerate(weave._names):
 
1221
            p = combined.setdefault(name, set())
 
1222
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1223
    return combined
 
1224
 
 
1225
 
 
1226
def weave_toc(w):
 
1227
    """Show the weave's table-of-contents"""
 
1228
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1229
    for i in (6, 50, 10, 10):
677
1230
        print '-' * i,
678
1231
    print
679
 
    for i in range(w.numversions()):
 
1232
    for i in range(w.num_versions()):
680
1233
        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
 
1234
        name = w._names[i]
 
1235
        parent_str = ' '.join(map(str, w._parents[i]))
 
1236
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1237
 
 
1238
 
 
1239
 
 
1240
def weave_stats(weave_file, pb):
687
1241
    from bzrlib.weavefile import read_weave
688
1242
 
689
 
    pb = ProgressBar()
690
 
 
691
1243
    wf = file(weave_file, 'rb')
692
1244
    w = read_weave(wf)
693
1245
    # FIXME: doesn't work on pipes
697
1249
    vers = len(w)
698
1250
    for i in range(vers):
699
1251
        pb.update('checking sizes', i, vers)
700
 
        for line in w.get_iter(i):
 
1252
        for origin, lineno, line in w._extract([i]):
701
1253
            total += len(line)
702
1254
 
703
1255
    pb.clear()
706
1258
    print 'weave file        %9d bytes' % weave_size
707
1259
    print 'total contents    %9d bytes' % total
708
1260
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
709
 
 
 
1261
    if vers:
 
1262
        avg = total/vers
 
1263
        print 'average size      %9d bytes' % avg
 
1264
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
710
1265
 
711
1266
 
712
1267
def usage():
721
1276
        Write out specified version.
722
1277
    weave check WEAVEFILE
723
1278
        Check consistency of all versions.
724
 
    weave info WEAVEFILE
 
1279
    weave toc WEAVEFILE
725
1280
        Display table of contents.
726
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
1281
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
727
1282
        Add NEWTEXT, with specified parent versions.
728
1283
    weave annotate WEAVEFILE VERSION
729
1284
        Display origin of each line.
730
 
    weave mash WEAVEFILE VERSION...
731
 
        Display composite of all selected versions.
732
1285
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
733
1286
        Auto-merge two versions and display conflicts.
 
1287
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1288
        Show differences between two versions.
734
1289
 
735
1290
example:
736
1291
 
737
1292
    % weave init foo.weave
738
1293
    % vi foo.txt
739
 
    % weave add foo.weave < foo.txt
 
1294
    % weave add foo.weave ver0 < foo.txt
740
1295
    added version 0
741
1296
 
742
1297
    (create updated version)
743
1298
    % vi foo.txt
744
1299
    % weave get foo.weave 0 | diff -u - foo.txt
745
 
    % weave add foo.weave 0 < foo.txt
 
1300
    % weave add foo.weave ver1 0 < foo.txt
746
1301
    added version 1
747
1302
 
748
1303
    % weave get foo.weave 0 > foo.txt       (create forked version)
749
1304
    % vi foo.txt
750
 
    % weave add foo.weave 0 < foo.txt
 
1305
    % weave add foo.weave ver2 0 < foo.txt
751
1306
    added version 2
752
1307
 
753
1308
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
754
1309
    % vi foo.txt                            (resolve conflicts)
755
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
1310
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
756
1311
    
757
1312
"""
758
1313
    
761
1316
def main(argv):
762
1317
    import sys
763
1318
    import os
764
 
    from weavefile import write_weave, read_weave
 
1319
    try:
 
1320
        import bzrlib
 
1321
    except ImportError:
 
1322
        # in case we're run directly from the subdirectory
 
1323
        sys.path.append('..')
 
1324
        import bzrlib
 
1325
    from bzrlib.weavefile import write_weave, read_weave
765
1326
    from bzrlib.progress import ProgressBar
766
1327
 
767
 
    #import psyco
768
 
    #psyco.full()
 
1328
    try:
 
1329
        import psyco
 
1330
        psyco.full()
 
1331
    except ImportError:
 
1332
        pass
 
1333
 
 
1334
    if len(argv) < 2:
 
1335
        usage()
 
1336
        return 0
769
1337
 
770
1338
    cmd = argv[1]
771
1339
 
777
1345
    elif cmd == 'add':
778
1346
        w = readit()
779
1347
        # at the moment, based on everything in the file
780
 
        parents = map(int, argv[3:])
 
1348
        name = argv[3]
 
1349
        parents = map(int, argv[4:])
781
1350
        lines = sys.stdin.readlines()
782
 
        ver = w.add(parents, lines)
 
1351
        ver = w.add(name, parents, lines)
783
1352
        write_weave(w, file(argv[2], 'wb'))
784
 
        print 'added version %d' % ver
 
1353
        print 'added version %r %d' % (name, ver)
785
1354
    elif cmd == 'init':
786
1355
        fn = argv[2]
787
1356
        if os.path.exists(fn):
792
1361
        w = readit()
793
1362
        sys.stdout.writelines(w.get_iter(int(argv[3])))
794
1363
        
795
 
    elif cmd == 'mash': # get composite
 
1364
    elif cmd == 'diff':
796
1365
        w = readit()
797
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
798
 
 
 
1366
        fn = argv[2]
 
1367
        v1, v2 = map(int, argv[3:5])
 
1368
        lines1 = w.get(v1)
 
1369
        lines2 = w.get(v2)
 
1370
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1371
                                '%s version %d' % (fn, v1),
 
1372
                                '%s version %d' % (fn, v2))
 
1373
        sys.stdout.writelines(diff_gen)
 
1374
            
799
1375
    elif cmd == 'annotate':
800
1376
        w = readit()
801
1377
        # newline is added to all lines regardless; too hard to get
809
1385
                print '%5d | %s' % (origin, text)
810
1386
                lasto = origin
811
1387
                
812
 
    elif cmd == 'info':
813
 
        weave_info(readit())
 
1388
    elif cmd == 'toc':
 
1389
        weave_toc(readit())
814
1390
 
815
1391
    elif cmd == 'stats':
816
 
        weave_stats(argv[2])
 
1392
        weave_stats(argv[2], ProgressBar())
817
1393
        
818
1394
    elif cmd == 'check':
819
1395
        w = readit()
820
1396
        pb = ProgressBar()
821
1397
        w.check(pb)
822
1398
        pb.clear()
823
 
        print '%d versions ok' % w.numversions()
 
1399
        print '%d versions ok' % w.num_versions()
824
1400
 
825
1401
    elif cmd == 'inclusions':
826
1402
        w = readit()
831
1407
        print ' '.join(map(str, w._parents[int(argv[3])]))
832
1408
 
833
1409
    elif cmd == 'plan-merge':
 
1410
        # replaced by 'bzr weave-plan-merge'
834
1411
        w = readit()
835
1412
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
836
1413
            if line:
837
1414
                print '%14s | %s' % (state, line),
838
 
 
839
1415
    elif cmd == 'merge':
 
1416
        # replaced by 'bzr weave-merge-text'
840
1417
        w = readit()
841
1418
        p = w.plan_merge(int(argv[3]), int(argv[4]))
842
1419
        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
1420
    else:
865
1421
        raise ValueError('unknown command %r' % cmd)
866
1422
    
868
1424
if __name__ == '__main__':
869
1425
    import sys
870
1426
    sys.exit(main(sys.argv))
 
1427
 
 
1428
 
 
1429
class InterWeave(InterVersionedFile):
 
1430
    """Optimised code paths for weave to weave operations."""
 
1431
    
 
1432
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1433
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1434
    
 
1435
    @staticmethod
 
1436
    def is_compatible(source, target):
 
1437
        """Be compatible with weaves."""
 
1438
        try:
 
1439
            return (isinstance(source, Weave) and
 
1440
                    isinstance(target, Weave))
 
1441
        except AttributeError:
 
1442
            return False
 
1443
 
 
1444
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1445
        """See InterVersionedFile.join."""
 
1446
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1447
        if self.target.versions() == [] and version_ids is None:
 
1448
            self.target._copy_weave_content(self.source)
 
1449
            return
 
1450
        try:
 
1451
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1452
        except errors.WeaveParentMismatch:
 
1453
            self.target._reweave(self.source, pb, msg)
 
1454
 
 
1455
 
 
1456
InterVersionedFile.register_optimiser(InterWeave)