~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2005-10-06 22:15:52 UTC
  • mfrom: (1185.13.2)
  • mto: This revision was merged to the branch mainline in revision 1420.
  • Revision ID: robertc@robertcollins.net-20051006221552-9b15c96fa504e0ad
mergeĀ fromĀ upstream

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