~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

- tweak diff shown by assertEqualDiff

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