/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: Keir Mierle
  • Date: 2007-09-03 23:54:22 UTC
  • mto: This revision was merged to the branch mainline in revision 2824.
  • Revision ID: keir@cs.utoronto.ca-20070903235422-zfj6mk7nts9nmzw2
Add Mutt as a supported client email program. Also rearranges various listings
of the mail clients to be alphabetical; the number of supported email clients
is only going to grow, and this way it is easier to scan for your favorite
email client.

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 import (
 
79
    progress,
 
80
    )
 
81
from bzrlib.trace import mutter
 
82
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
 
83
        RevisionAlreadyPresent,
 
84
        RevisionNotPresent,
 
85
        WeaveRevisionAlreadyPresent,
 
86
        WeaveRevisionNotPresent,
 
87
        )
 
88
import bzrlib.errors as errors
 
89
from bzrlib.osutils import sha_strings
 
90
import bzrlib.patiencediff
 
91
from bzrlib.tsort import topo_sort
 
92
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
93
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
 
94
 
 
95
 
 
96
class Weave(VersionedFile):
90
97
    """weave - versioned text file storage.
91
98
    
92
99
    A Weave manages versions of line-based text files, keeping track
118
125
    The instruction can be '{' or '}' for an insertion block, and '['
119
126
    and ']' for a deletion block respectively.  The version is the
120
127
    integer version index.  There is no replace operator, only deletes
121
 
    and inserts.
 
128
    and inserts.  For '}', the end of an insertion, there is no
 
129
    version parameter because it always closes the most recently
 
130
    opened insertion.
122
131
 
123
132
    Constraints/notes:
124
133
 
160
169
        each version; the parent's parents are implied.
161
170
 
162
171
    _sha1s
163
 
        List of hex SHA-1 of each version, or None if not recorded.
 
172
        List of hex SHA-1 of each version.
 
173
 
 
174
    _names
 
175
        List of symbolic names for each version.  Each should be unique.
 
176
 
 
177
    _name_map
 
178
        For each name, the version number.
 
179
 
 
180
    _weave_name
 
181
        Descriptive name of this weave; typically the filename if known.
 
182
        Set by read_weave.
164
183
    """
165
184
 
166
 
    __slots__ = ['_weave', '_parents', '_sha1s']
 
185
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
186
                 '_weave_name', '_matcher']
167
187
    
168
 
    def __init__(self):
 
188
    def __init__(self, weave_name=None, access_mode='w', matcher=None):
 
189
        super(Weave, self).__init__(access_mode)
169
190
        self._weave = []
170
191
        self._parents = []
171
192
        self._sha1s = []
172
 
 
 
193
        self._names = []
 
194
        self._name_map = {}
 
195
        self._weave_name = weave_name
 
196
        if matcher is None:
 
197
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
198
        else:
 
199
            self._matcher = matcher
 
200
 
 
201
    def __repr__(self):
 
202
        return "Weave(%r)" % self._weave_name
 
203
 
 
204
    def copy(self):
 
205
        """Return a deep copy of self.
 
206
        
 
207
        The copy can be modified without affecting the original weave."""
 
208
        other = Weave()
 
209
        other._weave = self._weave[:]
 
210
        other._parents = self._parents[:]
 
211
        other._sha1s = self._sha1s[:]
 
212
        other._names = self._names[:]
 
213
        other._name_map = self._name_map.copy()
 
214
        other._weave_name = self._weave_name
 
215
        return other
173
216
 
174
217
    def __eq__(self, other):
175
218
        if not isinstance(other, Weave):
176
219
            return False
177
220
        return self._parents == other._parents \
178
 
               and self._weave == other._weave
 
221
               and self._weave == other._weave \
 
222
               and self._sha1s == other._sha1s 
179
223
    
180
 
 
181
224
    def __ne__(self, other):
182
225
        return not self.__eq__(other)
183
226
 
184
 
        
185
 
    def add(self, parents, text):
 
227
    def _idx_to_name(self, version):
 
228
        return self._names[version]
 
229
 
 
230
    def _lookup(self, name):
 
231
        """Convert symbolic version name to index."""
 
232
        self.check_not_reserved_id(name)
 
233
        try:
 
234
            return self._name_map[name]
 
235
        except KeyError:
 
236
            raise RevisionNotPresent(name, self._weave_name)
 
237
 
 
238
    def versions(self):
 
239
        """See VersionedFile.versions."""
 
240
        return self._names[:]
 
241
 
 
242
    def has_version(self, version_id):
 
243
        """See VersionedFile.has_version."""
 
244
        return (version_id in self._name_map)
 
245
 
 
246
    __contains__ = has_version
 
247
 
 
248
    def get_delta(self, version_id):
 
249
        """See VersionedFile.get_delta."""
 
250
        return self.get_deltas([version_id])[version_id]
 
251
 
 
252
    def get_deltas(self, version_ids):
 
253
        """See VersionedFile.get_deltas."""
 
254
        version_ids = self.get_ancestry(version_ids)
 
255
        for version_id in version_ids:
 
256
            if not self.has_version(version_id):
 
257
                raise RevisionNotPresent(version_id, self)
 
258
        # try extracting all versions; parallel extraction is used
 
259
        nv = self.num_versions()
 
260
        sha1s = {}
 
261
        deltas = {}
 
262
        texts = {}
 
263
        inclusions = {}
 
264
        noeols = {}
 
265
        last_parent_lines = {}
 
266
        parents = {}
 
267
        parent_inclusions = {}
 
268
        parent_linenums = {}
 
269
        parent_noeols = {}
 
270
        current_hunks = {}
 
271
        diff_hunks = {}
 
272
        # its simplest to generate a full set of prepared variables.
 
273
        for i in range(nv):
 
274
            name = self._names[i]
 
275
            sha1s[name] = self.get_sha1(name)
 
276
            parents_list = self.get_parents(name)
 
277
            try:
 
278
                parent = parents_list[0]
 
279
                parents[name] = parent
 
280
                parent_inclusions[name] = inclusions[parent]
 
281
            except IndexError:
 
282
                parents[name] = None
 
283
                parent_inclusions[name] = set()
 
284
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
 
285
            diff_hunks[name] = []
 
286
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
 
287
            parent_linenums[name] = 0
 
288
            noeols[name] = False
 
289
            parent_noeols[name] = False
 
290
            last_parent_lines[name] = None
 
291
            new_inc = set([name])
 
292
            for p in self._parents[i]:
 
293
                new_inc.update(inclusions[self._idx_to_name(p)])
 
294
            # debug only, known good so far.
 
295
            #assert set(new_inc) == set(self.get_ancestry(name)), \
 
296
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
297
            inclusions[name] = new_inc
 
298
 
 
299
        nlines = len(self._weave)
 
300
 
 
301
        for lineno, inserted, deletes, line in self._walk_internal():
 
302
            # a line is active in a version if:
 
303
            # insert is in the versions inclusions
 
304
            # and
 
305
            # deleteset & the versions inclusions is an empty set.
 
306
            # so - if we have a included by mapping - version is included by
 
307
            # children, we get a list of children to examine for deletes affect
 
308
            # ing them, which is less than the entire set of children.
 
309
            for version_id in version_ids:  
 
310
                # The active inclusion must be an ancestor,
 
311
                # and no ancestors must have deleted this line,
 
312
                # because we don't support resurrection.
 
313
                parent_inclusion = parent_inclusions[version_id]
 
314
                inclusion = inclusions[version_id]
 
315
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
 
316
                version_active = inserted in inclusion and not (deletes & inclusion)
 
317
                if not parent_active and not version_active:
 
318
                    # unrelated line of ancestry
 
319
                    continue
 
320
                elif parent_active and version_active:
 
321
                    # shared line
 
322
                    parent_linenum = parent_linenums[version_id]
 
323
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
 
324
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
 
325
                    parent_linenum += 1
 
326
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
 
327
                    parent_linenums[version_id] = parent_linenum
 
328
                    try:
 
329
                        if line[-1] != '\n':
 
330
                            noeols[version_id] = True
 
331
                    except IndexError:
 
332
                        pass
 
333
                elif parent_active and not version_active:
 
334
                    # deleted line
 
335
                    current_hunks[version_id][1] += 1
 
336
                    parent_linenums[version_id] += 1
 
337
                    last_parent_lines[version_id] = line
 
338
                elif not parent_active and version_active:
 
339
                    # replacement line
 
340
                    # noeol only occurs at the end of a file because we 
 
341
                    # diff linewise. We want to show noeol changes as a
 
342
                    # empty diff unless the actual eol-less content changed.
 
343
                    theline = line
 
344
                    try:
 
345
                        if last_parent_lines[version_id][-1] != '\n':
 
346
                            parent_noeols[version_id] = True
 
347
                    except (TypeError, IndexError):
 
348
                        pass
 
349
                    try:
 
350
                        if theline[-1] != '\n':
 
351
                            noeols[version_id] = True
 
352
                    except IndexError:
 
353
                        pass
 
354
                    new_line = False
 
355
                    parent_should_go = False
 
356
 
 
357
                    if parent_noeols[version_id] == noeols[version_id]:
 
358
                        # no noeol toggle, so trust the weaves statement
 
359
                        # that this line is changed.
 
360
                        new_line = True
 
361
                        if parent_noeols[version_id]:
 
362
                            theline = theline + '\n'
 
363
                    elif parent_noeols[version_id]:
 
364
                        # parent has no eol, we do:
 
365
                        # our line is new, report as such..
 
366
                        new_line = True
 
367
                    elif noeols[version_id]:
 
368
                        # append a eol so that it looks like
 
369
                        # a normalised delta
 
370
                        theline = theline + '\n'
 
371
                        if parents[version_id] is not None:
 
372
                        #if last_parent_lines[version_id] is not None:
 
373
                            parent_should_go = True
 
374
                        if last_parent_lines[version_id] != theline:
 
375
                            # but changed anyway
 
376
                            new_line = True
 
377
                            #parent_should_go = False
 
378
                    if new_line:
 
379
                        current_hunks[version_id][2] += 1
 
380
                        current_hunks[version_id][3].append((inserted, theline))
 
381
                    if parent_should_go:
 
382
                        # last hunk last parent line is not eaten
 
383
                        current_hunks[version_id][1] -= 1
 
384
                    if current_hunks[version_id][1] < 0:
 
385
                        current_hunks[version_id][1] = 0
 
386
                        # import pdb;pdb.set_trace()
 
387
                    # assert current_hunks[version_id][1] >= 0
 
388
 
 
389
        # flush last hunk
 
390
        for i in range(nv):
 
391
            version = self._idx_to_name(i)
 
392
            if current_hunks[version] != [0, 0, 0, []]:
 
393
                diff_hunks[version].append(tuple(current_hunks[version]))
 
394
        result = {}
 
395
        for version_id in version_ids:
 
396
            result[version_id] = (
 
397
                                  parents[version_id],
 
398
                                  sha1s[version_id],
 
399
                                  noeols[version_id],
 
400
                                  diff_hunks[version_id],
 
401
                                  )
 
402
        return result
 
403
 
 
404
    def get_parents(self, version_id):
 
405
        """See VersionedFile.get_parent."""
 
406
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
 
407
 
 
408
    def _check_repeated_add(self, name, parents, text, sha1):
 
409
        """Check that a duplicated add is OK.
 
410
 
 
411
        If it is, return the (old) index; otherwise raise an exception.
 
412
        """
 
413
        idx = self._lookup(name)
 
414
        if sorted(self._parents[idx]) != sorted(parents) \
 
415
            or sha1 != self._sha1s[idx]:
 
416
            raise RevisionAlreadyPresent(name, self._weave_name)
 
417
        return idx
 
418
 
 
419
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
420
                   left_matching_blocks=None):
 
421
        """See VersionedFile.add_lines."""
 
422
        return self._add(version_id, lines, map(self._lookup, parents))
 
423
 
 
424
    def _add(self, version_id, lines, parents, sha1=None):
186
425
        """Add a single text on top of the weave.
187
426
  
188
427
        Returns the index number of the newly added version.
189
428
 
 
429
        version_id
 
430
            Symbolic name for this version.
 
431
            (Typically the revision-id of the revision that added it.)
 
432
 
190
433
        parents
191
434
            List or set of direct parent version numbers.
192
435
            
193
 
        text
194
 
            Sequence of lines to be added in the new version."""
 
436
        lines
 
437
            Sequence of lines to be added in the new version.
 
438
        """
 
439
 
 
440
        assert isinstance(version_id, basestring)
 
441
        self._check_lines_not_unicode(lines)
 
442
        self._check_lines_are_lines(lines)
 
443
        if not sha1:
 
444
            sha1 = sha_strings(lines)
 
445
        if version_id in self._name_map:
 
446
            return self._check_repeated_add(version_id, parents, lines, sha1)
195
447
 
196
448
        self._check_versions(parents)
197
 
        ## self._check_lines(text)
 
449
        ## self._check_lines(lines)
198
450
        new_version = len(self._parents)
199
451
 
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))
 
452
        # if we abort after here the (in-memory) weave will be corrupt because only
 
453
        # some fields are updated
 
454
        # XXX: FIXME implement a succeed-or-fail of the rest of this routine.
 
455
        #      - Robert Collins 20060226
 
456
        self._parents.append(parents[:])
208
457
        self._sha1s.append(sha1)
 
458
        self._names.append(version_id)
 
459
        self._name_map[version_id] = new_version
209
460
 
210
461
            
211
462
        if not parents:
213
464
            # this more quickly by just appending unconditionally.
214
465
            # even more specially, if we're adding an empty text we
215
466
            # need do nothing at all.
216
 
            if text:
 
467
            if lines:
217
468
                self._weave.append(('{', new_version))
218
 
                self._weave.extend(text)
219
 
                self._weave.append(('}', new_version))
220
 
        
 
469
                self._weave.extend(lines)
 
470
                self._weave.append(('}', None))
221
471
            return new_version
222
472
 
223
473
        if len(parents) == 1:
227
477
                return new_version
228
478
            
229
479
 
230
 
        ancestors = self.inclusions(parents)
 
480
        ancestors = self._inclusions(parents)
231
481
 
232
482
        l = self._weave
233
483
 
238
488
            basis_lineno.append(lineno)
239
489
            basis_lines.append(line)
240
490
 
241
 
        # another small special case: a merge, producing the same text as auto-merge
242
 
        if text == basis_lines:
 
491
        # another small special case: a merge, producing the same text
 
492
        # as auto-merge
 
493
        if lines == basis_lines:
243
494
            return new_version            
244
495
 
245
 
        # add a sentinal, because we can also match against the final line
 
496
        # add a sentinel, because we can also match against the final line
246
497
        basis_lineno.append(len(self._weave))
247
498
 
248
499
        # XXX: which line of the weave should we really consider
252
503
        #print 'basis_lines:', basis_lines
253
504
        #print 'new_lines:  ', lines
254
505
 
255
 
        from difflib import SequenceMatcher
256
 
        s = SequenceMatcher(None, basis_lines, text)
 
506
        s = self._matcher(None, basis_lines, lines)
257
507
 
258
508
        # offset gives the number of lines that have been inserted
259
509
        # into the weave up to the current point; if the original edit instruction
270
520
            i1 = basis_lineno[i1]
271
521
            i2 = basis_lineno[i2]
272
522
 
273
 
            assert 0 <= j1 <= j2 <= len(text)
 
523
            assert 0 <= j1 <= j2 <= len(lines)
274
524
 
275
525
            #print tag, i1, i2, j1, j2
276
526
 
287
537
                # we don't destroy ourselves
288
538
                i = i2 + offset
289
539
                self._weave[i:i] = ([('{', new_version)] 
290
 
                                + text[j1:j2] 
291
 
                                + [('}', new_version)])
 
540
                                    + lines[j1:j2] 
 
541
                                    + [('}', None)])
292
542
                offset += 2 + (j2 - j1)
293
 
 
294
543
        return new_version
295
544
 
 
545
    def _clone_text(self, new_version_id, old_version_id, parents):
 
546
        """See VersionedFile.clone_text."""
 
547
        old_lines = self.get_text(old_version_id)
 
548
        self.add_lines(new_version_id, parents, old_lines)
296
549
 
297
 
    def inclusions(self, versions):
 
550
    def _inclusions(self, versions):
298
551
        """Return set of all ancestors of given version(s)."""
 
552
        if not len(versions):
 
553
            return []
299
554
        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
 
 
 
555
        for v in xrange(max(versions), 0, -1):
 
556
            if v in i:
 
557
                # include all its parents
 
558
                i.update(self._parents[v])
 
559
        return i
 
560
        ## except IndexError:
 
561
        ##     raise ValueError("version %d not present in weave" % v)
 
562
 
 
563
    def get_ancestry(self, version_ids, topo_sorted=True):
 
564
        """See VersionedFile.get_ancestry."""
 
565
        if isinstance(version_ids, basestring):
 
566
            version_ids = [version_ids]
 
567
        i = self._inclusions([self._lookup(v) for v in version_ids])
 
568
        return [self._idx_to_name(v) for v in i]
334
569
 
335
570
    def _check_lines(self, text):
336
571
        if not isinstance(text, list):
351
586
            except IndexError:
352
587
                raise IndexError("invalid version number %r" % i)
353
588
 
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.
 
589
    def _compatible_parents(self, my_parents, other_parents):
 
590
        """During join check that other_parents are joinable with my_parents.
 
591
 
 
592
        Joinable is defined as 'is a subset of' - supersets may require 
 
593
        regeneration of diffs, but subsets do not.
 
594
        """
 
595
        return len(other_parents.difference(my_parents)) == 0
 
596
 
 
597
    def annotate_iter(self, version_id):
 
598
        """Yield list of (version-id, line) pairs for the specified version.
361
599
 
362
600
        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
 
        """
 
601
        incls = [self._lookup(version_id)]
 
602
        for origin, lineno, text in self._extract(incls):
 
603
            yield self._idx_to_name(origin), text
 
604
 
 
605
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
606
                                                pb=None):
 
607
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
 
608
        if version_ids is None:
 
609
            version_ids = self.versions()
 
610
        version_ids = set(version_ids)
 
611
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
 
612
            # if inserted not in version_ids then it was inserted before the
 
613
            # versions we care about, but because weaves cannot represent ghosts
 
614
            # properly, we do not filter down to that
 
615
            # if inserted not in version_ids: continue
 
616
            if line[-1] != '\n':
 
617
                yield line + '\n'
 
618
            else:
 
619
                yield line
 
620
 
 
621
    def _walk_internal(self, version_ids=None):
 
622
        """Helper method for weave actions."""
374
623
        
375
624
        istack = []
376
625
        dset = set()
378
627
        lineno = 0         # line of weave, 0-based
379
628
 
380
629
        for l in self._weave:
381
 
            if isinstance(l, tuple):
 
630
            if l.__class__ == tuple:
382
631
                c, v = l
383
632
                isactive = None
384
633
                if c == '{':
385
 
                    istack.append(v)
 
634
                    istack.append(self._names[v])
386
635
                elif c == '}':
387
 
                    oldv = istack.pop()
 
636
                    istack.pop()
388
637
                elif c == '[':
389
 
                    assert v not in dset
390
 
                    dset.add(v)
 
638
                    assert self._names[v] not in dset
 
639
                    dset.add(self._names[v])
391
640
                elif c == ']':
392
 
                    dset.remove(v)
 
641
                    dset.remove(self._names[v])
393
642
                else:
394
 
                    raise WeaveFormatError('unexpected instruction %r'
395
 
                                           % v)
 
643
                    raise WeaveFormatError('unexpected instruction %r' % v)
396
644
            else:
397
 
                assert isinstance(l, basestring)
 
645
                assert l.__class__ in (str, unicode)
398
646
                assert istack
399
 
                yield lineno, istack[-1], dset, l
 
647
                yield lineno, istack[-1], frozenset(dset), l
400
648
            lineno += 1
401
649
 
402
 
 
 
650
        if istack:
 
651
            raise WeaveFormatError("unclosed insertion blocks "
 
652
                    "at end of weave: %s" % istack)
 
653
        if dset:
 
654
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
655
                                   % dset)
 
656
 
 
657
    def plan_merge(self, ver_a, ver_b):
 
658
        """Return pseudo-annotation indicating how the two versions merge.
 
659
 
 
660
        This is computed between versions a and b and their common
 
661
        base.
 
662
 
 
663
        Weave lines present in none of them are skipped entirely.
 
664
        """
 
665
        inc_a = set(self.get_ancestry([ver_a]))
 
666
        inc_b = set(self.get_ancestry([ver_b]))
 
667
        inc_c = inc_a & inc_b
 
668
 
 
669
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
670
            if deleteset & inc_c:
 
671
                # killed in parent; can't be in either a or b
 
672
                # not relevant to our work
 
673
                yield 'killed-base', line
 
674
            elif insert in inc_c:
 
675
                # was inserted in base
 
676
                killed_a = bool(deleteset & inc_a)
 
677
                killed_b = bool(deleteset & inc_b)
 
678
                if killed_a and killed_b:
 
679
                    yield 'killed-both', line
 
680
                elif killed_a:
 
681
                    yield 'killed-a', line
 
682
                elif killed_b:
 
683
                    yield 'killed-b', line
 
684
                else:
 
685
                    yield 'unchanged', line
 
686
            elif insert in inc_a:
 
687
                if deleteset & inc_a:
 
688
                    yield 'ghost-a', line
 
689
                else:
 
690
                    # new in A; not in B
 
691
                    yield 'new-a', line
 
692
            elif insert in inc_b:
 
693
                if deleteset & inc_b:
 
694
                    yield 'ghost-b', line
 
695
                else:
 
696
                    yield 'new-b', line
 
697
            else:
 
698
                # not in either revision
 
699
                yield 'irrelevant', line
 
700
 
 
701
        yield 'unchanged', ''           # terminator
403
702
 
404
703
    def _extract(self, versions):
405
704
        """Yield annotation of lines in included set.
410
709
 
411
710
        The set typically but not necessarily corresponds to a version.
412
711
        """
413
 
        included = self.inclusions(versions)
 
712
        for i in versions:
 
713
            if not isinstance(i, int):
 
714
                raise ValueError(i)
 
715
            
 
716
        included = self._inclusions(versions)
414
717
 
415
718
        istack = []
 
719
        iset = set()
416
720
        dset = set()
417
721
 
418
722
        lineno = 0         # line of weave, 0-based
423
727
 
424
728
        WFE = WeaveFormatError
425
729
 
 
730
        # wow. 
 
731
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
 
732
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
 
733
        # 1.6 seconds in 'isinstance'.
 
734
        # changing the first isinstance:
 
735
        #  449       0   2814.2660   1577.1760   bzrlib.weave:556(_extract)
 
736
        #  +140414   0    762.8050    762.8050   +<isinstance>
 
737
        # note that the inline time actually dropped (less function calls)
 
738
        # and total processing time was halved.
 
739
        # we're still spending ~1/4 of the method in isinstance though.
 
740
        # so lets hard code the acceptable string classes we expect:
 
741
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
 
742
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
743
        #                                          objects>
 
744
        # yay, down to ~1/4 the initial extract time, and our inline time
 
745
        # has shrunk again, with isinstance no longer dominating.
 
746
        # tweaking the stack inclusion test to use a set gives:
 
747
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
 
748
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
749
        #                                          objects>
 
750
        # - a 5% win, or possibly just noise. However with large istacks that
 
751
        # 'in' test could dominate, so I'm leaving this change in place -
 
752
        # when its fast enough to consider profiling big datasets we can review.
 
753
 
 
754
              
 
755
             
 
756
 
426
757
        for l in self._weave:
427
 
            if isinstance(l, tuple):
 
758
            if l.__class__ == tuple:
428
759
                c, v = l
429
760
                isactive = None
430
761
                if c == '{':
431
 
                    assert v not in istack
 
762
                    assert v not in iset
432
763
                    istack.append(v)
 
764
                    iset.add(v)
433
765
                elif c == '}':
434
 
                    oldv = istack.pop()
435
 
                    assert oldv == v
 
766
                    iset.remove(istack.pop())
436
767
                elif c == '[':
437
768
                    if v in included:
438
769
                        assert v not in dset
443
774
                        assert v in dset
444
775
                        dset.remove(v)
445
776
            else:
446
 
                assert isinstance(l, basestring)
 
777
                assert l.__class__ in (str, unicode)
447
778
                if isactive is None:
448
779
                    isactive = (not dset) and istack and (istack[-1] in included)
449
780
                if isactive:
450
781
                    result.append((istack[-1], lineno, l))
451
782
            lineno += 1
452
 
 
453
783
        if istack:
454
 
            raise WFE("unclosed insertion blocks at end of weave",
455
 
                                   istack)
 
784
            raise WeaveFormatError("unclosed insertion blocks "
 
785
                    "at end of weave: %s" % istack)
456
786
        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):
 
787
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
788
                                   % dset)
 
789
        return result
 
790
 
 
791
    def _maybe_lookup(self, name_or_index):
 
792
        """Convert possible symbolic name to index, or pass through indexes.
 
793
        
 
794
        NOT FOR PUBLIC USE.
 
795
        """
 
796
        if isinstance(name_or_index, (int, long)):
 
797
            return name_or_index
 
798
        else:
 
799
            return self._lookup(name_or_index)
 
800
 
 
801
    def get_lines(self, version_id):
 
802
        """See VersionedFile.get_lines()."""
 
803
        int_index = self._maybe_lookup(version_id)
 
804
        result = [line for (origin, lineno, line) in self._extract([int_index])]
 
805
        expected_sha1 = self._sha1s[int_index]
 
806
        measured_sha1 = sha_strings(result)
 
807
        if measured_sha1 != expected_sha1:
 
808
            raise errors.WeaveInvalidChecksum(
 
809
                    'file %s, revision %s, expected: %s, measured %s' 
 
810
                    % (self._weave_name, version_id,
 
811
                       expected_sha1, measured_sha1))
 
812
        return result
 
813
 
 
814
    def get_sha1(self, version_id):
 
815
        """See VersionedFile.get_sha1()."""
 
816
        return self._sha1s[self._lookup(version_id)]
 
817
 
 
818
    def get_sha1s(self, version_ids):
 
819
        """See VersionedFile.get_sha1s()."""
 
820
        return [self._sha1s[self._lookup(v)] for v in version_ids]
 
821
 
 
822
    def num_versions(self):
 
823
        """How many versions are in this weave?"""
490
824
        l = len(self._parents)
491
825
        assert l == len(self._sha1s)
492
826
        return l
493
827
 
494
 
 
495
 
    def __len__(self):
496
 
        return self.numversions()
497
 
 
 
828
    __len__ = num_versions
498
829
 
499
830
    def check(self, progress_bar=None):
500
 
        # check no circular inclusions
501
 
        for version in range(self.numversions()):
 
831
        # TODO evaluate performance hit of using string sets in this routine.
 
832
        # TODO: check no circular inclusions
 
833
        # TODO: create a nested progress bar
 
834
        for version in range(self.num_versions()):
502
835
            inclusions = list(self._parents[version])
503
836
            if inclusions:
504
837
                inclusions.sort()
506
839
                    raise WeaveFormatError("invalid included version %d for index %d"
507
840
                                           % (inclusions[-1], version))
508
841
 
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):
 
842
        # try extracting all versions; parallel extraction is used
 
843
        nv = self.num_versions()
 
844
        sha1s = {}
 
845
        texts = {}
 
846
        inclusions = {}
 
847
        for i in range(nv):
 
848
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
 
849
            # The problem is that set membership is much more expensive
 
850
            name = self._idx_to_name(i)
 
851
            sha1s[name] = sha.new()
 
852
            texts[name] = []
 
853
            new_inc = set([name])
 
854
            for p in self._parents[i]:
 
855
                new_inc.update(inclusions[self._idx_to_name(p)])
 
856
 
 
857
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
858
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
859
            inclusions[name] = new_inc
 
860
 
 
861
        nlines = len(self._weave)
 
862
 
 
863
        update_text = 'checking weave'
 
864
        if self._weave_name:
 
865
            short_name = os.path.basename(self._weave_name)
 
866
            update_text = 'checking %s' % (short_name,)
 
867
            update_text = update_text[:25]
 
868
 
 
869
        for lineno, insert, deleteset, line in self._walk_internal():
514
870
            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]
 
871
                progress_bar.update(update_text, lineno, nlines)
 
872
 
 
873
            for name, name_inclusions in inclusions.items():
 
874
                # The active inclusion must be an ancestor,
 
875
                # and no ancestors must have deleted this line,
 
876
                # because we don't support resurrection.
 
877
                if (insert in name_inclusions) and not (deleteset & name_inclusions):
 
878
                    sha1s[name].update(line)
 
879
 
 
880
        for i in range(nv):
 
881
            version = self._idx_to_name(i)
 
882
            hd = sha1s[version].hexdigest()
 
883
            expected = self._sha1s[i]
521
884
            if hd != expected:
522
 
                raise WeaveError("mismatched sha1 for version %d; "
523
 
                                 "got %s, expected %s"
524
 
                                 % (version, hd, expected))
 
885
                raise errors.WeaveInvalidChecksum(
 
886
                        "mismatched sha1 for version %s: "
 
887
                        "got %s, expected %s"
 
888
                        % (version, hd, expected))
525
889
 
526
890
        # TODO: check insertions are properly nested, that there are
527
891
        # no lines outside of insertion blocks, that deletions are
528
892
        # properly paired, etc.
529
893
 
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):
 
894
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
895
        """Worker routine for join()."""
 
896
        if not other.versions():
 
897
            return          # nothing to update, easy
 
898
 
 
899
        if not version_ids:
 
900
            # versions is never none, InterWeave checks this.
 
901
            return 0
 
902
 
 
903
        # two loops so that we do not change ourselves before verifying it
 
904
        # will be ok
 
905
        # work through in index order to make sure we get all dependencies
 
906
        names_to_join = []
 
907
        processed = 0
 
908
        # get the selected versions only that are in other.versions.
 
909
        version_ids = set(other.versions()).intersection(set(version_ids))
 
910
        # pull in the referenced graph.
 
911
        version_ids = other.get_ancestry(version_ids)
 
912
        pending_graph = [(version, other.get_parents(version)) for
 
913
                         version in version_ids]
 
914
        for name in topo_sort(pending_graph):
 
915
            other_idx = other._name_map[name]
 
916
            # returns True if we have it, False if we need it.
 
917
            if not self._check_version_consistent(other, other_idx, name):
 
918
                names_to_join.append((other_idx, name))
 
919
            processed += 1
 
920
 
 
921
 
 
922
        if pb and not msg:
 
923
            msg = 'weave join'
 
924
 
 
925
        merged = 0
 
926
        time0 = time.time()
 
927
        for other_idx, name in names_to_join:
 
928
            # TODO: If all the parents of the other version are already
 
929
            # present then we can avoid some work by just taking the delta
 
930
            # and adjusting the offsets.
 
931
            new_parents = self._imported_parents(other, other_idx)
 
932
            sha1 = other._sha1s[other_idx]
 
933
 
 
934
            merged += 1
 
935
 
 
936
            if pb:
 
937
                pb.update(msg, merged, len(names_to_join))
 
938
           
 
939
            lines = other.get_lines(other_idx)
 
940
            self._add(name, lines, new_parents, sha1)
 
941
 
 
942
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
943
                merged, processed, self._weave_name, time.time()-time0))
 
944
 
 
945
    def _imported_parents(self, other, other_idx):
 
946
        """Return list of parents in self corresponding to indexes in other."""
 
947
        new_parents = []
 
948
        for parent_idx in other._parents[other_idx]:
 
949
            parent_name = other._names[parent_idx]
 
950
            if parent_name not in self._name_map:
 
951
                # should not be possible
 
952
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
953
                                 % (parent_name, other._name_map[other_idx], self))
 
954
            new_parents.append(self._name_map[parent_name])
 
955
        return new_parents
 
956
 
 
957
    def _check_version_consistent(self, other, other_idx, name):
 
958
        """Check if a version in consistent in this and other.
 
959
 
 
960
        To be consistent it must have:
 
961
 
 
962
         * the same text
 
963
         * the same direct parents (by name, not index, and disregarding
 
964
           order)
 
965
        
 
966
        If present & correct return True;
 
967
        if not present in self return False; 
 
968
        if inconsistent raise error."""
 
969
        this_idx = self._name_map.get(name, -1)
 
970
        if this_idx != -1:
 
971
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
972
                raise errors.WeaveTextDiffers(name, self, other)
 
973
            self_parents = self._parents[this_idx]
 
974
            other_parents = other._parents[other_idx]
 
975
            n1 = set([self._names[i] for i in self_parents])
 
976
            n2 = set([other._names[i] for i in other_parents])
 
977
            if not self._compatible_parents(n1, n2):
 
978
                raise WeaveParentMismatch("inconsistent parents "
 
979
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
980
            else:
 
981
                return True         # ok!
 
982
        else:
 
983
            return False
 
984
 
 
985
    def _reweave(self, other, pb, msg):
 
986
        """Reweave self with other - internal helper for join().
 
987
 
 
988
        :param other: The other weave to merge
 
989
        :param pb: An optional progress bar, indicating how far done we are
 
990
        :param msg: An optional message for the progress
 
991
        """
 
992
        new_weave = _reweave(self, other, pb=pb, msg=msg)
 
993
        self._copy_weave_content(new_weave)
 
994
 
 
995
    def _copy_weave_content(self, otherweave):
 
996
        """adsorb the content from otherweave."""
 
997
        for attr in self.__slots__:
 
998
            if attr != '_weave_name':
 
999
                setattr(self, attr, copy(getattr(otherweave, attr)))
 
1000
 
 
1001
 
 
1002
class WeaveFile(Weave):
 
1003
    """A WeaveFile represents a Weave on disk and writes on change."""
 
1004
 
 
1005
    WEAVE_SUFFIX = '.weave'
 
1006
    
 
1007
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
1008
        """Create a WeaveFile.
 
1009
        
 
1010
        :param create: If not True, only open an existing knit.
 
1011
        """
 
1012
        super(WeaveFile, self).__init__(name, access_mode)
 
1013
        self._transport = transport
 
1014
        self._filemode = filemode
 
1015
        try:
 
1016
            _read_weave_v5(self._transport.get(name + WeaveFile.WEAVE_SUFFIX), self)
 
1017
        except errors.NoSuchFile:
 
1018
            if not create:
 
1019
                raise
 
1020
            # new file, save it
 
1021
            self._save()
 
1022
 
 
1023
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
1024
        left_matching_blocks=None):
 
1025
        """Add a version and save the weave."""
 
1026
        self.check_not_reserved_id(version_id)
 
1027
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
 
1028
                                                   parent_texts)
 
1029
        self._save()
 
1030
        return result
 
1031
 
 
1032
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1033
        """See VersionedFile.clone_text."""
 
1034
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1035
        self._save
 
1036
 
 
1037
    def copy_to(self, name, transport):
 
1038
        """See VersionedFile.copy_to()."""
 
1039
        # as we are all in memory always, just serialise to the new place.
 
1040
        sio = StringIO()
 
1041
        write_weave_v5(self, sio)
 
1042
        sio.seek(0)
 
1043
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1044
 
 
1045
    def create_empty(self, name, transport, filemode=None):
 
1046
        return WeaveFile(name, transport, filemode, create=True)
 
1047
 
 
1048
    def _save(self):
 
1049
        """Save the weave."""
 
1050
        self._check_write_ok()
 
1051
        sio = StringIO()
 
1052
        write_weave_v5(self, sio)
 
1053
        sio.seek(0)
 
1054
        self._transport.put_file(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1055
                                 sio,
 
1056
                                 self._filemode)
 
1057
 
 
1058
    @staticmethod
 
1059
    def get_suffixes():
 
1060
        """See VersionedFile.get_suffixes()."""
 
1061
        return [WeaveFile.WEAVE_SUFFIX]
 
1062
 
 
1063
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1064
             ignore_missing=False):
 
1065
        """Join other into self and save."""
 
1066
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
 
1067
        self._save()
 
1068
 
 
1069
 
 
1070
def _reweave(wa, wb, pb=None, msg=None):
 
1071
    """Combine two weaves and return the result.
 
1072
 
 
1073
    This works even if a revision R has different parents in 
 
1074
    wa and wb.  In the resulting weave all the parents are given.
 
1075
 
 
1076
    This is done by just building up a new weave, maintaining ordering 
 
1077
    of the versions in the two inputs.  More efficient approaches
 
1078
    might be possible but it should only be necessary to do 
 
1079
    this operation rarely, when a new previously ghost version is 
 
1080
    inserted.
 
1081
 
 
1082
    :param pb: An optional progress bar, indicating how far done we are
 
1083
    :param msg: An optional message for the progress
 
1084
    """
 
1085
    wr = Weave()
 
1086
    ia = ib = 0
 
1087
    queue_a = range(wa.num_versions())
 
1088
    queue_b = range(wb.num_versions())
 
1089
    # first determine combined parents of all versions
 
1090
    # map from version name -> all parent names
 
1091
    combined_parents = _reweave_parent_graphs(wa, wb)
 
1092
    mutter("combined parents: %r", combined_parents)
 
1093
    order = topo_sort(combined_parents.iteritems())
 
1094
    mutter("order to reweave: %r", order)
 
1095
 
 
1096
    if pb and not msg:
 
1097
        msg = 'reweave'
 
1098
 
 
1099
    for idx, name in enumerate(order):
 
1100
        if pb:
 
1101
            pb.update(msg, idx, len(order))
 
1102
        if name in wa._name_map:
 
1103
            lines = wa.get_lines(name)
 
1104
            if name in wb._name_map:
 
1105
                lines_b = wb.get_lines(name)
 
1106
                if lines != lines_b:
 
1107
                    mutter('Weaves differ on content. rev_id {%s}', name)
 
1108
                    mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
 
1109
                    import difflib
 
1110
                    lines = list(difflib.unified_diff(lines, lines_b,
 
1111
                            wa._weave_name, wb._weave_name))
 
1112
                    mutter('lines:\n%s', ''.join(lines))
 
1113
                    raise errors.WeaveTextDiffers(name, wa, wb)
 
1114
        else:
 
1115
            lines = wb.get_lines(name)
 
1116
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
 
1117
    return wr
 
1118
 
 
1119
def _reweave_parent_graphs(wa, wb):
 
1120
    """Return combined parent ancestry for two weaves.
 
1121
    
 
1122
    Returned as a list of (version_name, set(parent_names))"""
 
1123
    combined = {}
 
1124
    for weave in [wa, wb]:
 
1125
        for idx, name in enumerate(weave._names):
 
1126
            p = combined.setdefault(name, set())
 
1127
            p.update(map(weave._idx_to_name, weave._parents[idx]))
 
1128
    return combined
 
1129
 
 
1130
 
 
1131
def weave_toc(w):
 
1132
    """Show the weave's table-of-contents"""
 
1133
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1134
    for i in (6, 50, 10, 10):
677
1135
        print '-' * i,
678
1136
    print
679
 
    for i in range(w.numversions()):
 
1137
    for i in range(w.num_versions()):
680
1138
        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
 
1139
        name = w._names[i]
 
1140
        parent_str = ' '.join(map(str, w._parents[i]))
 
1141
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1142
 
 
1143
 
 
1144
 
 
1145
def weave_stats(weave_file, pb):
687
1146
    from bzrlib.weavefile import read_weave
688
1147
 
689
 
    pb = ProgressBar()
690
 
 
691
1148
    wf = file(weave_file, 'rb')
692
1149
    w = read_weave(wf)
693
1150
    # FIXME: doesn't work on pipes
697
1154
    vers = len(w)
698
1155
    for i in range(vers):
699
1156
        pb.update('checking sizes', i, vers)
700
 
        for line in w.get_iter(i):
 
1157
        for origin, lineno, line in w._extract([i]):
701
1158
            total += len(line)
702
1159
 
703
1160
    pb.clear()
706
1163
    print 'weave file        %9d bytes' % weave_size
707
1164
    print 'total contents    %9d bytes' % total
708
1165
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
709
 
 
 
1166
    if vers:
 
1167
        avg = total/vers
 
1168
        print 'average size      %9d bytes' % avg
 
1169
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
710
1170
 
711
1171
 
712
1172
def usage():
721
1181
        Write out specified version.
722
1182
    weave check WEAVEFILE
723
1183
        Check consistency of all versions.
724
 
    weave info WEAVEFILE
 
1184
    weave toc WEAVEFILE
725
1185
        Display table of contents.
726
 
    weave add WEAVEFILE [BASE...] < NEWTEXT
 
1186
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
727
1187
        Add NEWTEXT, with specified parent versions.
728
1188
    weave annotate WEAVEFILE VERSION
729
1189
        Display origin of each line.
730
 
    weave mash WEAVEFILE VERSION...
731
 
        Display composite of all selected versions.
732
1190
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
733
1191
        Auto-merge two versions and display conflicts.
 
1192
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1193
        Show differences between two versions.
734
1194
 
735
1195
example:
736
1196
 
737
1197
    % weave init foo.weave
738
1198
    % vi foo.txt
739
 
    % weave add foo.weave < foo.txt
 
1199
    % weave add foo.weave ver0 < foo.txt
740
1200
    added version 0
741
1201
 
742
1202
    (create updated version)
743
1203
    % vi foo.txt
744
1204
    % weave get foo.weave 0 | diff -u - foo.txt
745
 
    % weave add foo.weave 0 < foo.txt
 
1205
    % weave add foo.weave ver1 0 < foo.txt
746
1206
    added version 1
747
1207
 
748
1208
    % weave get foo.weave 0 > foo.txt       (create forked version)
749
1209
    % vi foo.txt
750
 
    % weave add foo.weave 0 < foo.txt
 
1210
    % weave add foo.weave ver2 0 < foo.txt
751
1211
    added version 2
752
1212
 
753
1213
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
754
1214
    % vi foo.txt                            (resolve conflicts)
755
 
    % weave add foo.weave 1 2 < foo.txt     (commit merged version)     
 
1215
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
756
1216
    
757
1217
"""
758
1218
    
761
1221
def main(argv):
762
1222
    import sys
763
1223
    import os
764
 
    from weavefile import write_weave, read_weave
 
1224
    try:
 
1225
        import bzrlib
 
1226
    except ImportError:
 
1227
        # in case we're run directly from the subdirectory
 
1228
        sys.path.append('..')
 
1229
        import bzrlib
 
1230
    from bzrlib.weavefile import write_weave, read_weave
765
1231
    from bzrlib.progress import ProgressBar
766
1232
 
767
 
    #import psyco
768
 
    #psyco.full()
 
1233
    try:
 
1234
        import psyco
 
1235
        psyco.full()
 
1236
    except ImportError:
 
1237
        pass
 
1238
 
 
1239
    if len(argv) < 2:
 
1240
        usage()
 
1241
        return 0
769
1242
 
770
1243
    cmd = argv[1]
771
1244
 
777
1250
    elif cmd == 'add':
778
1251
        w = readit()
779
1252
        # at the moment, based on everything in the file
780
 
        parents = map(int, argv[3:])
 
1253
        name = argv[3]
 
1254
        parents = map(int, argv[4:])
781
1255
        lines = sys.stdin.readlines()
782
 
        ver = w.add(parents, lines)
 
1256
        ver = w.add(name, parents, lines)
783
1257
        write_weave(w, file(argv[2], 'wb'))
784
 
        print 'added version %d' % ver
 
1258
        print 'added version %r %d' % (name, ver)
785
1259
    elif cmd == 'init':
786
1260
        fn = argv[2]
787
1261
        if os.path.exists(fn):
792
1266
        w = readit()
793
1267
        sys.stdout.writelines(w.get_iter(int(argv[3])))
794
1268
        
795
 
    elif cmd == 'mash': # get composite
 
1269
    elif cmd == 'diff':
796
1270
        w = readit()
797
 
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
798
 
 
 
1271
        fn = argv[2]
 
1272
        v1, v2 = map(int, argv[3:5])
 
1273
        lines1 = w.get(v1)
 
1274
        lines2 = w.get(v2)
 
1275
        diff_gen = bzrlib.patiencediff.unified_diff(lines1, lines2,
 
1276
                                '%s version %d' % (fn, v1),
 
1277
                                '%s version %d' % (fn, v2))
 
1278
        sys.stdout.writelines(diff_gen)
 
1279
            
799
1280
    elif cmd == 'annotate':
800
1281
        w = readit()
801
1282
        # newline is added to all lines regardless; too hard to get
809
1290
                print '%5d | %s' % (origin, text)
810
1291
                lasto = origin
811
1292
                
812
 
    elif cmd == 'info':
813
 
        weave_info(readit())
 
1293
    elif cmd == 'toc':
 
1294
        weave_toc(readit())
814
1295
 
815
1296
    elif cmd == 'stats':
816
 
        weave_stats(argv[2])
 
1297
        weave_stats(argv[2], ProgressBar())
817
1298
        
818
1299
    elif cmd == 'check':
819
1300
        w = readit()
820
1301
        pb = ProgressBar()
821
1302
        w.check(pb)
822
1303
        pb.clear()
823
 
        print '%d versions ok' % w.numversions()
 
1304
        print '%d versions ok' % w.num_versions()
824
1305
 
825
1306
    elif cmd == 'inclusions':
826
1307
        w = readit()
831
1312
        print ' '.join(map(str, w._parents[int(argv[3])]))
832
1313
 
833
1314
    elif cmd == 'plan-merge':
 
1315
        # replaced by 'bzr weave-plan-merge'
834
1316
        w = readit()
835
1317
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
836
1318
            if line:
837
1319
                print '%14s | %s' % (state, line),
838
 
 
839
1320
    elif cmd == 'merge':
 
1321
        # replaced by 'bzr weave-merge-text'
840
1322
        w = readit()
841
1323
        p = w.plan_merge(int(argv[3]), int(argv[4]))
842
1324
        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
1325
    else:
865
1326
        raise ValueError('unknown command %r' % cmd)
866
1327
    
868
1329
if __name__ == '__main__':
869
1330
    import sys
870
1331
    sys.exit(main(sys.argv))
 
1332
 
 
1333
 
 
1334
class InterWeave(InterVersionedFile):
 
1335
    """Optimised code paths for weave to weave operations."""
 
1336
    
 
1337
    _matching_file_from_factory = staticmethod(WeaveFile)
 
1338
    _matching_file_to_factory = staticmethod(WeaveFile)
 
1339
    
 
1340
    @staticmethod
 
1341
    def is_compatible(source, target):
 
1342
        """Be compatible with weaves."""
 
1343
        try:
 
1344
            return (isinstance(source, Weave) and
 
1345
                    isinstance(target, Weave))
 
1346
        except AttributeError:
 
1347
            return False
 
1348
 
 
1349
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1350
        """See InterVersionedFile.join."""
 
1351
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
1352
        if self.target.versions() == [] and version_ids is None:
 
1353
            self.target._copy_weave_content(self.source)
 
1354
            return
 
1355
        try:
 
1356
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1357
        except errors.WeaveParentMismatch:
 
1358
            self.target._reweave(self.source, pb, msg)
 
1359
 
 
1360
 
 
1361
InterVersionedFile.register_optimiser(InterWeave)