← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Robert Collins
  • Date: 2006-05-22 09:17:55 UTC
  • mto: (1721.1.2 integration)
  • mto: This revision was merged to the branch mainline in revision 1723.
  • Revision ID: robertc@robertcollins.net-20060522091755-ce8d5afb417ab26f
Review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weave.py
1
 
# Copyright (C) 2005, 2009 Canonical Ltd
2
 
#
 
1
#! /usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 Canonical Ltd
 
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
7
 
#
 
9
 
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
13
# GNU General Public License for more details.
12
 
#
 
14
 
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
# Author: Martin Pool <mbp@canonical.com>
18
20
 
25
27
# property.
26
28
 
27
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
28
 
# rather than being split up in some other way.  We could accommodate
 
30
# rather than being split up in some other way.  We could accomodate
29
31
# binaries, perhaps by naively splitting on \n or perhaps using
30
32
# something like a rolling checksum.
31
33
 
59
61
# where the basis and destination are unchanged.
60
62
 
61
63
# FIXME: Sometimes we will be given a parents list for a revision
62
 
# that includes some redundant parents (i.e. already a parent of
63
 
# something in the list.)  We should eliminate them.  This can
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
64
66
# be done fairly efficiently because the sequence numbers constrain
65
67
# the possible relationships.
66
68
 
68
70
 
69
71
from copy import copy
70
72
from cStringIO import StringIO
 
73
from difflib import SequenceMatcher
71
74
import os
 
75
import sha
 
76
import time
72
77
 
73
 
from bzrlib.lazy_import import lazy_import
74
 
lazy_import(globals(), """
75
 
from bzrlib import tsort
76
 
""")
77
 
from bzrlib import (
78
 
    errors,
79
 
    osutils,
80
 
    )
 
78
from bzrlib.trace import mutter
81
79
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
82
80
        RevisionAlreadyPresent,
83
81
        RevisionNotPresent,
84
 
        UnavailableRepresentation,
 
82
        WeaveRevisionAlreadyPresent,
 
83
        WeaveRevisionNotPresent,
85
84
        )
86
 
from bzrlib.osutils import dirname, sha, sha_strings, split_lines
87
 
import bzrlib.patiencediff
88
 
from bzrlib.revision import NULL_REVISION
 
85
import bzrlib.errors as errors
 
86
from bzrlib.osutils import sha_strings
89
87
from bzrlib.symbol_versioning import *
90
 
from bzrlib.trace import mutter
91
 
from bzrlib.versionedfile import (
92
 
    AbsentContentFactory,
93
 
    adapter_registry,
94
 
    ContentFactory,
95
 
    sort_groupcompress,
96
 
    VersionedFile,
97
 
    )
 
88
from bzrlib.tsort import topo_sort
 
89
from bzrlib.versionedfile import VersionedFile, InterVersionedFile
98
90
from bzrlib.weavefile import _read_weave_v5, write_weave_v5
99
91
 
100
92
 
101
 
class WeaveContentFactory(ContentFactory):
102
 
    """Content factory for streaming from weaves.
103
 
 
104
 
    :seealso ContentFactory:
105
 
    """
106
 
 
107
 
    def __init__(self, version, weave):
108
 
        """Create a WeaveContentFactory for version from weave."""
109
 
        ContentFactory.__init__(self)
110
 
        self.sha1 = weave.get_sha1s([version])[version]
111
 
        self.key = (version,)
112
 
        parents = weave.get_parent_map([version])[version]
113
 
        self.parents = tuple((parent,) for parent in parents)
114
 
        self.storage_kind = 'fulltext'
115
 
        self._weave = weave
116
 
 
117
 
    def get_bytes_as(self, storage_kind):
118
 
        if storage_kind == 'fulltext':
119
 
            return self._weave.get_text(self.key[-1])
120
 
        elif storage_kind == 'chunked':
121
 
            return self._weave.get_lines(self.key[-1])
122
 
        else:
123
 
            raise UnavailableRepresentation(self.key, storage_kind, 'fulltext')
124
 
 
125
 
 
126
93
class Weave(VersionedFile):
127
94
    """weave - versioned text file storage.
128
 
 
 
95
    
129
96
    A Weave manages versions of line-based text files, keeping track
130
97
    of the originating version for each line.
131
98
 
177
144
 
178
145
    * It doesn't seem very useful to have an active insertion
179
146
      inside an inactive insertion, but it might happen.
180
 
 
 
147
      
181
148
    * Therefore, all instructions are always"considered"; that
182
149
      is passed onto and off the stack.  An outer inactive block
183
150
      doesn't disable an inner block.
213
180
    """
214
181
 
215
182
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
216
 
                 '_weave_name', '_matcher', '_allow_reserved']
217
 
 
218
 
    def __init__(self, weave_name=None, access_mode='w', matcher=None,
219
 
                 get_scope=None, allow_reserved=False):
220
 
        """Create a weave.
221
 
 
222
 
        :param get_scope: A callable that returns an opaque object to be used
223
 
            for detecting when this weave goes out of scope (should stop
224
 
            answering requests or allowing mutation).
225
 
        """
226
 
        super(Weave, self).__init__()
 
183
                 '_weave_name']
 
184
    
 
185
    def __init__(self, weave_name=None, access_mode='w'):
 
186
        super(Weave, self).__init__(access_mode)
227
187
        self._weave = []
228
188
        self._parents = []
229
189
        self._sha1s = []
230
190
        self._names = []
231
191
        self._name_map = {}
232
192
        self._weave_name = weave_name
233
 
        if matcher is None:
234
 
            self._matcher = bzrlib.patiencediff.PatienceSequenceMatcher
235
 
        else:
236
 
            self._matcher = matcher
237
 
        if get_scope is None:
238
 
            get_scope = lambda:None
239
 
        self._get_scope = get_scope
240
 
        self._scope = get_scope()
241
 
        self._access_mode = access_mode
242
 
        self._allow_reserved = allow_reserved
243
193
 
244
194
    def __repr__(self):
245
195
        return "Weave(%r)" % self._weave_name
246
196
 
247
 
    def _check_write_ok(self):
248
 
        """Is the versioned file marked as 'finished' ? Raise if it is."""
249
 
        if self._get_scope() != self._scope:
250
 
            raise errors.OutSideTransaction()
251
 
        if self._access_mode != 'w':
252
 
            raise errors.ReadOnlyObjectDirtiedError(self)
253
 
 
254
197
    def copy(self):
255
198
        """Return a deep copy of self.
256
 
 
 
199
        
257
200
        The copy can be modified without affecting the original weave."""
258
201
        other = Weave()
259
202
        other._weave = self._weave[:]
269
212
            return False
270
213
        return self._parents == other._parents \
271
214
               and self._weave == other._weave \
272
 
               and self._sha1s == other._sha1s
273
 
 
 
215
               and self._sha1s == other._sha1s 
 
216
    
274
217
    def __ne__(self, other):
275
218
        return not self.__eq__(other)
276
219
 
 
220
    @deprecated_method(zero_eight)
 
221
    def idx_to_name(self, index):
 
222
        """Old public interface, the public interface is all names now."""
 
223
        return index
 
224
 
277
225
    def _idx_to_name(self, version):
278
226
        return self._names[version]
279
227
 
 
228
    @deprecated_method(zero_eight)
 
229
    def lookup(self, name):
 
230
        """Backwards compatability thunk:
 
231
 
 
232
        Return name, as name is valid in the api now, and spew deprecation
 
233
        warnings everywhere.
 
234
        """
 
235
        return name
 
236
 
280
237
    def _lookup(self, name):
281
238
        """Convert symbolic version name to index."""
282
 
        if not self._allow_reserved:
283
 
            self.check_not_reserved_id(name)
284
239
        try:
285
240
            return self._name_map[name]
286
241
        except KeyError:
287
242
            raise RevisionNotPresent(name, self._weave_name)
288
243
 
 
244
    @deprecated_method(zero_eight)
 
245
    def iter_names(self):
 
246
        """Deprecated convenience function, please see VersionedFile.names()."""
 
247
        return iter(self.names())
 
248
 
 
249
    @deprecated_method(zero_eight)
 
250
    def names(self):
 
251
        """See Weave.versions for the current api."""
 
252
        return self.versions()
 
253
 
289
254
    def versions(self):
290
255
        """See VersionedFile.versions."""
291
256
        return self._names[:]
292
257
 
293
258
    def has_version(self, version_id):
294
259
        """See VersionedFile.has_version."""
295
 
        return (version_id in self._name_map)
 
260
        return self._name_map.has_key(version_id)
296
261
 
297
262
    __contains__ = has_version
298
263
 
299
 
    def get_record_stream(self, versions, ordering, include_delta_closure):
300
 
        """Get a stream of records for versions.
301
 
 
302
 
        :param versions: The versions to include. Each version is a tuple
303
 
            (version,).
304
 
        :param ordering: Either 'unordered' or 'topological'. A topologically
305
 
            sorted stream has compression parents strictly before their
306
 
            children.
307
 
        :param include_delta_closure: If True then the closure across any
308
 
            compression parents will be included (in the opaque data).
309
 
        :return: An iterator of ContentFactory objects, each of which is only
310
 
            valid until the iterator is advanced.
311
 
        """
312
 
        versions = [version[-1] for version in versions]
313
 
        if ordering == 'topological':
314
 
            parents = self.get_parent_map(versions)
315
 
            new_versions = tsort.topo_sort(parents)
316
 
            new_versions.extend(set(versions).difference(set(parents)))
317
 
            versions = new_versions
318
 
        elif ordering == 'groupcompress':
319
 
            parents = self.get_parent_map(versions)
320
 
            new_versions = sort_groupcompress(parents)
321
 
            new_versions.extend(set(versions).difference(set(parents)))
322
 
            versions = new_versions
323
 
        for version in versions:
324
 
            if version in self:
325
 
                yield WeaveContentFactory(version, self)
326
 
            else:
327
 
                yield AbsentContentFactory((version,))
328
 
 
329
 
    def get_parent_map(self, version_ids):
330
 
        """See VersionedFile.get_parent_map."""
331
 
        result = {}
 
264
    def get_delta(self, version_id):
 
265
        """See VersionedFile.get_delta."""
 
266
        return self.get_deltas([version_id])[version_id]
 
267
 
 
268
    def get_deltas(self, version_ids):
 
269
        """See VersionedFile.get_deltas."""
 
270
        version_ids = self.get_ancestry(version_ids)
332
271
        for version_id in version_ids:
333
 
            if version_id == NULL_REVISION:
334
 
                parents = ()
335
 
            else:
336
 
                try:
337
 
                    parents = tuple(
338
 
                        map(self._idx_to_name,
339
 
                            self._parents[self._lookup(version_id)]))
340
 
                except RevisionNotPresent:
 
272
            if not self.has_version(version_id):
 
273
                raise RevisionNotPresent(version_id, self)
 
274
        # try extracting all versions; parallel extraction is used
 
275
        nv = self.num_versions()
 
276
        sha1s = {}
 
277
        deltas = {}
 
278
        texts = {}
 
279
        inclusions = {}
 
280
        noeols = {}
 
281
        last_parent_lines = {}
 
282
        parents = {}
 
283
        parent_inclusions = {}
 
284
        parent_linenums = {}
 
285
        parent_noeols = {}
 
286
        current_hunks = {}
 
287
        diff_hunks = {}
 
288
        # its simplest to generate a full set of prepared variables.
 
289
        for i in range(nv):
 
290
            name = self._names[i]
 
291
            sha1s[name] = self.get_sha1(name)
 
292
            parents_list = self.get_parents(name)
 
293
            try:
 
294
                parent = parents_list[0]
 
295
                parents[name] = parent
 
296
                parent_inclusions[name] = inclusions[parent]
 
297
            except IndexError:
 
298
                parents[name] = None
 
299
                parent_inclusions[name] = set()
 
300
            # we want to emit start, finish, replacement_length, replacement_lines tuples.
 
301
            diff_hunks[name] = []
 
302
            current_hunks[name] = [0, 0, 0, []] # #start, finish, repl_length, repl_tuples
 
303
            parent_linenums[name] = 0
 
304
            noeols[name] = False
 
305
            parent_noeols[name] = False
 
306
            last_parent_lines[name] = None
 
307
            new_inc = set([name])
 
308
            for p in self._parents[i]:
 
309
                new_inc.update(inclusions[self._idx_to_name(p)])
 
310
            # debug only, known good so far.
 
311
            #assert set(new_inc) == set(self.get_ancestry(name)), \
 
312
            #    'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
 
313
            inclusions[name] = new_inc
 
314
 
 
315
        nlines = len(self._weave)
 
316
 
 
317
        for lineno, inserted, deletes, line in self._walk_internal():
 
318
            # a line is active in a version if:
 
319
            # insert is in the versions inclusions
 
320
            # and
 
321
            # deleteset & the versions inclusions is an empty set.
 
322
            # so - if we have a included by mapping - version is included by
 
323
            # children, we get a list of children to examine for deletes affect
 
324
            # ing them, which is less than the entire set of children.
 
325
            for version_id in version_ids:  
 
326
                # The active inclusion must be an ancestor,
 
327
                # and no ancestors must have deleted this line,
 
328
                # because we don't support resurrection.
 
329
                parent_inclusion = parent_inclusions[version_id]
 
330
                inclusion = inclusions[version_id]
 
331
                parent_active = inserted in parent_inclusion and not (deletes & parent_inclusion)
 
332
                version_active = inserted in inclusion and not (deletes & inclusion)
 
333
                if not parent_active and not version_active:
 
334
                    # unrelated line of ancestry
341
335
                    continue
342
 
            result[version_id] = parents
 
336
                elif parent_active and version_active:
 
337
                    # shared line
 
338
                    parent_linenum = parent_linenums[version_id]
 
339
                    if current_hunks[version_id] != [parent_linenum, parent_linenum, 0, []]:
 
340
                        diff_hunks[version_id].append(tuple(current_hunks[version_id]))
 
341
                    parent_linenum += 1
 
342
                    current_hunks[version_id] = [parent_linenum, parent_linenum, 0, []]
 
343
                    parent_linenums[version_id] = parent_linenum
 
344
                    try:
 
345
                        if line[-1] != '\n':
 
346
                            noeols[version_id] = True
 
347
                    except IndexError:
 
348
                        pass
 
349
                elif parent_active and not version_active:
 
350
                    # deleted line
 
351
                    current_hunks[version_id][1] += 1
 
352
                    parent_linenums[version_id] += 1
 
353
                    last_parent_lines[version_id] = line
 
354
                elif not parent_active and version_active:
 
355
                    # replacement line
 
356
                    # noeol only occurs at the end of a file because we 
 
357
                    # diff linewise. We want to show noeol changes as a
 
358
                    # empty diff unless the actual eol-less content changed.
 
359
                    theline = line
 
360
                    try:
 
361
                        if last_parent_lines[version_id][-1] != '\n':
 
362
                            parent_noeols[version_id] = True
 
363
                    except (TypeError, IndexError):
 
364
                        pass
 
365
                    try:
 
366
                        if theline[-1] != '\n':
 
367
                            noeols[version_id] = True
 
368
                    except IndexError:
 
369
                        pass
 
370
                    new_line = False
 
371
                    parent_should_go = False
 
372
 
 
373
                    if parent_noeols[version_id] == noeols[version_id]:
 
374
                        # no noeol toggle, so trust the weaves statement
 
375
                        # that this line is changed.
 
376
                        new_line = True
 
377
                        if parent_noeols[version_id]:
 
378
                            theline = theline + '\n'
 
379
                    elif parent_noeols[version_id]:
 
380
                        # parent has no eol, we do:
 
381
                        # our line is new, report as such..
 
382
                        new_line = True
 
383
                    elif noeols[version_id]:
 
384
                        # append a eol so that it looks like
 
385
                        # a normalised delta
 
386
                        theline = theline + '\n'
 
387
                        if parents[version_id] is not None:
 
388
                        #if last_parent_lines[version_id] is not None:
 
389
                            parent_should_go = True
 
390
                        if last_parent_lines[version_id] != theline:
 
391
                            # but changed anyway
 
392
                            new_line = True
 
393
                            #parent_should_go = False
 
394
                    if new_line:
 
395
                        current_hunks[version_id][2] += 1
 
396
                        current_hunks[version_id][3].append((inserted, theline))
 
397
                    if parent_should_go:
 
398
                        # last hunk last parent line is not eaten
 
399
                        current_hunks[version_id][1] -= 1
 
400
                    if current_hunks[version_id][1] < 0:
 
401
                        current_hunks[version_id][1] = 0
 
402
                        # import pdb;pdb.set_trace()
 
403
                    # assert current_hunks[version_id][1] >= 0
 
404
 
 
405
        # flush last hunk
 
406
        for i in range(nv):
 
407
            version = self._idx_to_name(i)
 
408
            if current_hunks[version] != [0, 0, 0, []]:
 
409
                diff_hunks[version].append(tuple(current_hunks[version]))
 
410
        result = {}
 
411
        for version_id in version_ids:
 
412
            result[version_id] = (
 
413
                                  parents[version_id],
 
414
                                  sha1s[version_id],
 
415
                                  noeols[version_id],
 
416
                                  diff_hunks[version_id],
 
417
                                  )
343
418
        return result
344
419
 
345
 
    def get_parents_with_ghosts(self, version_id):
346
 
        raise NotImplementedError(self.get_parents_with_ghosts)
347
 
 
348
 
    def insert_record_stream(self, stream):
349
 
        """Insert a record stream into this versioned file.
350
 
 
351
 
        :param stream: A stream of records to insert.
352
 
        :return: None
353
 
        :seealso VersionedFile.get_record_stream:
354
 
        """
355
 
        adapters = {}
356
 
        for record in stream:
357
 
            # Raise an error when a record is missing.
358
 
            if record.storage_kind == 'absent':
359
 
                raise RevisionNotPresent([record.key[0]], self)
360
 
            # adapt to non-tuple interface
361
 
            parents = [parent[0] for parent in record.parents]
362
 
            if (record.storage_kind == 'fulltext'
363
 
                or record.storage_kind == 'chunked'):
364
 
                self.add_lines(record.key[0], parents,
365
 
                    osutils.chunks_to_lines(record.get_bytes_as('chunked')))
366
 
            else:
367
 
                adapter_key = record.storage_kind, 'fulltext'
368
 
                try:
369
 
                    adapter = adapters[adapter_key]
370
 
                except KeyError:
371
 
                    adapter_factory = adapter_registry.get(adapter_key)
372
 
                    adapter = adapter_factory(self)
373
 
                    adapters[adapter_key] = adapter
374
 
                lines = split_lines(adapter.get_bytes(record))
375
 
                try:
376
 
                    self.add_lines(record.key[0], parents, lines)
377
 
                except RevisionAlreadyPresent:
378
 
                    pass
 
420
    def get_parents(self, version_id):
 
421
        """See VersionedFile.get_parent."""
 
422
        return map(self._idx_to_name, self._parents[self._lookup(version_id)])
379
423
 
380
424
    def _check_repeated_add(self, name, parents, text, sha1):
381
425
        """Check that a duplicated add is OK.
388
432
            raise RevisionAlreadyPresent(name, self._weave_name)
389
433
        return idx
390
434
 
391
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
392
 
       left_matching_blocks, nostore_sha, random_id, check_content):
 
435
    @deprecated_method(zero_eight)
 
436
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
437
        """Please use Weave.clone_text now."""
 
438
        return self.clone_text(new_rev_id, old_rev_id, parents)
 
439
 
 
440
    def _add_lines(self, version_id, parents, lines, parent_texts):
393
441
        """See VersionedFile.add_lines."""
394
 
        idx = self._add(version_id, lines, map(self._lookup, parents),
395
 
            nostore_sha=nostore_sha)
396
 
        return sha_strings(lines), sum(map(len, lines)), idx
397
 
 
398
 
    def _add(self, version_id, lines, parents, sha1=None, nostore_sha=None):
 
442
        return self._add(version_id, lines, map(self._lookup, parents))
 
443
 
 
444
    @deprecated_method(zero_eight)
 
445
    def add(self, name, parents, text, sha1=None):
 
446
        """See VersionedFile.add_lines for the non deprecated api."""
 
447
        return self._add(name, text, map(self._maybe_lookup, parents), sha1)
 
448
 
 
449
    def _add(self, version_id, lines, parents, sha1=None):
399
450
        """Add a single text on top of the weave.
400
 
 
 
451
  
401
452
        Returns the index number of the newly added version.
402
453
 
403
454
        version_id
404
455
            Symbolic name for this version.
405
456
            (Typically the revision-id of the revision that added it.)
406
 
            If None, a name will be allocated based on the hash. (sha1:SHAHASH)
407
457
 
408
458
        parents
409
459
            List or set of direct parent version numbers.
410
 
 
 
460
            
411
461
        lines
412
462
            Sequence of lines to be added in the new version.
 
463
        """
413
464
 
414
 
        :param nostore_sha: See VersionedFile.add_lines.
415
 
        """
 
465
        assert isinstance(version_id, basestring)
416
466
        self._check_lines_not_unicode(lines)
417
467
        self._check_lines_are_lines(lines)
418
468
        if not sha1:
419
469
            sha1 = sha_strings(lines)
420
 
        if sha1 == nostore_sha:
421
 
            raise errors.ExistingContent
422
 
        if version_id is None:
423
 
            version_id = "sha1:" + sha1
424
470
        if version_id in self._name_map:
425
471
            return self._check_repeated_add(version_id, parents, lines, sha1)
426
472
 
437
483
        self._names.append(version_id)
438
484
        self._name_map[version_id] = new_version
439
485
 
440
 
 
 
486
            
441
487
        if not parents:
442
488
            # special case; adding with no parents revision; can do
443
489
            # this more quickly by just appending unconditionally.
454
500
            if sha1 == self._sha1s[pv]:
455
501
                # special case: same as the single parent
456
502
                return new_version
457
 
 
 
503
            
458
504
 
459
505
        ancestors = self._inclusions(parents)
460
506
 
470
516
        # another small special case: a merge, producing the same text
471
517
        # as auto-merge
472
518
        if lines == basis_lines:
473
 
            return new_version
 
519
            return new_version            
474
520
 
475
 
        # add a sentinel, because we can also match against the final line
 
521
        # add a sentinal, because we can also match against the final line
476
522
        basis_lineno.append(len(self._weave))
477
523
 
478
524
        # XXX: which line of the weave should we really consider
482
528
        #print 'basis_lines:', basis_lines
483
529
        #print 'new_lines:  ', lines
484
530
 
485
 
        s = self._matcher(None, basis_lines, lines)
 
531
        s = SequenceMatcher(None, basis_lines, lines)
486
532
 
487
533
        # offset gives the number of lines that have been inserted
488
534
        # into the weave up to the current point; if the original edit instruction
495
541
            #print 'raw match', tag, i1, i2, j1, j2
496
542
            if tag == 'equal':
497
543
                continue
 
544
 
498
545
            i1 = basis_lineno[i1]
499
546
            i2 = basis_lineno[i2]
 
547
 
 
548
            assert 0 <= j1 <= j2 <= len(lines)
 
549
 
 
550
            #print tag, i1, i2, j1, j2
 
551
 
500
552
            # the deletion and insertion are handled separately.
501
553
            # first delete the region.
502
554
            if i1 != i2:
509
561
                # i2; we want to insert after this region to make sure
510
562
                # we don't destroy ourselves
511
563
                i = i2 + offset
512
 
                self._weave[i:i] = ([('{', new_version)]
513
 
                                    + lines[j1:j2]
 
564
                self._weave[i:i] = ([('{', new_version)] 
 
565
                                    + lines[j1:j2] 
514
566
                                    + [('}', None)])
515
567
                offset += 2 + (j2 - j1)
516
568
        return new_version
517
569
 
 
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
 
518
575
    def _inclusions(self, versions):
519
576
        """Return set of all ancestors of given version(s)."""
520
577
        if not len(versions):
528
585
        ## except IndexError:
529
586
        ##     raise ValueError("version %d not present in weave" % v)
530
587
 
531
 
    def get_ancestry(self, version_ids, topo_sorted=True):
 
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):
532
599
        """See VersionedFile.get_ancestry."""
533
600
        if isinstance(version_ids, basestring):
534
601
            version_ids = [version_ids]
543
610
            if not isinstance(l, basestring):
544
611
                raise ValueError("text line should be a string or unicode, not %s"
545
612
                                 % type(l))
546
 
 
 
613
        
547
614
 
548
615
 
549
616
    def _check_versions(self, indexes):
557
624
    def _compatible_parents(self, my_parents, other_parents):
558
625
        """During join check that other_parents are joinable with my_parents.
559
626
 
560
 
        Joinable is defined as 'is a subset of' - supersets may require
 
627
        Joinable is defined as 'is a subset of' - supersets may require 
561
628
        regeneration of diffs, but subsets do not.
562
629
        """
563
630
        return len(other_parents.difference(my_parents)) == 0
564
631
 
565
632
    def annotate(self, version_id):
566
 
        """Return a list of (version-id, line) tuples for 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.
567
648
 
568
649
        The index indicates when the line originated in the weave."""
569
650
        incls = [self._lookup(version_id)]
570
 
        return [(self._idx_to_name(origin), text) for origin, lineno, text in
571
 
            self._extract(incls)]
572
 
 
573
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
574
 
                                                pb=None):
 
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):
575
660
        """See VersionedFile.iter_lines_added_or_present_in_versions()."""
576
661
        if version_ids is None:
577
662
            version_ids = self.versions()
578
663
        version_ids = set(version_ids)
579
664
        for lineno, inserted, deletes, line in self._walk_internal(version_ids):
580
 
            if inserted not in version_ids: continue
 
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
581
669
            if line[-1] != '\n':
582
 
                yield line + '\n', inserted
 
670
                yield line + '\n'
583
671
            else:
584
 
                yield line, inserted
 
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)
585
678
 
586
679
    def _walk_internal(self, version_ids=None):
587
680
        """Helper method for weave actions."""
588
 
 
 
681
        
589
682
        istack = []
590
683
        dset = set()
591
684
 
600
693
                elif c == '}':
601
694
                    istack.pop()
602
695
                elif c == '[':
 
696
                    assert self._names[v] not in dset
603
697
                    dset.add(self._names[v])
604
698
                elif c == ']':
605
699
                    dset.remove(self._names[v])
606
700
                else:
607
701
                    raise WeaveFormatError('unexpected instruction %r' % v)
608
702
            else:
 
703
                assert l.__class__ in (str, unicode)
 
704
                assert istack
609
705
                yield lineno, istack[-1], frozenset(dset), l
610
706
            lineno += 1
611
707
 
628
724
        inc_b = set(self.get_ancestry([ver_b]))
629
725
        inc_c = inc_a & inc_b
630
726
 
631
 
        for lineno, insert, deleteset, line in self._walk_internal([ver_a, ver_b]):
 
727
        for lineno, insert, deleteset, line in\
 
728
            self.walk([ver_a, ver_b]):
632
729
            if deleteset & inc_c:
633
730
                # killed in parent; can't be in either a or b
634
731
                # not relevant to our work
660
757
                # not in either revision
661
758
                yield 'irrelevant', line
662
759
 
 
760
        yield 'unchanged', ''           # terminator
 
761
 
663
762
    def _extract(self, versions):
664
763
        """Yield annotation of lines in included set.
665
764
 
672
771
        for i in versions:
673
772
            if not isinstance(i, int):
674
773
                raise ValueError(i)
675
 
 
 
774
            
676
775
        included = self._inclusions(versions)
677
776
 
678
777
        istack = []
687
786
 
688
787
        WFE = WeaveFormatError
689
788
 
690
 
        # wow.
 
789
        # wow. 
691
790
        #  449       0   4474.6820   2356.5590   bzrlib.weave:556(_extract)
692
791
        #  +285282   0   1676.8040   1676.8040   +<isinstance>
693
792
        # 1.6 seconds in 'isinstance'.
699
798
        # we're still spending ~1/4 of the method in isinstance though.
700
799
        # so lets hard code the acceptable string classes we expect:
701
800
        #  449       0   1202.9420    786.2930   bzrlib.weave:556(_extract)
702
 
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list'
 
801
        # +71352     0    377.5560    377.5560   +<method 'append' of 'list' 
703
802
        #                                          objects>
704
803
        # yay, down to ~1/4 the initial extract time, and our inline time
705
804
        # has shrunk again, with isinstance no longer dominating.
706
805
        # tweaking the stack inclusion test to use a set gives:
707
806
        #  449       0   1122.8030    713.0080   bzrlib.weave:556(_extract)
708
 
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list'
 
807
        # +71352     0    354.9980    354.9980   +<method 'append' of 'list' 
709
808
        #                                          objects>
710
809
        # - a 5% win, or possibly just noise. However with large istacks that
711
810
        # 'in' test could dominate, so I'm leaving this change in place -
712
811
        # when its fast enough to consider profiling big datasets we can review.
713
812
 
714
 
 
715
 
 
 
813
              
 
814
             
716
815
 
717
816
        for l in self._weave:
718
817
            if l.__class__ == tuple:
719
818
                c, v = l
720
819
                isactive = None
721
820
                if c == '{':
 
821
                    assert v not in iset
722
822
                    istack.append(v)
723
823
                    iset.add(v)
724
824
                elif c == '}':
725
825
                    iset.remove(istack.pop())
726
826
                elif c == '[':
727
827
                    if v in included:
 
828
                        assert v not in dset
728
829
                        dset.add(v)
729
 
                elif c == ']':
 
830
                else:
 
831
                    assert c == ']'
730
832
                    if v in included:
 
833
                        assert v in dset
731
834
                        dset.remove(v)
732
 
                else:
733
 
                    raise AssertionError()
734
835
            else:
 
836
                assert l.__class__ in (str, unicode)
735
837
                if isactive is None:
736
838
                    isactive = (not dset) and istack and (istack[-1] in included)
737
839
                if isactive:
745
847
                                   % dset)
746
848
        return result
747
849
 
 
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
 
748
863
    def _maybe_lookup(self, name_or_index):
749
864
        """Convert possible symbolic name to index, or pass through indexes.
750
 
 
 
865
        
751
866
        NOT FOR PUBLIC USE.
752
867
        """
753
868
        if isinstance(name_or_index, (int, long)):
755
870
        else:
756
871
            return self._lookup(name_or_index)
757
872
 
 
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
 
758
878
    def get_lines(self, version_id):
759
879
        """See VersionedFile.get_lines()."""
760
880
        int_index = self._maybe_lookup(version_id)
763
883
        measured_sha1 = sha_strings(result)
764
884
        if measured_sha1 != expected_sha1:
765
885
            raise errors.WeaveInvalidChecksum(
766
 
                    'file %s, revision %s, expected: %s, measured %s'
 
886
                    'file %s, revision %s, expected: %s, measured %s' 
767
887
                    % (self._weave_name, version_id,
768
888
                       expected_sha1, measured_sha1))
769
889
        return result
770
890
 
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
 
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()
777
902
 
778
903
    def num_versions(self):
779
904
        """How many versions are in this weave?"""
780
905
        l = len(self._parents)
 
906
        assert l == len(self._sha1s)
781
907
        return l
782
908
 
783
909
    __len__ = num_versions
803
929
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
804
930
            # The problem is that set membership is much more expensive
805
931
            name = self._idx_to_name(i)
806
 
            sha1s[name] = sha()
 
932
            sha1s[name] = sha.new()
807
933
            texts[name] = []
808
934
            new_inc = set([name])
809
935
            for p in self._parents[i]:
810
936
                new_inc.update(inclusions[self._idx_to_name(p)])
811
937
 
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))))
 
938
            assert set(new_inc) == set(self.get_ancestry(name)), \
 
939
                'failed %s != %s' % (set(new_inc), set(self.get_ancestry(name)))
816
940
            inclusions[name] = new_inc
817
941
 
818
942
        nlines = len(self._weave)
848
972
        # no lines outside of insertion blocks, that deletions are
849
973
        # properly paired, etc.
850
974
 
 
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
 
851
1026
    def _imported_parents(self, other, other_idx):
852
1027
        """Return list of parents in self corresponding to indexes in other."""
853
1028
        new_parents = []
855
1030
            parent_name = other._names[parent_idx]
856
1031
            if parent_name not in self._name_map:
857
1032
                # should not be possible
858
 
                raise WeaveError("missing parent {%s} of {%s} in %r"
 
1033
                raise WeaveError("missing parent {%s} of {%s} in %r" 
859
1034
                                 % (parent_name, other._name_map[other_idx], self))
860
1035
            new_parents.append(self._name_map[parent_name])
861
1036
        return new_parents
868
1043
         * the same text
869
1044
         * the same direct parents (by name, not index, and disregarding
870
1045
           order)
871
 
 
 
1046
        
872
1047
        If present & correct return True;
873
 
        if not present in self return False;
 
1048
        if not present in self return False; 
874
1049
        if inconsistent raise error."""
875
1050
        this_idx = self._name_map.get(name, -1)
876
1051
        if this_idx != -1:
888
1063
        else:
889
1064
            return False
890
1065
 
 
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
 
891
1071
    def _reweave(self, other, pb, msg):
892
1072
        """Reweave self with other - internal helper for join().
893
1073
 
909
1089
    """A WeaveFile represents a Weave on disk and writes on change."""
910
1090
 
911
1091
    WEAVE_SUFFIX = '.weave'
912
 
 
913
 
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w', get_scope=None):
 
1092
    
 
1093
    def __init__(self, name, transport, filemode=None, create=False, access_mode='w'):
914
1094
        """Create a WeaveFile.
915
 
 
 
1095
        
916
1096
        :param create: If not True, only open an existing knit.
917
1097
        """
918
 
        super(WeaveFile, self).__init__(name, access_mode, get_scope=get_scope,
919
 
            allow_reserved=False)
 
1098
        super(WeaveFile, self).__init__(name, access_mode)
920
1099
        self._transport = transport
921
1100
        self._filemode = filemode
922
1101
        try:
927
1106
            # new file, save it
928
1107
            self._save()
929
1108
 
930
 
    def _add_lines(self, version_id, parents, lines, parent_texts,
931
 
        left_matching_blocks, nostore_sha, random_id, check_content):
 
1109
    def _add_lines(self, version_id, parents, lines, parent_texts):
932
1110
        """Add a version and save the weave."""
933
 
        self.check_not_reserved_id(version_id)
934
1111
        result = super(WeaveFile, self)._add_lines(version_id, parents, lines,
935
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
936
 
            check_content)
 
1112
                                                   parent_texts)
937
1113
        self._save()
938
1114
        return result
939
1115
 
 
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
 
940
1121
    def copy_to(self, name, transport):
941
1122
        """See VersionedFile.copy_to()."""
942
1123
        # as we are all in memory always, just serialise to the new place.
943
1124
        sio = StringIO()
944
1125
        write_weave_v5(self, sio)
945
1126
        sio.seek(0)
946
 
        transport.put_file(name + WeaveFile.WEAVE_SUFFIX, sio, self._filemode)
 
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)
947
1131
 
948
1132
    def _save(self):
949
1133
        """Save the weave."""
951
1135
        sio = StringIO()
952
1136
        write_weave_v5(self, sio)
953
1137
        sio.seek(0)
954
 
        bytes = sio.getvalue()
955
 
        path = self._weave_name + WeaveFile.WEAVE_SUFFIX
956
 
        try:
957
 
            self._transport.put_bytes(path, bytes, self._filemode)
958
 
        except errors.NoSuchFile:
959
 
            self._transport.mkdir(dirname(path))
960
 
            self._transport.put_bytes(path, bytes, self._filemode)
 
1138
        self._transport.put(self._weave_name + WeaveFile.WEAVE_SUFFIX,
 
1139
                            sio,
 
1140
                            self._filemode)
961
1141
 
962
1142
    @staticmethod
963
1143
    def get_suffixes():
964
1144
        """See VersionedFile.get_suffixes()."""
965
1145
        return [WeaveFile.WEAVE_SUFFIX]
966
1146
 
967
 
    def insert_record_stream(self, stream):
968
 
        super(WeaveFile, self).insert_record_stream(stream)
 
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)
969
1151
        self._save()
970
1152
 
971
1153
 
 
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
 
972
1159
def _reweave(wa, wb, pb=None, msg=None):
973
1160
    """Combine two weaves and return the result.
974
1161
 
975
 
    This works even if a revision R has different parents in
 
1162
    This works even if a revision R has different parents in 
976
1163
    wa and wb.  In the resulting weave all the parents are given.
977
1164
 
978
 
    This is done by just building up a new weave, maintaining ordering
 
1165
    This is done by just building up a new weave, maintaining ordering 
979
1166
    of the versions in the two inputs.  More efficient approaches
980
 
    might be possible but it should only be necessary to do
981
 
    this operation rarely, when a new previously ghost version is
 
1167
    might be possible but it should only be necessary to do 
 
1168
    this operation rarely, when a new previously ghost version is 
982
1169
    inserted.
983
1170
 
984
1171
    :param pb: An optional progress bar, indicating how far done we are
992
1179
    # map from version name -> all parent names
993
1180
    combined_parents = _reweave_parent_graphs(wa, wb)
994
1181
    mutter("combined parents: %r", combined_parents)
995
 
    order = tsort.topo_sort(combined_parents.iteritems())
 
1182
    order = topo_sort(combined_parents.iteritems())
996
1183
    mutter("order to reweave: %r", order)
997
1184
 
998
1185
    if pb and not msg:
1018
1205
        wr._add(name, lines, [wr._lookup(i) for i in combined_parents[name]])
1019
1206
    return wr
1020
1207
 
1021
 
 
1022
1208
def _reweave_parent_graphs(wa, wb):
1023
1209
    """Return combined parent ancestry for two weaves.
1024
 
 
 
1210
    
1025
1211
    Returned as a list of (version_name, set(parent_names))"""
1026
1212
    combined = {}
1027
1213
    for weave in [wa, wb]:
1029
1215
            p = combined.setdefault(name, set())
1030
1216
            p.update(map(weave._idx_to_name, weave._parents[idx]))
1031
1217
    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)