← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

Major code cleanup.

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