/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: Robert Collins
  • Date: 2010-05-05 00:05:29 UTC
  • mto: This revision was merged to the branch mainline in revision 5206.
  • Revision ID: robertc@robertcollins.net-20100505000529-ltmllyms5watqj5u
Make 'pydoc bzrlib.tests.build_tree_shape' useful.

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