/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-01-11 17:20:25 UTC
  • mto: This revision was merged to the branch mainline in revision 2239.
  • Revision ID: abentley@panoramicfeedback.com-20070111172025-8rnvvm3jqx7h5uvv
Reject reserved ids in versiondfile, tree, branch and repository

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
        if self.reserved_id(name):
 
251
            raise errors.ReservedId(name)
 
252
        try:
 
253
            return self._name_map[name]
 
254
        except KeyError:
 
255
            raise RevisionNotPresent(name, self._weave_name)
 
256
 
 
257
    @deprecated_method(zero_eight)
 
258
    def iter_names(self):
 
259
        """Deprecated convenience function, please see VersionedFile.names()."""
 
260
        return iter(self.names())
 
261
 
 
262
    @deprecated_method(zero_eight)
 
263
    def names(self):
 
264
        """See Weave.versions for the current api."""
 
265
        return self.versions()
 
266
 
 
267
    def versions(self):
 
268
        """See VersionedFile.versions."""
 
269
        return self._names[:]
 
270
 
 
271
    def has_version(self, version_id):
 
272
        """See VersionedFile.has_version."""
 
273
        return (version_id in self._name_map)
 
274
 
 
275
    __contains__ = has_version
 
276
 
 
277
    def get_delta(self, version_id):
 
278
        """See VersionedFile.get_delta."""
 
279
        return self.get_deltas([version_id])[version_id]
 
280
 
 
281
    def get_deltas(self, version_ids):
 
282
        """See VersionedFile.get_deltas."""
 
283
        version_ids = self.get_ancestry(version_ids)
 
284
        for version_id in version_ids:
 
285
            if not self.has_version(version_id):
 
286
                raise RevisionNotPresent(version_id, self)
 
287
        # try extracting all versions; parallel extraction is used
 
288
        nv = self.num_versions()
 
289
        sha1s = {}
 
290
        deltas = {}
 
291
        texts = {}
 
292
        inclusions = {}
 
293
        noeols = {}
 
294
        last_parent_lines = {}
 
295
        parents = {}
 
296
        parent_inclusions = {}
 
297
        parent_linenums = {}
 
298
        parent_noeols = {}
 
299
        current_hunks = {}
 
300
        diff_hunks = {}
 
301
        # its simplest to generate a full set of prepared variables.
 
302
        for i in range(nv):
 
303
            name = self._names[i]
 
304
            sha1s[name] = self.get_sha1(name)
 
305
            parents_list = self.get_parents(name)
 
306
            try:
 
307
                parent = parents_list[0]
 
308
                parents[name] = parent
 
309
                parent_inclusions[name] = inclusions[parent]
 
310
            except IndexError:
 
311
                parents[name] = None
 
312
                parent_inclusions[name] = set()
 
313
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
 
314
            diff_hunks[name] = []
 
315
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
 
316
            parent_linenums[name] = 0
 
317
            noeols[name] = False
 
318
            parent_noeols[name] = False
 
319
            last_parent_lines[name] = None
 
320
            new_inc = set([name])
 
321
            for p in self._parents[i]:
 
322
                new_inc.update(inclusions[self._idx_to_name(p)])
 
323
            # debug only, known good so far.
 
324
            #assert set(new_inc) == set(self.get_ancestry(name)), \
 
325
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
326
            inclusions[name] = new_inc
 
327
 
 
328
        nlines = len(self._weave)
 
329
 
 
330
        for lineno, inserted, deletes, line in self._walk_internal():
 
331
            # a line is active in a version if:
 
332
            # insert is in the versions inclusions
 
333
            # and
 
334
            # deleteset & the versions inclusions is an empty set.
 
335
            # so - if we have a included by mapping - version is included by
 
336
            # children, we get a list of children to examine for deletes affect
 
337
            # ing them, which is less than the entire set of children.
 
338
            for version_id in version_ids:  
 
339
                # The active inclusion must be an ancestor,
 
340
                # and no ancestors must have deleted this line,
 
341
                # because we don't support resurrection.
 
342
                parent_inclusion = parent_inclusions[version_id]
 
343
                inclusion = inclusions[version_id]
 
344
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
 
345
                version_active = inserted in inclusion and not (deletes & inclusion)
 
346
                if not parent_active and not version_active:
 
347
                    # unrelated line of ancestry
 
348
                    continue
 
349
                elif parent_active and version_active:
 
350
                    # shared line
 
351
                    parent_linenum = parent_linenums[version_id]
 
352
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
 
353
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
 
354
                    parent_linenum += 1
 
355
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
 
356
                    parent_linenums[version_id] = parent_linenum
 
357
                    try:
 
358
                        if line[-1] != '\n':
 
359
                            noeols[version_id] = True
 
360
                    except IndexError:
 
361
                        pass
 
362
                elif parent_active and not version_active:
 
363
                    # deleted line
 
364
                    current_hunks[version_id][1] += 1
 
365
                    parent_linenums[version_id] += 1
 
366
                    last_parent_lines[version_id] = line
 
367
                elif not parent_active and version_active:
 
368
                    # replacement line
 
369
                    # noeol only occurs at the end of a file because we 
 
370
                    # diff linewise. We want to show noeol changes as a
 
371
                    # empty diff unless the actual eol-less content changed.
 
372
                    theline = line
 
373
                    try:
 
374
                        if last_parent_lines[version_id][-1] != '\n':
 
375
                            parent_noeols[version_id] = True
 
376
                    except (TypeError, IndexError):
 
377
                        pass
 
378
                    try:
 
379
                        if theline[-1] != '\n':
 
380
                            noeols[version_id] = True
 
381
                    except IndexError:
 
382
                        pass
 
383
                    new_line = False
 
384
                    parent_should_go = False
 
385
 
 
386
                    if parent_noeols[version_id] == noeols[version_id]:
 
387
                        # no noeol toggle, so trust the weaves statement
 
388
                        # that this line is changed.
 
389
                        new_line = True
 
390
                        if parent_noeols[version_id]:
 
391
                            theline = theline + '\n'
 
392
                    elif parent_noeols[version_id]:
 
393
                        # parent has no eol, we do:
 
394
                        # our line is new, report as such..
 
395
                        new_line = True
 
396
                    elif noeols[version_id]:
 
397
                        # append a eol so that it looks like
 
398
                        # a normalised delta
 
399
                        theline = theline + '\n'
 
400
                        if parents[version_id] is not None:
 
401
                        #if last_parent_lines[version_id] is not None:
 
402
                            parent_should_go = True
 
403
                        if last_parent_lines[version_id] != theline:
 
404
                            # but changed anyway
 
405
                            new_line = True
 
406
                            #parent_should_go = False
 
407
                    if new_line:
 
408
                        current_hunks[version_id][2] += 1
 
409
                        current_hunks[version_id][3].append((inserted, theline))
 
410
                    if parent_should_go:
 
411
                        # last hunk last parent line is not eaten
 
412
                        current_hunks[version_id][1] -= 1
 
413
                    if current_hunks[version_id][1] < 0:
 
414
                        current_hunks[version_id][1] = 0
 
415
                        # import pdb;pdb.set_trace()
 
416
                    # assert current_hunks[version_id][1] >= 0
 
417
 
 
418
        # flush last hunk
 
419
        for i in range(nv):
 
420
            version = self._idx_to_name(i)
 
421
            if current_hunks[version] != [0, 0, 0, []]:
 
422
                diff_hunks[version].append(tuple(current_hunks[version]))
 
423
        result = {}
 
424
        for version_id in version_ids:
 
425
            result[version_id] = (
 
426
                                  parents[version_id],
 
427
                                  sha1s[version_id],
 
428
                                  noeols[version_id],
 
429
                                  diff_hunks[version_id],
 
430
                                  )
 
431
        return result
 
432
 
 
433
    def get_parents(self, version_id):
 
434
        """See VersionedFile.get_parent."""
 
435
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
 
436
 
 
437
    def _check_repeated_add(self, name, parents, text, sha1):
 
438
        """Check that a duplicated add is OK.
 
439
 
 
440
        If it is, return the (old) index; otherwise raise an exception.
 
441
        """
 
442
        idx = self._lookup(name)
 
443
        if sorted(self._parents[idx]) != sorted(parents) \
 
444
            or sha1 != self._sha1s[idx]:
 
445
            raise RevisionAlreadyPresent(name, self._weave_name)
 
446
        return idx
 
447
 
 
448
    @deprecated_method(zero_eight)
 
449
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
450
        """Please use Weave.clone_text now."""
 
451
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
452
 
 
453
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
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):
 
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
 
 
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(self, version_id):
 
646
        if isinstance(version_id, int):
 
647
            warnings.warn('Weave.annotate(int) is deprecated. Please use version names'
 
648
                 ' in all circumstances as of 0.8',
 
649
                 DeprecationWarning,
 
650
                 stacklevel=2
 
651
                 )
 
652
            result = []
 
653
            for origin, lineno, text in self._extract([version_id]):
 
654
                result.append((origin, text))
 
655
            return result
 
656
        else:
 
657
            return super(Weave, self).annotate(version_id)
354
658
    
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.
 
659
    def annotate_iter(self, version_id):
 
660
        """Yield list of (version-id, line) pairs for the specified version.
361
661
 
362
662
        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
 
 
 
663
        incls = [self._lookup(version_id)]
 
664
        for origin, lineno, text in self._extract(incls):
 
665
            yield self._idx_to_name(origin), text
 
666
 
 
667
    @deprecated_method(zero_eight)
367
668
    def _walk(self):
368
 
        """Walk the weave.
369
 
 
370
 
        Yields sequence of
371
 
        (lineno, insert, deletes, text)
372
 
        for each literal line.
373
 
        """
 
669
        """_walk has become visit, a supported api."""
 
670
        return self._walk_internal()
 
671
 
 
672
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
673
                                                pb=None):
 
674
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
675
        if version_ids is None:
 
676
            version_ids = self.versions()
 
677
        version_ids = set(version_ids)
 
678
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
679
            # if inserted not in version_ids then it was inserted before the
 
680
            # versions we care about, but because weaves cannot represent ghosts
 
681
            # properly, we do not filter down to that
 
682
            # if inserted not in version_ids: continue
 
683
            if line[-1] != '\n':
 
684
                yield line + '\n'
 
685
            else:
 
686
                yield line
 
687
 
 
688
    #@deprecated_method(zero_eight)
 
689
    def walk(self, version_ids=None):
 
690
        """See VersionedFile.walk."""
 
691
        return self._walk_internal(version_ids)
 
692
 
 
693
    def _walk_internal(self, version_ids=None):
 
694
        """Helper method for weave actions."""
374
695
        
375
696
        istack = []
376
697
        dset = set()
378
699
        lineno = 0         # line of weave, 0-based
379
700
 
380
701
        for l in self._weave:
381
 
            if isinstance(l, tuple):
 
702
            if l.__class__ == tuple:
382
703
                c, v = l
383
704
                isactive = None
384
705
                if c == '{':
385
 
                    istack.append(v)
 
706
                    istack.append(self._names[v])
386
707
                elif c == '}':
387
 
                    oldv = istack.pop()
 
708
                    istack.pop()
388
709
                elif c == '[':
389
 
                    assert v not in dset
390
 
                    dset.add(v)
 
710
                    assert self._names[v] not in dset
 
711
                    dset.add(self._names[v])
391
712
                elif c == ']':
392
 
                    dset.remove(v)
 
713
                    dset.remove(self._names[v])
393
714
                else:
394
 
                    raise WeaveFormatError('unexpected instruction %r'
395
 
                                           % v)
 
715
                    raise WeaveFormatError('unexpected instruction %r' % v)
396
716
            else:
397
 
                assert isinstance(l, basestring)
 
717
                assert l.__class__ in (str, unicode)
398
718
                assert istack
399
 
                yield lineno, istack[-1], dset, l
 
719
                yield lineno, istack[-1], frozenset(dset), l
400
720
            lineno += 1
401
721
 
402
 
 
 
722
        if istack:
 
723
            raise WeaveFormatError("unclosed insertion blocks "
 
724
                    "at end of weave: %s" % istack)
 
725
        if dset:
 
726
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
727
                                   % dset)
 
728
 
 
729
    def plan_merge(self, ver_a, ver_b):
 
730
        """Return pseudo-annotation indicating how the two versions merge.
 
731
 
 
732
        This is computed between versions a and b and their common
 
733
        base.
 
734
 
 
735
        Weave lines present in none of them are skipped entirely.
 
736
        """
 
737
        inc_a = set(self.get_ancestry([ver_a]))
 
738
        inc_b = set(self.get_ancestry([ver_b]))
 
739
        inc_c = inc_a & inc_b
 
740
 
 
741
        for lineno, insert, deleteset, line in\
 
742
            self.walk([ver_a, ver_b]):
 
743
            if deleteset & inc_c:
 
744
                # killed in parent; can't be in either a or b
 
745
                # not relevant to our work
 
746
                yield 'killed-base', line
 
747
            elif insert in inc_c:
 
748
                # was inserted in base
 
749
                killed_a = bool(deleteset & inc_a)
 
750
                killed_b = bool(deleteset & inc_b)
 
751
                if killed_a and killed_b:
 
752
                    yield 'killed-both', line
 
753
                elif killed_a:
 
754
                    yield 'killed-a', line
 
755
                elif killed_b:
 
756
                    yield 'killed-b', line
 
757
                else:
 
758
                    yield 'unchanged', line
 
759
            elif insert in inc_a:
 
760
                if deleteset & inc_a:
 
761
                    yield 'ghost-a', line
 
762
                else:
 
763
                    # new in A; not in B
 
764
                    yield 'new-a', line
 
765
            elif insert in inc_b:
 
766
                if deleteset & inc_b:
 
767
                    yield 'ghost-b', line
 
768
                else:
 
769
                    yield 'new-b', line
 
770
            else:
 
771
                # not in either revision
 
772
                yield 'irrelevant', line
 
773
 
 
774
        yield 'unchanged', ''           # terminator
403
775
 
404
776
    def _extract(self, versions):
405
777
        """Yield annotation of lines in included set.
410
782
 
411
783
        The set typically but not necessarily corresponds to a version.
412
784
        """
413
 
        included = self.inclusions(versions)
 
785
        for i in versions:
 
786
            if not isinstance(i, int):
 
787
                raise ValueError(i)
 
788
            
 
789
        included = self._inclusions(versions)
414
790
 
415
791
        istack = []
 
792
        iset = set()
416
793
        dset = set()
417
794
 
418
795
        lineno = 0         # line of weave, 0-based
423
800
 
424
801
        WFE = WeaveFormatError
425
802
 
 
803
        # wow. 
 
804
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
805
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
806
        # 1.6 seconds in 'isinstance'.
 
807
        # changing the first isinstance:
 
808
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
809
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
810
        # note that the inline time actually dropped (less function calls)
 
811
        # and total processing time was halved.
 
812
        # we're still spending ~1/4 of the method in isinstance though.
 
813
        # so lets hard code the acceptable string classes we expect:
 
814
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
815
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
816
        #                                          objects>
 
817
        # yay, down to ~1/4 the initial extract time, and our inline time
 
818
        # has shrunk again, with isinstance no longer dominating.
 
819
        # tweaking the stack inclusion test to use a set gives:
 
820
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
821
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
822
        #                                          objects>
 
823
        # - a 5% win, or possibly just noise. However with large istacks that
 
824
        # 'in' test could dominate, so I'm leaving this change in place -
 
825
        # when its fast enough to consider profiling big datasets we can review.
 
826
 
 
827
              
 
828
             
 
829
 
426
830
        for l in self._weave:
427
 
            if isinstance(l, tuple):
 
831
            if l.__class__ == tuple:
428
832
                c, v = l
429
833
                isactive = None
430
834
                if c == '{':
431
 
                    assert v not in istack
 
835
                    assert v not in iset
432
836
                    istack.append(v)
 
837
                    iset.add(v)
433
838
                elif c == '}':
434
 
                    oldv = istack.pop()
435
 
                    assert oldv == v
 
839
                    iset.remove(istack.pop())
436
840
                elif c == '[':
437
841
                    if v in included:
438
842
                        assert v not in dset
443
847
                        assert v in dset
444
848
                        dset.remove(v)
445
849
            else:
446
 
                assert isinstance(l, basestring)
 
850
                assert l.__class__ in (str, unicode)
447
851
                if isactive is None:
448
852
                    isactive = (not dset) and istack and (istack[-1] in included)
449
853
                if isactive:
450
854
                    result.append((istack[-1], lineno, l))
451
855
            lineno += 1
452
 
 
453
856
        if istack:
454
 
            raise WFE("unclosed insertion blocks at end of weave",
455
 
                                   istack)
 
857
            raise WeaveFormatError("unclosed insertion blocks "
 
858
                    "at end of weave: %s" % istack)
456
859
        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
 
 
 
860
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
861
                                   % dset)
 
862
        return result
 
863
 
 
864
    @deprecated_method(zero_eight)
 
865
    def get_iter(self, name_or_index):
 
866
        """Deprecated, please do not use. Lookups are not not needed.
 
867
        
 
868
        Please use get_lines now.
 
869
        """
 
870
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
871
 
 
872
    @deprecated_method(zero_eight)
 
873
    def maybe_lookup(self, name_or_index):
 
874
        """Deprecated, please do not use. Lookups are not not needed."""
 
875
        return self._maybe_lookup(name_or_index)
 
876
 
 
877
    def _maybe_lookup(self, name_or_index):
 
878
        """Convert possible symbolic name to index, or pass through indexes.
 
879
        
 
880
        NOT FOR PUBLIC USE.
 
881
        """
 
882
        if isinstance(name_or_index, (int, long)):
 
883
            return name_or_index
 
884
        else:
 
885
            return self._lookup(name_or_index)
 
886
 
 
887
    @deprecated_method(zero_eight)
 
888
    def get(self, version_id):
 
889
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
890
        return self.get_lines(version_id)
 
891
 
 
892
    def get_lines(self, version_id):
 
893
        """See VersionedFile.get_lines()."""
 
894
        int_index = self._maybe_lookup(version_id)
 
895
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
896
        expected_sha1 = self._sha1s[int_index]
 
897
        measured_sha1 = sha_strings(result)
 
898
        if measured_sha1 != expected_sha1:
 
899
            raise errors.WeaveInvalidChecksum(
 
900
                    'file %s, revision %s, expected: %s, measured %s' 
 
901
                    % (self._weave_name, version_id,
 
902
                       expected_sha1, measured_sha1))
 
903
        return result
 
904
 
 
905
    def get_sha1(self, version_id):
 
906
        """See VersionedFile.get_sha1()."""
 
907
        return self._sha1s[self._lookup(version_id)]
 
908
 
 
909
    @deprecated_method(zero_eight)
489
910
    def numversions(self):
 
911
        """How many versions are in this weave?
 
912
 
 
913
        Deprecated in favour of num_versions.
 
914
        """
 
915
        return self.num_versions()
 
916
 
 
917
    def num_versions(self):
 
918
        """How many versions are in this weave?"""
490
919
        l = len(self._parents)
491
920
        assert l == len(self._sha1s)
492
921
        return l
493
922
 
494
 
 
495
 
    def __len__(self):
496
 
        return self.numversions()
497
 
 
 
923
    __len__ = num_versions
498
924
 
499
925
    def check(self, progress_bar=None):
500
 
        # check no circular inclusions
501
 
        for version in range(self.numversions()):
 
926
        # TODO evaluate performance hit of using string sets in this routine.
 
927
        # TODO: check no circular inclusions
 
928
        # TODO: create a nested progress bar
 
929
        for version in range(self.num_versions()):
502
930
            inclusions = list(self._parents[version])
503
931
            if inclusions:
504
932
                inclusions.sort()
506
934
                    raise WeaveFormatError("invalid included version %d for index %d"
507
935
                                           % (inclusions[-1], version))
508
936
 
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):
 
937
        # try extracting all versions; parallel extraction is used
 
938
        nv = self.num_versions()
 
939
        sha1s = {}
 
940
        texts = {}
 
941
        inclusions = {}
 
942
        for i in range(nv):
 
943
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
944
            # The problem is that set membership is much more expensive
 
945
            name = self._idx_to_name(i)
 
946
            sha1s[name] = sha.new()
 
947
            texts[name] = []
 
948
            new_inc = set([name])
 
949
            for p in self._parents[i]:
 
950
                new_inc.update(inclusions[self._idx_to_name(p)])
 
951
 
 
952
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
953
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
954
            inclusions[name] = new_inc
 
955
 
 
956
        nlines = len(self._weave)
 
957
 
 
958
        update_text = 'checking weave'
 
959
        if self._weave_name:
 
960
            short_name = os.path.basename(self._weave_name)
 
961
            update_text = 'checking %s' % (short_name,)
 
962
            update_text = update_text[:25]
 
963
 
 
964
        for lineno, insert, deleteset, line in self._walk_internal():
514
965
            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]
 
966
                progress_bar.update(update_text, lineno, nlines)
 
967
 
 
968
            for name, name_inclusions in inclusions.items():
 
969
                # The active inclusion must be an ancestor,
 
970
                # and no ancestors must have deleted this line,
 
971
                # because we don't support resurrection.
 
972
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
973
                    sha1s[name].update(line)
 
974
 
 
975
        for i in range(nv):
 
976
            version = self._idx_to_name(i)
 
977
            hd = sha1s[version].hexdigest()
 
978
            expected = self._sha1s[i]
521
979
            if hd != expected:
522
 
                raise WeaveError("mismatched sha1 for version %d; "
523
 
                                 "got %s, expected %s"
524
 
                                 % (version, hd, expected))
 
980
                raise errors.WeaveInvalidChecksum(
 
981
                        "mismatched sha1 for version %s: "
 
982
                        "got %s, expected %s"
 
983
                        % (version, hd, expected))
525
984
 
526
985
        # TODO: check insertions are properly nested, that there are
527
986
        # no lines outside of insertion blocks, that deletions are
528
987
        # properly paired, etc.
529
988
 
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):
 
989
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
990
        """Worker routine for join()."""
 
991
        if not other.versions():
 
992
            return          # nothing to update, easy
 
993
 
 
994
        if not version_ids:
 
995
            # versions is never none, InterWeave checks this.
 
996
            return 0
 
997
 
 
998
        # two loops so that we do not change ourselves before verifying it
 
999
        # will be ok
 
1000
        # work through in index order to make sure we get all dependencies
 
1001
        names_to_join = []
 
1002
        processed = 0
 
1003
        # get the selected versions only that are in other.versions.
 
1004
        version_ids = set(other.versions()).intersection(set(version_ids))
 
1005
        # pull in the referenced graph.
 
1006
        version_ids = other.get_ancestry(version_ids)
 
1007
        pending_graph = [(version, other.get_parents(version)) for
 
1008
                         version in version_ids]
 
1009
        for name in topo_sort(pending_graph):
 
1010
            other_idx = other._name_map[name]
 
1011
            # returns True if we have it, False if we need it.
 
1012
            if not self._check_version_consistent(other, other_idx, name):
 
1013
                names_to_join.append((other_idx, name))
 
1014
            processed += 1
 
1015
 
 
1016
 
 
1017
        if pb and not msg:
 
1018
            msg = 'weave join'
 
1019
 
 
1020
        merged = 0
 
1021
        time0 = time.time()
 
1022
        for other_idx, name in names_to_join:
 
1023
            # TODO: If all the parents of the other version are already
 
1024
            # present then we can avoid some work by just taking the delta
 
1025
            # and adjusting the offsets.
 
1026
            new_parents = self._imported_parents(other, other_idx)
 
1027
            sha1 = other._sha1s[other_idx]
 
1028
 
 
1029
            merged += 1
 
1030
 
 
1031
            if pb:
 
1032
                pb.update(msg, merged, len(names_to_join))
 
1033
           
 
1034
            lines = other.get_lines(other_idx)
 
1035
            self._add(name, lines, new_parents, sha1)
 
1036
 
 
1037
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
1038
                merged, processed, self._weave_name, time.time()-time0))
 
1039
 
 
1040
    def _imported_parents(self, other, other_idx):
 
1041
        """Return list of parents in self corresponding to indexes in other."""
 
1042
        new_parents = []
 
1043
        for parent_idx in other._parents[other_idx]:
 
1044
            parent_name = other._names[parent_idx]
 
1045
            if parent_name not in self._name_map:
 
1046
                # should not be possible
 
1047
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
1048
                                 % (parent_name, other._name_map[other_idx], self))
 
1049
            new_parents.append(self._name_map[parent_name])
 
1050
        return new_parents
 
1051
 
 
1052
    def _check_version_consistent(self, other, other_idx, name):
 
1053
        """Check if a version in consistent in this and other.
 
1054
 
 
1055
        To be consistent it must have:
 
1056
 
 
1057
         * the same text
 
1058
         * the same direct parents (by name, not index, and disregarding
 
1059
           order)
 
1060
        
 
1061
        If present & correct return True;
 
1062
        if not present in self return False; 
 
1063
        if inconsistent raise error."""
 
1064
        this_idx = self._name_map.get(name, -1)
 
1065
        if this_idx != -1:
 
1066
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
1067
                raise errors.WeaveTextDiffers(name, self, other)
 
1068
            self_parents = self._parents[this_idx]
 
1069
            other_parents = other._parents[other_idx]
 
1070
            n1 = set([self._names[i] for i in self_parents])
 
1071
            n2 = set([other._names[i] for i in other_parents])
 
1072
            if not self._compatible_parents(n1, n2):
 
1073
                raise WeaveParentMismatch("inconsistent parents "
 
1074
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
1075
            else:
 
1076
                return True         # ok!
 
1077
        else:
 
1078
            return False
 
1079
 
 
1080
    @deprecated_method(zero_eight)
 
1081
    def reweave(self, other, pb=None, msg=None):
 
1082
        """reweave has been superseded by plain use of join."""
 
1083
        return self.join(other, pb, msg)
 
1084
 
 
1085
    def _reweave(self, other, pb, msg):
 
1086
        """Reweave self with other - internal helper for join().
 
1087
 
 
1088
        :param other: The other weave to merge
 
1089
        :param pb: An optional progress bar, indicating how far done we are
 
1090
        :param msg: An optional message for the progress
 
1091
        """
 
1092
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
1093
        self._copy_weave_content(new_weave)
 
1094
 
 
1095
    def _copy_weave_content(self, otherweave):
 
1096
        """adsorb the content from otherweave."""
 
1097
        for attr in self.__slots__:
 
1098
            if attr != '_weave_name':
 
1099
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
1100
 
 
1101
 
 
1102
class WeaveFile(Weave):
 
1103
    """A WeaveFile represents a Weave on disk and writes on change."""
 
1104
 
 
1105
    WEAVE_SUFFIX = '.weave'
 
1106
    
 
1107
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
1108
        """Create a WeaveFile.
 
1109
        
 
1110
        :param create: If not True, only open an existing knit.
 
1111
        """
 
1112
        super(WeaveFile, self).__init__(name, access_mode)
 
1113
        self._transport = transport
 
1114
        self._filemode = filemode
 
1115
        try:
 
1116
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
1117
        except errors.NoSuchFile:
 
1118
            if not create:
 
1119
                raise
 
1120
            # new file, save it
 
1121
            self._save()
 
1122
 
 
1123
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
1124
        """Add a version and save the weave."""
 
1125
        if self.reserved_id(version_id):
 
1126
            raise errors.ReservedId(version_id)
 
1127
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
1128
                                                   parent_texts)
 
1129
        self._save()
 
1130
        return result
 
1131
 
 
1132
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1133
        """See VersionedFile.clone_text."""
 
1134
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1135
        self._save
 
1136
 
 
1137
    def copy_to(self, name, transport):
 
1138
        """See VersionedFile.copy_to()."""
 
1139
        # as we are all in memory always, just serialise to the new place.
 
1140
        sio = StringIO()
 
1141
        write_weave_v5(self, sio)
 
1142
        sio.seek(0)
 
1143
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1144
 
 
1145
    def create_empty(self, name, transport, filemode=None):
 
1146
        return WeaveFile(name, transport, filemode, create=True)
 
1147
 
 
1148
    def _save(self):
 
1149
        """Save the weave."""
 
1150
        self._check_write_ok()
 
1151
        sio = StringIO()
 
1152
        write_weave_v5(self, sio)
 
1153
        sio.seek(0)
 
1154
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1155
                                 sio,
 
1156
                                 self._filemode)
 
1157
 
 
1158
    @staticmethod
 
1159
    def get_suffixes():
 
1160
        """See VersionedFile.get_suffixes()."""
 
1161
        return [WeaveFile.WEAVE_SUFFIX]
 
1162
 
 
1163
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1164
             ignore_missing=False):
 
1165
        """Join other into self and save."""
 
1166
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
1167
        self._save()
 
1168
 
 
1169
 
 
1170
@deprecated_function(zero_eight)
 
1171
def reweave(wa, wb, pb=None, msg=None):
 
1172
    """reweaving is deprecation, please just use weave.join()."""
 
1173
    _reweave(wa, wb, pb, msg)
 
1174
 
 
1175
def _reweave(wa, wb, pb=None, msg=None):
 
1176
    """Combine two weaves and return the result.
 
1177
 
 
1178
    This works even if a revision R has different parents in 
 
1179
    wa and wb.  In the resulting weave all the parents are given.
 
1180
 
 
1181
    This is done by just building up a new weave, maintaining ordering 
 
1182
    of the versions in the two inputs.  More efficient approaches
 
1183
    might be possible but it should only be necessary to do 
 
1184
    this operation rarely, when a new previously ghost version is 
 
1185
    inserted.
 
1186
 
 
1187
    :param pb: An optional progress bar, indicating how far done we are
 
1188
    :param msg: An optional message for the progress
 
1189
    """
 
1190
    wr = Weave()
 
1191
    ia = ib = 0
 
1192
    queue_a = range(wa.num_versions())
 
1193
    queue_b = range(wb.num_versions())
 
1194
    # first determine combined parents of all versions
 
1195
    # map from version name -> all parent names
 
1196
    combined_parents = _reweave_parent_graphs(wa, wb)
 
1197
    mutter("combined parents: %r", combined_parents)
 
1198
    order = topo_sort(combined_parents.iteritems())
 
1199
    mutter("order to reweave: %r", order)
 
1200
 
 
1201
    if pb and not msg:
 
1202
        msg = 'reweave'
 
1203
 
 
1204
    for idx, name in enumerate(order):
 
1205
        if pb:
 
1206
            pb.update(msg, idx, len(order))
 
1207
        if name in wa._name_map:
 
1208
            lines = wa.get_lines(name)
 
1209
            if name in wb._name_map:
 
1210
                lines_b = wb.get_lines(name)
 
1211
                if lines != lines_b:
 
1212
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1213
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1214
                    import difflib
 
1215
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1216
                            wa._weave_name, wb._weave_name))
 
1217
                    mutter('lines:\n%s', ''.join(lines))
 
1218
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1219
        else:
 
1220
            lines = wb.get_lines(name)
 
1221
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1222
    return wr
 
1223
 
 
1224
def _reweave_parent_graphs(wa, wb):
 
1225
    """Return combined parent ancestry for two weaves.
 
1226
    
 
1227
    Returned as a list of (version_name, set(parent_names))"""
 
1228
    combined = {}
 
1229
    for weave in [wa, wb]:
 
1230
        for idx, name in enumerate(weave._names):
 
1231
            p = combined.setdefault(name, set())
 
1232
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1233
    return combined
 
1234
 
 
1235
 
 
1236
def weave_toc(w):
 
1237
    """Show the weave's table-of-contents"""
 
1238
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1239
    for i in (6, 50, 10, 10):
677
1240
        print '-' * i,
678
1241
    print
679
 
    for i in range(w.numversions()):
 
1242
    for i in range(w.num_versions()):
680
1243
        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
 
1244
        name = w._names[i]
 
1245
        parent_str = ' '.join(map(str, w._parents[i]))
 
1246
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1247
 
 
1248
 
 
1249
 
 
1250
def weave_stats(weave_file, pb):
687
1251
    from bzrlib.weavefile import read_weave
688
1252
 
689
 
    pb = ProgressBar()
690
 
 
691
1253
    wf = file(weave_file, 'rb')
692
1254
    w = read_weave(wf)
693
1255
    # FIXME: doesn't work on pipes
697
1259
    vers = len(w)
698
1260
    for i in range(vers):
699
1261
        pb.update('checking sizes', i, vers)
700
 
        for line in w.get_iter(i):
 
1262
        for origin, lineno, line in w._extract([i]):
701
1263
            total += len(line)
702
1264
 
703
1265
    pb.clear()
706
1268
    print 'weave file        %9d bytes' % weave_size
707
1269
    print 'total contents    %9d bytes' % total
708
1270
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
709
 
 
 
1271
    if vers:
 
1272
        avg = total/vers
 
1273
        print 'average size      %9d bytes' % avg
 
1274
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
710
1275
 
711
1276
 
712
1277
def usage():
721
1286
        Write out specified version.
722
1287
    weave check WEAVEFILE
723
1288
        Check consistency of all versions.
724
 
    weave info WEAVEFILE
 
1289
    weave toc WEAVEFILE
725
1290
        Display table of contents.
726
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
1291
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
727
1292
        Add NEWTEXT, with specified parent versions.
728
1293
    weave annotate WEAVEFILE VERSION
729
1294
        Display origin of each line.
730
 
    weave mash WEAVEFILE VERSION...
731
 
        Display composite of all selected versions.
732
1295
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
733
1296
        Auto-merge two versions and display conflicts.
 
1297
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1298
        Show differences between two versions.
734
1299
 
735
1300
example:
736
1301
 
737
1302
    % weave init foo.weave
738
1303
    % vi foo.txt
739
 
    % weave add foo.weave < foo.txt
 
1304
    % weave add foo.weave ver0 < foo.txt
740
1305
    added version 0
741
1306
 
742
1307
    (create updated version)
743
1308
    % vi foo.txt
744
1309
    % weave get foo.weave 0 | diff -u - foo.txt
745
 
    % weave add foo.weave 0 < foo.txt
 
1310
    % weave add foo.weave ver1 0 < foo.txt
746
1311
    added version 1
747
1312
 
748
1313
    % weave get foo.weave 0 > foo.txt       (create forked version)
749
1314
    % vi foo.txt
750
 
    % weave add foo.weave 0 < foo.txt
 
1315
    % weave add foo.weave ver2 0 < foo.txt
751
1316
    added version 2
752
1317
 
753
1318
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
754
1319
    % vi foo.txt                            (resolve conflicts)
755
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
1320
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
756
1321
    
757
1322
"""
758
1323
    
761
1326
def main(argv):
762
1327
    import sys
763
1328
    import os
764
 
    from weavefile import write_weave, read_weave
 
1329
    try:
 
1330
        import bzrlib
 
1331
    except ImportError:
 
1332
        # in case we're run directly from the subdirectory
 
1333
        sys.path.append('..')
 
1334
        import bzrlib
 
1335
    from bzrlib.weavefile import write_weave, read_weave
765
1336
    from bzrlib.progress import ProgressBar
766
1337
 
767
 
    #import psyco
768
 
    #psyco.full()
 
1338
    try:
 
1339
        import psyco
 
1340
        psyco.full()
 
1341
    except ImportError:
 
1342
        pass
 
1343
 
 
1344
    if len(argv) < 2:
 
1345
        usage()
 
1346
        return 0
769
1347
 
770
1348
    cmd = argv[1]
771
1349
 
777
1355
    elif cmd == 'add':
778
1356
        w = readit()
779
1357
        # at the moment, based on everything in the file
780
 
        parents = map(int, argv[3:])
 
1358
        name = argv[3]
 
1359
        parents = map(int, argv[4:])
781
1360
        lines = sys.stdin.readlines()
782
 
        ver = w.add(parents, lines)
 
1361
        ver = w.add(name, parents, lines)
783
1362
        write_weave(w, file(argv[2], 'wb'))
784
 
        print 'added version %d' % ver
 
1363
        print 'added version %r %d' % (name, ver)
785
1364
    elif cmd == 'init':
786
1365
        fn = argv[2]
787
1366
        if os.path.exists(fn):
792
1371
        w = readit()
793
1372
        sys.stdout.writelines(w.get_iter(int(argv[3])))
794
1373
        
795
 
    elif cmd == 'mash': # get composite
 
1374
    elif cmd == 'diff':
796
1375
        w = readit()
797
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
798
 
 
 
1376
        fn = argv[2]
 
1377
        v1, v2 = map(int, argv[3:5])
 
1378
        lines1 = w.get(v1)
 
1379
        lines2 = w.get(v2)
 
1380
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1381
                                '%s version %d' % (fn, v1),
 
1382
                                '%s version %d' % (fn, v2))
 
1383
        sys.stdout.writelines(diff_gen)
 
1384
            
799
1385
    elif cmd == 'annotate':
800
1386
        w = readit()
801
1387
        # newline is added to all lines regardless; too hard to get
809
1395
                print '%5d | %s' % (origin, text)
810
1396
                lasto = origin
811
1397
                
812
 
    elif cmd == 'info':
813
 
        weave_info(readit())
 
1398
    elif cmd == 'toc':
 
1399
        weave_toc(readit())
814
1400
 
815
1401
    elif cmd == 'stats':
816
 
        weave_stats(argv[2])
 
1402
        weave_stats(argv[2], ProgressBar())
817
1403
        
818
1404
    elif cmd == 'check':
819
1405
        w = readit()
820
1406
        pb = ProgressBar()
821
1407
        w.check(pb)
822
1408
        pb.clear()
823
 
        print '%d versions ok' % w.numversions()
 
1409
        print '%d versions ok' % w.num_versions()
824
1410
 
825
1411
    elif cmd == 'inclusions':
826
1412
        w = readit()
831
1417
        print ' '.join(map(str, w._parents[int(argv[3])]))
832
1418
 
833
1419
    elif cmd == 'plan-merge':
 
1420
        # replaced by 'bzr weave-plan-merge'
834
1421
        w = readit()
835
1422
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
836
1423
            if line:
837
1424
                print '%14s | %s' % (state, line),
838
 
 
839
1425
    elif cmd == 'merge':
 
1426
        # replaced by 'bzr weave-merge-text'
840
1427
        w = readit()
841
1428
        p = w.plan_merge(int(argv[3]), int(argv[4]))
842
1429
        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
1430
    else:
865
1431
        raise ValueError('unknown command %r' % cmd)
866
1432
    
868
1434
if __name__ == '__main__':
869
1435
    import sys
870
1436
    sys.exit(main(sys.argv))
 
1437
 
 
1438
 
 
1439
class InterWeave(InterVersionedFile):
 
1440
    """Optimised code paths for weave to weave operations."""
 
1441
    
 
1442
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1443
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1444
    
 
1445
    @staticmethod
 
1446
    def is_compatible(source, target):
 
1447
        """Be compatible with weaves."""
 
1448
        try:
 
1449
            return (isinstance(source, Weave) and
 
1450
                    isinstance(target, Weave))
 
1451
        except AttributeError:
 
1452
            return False
 
1453
 
 
1454
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1455
        """See InterVersionedFile.join."""
 
1456
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1457
        if self.target.versions() == [] and version_ids is None:
 
1458
            self.target._copy_weave_content(self.source)
 
1459
            return
 
1460
        try:
 
1461
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1462
        except errors.WeaveParentMismatch:
 
1463
            self.target._reweave(self.source, pb, msg)
 
1464
 
 
1465
 
 
1466
InterVersionedFile.register_optimiser(InterWeave)