/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-11-08 03:00:11 UTC
  • mfrom: (4789.2.1 bzrdirvfswarning)
  • Revision ID: pqm@pqm.ubuntu.com-20091108030011-4ifz210jwrd3ewkv
(robertc) Extend -Dhpssvfs debugging support to BzrDir._ensure_real.
        (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
#! /usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2009 Canonical Ltd
 
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
# Author: Martin Pool <mbp@canonical.com>
20
18
 
27
25
# property.
28
26
 
29
27
# TODO: Nothing here so far assumes the lines are really \n newlines,
30
 
# rather than being split up in some other way.  We could accomodate
 
28
# rather than being split up in some other way.  We could accommodate
31
29
# binaries, perhaps by naively splitting on \n or perhaps using
32
30
# something like a rolling checksum.
33
31
 
61
59
# where the basis and destination are unchanged.
62
60
 
63
61
# FIXME: Sometimes we will be given a parents list for a revision
64
 
# that includes some redundant parents (i.e. already a parent of 
65
 
# something in the list.)  We should eliminate them.  This can 
 
62
# that includes some redundant parents (i.e. already a parent of
 
63
# something in the list.)  We should eliminate them.  This can
66
64
# be done fairly efficiently because the sequence numbers constrain
67
65
# the possible relationships.
68
66
 
70
68
 
71
69
from copy import copy
72
70
from cStringIO import StringIO
73
 
from difflib import SequenceMatcher
74
71
import os
75
 
import sha
76
72
import time
 
73
import warnings
77
74
 
78
 
from bzrlib.trace import mutter
 
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
    )
79
84
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
80
85
        RevisionAlreadyPresent,
81
86
        RevisionNotPresent,
 
87
        UnavailableRepresentation,
82
88
        WeaveRevisionAlreadyPresent,
83
89
        WeaveRevisionNotPresent,
84
90
        )
85
 
import bzrlib.errors as errors
86
 
from bzrlib.osutils import sha_strings
 
91
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
 
92
import bzrlib.patiencediff
 
93
from bzrlib.revision import NULL_REVISION
87
94
from bzrlib.symbol_versioning import *
88
 
from bzrlib.tsort import topo_sort
89
 
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
 
95
from bzrlib.trace import mutter
 
96
from bzrlib.versionedfile import (
 
97
    AbsentContentFactory,
 
98
    adapter_registry,
 
99
    ContentFactory,
 
100
    sort_groupcompress,
 
101
    VersionedFile,
 
102
    )
90
103
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
91
104
 
92
105
 
 
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
 
93
131
class Weave(VersionedFile):
94
132
    """weave - versioned text file storage.
95
 
    
 
133
 
96
134
    A Weave manages versions of line-based text files, keeping track
97
135
    of the originating version for each line.
98
136
 
144
182
 
145
183
    * It doesn't seem very useful to have an active insertion
146
184
      inside an inactive insertion, but it might happen.
147
 
      
 
185
 
148
186
    * Therefore, all instructions are always"considered"; that
149
187
      is passed onto and off the stack.  An outer inactive block
150
188
      doesn't disable an inner block.
180
218
    """
181
219
 
182
220
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
183
 
                 '_weave_name']
184
 
    
185
 
    def __init__(self, weave_name=None, access_mode='w'):
186
 
        super(Weave, self).__init__(access_mode)
 
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__()
187
232
        self._weave = []
188
233
        self._parents = []
189
234
        self._sha1s = []
190
235
        self._names = []
191
236
        self._name_map = {}
192
237
        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
193
248
 
194
249
    def __repr__(self):
195
250
        return "Weave(%r)" % self._weave_name
196
251
 
 
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
 
197
259
    def copy(self):
198
260
        """Return a deep copy of self.
199
 
        
 
261
 
200
262
        The copy can be modified without affecting the original weave."""
201
263
        other = Weave()
202
264
        other._weave = self._weave[:]
212
274
            return False
213
275
        return self._parents == other._parents \
214
276
               and self._weave == other._weave \
215
 
               and self._sha1s == other._sha1s 
216
 
    
 
277
               and self._sha1s == other._sha1s
 
278
 
217
279
    def __ne__(self, other):
218
280
        return not self.__eq__(other)
219
281
 
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
 
 
225
282
    def _idx_to_name(self, version):
226
283
        return self._names[version]
227
284
 
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
 
 
237
285
    def _lookup(self, name):
238
286
        """Convert symbolic version name to index."""
 
287
        if not self._allow_reserved:
 
288
            self.check_not_reserved_id(name)
239
289
        try:
240
290
            return self._name_map[name]
241
291
        except KeyError:
242
292
            raise RevisionNotPresent(name, self._weave_name)
243
293
 
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
 
 
254
294
    def versions(self):
255
295
        """See VersionedFile.versions."""
256
296
        return self._names[:]
257
297
 
258
298
    def has_version(self, version_id):
259
299
        """See VersionedFile.has_version."""
260
 
        return self._name_map.has_key(version_id)
 
300
        return (version_id in self._name_map)
261
301
 
262
302
    __contains__ = has_version
263
303
 
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)
 
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 = {}
271
337
        for version_id in version_ids:
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
 
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:
335
346
                    continue
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
 
                                  )
 
347
            result[version_id] = parents
418
348
        return result
419
349
 
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)])
 
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
423
384
 
424
385
    def _check_repeated_add(self, name, parents, text, sha1):
425
386
        """Check that a duplicated add is OK.
432
393
            raise RevisionAlreadyPresent(name, self._weave_name)
433
394
        return idx
434
395
 
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):
 
396
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
397
       left_matching_blocks, nostore_sha, random_id, check_content):
441
398
        """See VersionedFile.add_lines."""
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):
 
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):
450
404
        """Add a single text on top of the weave.
451
 
  
 
405
 
452
406
        Returns the index number of the newly added version.
453
407
 
454
408
        version_id
455
409
            Symbolic name for this version.
456
410
            (Typically the revision-id of the revision that added it.)
 
411
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
457
412
 
458
413
        parents
459
414
            List or set of direct parent version numbers.
460
 
            
 
415
 
461
416
        lines
462
417
            Sequence of lines to be added in the new version.
 
418
 
 
419
        :param nostore_sha: See VersionedFile.add_lines.
463
420
        """
464
 
 
465
 
        assert isinstance(version_id, basestring)
 
421
        self._check_lines_not_unicode(lines)
 
422
        self._check_lines_are_lines(lines)
466
423
        if not sha1:
467
424
            sha1 = sha_strings(lines)
 
425
        if sha1 == nostore_sha:
 
426
            raise errors.ExistingContent
 
427
        if version_id is None:
 
428
            version_id = "sha1:" + sha1
468
429
        if version_id in self._name_map:
469
430
            return self._check_repeated_add(version_id, parents, lines, sha1)
470
431
 
481
442
        self._names.append(version_id)
482
443
        self._name_map[version_id] = new_version
483
444
 
484
 
            
 
445
 
485
446
        if not parents:
486
447
            # special case; adding with no parents revision; can do
487
448
            # this more quickly by just appending unconditionally.
498
459
            if sha1 == self._sha1s[pv]:
499
460
                # special case: same as the single parent
500
461
                return new_version
501
 
            
 
462
 
502
463
 
503
464
        ancestors = self._inclusions(parents)
504
465
 
514
475
        # another small special case: a merge, producing the same text
515
476
        # as auto-merge
516
477
        if lines == basis_lines:
517
 
            return new_version            
 
478
            return new_version
518
479
 
519
 
        # add a sentinal, because we can also match against the final line
 
480
        # add a sentinel, because we can also match against the final line
520
481
        basis_lineno.append(len(self._weave))
521
482
 
522
483
        # XXX: which line of the weave should we really consider
526
487
        #print 'basis_lines:', basis_lines
527
488
        #print 'new_lines:  ', lines
528
489
 
529
 
        s = SequenceMatcher(None, basis_lines, lines)
 
490
        s = self._matcher(None, basis_lines, lines)
530
491
 
531
492
        # offset gives the number of lines that have been inserted
532
493
        # into the weave up to the current point; if the original edit instruction
539
500
            #print 'raw match', tag, i1, i2, j1, j2
540
501
            if tag == 'equal':
541
502
                continue
542
 
 
543
503
            i1 = basis_lineno[i1]
544
504
            i2 = basis_lineno[i2]
545
 
 
546
 
            assert 0 <= j1 <= j2 <= len(lines)
547
 
 
548
 
            #print tag, i1, i2, j1, j2
549
 
 
550
505
            # the deletion and insertion are handled separately.
551
506
            # first delete the region.
552
507
            if i1 != i2:
559
514
                # i2; we want to insert after this region to make sure
560
515
                # we don't destroy ourselves
561
516
                i = i2 + offset
562
 
                self._weave[i:i] = ([('{', new_version)] 
563
 
                                    + lines[j1:j2] 
 
517
                self._weave[i:i] = ([('{', new_version)]
 
518
                                    + lines[j1:j2]
564
519
                                    + [('}', None)])
565
520
                offset += 2 + (j2 - j1)
566
521
        return new_version
567
522
 
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
 
 
573
523
    def _inclusions(self, versions):
574
524
        """Return set of all ancestors of given version(s)."""
575
525
        if not len(versions):
583
533
        ## except IndexError:
584
534
        ##     raise ValueError("version %d not present in weave" % v)
585
535
 
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):
 
536
    def get_ancestry(self, version_ids, topo_sorted=True):
597
537
        """See VersionedFile.get_ancestry."""
598
538
        if isinstance(version_ids, basestring):
599
539
            version_ids = [version_ids]
608
548
            if not isinstance(l, basestring):
609
549
                raise ValueError("text line should be a string or unicode, not %s"
610
550
                                 % type(l))
611
 
        
 
551
 
612
552
 
613
553
 
614
554
    def _check_versions(self, indexes):
622
562
    def _compatible_parents(self, my_parents, other_parents):
623
563
        """During join check that other_parents are joinable with my_parents.
624
564
 
625
 
        Joinable is defined as 'is a subset of' - supersets may require 
 
565
        Joinable is defined as 'is a subset of' - supersets may require
626
566
        regeneration of diffs, but subsets do not.
627
567
        """
628
568
        return len(other_parents.difference(my_parents)) == 0
629
569
 
630
570
    def annotate(self, 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.
 
571
        """Return a list of (version-id, line) tuples for version_id.
646
572
 
647
573
        The index indicates when the line originated in the weave."""
648
574
        incls = [self._lookup(version_id)]
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):
 
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):
658
580
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
659
581
        if version_ids is None:
660
582
            version_ids = self.versions()
661
583
        version_ids = set(version_ids)
662
584
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
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
 
585
            if inserted not in version_ids: continue
667
586
            if line[-1] != '\n':
668
 
                yield line + '\n'
 
587
                yield line + '\n', inserted
669
588
            else:
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)
 
589
                yield line, inserted
676
590
 
677
591
    def _walk_internal(self, version_ids=None):
678
592
        """Helper method for weave actions."""
679
 
        
 
593
 
680
594
        istack = []
681
595
        dset = set()
682
596
 
691
605
                elif c == '}':
692
606
                    istack.pop()
693
607
                elif c == '[':
694
 
                    assert self._names[v] not in dset
695
608
                    dset.add(self._names[v])
696
609
                elif c == ']':
697
610
                    dset.remove(self._names[v])
698
611
                else:
699
612
                    raise WeaveFormatError('unexpected instruction %r' % v)
700
613
            else:
701
 
                assert l.__class__ in (str, unicode)
702
 
                assert istack
703
614
                yield lineno, istack[-1], frozenset(dset), l
704
615
            lineno += 1
705
616
 
710
621
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
711
622
                                   % dset)
712
623
 
 
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
 
713
668
    def _extract(self, versions):
714
669
        """Yield annotation of lines in included set.
715
670
 
722
677
        for i in versions:
723
678
            if not isinstance(i, int):
724
679
                raise ValueError(i)
725
 
            
 
680
 
726
681
        included = self._inclusions(versions)
727
682
 
728
683
        istack = []
737
692
 
738
693
        WFE = WeaveFormatError
739
694
 
740
 
        # wow. 
 
695
        # wow.
741
696
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
742
697
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
743
698
        # 1.6 seconds in 'isinstance'.
749
704
        # we're still spending ~1/4 of the method in isinstance though.
750
705
        # so lets hard code the acceptable string classes we expect:
751
706
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
752
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
 
707
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
753
708
        #                                          objects>
754
709
        # yay, down to ~1/4 the initial extract time, and our inline time
755
710
        # has shrunk again, with isinstance no longer dominating.
756
711
        # tweaking the stack inclusion test to use a set gives:
757
712
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
758
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
 
713
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
759
714
        #                                          objects>
760
715
        # - a 5% win, or possibly just noise. However with large istacks that
761
716
        # 'in' test could dominate, so I'm leaving this change in place -
762
717
        # when its fast enough to consider profiling big datasets we can review.
763
718
 
764
 
              
765
 
             
 
719
 
 
720
 
766
721
 
767
722
        for l in self._weave:
768
723
            if l.__class__ == tuple:
769
724
                c, v = l
770
725
                isactive = None
771
726
                if c == '{':
772
 
                    assert v not in iset
773
727
                    istack.append(v)
774
728
                    iset.add(v)
775
729
                elif c == '}':
776
730
                    iset.remove(istack.pop())
777
731
                elif c == '[':
778
732
                    if v in included:
779
 
                        assert v not in dset
780
733
                        dset.add(v)
781
 
                else:
782
 
                    assert c == ']'
 
734
                elif c == ']':
783
735
                    if v in included:
784
 
                        assert v in dset
785
736
                        dset.remove(v)
 
737
                else:
 
738
                    raise AssertionError()
786
739
            else:
787
 
                assert l.__class__ in (str, unicode)
788
740
                if isactive is None:
789
741
                    isactive = (not dset) and istack and (istack[-1] in included)
790
742
                if isactive:
798
750
                                   % dset)
799
751
        return result
800
752
 
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
 
 
814
753
    def _maybe_lookup(self, name_or_index):
815
754
        """Convert possible symbolic name to index, or pass through indexes.
816
 
        
 
755
 
817
756
        NOT FOR PUBLIC USE.
818
757
        """
819
758
        if isinstance(name_or_index, (int, long)):
821
760
        else:
822
761
            return self._lookup(name_or_index)
823
762
 
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
 
 
829
763
    def get_lines(self, version_id):
830
764
        """See VersionedFile.get_lines()."""
831
765
        int_index = self._maybe_lookup(version_id)
834
768
        measured_sha1 = sha_strings(result)
835
769
        if measured_sha1 != expected_sha1:
836
770
            raise errors.WeaveInvalidChecksum(
837
 
                    'file %s, revision %s, expected: %s, measured %s' 
 
771
                    'file %s, revision %s, expected: %s, measured %s'
838
772
                    % (self._weave_name, version_id,
839
773
                       expected_sha1, measured_sha1))
840
774
        return result
841
775
 
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()
 
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
856
782
 
857
783
    def num_versions(self):
858
784
        """How many versions are in this weave?"""
859
785
        l = len(self._parents)
860
 
        assert l == len(self._sha1s)
861
786
        return l
862
787
 
863
788
    __len__ = num_versions
883
808
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
884
809
            # The problem is that set membership is much more expensive
885
810
            name = self._idx_to_name(i)
886
 
            sha1s[name] = sha.new()
 
811
            sha1s[name] = sha()
887
812
            texts[name] = []
888
813
            new_inc = set([name])
889
814
            for p in self._parents[i]:
890
815
                new_inc.update(inclusions[self._idx_to_name(p)])
891
816
 
892
 
            assert set(new_inc) == set(self.get_ancestry(name)), \
893
 
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
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))))
894
821
            inclusions[name] = new_inc
895
822
 
896
823
        nlines = len(self._weave)
926
853
        # no lines outside of insertion blocks, that deletions are
927
854
        # properly paired, etc.
928
855
 
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
 
 
983
856
    def _imported_parents(self, other, other_idx):
984
857
        """Return list of parents in self corresponding to indexes in other."""
985
858
        new_parents = []
987
860
            parent_name = other._names[parent_idx]
988
861
            if parent_name not in self._name_map:
989
862
                # should not be possible
990
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
863
                raise WeaveError("missing parent {%s} of {%s} in %r"
991
864
                                 % (parent_name, other._name_map[other_idx], self))
992
865
            new_parents.append(self._name_map[parent_name])
993
866
        return new_parents
1000
873
         * the same text
1001
874
         * the same direct parents (by name, not index, and disregarding
1002
875
           order)
1003
 
        
 
876
 
1004
877
        If present & correct return True;
1005
 
        if not present in self return False; 
 
878
        if not present in self return False;
1006
879
        if inconsistent raise error."""
1007
880
        this_idx = self._name_map.get(name, -1)
1008
881
        if this_idx != -1:
1020
893
        else:
1021
894
            return False
1022
895
 
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
 
 
1028
896
    def _reweave(self, other, pb, msg):
1029
897
        """Reweave self with other - internal helper for join().
1030
898
 
1046
914
    """A WeaveFile represents a Weave on disk and writes on change."""
1047
915
 
1048
916
    WEAVE_SUFFIX = '.weave'
1049
 
    
1050
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
 
917
 
 
918
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
1051
919
        """Create a WeaveFile.
1052
 
        
 
920
 
1053
921
        :param create: If not True, only open an existing knit.
1054
922
        """
1055
 
        super(WeaveFile, self).__init__(name, access_mode)
 
923
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
 
924
            allow_reserved=False)
1056
925
        self._transport = transport
1057
926
        self._filemode = filemode
1058
927
        try:
1063
932
            # new file, save it
1064
933
            self._save()
1065
934
 
1066
 
    def _add_lines(self, version_id, parents, lines, parent_texts):
 
935
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
936
        left_matching_blocks, nostore_sha, random_id, check_content):
1067
937
        """Add a version and save the weave."""
 
938
        self.check_not_reserved_id(version_id)
1068
939
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
1069
 
                                                   parent_texts)
 
940
            parent_texts, left_matching_blocks, nostore_sha, random_id,
 
941
            check_content)
1070
942
        self._save()
1071
943
        return result
1072
944
 
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
 
 
1078
945
    def copy_to(self, name, transport):
1079
946
        """See VersionedFile.copy_to()."""
1080
947
        # as we are all in memory always, just serialise to the new place.
1081
948
        sio = StringIO()
1082
949
        write_weave_v5(self, sio)
1083
950
        sio.seek(0)
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)
 
951
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
1088
952
 
1089
953
    def _save(self):
1090
954
        """Save the weave."""
1092
956
        sio = StringIO()
1093
957
        write_weave_v5(self, sio)
1094
958
        sio.seek(0)
1095
 
        self._transport.put(self._weave_name + WeaveFile.WEAVE_SUFFIX,
1096
 
                            sio,
1097
 
                            self._filemode)
 
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)
1098
966
 
1099
967
    @staticmethod
1100
968
    def get_suffixes():
1101
969
        """See VersionedFile.get_suffixes()."""
1102
970
        return [WeaveFile.WEAVE_SUFFIX]
1103
971
 
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)
 
972
    def insert_record_stream(self, stream):
 
973
        super(WeaveFile, self).insert_record_stream(stream)
1108
974
        self._save()
1109
975
 
1110
976
 
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
 
 
1116
977
def _reweave(wa, wb, pb=None, msg=None):
1117
978
    """Combine two weaves and return the result.
1118
979
 
1119
 
    This works even if a revision R has different parents in 
 
980
    This works even if a revision R has different parents in
1120
981
    wa and wb.  In the resulting weave all the parents are given.
1121
982
 
1122
 
    This is done by just building up a new weave, maintaining ordering 
 
983
    This is done by just building up a new weave, maintaining ordering
1123
984
    of the versions in the two inputs.  More efficient approaches
1124
 
    might be possible but it should only be necessary to do 
1125
 
    this operation rarely, when a new previously ghost version is 
 
985
    might be possible but it should only be necessary to do
 
986
    this operation rarely, when a new previously ghost version is
1126
987
    inserted.
1127
988
 
1128
989
    :param pb: An optional progress bar, indicating how far done we are
1136
997
    # map from version name -> all parent names
1137
998
    combined_parents = _reweave_parent_graphs(wa, wb)
1138
999
    mutter("combined parents: %r", combined_parents)
1139
 
    order = topo_sort(combined_parents.iteritems())
 
1000
    order = tsort.topo_sort(combined_parents.iteritems())
1140
1001
    mutter("order to reweave: %r", order)
1141
1002
 
1142
1003
    if pb and not msg:
1162
1023
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1163
1024
    return wr
1164
1025
 
 
1026
 
1165
1027
def _reweave_parent_graphs(wa, wb):
1166
1028
    """Return combined parent ancestry for two weaves.
1167
 
    
 
1029
 
1168
1030
    Returned as a list of (version_name, set(parent_names))"""
1169
1031
    combined = {}
1170
1032
    for weave in [wa, wb]:
1172
1034
            p = combined.setdefault(name, set())
1173
1035
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1174
1036
    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)