/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Andrew Bennetts
  • Date: 2008-04-02 00:14:00 UTC
  • mfrom: (3324 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080402001400-r1pqse38i03dl97w
Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
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
21
21
 
22
22
"""Weave - storage of related text file versions"""
23
23
 
24
 
# before intset (r923) 2000 versions in 41.5s
25
 
# with intset (r926) 2000 versions in 93s !!!
26
 
# better to just use plain sets.
27
 
 
28
 
# making _extract build and return a list, rather than being a generator
29
 
# takes 37.94s
30
 
 
31
 
# with python -O, r923 does 2000 versions in 36.87s
32
 
 
33
 
# with optimizations to avoid mutating lists - 35.75!  I guess copying
34
 
# all the elements every time costs more than the small manipulations.
35
 
# a surprisingly small change.
36
 
 
37
 
# r931, which avoids using a generator for extract, does 36.98s
38
 
 
39
 
# with memoized inclusions, takes 41.49s; not very good
40
 
 
41
 
# with slots, takes 37.35s; without takes 39.16, a bit surprising
42
 
 
43
 
# with the delta calculation mixed in with the add method, rather than
44
 
# separated, takes 36.78s
45
 
 
46
 
# with delta folded in and mutation of the list, 36.13s
47
 
 
48
 
# with all this and simplification of add code, 33s 
49
 
 
50
 
 
51
 
# TODO: Perhaps have copy method for Weave instances?
52
24
 
53
25
# XXX: If we do weaves this way, will a merge still behave the same
54
26
# way if it's done in a different order?  That's a pretty desirable
55
27
# property.
56
28
 
57
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
58
 
# 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
59
31
# binaries, perhaps by naively splitting on \n or perhaps using
60
32
# something like a rolling checksum.
61
33
 
62
 
# TODO: Track version names as well as indexes. 
63
 
 
64
34
# TODO: End marker for each version so we can stop reading?
65
35
 
66
36
# TODO: Check that no insertion occurs inside a deletion that was
73
43
 
74
44
# TODO: Parallel-extract that passes back each line along with a
75
45
# description of which revisions include it.  Nice for checking all
76
 
# shas in parallel.
77
 
 
78
 
 
79
 
 
80
 
 
81
 
class WeaveError(Exception):
82
 
    """Exception in processing weave"""
83
 
 
84
 
 
85
 
class WeaveFormatError(WeaveError):
86
 
    """Weave invariant violated"""
87
 
    
88
 
 
89
 
class Weave(object):
 
46
# shas or calculating stats in parallel.
 
47
 
 
48
# TODO: Using a single _extract routine and then processing the output
 
49
# is probably inefficient.  It's simple enough that we can afford to
 
50
# have slight specializations for different ways its used: annotate,
 
51
# basis for add, get, etc.
 
52
 
 
53
# TODO: Probably the API should work only in names to hide the integer
 
54
# indexes from the user.
 
55
 
 
56
# TODO: Is there any potential performance win by having an add()
 
57
# variant that is passed a pre-cooked version of the single basis
 
58
# version?
 
59
 
 
60
# TODO: Reweave can possibly be made faster by remembering diffs
 
61
# where the basis and destination are unchanged.
 
62
 
 
63
# FIXME: Sometimes we will be given a parents list for a revision
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
 
66
# be done fairly efficiently because the sequence numbers constrain
 
67
# the possible relationships.
 
68
 
 
69
# FIXME: the conflict markers should be *7* characters
 
70
 
 
71
from copy import copy
 
72
from cStringIO import StringIO
 
73
import os
 
74
import sha
 
75
import time
 
76
import warnings
 
77
 
 
78
from bzrlib.lazy_import import lazy_import
 
79
lazy_import(globals(), """
 
80
from bzrlib import tsort
 
81
""")
 
82
from bzrlib import (
 
83
    progress,
 
84
    )
 
85
from bzrlib.trace import mutter
 
86
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
87
        RevisionAlreadyPresent,
 
88
        RevisionNotPresent,
 
89
        WeaveRevisionAlreadyPresent,
 
90
        WeaveRevisionNotPresent,
 
91
        )
 
92
import bzrlib.errors as errors
 
93
from bzrlib.osutils import sha_strings
 
94
import bzrlib.patiencediff
 
95
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
96
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
97
 
 
98
 
 
99
class Weave(VersionedFile):
90
100
    """weave - versioned text file storage.
91
101
    
92
102
    A Weave manages versions of line-based text files, keeping track
118
128
    The instruction can be '{' or '}' for an insertion block, and '['
119
129
    and ']' for a deletion block respectively.  The version is the
120
130
    integer version index.  There is no replace operator, only deletes
121
 
    and inserts.
 
131
    and inserts.  For '}', the end of an insertion, there is no
 
132
    version parameter because it always closes the most recently
 
133
    opened insertion.
122
134
 
123
135
    Constraints/notes:
124
136
 
160
172
        each version; the parent's parents are implied.
161
173
 
162
174
    _sha1s
163
 
        List of hex SHA-1 of each version, or None if not recorded.
 
175
        List of hex SHA-1 of each version.
 
176
 
 
177
    _names
 
178
        List of symbolic names for each version.  Each should be unique.
 
179
 
 
180
    _name_map
 
181
        For each name, the version number.
 
182
 
 
183
    _weave_name
 
184
        Descriptive name of this weave; typically the filename if known.
 
185
        Set by read_weave.
164
186
    """
165
187
 
166
 
    __slots__ = ['_weave', '_parents', '_sha1s']
 
188
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
189
                 '_weave_name', '_matcher']
167
190
    
168
 
    def __init__(self):
 
191
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
 
192
        super(Weave, self).__init__(access_mode)
169
193
        self._weave = []
170
194
        self._parents = []
171
195
        self._sha1s = []
172
 
 
 
196
        self._names = []
 
197
        self._name_map = {}
 
198
        self._weave_name = weave_name
 
199
        if matcher is None:
 
200
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
201
        else:
 
202
            self._matcher = matcher
 
203
 
 
204
    def __repr__(self):
 
205
        return "Weave(%r)" % self._weave_name
 
206
 
 
207
    def copy(self):
 
208
        """Return a deep copy of self.
 
209
        
 
210
        The copy can be modified without affecting the original weave."""
 
211
        other = Weave()
 
212
        other._weave = self._weave[:]
 
213
        other._parents = self._parents[:]
 
214
        other._sha1s = self._sha1s[:]
 
215
        other._names = self._names[:]
 
216
        other._name_map = self._name_map.copy()
 
217
        other._weave_name = self._weave_name
 
218
        return other
173
219
 
174
220
    def __eq__(self, other):
175
221
        if not isinstance(other, Weave):
176
222
            return False
177
223
        return self._parents == other._parents \
178
 
               and self._weave == other._weave
 
224
               and self._weave == other._weave \
 
225
               and self._sha1s == other._sha1s 
179
226
    
180
 
 
181
227
    def __ne__(self, other):
182
228
        return not self.__eq__(other)
183
229
 
184
 
        
185
 
    def add(self, parents, text):
 
230
    def _idx_to_name(self, version):
 
231
        return self._names[version]
 
232
 
 
233
    def _lookup(self, name):
 
234
        """Convert symbolic version name to index."""
 
235
        self.check_not_reserved_id(name)
 
236
        try:
 
237
            return self._name_map[name]
 
238
        except KeyError:
 
239
            raise RevisionNotPresent(name, self._weave_name)
 
240
 
 
241
    def versions(self):
 
242
        """See VersionedFile.versions."""
 
243
        return self._names[:]
 
244
 
 
245
    def has_version(self, version_id):
 
246
        """See VersionedFile.has_version."""
 
247
        return (version_id in self._name_map)
 
248
 
 
249
    __contains__ = has_version
 
250
 
 
251
    def get_parent_map(self, version_ids):
 
252
        """See VersionedFile.get_parent_map."""
 
253
        result = {}
 
254
        for version_id in version_ids:
 
255
            try:
 
256
                result[version_id] = tuple(
 
257
                    map(self._idx_to_name, self._parents[self._lookup(version_id)]))
 
258
            except RevisionNotPresent:
 
259
                pass
 
260
        return result
 
261
 
 
262
    def get_parents_with_ghosts(self, version_id):
 
263
        raise NotImplementedError(self.get_parents_with_ghosts)
 
264
 
 
265
    def _check_repeated_add(self, name, parents, text, sha1):
 
266
        """Check that a duplicated add is OK.
 
267
 
 
268
        If it is, return the (old) index; otherwise raise an exception.
 
269
        """
 
270
        idx = self._lookup(name)
 
271
        if sorted(self._parents[idx]) != sorted(parents) \
 
272
            or sha1 != self._sha1s[idx]:
 
273
            raise RevisionAlreadyPresent(name, self._weave_name)
 
274
        return idx
 
275
 
 
276
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
277
       left_matching_blocks, nostore_sha, random_id, check_content):
 
278
        """See VersionedFile.add_lines."""
 
279
        idx = self._add(version_id, lines, map(self._lookup, parents),
 
280
            nostore_sha=nostore_sha)
 
281
        return sha_strings(lines), sum(map(len, lines)), idx
 
282
 
 
283
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
186
284
        """Add a single text on top of the weave.
187
285
  
188
286
        Returns the index number of the newly added version.
189
287
 
 
288
        version_id
 
289
            Symbolic name for this version.
 
290
            (Typically the revision-id of the revision that added it.)
 
291
 
190
292
        parents
191
293
            List or set of direct parent version numbers.
192
294
            
193
 
        text
194
 
            Sequence of lines to be added in the new version."""
 
295
        lines
 
296
            Sequence of lines to be added in the new version.
 
297
 
 
298
        :param nostore_sha: See VersionedFile.add_lines.
 
299
        """
 
300
        assert isinstance(version_id, basestring)
 
301
        self._check_lines_not_unicode(lines)
 
302
        self._check_lines_are_lines(lines)
 
303
        if not sha1:
 
304
            sha1 = sha_strings(lines)
 
305
        if sha1 == nostore_sha:
 
306
            raise errors.ExistingContent
 
307
        if version_id in self._name_map:
 
308
            return self._check_repeated_add(version_id, parents, lines, sha1)
195
309
 
196
310
        self._check_versions(parents)
197
 
        ## self._check_lines(text)
 
311
        ## self._check_lines(lines)
198
312
        new_version = len(self._parents)
199
313
 
200
 
        import sha
201
 
        s = sha.new()
202
 
        map(s.update, text)
203
 
        sha1 = s.hexdigest()
204
 
        del s
205
 
 
206
 
        # if we abort after here the weave will be corrupt
207
 
        self._parents.append(frozenset(parents))
 
314
        # if we abort after here the (in-memory) weave will be corrupt because only
 
315
        # some fields are updated
 
316
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
317
        #      - Robert Collins 20060226
 
318
        self._parents.append(parents[:])
208
319
        self._sha1s.append(sha1)
 
320
        self._names.append(version_id)
 
321
        self._name_map[version_id] = new_version
209
322
 
210
323
            
211
324
        if not parents:
213
326
            # this more quickly by just appending unconditionally.
214
327
            # even more specially, if we're adding an empty text we
215
328
            # need do nothing at all.
216
 
            if text:
 
329
            if lines:
217
330
                self._weave.append(('{', new_version))
218
 
                self._weave.extend(text)
219
 
                self._weave.append(('}', new_version))
220
 
        
 
331
                self._weave.extend(lines)
 
332
                self._weave.append(('}', None))
221
333
            return new_version
222
334
 
223
335
        if len(parents) == 1:
227
339
                return new_version
228
340
            
229
341
 
230
 
        ancestors = self.inclusions(parents)
 
342
        ancestors = self._inclusions(parents)
231
343
 
232
344
        l = self._weave
233
345
 
238
350
            basis_lineno.append(lineno)
239
351
            basis_lines.append(line)
240
352
 
241
 
        # another small special case: a merge, producing the same text as auto-merge
242
 
        if text == basis_lines:
243
 
            return new_version            
 
353
        # another small special case: a merge, producing the same text
 
354
        # as auto-merge
 
355
        if lines == basis_lines:
 
356
            return new_version
244
357
 
245
 
        # add a sentinal, because we can also match against the final line
 
358
        # add a sentinel, because we can also match against the final line
246
359
        basis_lineno.append(len(self._weave))
247
360
 
248
361
        # XXX: which line of the weave should we really consider
252
365
        #print 'basis_lines:', basis_lines
253
366
        #print 'new_lines:  ', lines
254
367
 
255
 
        from difflib import SequenceMatcher
256
 
        s = SequenceMatcher(None, basis_lines, text)
 
368
        s = self._matcher(None, basis_lines, lines)
257
369
 
258
370
        # offset gives the number of lines that have been inserted
259
371
        # into the weave up to the current point; if the original edit instruction
270
382
            i1 = basis_lineno[i1]
271
383
            i2 = basis_lineno[i2]
272
384
 
273
 
            assert 0 <= j1 <= j2 <= len(text)
 
385
            assert 0 <= j1 <= j2 <= len(lines)
274
386
 
275
387
            #print tag, i1, i2, j1, j2
276
388
 
287
399
                # we don't destroy ourselves
288
400
                i = i2 + offset
289
401
                self._weave[i:i] = ([('{', new_version)] 
290
 
                                + text[j1:j2] 
291
 
                                + [('}', new_version)])
 
402
                                    + lines[j1:j2] 
 
403
                                    + [('}', None)])
292
404
                offset += 2 + (j2 - j1)
293
 
 
294
405
        return new_version
295
406
 
 
407
    def _clone_text(self, new_version_id, old_version_id, parents):
 
408
        """See VersionedFile.clone_text."""
 
409
        old_lines = self.get_text(old_version_id)
 
410
        self.add_lines(new_version_id, parents, old_lines)
296
411
 
297
 
    def inclusions(self, versions):
 
412
    def _inclusions(self, versions):
298
413
        """Return set of all ancestors of given version(s)."""
 
414
        if not len(versions):
 
415
            return []
299
416
        i = set(versions)
300
 
        v = max(versions)
301
 
        try:
302
 
            while v >= 0:
303
 
                if v in i:
304
 
                    # include all its parents
305
 
                    i.update(self._parents[v])
306
 
                v -= 1
307
 
            return i
308
 
        except IndexError:
309
 
            raise ValueError("version %d not present in weave" % v)
310
 
 
311
 
 
312
 
    def minimal_parents(self, version):
313
 
        """Find the minimal set of parents for the version."""
314
 
        included = self._parents[version]
315
 
        if not included:
316
 
            return []
317
 
        
318
 
        li = list(included)
319
 
        li.sort(reverse=True)
320
 
 
321
 
        mininc = []
322
 
        gotit = set()
323
 
 
324
 
        for pv in li:
325
 
            if pv not in gotit:
326
 
                mininc.append(pv)
327
 
                gotit.update(self.inclusions(pv))
328
 
 
329
 
        assert mininc[0] >= 0
330
 
        assert mininc[-1] < version
331
 
        return mininc
332
 
 
333
 
 
 
417
        for v in xrange(max(versions), 0, -1):
 
418
            if v in i:
 
419
                # include all its parents
 
420
                i.update(self._parents[v])
 
421
        return i
 
422
        ## except IndexError:
 
423
        ##     raise ValueError("version %d not present in weave" % v)
 
424
 
 
425
    def get_ancestry(self, version_ids, topo_sorted=True):
 
426
        """See VersionedFile.get_ancestry."""
 
427
        if isinstance(version_ids, basestring):
 
428
            version_ids = [version_ids]
 
429
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
430
        return [self._idx_to_name(v) for v in i]
334
431
 
335
432
    def _check_lines(self, text):
336
433
        if not isinstance(text, list):
351
448
            except IndexError:
352
449
                raise IndexError("invalid version number %r" % i)
353
450
 
354
 
    
355
 
    def annotate(self, index):
356
 
        return list(self.annotate_iter(index))
357
 
 
358
 
 
359
 
    def annotate_iter(self, version):
360
 
        """Yield list of (index-id, line) pairs for the specified version.
 
451
    def _compatible_parents(self, my_parents, other_parents):
 
452
        """During join check that other_parents are joinable with my_parents.
 
453
 
 
454
        Joinable is defined as 'is a subset of' - supersets may require 
 
455
        regeneration of diffs, but subsets do not.
 
456
        """
 
457
        return len(other_parents.difference(my_parents)) == 0
 
458
 
 
459
    def annotate_iter(self, version_id):
 
460
        """Yield list of (version-id, line) pairs for the specified version.
361
461
 
362
462
        The index indicates when the line originated in the weave."""
363
 
        for origin, lineno, text in self._extract([version]):
364
 
            yield origin, text
365
 
 
366
 
 
367
 
    def _walk(self):
368
 
        """Walk the weave.
369
 
 
370
 
        Yields sequence of
371
 
        (lineno, insert, deletes, text)
372
 
        for each literal line.
373
 
        """
 
463
        incls = [self._lookup(version_id)]
 
464
        for origin, lineno, text in self._extract(incls):
 
465
            yield self._idx_to_name(origin), text
 
466
 
 
467
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
468
                                                pb=None):
 
469
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
470
        if version_ids is None:
 
471
            version_ids = self.versions()
 
472
        version_ids = set(version_ids)
 
473
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
474
            # if inserted not in version_ids then it was inserted before the
 
475
            # versions we care about, but because weaves cannot represent ghosts
 
476
            # properly, we do not filter down to that
 
477
            # if inserted not in version_ids: continue
 
478
            if line[-1] != '\n':
 
479
                yield line + '\n', inserted
 
480
            else:
 
481
                yield line, inserted
 
482
 
 
483
    def _walk_internal(self, version_ids=None):
 
484
        """Helper method for weave actions."""
374
485
        
375
486
        istack = []
376
487
        dset = set()
378
489
        lineno = 0         # line of weave, 0-based
379
490
 
380
491
        for l in self._weave:
381
 
            if isinstance(l, tuple):
 
492
            if l.__class__ == tuple:
382
493
                c, v = l
383
494
                isactive = None
384
495
                if c == '{':
385
 
                    istack.append(v)
 
496
                    istack.append(self._names[v])
386
497
                elif c == '}':
387
 
                    oldv = istack.pop()
 
498
                    istack.pop()
388
499
                elif c == '[':
389
 
                    assert v not in dset
390
 
                    dset.add(v)
 
500
                    assert self._names[v] not in dset
 
501
                    dset.add(self._names[v])
391
502
                elif c == ']':
392
 
                    dset.remove(v)
 
503
                    dset.remove(self._names[v])
393
504
                else:
394
 
                    raise WeaveFormatError('unexpected instruction %r'
395
 
                                           % v)
 
505
                    raise WeaveFormatError('unexpected instruction %r' % v)
396
506
            else:
397
 
                assert isinstance(l, basestring)
 
507
                assert l.__class__ in (str, unicode)
398
508
                assert istack
399
 
                yield lineno, istack[-1], dset, l
 
509
                yield lineno, istack[-1], frozenset(dset), l
400
510
            lineno += 1
401
511
 
402
 
 
 
512
        if istack:
 
513
            raise WeaveFormatError("unclosed insertion blocks "
 
514
                    "at end of weave: %s" % istack)
 
515
        if dset:
 
516
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
517
                                   % dset)
 
518
 
 
519
    def plan_merge(self, ver_a, ver_b):
 
520
        """Return pseudo-annotation indicating how the two versions merge.
 
521
 
 
522
        This is computed between versions a and b and their common
 
523
        base.
 
524
 
 
525
        Weave lines present in none of them are skipped entirely.
 
526
        """
 
527
        inc_a = set(self.get_ancestry([ver_a]))
 
528
        inc_b = set(self.get_ancestry([ver_b]))
 
529
        inc_c = inc_a & inc_b
 
530
 
 
531
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
532
            if deleteset & inc_c:
 
533
                # killed in parent; can't be in either a or b
 
534
                # not relevant to our work
 
535
                yield 'killed-base', line
 
536
            elif insert in inc_c:
 
537
                # was inserted in base
 
538
                killed_a = bool(deleteset & inc_a)
 
539
                killed_b = bool(deleteset & inc_b)
 
540
                if killed_a and killed_b:
 
541
                    yield 'killed-both', line
 
542
                elif killed_a:
 
543
                    yield 'killed-a', line
 
544
                elif killed_b:
 
545
                    yield 'killed-b', line
 
546
                else:
 
547
                    yield 'unchanged', line
 
548
            elif insert in inc_a:
 
549
                if deleteset & inc_a:
 
550
                    yield 'ghost-a', line
 
551
                else:
 
552
                    # new in A; not in B
 
553
                    yield 'new-a', line
 
554
            elif insert in inc_b:
 
555
                if deleteset & inc_b:
 
556
                    yield 'ghost-b', line
 
557
                else:
 
558
                    yield 'new-b', line
 
559
            else:
 
560
                # not in either revision
 
561
                yield 'irrelevant', line
 
562
 
 
563
        yield 'unchanged', ''           # terminator
403
564
 
404
565
    def _extract(self, versions):
405
566
        """Yield annotation of lines in included set.
410
571
 
411
572
        The set typically but not necessarily corresponds to a version.
412
573
        """
413
 
        included = self.inclusions(versions)
 
574
        for i in versions:
 
575
            if not isinstance(i, int):
 
576
                raise ValueError(i)
 
577
            
 
578
        included = self._inclusions(versions)
414
579
 
415
580
        istack = []
 
581
        iset = set()
416
582
        dset = set()
417
583
 
418
584
        lineno = 0         # line of weave, 0-based
423
589
 
424
590
        WFE = WeaveFormatError
425
591
 
 
592
        # wow. 
 
593
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
594
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
595
        # 1.6 seconds in 'isinstance'.
 
596
        # changing the first isinstance:
 
597
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
598
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
599
        # note that the inline time actually dropped (less function calls)
 
600
        # and total processing time was halved.
 
601
        # we're still spending ~1/4 of the method in isinstance though.
 
602
        # so lets hard code the acceptable string classes we expect:
 
603
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
604
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
605
        #                                          objects>
 
606
        # yay, down to ~1/4 the initial extract time, and our inline time
 
607
        # has shrunk again, with isinstance no longer dominating.
 
608
        # tweaking the stack inclusion test to use a set gives:
 
609
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
610
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
611
        #                                          objects>
 
612
        # - a 5% win, or possibly just noise. However with large istacks that
 
613
        # 'in' test could dominate, so I'm leaving this change in place -
 
614
        # when its fast enough to consider profiling big datasets we can review.
 
615
 
 
616
              
 
617
             
 
618
 
426
619
        for l in self._weave:
427
 
            if isinstance(l, tuple):
 
620
            if l.__class__ == tuple:
428
621
                c, v = l
429
622
                isactive = None
430
623
                if c == '{':
431
 
                    assert v not in istack
 
624
                    assert v not in iset
432
625
                    istack.append(v)
 
626
                    iset.add(v)
433
627
                elif c == '}':
434
 
                    oldv = istack.pop()
435
 
                    assert oldv == v
 
628
                    iset.remove(istack.pop())
436
629
                elif c == '[':
437
630
                    if v in included:
438
631
                        assert v not in dset
443
636
                        assert v in dset
444
637
                        dset.remove(v)
445
638
            else:
446
 
                assert isinstance(l, basestring)
 
639
                assert l.__class__ in (str, unicode)
447
640
                if isactive is None:
448
641
                    isactive = (not dset) and istack and (istack[-1] in included)
449
642
                if isactive:
450
643
                    result.append((istack[-1], lineno, l))
451
644
            lineno += 1
452
 
 
453
645
        if istack:
454
 
            raise WFE("unclosed insertion blocks at end of weave",
455
 
                                   istack)
 
646
            raise WeaveFormatError("unclosed insertion blocks "
 
647
                    "at end of weave: %s" % istack)
456
648
        if dset:
457
 
            raise WFE("unclosed deletion blocks at end of weave",
458
 
                                   dset)
459
 
 
460
 
        return result
461
 
    
462
 
 
463
 
 
464
 
    def get_iter(self, version):
465
 
        """Yield lines for the specified version."""
466
 
        for origin, lineno, line in self._extract([version]):
467
 
            yield line
468
 
 
469
 
 
470
 
    def get(self, index):
471
 
        return list(self.get_iter(index))
472
 
 
473
 
 
474
 
    def mash_iter(self, included):
475
 
        """Return composed version of multiple included versions."""
476
 
        for origin, lineno, text in self._extract(included):
477
 
            yield text
478
 
 
479
 
 
480
 
    def dump(self, to_file):
481
 
        from pprint import pprint
482
 
        print >>to_file, "Weave._weave = ",
483
 
        pprint(self._weave, to_file)
484
 
        print >>to_file, "Weave._parents = ",
485
 
        pprint(self._parents, to_file)
486
 
 
487
 
 
488
 
 
489
 
    def numversions(self):
 
649
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
650
                                   % dset)
 
651
        return result
 
652
 
 
653
    def _maybe_lookup(self, name_or_index):
 
654
        """Convert possible symbolic name to index, or pass through indexes.
 
655
        
 
656
        NOT FOR PUBLIC USE.
 
657
        """
 
658
        if isinstance(name_or_index, (int, long)):
 
659
            return name_or_index
 
660
        else:
 
661
            return self._lookup(name_or_index)
 
662
 
 
663
    def get_lines(self, version_id):
 
664
        """See VersionedFile.get_lines()."""
 
665
        int_index = self._maybe_lookup(version_id)
 
666
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
667
        expected_sha1 = self._sha1s[int_index]
 
668
        measured_sha1 = sha_strings(result)
 
669
        if measured_sha1 != expected_sha1:
 
670
            raise errors.WeaveInvalidChecksum(
 
671
                    'file %s, revision %s, expected: %s, measured %s' 
 
672
                    % (self._weave_name, version_id,
 
673
                       expected_sha1, measured_sha1))
 
674
        return result
 
675
 
 
676
    def get_sha1(self, version_id):
 
677
        """See VersionedFile.get_sha1()."""
 
678
        return self._sha1s[self._lookup(version_id)]
 
679
 
 
680
    def get_sha1s(self, version_ids):
 
681
        """See VersionedFile.get_sha1s()."""
 
682
        return [self._sha1s[self._lookup(v)] for v in version_ids]
 
683
 
 
684
    def num_versions(self):
 
685
        """How many versions are in this weave?"""
490
686
        l = len(self._parents)
491
687
        assert l == len(self._sha1s)
492
688
        return l
493
689
 
494
 
 
495
 
    def __len__(self):
496
 
        return self.numversions()
497
 
 
 
690
    __len__ = num_versions
498
691
 
499
692
    def check(self, progress_bar=None):
500
 
        # check no circular inclusions
501
 
        for version in range(self.numversions()):
 
693
        # TODO evaluate performance hit of using string sets in this routine.
 
694
        # TODO: check no circular inclusions
 
695
        # TODO: create a nested progress bar
 
696
        for version in range(self.num_versions()):
502
697
            inclusions = list(self._parents[version])
503
698
            if inclusions:
504
699
                inclusions.sort()
506
701
                    raise WeaveFormatError("invalid included version %d for index %d"
507
702
                                           % (inclusions[-1], version))
508
703
 
509
 
        # try extracting all versions; this is a bit slow and parallel
510
 
        # extraction could be used
511
 
        import sha
512
 
        nv = self.numversions()
513
 
        for version in range(nv):
 
704
        # try extracting all versions; parallel extraction is used
 
705
        nv = self.num_versions()
 
706
        sha1s = {}
 
707
        texts = {}
 
708
        inclusions = {}
 
709
        for i in range(nv):
 
710
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
711
            # The problem is that set membership is much more expensive
 
712
            name = self._idx_to_name(i)
 
713
            sha1s[name] = sha.new()
 
714
            texts[name] = []
 
715
            new_inc = set([name])
 
716
            for p in self._parents[i]:
 
717
                new_inc.update(inclusions[self._idx_to_name(p)])
 
718
 
 
719
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
720
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
721
            inclusions[name] = new_inc
 
722
 
 
723
        nlines = len(self._weave)
 
724
 
 
725
        update_text = 'checking weave'
 
726
        if self._weave_name:
 
727
            short_name = os.path.basename(self._weave_name)
 
728
            update_text = 'checking %s' % (short_name,)
 
729
            update_text = update_text[:25]
 
730
 
 
731
        for lineno, insert, deleteset, line in self._walk_internal():
514
732
            if progress_bar:
515
 
                progress_bar.update('checking text', version, nv)
516
 
            s = sha.new()
517
 
            for l in self.get_iter(version):
518
 
                s.update(l)
519
 
            hd = s.hexdigest()
520
 
            expected = self._sha1s[version]
 
733
                progress_bar.update(update_text, lineno, nlines)
 
734
 
 
735
            for name, name_inclusions in inclusions.items():
 
736
                # The active inclusion must be an ancestor,
 
737
                # and no ancestors must have deleted this line,
 
738
                # because we don't support resurrection.
 
739
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
740
                    sha1s[name].update(line)
 
741
 
 
742
        for i in range(nv):
 
743
            version = self._idx_to_name(i)
 
744
            hd = sha1s[version].hexdigest()
 
745
            expected = self._sha1s[i]
521
746
            if hd != expected:
522
 
                raise WeaveError("mismatched sha1 for version %d; "
523
 
                                 "got %s, expected %s"
524
 
                                 % (version, hd, expected))
 
747
                raise errors.WeaveInvalidChecksum(
 
748
                        "mismatched sha1 for version %s: "
 
749
                        "got %s, expected %s"
 
750
                        % (version, hd, expected))
525
751
 
526
752
        # TODO: check insertions are properly nested, that there are
527
753
        # no lines outside of insertion blocks, that deletions are
528
754
        # properly paired, etc.
529
755
 
530
 
 
531
 
 
532
 
    def merge(self, merge_versions):
533
 
        """Automerge and mark conflicts between versions.
534
 
 
535
 
        This returns a sequence, each entry describing alternatives
536
 
        for a chunk of the file.  Each of the alternatives is given as
537
 
        a list of lines.
538
 
 
539
 
        If there is a chunk of the file where there's no diagreement,
540
 
        only one alternative is given.
541
 
        """
542
 
 
543
 
        # approach: find the included versions common to all the
544
 
        # merged versions
545
 
        raise NotImplementedError()
546
 
 
547
 
 
548
 
 
549
 
    def _delta(self, included, lines):
550
 
        """Return changes from basis to new revision.
551
 
 
552
 
        The old text for comparison is the union of included revisions.
553
 
 
554
 
        This is used in inserting a new text.
555
 
 
556
 
        Delta is returned as a sequence of
557
 
        (weave1, weave2, newlines).
558
 
 
559
 
        This indicates that weave1:weave2 of the old weave should be
560
 
        replaced by the sequence of lines in newlines.  Note that
561
 
        these line numbers are positions in the total weave and don't
562
 
        correspond to the lines in any extracted version, or even the
563
 
        extracted union of included versions.
564
 
 
565
 
        If line1=line2, this is a pure insert; if newlines=[] this is a
566
 
        pure delete.  (Similar to difflib.)
567
 
        """
568
 
 
569
 
 
570
 
            
571
 
    def plan_merge(self, ver_a, ver_b):
572
 
        """Return pseudo-annotation indicating how the two versions merge.
573
 
 
574
 
        This is computed between versions a and b and their common
575
 
        base.
576
 
 
577
 
        Weave lines present in none of them are skipped entirely.
578
 
        """
579
 
        inc_a = self.inclusions([ver_a])
580
 
        inc_b = self.inclusions([ver_b])
581
 
        inc_c = inc_a & inc_b
582
 
 
583
 
        for lineno, insert, deleteset, line in self._walk():
584
 
            if deleteset & inc_c:
585
 
                # killed in parent; can't be in either a or b
586
 
                # not relevant to our work
587
 
                yield 'killed-base', line
588
 
            elif insert in inc_c:
589
 
                # was inserted in base
590
 
                killed_a = bool(deleteset & inc_a)
591
 
                killed_b = bool(deleteset & inc_b)
592
 
                if killed_a and killed_b:
593
 
                    yield 'killed-both', line
594
 
                elif killed_a:
595
 
                    yield 'killed-a', line
596
 
                elif killed_b:
597
 
                    yield 'killed-b', line
598
 
                else:
599
 
                    yield 'unchanged', line
600
 
            elif insert in inc_a:
601
 
                if deleteset & inc_a:
602
 
                    yield 'ghost-a', line
603
 
                else:
604
 
                    # new in A; not in B
605
 
                    yield 'new-a', line
606
 
            elif insert in inc_b:
607
 
                if deleteset & inc_b:
608
 
                    yield 'ghost-b', line
609
 
                else:
610
 
                    yield 'new-b', line
611
 
            else:
612
 
                # not in either revision
613
 
                yield 'irrelevant', line
614
 
 
615
 
        yield 'unchanged', ''           # terminator
616
 
 
617
 
 
618
 
 
619
 
    def weave_merge(self, plan):
620
 
        lines_a = []
621
 
        lines_b = []
622
 
        ch_a = ch_b = False
623
 
 
624
 
        for state, line in plan:
625
 
            if state == 'unchanged' or state == 'killed-both':
626
 
                # resync and flush queued conflicts changes if any
627
 
                if not lines_a and not lines_b:
628
 
                    pass
629
 
                elif ch_a and not ch_b:
630
 
                    # one-sided change:                    
631
 
                    for l in lines_a: yield l
632
 
                elif ch_b and not ch_a:
633
 
                    for l in lines_b: yield l
634
 
                elif lines_a == lines_b:
635
 
                    for l in lines_a: yield l
636
 
                else:
637
 
                    yield '<<<<\n'
638
 
                    for l in lines_a: yield l
639
 
                    yield '====\n'
640
 
                    for l in lines_b: yield l
641
 
                    yield '>>>>\n'
642
 
 
643
 
                del lines_a[:]
644
 
                del lines_b[:]
645
 
                ch_a = ch_b = False
646
 
                
647
 
            if state == 'unchanged':
648
 
                if line:
649
 
                    yield line
650
 
            elif state == 'killed-a':
651
 
                ch_a = True
652
 
                lines_b.append(line)
653
 
            elif state == 'killed-b':
654
 
                ch_b = True
655
 
                lines_a.append(line)
656
 
            elif state == 'new-a':
657
 
                ch_a = True
658
 
                lines_a.append(line)
659
 
            elif state == 'new-b':
660
 
                ch_b = True
661
 
                lines_b.append(line)
662
 
            else:
663
 
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
664
 
                                 'killed-both'), \
665
 
                       state
666
 
 
667
 
                
668
 
 
669
 
 
670
 
 
671
 
 
672
 
 
673
 
def weave_info(w):
674
 
    """Show some text information about the weave."""
675
 
    print '%6s %40s %20s' % ('ver', 'sha1', 'parents')
676
 
    for i in (6, 40, 20):
 
756
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
757
        """Worker routine for join()."""
 
758
        if not other.versions():
 
759
            return          # nothing to update, easy
 
760
 
 
761
        if not version_ids:
 
762
            # versions is never none, InterWeave checks this.
 
763
            return 0
 
764
 
 
765
        # two loops so that we do not change ourselves before verifying it
 
766
        # will be ok
 
767
        # work through in index order to make sure we get all dependencies
 
768
        names_to_join = []
 
769
        processed = 0
 
770
        # get the selected versions only that are in other.versions.
 
771
        version_ids = set(other.versions()).intersection(set(version_ids))
 
772
        # pull in the referenced graph.
 
773
        version_ids = other.get_ancestry(version_ids)
 
774
        pending_parents = other.get_parent_map(version_ids)
 
775
        pending_graph = pending_parents.items()
 
776
        if len(pending_graph) != len(version_ids):
 
777
            raise RevisionNotPresent(
 
778
                set(version_ids) - set(pending_parents.keys()), self)
 
779
        for name in tsort.topo_sort(pending_graph):
 
780
            other_idx = other._name_map[name]
 
781
            # returns True if we have it, False if we need it.
 
782
            if not self._check_version_consistent(other, other_idx, name):
 
783
                names_to_join.append((other_idx, name))
 
784
            processed += 1
 
785
 
 
786
        if pb and not msg:
 
787
            msg = 'weave join'
 
788
 
 
789
        merged = 0
 
790
        time0 = time.time()
 
791
        for other_idx, name in names_to_join:
 
792
            # TODO: If all the parents of the other version are already
 
793
            # present then we can avoid some work by just taking the delta
 
794
            # and adjusting the offsets.
 
795
            new_parents = self._imported_parents(other, other_idx)
 
796
            sha1 = other._sha1s[other_idx]
 
797
 
 
798
            merged += 1
 
799
 
 
800
            if pb:
 
801
                pb.update(msg, merged, len(names_to_join))
 
802
           
 
803
            lines = other.get_lines(other_idx)
 
804
            self._add(name, lines, new_parents, sha1)
 
805
 
 
806
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
807
                merged, processed, self._weave_name, time.time()-time0))
 
808
 
 
809
    def _imported_parents(self, other, other_idx):
 
810
        """Return list of parents in self corresponding to indexes in other."""
 
811
        new_parents = []
 
812
        for parent_idx in other._parents[other_idx]:
 
813
            parent_name = other._names[parent_idx]
 
814
            if parent_name not in self._name_map:
 
815
                # should not be possible
 
816
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
817
                                 % (parent_name, other._name_map[other_idx], self))
 
818
            new_parents.append(self._name_map[parent_name])
 
819
        return new_parents
 
820
 
 
821
    def _check_version_consistent(self, other, other_idx, name):
 
822
        """Check if a version in consistent in this and other.
 
823
 
 
824
        To be consistent it must have:
 
825
 
 
826
         * the same text
 
827
         * the same direct parents (by name, not index, and disregarding
 
828
           order)
 
829
        
 
830
        If present & correct return True;
 
831
        if not present in self return False; 
 
832
        if inconsistent raise error."""
 
833
        this_idx = self._name_map.get(name, -1)
 
834
        if this_idx != -1:
 
835
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
836
                raise errors.WeaveTextDiffers(name, self, other)
 
837
            self_parents = self._parents[this_idx]
 
838
            other_parents = other._parents[other_idx]
 
839
            n1 = set([self._names[i] for i in self_parents])
 
840
            n2 = set([other._names[i] for i in other_parents])
 
841
            if not self._compatible_parents(n1, n2):
 
842
                raise WeaveParentMismatch("inconsistent parents "
 
843
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
844
            else:
 
845
                return True         # ok!
 
846
        else:
 
847
            return False
 
848
 
 
849
    def _reweave(self, other, pb, msg):
 
850
        """Reweave self with other - internal helper for join().
 
851
 
 
852
        :param other: The other weave to merge
 
853
        :param pb: An optional progress bar, indicating how far done we are
 
854
        :param msg: An optional message for the progress
 
855
        """
 
856
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
857
        self._copy_weave_content(new_weave)
 
858
 
 
859
    def _copy_weave_content(self, otherweave):
 
860
        """adsorb the content from otherweave."""
 
861
        for attr in self.__slots__:
 
862
            if attr != '_weave_name':
 
863
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
864
 
 
865
 
 
866
class WeaveFile(Weave):
 
867
    """A WeaveFile represents a Weave on disk and writes on change."""
 
868
 
 
869
    WEAVE_SUFFIX = '.weave'
 
870
    
 
871
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
872
        """Create a WeaveFile.
 
873
        
 
874
        :param create: If not True, only open an existing knit.
 
875
        """
 
876
        super(WeaveFile, self).__init__(name, access_mode)
 
877
        self._transport = transport
 
878
        self._filemode = filemode
 
879
        try:
 
880
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
881
        except errors.NoSuchFile:
 
882
            if not create:
 
883
                raise
 
884
            # new file, save it
 
885
            self._save()
 
886
 
 
887
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
888
        left_matching_blocks, nostore_sha, random_id, check_content):
 
889
        """Add a version and save the weave."""
 
890
        self.check_not_reserved_id(version_id)
 
891
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
892
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
893
            check_content)
 
894
        self._save()
 
895
        return result
 
896
 
 
897
    def _clone_text(self, new_version_id, old_version_id, parents):
 
898
        """See VersionedFile.clone_text."""
 
899
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
900
        self._save
 
901
 
 
902
    def copy_to(self, name, transport):
 
903
        """See VersionedFile.copy_to()."""
 
904
        # as we are all in memory always, just serialise to the new place.
 
905
        sio = StringIO()
 
906
        write_weave_v5(self, sio)
 
907
        sio.seek(0)
 
908
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
909
 
 
910
    def create_empty(self, name, transport, filemode=None):
 
911
        return WeaveFile(name, transport, filemode, create=True)
 
912
 
 
913
    def _save(self):
 
914
        """Save the weave."""
 
915
        self._check_write_ok()
 
916
        sio = StringIO()
 
917
        write_weave_v5(self, sio)
 
918
        sio.seek(0)
 
919
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
920
                                 sio,
 
921
                                 self._filemode)
 
922
 
 
923
    @staticmethod
 
924
    def get_suffixes():
 
925
        """See VersionedFile.get_suffixes()."""
 
926
        return [WeaveFile.WEAVE_SUFFIX]
 
927
 
 
928
    def join(self, other, pb=None, msg=None, version_ids=None,
 
929
             ignore_missing=False):
 
930
        """Join other into self and save."""
 
931
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
932
        self._save()
 
933
 
 
934
 
 
935
def _reweave(wa, wb, pb=None, msg=None):
 
936
    """Combine two weaves and return the result.
 
937
 
 
938
    This works even if a revision R has different parents in 
 
939
    wa and wb.  In the resulting weave all the parents are given.
 
940
 
 
941
    This is done by just building up a new weave, maintaining ordering 
 
942
    of the versions in the two inputs.  More efficient approaches
 
943
    might be possible but it should only be necessary to do 
 
944
    this operation rarely, when a new previously ghost version is 
 
945
    inserted.
 
946
 
 
947
    :param pb: An optional progress bar, indicating how far done we are
 
948
    :param msg: An optional message for the progress
 
949
    """
 
950
    wr = Weave()
 
951
    ia = ib = 0
 
952
    queue_a = range(wa.num_versions())
 
953
    queue_b = range(wb.num_versions())
 
954
    # first determine combined parents of all versions
 
955
    # map from version name -> all parent names
 
956
    combined_parents = _reweave_parent_graphs(wa, wb)
 
957
    mutter("combined parents: %r", combined_parents)
 
958
    order = tsort.topo_sort(combined_parents.iteritems())
 
959
    mutter("order to reweave: %r", order)
 
960
 
 
961
    if pb and not msg:
 
962
        msg = 'reweave'
 
963
 
 
964
    for idx, name in enumerate(order):
 
965
        if pb:
 
966
            pb.update(msg, idx, len(order))
 
967
        if name in wa._name_map:
 
968
            lines = wa.get_lines(name)
 
969
            if name in wb._name_map:
 
970
                lines_b = wb.get_lines(name)
 
971
                if lines != lines_b:
 
972
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
973
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
974
                    import difflib
 
975
                    lines = list(difflib.unified_diff(lines, lines_b,
 
976
                            wa._weave_name, wb._weave_name))
 
977
                    mutter('lines:\n%s', ''.join(lines))
 
978
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
979
        else:
 
980
            lines = wb.get_lines(name)
 
981
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
982
    return wr
 
983
 
 
984
def _reweave_parent_graphs(wa, wb):
 
985
    """Return combined parent ancestry for two weaves.
 
986
    
 
987
    Returned as a list of (version_name, set(parent_names))"""
 
988
    combined = {}
 
989
    for weave in [wa, wb]:
 
990
        for idx, name in enumerate(weave._names):
 
991
            p = combined.setdefault(name, set())
 
992
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
993
    return combined
 
994
 
 
995
 
 
996
def weave_toc(w):
 
997
    """Show the weave's table-of-contents"""
 
998
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
999
    for i in (6, 50, 10, 10):
677
1000
        print '-' * i,
678
1001
    print
679
 
    for i in range(w.numversions()):
 
1002
    for i in range(w.num_versions()):
680
1003
        sha1 = w._sha1s[i]
681
 
        print '%6d %40s %s' % (i, sha1, ' '.join(map(str, w._parents[i])))
682
 
 
683
 
 
684
 
 
685
 
def weave_stats(weave_file):
686
 
    from bzrlib.progress import ProgressBar
 
1004
        name = w._names[i]
 
1005
        parent_str = ' '.join(map(str, w._parents[i]))
 
1006
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1007
 
 
1008
 
 
1009
 
 
1010
def weave_stats(weave_file, pb):
687
1011
    from bzrlib.weavefile import read_weave
688
1012
 
689
 
    pb = ProgressBar()
690
 
 
691
1013
    wf = file(weave_file, 'rb')
692
1014
    w = read_weave(wf)
693
1015
    # FIXME: doesn't work on pipes
697
1019
    vers = len(w)
698
1020
    for i in range(vers):
699
1021
        pb.update('checking sizes', i, vers)
700
 
        for line in w.get_iter(i):
 
1022
        for origin, lineno, line in w._extract([i]):
701
1023
            total += len(line)
702
1024
 
703
1025
    pb.clear()
706
1028
    print 'weave file        %9d bytes' % weave_size
707
1029
    print 'total contents    %9d bytes' % total
708
1030
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
709
 
 
 
1031
    if vers:
 
1032
        avg = total/vers
 
1033
        print 'average size      %9d bytes' % avg
 
1034
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
710
1035
 
711
1036
 
712
1037
def usage():
721
1046
        Write out specified version.
722
1047
    weave check WEAVEFILE
723
1048
        Check consistency of all versions.
724
 
    weave info WEAVEFILE
 
1049
    weave toc WEAVEFILE
725
1050
        Display table of contents.
726
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
1051
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
727
1052
        Add NEWTEXT, with specified parent versions.
728
1053
    weave annotate WEAVEFILE VERSION
729
1054
        Display origin of each line.
730
 
    weave mash WEAVEFILE VERSION...
731
 
        Display composite of all selected versions.
732
1055
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
733
1056
        Auto-merge two versions and display conflicts.
 
1057
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1058
        Show differences between two versions.
734
1059
 
735
1060
example:
736
1061
 
737
1062
    % weave init foo.weave
738
1063
    % vi foo.txt
739
 
    % weave add foo.weave < foo.txt
 
1064
    % weave add foo.weave ver0 < foo.txt
740
1065
    added version 0
741
1066
 
742
1067
    (create updated version)
743
1068
    % vi foo.txt
744
1069
    % weave get foo.weave 0 | diff -u - foo.txt
745
 
    % weave add foo.weave 0 < foo.txt
 
1070
    % weave add foo.weave ver1 0 < foo.txt
746
1071
    added version 1
747
1072
 
748
1073
    % weave get foo.weave 0 > foo.txt       (create forked version)
749
1074
    % vi foo.txt
750
 
    % weave add foo.weave 0 < foo.txt
 
1075
    % weave add foo.weave ver2 0 < foo.txt
751
1076
    added version 2
752
1077
 
753
1078
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
754
1079
    % vi foo.txt                            (resolve conflicts)
755
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
1080
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
756
1081
    
757
1082
"""
758
1083
    
761
1086
def main(argv):
762
1087
    import sys
763
1088
    import os
764
 
    from weavefile import write_weave, read_weave
 
1089
    try:
 
1090
        import bzrlib
 
1091
    except ImportError:
 
1092
        # in case we're run directly from the subdirectory
 
1093
        sys.path.append('..')
 
1094
        import bzrlib
 
1095
    from bzrlib.weavefile import write_weave, read_weave
765
1096
    from bzrlib.progress import ProgressBar
766
1097
 
767
 
    #import psyco
768
 
    #psyco.full()
 
1098
    try:
 
1099
        import psyco
 
1100
        psyco.full()
 
1101
    except ImportError:
 
1102
        pass
 
1103
 
 
1104
    if len(argv) < 2:
 
1105
        usage()
 
1106
        return 0
769
1107
 
770
1108
    cmd = argv[1]
771
1109
 
777
1115
    elif cmd == 'add':
778
1116
        w = readit()
779
1117
        # at the moment, based on everything in the file
780
 
        parents = map(int, argv[3:])
 
1118
        name = argv[3]
 
1119
        parents = map(int, argv[4:])
781
1120
        lines = sys.stdin.readlines()
782
 
        ver = w.add(parents, lines)
 
1121
        ver = w.add(name, parents, lines)
783
1122
        write_weave(w, file(argv[2], 'wb'))
784
 
        print 'added version %d' % ver
 
1123
        print 'added version %r %d' % (name, ver)
785
1124
    elif cmd == 'init':
786
1125
        fn = argv[2]
787
1126
        if os.path.exists(fn):
792
1131
        w = readit()
793
1132
        sys.stdout.writelines(w.get_iter(int(argv[3])))
794
1133
        
795
 
    elif cmd == 'mash': # get composite
 
1134
    elif cmd == 'diff':
796
1135
        w = readit()
797
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
798
 
 
 
1136
        fn = argv[2]
 
1137
        v1, v2 = map(int, argv[3:5])
 
1138
        lines1 = w.get(v1)
 
1139
        lines2 = w.get(v2)
 
1140
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1141
                                '%s version %d' % (fn, v1),
 
1142
                                '%s version %d' % (fn, v2))
 
1143
        sys.stdout.writelines(diff_gen)
 
1144
            
799
1145
    elif cmd == 'annotate':
800
1146
        w = readit()
801
1147
        # newline is added to all lines regardless; too hard to get
809
1155
                print '%5d | %s' % (origin, text)
810
1156
                lasto = origin
811
1157
                
812
 
    elif cmd == 'info':
813
 
        weave_info(readit())
 
1158
    elif cmd == 'toc':
 
1159
        weave_toc(readit())
814
1160
 
815
1161
    elif cmd == 'stats':
816
 
        weave_stats(argv[2])
 
1162
        weave_stats(argv[2], ProgressBar())
817
1163
        
818
1164
    elif cmd == 'check':
819
1165
        w = readit()
820
1166
        pb = ProgressBar()
821
1167
        w.check(pb)
822
1168
        pb.clear()
823
 
        print '%d versions ok' % w.numversions()
 
1169
        print '%d versions ok' % w.num_versions()
824
1170
 
825
1171
    elif cmd == 'inclusions':
826
1172
        w = readit()
831
1177
        print ' '.join(map(str, w._parents[int(argv[3])]))
832
1178
 
833
1179
    elif cmd == 'plan-merge':
 
1180
        # replaced by 'bzr weave-plan-merge'
834
1181
        w = readit()
835
1182
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
836
1183
            if line:
837
1184
                print '%14s | %s' % (state, line),
838
 
 
839
1185
    elif cmd == 'merge':
 
1186
        # replaced by 'bzr weave-merge-text'
840
1187
        w = readit()
841
1188
        p = w.plan_merge(int(argv[3]), int(argv[4]))
842
1189
        sys.stdout.writelines(w.weave_merge(p))
843
 
            
844
 
    elif cmd == 'mash-merge':
845
 
        if len(argv) != 5:
846
 
            usage()
847
 
            return 1
848
 
 
849
 
        w = readit()
850
 
        v1, v2 = map(int, argv[3:5])
851
 
 
852
 
        basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
853
 
 
854
 
        base_lines = list(w.mash_iter(basis))
855
 
        a_lines = list(w.get(v1))
856
 
        b_lines = list(w.get(v2))
857
 
 
858
 
        from bzrlib.merge3 import Merge3
859
 
        m3 = Merge3(base_lines, a_lines, b_lines)
860
 
 
861
 
        name_a = 'version %d' % v1
862
 
        name_b = 'version %d' % v2
863
 
        sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
864
1190
    else:
865
1191
        raise ValueError('unknown command %r' % cmd)
866
1192
    
868
1194
if __name__ == '__main__':
869
1195
    import sys
870
1196
    sys.exit(main(sys.argv))
 
1197
 
 
1198
 
 
1199
class InterWeave(InterVersionedFile):
 
1200
    """Optimised code paths for weave to weave operations."""
 
1201
    
 
1202
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1203
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1204
    
 
1205
    @staticmethod
 
1206
    def is_compatible(source, target):
 
1207
        """Be compatible with weaves."""
 
1208
        try:
 
1209
            return (isinstance(source, Weave) and
 
1210
                    isinstance(target, Weave))
 
1211
        except AttributeError:
 
1212
            return False
 
1213
 
 
1214
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1215
        """See InterVersionedFile.join."""
 
1216
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1217
        if self.target.versions() == [] and version_ids is None:
 
1218
            self.target._copy_weave_content(self.source)
 
1219
            return
 
1220
        self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1221
 
 
1222
 
 
1223
InterVersionedFile.register_optimiser(InterWeave)