← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-03-31 00:43:21 UTC
  • mfrom: (1551.2.51 win32fixes)
  • Revision ID: pqm@pqm.ubuntu.com-20060331004321-2171d32febcbfe4d
Various fixes for win32

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
 
76
import time
72
77
 
73
 
from bzrlib.lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from bzrlib import tsort
76
 
""")
77
 
from bzrlib import (
78
 
    errors,
79
 
    osutils,
80
 
    )
 
78
from bzrlib.trace import mutter
81
79
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
80
        RevisionAlreadyPresent,
83
81
        RevisionNotPresent,
84
 
        UnavailableRepresentation,
 
82
        WeaveRevisionAlreadyPresent,
 
83
        WeaveRevisionNotPresent,
85
84
        )
86
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
87
 
import bzrlib.patiencediff
88
 
from bzrlib.revision import NULL_REVISION
 
85
import bzrlib.errors as errors
 
86
from bzrlib.osutils import sha_strings
89
87
from bzrlib.symbol_versioning import *
90
 
from bzrlib.trace import mutter
91
 
from bzrlib.versionedfile import (
92
 
    AbsentContentFactory,
93
 
    adapter_registry,
94
 
    ContentFactory,
95
 
    sort_groupcompress,
96
 
    VersionedFile,
97
 
    )
 
88
from bzrlib.tsort import topo_sort
 
89
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
98
90
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
91
 
100
92
 
101
 
class WeaveContentFactory(ContentFactory):
102
 
    """Content factory for streaming from weaves.
103
 
 
104
 
    :seealso ContentFactory:
105
 
    """
106
 
 
107
 
    def __init__(self, version, weave):
108
 
        """Create a WeaveContentFactory for version from weave."""
109
 
        ContentFactory.__init__(self)
110
 
        self.sha1 = weave.get_sha1s([version])[version]
111
 
        self.key = (version,)
112
 
        parents = weave.get_parent_map([version])[version]
113
 
        self.parents = tuple((parent,) for parent in parents)
114
 
        self.storage_kind = 'fulltext'
115
 
        self._weave = weave
116
 
 
117
 
    def get_bytes_as(self, storage_kind):
118
 
        if storage_kind == 'fulltext':
119
 
            return self._weave.get_text(self.key[-1])
120
 
        elif storage_kind == 'chunked':
121
 
            return self._weave.get_lines(self.key[-1])
122
 
        else:
123
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
124
 
 
125
 
 
126
93
class Weave(VersionedFile):
127
94
    """weave - versioned text file storage.
128
 
 
 
95
    
129
96
    A Weave manages versions of line-based text files, keeping track
130
97
    of the originating version for each line.
131
98
 
177
144
 
178
145
    * It doesn't seem very useful to have an active insertion
179
146
      inside an inactive insertion, but it might happen.
180
 
 
 
147
      
181
148
    * Therefore, all instructions are always"considered"; that
182
149
      is passed onto and off the stack.  An outer inactive block
183
150
      doesn't disable an inner block.
213
180
    """
214
181
 
215
182
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
216
 
                 '_weave_name', '_matcher', '_allow_reserved']
217
 
 
218
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
219
 
                 get_scope=None, allow_reserved=False):
220
 
        """Create a weave.
221
 
 
222
 
        :param get_scope: A callable that returns an opaque object to be used
223
 
            for detecting when this weave goes out of scope (should stop
224
 
            answering requests or allowing mutation).
225
 
        """
226
 
        super(Weave, self).__init__()
 
183
                 '_weave_name']
 
184
    
 
185
    def __init__(self, weave_name=None, access_mode='w'):
 
186
        super(Weave, self).__init__(access_mode)
227
187
        self._weave = []
228
188
        self._parents = []
229
189
        self._sha1s = []
230
190
        self._names = []
231
191
        self._name_map = {}
232
192
        self._weave_name = weave_name
233
 
        if matcher is None:
234
 
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
 
        else:
236
 
            self._matcher = matcher
237
 
        if get_scope is None:
238
 
            get_scope = lambda:None
239
 
        self._get_scope = get_scope
240
 
        self._scope = get_scope()
241
 
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
193
 
244
194
    def __repr__(self):
245
195
        return "Weave(%r)" % self._weave_name
246
196
 
247
 
    def _check_write_ok(self):
248
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
249
 
        if self._get_scope() != self._scope:
250
 
            raise errors.OutSideTransaction()
251
 
        if self._access_mode != 'w':
252
 
            raise errors.ReadOnlyObjectDirtiedError(self)
253
 
 
254
197
    def copy(self):
255
198
        """Return a deep copy of self.
256
 
 
 
199
        
257
200
        The copy can be modified without affecting the original weave."""
258
201
        other = Weave()
259
202
        other._weave = self._weave[:]
269
212
            return False
270
213
        return self._parents == other._parents \
271
214
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
273
 
 
 
215
               and self._sha1s == other._sha1s 
 
216
    
274
217
    def __ne__(self, other):
275
218
        return not self.__eq__(other)
276
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
 
277
225
    def _idx_to_name(self, version):
278
226
        return self._names[version]
279
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
 
280
237
    def _lookup(self, name):
281
238
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
284
239
        try:
285
240
            return self._name_map[name]
286
241
        except KeyError:
287
242
            raise RevisionNotPresent(name, self._weave_name)
288
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
 
289
254
    def versions(self):
290
255
        """See VersionedFile.versions."""
291
256
        return self._names[:]
292
257
 
293
258
    def has_version(self, version_id):
294
259
        """See VersionedFile.has_version."""
295
 
        return (version_id in self._name_map)
 
260
        return self._name_map.has_key(version_id)
296
261
 
297
262
    __contains__ = has_version
298
263
 
299
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
300
 
        """Get a stream of records for versions.
301
 
 
302
 
        :param versions: The versions to include. Each version is a tuple
303
 
            (version,).
304
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
305
 
            sorted stream has compression parents strictly before their
306
 
            children.
307
 
        :param include_delta_closure: If True then the closure across any
308
 
            compression parents will be included (in the opaque data).
309
 
        :return: An iterator of ContentFactory objects, each of which is only
310
 
            valid until the iterator is advanced.
311
 
        """
312
 
        versions = [version[-1] for version in versions]
313
 
        if ordering == 'topological':
314
 
            parents = self.get_parent_map(versions)
315
 
            new_versions = tsort.topo_sort(parents)
316
 
            new_versions.extend(set(versions).difference(set(parents)))
317
 
            versions = new_versions
318
 
        elif ordering == 'groupcompress':
319
 
            parents = self.get_parent_map(versions)
320
 
            new_versions = sort_groupcompress(parents)
321
 
            new_versions.extend(set(versions).difference(set(parents)))
322
 
            versions = new_versions
323
 
        for version in versions:
324
 
            if version in self:
325
 
                yield WeaveContentFactory(version, self)
326
 
            else:
327
 
                yield AbsentContentFactory((version,))
328
 
 
329
 
    def get_parent_map(self, version_ids):
330
 
        """See VersionedFile.get_parent_map."""
331
 
        result = {}
 
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)
332
271
        for version_id in version_ids:
333
 
            if version_id == NULL_REVISION:
334
 
                parents = ()
335
 
            else:
336
 
                try:
337
 
                    parents = tuple(
338
 
                        map(self._idx_to_name,
339
 
                            self._parents[self._lookup(version_id)]))
340
 
                except RevisionNotPresent:
 
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
341
335
                    continue
342
 
            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
                                  )
343
418
        return result
344
419
 
345
 
    def get_parents_with_ghosts(self, version_id):
346
 
        raise NotImplementedError(self.get_parents_with_ghosts)
347
 
 
348
 
    def insert_record_stream(self, stream):
349
 
        """Insert a record stream into this versioned file.
350
 
 
351
 
        :param stream: A stream of records to insert.
352
 
        :return: None
353
 
        :seealso VersionedFile.get_record_stream:
354
 
        """
355
 
        adapters = {}
356
 
        for record in stream:
357
 
            # Raise an error when a record is missing.
358
 
            if record.storage_kind == 'absent':
359
 
                raise RevisionNotPresent([record.key[0]], self)
360
 
            # adapt to non-tuple interface
361
 
            parents = [parent[0] for parent in record.parents]
362
 
            if (record.storage_kind == 'fulltext'
363
 
                or record.storage_kind == 'chunked'):
364
 
                self.add_lines(record.key[0], parents,
365
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
366
 
            else:
367
 
                adapter_key = record.storage_kind, 'fulltext'
368
 
                try:
369
 
                    adapter = adapters[adapter_key]
370
 
                except KeyError:
371
 
                    adapter_factory = adapter_registry.get(adapter_key)
372
 
                    adapter = adapter_factory(self)
373
 
                    adapters[adapter_key] = adapter
374
 
                lines = split_lines(adapter.get_bytes(record))
375
 
                try:
376
 
                    self.add_lines(record.key[0], parents, lines)
377
 
                except RevisionAlreadyPresent:
378
 
                    pass
 
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)])
379
423
 
380
424
    def _check_repeated_add(self, name, parents, text, sha1):
381
425
        """Check that a duplicated add is OK.
388
432
            raise RevisionAlreadyPresent(name, self._weave_name)
389
433
        return idx
390
434
 
391
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
392
 
       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):
393
441
        """See VersionedFile.add_lines."""
394
 
        idx = self._add(version_id, lines, map(self._lookup, parents),
395
 
            nostore_sha=nostore_sha)
396
 
        return sha_strings(lines), sum(map(len, lines)), idx
397
 
 
398
 
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
 
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
450
        """Add a single text on top of the weave.
400
 
 
 
451
  
401
452
        Returns the index number of the newly added version.
402
453
 
403
454
        version_id
404
455
            Symbolic name for this version.
405
456
            (Typically the revision-id of the revision that added it.)
406
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
407
457
 
408
458
        parents
409
459
            List or set of direct parent version numbers.
410
 
 
 
460
            
411
461
        lines
412
462
            Sequence of lines to be added in the new version.
 
463
        """
413
464
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
415
 
        """
416
 
        self._check_lines_not_unicode(lines)
417
 
        self._check_lines_are_lines(lines)
 
465
        assert isinstance(version_id, basestring)
418
466
        if not sha1:
419
467
            sha1 = sha_strings(lines)
420
 
        if sha1 == nostore_sha:
421
 
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
468
        if version_id in self._name_map:
425
469
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
470
 
437
481
        self._names.append(version_id)
438
482
        self._name_map[version_id] = new_version
439
483
 
440
 
 
 
484
            
441
485
        if not parents:
442
486
            # special case; adding with no parents revision; can do
443
487
            # this more quickly by just appending unconditionally.
454
498
            if sha1 == self._sha1s[pv]:
455
499
                # special case: same as the single parent
456
500
                return new_version
457
 
 
 
501
            
458
502
 
459
503
        ancestors = self._inclusions(parents)
460
504
 
470
514
        # another small special case: a merge, producing the same text
471
515
        # as auto-merge
472
516
        if lines == basis_lines:
473
 
            return new_version
 
517
            return new_version            
474
518
 
475
 
        # 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
476
520
        basis_lineno.append(len(self._weave))
477
521
 
478
522
        # XXX: which line of the weave should we really consider
482
526
        #print 'basis_lines:', basis_lines
483
527
        #print 'new_lines:  ', lines
484
528
 
485
 
        s = self._matcher(None, basis_lines, lines)
 
529
        s = SequenceMatcher(None, basis_lines, lines)
486
530
 
487
531
        # offset gives the number of lines that have been inserted
488
532
        # into the weave up to the current point; if the original edit instruction
495
539
            #print 'raw match', tag, i1, i2, j1, j2
496
540
            if tag == 'equal':
497
541
                continue
 
542
 
498
543
            i1 = basis_lineno[i1]
499
544
            i2 = basis_lineno[i2]
 
545
 
 
546
            assert 0 <= j1 <= j2 <= len(lines)
 
547
 
 
548
            #print tag, i1, i2, j1, j2
 
549
 
500
550
            # the deletion and insertion are handled separately.
501
551
            # first delete the region.
502
552
            if i1 != i2:
509
559
                # i2; we want to insert after this region to make sure
510
560
                # we don't destroy ourselves
511
561
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
562
                self._weave[i:i] = ([('{', new_version)] 
 
563
                                    + lines[j1:j2] 
514
564
                                    + [('}', None)])
515
565
                offset += 2 + (j2 - j1)
516
566
        return new_version
517
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
 
518
573
    def _inclusions(self, versions):
519
574
        """Return set of all ancestors of given version(s)."""
520
575
        if not len(versions):
528
583
        ## except IndexError:
529
584
        ##     raise ValueError("version %d not present in weave" % v)
530
585
 
531
 
    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):
532
597
        """See VersionedFile.get_ancestry."""
533
598
        if isinstance(version_ids, basestring):
534
599
            version_ids = [version_ids]
543
608
            if not isinstance(l, basestring):
544
609
                raise ValueError("text line should be a string or unicode, not %s"
545
610
                                 % type(l))
546
 
 
 
611
        
547
612
 
548
613
 
549
614
    def _check_versions(self, indexes):
557
622
    def _compatible_parents(self, my_parents, other_parents):
558
623
        """During join check that other_parents are joinable with my_parents.
559
624
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
625
        Joinable is defined as 'is a subset of' - supersets may require 
561
626
        regeneration of diffs, but subsets do not.
562
627
        """
563
628
        return len(other_parents.difference(my_parents)) == 0
564
629
 
565
630
    def annotate(self, version_id):
566
 
        """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.
567
646
 
568
647
        The index indicates when the line originated in the weave."""
569
648
        incls = [self._lookup(version_id)]
570
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
 
            self._extract(incls)]
572
 
 
573
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
574
 
                                                pb=None):
 
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
658
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
576
659
        if version_ids is None:
577
660
            version_ids = self.versions()
578
661
        version_ids = set(version_ids)
579
662
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            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
581
667
            if line[-1] != '\n':
582
 
                yield line + '\n', inserted
 
668
                yield line + '\n'
583
669
            else:
584
 
                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)
585
676
 
586
677
    def _walk_internal(self, version_ids=None):
587
678
        """Helper method for weave actions."""
588
 
 
 
679
        
589
680
        istack = []
590
681
        dset = set()
591
682
 
600
691
                elif c == '}':
601
692
                    istack.pop()
602
693
                elif c == '[':
 
694
                    assert self._names[v] not in dset
603
695
                    dset.add(self._names[v])
604
696
                elif c == ']':
605
697
                    dset.remove(self._names[v])
606
698
                else:
607
699
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
700
            else:
 
701
                assert l.__class__ in (str, unicode)
 
702
                assert istack
609
703
                yield lineno, istack[-1], frozenset(dset), l
610
704
            lineno += 1
611
705
 
616
710
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
617
711
                                   % dset)
618
712
 
619
 
    def plan_merge(self, ver_a, ver_b):
620
 
        """Return pseudo-annotation indicating how the two versions merge.
621
 
 
622
 
        This is computed between versions a and b and their common
623
 
        base.
624
 
 
625
 
        Weave lines present in none of them are skipped entirely.
626
 
        """
627
 
        inc_a = set(self.get_ancestry([ver_a]))
628
 
        inc_b = set(self.get_ancestry([ver_b]))
629
 
        inc_c = inc_a & inc_b
630
 
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
632
 
            if deleteset & inc_c:
633
 
                # killed in parent; can't be in either a or b
634
 
                # not relevant to our work
635
 
                yield 'killed-base', line
636
 
            elif insert in inc_c:
637
 
                # was inserted in base
638
 
                killed_a = bool(deleteset & inc_a)
639
 
                killed_b = bool(deleteset & inc_b)
640
 
                if killed_a and killed_b:
641
 
                    yield 'killed-both', line
642
 
                elif killed_a:
643
 
                    yield 'killed-a', line
644
 
                elif killed_b:
645
 
                    yield 'killed-b', line
646
 
                else:
647
 
                    yield 'unchanged', line
648
 
            elif insert in inc_a:
649
 
                if deleteset & inc_a:
650
 
                    yield 'ghost-a', line
651
 
                else:
652
 
                    # new in A; not in B
653
 
                    yield 'new-a', line
654
 
            elif insert in inc_b:
655
 
                if deleteset & inc_b:
656
 
                    yield 'ghost-b', line
657
 
                else:
658
 
                    yield 'new-b', line
659
 
            else:
660
 
                # not in either revision
661
 
                yield 'irrelevant', line
662
 
 
663
713
    def _extract(self, versions):
664
714
        """Yield annotation of lines in included set.
665
715
 
672
722
        for i in versions:
673
723
            if not isinstance(i, int):
674
724
                raise ValueError(i)
675
 
 
 
725
            
676
726
        included = self._inclusions(versions)
677
727
 
678
728
        istack = []
687
737
 
688
738
        WFE = WeaveFormatError
689
739
 
690
 
        # wow.
 
740
        # wow. 
691
741
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
742
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
743
        # 1.6 seconds in 'isinstance'.
699
749
        # we're still spending ~1/4 of the method in isinstance though.
700
750
        # so lets hard code the acceptable string classes we expect:
701
751
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
752
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
753
        #                                          objects>
704
754
        # yay, down to ~1/4 the initial extract time, and our inline time
705
755
        # has shrunk again, with isinstance no longer dominating.
706
756
        # tweaking the stack inclusion test to use a set gives:
707
757
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
758
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
759
        #                                          objects>
710
760
        # - a 5% win, or possibly just noise. However with large istacks that
711
761
        # 'in' test could dominate, so I'm leaving this change in place -
712
762
        # when its fast enough to consider profiling big datasets we can review.
713
763
 
714
 
 
715
 
 
 
764
              
 
765
             
716
766
 
717
767
        for l in self._weave:
718
768
            if l.__class__ == tuple:
719
769
                c, v = l
720
770
                isactive = None
721
771
                if c == '{':
 
772
                    assert v not in iset
722
773
                    istack.append(v)
723
774
                    iset.add(v)
724
775
                elif c == '}':
725
776
                    iset.remove(istack.pop())
726
777
                elif c == '[':
727
778
                    if v in included:
 
779
                        assert v not in dset
728
780
                        dset.add(v)
729
 
                elif c == ']':
 
781
                else:
 
782
                    assert c == ']'
730
783
                    if v in included:
 
784
                        assert v in dset
731
785
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
786
            else:
 
787
                assert l.__class__ in (str, unicode)
735
788
                if isactive is None:
736
789
                    isactive = (not dset) and istack and (istack[-1] in included)
737
790
                if isactive:
745
798
                                   % dset)
746
799
        return result
747
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
 
748
814
    def _maybe_lookup(self, name_or_index):
749
815
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
 
816
        
751
817
        NOT FOR PUBLIC USE.
752
818
        """
753
819
        if isinstance(name_or_index, (int, long)):
755
821
        else:
756
822
            return self._lookup(name_or_index)
757
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
 
758
829
    def get_lines(self, version_id):
759
830
        """See VersionedFile.get_lines()."""
760
831
        int_index = self._maybe_lookup(version_id)
763
834
        measured_sha1 = sha_strings(result)
764
835
        if measured_sha1 != expected_sha1:
765
836
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
 
837
                    'file %s, revision %s, expected: %s, measured %s' 
767
838
                    % (self._weave_name, version_id,
768
839
                       expected_sha1, measured_sha1))
769
840
        return result
770
841
 
771
 
    def get_sha1s(self, version_ids):
772
 
        """See VersionedFile.get_sha1s()."""
773
 
        result = {}
774
 
        for v in version_ids:
775
 
            result[v] = self._sha1s[self._lookup(v)]
776
 
        return result
 
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()
777
856
 
778
857
    def num_versions(self):
779
858
        """How many versions are in this weave?"""
780
859
        l = len(self._parents)
 
860
        assert l == len(self._sha1s)
781
861
        return l
782
862
 
783
863
    __len__ = num_versions
803
883
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
884
            # The problem is that set membership is much more expensive
805
885
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
886
            sha1s[name] = sha.new()
807
887
            texts[name] = []
808
888
            new_inc = set([name])
809
889
            for p in self._parents[i]:
810
890
                new_inc.update(inclusions[self._idx_to_name(p)])
811
891
 
812
 
            if set(new_inc) != set(self.get_ancestry(name)):
813
 
                raise AssertionError(
814
 
                    'failed %s != %s'
815
 
                    % (set(new_inc), set(self.get_ancestry(name))))
 
892
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
893
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
816
894
            inclusions[name] = new_inc
817
895
 
818
896
        nlines = len(self._weave)
848
926
        # no lines outside of insertion blocks, that deletions are
849
927
        # properly paired, etc.
850
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
 
851
983
    def _imported_parents(self, other, other_idx):
852
984
        """Return list of parents in self corresponding to indexes in other."""
853
985
        new_parents = []
855
987
            parent_name = other._names[parent_idx]
856
988
            if parent_name not in self._name_map:
857
989
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
990
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
991
                                 % (parent_name, other._name_map[other_idx], self))
860
992
            new_parents.append(self._name_map[parent_name])
861
993
        return new_parents
868
1000
         * the same text
869
1001
         * the same direct parents (by name, not index, and disregarding
870
1002
           order)
871
 
 
 
1003
        
872
1004
        If present & correct return True;
873
 
        if not present in self return False;
 
1005
        if not present in self return False; 
874
1006
        if inconsistent raise error."""
875
1007
        this_idx = self._name_map.get(name, -1)
876
1008
        if this_idx != -1:
888
1020
        else:
889
1021
            return False
890
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
 
891
1028
    def _reweave(self, other, pb, msg):
892
1029
        """Reweave self with other - internal helper for join().
893
1030
 
909
1046
    """A WeaveFile represents a Weave on disk and writes on change."""
910
1047
 
911
1048
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    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'):
914
1051
        """Create a WeaveFile.
915
 
 
 
1052
        
916
1053
        :param create: If not True, only open an existing knit.
917
1054
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
1055
        super(WeaveFile, self).__init__(name, access_mode)
920
1056
        self._transport = transport
921
1057
        self._filemode = filemode
922
1058
        try:
927
1063
            # new file, save it
928
1064
            self._save()
929
1065
 
930
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
931
 
        left_matching_blocks, nostore_sha, random_id, check_content):
 
1066
    def _add_lines(self, version_id, parents, lines, parent_texts):
932
1067
        """Add a version and save the weave."""
933
 
        self.check_not_reserved_id(version_id)
934
1068
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
935
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
936
 
            check_content)
 
1069
                                                   parent_texts)
937
1070
        self._save()
938
1071
        return result
939
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
 
940
1078
    def copy_to(self, name, transport):
941
1079
        """See VersionedFile.copy_to()."""
942
1080
        # as we are all in memory always, just serialise to the new place.
943
1081
        sio = StringIO()
944
1082
        write_weave_v5(self, sio)
945
1083
        sio.seek(0)
946
 
        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)
947
1088
 
948
1089
    def _save(self):
949
1090
        """Save the weave."""
951
1092
        sio = StringIO()
952
1093
        write_weave_v5(self, sio)
953
1094
        sio.seek(0)
954
 
        bytes = sio.getvalue()
955
 
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
956
 
        try:
957
 
            self._transport.put_bytes(path, bytes, self._filemode)
958
 
        except errors.NoSuchFile:
959
 
            self._transport.mkdir(dirname(path))
960
 
            self._transport.put_bytes(path, bytes, self._filemode)
 
1095
        self._transport.put(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1096
                            sio,
 
1097
                            self._filemode)
961
1098
 
962
1099
    @staticmethod
963
1100
    def get_suffixes():
964
1101
        """See VersionedFile.get_suffixes()."""
965
1102
        return [WeaveFile.WEAVE_SUFFIX]
966
1103
 
967
 
    def insert_record_stream(self, stream):
968
 
        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)
969
1108
        self._save()
970
1109
 
971
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
 
972
1116
def _reweave(wa, wb, pb=None, msg=None):
973
1117
    """Combine two weaves and return the result.
974
1118
 
975
 
    This works even if a revision R has different parents in
 
1119
    This works even if a revision R has different parents in 
976
1120
    wa and wb.  In the resulting weave all the parents are given.
977
1121
 
978
 
    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 
979
1123
    of the versions in the two inputs.  More efficient approaches
980
 
    might be possible but it should only be necessary to do
981
 
    this operation rarely, when a new previously ghost version is
 
1124
    might be possible but it should only be necessary to do 
 
1125
    this operation rarely, when a new previously ghost version is 
982
1126
    inserted.
983
1127
 
984
1128
    :param pb: An optional progress bar, indicating how far done we are
992
1136
    # map from version name -> all parent names
993
1137
    combined_parents = _reweave_parent_graphs(wa, wb)
994
1138
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
1139
    order = topo_sort(combined_parents.iteritems())
996
1140
    mutter("order to reweave: %r", order)
997
1141
 
998
1142
    if pb and not msg:
1018
1162
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
1163
    return wr
1020
1164
 
1021
 
 
1022
1165
def _reweave_parent_graphs(wa, wb):
1023
1166
    """Return combined parent ancestry for two weaves.
1024
 
 
 
1167
    
1025
1168
    Returned as a list of (version_name, set(parent_names))"""
1026
1169
    combined = {}
1027
1170
    for weave in [wa, wb]:
1029
1172
            p = combined.setdefault(name, set())
1030
1173
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
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)