~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

Fix BzrDir.create_workingtree for NULL_REVISION

Show diffs side-by-side

added added

removed removed

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