~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2007-04-20 00:06:46 UTC
  • mto: This revision was merged to the branch mainline in revision 2441.
  • Revision ID: robertc@robertcollins.net-20070420000646-nwrkgumqaykrg1lz
Create a HelpContexts object to do help lookups.

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