1
# Copyright (C) 2005 by 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
# Remaing to do is to figure out if get_graph should return a simple
21
# map, or a graph object of some kind.
24
"""Versioned text file storage api."""
27
from copy import deepcopy
28
from unittest import TestSuite
31
from bzrlib.inter import InterObject
32
from bzrlib.symbol_versioning import *
33
from bzrlib.transport.memory import MemoryTransport
34
from bzrlib.tsort import topo_sort
38
class VersionedFile(object):
39
"""Versioned text file storage.
41
A versioned file manages versions of line-based text files,
42
keeping track of the originating version for each line.
44
To clients the "lines" of the file are represented as a list of
45
strings. These strings will typically have terminal newline
46
characters, but this is not required. In particular files commonly
47
do not have a newline at the end of the file.
49
Texts are identified by a version-id string.
52
def copy_to(self, name, transport):
53
"""Copy this versioned file to name on transport."""
54
raise NotImplementedError(self.copy_to)
56
@deprecated_method(zero_eight)
58
"""Return a list of all the versions in this versioned file.
60
Please use versionedfile.versions() now.
62
return self.versions()
65
"""Return a unsorted list of versions."""
66
raise NotImplementedError(self.versions)
68
def has_version(self, version_id):
69
"""Returns whether version is present."""
70
raise NotImplementedError(self.has_version)
72
def add_lines(self, version_id, parents, lines):
73
"""Add a single text on top of the versioned file.
75
Must raise RevisionAlreadyPresent if the new version is
76
already present in file history.
78
Must raise RevisionNotPresent if any of the given parents are
79
not present in file history."""
80
raise NotImplementedError(self.add_lines)
82
def check(self, progress_bar=None):
83
"""Check the versioned file for integrity."""
84
raise NotImplementedError(self.check)
86
def clear_cache(self):
87
"""Remove any data cached in the versioned file object."""
89
def clone_text(self, new_version_id, old_version_id, parents):
90
"""Add an identical text to old_version_id as new_version_id.
92
Must raise RevisionNotPresent if the old version or any of the
93
parents are not present in file history.
95
Must raise RevisionAlreadyPresent if the new version is
96
already present in file history."""
97
raise NotImplementedError(self.clone_text)
99
def create_empty(self, name, transport, mode=None):
100
"""Create a new versioned file of this exact type.
102
:param name: the file name
103
:param transport: the transport
104
:param mode: optional file mode.
106
raise NotImplementedError(self.create_empty)
108
def get_suffixes(self):
109
"""Return the file suffixes associated with this versioned file."""
110
raise NotImplementedError(self.get_suffixes)
112
def get_text(self, version_id):
113
"""Return version contents as a text string.
115
Raises RevisionNotPresent if version is not present in
118
return ''.join(self.get_lines(version_id))
119
get_string = get_text
121
def get_lines(self, version_id):
122
"""Return version contents as a sequence of lines.
124
Raises RevisionNotPresent if version is not present in
127
raise NotImplementedError(self.get_lines)
129
def get_ancestry(self, version_ids):
130
"""Return a list of all ancestors of given version(s). This
131
will not include the null revision.
133
Must raise RevisionNotPresent if any of the given versions are
134
not present in file history."""
135
if isinstance(version_ids, basestring):
136
version_ids = [version_ids]
137
raise NotImplementedError(self.get_ancestry)
140
"""Return a graph for the entire versioned file."""
142
for version in self.versions():
143
result[version] = self.get_parents(version)
146
@deprecated_method(zero_eight)
147
def parent_names(self, version):
148
"""Return version names for parents of a version.
150
See get_parents for the current api.
152
return self.get_parents(version)
154
def get_parents(self, version_id):
155
"""Return version names for parents of a version.
157
Must raise RevisionNotPresent if version is not present in
160
raise NotImplementedError(self.get_parents)
162
def annotate_iter(self, version_id):
163
"""Yield list of (version-id, line) pairs for the specified
166
Must raise RevisionNotPresent if any of the given versions are
167
not present in file history.
169
raise NotImplementedError(self.annotate_iter)
171
def annotate(self, version_id):
172
return list(self.annotate_iter(version_id))
174
def join(self, other, pb=None, msg=None, version_ids=None,
175
ignore_missing=False):
176
"""Integrate versions from other into this versioned file.
178
If version_ids is None all versions from other should be
179
incorporated into this versioned file.
181
Must raise RevisionNotPresent if any of the specified versions
182
are not present in the other files history unless ignore_missing
183
is supplied when they are silently skipped.
185
return InterVersionedFile.get(other, self).join(
191
def iter_lines_added_or_present_in_versions(self, version_ids=None):
192
"""Iterate over the lines in the versioned file from version_ids.
194
This may return lines from other versions, and does not return the
195
specific version marker at this point. The api may be changed
196
during development to include the version that the versioned file
197
thinks is relevant, but given that such hints are just guesses,
198
its better not to have it if we dont need it.
200
NOTES: Lines are normalised: they will all have \n terminators.
201
Lines are returned in arbitrary order.
203
raise NotImplementedError(self.iter_lines_added_or_present_in_versions)
205
@deprecated_method(zero_eight)
206
def walk(self, version_ids=None):
207
"""Walk the versioned file as a weave-like structure, for
208
versions relative to version_ids. Yields sequence of (lineno,
209
insert, deletes, text) for each relevant line.
211
Must raise RevisionNotPresent if any of the specified versions
212
are not present in the file history.
214
:param version_ids: the version_ids to walk with respect to. If not
215
supplied the entire weave-like structure is walked.
217
walk is deprecated in favour of iter_lines_added_or_present_in_versions
219
raise NotImplementedError(self.walk)
221
@deprecated_method(zero_eight)
222
def iter_names(self):
223
"""Walk the names list."""
224
return iter(self.versions())
226
def plan_merge(self, ver_a, ver_b):
227
"""Return pseudo-annotation indicating how the two versions merge.
229
This is computed between versions a and b and their common
232
Weave lines present in none of them are skipped entirely.
234
inc_a = set(self.get_ancestry([ver_a]))
235
inc_b = set(self.get_ancestry([ver_b]))
236
inc_c = inc_a & inc_b
238
for lineno, insert, deleteset, line in self.walk([ver_a, ver_b]):
239
if deleteset & inc_c:
240
# killed in parent; can't be in either a or b
241
# not relevant to our work
242
yield 'killed-base', line
243
elif insert in inc_c:
244
# was inserted in base
245
killed_a = bool(deleteset & inc_a)
246
killed_b = bool(deleteset & inc_b)
247
if killed_a and killed_b:
248
yield 'killed-both', line
250
yield 'killed-a', line
252
yield 'killed-b', line
254
yield 'unchanged', line
255
elif insert in inc_a:
256
if deleteset & inc_a:
257
yield 'ghost-a', line
261
elif insert in inc_b:
262
if deleteset & inc_b:
263
yield 'ghost-b', line
267
# not in either revision
268
yield 'irrelevant', line
270
yield 'unchanged', '' # terminator
272
def weave_merge(self, plan, a_marker='<<<<<<< \n', b_marker='>>>>>>> \n'):
276
# TODO: Return a structured form of the conflicts (e.g. 2-tuples for
277
# conflicted regions), rather than just inserting the markers.
279
# TODO: Show some version information (e.g. author, date) on
280
# conflicted regions.
281
for state, line in plan:
282
if state == 'unchanged' or state == 'killed-both':
283
# resync and flush queued conflicts changes if any
284
if not lines_a and not lines_b:
286
elif ch_a and not ch_b:
288
for l in lines_a: yield l
289
elif ch_b and not ch_a:
290
for l in lines_b: yield l
291
elif lines_a == lines_b:
292
for l in lines_a: yield l
295
for l in lines_a: yield l
297
for l in lines_b: yield l
304
if state == 'unchanged':
307
elif state == 'killed-a':
310
elif state == 'killed-b':
313
elif state == 'new-a':
316
elif state == 'new-b':
320
assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
325
class InterVersionedFile(InterObject):
326
"""This class represents operations taking place between two versionedfiles..
328
Its instances have methods like join, and contain
329
references to the source and target versionedfiles these operations can be
332
Often we will provide convenience methods on 'versionedfile' which carry out
333
operations with another versionedfile - they will always forward to
334
InterVersionedFile.get(other).method_name(parameters).
338
"""The available optimised InterVersionedFile types."""
340
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
341
"""Integrate versions from self.source into self.target.
343
If version_ids is None all versions from source should be
344
incorporated into this versioned file.
346
Must raise RevisionNotPresent if any of the specified versions
347
are not present in the other files history unless ignore_missing is
348
supplied when they are silently skipped.
351
# - make a temporary versioned file of type target
352
# - insert the source content into it one at a time
354
# Make a new target-format versioned file.
355
temp_source = self.target.create_empty("temp", MemoryTransport())
356
graph = self.source.get_graph()
357
order = topo_sort(graph.items())
358
pb = ui.ui_factory.nested_progress_bar()
360
for index, version in enumerate(order):
361
pb.update('Converting versioned data', index, len(order))
362
temp_source.add_lines(version,
363
self.source.get_parents(version),
364
self.source.get_lines(version))
366
# this should hit the native code path for target
367
return self.target.join(temp_source,
376
class InterVersionedFileTestProviderAdapter(object):
377
"""A tool to generate a suite testing multiple inter versioned-file classes.
379
This is done by copying the test once for each interversionedfile provider
380
and injecting the transport_server, transport_readonly_server,
381
versionedfile_factory and versionedfile_factory_to classes into each copy.
382
Each copy is also given a new id() to make it easy to identify.
385
def __init__(self, transport_server, transport_readonly_server, formats):
386
self._transport_server = transport_server
387
self._transport_readonly_server = transport_readonly_server
388
self._formats = formats
390
def adapt(self, test):
392
for (interversionedfile_class,
393
versionedfile_factory,
394
versionedfile_factory_to) in self._formats:
395
new_test = deepcopy(test)
396
new_test.transport_server = self._transport_server
397
new_test.transport_readonly_server = self._transport_readonly_server
398
new_test.interversionedfile_class = interversionedfile_class
399
new_test.versionedfile_factory = versionedfile_factory
400
new_test.versionedfile_factory_to = versionedfile_factory_to
401
def make_new_test_id():
402
new_id = "%s(%s)" % (new_test.id(), interversionedfile_class.__name__)
403
return lambda: new_id
404
new_test.id = make_new_test_id()
405
result.addTest(new_test)
409
def default_test_list():
410
"""Generate the default list of interversionedfile permutations to test."""
411
from bzrlib.weave import WeaveFile
412
from bzrlib.knit import KnitVersionedFile
414
# test the fallback InterVersionedFile from weave to annotated knits
415
result.append((InterVersionedFile,
418
for optimiser in InterVersionedFile._optimisers:
419
result.append((optimiser,
420
optimiser._matching_file_factory,
421
optimiser._matching_file_factory
423
# if there are specific combinations we want to use, we can add them
added
removed
bzrlib/versionedfile.py
