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
def filter_absent(record_stream):
102
"""Adapt a record stream to remove absent records."""
103
for record in record_stream:
104
if record.storage_kind != 'absent':
108
class VersionedFile(object):
109
"""Versioned text file storage.
111
A versioned file manages versions of line-based text files,
112
keeping track of the originating version for each line.
114
To clients the "lines" of the file are represented as a list of
115
strings. These strings will typically have terminal newline
116
characters, but this is not required. In particular files commonly
117
do not have a newline at the end of the file.
119
Texts are identified by a version-id string.
123
def check_not_reserved_id(version_id):
124
revision.check_not_reserved_id(version_id)
126
def copy_to(self, name, transport):
127
"""Copy this versioned file to name on transport."""
128
raise NotImplementedError(self.copy_to)
130
def get_record_stream(self, versions, ordering, include_delta_closure):
131
"""Get a stream of records for versions.
133
:param versions: The versions to include. Each version is a tuple
135
:param ordering: Either 'unordered' or 'topological'. A topologically
136
sorted stream has compression parents strictly before their
138
:param include_delta_closure: If True then the closure across any
139
compression parents will be included (in the data content of the
140
stream, not in the emitted records). This guarantees that
141
'fulltext' can be used successfully on every record.
142
:return: An iterator of ContentFactory objects, each of which is only
143
valid until the iterator is advanced.
145
raise NotImplementedError(self.get_record_stream)
147
@deprecated_method(one_four)
148
def has_ghost(self, version_id):
149
"""Returns whether version is present as a ghost."""
150
raise NotImplementedError(self.has_ghost)
152
def has_version(self, version_id):
153
"""Returns whether version is present."""
154
raise NotImplementedError(self.has_version)
156
def insert_record_stream(self, stream):
157
"""Insert a record stream into this versioned file.
159
:param stream: A stream of records to insert.
161
:seealso VersionedFile.get_record_stream:
163
raise NotImplementedError
165
def add_lines(self, version_id, parents, lines, parent_texts=None,
166
left_matching_blocks=None, nostore_sha=None, random_id=False,
168
"""Add a single text on top of the versioned file.
170
Must raise RevisionAlreadyPresent if the new version is
171
already present in file history.
173
Must raise RevisionNotPresent if any of the given parents are
174
not present in file history.
176
:param lines: A list of lines. Each line must be a bytestring. And all
177
of them except the last must be terminated with \n and contain no
178
other \n's. The last line may either contain no \n's or a single
179
terminated \n. If the lines list does meet this constraint the add
180
routine may error or may succeed - but you will be unable to read
181
the data back accurately. (Checking the lines have been split
182
correctly is expensive and extremely unlikely to catch bugs so it
183
is not done at runtime unless check_content is True.)
184
:param parent_texts: An optional dictionary containing the opaque
185
representations of some or all of the parents of version_id to
186
allow delta optimisations. VERY IMPORTANT: the texts must be those
187
returned by add_lines or data corruption can be caused.
188
:param left_matching_blocks: a hint about which areas are common
189
between the text and its left-hand-parent. The format is
190
the SequenceMatcher.get_matching_blocks format.
191
:param nostore_sha: Raise ExistingContent and do not add the lines to
192
the versioned file if the digest of the lines matches this.
193
:param random_id: If True a random id has been selected rather than
194
an id determined by some deterministic process such as a converter
195
from a foreign VCS. When True the backend may choose not to check
196
for uniqueness of the resulting key within the versioned file, so
197
this should only be done when the result is expected to be unique
199
:param check_content: If True, the lines supplied are verified to be
200
bytestrings that are correctly formed lines.
201
:return: The text sha1, the number of bytes in the text, and an opaque
202
representation of the inserted version which can be provided
203
back to future add_lines calls in the parent_texts dictionary.
205
self._check_write_ok()
206
return self._add_lines(version_id, parents, lines, parent_texts,
207
left_matching_blocks, nostore_sha, random_id, check_content)
209
def _add_lines(self, version_id, parents, lines, parent_texts,
210
left_matching_blocks, nostore_sha, random_id, check_content):
211
"""Helper to do the class specific add_lines."""
212
raise NotImplementedError(self.add_lines)
214
def add_lines_with_ghosts(self, version_id, parents, lines,
215
parent_texts=None, nostore_sha=None, random_id=False,
216
check_content=True, left_matching_blocks=None):
217
"""Add lines to the versioned file, allowing ghosts to be present.
219
This takes the same parameters as add_lines and returns the same.
221
self._check_write_ok()
222
return self._add_lines_with_ghosts(version_id, parents, lines,
223
parent_texts, nostore_sha, random_id, check_content, left_matching_blocks)
225
def _add_lines_with_ghosts(self, version_id, parents, lines, parent_texts,
226
nostore_sha, random_id, check_content, left_matching_blocks):
227
"""Helper to do class specific add_lines_with_ghosts."""
228
raise NotImplementedError(self.add_lines_with_ghosts)
230
def check(self, progress_bar=None):
231
"""Check the versioned file for integrity."""
232
raise NotImplementedError(self.check)
234
def _check_lines_not_unicode(self, lines):
235
"""Check that lines being added to a versioned file are not unicode."""
237
if line.__class__ is not str:
238
raise errors.BzrBadParameterUnicode("lines")
240
def _check_lines_are_lines(self, lines):
241
"""Check that the lines really are full lines without inline EOL."""
243
if '\n' in line[:-1]:
244
raise errors.BzrBadParameterContainsNewline("lines")
246
@deprecated_method(one_four)
247
def enable_cache(self):
248
"""Tell this versioned file that it should cache any data it reads.
250
This is advisory, implementations do not have to support caching.
254
@deprecated_method(one_four)
255
def clear_cache(self):
256
"""Remove any data cached in the versioned file object.
258
This only needs to be supported if caches are supported
262
@deprecated_method(one_four)
263
def clone_text(self, new_version_id, old_version_id, parents):
264
"""Add an identical text to old_version_id as new_version_id.
266
Must raise RevisionNotPresent if the old version or any of the
267
parents are not present in file history.
269
Must raise RevisionAlreadyPresent if the new version is
270
already present in file history."""
271
self._check_write_ok()
272
return self.add_lines(new_version_id, parents,
273
self.get_lines(old_version_id))
275
def get_format_signature(self):
276
"""Get a text description of the data encoding in this file.
280
raise NotImplementedError(self.get_format_signature)
282
def make_mpdiffs(self, version_ids):
283
"""Create multiparent diffs for specified versions."""
284
knit_versions = set()
285
knit_versions.update(version_ids)
286
parent_map = self.get_parent_map(version_ids)
287
for version_id in version_ids:
289
knit_versions.update(parent_map[version_id])
291
raise RevisionNotPresent(version_id, self)
292
# We need to filter out ghosts, because we can't diff against them.
293
knit_versions = set(self.get_parent_map(knit_versions).keys())
294
lines = dict(zip(knit_versions,
295
self._get_lf_split_line_list(knit_versions)))
297
for version_id in version_ids:
298
target = lines[version_id]
300
parents = [lines[p] for p in parent_map[version_id] if p in
303
raise RevisionNotPresent(version_id, self)
305
left_parent_blocks = self._extract_blocks(version_id,
308
left_parent_blocks = None
309
diffs.append(multiparent.MultiParent.from_lines(target, parents,
313
def _extract_blocks(self, version_id, source, target):
316
def add_mpdiffs(self, records):
317
"""Add mpdiffs to this VersionedFile.
319
Records should be iterables of version, parents, expected_sha1,
320
mpdiff. mpdiff should be a MultiParent instance.
322
# Does this need to call self._check_write_ok()? (IanC 20070919)
324
mpvf = multiparent.MultiMemoryVersionedFile()
326
for version, parent_ids, expected_sha1, mpdiff in records:
327
versions.append(version)
328
mpvf.add_diff(mpdiff, version, parent_ids)
329
needed_parents = set()
330
for version, parent_ids, expected_sha1, mpdiff in records:
331
needed_parents.update(p for p in parent_ids
332
if not mpvf.has_version(p))
333
present_parents = set(self.get_parent_map(needed_parents).keys())
334
for parent_id, lines in zip(present_parents,
335
self._get_lf_split_line_list(present_parents)):
336
mpvf.add_version(lines, parent_id, [])
337
for (version, parent_ids, expected_sha1, mpdiff), lines in\
338
zip(records, mpvf.get_line_list(versions)):
339
if len(parent_ids) == 1:
340
left_matching_blocks = list(mpdiff.get_matching_blocks(0,
341
mpvf.get_diff(parent_ids[0]).num_lines()))
343
left_matching_blocks = None
345
_, _, version_text = self.add_lines_with_ghosts(version,
346
parent_ids, lines, vf_parents,
347
left_matching_blocks=left_matching_blocks)
348
except NotImplementedError:
349
# The vf can't handle ghosts, so add lines normally, which will
350
# (reasonably) fail if there are ghosts in the data.
351
_, _, version_text = self.add_lines(version,
352
parent_ids, lines, vf_parents,
353
left_matching_blocks=left_matching_blocks)
354
vf_parents[version] = version_text
355
for (version, parent_ids, expected_sha1, mpdiff), sha1 in\
356
zip(records, self.get_sha1s(versions)):
357
if expected_sha1 != sha1:
358
raise errors.VersionedFileInvalidChecksum(version)
360
@deprecated_method(one_four)
361
def get_sha1(self, version_id):
362
"""Get the stored sha1 sum for the given revision.
364
:param version_id: The name of the version to lookup
366
return self.get_sha1s([version_id])[0]
368
def get_sha1s(self, version_ids):
369
"""Get the stored sha1 sums for the given revisions.
371
:param version_ids: The names of the versions to lookup
372
:return: a list of sha1s in order according to the version_ids
374
raise NotImplementedError(self.get_sha1s)
376
def get_text(self, version_id):
377
"""Return version contents as a text string.
379
Raises RevisionNotPresent if version is not present in
382
return ''.join(self.get_lines(version_id))
383
get_string = get_text
385
def get_texts(self, version_ids):
386
"""Return the texts of listed versions as a list of strings.
388
Raises RevisionNotPresent if version is not present in
391
return [''.join(self.get_lines(v)) for v in version_ids]
393
def get_lines(self, version_id):
394
"""Return version contents as a sequence of lines.
396
Raises RevisionNotPresent if version is not present in
399
raise NotImplementedError(self.get_lines)
401
def _get_lf_split_line_list(self, version_ids):
402
return [StringIO(t).readlines() for t in self.get_texts(version_ids)]
404
def get_ancestry(self, version_ids, topo_sorted=True):
405
"""Return a list of all ancestors of given version(s). This
406
will not include the null revision.
408
This list will not be topologically sorted if topo_sorted=False is
411
Must raise RevisionNotPresent if any of the given versions are
412
not present in file history."""
413
if isinstance(version_ids, basestring):
414
version_ids = [version_ids]
415
raise NotImplementedError(self.get_ancestry)
417
def get_ancestry_with_ghosts(self, version_ids):
418
"""Return a list of all ancestors of given version(s). This
419
will not include the null revision.
421
Must raise RevisionNotPresent if any of the given versions are
422
not present in file history.
424
Ghosts that are known about will be included in ancestry list,
425
but are not explicitly marked.
427
raise NotImplementedError(self.get_ancestry_with_ghosts)
429
@deprecated_method(one_four)
430
def get_graph(self, version_ids=None):
431
"""Return a graph from the versioned file.
433
Ghosts are not listed or referenced in the graph.
434
:param version_ids: Versions to select.
435
None means retrieve all versions.
437
if version_ids is None:
438
result = self.get_parent_map(self.versions())
441
pending = set(version_ids)
443
this_iteration = pending
445
parents = self.get_parent_map(this_iteration)
446
for version, parents in parents.iteritems():
447
result[version] = parents
448
for parent in parents:
453
for parents in result.itervalues():
454
references.update(parents)
455
existing_parents = self.get_parent_map(references)
456
for key, parents in result.iteritems():
457
present_parents = [parent for parent in parents if parent in
459
result[key] = tuple(present_parents)
462
@deprecated_method(one_four)
463
def get_graph_with_ghosts(self):
464
"""Return a graph for the entire versioned file.
466
Ghosts are referenced in parents list but are not
469
raise NotImplementedError(self.get_graph_with_ghosts)
471
def get_parent_map(self, version_ids):
472
"""Get a map of the parents of version_ids.
474
:param version_ids: The version ids to look up parents for.
475
:return: A mapping from version id to parents.
477
raise NotImplementedError(self.get_parent_map)
479
@deprecated_method(one_four)
480
def get_parents(self, version_id):
481
"""Return version names for parents of a version.
483
Must raise RevisionNotPresent if version is not present in
487
all = self.get_parent_map([version_id])[version_id]
489
raise errors.RevisionNotPresent(version_id, self)
491
parent_parents = self.get_parent_map(all)
492
for version_id in all:
493
if version_id in parent_parents:
494
result.append(version_id)
497
def get_parents_with_ghosts(self, version_id):
498
"""Return version names for parents of version_id.
500
Will raise RevisionNotPresent if version_id is not present
503
Ghosts that are known about will be included in the parent list,
504
but are not explicitly marked.
507
return list(self.get_parent_map([version_id])[version_id])
509
raise errors.RevisionNotPresent(version_id, self)
511
@deprecated_method(one_four)
512
def annotate_iter(self, version_id):
513
"""Yield list of (version-id, line) pairs for the specified
516
Must raise RevisionNotPresent if the given version is
517
not present in file history.
519
return iter(self.annotate(version_id))
521
def annotate(self, version_id):
522
"""Return a list of (version-id, line) tuples for version_id.
524
:raise RevisionNotPresent: If the given version is
525
not present in file history.
527
raise NotImplementedError(self.annotate)
529
@deprecated_method(one_five)
530
def join(self, other, pb=None, msg=None, version_ids=None,
531
ignore_missing=False):
532
"""Integrate versions from other into this versioned file.
534
If version_ids is None all versions from other should be
535
incorporated into this versioned file.
537
Must raise RevisionNotPresent if any of the specified versions
538
are not present in the other file's history unless ignore_missing
539
is supplied in which case they are silently skipped.
541
self._check_write_ok()
542
return InterVersionedFile.get(other, self).join(
548
def iter_lines_added_or_present_in_versions(self, version_ids=None,
550
"""Iterate over the lines in the versioned file from version_ids.
552
This may return lines from other versions. Each item the returned
553
iterator yields is a tuple of a line and a text version that that line
554
is present in (not introduced in).
556
Ordering of results is in whatever order is most suitable for the
557
underlying storage format.
559
If a progress bar is supplied, it may be used to indicate progress.
560
The caller is responsible for cleaning up progress bars (because this
563
NOTES: Lines are normalised: they will all have \n terminators.
564
Lines are returned in arbitrary order.
566
:return: An iterator over (line, version_id).
568
raise NotImplementedError(self.iter_lines_added_or_present_in_versions)
570
@deprecated_method(one_four)
571
def iter_parents(self, version_ids):
572
"""Iterate through the parents for many version ids.
574
:param version_ids: An iterable yielding version_ids.
575
:return: An iterator that yields (version_id, parents). Requested
576
version_ids not present in the versioned file are simply skipped.
577
The order is undefined, allowing for different optimisations in
578
the underlying implementation.
580
return self.get_parent_map(version_ids).iteritems()
582
def plan_merge(self, ver_a, ver_b):
583
"""Return pseudo-annotation indicating how the two versions merge.
585
This is computed between versions a and b and their common
588
Weave lines present in none of them are skipped entirely.
591
killed-base Dead in base revision
592
killed-both Killed in each revision
595
unchanged Alive in both a and b (possibly created in both)
598
ghost-a Killed in a, unborn in b
599
ghost-b Killed in b, unborn in a
600
irrelevant Not in either revision
602
raise NotImplementedError(VersionedFile.plan_merge)
604
def weave_merge(self, plan, a_marker=TextMerge.A_MARKER,
605
b_marker=TextMerge.B_MARKER):
606
return PlanWeaveMerge(plan, a_marker, b_marker).merge_lines()[0]
609
class RecordingVersionedFileDecorator(object):
610
"""A minimal versioned file that records calls made on it.
612
Only enough methods have been added to support tests using it to date.
614
:ivar calls: A list of the calls made; can be reset at any time by
618
def __init__(self, backing_vf):
619
"""Create a RecordingVersionedFileDecorator decorating backing_vf.
621
:param backing_vf: The versioned file to answer all methods.
623
self._backing_vf = backing_vf
626
def get_lines(self, version_ids):
627
self.calls.append(("get_lines", version_ids))
628
return self._backing_vf.get_lines(version_ids)
631
class _PlanMergeVersionedFile(object):
632
"""A VersionedFile for uncommitted and committed texts.
634
It is intended to allow merges to be planned with working tree texts.
635
It implements only the small part of the VersionedFile interface used by
636
PlanMerge. It falls back to multiple versionedfiles for data not stored in
637
_PlanMergeVersionedFile itself.
640
def __init__(self, file_id, fallback_versionedfiles=None):
643
:param file_id: Used when raising exceptions.
644
:param fallback_versionedfiles: If supplied, the set of fallbacks to
645
use. Otherwise, _PlanMergeVersionedFile.fallback_versionedfiles
646
can be appended to later.
648
self._file_id = file_id
649
if fallback_versionedfiles is None:
650
self.fallback_versionedfiles = []
652
self.fallback_versionedfiles = fallback_versionedfiles
656
def plan_merge(self, ver_a, ver_b, base=None):
657
"""See VersionedFile.plan_merge"""
658
from bzrlib.merge import _PlanMerge
660
return _PlanMerge(ver_a, ver_b, self).plan_merge()
661
old_plan = list(_PlanMerge(ver_a, base, self).plan_merge())
662
new_plan = list(_PlanMerge(ver_a, ver_b, self).plan_merge())
663
return _PlanMerge._subtract_plans(old_plan, new_plan)
665
def plan_lca_merge(self, ver_a, ver_b, base=None):
666
from bzrlib.merge import _PlanLCAMerge
667
graph = self._get_graph()
668
new_plan = _PlanLCAMerge(ver_a, ver_b, self, graph).plan_merge()
671
old_plan = _PlanLCAMerge(ver_a, base, self, graph).plan_merge()
672
return _PlanLCAMerge._subtract_plans(list(old_plan), list(new_plan))
674
def add_lines(self, version_id, parents, lines):
675
"""See VersionedFile.add_lines
677
Lines are added locally, not fallback versionedfiles. Also, ghosts are
678
permitted. Only reserved ids are permitted.
680
if not revision.is_reserved_id(version_id):
681
raise ValueError('Only reserved ids may be used')
683
raise ValueError('Parents may not be None')
685
raise ValueError('Lines may not be None')
686
self._parents[version_id] = tuple(parents)
687
self._lines[version_id] = lines
689
def get_lines(self, version_id):
690
"""See VersionedFile.get_ancestry"""
691
lines = self._lines.get(version_id)
692
if lines is not None:
694
for versionedfile in self.fallback_versionedfiles:
696
return versionedfile.get_lines(version_id)
697
except errors.RevisionNotPresent:
700
raise errors.RevisionNotPresent(version_id, self._file_id)
702
def get_ancestry(self, version_id, topo_sorted=False):
703
"""See VersionedFile.get_ancestry.
705
Note that this implementation assumes that if a VersionedFile can
706
answer get_ancestry at all, it can give an authoritative answer. In
707
fact, ghosts can invalidate this assumption. But it's good enough
708
99% of the time, and far cheaper/simpler.
710
Also note that the results of this version are never topologically
711
sorted, and are a set.
714
raise ValueError('This implementation does not provide sorting')
715
parents = self._parents.get(version_id)
717
for vf in self.fallback_versionedfiles:
719
return vf.get_ancestry(version_id, topo_sorted=False)
720
except errors.RevisionNotPresent:
723
raise errors.RevisionNotPresent(version_id, self._file_id)
724
ancestry = set([version_id])
725
for parent in parents:
726
ancestry.update(self.get_ancestry(parent, topo_sorted=False))
729
def get_parent_map(self, version_ids):
730
"""See VersionedFile.get_parent_map"""
732
pending = set(version_ids)
733
for key in version_ids:
735
result[key] = self._parents[key]
738
pending = pending - set(result.keys())
739
for versionedfile in self.fallback_versionedfiles:
740
parents = versionedfile.get_parent_map(pending)
741
result.update(parents)
742
pending = pending - set(parents.keys())
747
def _get_graph(self):
748
from bzrlib.graph import (
751
_StackedParentsProvider,
753
from bzrlib.repofmt.knitrepo import _KnitParentsProvider
754
parent_providers = [DictParentsProvider(self._parents)]
755
for vf in self.fallback_versionedfiles:
756
parent_providers.append(_KnitParentsProvider(vf))
757
return Graph(_StackedParentsProvider(parent_providers))
760
class PlanWeaveMerge(TextMerge):
761
"""Weave merge that takes a plan as its input.
763
This exists so that VersionedFile.plan_merge is implementable.
764
Most callers will want to use WeaveMerge instead.
767
def __init__(self, plan, a_marker=TextMerge.A_MARKER,
768
b_marker=TextMerge.B_MARKER):
769
TextMerge.__init__(self, a_marker, b_marker)
772
def _merge_struct(self):
777
def outstanding_struct():
778
if not lines_a and not lines_b:
780
elif ch_a and not ch_b:
783
elif ch_b and not ch_a:
785
elif lines_a == lines_b:
788
yield (lines_a, lines_b)
790
# We previously considered either 'unchanged' or 'killed-both' lines
791
# to be possible places to resynchronize. However, assuming agreement
792
# on killed-both lines may be too aggressive. -- mbp 20060324
793
for state, line in self.plan:
794
if state == 'unchanged':
795
# resync and flush queued conflicts changes if any
796
for struct in outstanding_struct():
802
if state == 'unchanged':
805
elif state == 'killed-a':
808
elif state == 'killed-b':
811
elif state == 'new-a':
814
elif state == 'new-b':
817
elif state == 'conflicted-a':
820
elif state == 'conflicted-b':
824
if state not in ('irrelevant', 'ghost-a', 'ghost-b',
825
'killed-base', 'killed-both'):
826
raise AssertionError(state)
827
for struct in outstanding_struct():
831
class WeaveMerge(PlanWeaveMerge):
832
"""Weave merge that takes a VersionedFile and two versions as its input."""
834
def __init__(self, versionedfile, ver_a, ver_b,
835
a_marker=PlanWeaveMerge.A_MARKER, b_marker=PlanWeaveMerge.B_MARKER):
836
plan = versionedfile.plan_merge(ver_a, ver_b)
837
PlanWeaveMerge.__init__(self, plan, a_marker, b_marker)
840
class InterVersionedFile(InterObject):
841
"""This class represents operations taking place between two VersionedFiles.
843
Its instances have methods like join, and contain
844
references to the source and target versionedfiles these operations can be
847
Often we will provide convenience methods on 'versionedfile' which carry out
848
operations with another versionedfile - they will always forward to
849
InterVersionedFile.get(other).method_name(parameters).
853
"""The available optimised InterVersionedFile types."""
855
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
856
"""Integrate versions from self.source into self.target.
858
If version_ids is None all versions from source should be
859
incorporated into this versioned file.
861
Must raise RevisionNotPresent if any of the specified versions
862
are not present in the other file's history unless ignore_missing is
863
supplied in which case they are silently skipped.
866
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
867
graph = Graph(self.source)
868
search = graph._make_breadth_first_searcher(version_ids)
869
transitive_ids = set()
870
map(transitive_ids.update, list(search))
871
parent_map = self.source.get_parent_map(transitive_ids)
872
order = tsort.topo_sort(parent_map.items())
873
pb = ui.ui_factory.nested_progress_bar()
876
# TODO for incremental cross-format work:
877
# make a versioned file with the following content:
878
# all revisions we have been asked to join
879
# all their ancestors that are *not* in target already.
880
# the immediate parents of the above two sets, with
881
# empty parent lists - these versions are in target already
882
# and the incorrect version data will be ignored.
883
# TODO: for all ancestors that are present in target already,
884
# check them for consistent data, this requires moving sha1 from
886
# TODO: remove parent texts when they are not relevant any more for
887
# memory pressure reduction. RBC 20060313
888
# pb.update('Converting versioned data', 0, len(order))
890
for index, version in enumerate(order):
891
pb.update('Converting versioned data', index, total)
892
if version in target:
894
_, _, parent_text = target.add_lines(version,
896
self.source.get_lines(version),
897
parent_texts=parent_texts)
898
parent_texts[version] = parent_text
903
def _get_source_version_ids(self, version_ids, ignore_missing):
904
"""Determine the version ids to be used from self.source.
906
:param version_ids: The caller-supplied version ids to check. (None
907
for all). If None is in version_ids, it is stripped.
908
:param ignore_missing: if True, remove missing ids from the version
909
list. If False, raise RevisionNotPresent on
910
a missing version id.
911
:return: A set of version ids.
913
if version_ids is None:
914
# None cannot be in source.versions
915
return set(self.source.versions())
918
return set(self.source.versions()).intersection(set(version_ids))
920
new_version_ids = set()
921
for version in version_ids:
924
if not self.source.has_version(version):
925
raise errors.RevisionNotPresent(version, str(self.source))
927
new_version_ids.add(version)
928
return new_version_ids
added
removed
bzrlib/versionedfile.py
