~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Aaron Bentley
  • Date: 2006-11-10 01:55:55 UTC
  • mto: This revision was merged to the branch mainline in revision 2127.
  • Revision ID: aaron.bentley@utoronto.ca-20061110015555-f48202744b630209
Ignore html docs (both kinds)

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