~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge.py

  • Committer: John Arbash Meinel
  • Date: 2008-10-14 21:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3805.
  • Revision ID: john@arbash-meinel.com-20081014213527-4j9uc93aq1qmn43b
Add in a shortcut when we haven't cached much yet.

Document the current algorithm more completely, including the proper
justification for the various steps.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import errno
 
19
from itertools import chain
 
20
import os
17
21
import warnings
18
22
 
19
23
from bzrlib import (
20
 
    branch as _mod_branch,
21
 
    conflicts as _mod_conflicts,
22
24
    debug,
23
 
    decorators,
24
25
    errors,
25
26
    graph as _mod_graph,
26
 
    hooks,
27
 
    merge3,
28
27
    osutils,
29
28
    patiencediff,
 
29
    registry,
30
30
    revision as _mod_revision,
31
 
    textfile,
32
 
    trace,
33
 
    transform,
34
31
    tree as _mod_tree,
35
32
    tsort,
36
 
    ui,
37
 
    versionedfile
38
 
    )
39
 
from bzrlib.cleanup import OperationWithCleanups
40
 
from bzrlib.symbol_versioning import (
41
 
    deprecated_in,
42
 
    deprecated_method,
43
 
    )
 
33
    )
 
34
from bzrlib.branch import Branch
 
35
from bzrlib.conflicts import ConflictList, Conflict
 
36
from bzrlib.errors import (BzrCommandError,
 
37
                           BzrError,
 
38
                           NoCommonAncestor,
 
39
                           NoCommits,
 
40
                           NoSuchRevision,
 
41
                           NoSuchFile,
 
42
                           NotBranchError,
 
43
                           NotVersionedError,
 
44
                           UnrelatedBranches,
 
45
                           UnsupportedOperation,
 
46
                           WorkingTreeNotRevision,
 
47
                           BinaryFile,
 
48
                           )
 
49
from bzrlib.graph import Graph
 
50
from bzrlib.merge3 import Merge3
 
51
from bzrlib.osutils import rename, pathjoin
 
52
from progress import DummyProgress, ProgressPhase
 
53
from bzrlib.revision import (NULL_REVISION, ensure_null)
 
54
from bzrlib.textfile import check_text_lines
 
55
from bzrlib.trace import mutter, warning, note, is_quiet
 
56
from bzrlib.transform import (TransformPreview, TreeTransform,
 
57
                              resolve_conflicts, cook_conflicts,
 
58
                              conflict_pass, FinalPaths, create_by_entry,
 
59
                              unique_add, ROOT_PARENT)
 
60
from bzrlib.versionedfile import PlanWeaveMerge
 
61
from bzrlib import ui
 
62
 
44
63
# TODO: Report back as changes are merged in
45
64
 
46
65
 
47
66
def transform_tree(from_tree, to_tree, interesting_ids=None):
48
 
    from_tree.lock_tree_write()
49
 
    operation = OperationWithCleanups(merge_inner)
50
 
    operation.add_cleanup(from_tree.unlock)
51
 
    operation.run_simple(from_tree.branch, to_tree, from_tree,
52
 
        ignore_zero=True, interesting_ids=interesting_ids, this_tree=from_tree)
53
 
 
54
 
 
55
 
class MergeHooks(hooks.Hooks):
56
 
 
57
 
    def __init__(self):
58
 
        hooks.Hooks.__init__(self)
59
 
        self.create_hook(hooks.HookPoint('merge_file_content',
60
 
            "Called with a bzrlib.merge.Merger object to create a per file "
61
 
            "merge object when starting a merge. "
62
 
            "Should return either None or a subclass of "
63
 
            "``bzrlib.merge.AbstractPerFileMerger``. "
64
 
            "Such objects will then be called per file "
65
 
            "that needs to be merged (including when one "
66
 
            "side has deleted the file and the other has changed it). "
67
 
            "See the AbstractPerFileMerger API docs for details on how it is "
68
 
            "used by merge.",
69
 
            (2, 1), None))
70
 
 
71
 
 
72
 
class AbstractPerFileMerger(object):
73
 
    """PerFileMerger objects are used by plugins extending merge for bzrlib.
74
 
 
75
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
76
 
    
77
 
    :ivar merger: The Merge3Merger performing the merge.
78
 
    """
79
 
 
80
 
    def __init__(self, merger):
81
 
        """Create a PerFileMerger for use with merger."""
82
 
        self.merger = merger
83
 
 
84
 
    def merge_contents(self, merge_params):
85
 
        """Attempt to merge the contents of a single file.
86
 
        
87
 
        :param merge_params: A bzrlib.merge.MergeHookParams
88
 
        :return : A tuple of (status, chunks), where status is one of
89
 
            'not_applicable', 'success', 'conflicted', or 'delete'.  If status
90
 
            is 'success' or 'conflicted', then chunks should be an iterable of
91
 
            strings for the new file contents.
92
 
        """
93
 
        return ('not applicable', None)
94
 
 
95
 
 
96
 
class PerFileMerger(AbstractPerFileMerger):
97
 
    """Merge individual files when self.file_matches returns True.
98
 
 
99
 
    This class is intended to be subclassed.  The file_matches and
100
 
    merge_matching methods should be overridden with concrete implementations.
101
 
    """
102
 
 
103
 
    def file_matches(self, params):
104
 
        """Return True if merge_matching should be called on this file.
105
 
 
106
 
        Only called with merges of plain files with no clear winner.
107
 
 
108
 
        Subclasses must override this.
109
 
        """
110
 
        raise NotImplementedError(self.file_matches)
111
 
 
112
 
    def get_filename(self, params, tree):
113
 
        """Lookup the filename (i.e. basename, not path), given a Tree (e.g.
114
 
        self.merger.this_tree) and a MergeHookParams.
115
 
        """
116
 
        return osutils.basename(tree.id2path(params.file_id))
117
 
 
118
 
    def get_filepath(self, params, tree):
119
 
        """Calculate the path to the file in a tree.
120
 
 
121
 
        :param params: A MergeHookParams describing the file to merge
122
 
        :param tree: a Tree, e.g. self.merger.this_tree.
123
 
        """
124
 
        return tree.id2path(params.file_id)
125
 
 
126
 
    def merge_contents(self, params):
127
 
        """Merge the contents of a single file."""
128
 
        # Check whether this custom merge logic should be used.
129
 
        if (
130
 
            # OTHER is a straight winner, rely on default merge.
131
 
            params.winner == 'other' or
132
 
            # THIS and OTHER aren't both files.
133
 
            not params.is_file_merge() or
134
 
            # The filename doesn't match *.xml
135
 
            not self.file_matches(params)):
136
 
            return 'not_applicable', None
137
 
        return self.merge_matching(params)
138
 
 
139
 
    def merge_matching(self, params):
140
 
        """Merge the contents of a single file that has matched the criteria
141
 
        in PerFileMerger.merge_contents (is a conflict, is a file,
142
 
        self.file_matches is True).
143
 
 
144
 
        Subclasses must override this.
145
 
        """
146
 
        raise NotImplementedError(self.merge_matching)
147
 
 
148
 
 
149
 
class ConfigurableFileMerger(PerFileMerger):
150
 
    """Merge individual files when configured via a .conf file.
151
 
 
152
 
    This is a base class for concrete custom file merging logic. Concrete
153
 
    classes should implement ``merge_text``.
154
 
 
155
 
    See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
156
 
    
157
 
    :ivar affected_files: The configured file paths to merge.
158
 
 
159
 
    :cvar name_prefix: The prefix to use when looking up configuration
160
 
        details. <name_prefix>_merge_files describes the files targeted by the
161
 
        hook for example.
162
 
        
163
 
    :cvar default_files: The default file paths to merge when no configuration
164
 
        is present.
165
 
    """
166
 
 
167
 
    name_prefix = None
168
 
    default_files = None
169
 
 
170
 
    def __init__(self, merger):
171
 
        super(ConfigurableFileMerger, self).__init__(merger)
172
 
        self.affected_files = None
173
 
        self.default_files = self.__class__.default_files or []
174
 
        self.name_prefix = self.__class__.name_prefix
175
 
        if self.name_prefix is None:
176
 
            raise ValueError("name_prefix must be set.")
177
 
 
178
 
    def file_matches(self, params):
179
 
        """Check whether the file should call the merge hook.
180
 
 
181
 
        <name_prefix>_merge_files configuration variable is a list of files
182
 
        that should use the hook.
183
 
        """
184
 
        affected_files = self.affected_files
185
 
        if affected_files is None:
186
 
            config = self.merger.this_branch.get_config()
187
 
            # Until bzr provides a better policy for caching the config, we
188
 
            # just add the part we're interested in to the params to avoid
189
 
            # reading the config files repeatedly (bazaar.conf, location.conf,
190
 
            # branch.conf).
191
 
            config_key = self.name_prefix + '_merge_files'
192
 
            affected_files = config.get_user_option_as_list(config_key)
193
 
            if affected_files is None:
194
 
                # If nothing was specified in the config, use the default.
195
 
                affected_files = self.default_files
196
 
            self.affected_files = affected_files
197
 
        if affected_files:
198
 
            filepath = self.get_filepath(params, self.merger.this_tree)
199
 
            if filepath in affected_files:
200
 
                return True
201
 
        return False
202
 
 
203
 
    def merge_matching(self, params):
204
 
        return self.merge_text(params)
205
 
 
206
 
    def merge_text(self, params):
207
 
        """Merge the byte contents of a single file.
208
 
 
209
 
        This is called after checking that the merge should be performed in
210
 
        merge_contents, and it should behave as per
211
 
        ``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
212
 
        """
213
 
        raise NotImplementedError(self.merge_text)
214
 
 
215
 
 
216
 
class MergeHookParams(object):
217
 
    """Object holding parameters passed to merge_file_content hooks.
218
 
 
219
 
    There are some fields hooks can access:
220
 
 
221
 
    :ivar file_id: the file ID of the file being merged
222
 
    :ivar trans_id: the transform ID for the merge of this file
223
 
    :ivar this_kind: kind of file_id in 'this' tree
224
 
    :ivar other_kind: kind of file_id in 'other' tree
225
 
    :ivar winner: one of 'this', 'other', 'conflict'
226
 
    """
227
 
 
228
 
    def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
229
 
            winner):
230
 
        self._merger = merger
231
 
        self.file_id = file_id
232
 
        self.trans_id = trans_id
233
 
        self.this_kind = this_kind
234
 
        self.other_kind = other_kind
235
 
        self.winner = winner
236
 
 
237
 
    def is_file_merge(self):
238
 
        """True if this_kind and other_kind are both 'file'."""
239
 
        return self.this_kind == 'file' and self.other_kind == 'file'
240
 
 
241
 
    @decorators.cachedproperty
242
 
    def base_lines(self):
243
 
        """The lines of the 'base' version of the file."""
244
 
        return self._merger.get_lines(self._merger.base_tree, self.file_id)
245
 
 
246
 
    @decorators.cachedproperty
247
 
    def this_lines(self):
248
 
        """The lines of the 'this' version of the file."""
249
 
        return self._merger.get_lines(self._merger.this_tree, self.file_id)
250
 
 
251
 
    @decorators.cachedproperty
252
 
    def other_lines(self):
253
 
        """The lines of the 'other' version of the file."""
254
 
        return self._merger.get_lines(self._merger.other_tree, self.file_id)
 
67
    merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
 
68
                interesting_ids=interesting_ids, this_tree=from_tree)
255
69
 
256
70
 
257
71
class Merger(object):
258
 
 
259
 
    hooks = MergeHooks()
260
 
 
261
72
    def __init__(self, this_branch, other_tree=None, base_tree=None,
262
 
                 this_tree=None, pb=None, change_reporter=None,
 
73
                 this_tree=None, pb=DummyProgress(), change_reporter=None,
263
74
                 recurse='down', revision_graph=None):
264
75
        object.__init__(self)
265
76
        self.this_branch = this_branch
278
89
        self.interesting_files = None
279
90
        self.show_base = False
280
91
        self.reprocess = False
281
 
        if pb is not None:
282
 
            warnings.warn("pb parameter to Merger() is deprecated and ignored")
 
92
        self._pb = pb
283
93
        self.pp = None
284
94
        self.recurse = recurse
285
95
        self.change_reporter = change_reporter
290
100
        self._is_criss_cross = None
291
101
        self._lca_trees = None
292
102
 
293
 
    def cache_trees_with_revision_ids(self, trees):
294
 
        """Cache any tree in trees if it has a revision_id."""
295
 
        for maybe_tree in trees:
296
 
            if maybe_tree is None:
297
 
                continue
298
 
            try:
299
 
                rev_id = maybe_tree.get_revision_id()
300
 
            except AttributeError:
301
 
                continue
302
 
            self._cached_trees[rev_id] = maybe_tree
303
 
 
304
103
    @property
305
104
    def revision_graph(self):
306
105
        if self._revision_graph is None:
333
132
                                      _set_base_is_other_ancestor)
334
133
 
335
134
    @staticmethod
336
 
    def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
 
135
    def from_uncommitted(tree, other_tree, pb):
337
136
        """Return a Merger for uncommitted changes in other_tree.
338
137
 
339
138
        :param tree: The tree to merge into
340
139
        :param other_tree: The tree to get uncommitted changes from
341
140
        :param pb: A progress indicator
342
 
        :param base_tree: The basis to use for the merge.  If unspecified,
343
 
            other_tree.basis_tree() will be used.
344
141
        """
345
 
        if base_tree is None:
346
 
            base_tree = other_tree.basis_tree()
347
 
        merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
 
142
        merger = Merger(tree.branch, other_tree, other_tree.basis_tree(), tree,
 
143
                        pb)
348
144
        merger.base_rev_id = merger.base_tree.get_revision_id()
349
145
        merger.other_rev_id = None
350
146
        merger.other_basis = merger.base_rev_id
368
164
                base_revision_id, tree.branch.last_revision())):
369
165
                base_revision_id = None
370
166
            else:
371
 
                trace.warning('Performing cherrypick')
 
167
                warning('Performing cherrypick')
372
168
        merger = klass.from_revision_ids(pb, tree, other_revision_id,
373
169
                                         base_revision_id, revision_graph=
374
170
                                         revision_graph)
380
176
                          tree_branch=None):
381
177
        """Return a Merger for revision-ids.
382
178
 
383
 
        :param pb: A progress indicator
384
179
        :param tree: The tree to merge changes into
385
180
        :param other: The revision-id to use as OTHER
386
181
        :param base: The revision-id to use as BASE.  If not specified, will
391
186
            not supplied, other_branch or tree.branch will be used.
392
187
        :param revision_graph: If you have a revision_graph precomputed, pass
393
188
            it in, otherwise it will be created for you.
394
 
        :param tree_branch: The branch associated with tree.  If not supplied,
395
 
            tree.branch will be used.
 
189
        :param pb: A progress indicator
396
190
        """
397
191
        if tree_branch is None:
398
192
            tree_branch = tree.branch
426
220
        if revno is None:
427
221
            tree = workingtree.WorkingTree.open_containing(location)[0]
428
222
            return tree.branch, tree
429
 
        branch = _mod_branch.Branch.open_containing(
430
 
            location, possible_transports)[0]
 
223
        branch = Branch.open_containing(location, possible_transports)[0]
431
224
        if revno == -1:
432
225
            revision_id = branch.last_revision()
433
226
        else:
434
227
            revision_id = branch.get_rev_id(revno)
435
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
228
        revision_id = ensure_null(revision_id)
436
229
        return branch, self.revision_tree(revision_id, branch)
437
230
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
439
231
    def ensure_revision_trees(self):
440
232
        if self.this_revision_tree is None:
441
233
            self.this_basis_tree = self.revision_tree(self.this_basis)
444
236
 
445
237
        if self.other_rev_id is None:
446
238
            other_basis_tree = self.revision_tree(self.other_basis)
447
 
            if other_basis_tree.has_changes(self.other_tree):
448
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
239
            changes = other_basis_tree.changes_from(self.other_tree)
 
240
            if changes.has_changed():
 
241
                raise WorkingTreeNotRevision(self.this_tree)
449
242
            other_rev_id = self.other_basis
450
243
            self.other_tree = other_basis_tree
451
244
 
452
 
    @deprecated_method(deprecated_in((2, 1, 0)))
453
245
    def file_revisions(self, file_id):
454
246
        self.ensure_revision_trees()
455
247
        def get_id(tree, file_id):
458
250
        if self.this_rev_id is None:
459
251
            if self.this_basis_tree.get_file_sha1(file_id) != \
460
252
                self.this_tree.get_file_sha1(file_id):
461
 
                raise errors.WorkingTreeNotRevision(self.this_tree)
 
253
                raise WorkingTreeNotRevision(self.this_tree)
462
254
 
463
255
        trees = (self.this_basis_tree, self.other_tree)
464
256
        return [get_id(tree, file_id) for tree in trees]
465
257
 
466
 
    @deprecated_method(deprecated_in((2, 1, 0)))
467
258
    def check_basis(self, check_clean, require_commits=True):
468
259
        if self.this_basis is None and require_commits is True:
469
 
            raise errors.BzrCommandError(
470
 
                "This branch has no commits."
471
 
                " (perhaps you would prefer 'bzr pull')")
 
260
            raise BzrCommandError("This branch has no commits."
 
261
                                  " (perhaps you would prefer 'bzr pull')")
472
262
        if check_clean:
473
263
            self.compare_basis()
474
264
            if self.this_basis != self.this_rev_id:
475
265
                raise errors.UncommittedChanges(self.this_tree)
476
266
 
477
 
    @deprecated_method(deprecated_in((2, 1, 0)))
478
267
    def compare_basis(self):
479
268
        try:
480
269
            basis_tree = self.revision_tree(self.this_tree.last_revision())
481
270
        except errors.NoSuchRevision:
482
271
            basis_tree = self.this_tree.basis_tree()
483
 
        if not self.this_tree.has_changes(basis_tree):
 
272
        changes = self.this_tree.changes_from(basis_tree)
 
273
        if not changes.has_changed():
484
274
            self.this_rev_id = self.this_basis
485
275
 
486
276
    def set_interesting_files(self, file_list):
487
277
        self.interesting_files = file_list
488
278
 
489
279
    def set_pending(self):
490
 
        if (not self.base_is_ancestor or not self.base_is_other_ancestor
491
 
            or self.other_rev_id is None):
 
280
        if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
492
281
            return
493
282
        self._add_parent()
494
283
 
495
284
    def _add_parent(self):
496
285
        new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
497
286
        new_parent_trees = []
498
 
        operation = OperationWithCleanups(self.this_tree.set_parent_trees)
499
287
        for revision_id in new_parents:
500
288
            try:
501
289
                tree = self.revision_tree(revision_id)
503
291
                tree = None
504
292
            else:
505
293
                tree.lock_read()
506
 
                operation.add_cleanup(tree.unlock)
507
294
            new_parent_trees.append((revision_id, tree))
508
 
        operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
 
295
        try:
 
296
            self.this_tree.set_parent_trees(new_parent_trees,
 
297
                                            allow_leftmost_as_ghost=True)
 
298
        finally:
 
299
            for _revision_id, tree in new_parent_trees:
 
300
                if tree is not None:
 
301
                    tree.unlock()
509
302
 
510
303
    def set_other(self, other_revision, possible_transports=None):
511
304
        """Set the revision and tree to merge from.
520
313
            self.other_rev_id = _mod_revision.ensure_null(
521
314
                self.other_branch.last_revision())
522
315
            if _mod_revision.is_null(self.other_rev_id):
523
 
                raise errors.NoCommits(self.other_branch)
 
316
                raise NoCommits(self.other_branch)
524
317
            self.other_basis = self.other_rev_id
525
318
        elif other_revision[1] is not None:
526
319
            self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
529
322
            self.other_rev_id = None
530
323
            self.other_basis = self.other_branch.last_revision()
531
324
            if self.other_basis is None:
532
 
                raise errors.NoCommits(self.other_branch)
 
325
                raise NoCommits(self.other_branch)
533
326
        if self.other_rev_id is not None:
534
327
            self._cached_trees[self.other_rev_id] = self.other_tree
535
328
        self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
562
355
            target.fetch(source, revision_id)
563
356
 
564
357
    def find_base(self):
565
 
        revisions = [_mod_revision.ensure_null(self.this_basis),
566
 
                     _mod_revision.ensure_null(self.other_basis)]
567
 
        if _mod_revision.NULL_REVISION in revisions:
568
 
            self.base_rev_id = _mod_revision.NULL_REVISION
 
358
        revisions = [ensure_null(self.this_basis),
 
359
                     ensure_null(self.other_basis)]
 
360
        if NULL_REVISION in revisions:
 
361
            self.base_rev_id = NULL_REVISION
569
362
            self.base_tree = self.revision_tree(self.base_rev_id)
570
363
            self._is_criss_cross = False
571
364
        else:
572
365
            lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
573
366
            self._is_criss_cross = False
574
367
            if len(lcas) == 0:
575
 
                self.base_rev_id = _mod_revision.NULL_REVISION
 
368
                self.base_rev_id = NULL_REVISION
576
369
            elif len(lcas) == 1:
577
370
                self.base_rev_id = list(lcas)[0]
578
371
            else: # len(lcas) > 1
587
380
                    self.base_rev_id = self.revision_graph.find_unique_lca(
588
381
                                            *lcas)
589
382
                self._is_criss_cross = True
590
 
            if self.base_rev_id == _mod_revision.NULL_REVISION:
591
 
                raise errors.UnrelatedBranches()
 
383
            if self.base_rev_id == NULL_REVISION:
 
384
                raise UnrelatedBranches()
592
385
            if self._is_criss_cross:
593
 
                trace.warning('Warning: criss-cross merge encountered.  See bzr'
594
 
                              ' help criss-cross.')
595
 
                trace.mutter('Criss-cross lcas: %r' % lcas)
 
386
                warning('Warning: criss-cross merge encountered.  See bzr'
 
387
                        ' help criss-cross.')
596
388
                interesting_revision_ids = [self.base_rev_id]
597
389
                interesting_revision_ids.extend(lcas)
598
390
                interesting_trees = dict((t.get_revision_id(), t)
608
400
                self.base_tree = self.revision_tree(self.base_rev_id)
609
401
        self.base_is_ancestor = True
610
402
        self.base_is_other_ancestor = True
611
 
        trace.mutter('Base revid: %r' % self.base_rev_id)
612
403
 
613
404
    def set_base(self, base_revision):
614
405
        """Set the base revision to use for the merge.
615
406
 
616
407
        :param base_revision: A 2-list containing a path and revision number.
617
408
        """
618
 
        trace.mutter("doing merge() with no base_revision specified")
 
409
        mutter("doing merge() with no base_revision specified")
619
410
        if base_revision == [None, None]:
620
411
            self.find_base()
621
412
        else:
634
425
                  'other_tree': self.other_tree,
635
426
                  'interesting_ids': self.interesting_ids,
636
427
                  'interesting_files': self.interesting_files,
637
 
                  'this_branch': self.this_branch,
 
428
                  'pp': self.pp,
638
429
                  'do_merge': False}
639
430
        if self.merge_type.requires_base:
640
431
            kwargs['base_tree'] = self.base_tree
641
432
        if self.merge_type.supports_reprocess:
642
433
            kwargs['reprocess'] = self.reprocess
643
434
        elif self.reprocess:
644
 
            raise errors.BzrError(
645
 
                "Conflict reduction is not supported for merge"
646
 
                " type %s." % self.merge_type)
 
435
            raise BzrError("Conflict reduction is not supported for merge"
 
436
                                  " type %s." % self.merge_type)
647
437
        if self.merge_type.supports_show_base:
648
438
            kwargs['show_base'] = self.show_base
649
439
        elif self.show_base:
650
 
            raise errors.BzrError("Showing base is not supported for this"
651
 
                                  " merge type. %s" % self.merge_type)
 
440
            raise BzrError("Showing base is not supported for this"
 
441
                           " merge type. %s" % self.merge_type)
652
442
        if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
653
443
            and not self.base_is_other_ancestor):
654
444
            raise errors.CannotReverseCherrypick()
658
448
        if self._is_criss_cross and getattr(self.merge_type,
659
449
                                            'supports_lca_trees', False):
660
450
            kwargs['lca_trees'] = self._lca_trees
661
 
        return self.merge_type(pb=None,
 
451
        return self.merge_type(pb=self._pb,
662
452
                               change_reporter=self.change_reporter,
663
453
                               **kwargs)
664
454
 
665
 
    def _do_merge_to(self):
666
 
        merge = self.make_merger()
667
 
        if self.other_branch is not None:
668
 
            self.other_branch.update_references(self.this_branch)
 
455
    def _do_merge_to(self, merge):
669
456
        merge.do_merge()
670
457
        if self.recurse == 'down':
671
458
            for relpath, file_id in self.this_tree.iter_references():
683
470
                    sub_tree.branch.repository.revision_tree(base_revision)
684
471
                sub_merge.base_rev_id = base_revision
685
472
                sub_merge.do_merge()
686
 
        return merge
687
 
 
 
473
        
688
474
    def do_merge(self):
689
 
        operation = OperationWithCleanups(self._do_merge_to)
690
475
        self.this_tree.lock_tree_write()
691
 
        operation.add_cleanup(self.this_tree.unlock)
692
 
        if self.base_tree is not None:
693
 
            self.base_tree.lock_read()
694
 
            operation.add_cleanup(self.base_tree.unlock)
695
 
        if self.other_tree is not None:
696
 
            self.other_tree.lock_read()
697
 
            operation.add_cleanup(self.other_tree.unlock)
698
 
        merge = operation.run_simple()
 
476
        try:
 
477
            if self.base_tree is not None:
 
478
                self.base_tree.lock_read()
 
479
            try:
 
480
                if self.other_tree is not None:
 
481
                    self.other_tree.lock_read()
 
482
                try:
 
483
                    merge = self.make_merger()
 
484
                    self._do_merge_to(merge)
 
485
                finally:
 
486
                    if self.other_tree is not None:
 
487
                        self.other_tree.unlock()
 
488
            finally:
 
489
                if self.base_tree is not None:
 
490
                    self.base_tree.unlock()
 
491
        finally:
 
492
            self.this_tree.unlock()
699
493
        if len(merge.cooked_conflicts) == 0:
700
 
            if not self.ignore_zero and not trace.is_quiet():
701
 
                trace.note("All changes applied successfully.")
 
494
            if not self.ignore_zero and not is_quiet():
 
495
                note("All changes applied successfully.")
702
496
        else:
703
 
            trace.note("%d conflicts encountered."
704
 
                       % len(merge.cooked_conflicts))
 
497
            note("%d conflicts encountered." % len(merge.cooked_conflicts))
705
498
 
706
499
        return len(merge.cooked_conflicts)
707
500
 
734
527
    winner_idx = {"this": 2, "other": 1, "conflict": 1}
735
528
    supports_lca_trees = True
736
529
 
737
 
    def __init__(self, working_tree, this_tree, base_tree, other_tree,
 
530
    def __init__(self, working_tree, this_tree, base_tree, other_tree, 
738
531
                 interesting_ids=None, reprocess=False, show_base=False,
739
 
                 pb=None, pp=None, change_reporter=None,
 
532
                 pb=DummyProgress(), pp=None, change_reporter=None,
740
533
                 interesting_files=None, do_merge=True,
741
 
                 cherrypick=False, lca_trees=None, this_branch=None):
 
534
                 cherrypick=False, lca_trees=None):
742
535
        """Initialize the merger object and perform the merge.
743
536
 
744
537
        :param working_tree: The working tree to apply the merge to
745
538
        :param this_tree: The local tree in the merge operation
746
539
        :param base_tree: The common tree in the merge operation
747
 
        :param other_tree: The other tree to merge changes from
748
 
        :param this_branch: The branch associated with this_tree.  Defaults to
749
 
            this_tree.branch if not supplied.
 
540
        :param other_tree: The other other tree to merge changes from
750
541
        :param interesting_ids: The file_ids of files that should be
751
542
            participate in the merge.  May not be combined with
752
543
            interesting_files.
753
544
        :param: reprocess If True, perform conflict-reduction processing.
754
545
        :param show_base: If True, show the base revision in text conflicts.
755
546
            (incompatible with reprocess)
756
 
        :param pb: ignored
 
547
        :param pb: A Progress bar
757
548
        :param pp: A ProgressPhase object
758
549
        :param change_reporter: An object that should report changes made
759
550
        :param interesting_files: The tree-relative paths of files that should
770
561
        if interesting_files is not None and interesting_ids is not None:
771
562
            raise ValueError(
772
563
                'specify either interesting_ids or interesting_files')
773
 
        if this_branch is None:
774
 
            this_branch = this_tree.branch
775
564
        self.interesting_ids = interesting_ids
776
565
        self.interesting_files = interesting_files
777
566
        self.this_tree = working_tree
778
567
        self.base_tree = base_tree
779
568
        self.other_tree = other_tree
780
 
        self.this_branch = this_branch
781
569
        self._raw_conflicts = []
782
570
        self.cooked_conflicts = []
783
571
        self.reprocess = reprocess
788
576
        # making sure we haven't missed any corner cases.
789
577
        # if lca_trees is None:
790
578
        #     self._lca_trees = [self.base_tree]
 
579
        self.pb = pb
 
580
        self.pp = pp
791
581
        self.change_reporter = change_reporter
792
582
        self.cherrypick = cherrypick
 
583
        if self.pp is None:
 
584
            self.pp = ProgressPhase("Merge phase", 3, self.pb)
793
585
        if do_merge:
794
586
            self.do_merge()
795
 
        if pp is not None:
796
 
            warnings.warn("pp argument to Merge3Merger is deprecated")
797
 
        if pb is not None:
798
 
            warnings.warn("pb argument to Merge3Merger is deprecated")
799
587
 
800
588
    def do_merge(self):
801
 
        operation = OperationWithCleanups(self._do_merge)
802
589
        self.this_tree.lock_tree_write()
803
 
        operation.add_cleanup(self.this_tree.unlock)
804
590
        self.base_tree.lock_read()
805
 
        operation.add_cleanup(self.base_tree.unlock)
806
591
        self.other_tree.lock_read()
807
 
        operation.add_cleanup(self.other_tree.unlock)
808
 
        operation.run()
809
 
 
810
 
    def _do_merge(self, operation):
811
 
        self.tt = transform.TreeTransform(self.this_tree, None)
812
 
        operation.add_cleanup(self.tt.finalize)
813
 
        self._compute_transform()
814
 
        results = self.tt.apply(no_conflicts=True)
815
 
        self.write_modified(results)
 
592
        self.tt = TreeTransform(self.this_tree, self.pb)
816
593
        try:
817
 
            self.this_tree.add_conflicts(self.cooked_conflicts)
818
 
        except errors.UnsupportedOperation:
819
 
            pass
 
594
            self.pp.next_phase()
 
595
            self._compute_transform()
 
596
            self.pp.next_phase()
 
597
            results = self.tt.apply(no_conflicts=True)
 
598
            self.write_modified(results)
 
599
            try:
 
600
                self.this_tree.add_conflicts(self.cooked_conflicts)
 
601
            except UnsupportedOperation:
 
602
                pass
 
603
        finally:
 
604
            self.tt.finalize()
 
605
            self.other_tree.unlock()
 
606
            self.base_tree.unlock()
 
607
            self.this_tree.unlock()
 
608
            self.pb.clear()
820
609
 
821
610
    def make_preview_transform(self):
822
 
        operation = OperationWithCleanups(self._make_preview_transform)
823
611
        self.base_tree.lock_read()
824
 
        operation.add_cleanup(self.base_tree.unlock)
825
612
        self.other_tree.lock_read()
826
 
        operation.add_cleanup(self.other_tree.unlock)
827
 
        return operation.run_simple()
828
 
 
829
 
    def _make_preview_transform(self):
830
 
        self.tt = transform.TransformPreview(self.this_tree)
831
 
        self._compute_transform()
 
613
        self.tt = TransformPreview(self.this_tree)
 
614
        try:
 
615
            self.pp.next_phase()
 
616
            self._compute_transform()
 
617
            self.pp.next_phase()
 
618
        finally:
 
619
            self.other_tree.unlock()
 
620
            self.base_tree.unlock()
 
621
            self.pb.clear()
832
622
        return self.tt
833
623
 
834
624
    def _compute_transform(self):
840
630
            resolver = self._lca_multi_way
841
631
        child_pb = ui.ui_factory.nested_progress_bar()
842
632
        try:
843
 
            factories = Merger.hooks['merge_file_content']
844
 
            hooks = [factory(self) for factory in factories] + [self]
845
 
            self.active_hooks = [hook for hook in hooks if hook is not None]
846
633
            for num, (file_id, changed, parents3, names3,
847
634
                      executable3) in enumerate(entries):
848
635
                child_pb.update('Preparing file merge', num, len(entries))
849
636
                self._merge_names(file_id, parents3, names3, resolver=resolver)
850
637
                if changed:
851
 
                    file_status = self._do_merge_contents(file_id)
 
638
                    file_status = self.merge_contents(file_id)
852
639
                else:
853
640
                    file_status = 'unmodified'
854
641
                self._merge_executable(file_id,
856
643
        finally:
857
644
            child_pb.finished()
858
645
        self.fix_root()
 
646
        self.pp.next_phase()
859
647
        child_pb = ui.ui_factory.nested_progress_bar()
860
648
        try:
861
 
            fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
862
 
                lambda t, c: transform.conflict_pass(t, c, self.other_tree))
 
649
            fs_conflicts = resolve_conflicts(self.tt, child_pb,
 
650
                lambda t, c: conflict_pass(t, c, self.other_tree))
863
651
        finally:
864
652
            child_pb.finished()
865
653
        if self.change_reporter is not None:
868
656
                self.tt.iter_changes(), self.change_reporter)
869
657
        self.cook_conflicts(fs_conflicts)
870
658
        for conflict in self.cooked_conflicts:
871
 
            trace.warning(conflict)
 
659
            warning(conflict)
872
660
 
873
661
    def _entries3(self):
874
662
        """Gather data about files modified between three trees.
1001
789
            content_changed = True
1002
790
            if kind_winner == 'this':
1003
791
                # No kind change in OTHER, see if there are *any* changes
1004
 
                if other_ie.kind == 'directory':
 
792
                if other_ie.kind == None:
 
793
                    # No content and 'this' wins the kind, so skip this?
 
794
                    # continue
 
795
                    pass
 
796
                elif other_ie.kind == 'directory':
1005
797
                    if parent_id_winner == 'this' and name_winner == 'this':
1006
798
                        # No change for this directory in OTHER, skip
1007
799
                        continue
1008
800
                    content_changed = False
1009
 
                elif other_ie.kind is None or other_ie.kind == 'file':
 
801
                elif other_ie.kind == 'file':
1010
802
                    def get_sha1(ie, tree):
1011
803
                        if ie.kind != 'file':
1012
804
                            return None
1059
851
                        continue
1060
852
                else:
1061
853
                    raise AssertionError('unhandled kind: %s' % other_ie.kind)
 
854
                # XXX: We need to handle kind == 'symlink'
1062
855
 
1063
856
            # If we have gotten this far, that means something has changed
1064
857
            result.append((file_id, content_changed,
1075
868
    def fix_root(self):
1076
869
        try:
1077
870
            self.tt.final_kind(self.tt.root)
1078
 
        except errors.NoSuchFile:
 
871
        except NoSuchFile:
1079
872
            self.tt.cancel_deletion(self.tt.root)
1080
873
        if self.tt.final_file_id(self.tt.root) is None:
1081
 
            self.tt.version_file(self.tt.tree_file_id(self.tt.root),
 
874
            self.tt.version_file(self.tt.tree_file_id(self.tt.root), 
1082
875
                                 self.tt.root)
 
876
        if self.other_tree.inventory.root is None:
 
877
            return
1083
878
        other_root_file_id = self.other_tree.get_root_id()
1084
 
        if other_root_file_id is None:
1085
 
            return
1086
879
        other_root = self.tt.trans_id_file_id(other_root_file_id)
1087
880
        if other_root == self.tt.root:
1088
881
            return
 
882
        try:
 
883
            self.tt.final_kind(other_root)
 
884
        except NoSuchFile:
 
885
            return
1089
886
        if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
1090
 
            # the other tree's root is a non-root in the current tree (as when
1091
 
            # a previously unrelated branch is merged into another)
 
887
            # the other tree's root is a non-root in the current tree
1092
888
            return
1093
 
        try:
1094
 
            self.tt.final_kind(other_root)
1095
 
            other_root_is_present = True
1096
 
        except errors.NoSuchFile:
1097
 
            # other_root doesn't have a physical representation. We still need
1098
 
            # to move any references to the actual root of the tree.
1099
 
            other_root_is_present = False
1100
 
        # 'other_tree.inventory.root' is not present in this tree. We are
1101
 
        # calling adjust_path for children which *want* to be present with a
1102
 
        # correct place to go.
1103
 
        for thing, child in self.other_tree.inventory.root.children.iteritems():
 
889
        self.reparent_children(self.other_tree.inventory.root, self.tt.root)
 
890
        self.tt.cancel_creation(other_root)
 
891
        self.tt.cancel_versioning(other_root)
 
892
 
 
893
    def reparent_children(self, ie, target):
 
894
        for thing, child in ie.children.iteritems():
1104
895
            trans_id = self.tt.trans_id_file_id(child.file_id)
1105
 
            if not other_root_is_present:
1106
 
                # FIXME: Make final_kind returns None instead of raising
1107
 
                # NoSuchFile to avoid the ugly construct below -- vila 20100402
1108
 
                try:
1109
 
                    self.tt.final_kind(trans_id)
1110
 
                    # The item exist in the final tree and has a defined place
1111
 
                    # to go already.
1112
 
                    continue
1113
 
                except errors.NoSuchFile, e:
1114
 
                    pass
1115
 
            # Move the item into the root
1116
 
            self.tt.adjust_path(self.tt.final_name(trans_id),
1117
 
                                self.tt.root, trans_id)
1118
 
        if other_root_is_present:
1119
 
            self.tt.cancel_creation(other_root)
1120
 
            self.tt.cancel_versioning(other_root)
 
896
            self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1121
897
 
1122
898
    def write_modified(self, results):
1123
899
        modified_hashes = {}
1144
920
        if entry is None:
1145
921
            return None
1146
922
        return entry.name
1147
 
 
 
923
    
1148
924
    @staticmethod
1149
925
    def contents_sha1(tree, file_id):
1150
926
        """Determine the sha1 of the file contents (used as a key method)."""
1155
931
    @staticmethod
1156
932
    def executable(tree, file_id):
1157
933
        """Determine the executability of a file-id (used as a key method)."""
1158
 
        if not tree.has_id(file_id):
 
934
        if file_id not in tree:
1159
935
            return None
1160
936
        if tree.kind(file_id) != "file":
1161
937
            return False
1164
940
    @staticmethod
1165
941
    def kind(tree, file_id):
1166
942
        """Determine the kind of a file-id (used as a key method)."""
1167
 
        if not tree.has_id(file_id):
 
943
        if file_id not in tree:
1168
944
            return None
1169
945
        return tree.kind(file_id)
1170
946
 
1171
947
    @staticmethod
1172
948
    def _three_way(base, other, this):
 
949
        #if base == other, either they all agree, or only THIS has changed.
1173
950
        if base == other:
1174
 
            # if 'base == other', either they all agree, or only 'this' has
1175
 
            # changed.
1176
951
            return 'this'
1177
952
        elif this not in (base, other):
1178
 
            # 'this' is neither 'base' nor 'other', so both sides changed
1179
953
            return 'conflict'
 
954
        # "Ambiguous clean merge" -- both sides have made the same change.
1180
955
        elif this == other:
1181
 
            # "Ambiguous clean merge" -- both sides have made the same change.
1182
956
            return "this"
 
957
        # this == base: only other has changed.
1183
958
        else:
1184
 
            # this == base: only other has changed.
1185
959
            return "other"
1186
960
 
1187
961
    @staticmethod
1200
974
        :return: 'this', 'other', or 'conflict' depending on whether an entry
1201
975
            changed or not.
1202
976
        """
1203
 
        # See doc/developers/lca_tree_merging.txt for details about this
 
977
        # See doc/developers/lca_merge_resolution.txt for details about this
1204
978
        # algorithm.
1205
979
        if other == this:
1206
980
            # Either Ambiguously clean, or nothing was actually changed. We
1231
1005
                # only has an lca value
1232
1006
                return 'other'
1233
1007
 
1234
 
        # At this point, the lcas disagree, and the tip disagree
 
1008
        # At this point, the lcas disagree, and the tips disagree
1235
1009
        return 'conflict'
1236
1010
 
1237
1011
    @staticmethod
1238
 
    @deprecated_method(deprecated_in((2, 2, 0)))
1239
1012
    def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1240
1013
        """Do a three-way test on a scalar.
1241
1014
        Return "this", "other" or "conflict", depending whether a value wins.
1256
1029
 
1257
1030
    def merge_names(self, file_id):
1258
1031
        def get_entry(tree):
1259
 
            if tree.has_id(file_id):
 
1032
            if file_id in tree.inventory:
1260
1033
                return tree.inventory[file_id]
1261
1034
            else:
1262
1035
                return None
1291
1064
                parent_id_winner = "other"
1292
1065
        if name_winner == "this" and parent_id_winner == "this":
1293
1066
            return
1294
 
        if name_winner == 'conflict' or parent_id_winner == 'conflict':
1295
 
            # Creating helpers (.OTHER or .THIS) here cause problems down the
1296
 
            # road if a ContentConflict needs to be created so we should not do
1297
 
            # that
1298
 
            trans_id = self.tt.trans_id_file_id(file_id)
1299
 
            self._raw_conflicts.append(('path conflict', trans_id, file_id,
1300
 
                                        this_parent, this_name,
1301
 
                                        other_parent, other_name))
 
1067
        if name_winner == "conflict":
 
1068
            trans_id = self.tt.trans_id_file_id(file_id)
 
1069
            self._raw_conflicts.append(('name conflict', trans_id, 
 
1070
                                        this_name, other_name))
 
1071
        if parent_id_winner == "conflict":
 
1072
            trans_id = self.tt.trans_id_file_id(file_id)
 
1073
            self._raw_conflicts.append(('parent conflict', trans_id, 
 
1074
                                        this_parent, other_parent))
1302
1075
        if other_name is None:
1303
 
            # it doesn't matter whether the result was 'other' or
 
1076
            # it doesn't matter whether the result was 'other' or 
1304
1077
            # 'conflict'-- if there's no 'other', we leave it alone.
1305
1078
            return
 
1079
        # if we get here, name_winner and parent_winner are set to safe values.
 
1080
        trans_id = self.tt.trans_id_file_id(file_id)
1306
1081
        parent_id = parents[self.winner_idx[parent_id_winner]]
1307
1082
        if parent_id is not None:
1308
 
            # if we get here, name_winner and parent_winner are set to safe
1309
 
            # values.
 
1083
            parent_trans_id = self.tt.trans_id_file_id(parent_id)
1310
1084
            self.tt.adjust_path(names[self.winner_idx[name_winner]],
1311
 
                                self.tt.trans_id_file_id(parent_id),
1312
 
                                self.tt.trans_id_file_id(file_id))
 
1085
                                parent_trans_id, trans_id)
1313
1086
 
1314
 
    def _do_merge_contents(self, file_id):
1315
 
        """Performs a merge on file_id contents."""
 
1087
    def merge_contents(self, file_id):
 
1088
        """Performa a merge on file_id contents."""
1316
1089
        def contents_pair(tree):
1317
1090
            if file_id not in tree:
1318
1091
                return (None, None)
1325
1098
                contents = None
1326
1099
            return kind, contents
1327
1100
 
 
1101
        def contents_conflict():
 
1102
            trans_id = self.tt.trans_id_file_id(file_id)
 
1103
            name = self.tt.final_name(trans_id)
 
1104
            parent_id = self.tt.final_parent(trans_id)
 
1105
            if file_id in self.this_tree.inventory:
 
1106
                self.tt.unversion_file(trans_id)
 
1107
                if file_id in self.this_tree:
 
1108
                    self.tt.delete_contents(trans_id)
 
1109
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
1110
                                              set_version=True)
 
1111
            self._raw_conflicts.append(('contents conflict', file_group))
 
1112
 
1328
1113
        # See SPOT run.  run, SPOT, run.
1329
1114
        # So we're not QUITE repeating ourselves; we do tricky things with
1330
1115
        # file kind...
1331
1116
        base_pair = contents_pair(self.base_tree)
1332
1117
        other_pair = contents_pair(self.other_tree)
1333
 
        if self._lca_trees:
1334
 
            this_pair = contents_pair(self.this_tree)
1335
 
            lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1336
 
            winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1337
 
                                         this_pair, allow_overriding_lca=False)
1338
 
        else:
1339
 
            if base_pair == other_pair:
1340
 
                winner = 'this'
1341
 
            else:
1342
 
                # We delayed evaluating this_pair as long as we can to avoid
1343
 
                # unnecessary sha1 calculation
1344
 
                this_pair = contents_pair(self.this_tree)
1345
 
                winner = self._three_way(base_pair, other_pair, this_pair)
1346
 
        if winner == 'this':
1347
 
            # No interesting changes introduced by OTHER
1348
 
            return "unmodified"
1349
 
        # We have a hypothetical conflict, but if we have files, then we
1350
 
        # can try to merge the content
1351
 
        trans_id = self.tt.trans_id_file_id(file_id)
1352
 
        params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1353
 
            other_pair[0], winner)
1354
 
        hooks = self.active_hooks
1355
 
        hook_status = 'not_applicable'
1356
 
        for hook in hooks:
1357
 
            hook_status, lines = hook.merge_contents(params)
1358
 
            if hook_status != 'not_applicable':
1359
 
                # Don't try any more hooks, this one applies.
1360
 
                break
1361
 
        result = "modified"
1362
 
        if hook_status == 'not_applicable':
1363
 
            # This is a contents conflict, because none of the available
1364
 
            # functions could merge it.
1365
 
            result = None
1366
 
            name = self.tt.final_name(trans_id)
1367
 
            parent_id = self.tt.final_parent(trans_id)
1368
 
            if self.this_tree.has_id(file_id):
1369
 
                self.tt.unversion_file(trans_id)
1370
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1371
 
                                              set_version=True)
1372
 
            self._raw_conflicts.append(('contents conflict', file_group))
1373
 
        elif hook_status == 'success':
1374
 
            self.tt.create_file(lines, trans_id)
1375
 
        elif hook_status == 'conflicted':
1376
 
            # XXX: perhaps the hook should be able to provide
1377
 
            # the BASE/THIS/OTHER files?
1378
 
            self.tt.create_file(lines, trans_id)
1379
 
            self._raw_conflicts.append(('text conflict', trans_id))
1380
 
            name = self.tt.final_name(trans_id)
1381
 
            parent_id = self.tt.final_parent(trans_id)
1382
 
            self._dump_conflicts(name, parent_id, file_id)
1383
 
        elif hook_status == 'delete':
1384
 
            self.tt.unversion_file(trans_id)
1385
 
            result = "deleted"
1386
 
        elif hook_status == 'done':
1387
 
            # The hook function did whatever it needs to do directly, no
1388
 
            # further action needed here.
1389
 
            pass
1390
 
        else:
1391
 
            raise AssertionError('unknown hook_status: %r' % (hook_status,))
1392
 
        if not self.this_tree.has_id(file_id) and result == "modified":
1393
 
            self.tt.version_file(file_id, trans_id)
1394
 
        # The merge has been performed, so the old contents should not be
1395
 
        # retained.
1396
 
        try:
1397
 
            self.tt.delete_contents(trans_id)
1398
 
        except errors.NoSuchFile:
1399
 
            pass
1400
 
        return result
1401
 
 
1402
 
    def _default_other_winner_merge(self, merge_hook_params):
1403
 
        """Replace this contents with other."""
1404
 
        file_id = merge_hook_params.file_id
1405
 
        trans_id = merge_hook_params.trans_id
1406
 
        file_in_this = self.this_tree.has_id(file_id)
1407
 
        if self.other_tree.has_id(file_id):
1408
 
            # OTHER changed the file
1409
 
            wt = self.this_tree
1410
 
            if wt.supports_content_filtering():
1411
 
                # We get the path from the working tree if it exists.
1412
 
                # That fails though when OTHER is adding a file, so
1413
 
                # we fall back to the other tree to find the path if
1414
 
                # it doesn't exist locally.
1415
 
                try:
1416
 
                    filter_tree_path = wt.id2path(file_id)
1417
 
                except errors.NoSuchId:
1418
 
                    filter_tree_path = self.other_tree.id2path(file_id)
1419
 
            else:
1420
 
                # Skip the id2path lookup for older formats
1421
 
                filter_tree_path = None
1422
 
            transform.create_from_tree(self.tt, trans_id,
1423
 
                             self.other_tree, file_id,
1424
 
                             filter_tree_path=filter_tree_path)
1425
 
            return 'done', None
1426
 
        elif file_in_this:
1427
 
            # OTHER deleted the file
1428
 
            return 'delete', None
1429
 
        else:
1430
 
            raise AssertionError(
1431
 
                'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1432
 
                % (file_id,))
1433
 
 
1434
 
    def merge_contents(self, merge_hook_params):
1435
 
        """Fallback merge logic after user installed hooks."""
1436
 
        # This function is used in merge hooks as the fallback instance.
1437
 
        # Perhaps making this function and the functions it calls be a 
1438
 
        # a separate class would be better.
1439
 
        if merge_hook_params.winner == 'other':
1440
 
            # OTHER is a straight winner, so replace this contents with other
1441
 
            return self._default_other_winner_merge(merge_hook_params)
1442
 
        elif merge_hook_params.is_file_merge():
1443
 
            # THIS and OTHER are both files, so text merge.  Either
1444
 
            # BASE is a file, or both converted to files, so at least we
1445
 
            # have agreement that output should be a file.
1446
 
            try:
1447
 
                self.text_merge(merge_hook_params.file_id,
1448
 
                    merge_hook_params.trans_id)
1449
 
            except errors.BinaryFile:
1450
 
                return 'not_applicable', None
1451
 
            return 'done', None
1452
 
        else:
1453
 
            return 'not_applicable', None
 
1118
        if base_pair == other_pair:
 
1119
            # OTHER introduced no changes
 
1120
            return "unmodified"
 
1121
        this_pair = contents_pair(self.this_tree)
 
1122
        if this_pair == other_pair:
 
1123
            # THIS and OTHER introduced the same changes
 
1124
            return "unmodified"
 
1125
        else:
 
1126
            trans_id = self.tt.trans_id_file_id(file_id)
 
1127
            if this_pair == base_pair:
 
1128
                # only OTHER introduced changes
 
1129
                if file_id in self.this_tree:
 
1130
                    # Remove any existing contents
 
1131
                    self.tt.delete_contents(trans_id)
 
1132
                if file_id in self.other_tree:
 
1133
                    # OTHER changed the file
 
1134
                    create_by_entry(self.tt,
 
1135
                                    self.other_tree.inventory[file_id],
 
1136
                                    self.other_tree, trans_id)
 
1137
                    if file_id not in self.this_tree:
 
1138
                        self.tt.version_file(file_id, trans_id)
 
1139
                    return "modified"
 
1140
                elif file_id in self.this_tree.inventory:
 
1141
                    # OTHER deleted the file
 
1142
                    self.tt.unversion_file(trans_id)
 
1143
                    return "deleted"
 
1144
            #BOTH THIS and OTHER introduced changes; scalar conflict
 
1145
            elif this_pair[0] == "file" and other_pair[0] == "file":
 
1146
                # THIS and OTHER are both files, so text merge.  Either
 
1147
                # BASE is a file, or both converted to files, so at least we
 
1148
                # have agreement that output should be a file.
 
1149
                try:
 
1150
                    self.text_merge(file_id, trans_id)
 
1151
                except BinaryFile:
 
1152
                    return contents_conflict()
 
1153
                if file_id not in self.this_tree:
 
1154
                    self.tt.version_file(file_id, trans_id)
 
1155
                try:
 
1156
                    self.tt.tree_kind(trans_id)
 
1157
                    self.tt.delete_contents(trans_id)
 
1158
                except NoSuchFile:
 
1159
                    pass
 
1160
                return "modified"
 
1161
            else:
 
1162
                # Scalar conflict, can't text merge.  Dump conflicts
 
1163
                return contents_conflict()
1454
1164
 
1455
1165
    def get_lines(self, tree, file_id):
1456
1166
        """Return the lines in a file, or an empty list."""
1457
 
        if tree.has_id(file_id):
 
1167
        if file_id in tree:
1458
1168
            return tree.get_file(file_id).readlines()
1459
1169
        else:
1460
1170
            return []
1463
1173
        """Perform a three-way text merge on a file_id"""
1464
1174
        # it's possible that we got here with base as a different type.
1465
1175
        # if so, we just want two-way text conflicts.
1466
 
        if self.base_tree.has_id(file_id) and \
 
1176
        if file_id in self.base_tree and \
1467
1177
            self.base_tree.kind(file_id) == "file":
1468
1178
            base_lines = self.get_lines(self.base_tree, file_id)
1469
1179
        else:
1470
1180
            base_lines = []
1471
1181
        other_lines = self.get_lines(self.other_tree, file_id)
1472
1182
        this_lines = self.get_lines(self.this_tree, file_id)
1473
 
        m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1474
 
                           is_cherrypick=self.cherrypick)
 
1183
        m3 = Merge3(base_lines, this_lines, other_lines,
 
1184
                    is_cherrypick=self.cherrypick)
1475
1185
        start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1476
1186
        if self.show_base is True:
1477
1187
            base_marker = '|' * 7
1480
1190
 
1481
1191
        def iter_merge3(retval):
1482
1192
            retval["text_conflicts"] = False
1483
 
            for line in m3.merge_lines(name_a = "TREE",
1484
 
                                       name_b = "MERGE-SOURCE",
 
1193
            for line in m3.merge_lines(name_a = "TREE", 
 
1194
                                       name_b = "MERGE-SOURCE", 
1485
1195
                                       name_base = "BASE-REVISION",
1486
 
                                       start_marker=start_marker,
 
1196
                                       start_marker=start_marker, 
1487
1197
                                       base_marker=base_marker,
1488
1198
                                       reprocess=self.reprocess):
1489
1199
                if line.startswith(start_marker):
1498
1208
            self._raw_conflicts.append(('text conflict', trans_id))
1499
1209
            name = self.tt.final_name(trans_id)
1500
1210
            parent_id = self.tt.final_parent(trans_id)
1501
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
 
1211
            file_group = self._dump_conflicts(name, parent_id, file_id, 
1502
1212
                                              this_lines, base_lines,
1503
1213
                                              other_lines)
1504
1214
            file_group.append(trans_id)
1505
1215
 
1506
 
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
 
1216
    def _dump_conflicts(self, name, parent_id, file_id, this_lines=None, 
1507
1217
                        base_lines=None, other_lines=None, set_version=False,
1508
1218
                        no_base=False):
1509
1219
        """Emit conflict files.
1511
1221
        determined automatically.  If set_version is true, the .OTHER, .THIS
1512
1222
        or .BASE (in that order) will be created as versioned files.
1513
1223
        """
1514
 
        data = [('OTHER', self.other_tree, other_lines),
 
1224
        data = [('OTHER', self.other_tree, other_lines), 
1515
1225
                ('THIS', self.this_tree, this_lines)]
1516
1226
        if not no_base:
1517
1227
            data.append(('BASE', self.base_tree, base_lines))
1518
 
 
1519
 
        # We need to use the actual path in the working tree of the file here,
1520
 
        # ignoring the conflict suffixes
1521
 
        wt = self.this_tree
1522
 
        if wt.supports_content_filtering():
1523
 
            try:
1524
 
                filter_tree_path = wt.id2path(file_id)
1525
 
            except errors.NoSuchId:
1526
 
                # file has been deleted
1527
 
                filter_tree_path = None
1528
 
        else:
1529
 
            # Skip the id2path lookup for older formats
1530
 
            filter_tree_path = None
1531
 
 
1532
1228
        versioned = False
1533
1229
        file_group = []
1534
1230
        for suffix, tree, lines in data:
1535
 
            if tree.has_id(file_id):
 
1231
            if file_id in tree:
1536
1232
                trans_id = self._conflict_file(name, parent_id, tree, file_id,
1537
 
                                               suffix, lines, filter_tree_path)
 
1233
                                               suffix, lines)
1538
1234
                file_group.append(trans_id)
1539
1235
                if set_version and not versioned:
1540
1236
                    self.tt.version_file(file_id, trans_id)
1541
1237
                    versioned = True
1542
1238
        return file_group
1543
 
 
1544
 
    def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1545
 
                       lines=None, filter_tree_path=None):
 
1239
           
 
1240
    def _conflict_file(self, name, parent_id, tree, file_id, suffix, 
 
1241
                       lines=None):
1546
1242
        """Emit a single conflict file."""
1547
1243
        name = name + '.' + suffix
1548
1244
        trans_id = self.tt.create_path(name, parent_id)
1549
 
        transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1550
 
            filter_tree_path)
 
1245
        entry = tree.inventory[file_id]
 
1246
        create_by_entry(self.tt, entry, tree, trans_id, lines)
1551
1247
        return trans_id
1552
1248
 
1553
1249
    def merge_executable(self, file_id, file_status):
1577
1273
        try:
1578
1274
            if self.tt.final_kind(trans_id) != "file":
1579
1275
                return
1580
 
        except errors.NoSuchFile:
 
1276
        except NoSuchFile:
1581
1277
            return
1582
1278
        if winner == "this":
1583
1279
            executability = this_executable
1584
1280
        else:
1585
 
            if self.other_tree.has_id(file_id):
 
1281
            if file_id in self.other_tree:
1586
1282
                executability = other_executable
1587
 
            elif self.this_tree.has_id(file_id):
 
1283
            elif file_id in self.this_tree:
1588
1284
                executability = this_executable
1589
 
            elif self.base_tree_has_id(file_id):
 
1285
            elif file_id in self.base_tree:
1590
1286
                executability = base_executable
1591
1287
        if executability is not None:
1592
1288
            trans_id = self.tt.trans_id_file_id(file_id)
1594
1290
 
1595
1291
    def cook_conflicts(self, fs_conflicts):
1596
1292
        """Convert all conflicts into a form that doesn't depend on trans_id"""
1597
 
        self.cooked_conflicts.extend(transform.cook_conflicts(
1598
 
                fs_conflicts, self.tt))
1599
 
        fp = transform.FinalPaths(self.tt)
 
1293
        from conflicts import Conflict
 
1294
        name_conflicts = {}
 
1295
        self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
 
1296
        fp = FinalPaths(self.tt)
1600
1297
        for conflict in self._raw_conflicts:
1601
1298
            conflict_type = conflict[0]
1602
 
            if conflict_type == 'path conflict':
1603
 
                (trans_id, file_id,
1604
 
                this_parent, this_name,
1605
 
                other_parent, other_name) = conflict[1:]
1606
 
                if this_parent is None or this_name is None:
1607
 
                    this_path = '<deleted>'
1608
 
                else:
1609
 
                    parent_path =  fp.get_path(
1610
 
                        self.tt.trans_id_file_id(this_parent))
1611
 
                    this_path = osutils.pathjoin(parent_path, this_name)
1612
 
                if other_parent is None or other_name is None:
1613
 
                    other_path = '<deleted>'
1614
 
                else:
1615
 
                    parent_path =  fp.get_path(
1616
 
                        self.tt.trans_id_file_id(other_parent))
1617
 
                    other_path = osutils.pathjoin(parent_path, other_name)
1618
 
                c = _mod_conflicts.Conflict.factory(
1619
 
                    'path conflict', path=this_path,
1620
 
                    conflict_path=other_path,
1621
 
                    file_id=file_id)
1622
 
            elif conflict_type == 'contents conflict':
 
1299
            if conflict_type in ('name conflict', 'parent conflict'):
 
1300
                trans_id = conflict[1]
 
1301
                conflict_args = conflict[2:]
 
1302
                if trans_id not in name_conflicts:
 
1303
                    name_conflicts[trans_id] = {}
 
1304
                unique_add(name_conflicts[trans_id], conflict_type, 
 
1305
                           conflict_args)
 
1306
            if conflict_type == 'contents conflict':
1623
1307
                for trans_id in conflict[1]:
1624
1308
                    file_id = self.tt.final_file_id(trans_id)
1625
1309
                    if file_id is not None:
1629
1313
                    if path.endswith(suffix):
1630
1314
                        path = path[:-len(suffix)]
1631
1315
                        break
1632
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1633
 
                                                    path=path, file_id=file_id)
1634
 
            elif conflict_type == 'text conflict':
 
1316
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1317
                self.cooked_conflicts.append(c)
 
1318
            if conflict_type == 'text conflict':
1635
1319
                trans_id = conflict[1]
1636
1320
                path = fp.get_path(trans_id)
1637
1321
                file_id = self.tt.final_file_id(trans_id)
1638
 
                c = _mod_conflicts.Conflict.factory(conflict_type,
1639
 
                                                    path=path, file_id=file_id)
 
1322
                c = Conflict.factory(conflict_type, path=path, file_id=file_id)
 
1323
                self.cooked_conflicts.append(c)
 
1324
 
 
1325
        for trans_id, conflicts in name_conflicts.iteritems():
 
1326
            try:
 
1327
                this_parent, other_parent = conflicts['parent conflict']
 
1328
                if this_parent == other_parent:
 
1329
                    raise AssertionError()
 
1330
            except KeyError:
 
1331
                this_parent = other_parent = \
 
1332
                    self.tt.final_file_id(self.tt.final_parent(trans_id))
 
1333
            try:
 
1334
                this_name, other_name = conflicts['name conflict']
 
1335
                if this_name == other_name:
 
1336
                    raise AssertionError()
 
1337
            except KeyError:
 
1338
                this_name = other_name = self.tt.final_name(trans_id)
 
1339
            other_path = fp.get_path(trans_id)
 
1340
            if this_parent is not None and this_name is not None:
 
1341
                this_parent_path = \
 
1342
                    fp.get_path(self.tt.trans_id_file_id(this_parent))
 
1343
                this_path = pathjoin(this_parent_path, this_name)
1640
1344
            else:
1641
 
                raise AssertionError('bad conflict type: %r' % (conflict,))
 
1345
                this_path = "<deleted>"
 
1346
            file_id = self.tt.final_file_id(trans_id)
 
1347
            c = Conflict.factory('path conflict', path=this_path,
 
1348
                                 conflict_path=other_path, file_id=file_id)
1642
1349
            self.cooked_conflicts.append(c)
1643
 
        self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
 
1350
        self.cooked_conflicts.sort(key=Conflict.sort_key)
1644
1351
 
1645
1352
 
1646
1353
class WeaveMerger(Merge3Merger):
1650
1357
    supports_reverse_cherrypick = False
1651
1358
    history_based = True
1652
1359
 
1653
 
    def _generate_merge_plan(self, file_id, base):
1654
 
        return self.this_tree.plan_file_merge(file_id, self.other_tree,
 
1360
    def _merged_lines(self, file_id):
 
1361
        """Generate the merged lines.
 
1362
        There is no distinction between lines that are meant to contain <<<<<<<
 
1363
        and conflicts.
 
1364
        """
 
1365
        if self.cherrypick:
 
1366
            base = self.base_tree
 
1367
        else:
 
1368
            base = None
 
1369
        plan = self.this_tree.plan_file_merge(file_id, self.other_tree,
1655
1370
                                              base=base)
1656
 
 
1657
 
    def _merged_lines(self, file_id):
1658
 
        """Generate the merged lines.
1659
 
        There is no distinction between lines that are meant to contain <<<<<<<
1660
 
        and conflicts.
1661
 
        """
1662
 
        if self.cherrypick:
1663
 
            base = self.base_tree
1664
 
        else:
1665
 
            base = None
1666
 
        plan = self._generate_merge_plan(file_id, base)
1667
1371
        if 'merge' in debug.debug_flags:
1668
1372
            plan = list(plan)
1669
1373
            trans_id = self.tt.trans_id_file_id(file_id)
1670
1374
            name = self.tt.final_name(trans_id) + '.plan'
1671
 
            contents = ('%11s|%s' % l for l in plan)
 
1375
            contents = ('%10s|%s' % l for l in plan)
1672
1376
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1673
 
        textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1674
 
                                                 '>>>>>>> MERGE-SOURCE\n')
1675
 
        lines, conflicts = textmerge.merge_lines(self.reprocess)
1676
 
        if conflicts:
1677
 
            base_lines = textmerge.base_from_plan()
1678
 
        else:
1679
 
            base_lines = None
1680
 
        return lines, base_lines
 
1377
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1378
            '>>>>>>> MERGE-SOURCE\n')
 
1379
        return textmerge.merge_lines(self.reprocess)
1681
1380
 
1682
1381
    def text_merge(self, file_id, trans_id):
1683
1382
        """Perform a (weave) text merge for a given file and file-id.
1684
1383
        If conflicts are encountered, .THIS and .OTHER files will be emitted,
1685
1384
        and a conflict will be noted.
1686
1385
        """
1687
 
        lines, base_lines = self._merged_lines(file_id)
 
1386
        lines, conflicts = self._merged_lines(file_id)
1688
1387
        lines = list(lines)
1689
 
        # Note we're checking whether the OUTPUT is binary in this case,
 
1388
        # Note we're checking whether the OUTPUT is binary in this case, 
1690
1389
        # because we don't want to get into weave merge guts.
1691
 
        textfile.check_text_lines(lines)
 
1390
        check_text_lines(lines)
1692
1391
        self.tt.create_file(lines, trans_id)
1693
 
        if base_lines is not None:
1694
 
            # Conflict
 
1392
        if conflicts:
1695
1393
            self._raw_conflicts.append(('text conflict', trans_id))
1696
1394
            name = self.tt.final_name(trans_id)
1697
1395
            parent_id = self.tt.final_parent(trans_id)
1698
 
            file_group = self._dump_conflicts(name, parent_id, file_id,
1699
 
                                              no_base=False,
1700
 
                                              base_lines=base_lines)
 
1396
            file_group = self._dump_conflicts(name, parent_id, file_id, 
 
1397
                                              no_base=True)
1701
1398
            file_group.append(trans_id)
1702
1399
 
1703
1400
 
1704
1401
class LCAMerger(WeaveMerger):
1705
1402
 
1706
 
    def _generate_merge_plan(self, file_id, base):
1707
 
        return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
 
1403
    def _merged_lines(self, file_id):
 
1404
        """Generate the merged lines.
 
1405
        There is no distinction between lines that are meant to contain <<<<<<<
 
1406
        and conflicts.
 
1407
        """
 
1408
        if self.cherrypick:
 
1409
            base = self.base_tree
 
1410
        else:
 
1411
            base = None
 
1412
        plan = self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1708
1413
                                                  base=base)
 
1414
        if 'merge' in debug.debug_flags:
 
1415
            plan = list(plan)
 
1416
            trans_id = self.tt.trans_id_file_id(file_id)
 
1417
            name = self.tt.final_name(trans_id) + '.plan'
 
1418
            contents = ('%10s|%s' % l for l in plan)
 
1419
            self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
 
1420
        textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
 
1421
            '>>>>>>> MERGE-SOURCE\n')
 
1422
        return textmerge.merge_lines(self.reprocess)
 
1423
 
1709
1424
 
1710
1425
class Diff3Merger(Merge3Merger):
1711
1426
    """Three-way merger using external diff3 for text merging"""
1712
1427
 
1713
1428
    def dump_file(self, temp_dir, name, tree, file_id):
1714
 
        out_path = osutils.pathjoin(temp_dir, name)
 
1429
        out_path = pathjoin(temp_dir, name)
1715
1430
        out_file = open(out_path, "wb")
1716
1431
        try:
1717
1432
            in_file = tree.get_file(file_id)
1729
1444
        import bzrlib.patch
1730
1445
        temp_dir = osutils.mkdtemp(prefix="bzr-")
1731
1446
        try:
1732
 
            new_file = osutils.pathjoin(temp_dir, "new")
 
1447
            new_file = pathjoin(temp_dir, "new")
1733
1448
            this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1734
1449
            base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1735
1450
            other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1736
1451
            status = bzrlib.patch.diff3(new_file, this, base, other)
1737
1452
            if status not in (0, 1):
1738
 
                raise errors.BzrError("Unhandled diff3 exit code")
 
1453
                raise BzrError("Unhandled diff3 exit code")
1739
1454
            f = open(new_file, 'rb')
1740
1455
            try:
1741
1456
                self.tt.create_file(f, trans_id)
1759
1474
                other_rev_id=None,
1760
1475
                interesting_files=None,
1761
1476
                this_tree=None,
1762
 
                pb=None,
 
1477
                pb=DummyProgress(),
1763
1478
                change_reporter=None):
1764
 
    """Primary interface for merging.
 
1479
    """Primary interface for merging. 
1765
1480
 
1766
 
        typical use is probably
 
1481
        typical use is probably 
1767
1482
        'merge_inner(branch, branch.get_revision_tree(other_revision),
1768
1483
                     branch.get_revision_tree(base_revision))'
1769
1484
        """
1770
1485
    if this_tree is None:
1771
 
        raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1772
 
                              "parameter as of bzrlib version 0.8.")
 
1486
        raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
 
1487
            "parameter as of bzrlib version 0.8.")
1773
1488
    merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1774
1489
                    pb=pb, change_reporter=change_reporter)
1775
1490
    merger.backup_files = backup_files
1788
1503
    get_revision_id = getattr(base_tree, 'get_revision_id', None)
1789
1504
    if get_revision_id is None:
1790
1505
        get_revision_id = base_tree.last_revision
1791
 
    merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1792
1506
    merger.set_base_revision(get_revision_id(), this_branch)
1793
1507
    return merger.do_merge()
1794
1508
 
1862
1576
 
1863
1577
    def get_lines(self, revisions):
1864
1578
        """Get lines for revisions from the backing VersionedFiles.
1865
 
 
 
1579
        
1866
1580
        :raises RevisionNotPresent: on absent texts.
1867
1581
        """
1868
1582
        keys = [(self._key_prefix + (rev,)) for rev in revisions]
1870
1584
        for record in self.vf.get_record_stream(keys, 'unordered', True):
1871
1585
            if record.storage_kind == 'absent':
1872
1586
                raise errors.RevisionNotPresent(record.key, self.vf)
1873
 
            result[record.key[-1]] = osutils.chunks_to_lines(
1874
 
                record.get_bytes_as('chunked'))
 
1587
            result[record.key[-1]] = osutils.split_lines(
 
1588
                record.get_bytes_as('fulltext'))
1875
1589
        return result
1876
1590
 
1877
1591
    def plan_merge(self):
1993
1707
        super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1994
1708
        self.a_key = self._key_prefix + (self.a_rev,)
1995
1709
        self.b_key = self._key_prefix + (self.b_rev,)
1996
 
        self.graph = _mod_graph.Graph(self.vf)
 
1710
        self.graph = Graph(self.vf)
1997
1711
        heads = self.graph.heads((self.a_key, self.b_key))
1998
1712
        if len(heads) == 1:
1999
1713
            # one side dominates, so we can just return its values, yay for
2004
1718
                other = b_rev
2005
1719
            else:
2006
1720
                other = a_rev
2007
 
            trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
2008
 
                         self._head_key[-1], other)
 
1721
            mutter('found dominating revision for %s\n%s > %s', self.vf,
 
1722
                   self._head_key[-1], other)
2009
1723
            self._weave = None
2010
1724
        else:
2011
1725
            self._head_key = None
2025
1739
        while True:
2026
1740
            next_lcas = self.graph.find_lca(*cur_ancestors)
2027
1741
            # Map a plain NULL_REVISION to a simple no-ancestors
2028
 
            if next_lcas == set([_mod_revision.NULL_REVISION]):
 
1742
            if next_lcas == set([NULL_REVISION]):
2029
1743
                next_lcas = ()
2030
1744
            # Order the lca's based on when they were merged into the tip
2031
1745
            # While the actual merge portion of weave merge uses a set() of
2043
1757
            elif len(next_lcas) > 2:
2044
1758
                # More than 2 lca's, fall back to grabbing all nodes between
2045
1759
                # this and the unique lca.
2046
 
                trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2047
 
                             ' %s, %s\n=> %s',
2048
 
                             self.a_key, self.b_key, cur_ancestors)
 
1760
                mutter('More than 2 LCAs, falling back to all nodes for:'
 
1761
                       ' %s, %s\n=> %s', self.a_key, self.b_key, cur_ancestors)
2049
1762
                cur_lcas = next_lcas
2050
1763
                while len(cur_lcas) > 1:
2051
1764
                    cur_lcas = self.graph.find_lca(*cur_lcas)
2054
1767
                    unique_lca = None
2055
1768
                else:
2056
1769
                    unique_lca = list(cur_lcas)[0]
2057
 
                    if unique_lca == _mod_revision.NULL_REVISION:
 
1770
                    if unique_lca == NULL_REVISION:
2058
1771
                        # find_lca will return a plain 'NULL_REVISION' rather
2059
1772
                        # than a key tuple when there is no common ancestor, we
2060
1773
                        # prefer to just use None, because it doesn't confuse
2068
1781
 
2069
1782
    def _find_unique_parents(self, tip_keys, base_key):
2070
1783
        """Find ancestors of tip that aren't ancestors of base.
2071
 
 
 
1784
        
2072
1785
        :param tip_keys: Nodes that are interesting
2073
1786
        :param base_key: Cull all ancestors of this node
2074
1787
        :return: The parent map for all revisions between tip_keys and
2083
1796
            # We remove NULL_REVISION because it isn't a proper tuple key, and
2084
1797
            # thus confuses things like _get_interesting_texts, and our logic
2085
1798
            # to add the texts into the memory weave.
2086
 
            if _mod_revision.NULL_REVISION in parent_map:
2087
 
                parent_map.pop(_mod_revision.NULL_REVISION)
 
1799
            if NULL_REVISION in parent_map:
 
1800
                parent_map.pop(NULL_REVISION)
2088
1801
        else:
2089
1802
            interesting = set()
2090
1803
            for tip in tip_keys:
2134
1847
    @staticmethod
2135
1848
    def _prune_tails(parent_map, child_map, tails_to_remove):
2136
1849
        """Remove tails from the parent map.
2137
 
 
 
1850
        
2138
1851
        This will remove the supplied revisions until no more children have 0
2139
1852
        parents.
2140
1853
 
2242
1955
        lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2243
1956
        self.lcas = set()
2244
1957
        for lca in lcas:
2245
 
            if lca == _mod_revision.NULL_REVISION:
 
1958
            if lca == NULL_REVISION:
2246
1959
                self.lcas.add(lca)
2247
1960
            else:
2248
1961
                self.lcas.add(lca[-1])