1
# Copyright (C) 2005, 2006 Canonical Ltd
4
# Johan Rydberg <jrydberg@gnu.org>
6
# This program is free software; you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation; either version 2 of the License, or
9
# (at your option) any later version.
11
# This program is distributed in the hope that it will be useful,
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
# GNU General Public License for more details.
16
# You should have received a copy of the GNU General Public License
17
# along with this program; if not, write to the Free Software
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
"""Versioned text file storage api."""
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
33
from bzrlib.graph import Graph
34
from bzrlib.transport.memory import MemoryTransport
37
from cStringIO import StringIO
39
from bzrlib.inter import InterObject
40
from bzrlib.registry import Registry
41
from bzrlib.symbol_versioning import *
42
from bzrlib.textmerge import TextMerge
45
adapter_registry = Registry()
46
adapter_registry.register_lazy(('knit-delta-gz', 'fulltext'), 'bzrlib.knit',
47
'DeltaPlainToFullText')
48
adapter_registry.register_lazy(('knit-ft-gz', 'fulltext'), 'bzrlib.knit',
50
adapter_registry.register_lazy(('knit-annotated-delta-gz', 'knit-delta-gz'),
51
'bzrlib.knit', 'DeltaAnnotatedToUnannotated')
52
adapter_registry.register_lazy(('knit-annotated-delta-gz', 'fulltext'),
53
'bzrlib.knit', 'DeltaAnnotatedToFullText')
54
adapter_registry.register_lazy(('knit-annotated-ft-gz', 'knit-ft-gz'),
55
'bzrlib.knit', 'FTAnnotatedToUnannotated')
56
adapter_registry.register_lazy(('knit-annotated-ft-gz', 'fulltext'),
57
'bzrlib.knit', 'FTAnnotatedToFullText')
60
class ContentFactory(object):
61
"""Abstract interface for insertion and retrieval from a VersionedFile.
63
:ivar sha1: None, or the sha1 of the content fulltext.
64
:ivar storage_kind: The native storage kind of this factory. One of
65
'mpdiff', 'knit-annotated-ft', 'knit-annotated-delta', 'knit-ft',
66
'knit-delta', 'fulltext', 'knit-annotated-ft-gz',
67
'knit-annotated-delta-gz', 'knit-ft-gz', 'knit-delta-gz'.
68
:ivar key: The key of this content. Each key is a tuple with a single
70
:ivar parents: A tuple of parent keys for self.key. If the object has
71
no parent information, None (as opposed to () for an empty list of
76
"""Create a ContentFactory."""
78
self.storage_kind = None
83
class AbsentContentFactory(object):
84
"""A placeholder content factory for unavailable texts.
87
:ivar storage_kind: 'absent'.
88
:ivar key: The key of this content. Each key is a tuple with a single
93
def __init__(self, key):
94
"""Create a ContentFactory."""
96
self.storage_kind = 'absent'
101
class VersionedFile(object):
102
"""Versioned text file storage.
104
A versioned file manages versions of line-based text files,
105
keeping track of the originating version for each line.
107
To clients the "lines" of the file are represented as a list of
108
strings. These strings will typically have terminal newline
109
characters, but this is not required. In particular files commonly
110
do not have a newline at the end of the file.
112
Texts are identified by a version-id string.
116
def check_not_reserved_id(version_id):
117
revision.check_not_reserved_id(version_id)
119
def copy_to(self, name, transport):
120
"""Copy this versioned file to name on transport."""
121
raise NotImplementedError(self.copy_to)
123
def get_record_stream(self, versions, ordering, include_delta_closure):
124
"""Get a stream of records for versions.
126
:param versions: The versions to include. Each version is a tuple
128
:param ordering: Either 'unordered' or 'topological'. A topologically
129
sorted stream has compression parents strictly before their
131
:param include_delta_closure: If True then the closure across any
132
compression parents will be included (in the opaque data).
133
:return: An iterator of ContentFactory objects, each of which is only
134
valid until the iterator is advanced.
136
raise NotImplementedError(self.get_record_stream)
138
@deprecated_method(one_four)
139
def has_ghost(self, version_id):
140
"""Returns whether version is present as a ghost."""
141
raise NotImplementedError(self.has_ghost)
143
def has_version(self, version_id):
144
"""Returns whether version is present."""
145
raise NotImplementedError(self.has_version)
147
def insert_record_stream(self, stream):
148
"""Insert a record stream into this versioned file.
150
:param stream: A stream of records to insert.
152
:seealso VersionedFile.get_record_stream:
154
raise NotImplementedError
156
def add_lines(self, version_id, parents, lines, parent_texts=None,
157
left_matching_blocks=None, nostore_sha=None, random_id=False,
159
"""Add a single text on top of the versioned file.
161
Must raise RevisionAlreadyPresent if the new version is
162
already present in file history.
164
Must raise RevisionNotPresent if any of the given parents are
165
not present in file history.
167
:param lines: A list of lines. Each line must be a bytestring. And all
168
of them except the last must be terminated with \n and contain no
169
other \n's. The last line may either contain no \n's or a single
170
terminated \n. If the lines list does meet this constraint the add
171
routine may error or may succeed - but you will be unable to read
172
the data back accurately. (Checking the lines have been split
173
correctly is expensive and extremely unlikely to catch bugs so it
174
is not done at runtime unless check_content is True.)
175
:param parent_texts: An optional dictionary containing the opaque
176
representations of some or all of the parents of version_id to
177
allow delta optimisations. VERY IMPORTANT: the texts must be those
178
returned by add_lines or data corruption can be caused.
179
:param left_matching_blocks: a hint about which areas are common
180
between the text and its left-hand-parent. The format is
181
the SequenceMatcher.get_matching_blocks format.
182
:param nostore_sha: Raise ExistingContent and do not add the lines to
183
the versioned file if the digest of the lines matches this.
184
:param random_id: If True a random id has been selected rather than
185
an id determined by some deterministic process such as a converter
186
from a foreign VCS. When True the backend may choose not to check
187
for uniqueness of the resulting key within the versioned file, so
188
this should only be done when the result is expected to be unique
190
:param check_content: If True, the lines supplied are verified to be
191
bytestrings that are correctly formed lines.
192
:return: The text sha1, the number of bytes in the text, and an opaque
193
representation of the inserted version which can be provided
194
back to future add_lines calls in the parent_texts dictionary.
196
self._check_write_ok()
197
return self._add_lines(version_id, parents, lines, parent_texts,
198
left_matching_blocks, nostore_sha, random_id, check_content)
200
def _add_lines(self, version_id, parents, lines, parent_texts,
201
left_matching_blocks, nostore_sha, random_id, check_content):
202
"""Helper to do the class specific add_lines."""
203
raise NotImplementedError(self.add_lines)
205
def add_lines_with_ghosts(self, version_id, parents, lines,
206
parent_texts=None, nostore_sha=None, random_id=False,
207
check_content=True, left_matching_blocks=None):
208
"""Add lines to the versioned file, allowing ghosts to be present.
210
This takes the same parameters as add_lines and returns the same.
212
self._check_write_ok()
213
return self._add_lines_with_ghosts(version_id, parents, lines,
214
parent_texts, nostore_sha, random_id, check_content, left_matching_blocks)
216
def _add_lines_with_ghosts(self, version_id, parents, lines, parent_texts,
217
nostore_sha, random_id, check_content, left_matching_blocks):
218
"""Helper to do class specific add_lines_with_ghosts."""
219
raise NotImplementedError(self.add_lines_with_ghosts)
221
def check(self, progress_bar=None):
222
"""Check the versioned file for integrity."""
223
raise NotImplementedError(self.check)
225
def _check_lines_not_unicode(self, lines):
226
"""Check that lines being added to a versioned file are not unicode."""
228
if line.__class__ is not str:
229
raise errors.BzrBadParameterUnicode("lines")
231
def _check_lines_are_lines(self, lines):
232
"""Check that the lines really are full lines without inline EOL."""
234
if '\n' in line[:-1]:
235
raise errors.BzrBadParameterContainsNewline("lines")
237
@deprecated_method(one_four)
238
def enable_cache(self):
239
"""Tell this versioned file that it should cache any data it reads.
241
This is advisory, implementations do not have to support caching.
245
@deprecated_method(one_four)
246
def clear_cache(self):
247
"""Remove any data cached in the versioned file object.
249
This only needs to be supported if caches are supported
253
@deprecated_method(one_four)
254
def clone_text(self, new_version_id, old_version_id, parents):
255
"""Add an identical text to old_version_id as new_version_id.
257
Must raise RevisionNotPresent if the old version or any of the
258
parents are not present in file history.
260
Must raise RevisionAlreadyPresent if the new version is
261
already present in file history."""
262
self._check_write_ok()
263
return self.add_lines(new_version_id, parents,
264
self.get_lines(old_version_id))
266
def get_format_signature(self):
267
"""Get a text description of the data encoding in this file.
271
raise NotImplementedError(self.get_format_signature)
273
def make_mpdiffs(self, version_ids):
274
"""Create multiparent diffs for specified versions."""
275
knit_versions = set()
276
knit_versions.update(version_ids)
277
parent_map = self.get_parent_map(version_ids)
278
for version_id in version_ids:
280
knit_versions.update(parent_map[version_id])
282
raise RevisionNotPresent(version_id, self)
283
# We need to filter out ghosts, because we can't diff against them.
284
knit_versions = set(self.get_parent_map(knit_versions).keys())
285
lines = dict(zip(knit_versions,
286
self._get_lf_split_line_list(knit_versions)))
288
for version_id in version_ids:
289
target = lines[version_id]
291
parents = [lines[p] for p in parent_map[version_id] if p in
294
raise RevisionNotPresent(version_id, self)
296
left_parent_blocks = self._extract_blocks(version_id,
299
left_parent_blocks = None
300
diffs.append(multiparent.MultiParent.from_lines(target, parents,
304
def _extract_blocks(self, version_id, source, target):
307
def add_mpdiffs(self, records):
308
"""Add mpdiffs to this VersionedFile.
310
Records should be iterables of version, parents, expected_sha1,
311
mpdiff. mpdiff should be a MultiParent instance.
313
# Does this need to call self._check_write_ok()? (IanC 20070919)
315
mpvf = multiparent.MultiMemoryVersionedFile()
317
for version, parent_ids, expected_sha1, mpdiff in records:
318
versions.append(version)
319
mpvf.add_diff(mpdiff, version, parent_ids)
320
needed_parents = set()
321
for version, parent_ids, expected_sha1, mpdiff in records:
322
needed_parents.update(p for p in parent_ids
323
if not mpvf.has_version(p))
324
present_parents = set(self.get_parent_map(needed_parents).keys())
325
for parent_id, lines in zip(present_parents,
326
self._get_lf_split_line_list(present_parents)):
327
mpvf.add_version(lines, parent_id, [])
328
for (version, parent_ids, expected_sha1, mpdiff), lines in\
329
zip(records, mpvf.get_line_list(versions)):
330
if len(parent_ids) == 1:
331
left_matching_blocks = list(mpdiff.get_matching_blocks(0,
332
mpvf.get_diff(parent_ids[0]).num_lines()))
334
left_matching_blocks = None
336
_, _, version_text = self.add_lines_with_ghosts(version,
337
parent_ids, lines, vf_parents,
338
left_matching_blocks=left_matching_blocks)
339
except NotImplementedError:
340
# The vf can't handle ghosts, so add lines normally, which will
341
# (reasonably) fail if there are ghosts in the data.
342
_, _, version_text = self.add_lines(version,
343
parent_ids, lines, vf_parents,
344
left_matching_blocks=left_matching_blocks)
345
vf_parents[version] = version_text
346
for (version, parent_ids, expected_sha1, mpdiff), sha1 in\
347
zip(records, self.get_sha1s(versions)):
348
if expected_sha1 != sha1:
349
raise errors.VersionedFileInvalidChecksum(version)
351
@deprecated_method(one_four)
352
def get_sha1(self, version_id):
353
"""Get the stored sha1 sum for the given revision.
355
:param version_id: The name of the version to lookup
357
return self.get_sha1s([version_id])[0]
359
def get_sha1s(self, version_ids):
360
"""Get the stored sha1 sums for the given revisions.
362
:param version_ids: The names of the versions to lookup
363
:return: a list of sha1s in order according to the version_ids
365
raise NotImplementedError(self.get_sha1s)
367
def get_text(self, version_id):
368
"""Return version contents as a text string.
370
Raises RevisionNotPresent if version is not present in
373
return ''.join(self.get_lines(version_id))
374
get_string = get_text
376
def get_texts(self, version_ids):
377
"""Return the texts of listed versions as a list of strings.
379
Raises RevisionNotPresent if version is not present in
382
return [''.join(self.get_lines(v)) for v in version_ids]
384
def get_lines(self, version_id):
385
"""Return version contents as a sequence of lines.
387
Raises RevisionNotPresent if version is not present in
390
raise NotImplementedError(self.get_lines)
392
def _get_lf_split_line_list(self, version_ids):
393
return [StringIO(t).readlines() for t in self.get_texts(version_ids)]
395
def get_ancestry(self, version_ids, topo_sorted=True):
396
"""Return a list of all ancestors of given version(s). This
397
will not include the null revision.
399
This list will not be topologically sorted if topo_sorted=False is
402
Must raise RevisionNotPresent if any of the given versions are
403
not present in file history."""
404
if isinstance(version_ids, basestring):
405
version_ids = [version_ids]
406
raise NotImplementedError(self.get_ancestry)
408
def get_ancestry_with_ghosts(self, version_ids):
409
"""Return a list of all ancestors of given version(s). This
410
will not include the null revision.
412
Must raise RevisionNotPresent if any of the given versions are
413
not present in file history.
415
Ghosts that are known about will be included in ancestry list,
416
but are not explicitly marked.
418
raise NotImplementedError(self.get_ancestry_with_ghosts)
420
@deprecated_method(one_four)
421
def get_graph(self, version_ids=None):
422
"""Return a graph from the versioned file.
424
Ghosts are not listed or referenced in the graph.
425
:param version_ids: Versions to select.
426
None means retrieve all versions.
428
if version_ids is None:
429
result = self.get_parent_map(self.versions())
432
pending = set(version_ids)
434
this_iteration = pending
436
parents = self.get_parent_map(this_iteration)
437
for version, parents in parents.iteritems():
438
result[version] = parents
439
for parent in parents:
444
for parents in result.itervalues():
445
references.update(parents)
446
existing_parents = self.get_parent_map(references)
447
for key, parents in result.iteritems():
448
present_parents = [parent for parent in parents if parent in
450
result[key] = tuple(present_parents)
453
@deprecated_method(one_four)
454
def get_graph_with_ghosts(self):
455
"""Return a graph for the entire versioned file.
457
Ghosts are referenced in parents list but are not
460
raise NotImplementedError(self.get_graph_with_ghosts)
462
def get_parent_map(self, version_ids):
463
"""Get a map of the parents of version_ids.
465
:param version_ids: The version ids to look up parents for.
466
:return: A mapping from version id to parents.
468
raise NotImplementedError(self.get_parent_map)
470
@deprecated_method(one_four)
471
def get_parents(self, version_id):
472
"""Return version names for parents of a version.
474
Must raise RevisionNotPresent if version is not present in
478
all = self.get_parent_map([version_id])[version_id]
480
raise errors.RevisionNotPresent(version_id, self)
482
parent_parents = self.get_parent_map(all)
483
for version_id in all:
484
if version_id in parent_parents:
485
result.append(version_id)
488
def get_parents_with_ghosts(self, version_id):
489
"""Return version names for parents of version_id.
491
Will raise RevisionNotPresent if version_id is not present
494
Ghosts that are known about will be included in the parent list,
495
but are not explicitly marked.
498
return list(self.get_parent_map([version_id])[version_id])
500
raise errors.RevisionNotPresent(version_id, self)
502
@deprecated_method(one_four)
503
def annotate_iter(self, version_id):
504
"""Yield list of (version-id, line) pairs for the specified
507
Must raise RevisionNotPresent if the given version is
508
not present in file history.
510
return iter(self.annotate(version_id))
512
def annotate(self, version_id):
513
"""Return a list of (version-id, line) tuples for version_id.
515
:raise RevisionNotPresent: If the given version is
516
not present in file history.
518
raise NotImplementedError(self.annotate)
520
def join(self, other, pb=None, msg=None, version_ids=None,
521
ignore_missing=False):
522
"""Integrate versions from other into this versioned file.
524
If version_ids is None all versions from other should be
525
incorporated into this versioned file.
527
Must raise RevisionNotPresent if any of the specified versions
528
are not present in the other file's history unless ignore_missing
529
is supplied in which case they are silently skipped.
531
self._check_write_ok()
532
return InterVersionedFile.get(other, self).join(
538
def iter_lines_added_or_present_in_versions(self, version_ids=None,
540
"""Iterate over the lines in the versioned file from version_ids.
542
This may return lines from other versions. Each item the returned
543
iterator yields is a tuple of a line and a text version that that line
544
is present in (not introduced in).
546
Ordering of results is in whatever order is most suitable for the
547
underlying storage format.
549
If a progress bar is supplied, it may be used to indicate progress.
550
The caller is responsible for cleaning up progress bars (because this
553
NOTES: Lines are normalised: they will all have \n terminators.
554
Lines are returned in arbitrary order.
556
:return: An iterator over (line, version_id).
558
raise NotImplementedError(self.iter_lines_added_or_present_in_versions)
560
@deprecated_method(one_four)
561
def iter_parents(self, version_ids):
562
"""Iterate through the parents for many version ids.
564
:param version_ids: An iterable yielding version_ids.
565
:return: An iterator that yields (version_id, parents). Requested
566
version_ids not present in the versioned file are simply skipped.
567
The order is undefined, allowing for different optimisations in
568
the underlying implementation.
570
return self.get_parent_map(version_ids).iteritems()
572
def plan_merge(self, ver_a, ver_b):
573
"""Return pseudo-annotation indicating how the two versions merge.
575
This is computed between versions a and b and their common
578
Weave lines present in none of them are skipped entirely.
581
killed-base Dead in base revision
582
killed-both Killed in each revision
585
unchanged Alive in both a and b (possibly created in both)
588
ghost-a Killed in a, unborn in b
589
ghost-b Killed in b, unborn in a
590
irrelevant Not in either revision
592
raise NotImplementedError(VersionedFile.plan_merge)
594
def weave_merge(self, plan, a_marker=TextMerge.A_MARKER,
595
b_marker=TextMerge.B_MARKER):
596
return PlanWeaveMerge(plan, a_marker, b_marker).merge_lines()[0]
599
class RecordingVersionedFileDecorator(object):
600
"""A minimal versioned file that records calls made on it.
602
Only enough methods have been added to support tests using it to date.
604
:ivar calls: A list of the calls made; can be reset at any time by
608
def __init__(self, backing_vf):
609
"""Create a RecordingVersionedFileDecorator decorating backing_vf.
611
:param backing_vf: The versioned file to answer all methods.
613
self._backing_vf = backing_vf
616
def get_lines(self, version_ids):
617
self.calls.append(("get_lines", version_ids))
618
return self._backing_vf.get_lines(version_ids)
621
class _PlanMergeVersionedFile(object):
622
"""A VersionedFile for uncommitted and committed texts.
624
It is intended to allow merges to be planned with working tree texts.
625
It implements only the small part of the VersionedFile interface used by
626
PlanMerge. It falls back to multiple versionedfiles for data not stored in
627
_PlanMergeVersionedFile itself.
630
def __init__(self, file_id, fallback_versionedfiles=None):
633
:param file_id: Used when raising exceptions.
634
:param fallback_versionedfiles: If supplied, the set of fallbacks to
635
use. Otherwise, _PlanMergeVersionedFile.fallback_versionedfiles
636
can be appended to later.
638
self._file_id = file_id
639
if fallback_versionedfiles is None:
640
self.fallback_versionedfiles = []
642
self.fallback_versionedfiles = fallback_versionedfiles
646
def plan_merge(self, ver_a, ver_b, base=None):
647
"""See VersionedFile.plan_merge"""
648
from bzrlib.merge import _PlanMerge
650
return _PlanMerge(ver_a, ver_b, self).plan_merge()
651
old_plan = list(_PlanMerge(ver_a, base, self).plan_merge())
652
new_plan = list(_PlanMerge(ver_a, ver_b, self).plan_merge())
653
return _PlanMerge._subtract_plans(old_plan, new_plan)
655
def plan_lca_merge(self, ver_a, ver_b, base=None):
656
from bzrlib.merge import _PlanLCAMerge
657
graph = self._get_graph()
658
new_plan = _PlanLCAMerge(ver_a, ver_b, self, graph).plan_merge()
661
old_plan = _PlanLCAMerge(ver_a, base, self, graph).plan_merge()
662
return _PlanLCAMerge._subtract_plans(list(old_plan), list(new_plan))
664
def add_lines(self, version_id, parents, lines):
665
"""See VersionedFile.add_lines
667
Lines are added locally, not fallback versionedfiles. Also, ghosts are
668
permitted. Only reserved ids are permitted.
670
if not revision.is_reserved_id(version_id):
671
raise ValueError('Only reserved ids may be used')
673
raise ValueError('Parents may not be None')
675
raise ValueError('Lines may not be None')
676
self._parents[version_id] = tuple(parents)
677
self._lines[version_id] = lines
679
def get_lines(self, version_id):
680
"""See VersionedFile.get_ancestry"""
681
lines = self._lines.get(version_id)
682
if lines is not None:
684
for versionedfile in self.fallback_versionedfiles:
686
return versionedfile.get_lines(version_id)
687
except errors.RevisionNotPresent:
690
raise errors.RevisionNotPresent(version_id, self._file_id)
692
def get_ancestry(self, version_id, topo_sorted=False):
693
"""See VersionedFile.get_ancestry.
695
Note that this implementation assumes that if a VersionedFile can
696
answer get_ancestry at all, it can give an authoritative answer. In
697
fact, ghosts can invalidate this assumption. But it's good enough
698
99% of the time, and far cheaper/simpler.
700
Also note that the results of this version are never topologically
701
sorted, and are a set.
704
raise ValueError('This implementation does not provide sorting')
705
parents = self._parents.get(version_id)
707
for vf in self.fallback_versionedfiles:
709
return vf.get_ancestry(version_id, topo_sorted=False)
710
except errors.RevisionNotPresent:
713
raise errors.RevisionNotPresent(version_id, self._file_id)
714
ancestry = set([version_id])
715
for parent in parents:
716
ancestry.update(self.get_ancestry(parent, topo_sorted=False))
719
def get_parent_map(self, version_ids):
720
"""See VersionedFile.get_parent_map"""
722
pending = set(version_ids)
723
for key in version_ids:
725
result[key] = self._parents[key]
728
pending = pending - set(result.keys())
729
for versionedfile in self.fallback_versionedfiles:
730
parents = versionedfile.get_parent_map(pending)
731
result.update(parents)
732
pending = pending - set(parents.keys())
737
def _get_graph(self):
738
from bzrlib.graph import (
741
_StackedParentsProvider,
743
from bzrlib.repofmt.knitrepo import _KnitParentsProvider
744
parent_providers = [DictParentsProvider(self._parents)]
745
for vf in self.fallback_versionedfiles:
746
parent_providers.append(_KnitParentsProvider(vf))
747
return Graph(_StackedParentsProvider(parent_providers))
750
class PlanWeaveMerge(TextMerge):
751
"""Weave merge that takes a plan as its input.
753
This exists so that VersionedFile.plan_merge is implementable.
754
Most callers will want to use WeaveMerge instead.
757
def __init__(self, plan, a_marker=TextMerge.A_MARKER,
758
b_marker=TextMerge.B_MARKER):
759
TextMerge.__init__(self, a_marker, b_marker)
762
def _merge_struct(self):
767
def outstanding_struct():
768
if not lines_a and not lines_b:
770
elif ch_a and not ch_b:
773
elif ch_b and not ch_a:
775
elif lines_a == lines_b:
778
yield (lines_a, lines_b)
780
# We previously considered either 'unchanged' or 'killed-both' lines
781
# to be possible places to resynchronize. However, assuming agreement
782
# on killed-both lines may be too aggressive. -- mbp 20060324
783
for state, line in self.plan:
784
if state == 'unchanged':
785
# resync and flush queued conflicts changes if any
786
for struct in outstanding_struct():
792
if state == 'unchanged':
795
elif state == 'killed-a':
798
elif state == 'killed-b':
801
elif state == 'new-a':
804
elif state == 'new-b':
807
elif state == 'conflicted-a':
810
elif state == 'conflicted-b':
814
assert state in ('irrelevant', 'ghost-a', 'ghost-b',
815
'killed-base', 'killed-both'), state
816
for struct in outstanding_struct():
820
class WeaveMerge(PlanWeaveMerge):
821
"""Weave merge that takes a VersionedFile and two versions as its input."""
823
def __init__(self, versionedfile, ver_a, ver_b,
824
a_marker=PlanWeaveMerge.A_MARKER, b_marker=PlanWeaveMerge.B_MARKER):
825
plan = versionedfile.plan_merge(ver_a, ver_b)
826
PlanWeaveMerge.__init__(self, plan, a_marker, b_marker)
829
class InterVersionedFile(InterObject):
830
"""This class represents operations taking place between two VersionedFiles.
832
Its instances have methods like join, and contain
833
references to the source and target versionedfiles these operations can be
836
Often we will provide convenience methods on 'versionedfile' which carry out
837
operations with another versionedfile - they will always forward to
838
InterVersionedFile.get(other).method_name(parameters).
842
"""The available optimised InterVersionedFile types."""
844
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
845
"""Integrate versions from self.source into self.target.
847
If version_ids is None all versions from source should be
848
incorporated into this versioned file.
850
Must raise RevisionNotPresent if any of the specified versions
851
are not present in the other file's history unless ignore_missing is
852
supplied in which case they are silently skipped.
855
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
856
graph = Graph(self.source)
857
search = graph._make_breadth_first_searcher(version_ids)
858
transitive_ids = set()
859
map(transitive_ids.update, list(search))
860
parent_map = self.source.get_parent_map(transitive_ids)
861
order = tsort.topo_sort(parent_map.items())
862
pb = ui.ui_factory.nested_progress_bar()
865
# TODO for incremental cross-format work:
866
# make a versioned file with the following content:
867
# all revisions we have been asked to join
868
# all their ancestors that are *not* in target already.
869
# the immediate parents of the above two sets, with
870
# empty parent lists - these versions are in target already
871
# and the incorrect version data will be ignored.
872
# TODO: for all ancestors that are present in target already,
873
# check them for consistent data, this requires moving sha1 from
875
# TODO: remove parent texts when they are not relevant any more for
876
# memory pressure reduction. RBC 20060313
877
# pb.update('Converting versioned data', 0, len(order))
879
for index, version in enumerate(order):
880
pb.update('Converting versioned data', index, total)
881
if version in target:
883
_, _, parent_text = target.add_lines(version,
885
self.source.get_lines(version),
886
parent_texts=parent_texts)
887
parent_texts[version] = parent_text
892
def _get_source_version_ids(self, version_ids, ignore_missing):
893
"""Determine the version ids to be used from self.source.
895
:param version_ids: The caller-supplied version ids to check. (None
896
for all). If None is in version_ids, it is stripped.
897
:param ignore_missing: if True, remove missing ids from the version
898
list. If False, raise RevisionNotPresent on
899
a missing version id.
900
:return: A set of version ids.
902
if version_ids is None:
903
# None cannot be in source.versions
904
return set(self.source.versions())
907
return set(self.source.versions()).intersection(set(version_ids))
909
new_version_ids = set()
910
for version in version_ids:
913
if not self.source.has_version(version):
914
raise errors.RevisionNotPresent(version, str(self.source))
916
new_version_ids.add(version)
917
return new_version_ids
added
removed
bzrlib/versionedfile.py
