~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: John Arbash Meinel
  • Date: 2007-08-14 19:29:56 UTC
  • mto: This revision was merged to the branch mainline in revision 2698.
  • Revision ID: john@arbash-meinel.com-20070814192956-34h336i5q3m34ods
Switch bzr.dev to 0.91 development

Show diffs side-by-side

added added

removed removed

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