← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Olaf Conradi
  • Date: 2006-03-29 21:07:20 UTC
  • mto: (1661.1.1 bzr.mbp.remember)
  • mto: This revision was merged to the branch mainline in revision 1663.
  • Revision ID: olaf@conradi.org-20060329210720-8e43fffa2a24d1a4
Re-added AmbiguousBase with a deprecated warning.

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