~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Aaron Bentley
  • Date: 2006-09-21 20:21:36 UTC
  • mto: (2027.1.2 revert-subpath-56549)
  • mto: This revision was merged to the branch mainline in revision 2031.
  • Revision ID: abentley@panoramicfeedback.com-20060921202136-e5a8deaadfa00021
Added test for preserving file mode

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
 
73
import os
70
74
import sha
71
 
from difflib import SequenceMatcher
 
75
import time
 
76
import warnings
72
77
 
73
78
from bzrlib.trace import mutter
74
 
from bzrlib.errors import WeaveError, WeaveFormatError, WeaveParentMismatch, \
75
 
        WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent
 
79
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
80
        RevisionAlreadyPresent,
 
81
        RevisionNotPresent,
 
82
        WeaveRevisionAlreadyPresent,
 
83
        WeaveRevisionNotPresent,
 
84
        )
 
85
import bzrlib.errors as errors
 
86
from bzrlib.osutils import sha_strings
 
87
import bzrlib.patiencediff
 
88
from bzrlib.symbol_versioning import (deprecated_method,
 
89
        deprecated_function,
 
90
        zero_eight,
 
91
        )
76
92
from bzrlib.tsort import topo_sort
77
 
 
78
 
 
79
 
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):
80
98
    """weave - versioned text file storage.
81
99
    
82
100
    A Weave manages versions of line-based text files, keeping track
166
184
    """
167
185
 
168
186
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
169
 
                 '_weave_name']
 
187
                 '_weave_name', '_matcher']
170
188
    
171
 
    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)
172
191
        self._weave = []
173
192
        self._parents = []
174
193
        self._sha1s = []
175
194
        self._names = []
176
195
        self._name_map = {}
177
196
        self._weave_name = weave_name
 
197
        if matcher is None:
 
198
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
199
        else:
 
200
            self._matcher = matcher
178
201
 
179
202
    def __repr__(self):
180
203
        return "Weave(%r)" % self._weave_name
181
204
 
182
 
 
183
205
    def copy(self):
184
206
        """Return a deep copy of self.
185
207
        
199
221
        return self._parents == other._parents \
200
222
               and self._weave == other._weave \
201
223
               and self._sha1s == other._sha1s 
202
 
 
203
224
    
204
225
    def __ne__(self, other):
205
226
        return not self.__eq__(other)
206
227
 
207
 
    def __contains__(self, name):
208
 
        return self._name_map.has_key(name)
209
 
 
210
 
    def maybe_lookup(self, name_or_index):
211
 
        """Convert possible symbolic name to index, or pass through indexes."""
212
 
        if isinstance(name_or_index, (int, long)):
213
 
            return name_or_index
214
 
        else:
215
 
            return self.lookup(name_or_index)
216
 
 
217
 
        
 
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)
218
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):
219
246
        """Convert symbolic version name to index."""
220
247
        try:
221
248
            return self._name_map[name]
222
249
        except KeyError:
223
 
            raise WeaveRevisionNotPresent(name, self)
224
 
 
 
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)
225
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."""
226
264
        return self._names[:]
227
265
 
228
 
    def iter_names(self):
229
 
        """Yield a list of all names in this weave."""
230
 
        return iter(self._names)
231
 
 
232
 
    def idx_to_name(self, version):
233
 
        return self._names[version]
 
266
    def has_version(self, version_id):
 
267
        """See VersionedFile.has_version."""
 
268
        return (version_id in self._name_map)
 
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)])
234
431
 
235
432
    def _check_repeated_add(self, name, parents, text, sha1):
236
433
        """Check that a duplicated add is OK.
237
434
 
238
435
        If it is, return the (old) index; otherwise raise an exception.
239
436
        """
240
 
        idx = self.lookup(name)
 
437
        idx = self._lookup(name)
241
438
        if sorted(self._parents[idx]) != sorted(parents) \
242
439
            or sha1 != self._sha1s[idx]:
243
 
            raise WeaveRevisionAlreadyPresent(name, self)
 
440
            raise RevisionAlreadyPresent(name, self._weave_name)
244
441
        return idx
245
 
        
 
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)
246
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):
247
458
        """Add a single text on top of the weave.
248
459
  
249
460
        Returns the index number of the newly added version.
250
461
 
251
 
        name
 
462
        version_id
252
463
            Symbolic name for this version.
253
464
            (Typically the revision-id of the revision that added it.)
254
465
 
255
466
        parents
256
467
            List or set of direct parent version numbers.
257
468
            
258
 
        text
 
469
        lines
259
470
            Sequence of lines to be added in the new version.
260
 
 
261
 
        sha -- SHA-1 of the file, if known.  This is trusted to be
262
 
            correct if supplied.
263
471
        """
264
 
        from bzrlib.osutils import sha_strings
265
 
 
266
 
        assert isinstance(name, basestring)
267
 
        if sha1 is None:
268
 
            sha1 = sha_strings(text)
269
 
        if name in self._name_map:
270
 
            return self._check_repeated_add(name, parents, text, sha1)
271
 
 
272
 
        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
 
273
481
        self._check_versions(parents)
274
 
        ## self._check_lines(text)
 
482
        ## self._check_lines(lines)
275
483
        new_version = len(self._parents)
276
484
 
277
 
 
278
485
        # if we abort after here the (in-memory) weave will be corrupt because only
279
486
        # some fields are updated
 
487
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
488
        #      - Robert Collins 20060226
280
489
        self._parents.append(parents[:])
281
490
        self._sha1s.append(sha1)
282
 
        self._names.append(name)
283
 
        self._name_map[name] = new_version
 
491
        self._names.append(version_id)
 
492
        self._name_map[version_id] = new_version
284
493
 
285
494
            
286
495
        if not parents:
288
497
            # this more quickly by just appending unconditionally.
289
498
            # even more specially, if we're adding an empty text we
290
499
            # need do nothing at all.
291
 
            if text:
 
500
            if lines:
292
501
                self._weave.append(('{', new_version))
293
 
                self._weave.extend(text)
 
502
                self._weave.extend(lines)
294
503
                self._weave.append(('}', None))
295
 
        
296
504
            return new_version
297
505
 
298
506
        if len(parents) == 1:
302
510
                return new_version
303
511
            
304
512
 
305
 
        ancestors = self.inclusions(parents)
 
513
        ancestors = self._inclusions(parents)
306
514
 
307
515
        l = self._weave
308
516
 
315
523
 
316
524
        # another small special case: a merge, producing the same text
317
525
        # as auto-merge
318
 
        if text == basis_lines:
 
526
        if lines == basis_lines:
319
527
            return new_version            
320
528
 
321
 
        # 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
322
530
        basis_lineno.append(len(self._weave))
323
531
 
324
532
        # XXX: which line of the weave should we really consider
328
536
        #print 'basis_lines:', basis_lines
329
537
        #print 'new_lines:  ', lines
330
538
 
331
 
        s = SequenceMatcher(None, basis_lines, text)
 
539
        s = self._matcher(None, basis_lines, lines)
332
540
 
333
541
        # offset gives the number of lines that have been inserted
334
542
        # into the weave up to the current point; if the original edit instruction
345
553
            i1 = basis_lineno[i1]
346
554
            i2 = basis_lineno[i2]
347
555
 
348
 
            assert 0 <= j1 <= j2 <= len(text)
 
556
            assert 0 <= j1 <= j2 <= len(lines)
349
557
 
350
558
            #print tag, i1, i2, j1, j2
351
559
 
362
570
                # we don't destroy ourselves
363
571
                i = i2 + offset
364
572
                self._weave[i:i] = ([('{', new_version)] 
365
 
                                    + text[j1:j2] 
 
573
                                    + lines[j1:j2] 
366
574
                                    + [('}', None)])
367
575
                offset += 2 + (j2 - j1)
368
 
 
369
576
        return new_version
370
577
 
371
 
    def add_identical(self, old_rev_id, new_rev_id, parents):
372
 
        """Add an identical text to old_rev_id as new_rev_id."""
373
 
        old_lines = self.get(self.lookup(old_rev_id))
374
 
        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)
375
582
 
376
 
    def inclusions(self, versions):
 
583
    def _inclusions(self, versions):
377
584
        """Return set of all ancestors of given version(s)."""
 
585
        if not len(versions):
 
586
            return []
378
587
        i = set(versions)
379
588
        for v in xrange(max(versions), 0, -1):
380
589
            if v in i:
384
593
        ## except IndexError:
385
594
        ##     raise ValueError("version %d not present in weave" % v)
386
595
 
387
 
 
388
 
    def parents(self, version):
389
 
        return self._parents[version]
390
 
 
391
 
 
392
 
    def parent_names(self, version):
393
 
        """Return version names for parents of a version."""
394
 
        return map(self.idx_to_name, self._parents[self.lookup(version)])
395
 
 
396
 
 
397
 
    def minimal_parents(self, version):
398
 
        """Find the minimal set of parents for the version."""
399
 
        included = self._parents[version]
400
 
        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:
401
600
            return []
402
 
        
403
 
        li = list(included)
404
 
        li.sort(reverse=True)
405
 
 
406
 
        mininc = []
407
 
        gotit = set()
408
 
 
409
 
        for pv in li:
410
 
            if pv not in gotit:
411
 
                mininc.append(pv)
412
 
                gotit.update(self.inclusions(pv))
413
 
 
414
 
        assert mininc[0] >= 0
415
 
        assert mininc[-1] < version
416
 
        return mininc
417
 
 
418
 
 
 
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]
419
612
 
420
613
    def _check_lines(self, text):
421
614
        if not isinstance(text, list):
436
629
            except IndexError:
437
630
                raise IndexError("invalid version number %r" % i)
438
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)
439
653
    
440
 
    def annotate(self, name_or_index):
441
 
        return list(self.annotate_iter(name_or_index))
442
 
 
443
 
 
444
 
    def annotate_iter(self, name_or_index):
445
 
        """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.
446
656
 
447
657
        The index indicates when the line originated in the weave."""
448
 
        incls = [self.maybe_lookup(name_or_index)]
 
658
        incls = [self._lookup(version_id)]
449
659
        for origin, lineno, text in self._extract(incls):
450
 
            yield origin, text
 
660
            yield self._idx_to_name(origin), text
451
661
 
 
662
    @deprecated_method(zero_eight)
452
663
    def _walk(self):
453
 
        """Walk the weave.
454
 
 
455
 
        Yields sequence of
456
 
        (lineno, insert, deletes, text)
457
 
        for each literal line.
458
 
        """
 
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."""
459
689
        
460
690
        istack = []
461
691
        dset = set()
463
693
        lineno = 0         # line of weave, 0-based
464
694
 
465
695
        for l in self._weave:
466
 
            if isinstance(l, tuple):
 
696
            if l.__class__ == tuple:
467
697
                c, v = l
468
698
                isactive = None
469
699
                if c == '{':
470
 
                    istack.append(v)
 
700
                    istack.append(self._names[v])
471
701
                elif c == '}':
472
702
                    istack.pop()
473
703
                elif c == '[':
474
 
                    assert v not in dset
475
 
                    dset.add(v)
 
704
                    assert self._names[v] not in dset
 
705
                    dset.add(self._names[v])
476
706
                elif c == ']':
477
 
                    dset.remove(v)
 
707
                    dset.remove(self._names[v])
478
708
                else:
479
709
                    raise WeaveFormatError('unexpected instruction %r' % v)
480
710
            else:
481
 
                assert isinstance(l, basestring)
 
711
                assert l.__class__ in (str, unicode)
482
712
                assert istack
483
 
                yield lineno, istack[-1], dset, l
 
713
                yield lineno, istack[-1], frozenset(dset), l
484
714
            lineno += 1
485
715
 
486
 
 
 
716
        if istack:
 
717
            raise WeaveFormatError("unclosed insertion blocks "
 
718
                    "at end of weave: %s" % istack)
 
719
        if dset:
 
720
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
721
                                   % dset)
 
722
 
 
723
    def plan_merge(self, ver_a, ver_b):
 
724
        """Return pseudo-annotation indicating how the two versions merge.
 
725
 
 
726
        This is computed between versions a and b and their common
 
727
        base.
 
728
 
 
729
        Weave lines present in none of them are skipped entirely.
 
730
        """
 
731
        inc_a = set(self.get_ancestry([ver_a]))
 
732
        inc_b = set(self.get_ancestry([ver_b]))
 
733
        inc_c = inc_a & inc_b
 
734
 
 
735
        for lineno, insert, deleteset, line in\
 
736
            self.walk([ver_a, ver_b]):
 
737
            if deleteset & inc_c:
 
738
                # killed in parent; can't be in either a or b
 
739
                # not relevant to our work
 
740
                yield 'killed-base', line
 
741
            elif insert in inc_c:
 
742
                # was inserted in base
 
743
                killed_a = bool(deleteset & inc_a)
 
744
                killed_b = bool(deleteset & inc_b)
 
745
                if killed_a and killed_b:
 
746
                    yield 'killed-both', line
 
747
                elif killed_a:
 
748
                    yield 'killed-a', line
 
749
                elif killed_b:
 
750
                    yield 'killed-b', line
 
751
                else:
 
752
                    yield 'unchanged', line
 
753
            elif insert in inc_a:
 
754
                if deleteset & inc_a:
 
755
                    yield 'ghost-a', line
 
756
                else:
 
757
                    # new in A; not in B
 
758
                    yield 'new-a', line
 
759
            elif insert in inc_b:
 
760
                if deleteset & inc_b:
 
761
                    yield 'ghost-b', line
 
762
                else:
 
763
                    yield 'new-b', line
 
764
            else:
 
765
                # not in either revision
 
766
                yield 'irrelevant', line
 
767
 
 
768
        yield 'unchanged', ''           # terminator
487
769
 
488
770
    def _extract(self, versions):
489
771
        """Yield annotation of lines in included set.
498
780
            if not isinstance(i, int):
499
781
                raise ValueError(i)
500
782
            
501
 
        included = self.inclusions(versions)
 
783
        included = self._inclusions(versions)
502
784
 
503
785
        istack = []
 
786
        iset = set()
504
787
        dset = set()
505
788
 
506
789
        lineno = 0         # line of weave, 0-based
511
794
 
512
795
        WFE = WeaveFormatError
513
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
 
514
824
        for l in self._weave:
515
 
            if isinstance(l, tuple):
 
825
            if l.__class__ == tuple:
516
826
                c, v = l
517
827
                isactive = None
518
828
                if c == '{':
519
 
                    assert v not in istack
 
829
                    assert v not in iset
520
830
                    istack.append(v)
 
831
                    iset.add(v)
521
832
                elif c == '}':
522
 
                    istack.pop()
 
833
                    iset.remove(istack.pop())
523
834
                elif c == '[':
524
835
                    if v in included:
525
836
                        assert v not in dset
530
841
                        assert v in dset
531
842
                        dset.remove(v)
532
843
            else:
533
 
                assert isinstance(l, basestring)
 
844
                assert l.__class__ in (str, unicode)
534
845
                if isactive is None:
535
846
                    isactive = (not dset) and istack and (istack[-1] in included)
536
847
                if isactive:
544
855
                                   % dset)
545
856
        return result
546
857
 
547
 
 
 
858
    @deprecated_method(zero_eight)
548
859
    def get_iter(self, name_or_index):
549
 
        """Yield lines for the specified version."""
550
 
        incls = [self.maybe_lookup(name_or_index)]
551
 
        for origin, lineno, line in self._extract(incls):
552
 
            yield line
553
 
 
554
 
 
555
 
    def get_text(self, name_or_index):
556
 
        return ''.join(self.get_iter(name_or_index))
557
 
        assert isinstance(version, int)
558
 
 
559
 
 
560
 
    def get_lines(self, name_or_index):
561
 
        return list(self.get_iter(name_or_index))
562
 
 
563
 
 
564
 
    get = get_lines
565
 
 
566
 
 
567
 
    def mash_iter(self, included):
568
 
        """Return composed version of multiple included versions."""
569
 
        included = map(self.maybe_lookup, included)
570
 
        for origin, lineno, text in self._extract(included):
571
 
            yield text
572
 
 
573
 
 
574
 
    def dump(self, to_file):
575
 
        from pprint import pprint
576
 
        print >>to_file, "Weave._weave = ",
577
 
        pprint(self._weave, to_file)
578
 
        print >>to_file, "Weave._parents = ",
579
 
        pprint(self._parents, to_file)
580
 
 
581
 
 
582
 
 
 
860
        """Deprecated, please do not use. Lookups are not not needed.
 
861
        
 
862
        Please use get_lines now.
 
863
        """
 
864
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
865
 
 
866
    @deprecated_method(zero_eight)
 
867
    def maybe_lookup(self, name_or_index):
 
868
        """Deprecated, please do not use. Lookups are not not needed."""
 
869
        return self._maybe_lookup(name_or_index)
 
870
 
 
871
    def _maybe_lookup(self, name_or_index):
 
872
        """Convert possible symbolic name to index, or pass through indexes.
 
873
        
 
874
        NOT FOR PUBLIC USE.
 
875
        """
 
876
        if isinstance(name_or_index, (int, long)):
 
877
            return name_or_index
 
878
        else:
 
879
            return self._lookup(name_or_index)
 
880
 
 
881
    @deprecated_method(zero_eight)
 
882
    def get(self, version_id):
 
883
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
884
        return self.get_lines(version_id)
 
885
 
 
886
    def get_lines(self, version_id):
 
887
        """See VersionedFile.get_lines()."""
 
888
        int_index = self._maybe_lookup(version_id)
 
889
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
890
        expected_sha1 = self._sha1s[int_index]
 
891
        measured_sha1 = sha_strings(result)
 
892
        if measured_sha1 != expected_sha1:
 
893
            raise errors.WeaveInvalidChecksum(
 
894
                    'file %s, revision %s, expected: %s, measured %s' 
 
895
                    % (self._weave_name, version_id,
 
896
                       expected_sha1, measured_sha1))
 
897
        return result
 
898
 
 
899
    def get_sha1(self, version_id):
 
900
        """See VersionedFile.get_sha1()."""
 
901
        return self._sha1s[self._lookup(version_id)]
 
902
 
 
903
    @deprecated_method(zero_eight)
583
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?"""
584
913
        l = len(self._parents)
585
914
        assert l == len(self._sha1s)
586
915
        return l
587
916
 
588
 
 
589
 
    def __len__(self):
590
 
        return self.numversions()
591
 
 
 
917
    __len__ = num_versions
592
918
 
593
919
    def check(self, progress_bar=None):
594
 
        # check no circular inclusions
595
 
        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()):
596
924
            inclusions = list(self._parents[version])
597
925
            if inclusions:
598
926
                inclusions.sort()
600
928
                    raise WeaveFormatError("invalid included version %d for index %d"
601
929
                                           % (inclusions[-1], version))
602
930
 
603
 
        # try extracting all versions; this is a bit slow and parallel
604
 
        # extraction could be used
605
 
        nv = self.numversions()
606
 
        for version in range(nv):
 
931
        # try extracting all versions; parallel extraction is used
 
932
        nv = self.num_versions()
 
933
        sha1s = {}
 
934
        texts = {}
 
935
        inclusions = {}
 
936
        for i in range(nv):
 
937
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
938
            # The problem is that set membership is much more expensive
 
939
            name = self._idx_to_name(i)
 
940
            sha1s[name] = sha.new()
 
941
            texts[name] = []
 
942
            new_inc = set([name])
 
943
            for p in self._parents[i]:
 
944
                new_inc.update(inclusions[self._idx_to_name(p)])
 
945
 
 
946
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
947
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
948
            inclusions[name] = new_inc
 
949
 
 
950
        nlines = len(self._weave)
 
951
 
 
952
        update_text = 'checking weave'
 
953
        if self._weave_name:
 
954
            short_name = os.path.basename(self._weave_name)
 
955
            update_text = 'checking %s' % (short_name,)
 
956
            update_text = update_text[:25]
 
957
 
 
958
        for lineno, insert, deleteset, line in self._walk_internal():
607
959
            if progress_bar:
608
 
                progress_bar.update('checking text', version, nv)
609
 
            s = sha.new()
610
 
            for l in self.get_iter(version):
611
 
                s.update(l)
612
 
            hd = s.hexdigest()
613
 
            expected = self._sha1s[version]
 
960
                progress_bar.update(update_text, lineno, nlines)
 
961
 
 
962
            for name, name_inclusions in inclusions.items():
 
963
                # The active inclusion must be an ancestor,
 
964
                # and no ancestors must have deleted this line,
 
965
                # because we don't support resurrection.
 
966
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
967
                    sha1s[name].update(line)
 
968
 
 
969
        for i in range(nv):
 
970
            version = self._idx_to_name(i)
 
971
            hd = sha1s[version].hexdigest()
 
972
            expected = self._sha1s[i]
614
973
            if hd != expected:
615
 
                raise WeaveError("mismatched sha1 for version %d; "
616
 
                                 "got %s, expected %s"
617
 
                                 % (version, hd, expected))
 
974
                raise errors.WeaveInvalidChecksum(
 
975
                        "mismatched sha1 for version %s: "
 
976
                        "got %s, expected %s"
 
977
                        % (version, hd, expected))
618
978
 
619
979
        # TODO: check insertions are properly nested, that there are
620
980
        # no lines outside of insertion blocks, that deletions are
621
981
        # properly paired, etc.
622
982
 
623
 
 
624
 
    def _delta(self, included, lines):
625
 
        """Return changes from basis to new revision.
626
 
 
627
 
        The old text for comparison is the union of included revisions.
628
 
 
629
 
        This is used in inserting a new text.
630
 
 
631
 
        Delta is returned as a sequence of
632
 
        (weave1, weave2, newlines).
633
 
 
634
 
        This indicates that weave1:weave2 of the old weave should be
635
 
        replaced by the sequence of lines in newlines.  Note that
636
 
        these line numbers are positions in the total weave and don't
637
 
        correspond to the lines in any extracted version, or even the
638
 
        extracted union of included versions.
639
 
 
640
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
641
 
        pure delete.  (Similar to difflib.)
642
 
        """
643
 
        raise NotImplementedError()
644
 
 
645
 
            
646
 
    def plan_merge(self, ver_a, ver_b):
647
 
        """Return pseudo-annotation indicating how the two versions merge.
648
 
 
649
 
        This is computed between versions a and b and their common
650
 
        base.
651
 
 
652
 
        Weave lines present in none of them are skipped entirely.
653
 
        """
654
 
        inc_a = self.inclusions([ver_a])
655
 
        inc_b = self.inclusions([ver_b])
656
 
        inc_c = inc_a & inc_b
657
 
 
658
 
        for lineno, insert, deleteset, line in self._walk():
659
 
            if deleteset & inc_c:
660
 
                # killed in parent; can't be in either a or b
661
 
                # not relevant to our work
662
 
                yield 'killed-base', line
663
 
            elif insert in inc_c:
664
 
                # was inserted in base
665
 
                killed_a = bool(deleteset & inc_a)
666
 
                killed_b = bool(deleteset & inc_b)
667
 
                if killed_a and killed_b:
668
 
                    yield 'killed-both', line
669
 
                elif killed_a:
670
 
                    yield 'killed-a', line
671
 
                elif killed_b:
672
 
                    yield 'killed-b', line
673
 
                else:
674
 
                    yield 'unchanged', line
675
 
            elif insert in inc_a:
676
 
                if deleteset & inc_a:
677
 
                    yield 'ghost-a', line
678
 
                else:
679
 
                    # new in A; not in B
680
 
                    yield 'new-a', line
681
 
            elif insert in inc_b:
682
 
                if deleteset & inc_b:
683
 
                    yield 'ghost-b', line
684
 
                else:
685
 
                    yield 'new-b', line
686
 
            else:
687
 
                # not in either revision
688
 
                yield 'irrelevant', line
689
 
 
690
 
        yield 'unchanged', ''           # terminator
691
 
 
692
 
 
693
 
 
694
 
    def weave_merge(self, plan):
695
 
        lines_a = []
696
 
        lines_b = []
697
 
        ch_a = ch_b = False
698
 
 
699
 
        for state, line in plan:
700
 
            if state == 'unchanged' or state == 'killed-both':
701
 
                # resync and flush queued conflicts changes if any
702
 
                if not lines_a and not lines_b:
703
 
                    pass
704
 
                elif ch_a and not ch_b:
705
 
                    # one-sided change:                    
706
 
                    for l in lines_a: yield l
707
 
                elif ch_b and not ch_a:
708
 
                    for l in lines_b: yield l
709
 
                elif lines_a == lines_b:
710
 
                    for l in lines_a: yield l
711
 
                else:
712
 
                    yield '<<<<<<<\n'
713
 
                    for l in lines_a: yield l
714
 
                    yield '=======\n'
715
 
                    for l in lines_b: yield l
716
 
                    yield '>>>>>>>\n'
717
 
 
718
 
                del lines_a[:]
719
 
                del lines_b[:]
720
 
                ch_a = ch_b = False
721
 
                
722
 
            if state == 'unchanged':
723
 
                if line:
724
 
                    yield line
725
 
            elif state == 'killed-a':
726
 
                ch_a = True
727
 
                lines_b.append(line)
728
 
            elif state == 'killed-b':
729
 
                ch_b = True
730
 
                lines_a.append(line)
731
 
            elif state == 'new-a':
732
 
                ch_a = True
733
 
                lines_a.append(line)
734
 
            elif state == 'new-b':
735
 
                ch_b = True
736
 
                lines_b.append(line)
737
 
            else:
738
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
739
 
                                 'killed-both'), \
740
 
                       state
741
 
 
742
 
                
743
 
    def join(self, other):
744
 
        """Integrate versions from other into this weave.
745
 
 
746
 
        The resulting weave contains all the history of both weaves; 
747
 
        any version you could retrieve from either self or other can be 
748
 
        retrieved from self after this call.
749
 
 
750
 
        It is illegal for the two weaves to contain different values 
751
 
        or different parents for any version.  See also reweave().
752
 
        """
753
 
        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():
754
986
            return          # nothing to update, easy
 
987
 
 
988
        if not version_ids:
 
989
            # versions is never none, InterWeave checks this.
 
990
            return 0
 
991
 
755
992
        # two loops so that we do not change ourselves before verifying it
756
993
        # will be ok
757
994
        # work through in index order to make sure we get all dependencies
758
 
        for other_idx, name in enumerate(other._names):
759
 
            if self._check_version_consistent(other, other_idx, name):
760
 
                continue
761
 
        for other_idx, name in enumerate(other._names):
762
 
            # TODO: If all the parents of the other version are already 
 
995
        names_to_join = []
 
996
        processed = 0
 
997
        # get the selected versions only that are in other.versions.
 
998
        version_ids = set(other.versions()).intersection(set(version_ids))
 
999
        # pull in the referenced graph.
 
1000
        version_ids = other.get_ancestry(version_ids)
 
1001
        pending_graph = [(version, other.get_parents(version)) for
 
1002
                         version in version_ids]
 
1003
        for name in topo_sort(pending_graph):
 
1004
            other_idx = other._name_map[name]
 
1005
            # returns True if we have it, False if we need it.
 
1006
            if not self._check_version_consistent(other, other_idx, name):
 
1007
                names_to_join.append((other_idx, name))
 
1008
            processed += 1
 
1009
 
 
1010
 
 
1011
        if pb and not msg:
 
1012
            msg = 'weave join'
 
1013
 
 
1014
        merged = 0
 
1015
        time0 = time.time()
 
1016
        for other_idx, name in names_to_join:
 
1017
            # TODO: If all the parents of the other version are already
763
1018
            # present then we can avoid some work by just taking the delta
764
1019
            # and adjusting the offsets.
765
1020
            new_parents = self._imported_parents(other, other_idx)
 
1021
            sha1 = other._sha1s[other_idx]
 
1022
 
 
1023
            merged += 1
 
1024
 
 
1025
            if pb:
 
1026
                pb.update(msg, merged, len(names_to_join))
 
1027
           
766
1028
            lines = other.get_lines(other_idx)
767
 
            sha1 = other._sha1s[other_idx]
768
 
            self.add(name, new_parents, lines, sha1)
769
 
 
770
 
 
 
1029
            self._add(name, lines, new_parents, sha1)
 
1030
 
 
1031
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
1032
                merged, processed, self._weave_name, time.time()-time0))
 
1033
 
771
1034
    def _imported_parents(self, other, other_idx):
772
1035
        """Return list of parents in self corresponding to indexes in other."""
773
1036
        new_parents = []
774
1037
        for parent_idx in other._parents[other_idx]:
775
1038
            parent_name = other._names[parent_idx]
776
 
            if parent_name not in self._names:
 
1039
            if parent_name not in self._name_map:
777
1040
                # should not be possible
778
1041
                raise WeaveError("missing parent {%s} of {%s} in %r" 
779
1042
                                 % (parent_name, other._name_map[other_idx], self))
795
1058
        this_idx = self._name_map.get(name, -1)
796
1059
        if this_idx != -1:
797
1060
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
798
 
                raise WeaveError("inconsistent texts for version {%s} "
799
 
                                 "when joining weaves"
800
 
                                 % (name))
 
1061
                raise errors.WeaveTextDiffers(name, self, other)
801
1062
            self_parents = self._parents[this_idx]
802
1063
            other_parents = other._parents[other_idx]
803
 
            n1 = [self._names[i] for i in self_parents]
804
 
            n2 = [other._names[i] for i in other_parents]
805
 
            n1.sort()
806
 
            n2.sort()
807
 
            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):
808
1067
                raise WeaveParentMismatch("inconsistent parents "
809
1068
                    "for version {%s}: %s vs %s" % (name, n1, n2))
810
1069
            else:
812
1071
        else:
813
1072
            return False
814
1073
 
815
 
    def reweave(self, other):
816
 
        """Reweave self with other."""
817
 
        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."""
818
1091
        for attr in self.__slots__:
819
 
            setattr(self, attr, getattr(new_weave, attr))
820
 
 
821
 
 
822
 
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_file(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_file(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):
823
1168
    """Combine two weaves and return the result.
824
1169
 
825
1170
    This works even if a revision R has different parents in 
830
1175
    might be possible but it should only be necessary to do 
831
1176
    this operation rarely, when a new previously ghost version is 
832
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
833
1181
    """
834
1182
    wr = Weave()
835
1183
    ia = ib = 0
836
 
    queue_a = range(wa.numversions())
837
 
    queue_b = range(wb.numversions())
 
1184
    queue_a = range(wa.num_versions())
 
1185
    queue_b = range(wb.num_versions())
838
1186
    # first determine combined parents of all versions
839
1187
    # map from version name -> all parent names
840
1188
    combined_parents = _reweave_parent_graphs(wa, wb)
841
1189
    mutter("combined parents: %r", combined_parents)
842
1190
    order = topo_sort(combined_parents.iteritems())
843
1191
    mutter("order to reweave: %r", order)
844
 
    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))
845
1199
        if name in wa._name_map:
846
1200
            lines = wa.get_lines(name)
847
1201
            if name in wb._name_map:
848
 
                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)
849
1211
        else:
850
1212
            lines = wb.get_lines(name)
851
 
        wr.add(name, combined_parents[name], lines)
 
1213
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
852
1214
    return wr
853
1215
 
854
 
 
855
1216
def _reweave_parent_graphs(wa, wb):
856
1217
    """Return combined parent ancestry for two weaves.
857
1218
    
860
1221
    for weave in [wa, wb]:
861
1222
        for idx, name in enumerate(weave._names):
862
1223
            p = combined.setdefault(name, set())
863
 
            p.update(map(weave.idx_to_name, weave._parents[idx]))
 
1224
            p.update(map(weave._idx_to_name, weave._parents[idx]))
864
1225
    return combined
865
1226
 
866
1227
 
870
1231
    for i in (6, 50, 10, 10):
871
1232
        print '-' * i,
872
1233
    print
873
 
    for i in range(w.numversions()):
 
1234
    for i in range(w.num_versions()):
874
1235
        sha1 = w._sha1s[i]
875
1236
        name = w._names[i]
876
1237
        parent_str = ' '.join(map(str, w._parents[i]))
923
1284
        Add NEWTEXT, with specified parent versions.
924
1285
    weave annotate WEAVEFILE VERSION
925
1286
        Display origin of each line.
926
 
    weave mash WEAVEFILE VERSION...
927
 
        Display composite of all selected versions.
928
1287
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
929
1288
        Auto-merge two versions and display conflicts.
930
1289
    weave diff WEAVEFILE VERSION1 VERSION2 
1004
1363
        w = readit()
1005
1364
        sys.stdout.writelines(w.get_iter(int(argv[3])))
1006
1365
        
1007
 
    elif cmd == 'mash': # get composite
1008
 
        w = readit()
1009
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
1010
 
 
1011
1366
    elif cmd == 'diff':
1012
 
        from difflib import unified_diff
1013
1367
        w = readit()
1014
1368
        fn = argv[2]
1015
1369
        v1, v2 = map(int, argv[3:5])
1016
1370
        lines1 = w.get(v1)
1017
1371
        lines2 = w.get(v2)
1018
 
        diff_gen = unified_diff(lines1, lines2,
 
1372
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
1019
1373
                                '%s version %d' % (fn, v1),
1020
1374
                                '%s version %d' % (fn, v2))
1021
1375
        sys.stdout.writelines(diff_gen)
1044
1398
        pb = ProgressBar()
1045
1399
        w.check(pb)
1046
1400
        pb.clear()
1047
 
        print '%d versions ok' % w.numversions()
 
1401
        print '%d versions ok' % w.num_versions()
1048
1402
 
1049
1403
    elif cmd == 'inclusions':
1050
1404
        w = readit()
1055
1409
        print ' '.join(map(str, w._parents[int(argv[3])]))
1056
1410
 
1057
1411
    elif cmd == 'plan-merge':
 
1412
        # replaced by 'bzr weave-plan-merge'
1058
1413
        w = readit()
1059
1414
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1060
1415
            if line:
1061
1416
                print '%14s | %s' % (state, line),
1062
 
 
1063
1417
    elif cmd == 'merge':
 
1418
        # replaced by 'bzr weave-merge-text'
1064
1419
        w = readit()
1065
1420
        p = w.plan_merge(int(argv[3]), int(argv[4]))
1066
1421
        sys.stdout.writelines(w.weave_merge(p))
1067
 
            
1068
 
    elif cmd == 'mash-merge':
1069
 
        if len(argv) != 5:
1070
 
            usage()
1071
 
            return 1
1072
 
 
1073
 
        w = readit()
1074
 
        v1, v2 = map(int, argv[3:5])
1075
 
 
1076
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
1077
 
 
1078
 
        base_lines = list(w.mash_iter(basis))
1079
 
        a_lines = list(w.get(v1))
1080
 
        b_lines = list(w.get(v2))
1081
 
 
1082
 
        from bzrlib.merge3 import Merge3
1083
 
        m3 = Merge3(base_lines, a_lines, b_lines)
1084
 
 
1085
 
        name_a = 'version %d' % v1
1086
 
        name_b = 'version %d' % v2
1087
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
1088
1422
    else:
1089
1423
        raise ValueError('unknown command %r' % cmd)
1090
1424
    
1091
1425
 
1092
 
 
1093
 
def profile_main(argv): 
1094
 
    import tempfile, hotshot, hotshot.stats
1095
 
 
1096
 
    prof_f = tempfile.NamedTemporaryFile()
1097
 
 
1098
 
    prof = hotshot.Profile(prof_f.name)
1099
 
 
1100
 
    ret = prof.runcall(main, argv)
1101
 
    prof.close()
1102
 
 
1103
 
    stats = hotshot.stats.load(prof_f.name)
1104
 
    #stats.strip_dirs()
1105
 
    stats.sort_stats('cumulative')
1106
 
    ## XXX: Might like to write to stderr or the trace file instead but
1107
 
    ## print_stats seems hardcoded to stdout
1108
 
    stats.print_stats(20)
1109
 
            
1110
 
    return ret
1111
 
 
1112
 
 
1113
1426
if __name__ == '__main__':
1114
1427
    import sys
1115
 
    if '--profile' in sys.argv:
1116
 
        args = sys.argv[:]
1117
 
        args.remove('--profile')
1118
 
        sys.exit(profile_main(args))
1119
 
    else:
1120
 
        sys.exit(main(sys.argv))
1121
 
 
 
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)