~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-08-18 18:17:19 UTC
  • mfrom: (1711.2.133 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060818181719-90004a4648d8537a
(cfbolz,hpk,robertc,jam) Add SFTP benchmark tests, and tests across a delayed socket

Show diffs side-by-side

added added

removed removed

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