← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2006-03-22 16:26:09 UTC
  • mto: (1666.1.5 integration)
  • mto: This revision was merged to the branch mainline in revision 1622.
  • Revision ID: robertc@robertcollins.net-20060322162609-fd4ba4a57afd33ed
Fix common_ancestor to still calculate a common ancestor when ghosts are
present along all paths of ancestry - there are no 'import' revisions
available.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
# Copyright (C) 2005, 2009 Canonical Ltd
2
 
#
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
 
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
7
 
#
 
9
 
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
13
# GNU General Public License for more details.
12
 
#
 
14
 
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
# Author: Martin Pool <mbp@canonical.com>
18
20
 
25
27
# property.
26
28
 
27
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
28
 
# rather than being split up in some other way.  We could accommodate
 
30
# rather than being split up in some other way.  We could accomodate
29
31
# binaries, perhaps by naively splitting on \n or perhaps using
30
32
# something like a rolling checksum.
31
33
 
59
61
# where the basis and destination are unchanged.
60
62
 
61
63
# FIXME: Sometimes we will be given a parents list for a revision
62
 
# that includes some redundant parents (i.e. already a parent of
63
 
# something in the list.)  We should eliminate them.  This can
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
64
66
# be done fairly efficiently because the sequence numbers constrain
65
67
# the possible relationships.
66
68
 
67
 
# FIXME: the conflict markers should be *7* characters
68
69
 
69
70
from copy import copy
70
71
from cStringIO import StringIO
 
72
from difflib import SequenceMatcher
71
73
import os
 
74
import sha
 
75
import time
72
76
 
73
 
from bzrlib.lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from bzrlib import tsort
76
 
""")
77
 
from bzrlib import (
78
 
    errors,
79
 
    osutils,
80
 
    )
 
77
from bzrlib.trace import mutter
81
78
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
79
        RevisionAlreadyPresent,
83
80
        RevisionNotPresent,
84
 
        UnavailableRepresentation,
 
81
        WeaveRevisionAlreadyPresent,
 
82
        WeaveRevisionNotPresent,
85
83
        )
86
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
87
 
import bzrlib.patiencediff
88
 
from bzrlib.revision import NULL_REVISION
 
84
import bzrlib.errors as errors
 
85
from bzrlib.osutils import sha_strings
89
86
from bzrlib.symbol_versioning import *
90
 
from bzrlib.trace import mutter
91
 
from bzrlib.versionedfile import (
92
 
    AbsentContentFactory,
93
 
    adapter_registry,
94
 
    ContentFactory,
95
 
    sort_groupcompress,
96
 
    VersionedFile,
97
 
    )
 
87
from bzrlib.tsort import topo_sort
 
88
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
98
89
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
90
 
100
91
 
101
 
class WeaveContentFactory(ContentFactory):
102
 
    """Content factory for streaming from weaves.
103
 
 
104
 
    :seealso ContentFactory:
105
 
    """
106
 
 
107
 
    def __init__(self, version, weave):
108
 
        """Create a WeaveContentFactory for version from weave."""
109
 
        ContentFactory.__init__(self)
110
 
        self.sha1 = weave.get_sha1s([version])[version]
111
 
        self.key = (version,)
112
 
        parents = weave.get_parent_map([version])[version]
113
 
        self.parents = tuple((parent,) for parent in parents)
114
 
        self.storage_kind = 'fulltext'
115
 
        self._weave = weave
116
 
 
117
 
    def get_bytes_as(self, storage_kind):
118
 
        if storage_kind == 'fulltext':
119
 
            return self._weave.get_text(self.key[-1])
120
 
        elif storage_kind == 'chunked':
121
 
            return self._weave.get_lines(self.key[-1])
122
 
        else:
123
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
124
 
 
125
 
 
126
92
class Weave(VersionedFile):
127
93
    """weave - versioned text file storage.
128
 
 
 
94
    
129
95
    A Weave manages versions of line-based text files, keeping track
130
96
    of the originating version for each line.
131
97
 
177
143
 
178
144
    * It doesn't seem very useful to have an active insertion
179
145
      inside an inactive insertion, but it might happen.
180
 
 
 
146
      
181
147
    * Therefore, all instructions are always"considered"; that
182
148
      is passed onto and off the stack.  An outer inactive block
183
149
      doesn't disable an inner block.
213
179
    """
214
180
 
215
181
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
216
 
                 '_weave_name', '_matcher', '_allow_reserved']
217
 
 
218
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
219
 
                 get_scope=None, allow_reserved=False):
220
 
        """Create a weave.
221
 
 
222
 
        :param get_scope: A callable that returns an opaque object to be used
223
 
            for detecting when this weave goes out of scope (should stop
224
 
            answering requests or allowing mutation).
225
 
        """
226
 
        super(Weave, self).__init__()
 
182
                 '_weave_name']
 
183
    
 
184
    def __init__(self, weave_name=None, access_mode='w'):
 
185
        super(Weave, self).__init__(access_mode)
227
186
        self._weave = []
228
187
        self._parents = []
229
188
        self._sha1s = []
230
189
        self._names = []
231
190
        self._name_map = {}
232
191
        self._weave_name = weave_name
233
 
        if matcher is None:
234
 
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
 
        else:
236
 
            self._matcher = matcher
237
 
        if get_scope is None:
238
 
            get_scope = lambda:None
239
 
        self._get_scope = get_scope
240
 
        self._scope = get_scope()
241
 
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
192
 
244
193
    def __repr__(self):
245
194
        return "Weave(%r)" % self._weave_name
246
195
 
247
 
    def _check_write_ok(self):
248
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
249
 
        if self._get_scope() != self._scope:
250
 
            raise errors.OutSideTransaction()
251
 
        if self._access_mode != 'w':
252
 
            raise errors.ReadOnlyObjectDirtiedError(self)
253
 
 
254
196
    def copy(self):
255
197
        """Return a deep copy of self.
256
 
 
 
198
        
257
199
        The copy can be modified without affecting the original weave."""
258
200
        other = Weave()
259
201
        other._weave = self._weave[:]
269
211
            return False
270
212
        return self._parents == other._parents \
271
213
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
273
 
 
 
214
               and self._sha1s == other._sha1s 
 
215
    
274
216
    def __ne__(self, other):
275
217
        return not self.__eq__(other)
276
218
 
 
219
    @deprecated_method(zero_eight)
 
220
    def idx_to_name(self, index):
 
221
        """Old public interface, the public interface is all names now."""
 
222
        return index
 
223
 
277
224
    def _idx_to_name(self, version):
278
225
        return self._names[version]
279
226
 
 
227
    @deprecated_method(zero_eight)
 
228
    def lookup(self, name):
 
229
        """Backwards compatability thunk:
 
230
 
 
231
        Return name, as name is valid in the api now, and spew deprecation
 
232
        warnings everywhere.
 
233
        """
 
234
        return name
 
235
 
280
236
    def _lookup(self, name):
281
237
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
284
238
        try:
285
239
            return self._name_map[name]
286
240
        except KeyError:
287
241
            raise RevisionNotPresent(name, self._weave_name)
288
242
 
 
243
    @deprecated_method(zero_eight)
 
244
    def iter_names(self):
 
245
        """Deprecated convenience function, please see VersionedFile.names()."""
 
246
        return iter(self.names())
 
247
 
 
248
    @deprecated_method(zero_eight)
 
249
    def names(self):
 
250
        """See Weave.versions for the current api."""
 
251
        return self.versions()
 
252
 
289
253
    def versions(self):
290
254
        """See VersionedFile.versions."""
291
255
        return self._names[:]
292
256
 
293
257
    def has_version(self, version_id):
294
258
        """See VersionedFile.has_version."""
295
 
        return (version_id in self._name_map)
 
259
        return self._name_map.has_key(version_id)
296
260
 
297
261
    __contains__ = has_version
298
262
 
299
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
300
 
        """Get a stream of records for versions.
301
 
 
302
 
        :param versions: The versions to include. Each version is a tuple
303
 
            (version,).
304
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
305
 
            sorted stream has compression parents strictly before their
306
 
            children.
307
 
        :param include_delta_closure: If True then the closure across any
308
 
            compression parents will be included (in the opaque data).
309
 
        :return: An iterator of ContentFactory objects, each of which is only
310
 
            valid until the iterator is advanced.
311
 
        """
312
 
        versions = [version[-1] for version in versions]
313
 
        if ordering == 'topological':
314
 
            parents = self.get_parent_map(versions)
315
 
            new_versions = tsort.topo_sort(parents)
316
 
            new_versions.extend(set(versions).difference(set(parents)))
317
 
            versions = new_versions
318
 
        elif ordering == 'groupcompress':
319
 
            parents = self.get_parent_map(versions)
320
 
            new_versions = sort_groupcompress(parents)
321
 
            new_versions.extend(set(versions).difference(set(parents)))
322
 
            versions = new_versions
323
 
        for version in versions:
324
 
            if version in self:
325
 
                yield WeaveContentFactory(version, self)
326
 
            else:
327
 
                yield AbsentContentFactory((version,))
328
 
 
329
 
    def get_parent_map(self, version_ids):
330
 
        """See VersionedFile.get_parent_map."""
331
 
        result = {}
 
263
    def get_delta(self, version_id):
 
264
        """See VersionedFile.get_delta."""
 
265
        return self.get_deltas([version_id])[version_id]
 
266
 
 
267
    def get_deltas(self, version_ids):
 
268
        """See VersionedFile.get_deltas."""
 
269
        version_ids = self.get_ancestry(version_ids)
332
270
        for version_id in version_ids:
333
 
            if version_id == NULL_REVISION:
334
 
                parents = ()
335
 
            else:
336
 
                try:
337
 
                    parents = tuple(
338
 
                        map(self._idx_to_name,
339
 
                            self._parents[self._lookup(version_id)]))
340
 
                except RevisionNotPresent:
 
271
            if not self.has_version(version_id):
 
272
                raise RevisionNotPresent(version_id, self)
 
273
        # try extracting all versions; parallel extraction is used
 
274
        nv = self.num_versions()
 
275
        sha1s = {}
 
276
        deltas = {}
 
277
        texts = {}
 
278
        inclusions = {}
 
279
        noeols = {}
 
280
        last_parent_lines = {}
 
281
        parents = {}
 
282
        parent_inclusions = {}
 
283
        parent_linenums = {}
 
284
        parent_noeols = {}
 
285
        current_hunks = {}
 
286
        diff_hunks = {}
 
287
        # its simplest to generate a full set of prepared variables.
 
288
        for i in range(nv):
 
289
            name = self._names[i]
 
290
            sha1s[name] = self.get_sha1(name)
 
291
            parents_list = self.get_parents(name)
 
292
            try:
 
293
                parent = parents_list[0]
 
294
                parents[name] = parent
 
295
                parent_inclusions[name] = inclusions[parent]
 
296
            except IndexError:
 
297
                parents[name] = None
 
298
                parent_inclusions[name] = set()
 
299
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
 
300
            diff_hunks[name] = []
 
301
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
 
302
            parent_linenums[name] = 0
 
303
            noeols[name] = False
 
304
            parent_noeols[name] = False
 
305
            last_parent_lines[name] = None
 
306
            new_inc = set([name])
 
307
            for p in self._parents[i]:
 
308
                new_inc.update(inclusions[self._idx_to_name(p)])
 
309
            # debug only, known good so far.
 
310
            #assert set(new_inc) == set(self.get_ancestry(name)), \
 
311
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
312
            inclusions[name] = new_inc
 
313
 
 
314
        nlines = len(self._weave)
 
315
 
 
316
        for lineno, inserted, deletes, line in self._walk_internal():
 
317
            # a line is active in a version if:
 
318
            # insert is in the versions inclusions
 
319
            # and
 
320
            # deleteset & the versions inclusions is an empty set.
 
321
            # so - if we have a included by mapping - version is included by
 
322
            # children, we get a list of children to examine for deletes affect
 
323
            # ing them, which is less than the entire set of children.
 
324
            for version_id in version_ids:  
 
325
                # The active inclusion must be an ancestor,
 
326
                # and no ancestors must have deleted this line,
 
327
                # because we don't support resurrection.
 
328
                parent_inclusion = parent_inclusions[version_id]
 
329
                inclusion = inclusions[version_id]
 
330
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
 
331
                version_active = inserted in inclusion and not (deletes & inclusion)
 
332
                if not parent_active and not version_active:
 
333
                    # unrelated line of ancestry
341
334
                    continue
342
 
            result[version_id] = parents
 
335
                elif parent_active and version_active:
 
336
                    # shared line
 
337
                    parent_linenum = parent_linenums[version_id]
 
338
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
 
339
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
 
340
                    parent_linenum += 1
 
341
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
 
342
                    parent_linenums[version_id] = parent_linenum
 
343
                    try:
 
344
                        if line[-1] != '\n':
 
345
                            noeols[version_id] = True
 
346
                    except IndexError:
 
347
                        pass
 
348
                elif parent_active and not version_active:
 
349
                    # deleted line
 
350
                    current_hunks[version_id][1] += 1
 
351
                    parent_linenums[version_id] += 1
 
352
                    last_parent_lines[version_id] = line
 
353
                elif not parent_active and version_active:
 
354
                    # replacement line
 
355
                    # noeol only occurs at the end of a file because we 
 
356
                    # diff linewise. We want to show noeol changes as a
 
357
                    # empty diff unless the actual eol-less content changed.
 
358
                    theline = line
 
359
                    try:
 
360
                        if last_parent_lines[version_id][-1] != '\n':
 
361
                            parent_noeols[version_id] = True
 
362
                    except (TypeError, IndexError):
 
363
                        pass
 
364
                    try:
 
365
                        if theline[-1] != '\n':
 
366
                            noeols[version_id] = True
 
367
                    except IndexError:
 
368
                        pass
 
369
                    new_line = False
 
370
                    parent_should_go = False
 
371
 
 
372
                    if parent_noeols[version_id] == noeols[version_id]:
 
373
                        # no noeol toggle, so trust the weaves statement
 
374
                        # that this line is changed.
 
375
                        new_line = True
 
376
                        if parent_noeols[version_id]:
 
377
                            theline = theline + '\n'
 
378
                    elif parent_noeols[version_id]:
 
379
                        # parent has no eol, we do:
 
380
                        # our line is new, report as such..
 
381
                        new_line = True
 
382
                    elif noeols[version_id]:
 
383
                        # append a eol so that it looks like
 
384
                        # a normalised delta
 
385
                        theline = theline + '\n'
 
386
                        if parents[version_id] is not None:
 
387
                        #if last_parent_lines[version_id] is not None:
 
388
                            parent_should_go = True
 
389
                        if last_parent_lines[version_id] != theline:
 
390
                            # but changed anyway
 
391
                            new_line = True
 
392
                            #parent_should_go = False
 
393
                    if new_line:
 
394
                        current_hunks[version_id][2] += 1
 
395
                        current_hunks[version_id][3].append((inserted, theline))
 
396
                    if parent_should_go:
 
397
                        # last hunk last parent line is not eaten
 
398
                        current_hunks[version_id][1] -= 1
 
399
                    if current_hunks[version_id][1] < 0:
 
400
                        current_hunks[version_id][1] = 0
 
401
                        # import pdb;pdb.set_trace()
 
402
                    # assert current_hunks[version_id][1] >= 0
 
403
 
 
404
        # flush last hunk
 
405
        for i in range(nv):
 
406
            version = self._idx_to_name(i)
 
407
            if current_hunks[version] != [0, 0, 0, []]:
 
408
                diff_hunks[version].append(tuple(current_hunks[version]))
 
409
        result = {}
 
410
        for version_id in version_ids:
 
411
            result[version_id] = (
 
412
                                  parents[version_id],
 
413
                                  sha1s[version_id],
 
414
                                  noeols[version_id],
 
415
                                  diff_hunks[version_id],
 
416
                                  )
343
417
        return result
344
418
 
345
 
    def get_parents_with_ghosts(self, version_id):
346
 
        raise NotImplementedError(self.get_parents_with_ghosts)
347
 
 
348
 
    def insert_record_stream(self, stream):
349
 
        """Insert a record stream into this versioned file.
350
 
 
351
 
        :param stream: A stream of records to insert.
352
 
        :return: None
353
 
        :seealso VersionedFile.get_record_stream:
354
 
        """
355
 
        adapters = {}
356
 
        for record in stream:
357
 
            # Raise an error when a record is missing.
358
 
            if record.storage_kind == 'absent':
359
 
                raise RevisionNotPresent([record.key[0]], self)
360
 
            # adapt to non-tuple interface
361
 
            parents = [parent[0] for parent in record.parents]
362
 
            if (record.storage_kind == 'fulltext'
363
 
                or record.storage_kind == 'chunked'):
364
 
                self.add_lines(record.key[0], parents,
365
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
366
 
            else:
367
 
                adapter_key = record.storage_kind, 'fulltext'
368
 
                try:
369
 
                    adapter = adapters[adapter_key]
370
 
                except KeyError:
371
 
                    adapter_factory = adapter_registry.get(adapter_key)
372
 
                    adapter = adapter_factory(self)
373
 
                    adapters[adapter_key] = adapter
374
 
                lines = split_lines(adapter.get_bytes(record))
375
 
                try:
376
 
                    self.add_lines(record.key[0], parents, lines)
377
 
                except RevisionAlreadyPresent:
378
 
                    pass
 
419
    def get_parents(self, version_id):
 
420
        """See VersionedFile.get_parent."""
 
421
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
379
422
 
380
423
    def _check_repeated_add(self, name, parents, text, sha1):
381
424
        """Check that a duplicated add is OK.
388
431
            raise RevisionAlreadyPresent(name, self._weave_name)
389
432
        return idx
390
433
 
391
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
392
 
       left_matching_blocks, nostore_sha, random_id, check_content):
 
434
    @deprecated_method(zero_eight)
 
435
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
436
        """Please use Weave.clone_text now."""
 
437
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
438
 
 
439
    def _add_lines(self, version_id, parents, lines, parent_texts):
393
440
        """See VersionedFile.add_lines."""
394
 
        idx = self._add(version_id, lines, map(self._lookup, parents),
395
 
            nostore_sha=nostore_sha)
396
 
        return sha_strings(lines), sum(map(len, lines)), idx
397
 
 
398
 
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
 
441
        return self._add(version_id, lines, map(self._lookup, parents))
 
442
 
 
443
    @deprecated_method(zero_eight)
 
444
    def add(self, name, parents, text, sha1=None):
 
445
        """See VersionedFile.add_lines for the non deprecated api."""
 
446
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
 
447
 
 
448
    def _add(self, version_id, lines, parents, sha1=None):
399
449
        """Add a single text on top of the weave.
400
 
 
 
450
  
401
451
        Returns the index number of the newly added version.
402
452
 
403
453
        version_id
404
454
            Symbolic name for this version.
405
455
            (Typically the revision-id of the revision that added it.)
406
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
407
456
 
408
457
        parents
409
458
            List or set of direct parent version numbers.
410
 
 
 
459
            
411
460
        lines
412
461
            Sequence of lines to be added in the new version.
 
462
        """
413
463
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
415
 
        """
416
 
        self._check_lines_not_unicode(lines)
417
 
        self._check_lines_are_lines(lines)
 
464
        assert isinstance(version_id, basestring)
418
465
        if not sha1:
419
466
            sha1 = sha_strings(lines)
420
 
        if sha1 == nostore_sha:
421
 
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
467
        if version_id in self._name_map:
425
468
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
469
 
437
480
        self._names.append(version_id)
438
481
        self._name_map[version_id] = new_version
439
482
 
440
 
 
 
483
            
441
484
        if not parents:
442
485
            # special case; adding with no parents revision; can do
443
486
            # this more quickly by just appending unconditionally.
454
497
            if sha1 == self._sha1s[pv]:
455
498
                # special case: same as the single parent
456
499
                return new_version
457
 
 
 
500
            
458
501
 
459
502
        ancestors = self._inclusions(parents)
460
503
 
470
513
        # another small special case: a merge, producing the same text
471
514
        # as auto-merge
472
515
        if lines == basis_lines:
473
 
            return new_version
 
516
            return new_version            
474
517
 
475
 
        # add a sentinel, because we can also match against the final line
 
518
        # add a sentinal, because we can also match against the final line
476
519
        basis_lineno.append(len(self._weave))
477
520
 
478
521
        # XXX: which line of the weave should we really consider
482
525
        #print 'basis_lines:', basis_lines
483
526
        #print 'new_lines:  ', lines
484
527
 
485
 
        s = self._matcher(None, basis_lines, lines)
 
528
        s = SequenceMatcher(None, basis_lines, lines)
486
529
 
487
530
        # offset gives the number of lines that have been inserted
488
531
        # into the weave up to the current point; if the original edit instruction
495
538
            #print 'raw match', tag, i1, i2, j1, j2
496
539
            if tag == 'equal':
497
540
                continue
 
541
 
498
542
            i1 = basis_lineno[i1]
499
543
            i2 = basis_lineno[i2]
 
544
 
 
545
            assert 0 <= j1 <= j2 <= len(lines)
 
546
 
 
547
            #print tag, i1, i2, j1, j2
 
548
 
500
549
            # the deletion and insertion are handled separately.
501
550
            # first delete the region.
502
551
            if i1 != i2:
509
558
                # i2; we want to insert after this region to make sure
510
559
                # we don't destroy ourselves
511
560
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
561
                self._weave[i:i] = ([('{', new_version)] 
 
562
                                    + lines[j1:j2] 
514
563
                                    + [('}', None)])
515
564
                offset += 2 + (j2 - j1)
516
565
        return new_version
517
566
 
 
567
    def _clone_text(self, new_version_id, old_version_id, parents):
 
568
        """See VersionedFile.clone_text."""
 
569
        old_lines = self.get_text(old_version_id)
 
570
        self.add_lines(new_version_id, parents, old_lines)
 
571
 
518
572
    def _inclusions(self, versions):
519
573
        """Return set of all ancestors of given version(s)."""
520
574
        if not len(versions):
528
582
        ## except IndexError:
529
583
        ##     raise ValueError("version %d not present in weave" % v)
530
584
 
531
 
    def get_ancestry(self, version_ids, topo_sorted=True):
 
585
    @deprecated_method(zero_eight)
 
586
    def inclusions(self, version_ids):
 
587
        """Deprecated - see VersionedFile.get_ancestry for the replacement."""
 
588
        if not version_ids:
 
589
            return []
 
590
        if isinstance(version_ids[0], int):
 
591
            return [self._idx_to_name(v) for v in self._inclusions(version_ids)]
 
592
        else:
 
593
            return self.get_ancestry(version_ids)
 
594
 
 
595
    def get_ancestry(self, version_ids):
532
596
        """See VersionedFile.get_ancestry."""
533
597
        if isinstance(version_ids, basestring):
534
598
            version_ids = [version_ids]
543
607
            if not isinstance(l, basestring):
544
608
                raise ValueError("text line should be a string or unicode, not %s"
545
609
                                 % type(l))
546
 
 
 
610
        
547
611
 
548
612
 
549
613
    def _check_versions(self, indexes):
557
621
    def _compatible_parents(self, my_parents, other_parents):
558
622
        """During join check that other_parents are joinable with my_parents.
559
623
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
624
        Joinable is defined as 'is a subset of' - supersets may require 
561
625
        regeneration of diffs, but subsets do not.
562
626
        """
563
627
        return len(other_parents.difference(my_parents)) == 0
564
628
 
565
629
    def annotate(self, version_id):
566
 
        """Return a list of (version-id, line) tuples for version_id.
 
630
        if isinstance(version_id, int):
 
631
            warn('Weave.annotate(int) is deprecated. Please use version names'
 
632
                 ' in all circumstances as of 0.8',
 
633
                 DeprecationWarning,
 
634
                 stacklevel=2
 
635
                 )
 
636
            result = []
 
637
            for origin, lineno, text in self._extract([version_id]):
 
638
                result.append((origin, text))
 
639
            return result
 
640
        else:
 
641
            return super(Weave, self).annotate(version_id)
 
642
    
 
643
    def annotate_iter(self, version_id):
 
644
        """Yield list of (version-id, line) pairs for the specified version.
567
645
 
568
646
        The index indicates when the line originated in the weave."""
569
647
        incls = [self._lookup(version_id)]
570
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
 
            self._extract(incls)]
572
 
 
573
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
574
 
                                                pb=None):
 
648
        for origin, lineno, text in self._extract(incls):
 
649
            yield self._idx_to_name(origin), text
 
650
 
 
651
    @deprecated_method(zero_eight)
 
652
    def _walk(self):
 
653
        """_walk has become visit, a supported api."""
 
654
        return self._walk_internal()
 
655
 
 
656
    def iter_lines_added_or_present_in_versions(self, version_ids=None):
575
657
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
576
658
        if version_ids is None:
577
659
            version_ids = self.versions()
578
660
        version_ids = set(version_ids)
579
661
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
 
662
            # if inserted not in version_ids then it was inserted before the
 
663
            # versions we care about, but because weaves cannot represent ghosts
 
664
            # properly, we do not filter down to that
 
665
            # if inserted not in version_ids: continue
581
666
            if line[-1] != '\n':
582
 
                yield line + '\n', inserted
 
667
                yield line + '\n'
583
668
            else:
584
 
                yield line, inserted
 
669
                yield line
 
670
 
 
671
    #@deprecated_method(zero_eight)
 
672
    def walk(self, version_ids=None):
 
673
        """See VersionedFile.walk."""
 
674
        return self._walk_internal(version_ids)
585
675
 
586
676
    def _walk_internal(self, version_ids=None):
587
677
        """Helper method for weave actions."""
588
 
 
 
678
        
589
679
        istack = []
590
680
        dset = set()
591
681
 
600
690
                elif c == '}':
601
691
                    istack.pop()
602
692
                elif c == '[':
 
693
                    assert self._names[v] not in dset
603
694
                    dset.add(self._names[v])
604
695
                elif c == ']':
605
696
                    dset.remove(self._names[v])
606
697
                else:
607
698
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
699
            else:
 
700
                assert l.__class__ in (str, unicode)
 
701
                assert istack
609
702
                yield lineno, istack[-1], frozenset(dset), l
610
703
            lineno += 1
611
704
 
616
709
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
617
710
                                   % dset)
618
711
 
619
 
    def plan_merge(self, ver_a, ver_b):
620
 
        """Return pseudo-annotation indicating how the two versions merge.
621
 
 
622
 
        This is computed between versions a and b and their common
623
 
        base.
624
 
 
625
 
        Weave lines present in none of them are skipped entirely.
626
 
        """
627
 
        inc_a = set(self.get_ancestry([ver_a]))
628
 
        inc_b = set(self.get_ancestry([ver_b]))
629
 
        inc_c = inc_a & inc_b
630
 
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
632
 
            if deleteset & inc_c:
633
 
                # killed in parent; can't be in either a or b
634
 
                # not relevant to our work
635
 
                yield 'killed-base', line
636
 
            elif insert in inc_c:
637
 
                # was inserted in base
638
 
                killed_a = bool(deleteset & inc_a)
639
 
                killed_b = bool(deleteset & inc_b)
640
 
                if killed_a and killed_b:
641
 
                    yield 'killed-both', line
642
 
                elif killed_a:
643
 
                    yield 'killed-a', line
644
 
                elif killed_b:
645
 
                    yield 'killed-b', line
646
 
                else:
647
 
                    yield 'unchanged', line
648
 
            elif insert in inc_a:
649
 
                if deleteset & inc_a:
650
 
                    yield 'ghost-a', line
651
 
                else:
652
 
                    # new in A; not in B
653
 
                    yield 'new-a', line
654
 
            elif insert in inc_b:
655
 
                if deleteset & inc_b:
656
 
                    yield 'ghost-b', line
657
 
                else:
658
 
                    yield 'new-b', line
659
 
            else:
660
 
                # not in either revision
661
 
                yield 'irrelevant', line
662
 
 
663
712
    def _extract(self, versions):
664
713
        """Yield annotation of lines in included set.
665
714
 
672
721
        for i in versions:
673
722
            if not isinstance(i, int):
674
723
                raise ValueError(i)
675
 
 
 
724
            
676
725
        included = self._inclusions(versions)
677
726
 
678
727
        istack = []
687
736
 
688
737
        WFE = WeaveFormatError
689
738
 
690
 
        # wow.
 
739
        # wow. 
691
740
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
741
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
742
        # 1.6 seconds in 'isinstance'.
699
748
        # we're still spending ~1/4 of the method in isinstance though.
700
749
        # so lets hard code the acceptable string classes we expect:
701
750
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
751
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
752
        #                                          objects>
704
753
        # yay, down to ~1/4 the initial extract time, and our inline time
705
754
        # has shrunk again, with isinstance no longer dominating.
706
755
        # tweaking the stack inclusion test to use a set gives:
707
756
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
757
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
758
        #                                          objects>
710
759
        # - a 5% win, or possibly just noise. However with large istacks that
711
760
        # 'in' test could dominate, so I'm leaving this change in place -
712
761
        # when its fast enough to consider profiling big datasets we can review.
713
762
 
714
 
 
715
 
 
 
763
              
 
764
             
716
765
 
717
766
        for l in self._weave:
718
767
            if l.__class__ == tuple:
719
768
                c, v = l
720
769
                isactive = None
721
770
                if c == '{':
 
771
                    assert v not in iset
722
772
                    istack.append(v)
723
773
                    iset.add(v)
724
774
                elif c == '}':
725
775
                    iset.remove(istack.pop())
726
776
                elif c == '[':
727
777
                    if v in included:
 
778
                        assert v not in dset
728
779
                        dset.add(v)
729
 
                elif c == ']':
 
780
                else:
 
781
                    assert c == ']'
730
782
                    if v in included:
 
783
                        assert v in dset
731
784
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
785
            else:
 
786
                assert l.__class__ in (str, unicode)
735
787
                if isactive is None:
736
788
                    isactive = (not dset) and istack and (istack[-1] in included)
737
789
                if isactive:
745
797
                                   % dset)
746
798
        return result
747
799
 
 
800
    @deprecated_method(zero_eight)
 
801
    def get_iter(self, name_or_index):
 
802
        """Deprecated, please do not use. Lookups are not not needed.
 
803
        
 
804
        Please use get_lines now.
 
805
        """
 
806
        return iter(self.get_lines(self._maybe_lookup(name_or_index)))
 
807
 
 
808
    @deprecated_method(zero_eight)
 
809
    def maybe_lookup(self, name_or_index):
 
810
        """Deprecated, please do not use. Lookups are not not needed."""
 
811
        return self._maybe_lookup(name_or_index)
 
812
 
748
813
    def _maybe_lookup(self, name_or_index):
749
814
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
 
815
        
751
816
        NOT FOR PUBLIC USE.
752
817
        """
753
818
        if isinstance(name_or_index, (int, long)):
755
820
        else:
756
821
            return self._lookup(name_or_index)
757
822
 
 
823
    @deprecated_method(zero_eight)
 
824
    def get(self, version_id):
 
825
        """Please use either Weave.get_text or Weave.get_lines as desired."""
 
826
        return self.get_lines(version_id)
 
827
 
758
828
    def get_lines(self, version_id):
759
829
        """See VersionedFile.get_lines()."""
760
830
        int_index = self._maybe_lookup(version_id)
763
833
        measured_sha1 = sha_strings(result)
764
834
        if measured_sha1 != expected_sha1:
765
835
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
 
836
                    'file %s, revision %s, expected: %s, measured %s' 
767
837
                    % (self._weave_name, version_id,
768
838
                       expected_sha1, measured_sha1))
769
839
        return result
770
840
 
771
 
    def get_sha1s(self, version_ids):
772
 
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
 
841
    def get_sha1(self, name):
 
842
        """Get the stored sha1 sum for the given revision.
 
843
        
 
844
        :param name: The name of the version to lookup
 
845
        """
 
846
        return self._sha1s[self._lookup(name)]
 
847
 
 
848
    @deprecated_method(zero_eight)
 
849
    def numversions(self):
 
850
        """How many versions are in this weave?
 
851
 
 
852
        Deprecated in favour of num_versions.
 
853
        """
 
854
        return self.num_versions()
777
855
 
778
856
    def num_versions(self):
779
857
        """How many versions are in this weave?"""
780
858
        l = len(self._parents)
 
859
        assert l == len(self._sha1s)
781
860
        return l
782
861
 
783
862
    __len__ = num_versions
803
882
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
883
            # The problem is that set membership is much more expensive
805
884
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
885
            sha1s[name] = sha.new()
807
886
            texts[name] = []
808
887
            new_inc = set([name])
809
888
            for p in self._parents[i]:
810
889
                new_inc.update(inclusions[self._idx_to_name(p)])
811
890
 
812
 
            if set(new_inc) != set(self.get_ancestry(name)):
813
 
                raise AssertionError(
814
 
                    'failed %s != %s'
815
 
                    % (set(new_inc), set(self.get_ancestry(name))))
 
891
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
892
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
816
893
            inclusions[name] = new_inc
817
894
 
818
895
        nlines = len(self._weave)
848
925
        # no lines outside of insertion blocks, that deletions are
849
926
        # properly paired, etc.
850
927
 
 
928
    def _join(self, other, pb, msg, version_ids, ignore_missing):
 
929
        """Worker routine for join()."""
 
930
        if not other.versions():
 
931
            return          # nothing to update, easy
 
932
 
 
933
        if version_ids:
 
934
            for version_id in version_ids:
 
935
                if not other.has_version(version_id) and not ignore_missing:
 
936
                    raise RevisionNotPresent(version_id, self._weave_name)
 
937
        else:
 
938
            version_ids = other.versions()
 
939
 
 
940
        # two loops so that we do not change ourselves before verifying it
 
941
        # will be ok
 
942
        # work through in index order to make sure we get all dependencies
 
943
        names_to_join = []
 
944
        processed = 0
 
945
        # get the selected versions only that are in other.versions.
 
946
        version_ids = set(other.versions()).intersection(set(version_ids))
 
947
        # pull in the referenced graph.
 
948
        version_ids = other.get_ancestry(version_ids)
 
949
        pending_graph = [(version, other.get_parents(version)) for
 
950
                         version in version_ids]
 
951
        for name in topo_sort(pending_graph):
 
952
            other_idx = other._name_map[name]
 
953
            # returns True if we have it, False if we need it.
 
954
            if not self._check_version_consistent(other, other_idx, name):
 
955
                names_to_join.append((other_idx, name))
 
956
            processed += 1
 
957
 
 
958
 
 
959
        if pb and not msg:
 
960
            msg = 'weave join'
 
961
 
 
962
        merged = 0
 
963
        time0 = time.time()
 
964
        for other_idx, name in names_to_join:
 
965
            # TODO: If all the parents of the other version are already
 
966
            # present then we can avoid some work by just taking the delta
 
967
            # and adjusting the offsets.
 
968
            new_parents = self._imported_parents(other, other_idx)
 
969
            sha1 = other._sha1s[other_idx]
 
970
 
 
971
            merged += 1
 
972
 
 
973
            if pb:
 
974
                pb.update(msg, merged, len(names_to_join))
 
975
           
 
976
            lines = other.get_lines(other_idx)
 
977
            self._add(name, lines, new_parents, sha1)
 
978
 
 
979
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
 
980
                merged, processed, self._weave_name, time.time()-time0))
 
981
 
851
982
    def _imported_parents(self, other, other_idx):
852
983
        """Return list of parents in self corresponding to indexes in other."""
853
984
        new_parents = []
855
986
            parent_name = other._names[parent_idx]
856
987
            if parent_name not in self._name_map:
857
988
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
989
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
990
                                 % (parent_name, other._name_map[other_idx], self))
860
991
            new_parents.append(self._name_map[parent_name])
861
992
        return new_parents
868
999
         * the same text
869
1000
         * the same direct parents (by name, not index, and disregarding
870
1001
           order)
871
 
 
 
1002
        
872
1003
        If present & correct return True;
873
 
        if not present in self return False;
 
1004
        if not present in self return False; 
874
1005
        if inconsistent raise error."""
875
1006
        this_idx = self._name_map.get(name, -1)
876
1007
        if this_idx != -1:
888
1019
        else:
889
1020
            return False
890
1021
 
 
1022
    @deprecated_method(zero_eight)
 
1023
    def reweave(self, other, pb=None, msg=None):
 
1024
        """reweave has been superceded by plain use of join."""
 
1025
        return self.join(other, pb, msg)
 
1026
 
891
1027
    def _reweave(self, other, pb, msg):
892
1028
        """Reweave self with other - internal helper for join().
893
1029
 
909
1045
    """A WeaveFile represents a Weave on disk and writes on change."""
910
1046
 
911
1047
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
1048
    
 
1049
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
914
1050
        """Create a WeaveFile.
915
 
 
 
1051
        
916
1052
        :param create: If not True, only open an existing knit.
917
1053
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
1054
        super(WeaveFile, self).__init__(name, access_mode)
920
1055
        self._transport = transport
921
1056
        self._filemode = filemode
922
1057
        try:
927
1062
            # new file, save it
928
1063
            self._save()
929
1064
 
930
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
931
 
        left_matching_blocks, nostore_sha, random_id, check_content):
 
1065
    def _add_lines(self, version_id, parents, lines, parent_texts):
932
1066
        """Add a version and save the weave."""
933
 
        self.check_not_reserved_id(version_id)
934
1067
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
935
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
936
 
            check_content)
 
1068
                                                   parent_texts)
937
1069
        self._save()
938
1070
        return result
939
1071
 
 
1072
    def _clone_text(self, new_version_id, old_version_id, parents):
 
1073
        """See VersionedFile.clone_text."""
 
1074
        super(WeaveFile, self)._clone_text(new_version_id, old_version_id, parents)
 
1075
        self._save
 
1076
 
940
1077
    def copy_to(self, name, transport):
941
1078
        """See VersionedFile.copy_to()."""
942
1079
        # as we are all in memory always, just serialise to the new place.
943
1080
        sio = StringIO()
944
1081
        write_weave_v5(self, sio)
945
1082
        sio.seek(0)
946
 
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1083
        transport.put(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
1084
 
 
1085
    def create_empty(self, name, transport, filemode=None):
 
1086
        return WeaveFile(name, transport, filemode, create=True)
947
1087
 
948
1088
    def _save(self):
949
1089
        """Save the weave."""
951
1091
        sio = StringIO()
952
1092
        write_weave_v5(self, sio)
953
1093
        sio.seek(0)
954
 
        bytes = sio.getvalue()
955
 
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
956
 
        try:
957
 
            self._transport.put_bytes(path, bytes, self._filemode)
958
 
        except errors.NoSuchFile:
959
 
            self._transport.mkdir(dirname(path))
960
 
            self._transport.put_bytes(path, bytes, self._filemode)
 
1094
        self._transport.put(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1095
                            sio,
 
1096
                            self._filemode)
961
1097
 
962
1098
    @staticmethod
963
1099
    def get_suffixes():
964
1100
        """See VersionedFile.get_suffixes()."""
965
1101
        return [WeaveFile.WEAVE_SUFFIX]
966
1102
 
967
 
    def insert_record_stream(self, stream):
968
 
        super(WeaveFile, self).insert_record_stream(stream)
 
1103
    def join(self, other, pb=None, msg=None, version_ids=None,
 
1104
             ignore_missing=False):
 
1105
        """Join other into self and save."""
 
1106
        super(WeaveFile, self).join(other, pb, msg, version_ids, ignore_missing)
969
1107
        self._save()
970
1108
 
971
1109
 
 
1110
@deprecated_function(zero_eight)
 
1111
def reweave(wa, wb, pb=None, msg=None):
 
1112
    """reweaving is deprecation, please just use weave.join()."""
 
1113
    _reweave(wa, wb, pb, msg)
 
1114
 
972
1115
def _reweave(wa, wb, pb=None, msg=None):
973
1116
    """Combine two weaves and return the result.
974
1117
 
975
 
    This works even if a revision R has different parents in
 
1118
    This works even if a revision R has different parents in 
976
1119
    wa and wb.  In the resulting weave all the parents are given.
977
1120
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
1121
    This is done by just building up a new weave, maintaining ordering 
979
1122
    of the versions in the two inputs.  More efficient approaches
980
 
    might be possible but it should only be necessary to do
981
 
    this operation rarely, when a new previously ghost version is
 
1123
    might be possible but it should only be necessary to do 
 
1124
    this operation rarely, when a new previously ghost version is 
982
1125
    inserted.
983
1126
 
984
1127
    :param pb: An optional progress bar, indicating how far done we are
992
1135
    # map from version name -> all parent names
993
1136
    combined_parents = _reweave_parent_graphs(wa, wb)
994
1137
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
1138
    order = topo_sort(combined_parents.iteritems())
996
1139
    mutter("order to reweave: %r", order)
997
1140
 
998
1141
    if pb and not msg:
1018
1161
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
1162
    return wr
1020
1163
 
1021
 
 
1022
1164
def _reweave_parent_graphs(wa, wb):
1023
1165
    """Return combined parent ancestry for two weaves.
1024
 
 
 
1166
    
1025
1167
    Returned as a list of (version_name, set(parent_names))"""
1026
1168
    combined = {}
1027
1169
    for weave in [wa, wb]:
1029
1171
            p = combined.setdefault(name, set())
1030
1172
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
1173
    return combined
 
1174
 
 
1175
 
 
1176
def weave_toc(w):
 
1177
    """Show the weave's table-of-contents"""
 
1178
    print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
 
1179
    for i in (6, 50, 10, 10):
 
1180
        print '-' * i,
 
1181
    print
 
1182
    for i in range(w.num_versions()):
 
1183
        sha1 = w._sha1s[i]
 
1184
        name = w._names[i]
 
1185
        parent_str = ' '.join(map(str, w._parents[i]))
 
1186
        print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
 
1187
 
 
1188
 
 
1189
 
 
1190
def weave_stats(weave_file, pb):
 
1191
    from bzrlib.weavefile import read_weave
 
1192
 
 
1193
    wf = file(weave_file, 'rb')
 
1194
    w = read_weave(wf, WeaveVersionedFile)
 
1195
    # FIXME: doesn't work on pipes
 
1196
    weave_size = wf.tell()
 
1197
 
 
1198
    total = 0
 
1199
    vers = len(w)
 
1200
    for i in range(vers):
 
1201
        pb.update('checking sizes', i, vers)
 
1202
        for origin, lineno, line in w._extract([i]):
 
1203
            total += len(line)
 
1204
 
 
1205
    pb.clear()
 
1206
 
 
1207
    print 'versions          %9d' % vers
 
1208
    print 'weave file        %9d bytes' % weave_size
 
1209
    print 'total contents    %9d bytes' % total
 
1210
    print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
 
1211
    if vers:
 
1212
        avg = total/vers
 
1213
        print 'average size      %9d bytes' % avg
 
1214
        print 'relative size     %9.2fx' % (float(weave_size) / float(avg))
 
1215
 
 
1216
 
 
1217
def usage():
 
1218
    print """bzr weave tool
 
1219
 
 
1220
Experimental tool for weave algorithm.
 
1221
 
 
1222
usage:
 
1223
    weave init WEAVEFILE
 
1224
        Create an empty weave file
 
1225
    weave get WEAVEFILE VERSION
 
1226
        Write out specified version.
 
1227
    weave check WEAVEFILE
 
1228
        Check consistency of all versions.
 
1229
    weave toc WEAVEFILE
 
1230
        Display table of contents.
 
1231
    weave add WEAVEFILE NAME [BASE...] < NEWTEXT
 
1232
        Add NEWTEXT, with specified parent versions.
 
1233
    weave annotate WEAVEFILE VERSION
 
1234
        Display origin of each line.
 
1235
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
 
1236
        Auto-merge two versions and display conflicts.
 
1237
    weave diff WEAVEFILE VERSION1 VERSION2 
 
1238
        Show differences between two versions.
 
1239
 
 
1240
example:
 
1241
 
 
1242
    % weave init foo.weave
 
1243
    % vi foo.txt
 
1244
    % weave add foo.weave ver0 < foo.txt
 
1245
    added version 0
 
1246
 
 
1247
    (create updated version)
 
1248
    % vi foo.txt
 
1249
    % weave get foo.weave 0 | diff -u - foo.txt
 
1250
    % weave add foo.weave ver1 0 < foo.txt
 
1251
    added version 1
 
1252
 
 
1253
    % weave get foo.weave 0 > foo.txt       (create forked version)
 
1254
    % vi foo.txt
 
1255
    % weave add foo.weave ver2 0 < foo.txt
 
1256
    added version 2
 
1257
 
 
1258
    % weave merge foo.weave 1 2 > foo.txt   (merge them)
 
1259
    % vi foo.txt                            (resolve conflicts)
 
1260
    % weave add foo.weave merged 1 2 < foo.txt     (commit merged version)     
 
1261
    
 
1262
"""
 
1263
    
 
1264
 
 
1265
 
 
1266
def main(argv):
 
1267
    import sys
 
1268
    import os
 
1269
    try:
 
1270
        import bzrlib
 
1271
    except ImportError:
 
1272
        # in case we're run directly from the subdirectory
 
1273
        sys.path.append('..')
 
1274
        import bzrlib
 
1275
    from bzrlib.weavefile import write_weave, read_weave
 
1276
    from bzrlib.progress import ProgressBar
 
1277
 
 
1278
    try:
 
1279
        import psyco
 
1280
        psyco.full()
 
1281
    except ImportError:
 
1282
        pass
 
1283
 
 
1284
    if len(argv) < 2:
 
1285
        usage()
 
1286
        return 0
 
1287
 
 
1288
    cmd = argv[1]
 
1289
 
 
1290
    def readit():
 
1291
        return read_weave(file(argv[2], 'rb'))
 
1292
    
 
1293
    if cmd == 'help':
 
1294
        usage()
 
1295
    elif cmd == 'add':
 
1296
        w = readit()
 
1297
        # at the moment, based on everything in the file
 
1298
        name = argv[3]
 
1299
        parents = map(int, argv[4:])
 
1300
        lines = sys.stdin.readlines()
 
1301
        ver = w.add(name, parents, lines)
 
1302
        write_weave(w, file(argv[2], 'wb'))
 
1303
        print 'added version %r %d' % (name, ver)
 
1304
    elif cmd == 'init':
 
1305
        fn = argv[2]
 
1306
        if os.path.exists(fn):
 
1307
            raise IOError("file exists")
 
1308
        w = Weave()
 
1309
        write_weave(w, file(fn, 'wb'))
 
1310
    elif cmd == 'get': # get one version
 
1311
        w = readit()
 
1312
        sys.stdout.writelines(w.get_iter(int(argv[3])))
 
1313
        
 
1314
    elif cmd == 'diff':
 
1315
        from difflib import unified_diff
 
1316
        w = readit()
 
1317
        fn = argv[2]
 
1318
        v1, v2 = map(int, argv[3:5])
 
1319
        lines1 = w.get(v1)
 
1320
        lines2 = w.get(v2)
 
1321
        diff_gen = unified_diff(lines1, lines2,
 
1322
                                '%s version %d' % (fn, v1),
 
1323
                                '%s version %d' % (fn, v2))
 
1324
        sys.stdout.writelines(diff_gen)
 
1325
            
 
1326
    elif cmd == 'annotate':
 
1327
        w = readit()
 
1328
        # newline is added to all lines regardless; too hard to get
 
1329
        # reasonable formatting otherwise
 
1330
        lasto = None
 
1331
        for origin, text in w.annotate(int(argv[3])):
 
1332
            text = text.rstrip('\r\n')
 
1333
            if origin == lasto:
 
1334
                print '      | %s' % (text)
 
1335
            else:
 
1336
                print '%5d | %s' % (origin, text)
 
1337
                lasto = origin
 
1338
                
 
1339
    elif cmd == 'toc':
 
1340
        weave_toc(readit())
 
1341
 
 
1342
    elif cmd == 'stats':
 
1343
        weave_stats(argv[2], ProgressBar())
 
1344
        
 
1345
    elif cmd == 'check':
 
1346
        w = readit()
 
1347
        pb = ProgressBar()
 
1348
        w.check(pb)
 
1349
        pb.clear()
 
1350
        print '%d versions ok' % w.num_versions()
 
1351
 
 
1352
    elif cmd == 'inclusions':
 
1353
        w = readit()
 
1354
        print ' '.join(map(str, w.inclusions([int(argv[3])])))
 
1355
 
 
1356
    elif cmd == 'parents':
 
1357
        w = readit()
 
1358
        print ' '.join(map(str, w._parents[int(argv[3])]))
 
1359
 
 
1360
    elif cmd == 'plan-merge':
 
1361
        w = readit()
 
1362
        for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
 
1363
            if line:
 
1364
                print '%14s | %s' % (state, line),
 
1365
 
 
1366
    elif cmd == 'merge':
 
1367
        w = readit()
 
1368
        p = w.plan_merge(int(argv[3]), int(argv[4]))
 
1369
        sys.stdout.writelines(w.weave_merge(p))
 
1370
    else:
 
1371
        raise ValueError('unknown command %r' % cmd)
 
1372
    
 
1373
 
 
1374
 
 
1375
def profile_main(argv):
 
1376
    import tempfile, hotshot, hotshot.stats
 
1377
 
 
1378
    prof_f = tempfile.NamedTemporaryFile()
 
1379
 
 
1380
    prof = hotshot.Profile(prof_f.name)
 
1381
 
 
1382
    ret = prof.runcall(main, argv)
 
1383
    prof.close()
 
1384
 
 
1385
    stats = hotshot.stats.load(prof_f.name)
 
1386
    #stats.strip_dirs()
 
1387
    stats.sort_stats('cumulative')
 
1388
    ## XXX: Might like to write to stderr or the trace file instead but
 
1389
    ## print_stats seems hardcoded to stdout
 
1390
    stats.print_stats(20)
 
1391
            
 
1392
    return ret
 
1393
 
 
1394
 
 
1395
def lsprofile_main(argv): 
 
1396
    from bzrlib.lsprof import profile
 
1397
    ret,stats = profile(main, argv)
 
1398
    stats.sort()
 
1399
    stats.pprint()
 
1400
    return ret
 
1401
 
 
1402
 
 
1403
if __name__ == '__main__':
 
1404
    import sys
 
1405
    if '--profile' in sys.argv:
 
1406
        args = sys.argv[:]
 
1407
        args.remove('--profile')
 
1408
        sys.exit(profile_main(args))
 
1409
    elif '--lsprof' in sys.argv:
 
1410
        args = sys.argv[:]
 
1411
        args.remove('--lsprof')
 
1412
        sys.exit(lsprofile_main(args))
 
1413
    else:
 
1414
        sys.exit(main(sys.argv))
 
1415
 
 
1416
 
 
1417
class InterWeave(InterVersionedFile):
 
1418
    """Optimised code paths for weave to weave operations."""
 
1419
    
 
1420
    _matching_file_factory = staticmethod(WeaveFile)
 
1421
    
 
1422
    @staticmethod
 
1423
    def is_compatible(source, target):
 
1424
        """Be compatible with weaves."""
 
1425
        try:
 
1426
            return (isinstance(source, Weave) and
 
1427
                    isinstance(target, Weave))
 
1428
        except AttributeError:
 
1429
            return False
 
1430
 
 
1431
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
1432
        """See InterVersionedFile.join."""
 
1433
        if self.target.versions() == []:
 
1434
            # optimised copy
 
1435
            self.target._copy_weave_content(self.source)
 
1436
            return
 
1437
        try:
 
1438
            self.target._join(self.source, pb, msg, version_ids, ignore_missing)
 
1439
        except errors.WeaveParentMismatch:
 
1440
            self.target._reweave(self.source, pb, msg)
 
1441
 
 
1442
 
 
1443
InterVersionedFile.register_optimiser(InterWeave)