/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/versionedfile.py

  • Committer: Robert Collins
  • Date: 2008-04-08 02:31:32 UTC
  • mto: This revision was merged to the branch mainline in revision 3350.
  • Revision ID: robertc@robertcollins.net-20080408023132-krhhq7sn52hff1tc
 * ``VersionedFile.iter_parents`` is now deprecated in favour of
   ``get_parent_map`` which can be used to instantiate a Graph on a
   VersionedFile. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# Authors:
 
4
#   Johan Rydberg <jrydberg@gnu.org>
 
5
#
 
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.
 
10
#
 
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.
 
15
#
 
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
 
19
 
 
20
"""Versioned text file storage api."""
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
 
 
25
from bzrlib import (
 
26
    errors,
 
27
    osutils,
 
28
    multiparent,
 
29
    tsort,
 
30
    revision,
 
31
    ui,
 
32
    )
 
33
from bzrlib.graph import Graph
 
34
from bzrlib.transport.memory import MemoryTransport
 
35
""")
 
36
 
 
37
from cStringIO import StringIO
 
38
 
 
39
from bzrlib.inter import InterObject
 
40
from bzrlib.symbol_versioning import *
 
41
from bzrlib.textmerge import TextMerge
 
42
 
 
43
 
 
44
class VersionedFile(object):
 
45
    """Versioned text file storage.
 
46
    
 
47
    A versioned file manages versions of line-based text files,
 
48
    keeping track of the originating version for each line.
 
49
 
 
50
    To clients the "lines" of the file are represented as a list of
 
51
    strings. These strings will typically have terminal newline
 
52
    characters, but this is not required.  In particular files commonly
 
53
    do not have a newline at the end of the file.
 
54
 
 
55
    Texts are identified by a version-id string.
 
56
    """
 
57
 
 
58
    @staticmethod
 
59
    def check_not_reserved_id(version_id):
 
60
        revision.check_not_reserved_id(version_id)
 
61
 
 
62
    def copy_to(self, name, transport):
 
63
        """Copy this versioned file to name on transport."""
 
64
        raise NotImplementedError(self.copy_to)
 
65
 
 
66
    def versions(self):
 
67
        """Return a unsorted list of versions."""
 
68
        raise NotImplementedError(self.versions)
 
69
 
 
70
    @deprecated_method(one_four)
 
71
    def has_ghost(self, version_id):
 
72
        """Returns whether version is present as a ghost."""
 
73
        raise NotImplementedError(self.has_ghost)
 
74
 
 
75
    def has_version(self, version_id):
 
76
        """Returns whether version is present."""
 
77
        raise NotImplementedError(self.has_version)
 
78
 
 
79
    def add_lines(self, version_id, parents, lines, parent_texts=None,
 
80
        left_matching_blocks=None, nostore_sha=None, random_id=False,
 
81
        check_content=True):
 
82
        """Add a single text on top of the versioned file.
 
83
 
 
84
        Must raise RevisionAlreadyPresent if the new version is
 
85
        already present in file history.
 
86
 
 
87
        Must raise RevisionNotPresent if any of the given parents are
 
88
        not present in file history.
 
89
 
 
90
        :param lines: A list of lines. Each line must be a bytestring. And all
 
91
            of them except the last must be terminated with \n and contain no
 
92
            other \n's. The last line may either contain no \n's or a single
 
93
            terminated \n. If the lines list does meet this constraint the add
 
94
            routine may error or may succeed - but you will be unable to read
 
95
            the data back accurately. (Checking the lines have been split
 
96
            correctly is expensive and extremely unlikely to catch bugs so it
 
97
            is not done at runtime unless check_content is True.)
 
98
        :param parent_texts: An optional dictionary containing the opaque 
 
99
            representations of some or all of the parents of version_id to
 
100
            allow delta optimisations.  VERY IMPORTANT: the texts must be those
 
101
            returned by add_lines or data corruption can be caused.
 
102
        :param left_matching_blocks: a hint about which areas are common
 
103
            between the text and its left-hand-parent.  The format is
 
104
            the SequenceMatcher.get_matching_blocks format.
 
105
        :param nostore_sha: Raise ExistingContent and do not add the lines to
 
106
            the versioned file if the digest of the lines matches this.
 
107
        :param random_id: If True a random id has been selected rather than
 
108
            an id determined by some deterministic process such as a converter
 
109
            from a foreign VCS. When True the backend may choose not to check
 
110
            for uniqueness of the resulting key within the versioned file, so
 
111
            this should only be done when the result is expected to be unique
 
112
            anyway.
 
113
        :param check_content: If True, the lines supplied are verified to be
 
114
            bytestrings that are correctly formed lines.
 
115
        :return: The text sha1, the number of bytes in the text, and an opaque
 
116
                 representation of the inserted version which can be provided
 
117
                 back to future add_lines calls in the parent_texts dictionary.
 
118
        """
 
119
        self._check_write_ok()
 
120
        return self._add_lines(version_id, parents, lines, parent_texts,
 
121
            left_matching_blocks, nostore_sha, random_id, check_content)
 
122
 
 
123
    def _add_lines(self, version_id, parents, lines, parent_texts,
 
124
        left_matching_blocks, nostore_sha, random_id, check_content):
 
125
        """Helper to do the class specific add_lines."""
 
126
        raise NotImplementedError(self.add_lines)
 
127
 
 
128
    def add_lines_with_ghosts(self, version_id, parents, lines,
 
129
        parent_texts=None, nostore_sha=None, random_id=False,
 
130
        check_content=True, left_matching_blocks=None):
 
131
        """Add lines to the versioned file, allowing ghosts to be present.
 
132
        
 
133
        This takes the same parameters as add_lines and returns the same.
 
134
        """
 
135
        self._check_write_ok()
 
136
        return self._add_lines_with_ghosts(version_id, parents, lines,
 
137
            parent_texts, nostore_sha, random_id, check_content, left_matching_blocks)
 
138
 
 
139
    def _add_lines_with_ghosts(self, version_id, parents, lines, parent_texts,
 
140
        nostore_sha, random_id, check_content, left_matching_blocks):
 
141
        """Helper to do class specific add_lines_with_ghosts."""
 
142
        raise NotImplementedError(self.add_lines_with_ghosts)
 
143
 
 
144
    def check(self, progress_bar=None):
 
145
        """Check the versioned file for integrity."""
 
146
        raise NotImplementedError(self.check)
 
147
 
 
148
    def _check_lines_not_unicode(self, lines):
 
149
        """Check that lines being added to a versioned file are not unicode."""
 
150
        for line in lines:
 
151
            if line.__class__ is not str:
 
152
                raise errors.BzrBadParameterUnicode("lines")
 
153
 
 
154
    def _check_lines_are_lines(self, lines):
 
155
        """Check that the lines really are full lines without inline EOL."""
 
156
        for line in lines:
 
157
            if '\n' in line[:-1]:
 
158
                raise errors.BzrBadParameterContainsNewline("lines")
 
159
 
 
160
    def enable_cache(self):
 
161
        """Tell this versioned file that it should cache any data it reads.
 
162
        
 
163
        This is advisory, implementations do not have to support caching.
 
164
        """
 
165
        pass
 
166
    
 
167
    def clear_cache(self):
 
168
        """Remove any data cached in the versioned file object.
 
169
 
 
170
        This only needs to be supported if caches are supported
 
171
        """
 
172
        pass
 
173
 
 
174
    def clone_text(self, new_version_id, old_version_id, parents):
 
175
        """Add an identical text to old_version_id as new_version_id.
 
176
 
 
177
        Must raise RevisionNotPresent if the old version or any of the
 
178
        parents are not present in file history.
 
179
 
 
180
        Must raise RevisionAlreadyPresent if the new version is
 
181
        already present in file history."""
 
182
        self._check_write_ok()
 
183
        return self._clone_text(new_version_id, old_version_id, parents)
 
184
 
 
185
    def _clone_text(self, new_version_id, old_version_id, parents):
 
186
        """Helper function to do the _clone_text work."""
 
187
        raise NotImplementedError(self.clone_text)
 
188
 
 
189
    def get_format_signature(self):
 
190
        """Get a text description of the data encoding in this file.
 
191
        
 
192
        :since: 0.90
 
193
        """
 
194
        raise NotImplementedError(self.get_format_signature)
 
195
 
 
196
    def make_mpdiffs(self, version_ids):
 
197
        """Create multiparent diffs for specified versions."""
 
198
        knit_versions = set()
 
199
        knit_versions.update(version_ids)
 
200
        parent_map = self.get_parent_map(version_ids)
 
201
        for version_id in version_ids:
 
202
            try:
 
203
                knit_versions.update(parent_map[version_id])
 
204
            except KeyError:
 
205
                raise RevisionNotPresent(version_id, self)
 
206
        # We need to filter out ghosts, because we can't diff against them.
 
207
        knit_versions = set(self.get_parent_map(knit_versions).keys())
 
208
        lines = dict(zip(knit_versions,
 
209
            self._get_lf_split_line_list(knit_versions)))
 
210
        diffs = []
 
211
        for version_id in version_ids:
 
212
            target = lines[version_id]
 
213
            try:
 
214
                parents = [lines[p] for p in parent_map[version_id] if p in
 
215
                    knit_versions]
 
216
            except KeyError:
 
217
                raise RevisionNotPresent(version_id, self)
 
218
            if len(parents) > 0:
 
219
                left_parent_blocks = self._extract_blocks(version_id,
 
220
                                                          parents[0], target)
 
221
            else:
 
222
                left_parent_blocks = None
 
223
            diffs.append(multiparent.MultiParent.from_lines(target, parents,
 
224
                         left_parent_blocks))
 
225
        return diffs
 
226
 
 
227
    def _extract_blocks(self, version_id, source, target):
 
228
        return None
 
229
 
 
230
    def add_mpdiffs(self, records):
 
231
        """Add mpdiffs to this VersionedFile.
 
232
 
 
233
        Records should be iterables of version, parents, expected_sha1,
 
234
        mpdiff. mpdiff should be a MultiParent instance.
 
235
        """
 
236
        # Does this need to call self._check_write_ok()? (IanC 20070919)
 
237
        vf_parents = {}
 
238
        mpvf = multiparent.MultiMemoryVersionedFile()
 
239
        versions = []
 
240
        for version, parent_ids, expected_sha1, mpdiff in records:
 
241
            versions.append(version)
 
242
            mpvf.add_diff(mpdiff, version, parent_ids)
 
243
        needed_parents = set()
 
244
        for version, parent_ids, expected_sha1, mpdiff in records:
 
245
            needed_parents.update(p for p in parent_ids
 
246
                                  if not mpvf.has_version(p))
 
247
        present_parents = set(self.get_parent_map(needed_parents).keys())
 
248
        for parent_id, lines in zip(present_parents,
 
249
                                 self._get_lf_split_line_list(present_parents)):
 
250
            mpvf.add_version(lines, parent_id, [])
 
251
        for (version, parent_ids, expected_sha1, mpdiff), lines in\
 
252
            zip(records, mpvf.get_line_list(versions)):
 
253
            if len(parent_ids) == 1:
 
254
                left_matching_blocks = list(mpdiff.get_matching_blocks(0,
 
255
                    mpvf.get_diff(parent_ids[0]).num_lines()))
 
256
            else:
 
257
                left_matching_blocks = None
 
258
            try:
 
259
                _, _, version_text = self.add_lines_with_ghosts(version,
 
260
                    parent_ids, lines, vf_parents,
 
261
                    left_matching_blocks=left_matching_blocks)
 
262
            except NotImplementedError:
 
263
                # The vf can't handle ghosts, so add lines normally, which will
 
264
                # (reasonably) fail if there are ghosts in the data.
 
265
                _, _, version_text = self.add_lines(version,
 
266
                    parent_ids, lines, vf_parents,
 
267
                    left_matching_blocks=left_matching_blocks)
 
268
            vf_parents[version] = version_text
 
269
        for (version, parent_ids, expected_sha1, mpdiff), sha1 in\
 
270
             zip(records, self.get_sha1s(versions)):
 
271
            if expected_sha1 != sha1:
 
272
                raise errors.VersionedFileInvalidChecksum(version)
 
273
 
 
274
    def get_sha1(self, version_id):
 
275
        """Get the stored sha1 sum for the given revision.
 
276
        
 
277
        :param version_id: The name of the version to lookup
 
278
        """
 
279
        raise NotImplementedError(self.get_sha1)
 
280
 
 
281
    def get_sha1s(self, version_ids):
 
282
        """Get the stored sha1 sums for the given revisions.
 
283
 
 
284
        :param version_ids: The names of the versions to lookup
 
285
        :return: a list of sha1s in order according to the version_ids
 
286
        """
 
287
        raise NotImplementedError(self.get_sha1s)
 
288
 
 
289
    def get_text(self, version_id):
 
290
        """Return version contents as a text string.
 
291
 
 
292
        Raises RevisionNotPresent if version is not present in
 
293
        file history.
 
294
        """
 
295
        return ''.join(self.get_lines(version_id))
 
296
    get_string = get_text
 
297
 
 
298
    def get_texts(self, version_ids):
 
299
        """Return the texts of listed versions as a list of strings.
 
300
 
 
301
        Raises RevisionNotPresent if version is not present in
 
302
        file history.
 
303
        """
 
304
        return [''.join(self.get_lines(v)) for v in version_ids]
 
305
 
 
306
    def get_lines(self, version_id):
 
307
        """Return version contents as a sequence of lines.
 
308
 
 
309
        Raises RevisionNotPresent if version is not present in
 
310
        file history.
 
311
        """
 
312
        raise NotImplementedError(self.get_lines)
 
313
 
 
314
    def _get_lf_split_line_list(self, version_ids):
 
315
        return [StringIO(t).readlines() for t in self.get_texts(version_ids)]
 
316
 
 
317
    def get_ancestry(self, version_ids, topo_sorted=True):
 
318
        """Return a list of all ancestors of given version(s). This
 
319
        will not include the null revision.
 
320
 
 
321
        This list will not be topologically sorted if topo_sorted=False is
 
322
        passed.
 
323
 
 
324
        Must raise RevisionNotPresent if any of the given versions are
 
325
        not present in file history."""
 
326
        if isinstance(version_ids, basestring):
 
327
            version_ids = [version_ids]
 
328
        raise NotImplementedError(self.get_ancestry)
 
329
        
 
330
    def get_ancestry_with_ghosts(self, version_ids):
 
331
        """Return a list of all ancestors of given version(s). This
 
332
        will not include the null revision.
 
333
 
 
334
        Must raise RevisionNotPresent if any of the given versions are
 
335
        not present in file history.
 
336
        
 
337
        Ghosts that are known about will be included in ancestry list,
 
338
        but are not explicitly marked.
 
339
        """
 
340
        raise NotImplementedError(self.get_ancestry_with_ghosts)
 
341
    
 
342
    @deprecated_method(one_four)
 
343
    def get_graph(self, version_ids=None):
 
344
        """Return a graph from the versioned file. 
 
345
        
 
346
        Ghosts are not listed or referenced in the graph.
 
347
        :param version_ids: Versions to select.
 
348
                            None means retrieve all versions.
 
349
        """
 
350
        if version_ids is None:
 
351
            result = self.get_parent_map(self.versions())
 
352
        else:
 
353
            result = {}
 
354
            pending = set(version_ids)
 
355
            while pending:
 
356
                this_iteration = pending
 
357
                pending = set()
 
358
                parents = self.get_parent_map(this_iteration)
 
359
                for version, parents in parents.iteritems():
 
360
                    result[version] = parents
 
361
                    for parent in parents:
 
362
                        if parent in result:
 
363
                            continue
 
364
                        pending.add(parent)
 
365
        references = set()
 
366
        for parents in result.itervalues():
 
367
            references.update(parents)
 
368
        existing_parents = self.get_parent_map(references)
 
369
        for key, parents in result.iteritems():
 
370
            present_parents = [parent for parent in parents if parent in
 
371
                existing_parents]
 
372
            result[key] = tuple(present_parents)
 
373
        return result
 
374
 
 
375
    @deprecated_method(one_four)
 
376
    def get_graph_with_ghosts(self):
 
377
        """Return a graph for the entire versioned file.
 
378
        
 
379
        Ghosts are referenced in parents list but are not
 
380
        explicitly listed.
 
381
        """
 
382
        raise NotImplementedError(self.get_graph_with_ghosts)
 
383
 
 
384
    def get_parent_map(self, version_ids):
 
385
        """Get a map of the parents of version_ids.
 
386
 
 
387
        :param version_ids: The version ids to look up parents for.
 
388
        :return: A mapping from version id to parents.
 
389
        """
 
390
        raise NotImplementedError(self.get_parent_map)
 
391
 
 
392
    @deprecated_method(one_four)
 
393
    def get_parents(self, version_id):
 
394
        """Return version names for parents of a version.
 
395
 
 
396
        Must raise RevisionNotPresent if version is not present in
 
397
        file history.
 
398
        """
 
399
        try:
 
400
            all = self.get_parent_map([version_id])[version_id]
 
401
        except KeyError:
 
402
            raise errors.RevisionNotPresent(version_id, self)
 
403
        result = []
 
404
        parent_parents = self.get_parent_map(all)
 
405
        for version_id in all:
 
406
            if version_id in parent_parents:
 
407
                result.append(version_id)
 
408
        return result
 
409
 
 
410
    def get_parents_with_ghosts(self, version_id):
 
411
        """Return version names for parents of version_id.
 
412
 
 
413
        Will raise RevisionNotPresent if version_id is not present
 
414
        in the history.
 
415
 
 
416
        Ghosts that are known about will be included in the parent list,
 
417
        but are not explicitly marked.
 
418
        """
 
419
        try:
 
420
            return list(self.get_parent_map([version_id])[version_id])
 
421
        except KeyError:
 
422
            raise errors.RevisionNotPresent(version_id, self)
 
423
 
 
424
    def annotate_iter(self, version_id):
 
425
        """Yield list of (version-id, line) pairs for the specified
 
426
        version.
 
427
 
 
428
        Must raise RevisionNotPresent if the given version is
 
429
        not present in file history.
 
430
        """
 
431
        raise NotImplementedError(self.annotate_iter)
 
432
 
 
433
    def annotate(self, version_id):
 
434
        return list(self.annotate_iter(version_id))
 
435
 
 
436
    def join(self, other, pb=None, msg=None, version_ids=None,
 
437
             ignore_missing=False):
 
438
        """Integrate versions from other into this versioned file.
 
439
 
 
440
        If version_ids is None all versions from other should be
 
441
        incorporated into this versioned file.
 
442
 
 
443
        Must raise RevisionNotPresent if any of the specified versions
 
444
        are not present in the other file's history unless ignore_missing
 
445
        is supplied in which case they are silently skipped.
 
446
        """
 
447
        self._check_write_ok()
 
448
        return InterVersionedFile.get(other, self).join(
 
449
            pb,
 
450
            msg,
 
451
            version_ids,
 
452
            ignore_missing)
 
453
 
 
454
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
 
455
                                                pb=None):
 
456
        """Iterate over the lines in the versioned file from version_ids.
 
457
 
 
458
        This may return lines from other versions. Each item the returned
 
459
        iterator yields is a tuple of a line and a text version that that line
 
460
        is present in (not introduced in).
 
461
 
 
462
        Ordering of results is in whatever order is most suitable for the
 
463
        underlying storage format.
 
464
 
 
465
        If a progress bar is supplied, it may be used to indicate progress.
 
466
        The caller is responsible for cleaning up progress bars (because this
 
467
        is an iterator).
 
468
 
 
469
        NOTES: Lines are normalised: they will all have \n terminators.
 
470
               Lines are returned in arbitrary order.
 
471
 
 
472
        :return: An iterator over (line, version_id).
 
473
        """
 
474
        raise NotImplementedError(self.iter_lines_added_or_present_in_versions)
 
475
 
 
476
    @deprecated_method(one_four)
 
477
    def iter_parents(self, version_ids):
 
478
        """Iterate through the parents for many version ids.
 
479
 
 
480
        :param version_ids: An iterable yielding version_ids.
 
481
        :return: An iterator that yields (version_id, parents). Requested 
 
482
            version_ids not present in the versioned file are simply skipped.
 
483
            The order is undefined, allowing for different optimisations in
 
484
            the underlying implementation.
 
485
        """
 
486
        return self.get_parent_map(version_ids).iteritems()
 
487
 
 
488
    def plan_merge(self, ver_a, ver_b):
 
489
        """Return pseudo-annotation indicating how the two versions merge.
 
490
 
 
491
        This is computed between versions a and b and their common
 
492
        base.
 
493
 
 
494
        Weave lines present in none of them are skipped entirely.
 
495
 
 
496
        Legend:
 
497
        killed-base Dead in base revision
 
498
        killed-both Killed in each revision
 
499
        killed-a    Killed in a
 
500
        killed-b    Killed in b
 
501
        unchanged   Alive in both a and b (possibly created in both)
 
502
        new-a       Created in a
 
503
        new-b       Created in b
 
504
        ghost-a     Killed in a, unborn in b    
 
505
        ghost-b     Killed in b, unborn in a
 
506
        irrelevant  Not in either revision
 
507
        """
 
508
        raise NotImplementedError(VersionedFile.plan_merge)
 
509
        
 
510
    def weave_merge(self, plan, a_marker=TextMerge.A_MARKER,
 
511
                    b_marker=TextMerge.B_MARKER):
 
512
        return PlanWeaveMerge(plan, a_marker, b_marker).merge_lines()[0]
 
513
 
 
514
 
 
515
class _PlanMergeVersionedFile(object):
 
516
    """A VersionedFile for uncommitted and committed texts.
 
517
 
 
518
    It is intended to allow merges to be planned with working tree texts.
 
519
    It implements only the small part of the VersionedFile interface used by
 
520
    PlanMerge.  It falls back to multiple versionedfiles for data not stored in
 
521
    _PlanMergeVersionedFile itself.
 
522
    """
 
523
 
 
524
    def __init__(self, file_id, fallback_versionedfiles=None):
 
525
        """Constuctor
 
526
 
 
527
        :param file_id: Used when raising exceptions.
 
528
        :param fallback_versionedfiles: If supplied, the set of fallbacks to
 
529
            use.  Otherwise, _PlanMergeVersionedFile.fallback_versionedfiles
 
530
            can be appended to later.
 
531
        """
 
532
        self._file_id = file_id
 
533
        if fallback_versionedfiles is None:
 
534
            self.fallback_versionedfiles = []
 
535
        else:
 
536
            self.fallback_versionedfiles = fallback_versionedfiles
 
537
        self._parents = {}
 
538
        self._lines = {}
 
539
 
 
540
    def plan_merge(self, ver_a, ver_b, base=None):
 
541
        """See VersionedFile.plan_merge"""
 
542
        from bzrlib.merge import _PlanMerge
 
543
        if base is None:
 
544
            return _PlanMerge(ver_a, ver_b, self).plan_merge()
 
545
        old_plan = list(_PlanMerge(ver_a, base, self).plan_merge())
 
546
        new_plan = list(_PlanMerge(ver_a, ver_b, self).plan_merge())
 
547
        return _PlanMerge._subtract_plans(old_plan, new_plan)
 
548
 
 
549
    def plan_lca_merge(self, ver_a, ver_b, base=None):
 
550
        from bzrlib.merge import _PlanLCAMerge
 
551
        graph = self._get_graph()
 
552
        new_plan = _PlanLCAMerge(ver_a, ver_b, self, graph).plan_merge()
 
553
        if base is None:
 
554
            return new_plan
 
555
        old_plan = _PlanLCAMerge(ver_a, base, self, graph).plan_merge()
 
556
        return _PlanLCAMerge._subtract_plans(list(old_plan), list(new_plan))
 
557
 
 
558
    def add_lines(self, version_id, parents, lines):
 
559
        """See VersionedFile.add_lines
 
560
 
 
561
        Lines are added locally, not fallback versionedfiles.  Also, ghosts are
 
562
        permitted.  Only reserved ids are permitted.
 
563
        """
 
564
        if not revision.is_reserved_id(version_id):
 
565
            raise ValueError('Only reserved ids may be used')
 
566
        if parents is None:
 
567
            raise ValueError('Parents may not be None')
 
568
        if lines is None:
 
569
            raise ValueError('Lines may not be None')
 
570
        self._parents[version_id] = tuple(parents)
 
571
        self._lines[version_id] = lines
 
572
 
 
573
    def get_lines(self, version_id):
 
574
        """See VersionedFile.get_ancestry"""
 
575
        lines = self._lines.get(version_id)
 
576
        if lines is not None:
 
577
            return lines
 
578
        for versionedfile in self.fallback_versionedfiles:
 
579
            try:
 
580
                return versionedfile.get_lines(version_id)
 
581
            except errors.RevisionNotPresent:
 
582
                continue
 
583
        else:
 
584
            raise errors.RevisionNotPresent(version_id, self._file_id)
 
585
 
 
586
    def get_ancestry(self, version_id, topo_sorted=False):
 
587
        """See VersionedFile.get_ancestry.
 
588
 
 
589
        Note that this implementation assumes that if a VersionedFile can
 
590
        answer get_ancestry at all, it can give an authoritative answer.  In
 
591
        fact, ghosts can invalidate this assumption.  But it's good enough
 
592
        99% of the time, and far cheaper/simpler.
 
593
 
 
594
        Also note that the results of this version are never topologically
 
595
        sorted, and are a set.
 
596
        """
 
597
        if topo_sorted:
 
598
            raise ValueError('This implementation does not provide sorting')
 
599
        parents = self._parents.get(version_id)
 
600
        if parents is None:
 
601
            for vf in self.fallback_versionedfiles:
 
602
                try:
 
603
                    return vf.get_ancestry(version_id, topo_sorted=False)
 
604
                except errors.RevisionNotPresent:
 
605
                    continue
 
606
            else:
 
607
                raise errors.RevisionNotPresent(version_id, self._file_id)
 
608
        ancestry = set([version_id])
 
609
        for parent in parents:
 
610
            ancestry.update(self.get_ancestry(parent, topo_sorted=False))
 
611
        return ancestry
 
612
 
 
613
    def get_parent_map(self, version_ids):
 
614
        """See VersionedFile.get_parent_map"""
 
615
        result = {}
 
616
        pending = set(version_ids)
 
617
        for key in version_ids:
 
618
            try:
 
619
                result[key] = self._parents[key]
 
620
            except KeyError:
 
621
                pass
 
622
        pending = pending - set(result.keys())
 
623
        for versionedfile in self.fallback_versionedfiles:
 
624
            parents = versionedfile.get_parent_map(pending)
 
625
            result.update(parents)
 
626
            pending = pending - set(parents.keys())
 
627
            if not pending:
 
628
                return result
 
629
        return result
 
630
 
 
631
    def _get_graph(self):
 
632
        from bzrlib.graph import (
 
633
            DictParentsProvider,
 
634
            Graph,
 
635
            _StackedParentsProvider,
 
636
            )
 
637
        from bzrlib.repofmt.knitrepo import _KnitParentsProvider
 
638
        parent_providers = [DictParentsProvider(self._parents)]
 
639
        for vf in self.fallback_versionedfiles:
 
640
            parent_providers.append(_KnitParentsProvider(vf))
 
641
        return Graph(_StackedParentsProvider(parent_providers))
 
642
 
 
643
 
 
644
class PlanWeaveMerge(TextMerge):
 
645
    """Weave merge that takes a plan as its input.
 
646
    
 
647
    This exists so that VersionedFile.plan_merge is implementable.
 
648
    Most callers will want to use WeaveMerge instead.
 
649
    """
 
650
 
 
651
    def __init__(self, plan, a_marker=TextMerge.A_MARKER,
 
652
                 b_marker=TextMerge.B_MARKER):
 
653
        TextMerge.__init__(self, a_marker, b_marker)
 
654
        self.plan = plan
 
655
 
 
656
    def _merge_struct(self):
 
657
        lines_a = []
 
658
        lines_b = []
 
659
        ch_a = ch_b = False
 
660
 
 
661
        def outstanding_struct():
 
662
            if not lines_a and not lines_b:
 
663
                return
 
664
            elif ch_a and not ch_b:
 
665
                # one-sided change:
 
666
                yield(lines_a,)
 
667
            elif ch_b and not ch_a:
 
668
                yield (lines_b,)
 
669
            elif lines_a == lines_b:
 
670
                yield(lines_a,)
 
671
            else:
 
672
                yield (lines_a, lines_b)
 
673
       
 
674
        # We previously considered either 'unchanged' or 'killed-both' lines
 
675
        # to be possible places to resynchronize.  However, assuming agreement
 
676
        # on killed-both lines may be too aggressive. -- mbp 20060324
 
677
        for state, line in self.plan:
 
678
            if state == 'unchanged':
 
679
                # resync and flush queued conflicts changes if any
 
680
                for struct in outstanding_struct():
 
681
                    yield struct
 
682
                lines_a = []
 
683
                lines_b = []
 
684
                ch_a = ch_b = False
 
685
                
 
686
            if state == 'unchanged':
 
687
                if line:
 
688
                    yield ([line],)
 
689
            elif state == 'killed-a':
 
690
                ch_a = True
 
691
                lines_b.append(line)
 
692
            elif state == 'killed-b':
 
693
                ch_b = True
 
694
                lines_a.append(line)
 
695
            elif state == 'new-a':
 
696
                ch_a = True
 
697
                lines_a.append(line)
 
698
            elif state == 'new-b':
 
699
                ch_b = True
 
700
                lines_b.append(line)
 
701
            elif state == 'conflicted-a':
 
702
                ch_b = ch_a = True
 
703
                lines_a.append(line)
 
704
            elif state == 'conflicted-b':
 
705
                ch_b = ch_a = True
 
706
                lines_b.append(line)
 
707
            else:
 
708
                assert state in ('irrelevant', 'ghost-a', 'ghost-b', 
 
709
                                 'killed-base', 'killed-both'), state
 
710
        for struct in outstanding_struct():
 
711
            yield struct
 
712
 
 
713
 
 
714
class WeaveMerge(PlanWeaveMerge):
 
715
    """Weave merge that takes a VersionedFile and two versions as its input."""
 
716
 
 
717
    def __init__(self, versionedfile, ver_a, ver_b, 
 
718
        a_marker=PlanWeaveMerge.A_MARKER, b_marker=PlanWeaveMerge.B_MARKER):
 
719
        plan = versionedfile.plan_merge(ver_a, ver_b)
 
720
        PlanWeaveMerge.__init__(self, plan, a_marker, b_marker)
 
721
 
 
722
 
 
723
class InterVersionedFile(InterObject):
 
724
    """This class represents operations taking place between two VersionedFiles.
 
725
 
 
726
    Its instances have methods like join, and contain
 
727
    references to the source and target versionedfiles these operations can be 
 
728
    carried out on.
 
729
 
 
730
    Often we will provide convenience methods on 'versionedfile' which carry out
 
731
    operations with another versionedfile - they will always forward to
 
732
    InterVersionedFile.get(other).method_name(parameters).
 
733
    """
 
734
 
 
735
    _optimisers = []
 
736
    """The available optimised InterVersionedFile types."""
 
737
 
 
738
    def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
 
739
        """Integrate versions from self.source into self.target.
 
740
 
 
741
        If version_ids is None all versions from source should be
 
742
        incorporated into this versioned file.
 
743
 
 
744
        Must raise RevisionNotPresent if any of the specified versions
 
745
        are not present in the other file's history unless ignore_missing is 
 
746
        supplied in which case they are silently skipped.
 
747
        """
 
748
        target = self.target
 
749
        version_ids = self._get_source_version_ids(version_ids, ignore_missing)
 
750
        graph = Graph(self.source)
 
751
        search = graph._make_breadth_first_searcher(version_ids)
 
752
        transitive_ids = set()
 
753
        map(transitive_ids.update, list(search))
 
754
        parent_map = self.source.get_parent_map(transitive_ids)
 
755
        order = tsort.topo_sort(parent_map.items())
 
756
        pb = ui.ui_factory.nested_progress_bar()
 
757
        parent_texts = {}
 
758
        try:
 
759
            # TODO for incremental cross-format work:
 
760
            # make a versioned file with the following content:
 
761
            # all revisions we have been asked to join
 
762
            # all their ancestors that are *not* in target already.
 
763
            # the immediate parents of the above two sets, with 
 
764
            # empty parent lists - these versions are in target already
 
765
            # and the incorrect version data will be ignored.
 
766
            # TODO: for all ancestors that are present in target already,
 
767
            # check them for consistent data, this requires moving sha1 from
 
768
            # 
 
769
            # TODO: remove parent texts when they are not relevant any more for 
 
770
            # memory pressure reduction. RBC 20060313
 
771
            # pb.update('Converting versioned data', 0, len(order))
 
772
            total = len(order)
 
773
            for index, version in enumerate(order):
 
774
                pb.update('Converting versioned data', index, total)
 
775
                if version in target:
 
776
                    continue
 
777
                _, _, parent_text = target.add_lines(version,
 
778
                                               parent_map[version],
 
779
                                               self.source.get_lines(version),
 
780
                                               parent_texts=parent_texts)
 
781
                parent_texts[version] = parent_text
 
782
            return total
 
783
        finally:
 
784
            pb.finished()
 
785
 
 
786
    def _get_source_version_ids(self, version_ids, ignore_missing):
 
787
        """Determine the version ids to be used from self.source.
 
788
 
 
789
        :param version_ids: The caller-supplied version ids to check. (None 
 
790
                            for all). If None is in version_ids, it is stripped.
 
791
        :param ignore_missing: if True, remove missing ids from the version 
 
792
                               list. If False, raise RevisionNotPresent on
 
793
                               a missing version id.
 
794
        :return: A set of version ids.
 
795
        """
 
796
        if version_ids is None:
 
797
            # None cannot be in source.versions
 
798
            return set(self.source.versions())
 
799
        else:
 
800
            if ignore_missing:
 
801
                return set(self.source.versions()).intersection(set(version_ids))
 
802
            else:
 
803
                new_version_ids = set()
 
804
                for version in version_ids:
 
805
                    if version is None:
 
806
                        continue
 
807
                    if not self.source.has_version(version):
 
808
                        raise errors.RevisionNotPresent(version, str(self.source))
 
809
                    else:
 
810
                        new_version_ids.add(version)
 
811
                return new_version_ids