~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: John Arbash Meinel
  • Date: 2006-06-19 14:40:19 UTC
  • mto: This revision was merged to the branch mainline in revision 1794.
  • Revision ID: john@arbash-meinel.com-20060619144019-873a4a8d252f7896
Refactor import stuff into separate functions. Update news

Show diffs side-by-side

added added

removed removed

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