1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from tempfile import mkdtemp
23
from bzrlib.branch import Branch
24
from bzrlib.conflicts import ConflictList, Conflict
25
from bzrlib.delta import compare_trees
26
from bzrlib.errors import (BzrCommandError,
36
WorkingTreeNotRevision,
39
from bzrlib.merge3 import Merge3
41
from bzrlib.osutils import rename, pathjoin, rmtree
42
from progress import DummyProgress, ProgressPhase
43
from bzrlib.revision import common_ancestor, is_ancestor, NULL_REVISION
44
from bzrlib.symbol_versioning import *
45
from bzrlib.textfile import check_text_lines
46
from bzrlib.trace import mutter, warning, note
47
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
48
FinalPaths, create_by_entry, unique_add)
49
from bzrlib.versionedfile import WeaveMerge
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
branch as _mod_branch,
21
conflicts as _mod_conflicts,
30
revision as _mod_revision,
39
from bzrlib.cleanup import OperationWithCleanups
40
from bzrlib.symbol_versioning import (
52
44
# TODO: Report back as changes are merged in
54
def _get_tree(treespec, local_branch=None):
55
location, revno = treespec
56
branch = Branch.open_containing(location)[0]
60
revision = branch.last_revision()
62
revision = branch.get_rev_id(revno)
64
revision = NULL_REVISION
65
return branch, _get_revid_tree(branch, revision, local_branch)
68
def _get_revid_tree(branch, revision, local_branch):
70
base_tree = branch.bzrdir.open_workingtree()
72
if local_branch is not None:
73
if local_branch.base != branch.base:
74
local_branch.fetch(branch, revision)
75
base_tree = local_branch.repository.revision_tree(revision)
77
base_tree = branch.repository.revision_tree(revision)
81
47
def transform_tree(from_tree, to_tree, interesting_ids=None):
82
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
83
interesting_ids=interesting_ids, this_tree=from_tree)
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)
55
class MergeHooks(hooks.Hooks):
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 "
72
class AbstractPerFileMerger(object):
73
"""PerFileMerger objects are used by plugins extending merge for bzrlib.
75
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
77
:ivar merger: The Merge3Merger performing the merge.
80
def __init__(self, merger):
81
"""Create a PerFileMerger for use with merger."""
84
def merge_contents(self, merge_params):
85
"""Attempt to merge the contents of a single file.
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.
93
return ('not applicable', None)
96
class ConfigurableFileMerger(AbstractPerFileMerger):
97
"""Merge individual files when configured via a .conf file.
99
This is a base class for concrete custom file merging logic. Concrete
100
classes should implement ``merge_text``.
102
See ``bzrlib.plugins.news_merge.news_merge`` for an example concrete class.
104
:ivar affected_files: The configured file paths to merge.
106
:cvar name_prefix: The prefix to use when looking up configuration
107
details. <name_prefix>_merge_files describes the files targeted by the
110
:cvar default_files: The default file paths to merge when no configuration
117
def __init__(self, merger):
118
super(ConfigurableFileMerger, self).__init__(merger)
119
self.affected_files = None
120
self.default_files = self.__class__.default_files or []
121
self.name_prefix = self.__class__.name_prefix
122
if self.name_prefix is None:
123
raise ValueError("name_prefix must be set.")
125
def filename_matches_config(self, params):
126
"""Check whether the file should call the merge hook.
128
<name_prefix>_merge_files configuration variable is a list of files
129
that should use the hook.
131
affected_files = self.affected_files
132
if affected_files is None:
133
config = self.merger.this_branch.get_config()
134
# Until bzr provides a better policy for caching the config, we
135
# just add the part we're interested in to the params to avoid
136
# reading the config files repeatedly (bazaar.conf, location.conf,
138
config_key = self.name_prefix + '_merge_files'
139
affected_files = config.get_user_option_as_list(config_key)
140
if affected_files is None:
141
# If nothing was specified in the config, use the default.
142
affected_files = self.default_files
143
self.affected_files = affected_files
145
filename = self.merger.this_tree.id2path(params.file_id)
146
if filename in affected_files:
150
def merge_contents(self, params):
151
"""Merge the contents of a single file."""
152
# First, check whether this custom merge logic should be used. We
153
# expect most files should not be merged by this handler.
155
# OTHER is a straight winner, rely on default merge.
156
params.winner == 'other' or
157
# THIS and OTHER aren't both files.
158
not params.is_file_merge() or
159
# The filename isn't listed in the 'NAME_merge_files' config
161
not self.filename_matches_config(params)):
162
return 'not_applicable', None
163
return self.merge_text(params)
165
def merge_text(self, params):
166
"""Merge the byte contents of a single file.
168
This is called after checking that the merge should be performed in
169
merge_contents, and it should behave as per
170
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
172
raise NotImplementedError(self.merge_text)
175
class MergeHookParams(object):
176
"""Object holding parameters passed to merge_file_content hooks.
178
There are some fields hooks can access:
180
:ivar file_id: the file ID of the file being merged
181
:ivar trans_id: the transform ID for the merge of this file
182
:ivar this_kind: kind of file_id in 'this' tree
183
:ivar other_kind: kind of file_id in 'other' tree
184
:ivar winner: one of 'this', 'other', 'conflict'
187
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
189
self._merger = merger
190
self.file_id = file_id
191
self.trans_id = trans_id
192
self.this_kind = this_kind
193
self.other_kind = other_kind
196
def is_file_merge(self):
197
"""True if this_kind and other_kind are both 'file'."""
198
return self.this_kind == 'file' and self.other_kind == 'file'
200
@decorators.cachedproperty
201
def base_lines(self):
202
"""The lines of the 'base' version of the file."""
203
return self._merger.get_lines(self._merger.base_tree, self.file_id)
205
@decorators.cachedproperty
206
def this_lines(self):
207
"""The lines of the 'this' version of the file."""
208
return self._merger.get_lines(self._merger.this_tree, self.file_id)
210
@decorators.cachedproperty
211
def other_lines(self):
212
"""The lines of the 'other' version of the file."""
213
return self._merger.get_lines(self._merger.other_tree, self.file_id)
86
216
class Merger(object):
87
def __init__(self, this_branch, other_tree=None, base_tree=None,
88
this_tree=None, pb=DummyProgress()):
220
def __init__(self, this_branch, other_tree=None, base_tree=None,
221
this_tree=None, pb=None, change_reporter=None,
222
recurse='down', revision_graph=None):
89
223
object.__init__(self)
90
assert this_tree is not None, "this_tree is required"
91
224
self.this_branch = this_branch
92
self.this_basis = this_branch.last_revision()
225
self.this_basis = _mod_revision.ensure_null(
226
this_branch.last_revision())
93
227
self.this_rev_id = None
94
228
self.this_tree = this_tree
95
229
self.this_revision_tree = None
96
230
self.this_basis_tree = None
97
231
self.other_tree = other_tree
232
self.other_branch = None
98
233
self.base_tree = base_tree
99
234
self.ignore_zero = False
100
235
self.backup_files = False
101
236
self.interesting_ids = None
237
self.interesting_files = None
102
238
self.show_base = False
103
239
self.reprocess = False
241
warnings.warn("pb parameter to Merger() is deprecated and ignored")
108
def revision_tree(self, revision_id):
109
return self.this_branch.repository.revision_tree(revision_id)
243
self.recurse = recurse
244
self.change_reporter = change_reporter
245
self._cached_trees = {}
246
self._revision_graph = revision_graph
247
self._base_is_ancestor = None
248
self._base_is_other_ancestor = None
249
self._is_criss_cross = None
250
self._lca_trees = None
252
def cache_trees_with_revision_ids(self, trees):
253
"""Cache any tree in trees if it has a revision_id."""
254
for maybe_tree in trees:
255
if maybe_tree is None:
258
rev_id = maybe_tree.get_revision_id()
259
except AttributeError:
261
self._cached_trees[rev_id] = maybe_tree
264
def revision_graph(self):
265
if self._revision_graph is None:
266
self._revision_graph = self.this_branch.repository.get_graph()
267
return self._revision_graph
269
def _set_base_is_ancestor(self, value):
270
self._base_is_ancestor = value
272
def _get_base_is_ancestor(self):
273
if self._base_is_ancestor is None:
274
self._base_is_ancestor = self.revision_graph.is_ancestor(
275
self.base_rev_id, self.this_basis)
276
return self._base_is_ancestor
278
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
280
def _set_base_is_other_ancestor(self, value):
281
self._base_is_other_ancestor = value
283
def _get_base_is_other_ancestor(self):
284
if self._base_is_other_ancestor is None:
285
if self.other_basis is None:
287
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
288
self.base_rev_id, self.other_basis)
289
return self._base_is_other_ancestor
291
base_is_other_ancestor = property(_get_base_is_other_ancestor,
292
_set_base_is_other_ancestor)
295
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
296
"""Return a Merger for uncommitted changes in other_tree.
298
:param tree: The tree to merge into
299
:param other_tree: The tree to get uncommitted changes from
300
:param pb: A progress indicator
301
:param base_tree: The basis to use for the merge. If unspecified,
302
other_tree.basis_tree() will be used.
304
if base_tree is None:
305
base_tree = other_tree.basis_tree()
306
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
307
merger.base_rev_id = merger.base_tree.get_revision_id()
308
merger.other_rev_id = None
309
merger.other_basis = merger.base_rev_id
313
def from_mergeable(klass, tree, mergeable, pb):
314
"""Return a Merger for a bundle or merge directive.
316
:param tree: The tree to merge changes into
317
:param mergeable: A merge directive or bundle
318
:param pb: A progress indicator
320
mergeable.install_revisions(tree.branch.repository)
321
base_revision_id, other_revision_id, verified =\
322
mergeable.get_merge_request(tree.branch.repository)
323
revision_graph = tree.branch.repository.get_graph()
324
if base_revision_id is not None:
325
if (base_revision_id != _mod_revision.NULL_REVISION and
326
revision_graph.is_ancestor(
327
base_revision_id, tree.branch.last_revision())):
328
base_revision_id = None
330
trace.warning('Performing cherrypick')
331
merger = klass.from_revision_ids(pb, tree, other_revision_id,
332
base_revision_id, revision_graph=
334
return merger, verified
337
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
338
base_branch=None, revision_graph=None,
340
"""Return a Merger for revision-ids.
342
:param pb: A progress indicator
343
:param tree: The tree to merge changes into
344
:param other: The revision-id to use as OTHER
345
:param base: The revision-id to use as BASE. If not specified, will
347
:param other_branch: A branch containing the other revision-id. If
348
not supplied, tree.branch is used.
349
:param base_branch: A branch containing the base revision-id. If
350
not supplied, other_branch or tree.branch will be used.
351
:param revision_graph: If you have a revision_graph precomputed, pass
352
it in, otherwise it will be created for you.
353
:param tree_branch: The branch associated with tree. If not supplied,
354
tree.branch will be used.
356
if tree_branch is None:
357
tree_branch = tree.branch
358
merger = Merger(tree_branch, this_tree=tree, pb=pb,
359
revision_graph=revision_graph)
360
if other_branch is None:
361
other_branch = tree.branch
362
merger.set_other_revision(other, other_branch)
366
if base_branch is None:
367
base_branch = other_branch
368
merger.set_base_revision(base, base_branch)
371
def revision_tree(self, revision_id, branch=None):
372
if revision_id not in self._cached_trees:
374
branch = self.this_branch
376
tree = self.this_tree.revision_tree(revision_id)
377
except errors.NoSuchRevisionInTree:
378
tree = branch.repository.revision_tree(revision_id)
379
self._cached_trees[revision_id] = tree
380
return self._cached_trees[revision_id]
382
def _get_tree(self, treespec, possible_transports=None):
383
from bzrlib import workingtree
384
location, revno = treespec
386
tree = workingtree.WorkingTree.open_containing(location)[0]
387
return tree.branch, tree
388
branch = _mod_branch.Branch.open_containing(
389
location, possible_transports)[0]
391
revision_id = branch.last_revision()
393
revision_id = branch.get_rev_id(revno)
394
revision_id = _mod_revision.ensure_null(revision_id)
395
return branch, self.revision_tree(revision_id, branch)
397
@deprecated_method(deprecated_in((2, 1, 0)))
111
398
def ensure_revision_trees(self):
112
399
if self.this_revision_tree is None:
113
self.this_basis_tree = self.this_branch.repository.revision_tree(
400
self.this_basis_tree = self.revision_tree(self.this_basis)
115
401
if self.this_basis == self.this_rev_id:
116
402
self.this_revision_tree = self.this_basis_tree
118
404
if self.other_rev_id is None:
119
405
other_basis_tree = self.revision_tree(self.other_basis)
120
changes = compare_trees(self.other_tree, other_basis_tree)
121
if changes.has_changed():
122
raise WorkingTreeNotRevision(self.this_tree)
123
other_rev_id = other_basis
406
if other_basis_tree.has_changes(self.other_tree):
407
raise errors.WorkingTreeNotRevision(self.this_tree)
408
other_rev_id = self.other_basis
124
409
self.other_tree = other_basis_tree
411
@deprecated_method(deprecated_in((2, 1, 0)))
126
412
def file_revisions(self, file_id):
127
413
self.ensure_revision_trees()
128
414
def get_id(tree, file_id):
129
415
revision_id = tree.inventory[file_id].revision
130
assert revision_id is not None
131
416
return revision_id
132
417
if self.this_rev_id is None:
133
418
if self.this_basis_tree.get_file_sha1(file_id) != \
134
419
self.this_tree.get_file_sha1(file_id):
135
raise WorkingTreeNotRevision(self.this_tree)
420
raise errors.WorkingTreeNotRevision(self.this_tree)
137
422
trees = (self.this_basis_tree, self.other_tree)
138
423
return [get_id(tree, file_id) for tree in trees]
140
def check_basis(self, check_clean):
141
if self.this_basis is None:
142
raise BzrCommandError("This branch has no commits")
425
@deprecated_method(deprecated_in((2, 1, 0)))
426
def check_basis(self, check_clean, require_commits=True):
427
if self.this_basis is None and require_commits is True:
428
raise errors.BzrCommandError(
429
"This branch has no commits."
430
" (perhaps you would prefer 'bzr pull')")
144
432
self.compare_basis()
145
433
if self.this_basis != self.this_rev_id:
146
raise BzrCommandError("Working tree has uncommitted changes.")
434
raise errors.UncommittedChanges(self.this_tree)
436
@deprecated_method(deprecated_in((2, 1, 0)))
148
437
def compare_basis(self):
149
changes = compare_trees(self.this_tree,
150
self.this_tree.basis_tree(), False)
151
if not changes.has_changed():
439
basis_tree = self.revision_tree(self.this_tree.last_revision())
440
except errors.NoSuchRevision:
441
basis_tree = self.this_tree.basis_tree()
442
if not self.this_tree.has_changes(basis_tree):
152
443
self.this_rev_id = self.this_basis
154
445
def set_interesting_files(self, file_list):
156
self._set_interesting_files(file_list)
157
except NotVersionedError, e:
158
raise BzrCommandError("%s is not a source file in any"
161
def _set_interesting_files(self, file_list):
162
"""Set the list of interesting ids from a list of files."""
163
if file_list is None:
164
self.interesting_ids = None
167
interesting_ids = set()
168
for path in file_list:
170
for tree in (self.this_tree, self.base_tree, self.other_tree):
171
file_id = tree.inventory.path2id(path)
172
if file_id is not None:
173
interesting_ids.add(file_id)
176
raise NotVersionedError(path=path)
177
self.interesting_ids = interesting_ids
446
self.interesting_files = file_list
179
448
def set_pending(self):
180
if not self.base_is_ancestor:
182
if self.other_rev_id is None:
184
ancestry = self.this_branch.repository.get_ancestry(self.this_basis)
185
if self.other_rev_id in ancestry:
187
self.this_tree.add_pending_merge(self.other_rev_id)
189
def set_other(self, other_revision):
190
other_branch, self.other_tree = _get_tree(other_revision,
449
if (not self.base_is_ancestor or not self.base_is_other_ancestor
450
or self.other_rev_id is None):
454
def _add_parent(self):
455
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
456
new_parent_trees = []
457
operation = OperationWithCleanups(self.this_tree.set_parent_trees)
458
for revision_id in new_parents:
460
tree = self.revision_tree(revision_id)
461
except errors.NoSuchRevision:
465
operation.add_cleanup(tree.unlock)
466
new_parent_trees.append((revision_id, tree))
467
operation.run_simple(new_parent_trees, allow_leftmost_as_ghost=True)
469
def set_other(self, other_revision, possible_transports=None):
470
"""Set the revision and tree to merge from.
472
This sets the other_tree, other_rev_id, other_basis attributes.
474
:param other_revision: The [path, revision] list to merge from.
476
self.other_branch, self.other_tree = self._get_tree(other_revision,
192
478
if other_revision[1] == -1:
193
self.other_rev_id = other_branch.last_revision()
194
if self.other_rev_id is None:
195
raise NoCommits(other_branch)
479
self.other_rev_id = _mod_revision.ensure_null(
480
self.other_branch.last_revision())
481
if _mod_revision.is_null(self.other_rev_id):
482
raise errors.NoCommits(self.other_branch)
196
483
self.other_basis = self.other_rev_id
197
484
elif other_revision[1] is not None:
198
self.other_rev_id = other_branch.get_rev_id(other_revision[1])
485
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
199
486
self.other_basis = self.other_rev_id
201
488
self.other_rev_id = None
202
self.other_basis = other_branch.last_revision()
489
self.other_basis = self.other_branch.last_revision()
203
490
if self.other_basis is None:
204
raise NoCommits(other_branch)
205
if other_branch.base != self.this_branch.base:
206
self.this_branch.fetch(other_branch, last_revision=self.other_basis)
491
raise errors.NoCommits(self.other_branch)
492
if self.other_rev_id is not None:
493
self._cached_trees[self.other_rev_id] = self.other_tree
494
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
496
def set_other_revision(self, revision_id, other_branch):
497
"""Set 'other' based on a branch and revision id
499
:param revision_id: The revision to use for a tree
500
:param other_branch: The branch containing this tree
502
self.other_rev_id = revision_id
503
self.other_branch = other_branch
504
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
505
self.other_tree = self.revision_tree(revision_id)
506
self.other_basis = revision_id
508
def set_base_revision(self, revision_id, branch):
509
"""Set 'base' based on a branch and revision id
511
:param revision_id: The revision to use for a tree
512
:param branch: The branch containing this tree
514
self.base_rev_id = revision_id
515
self.base_branch = branch
516
self._maybe_fetch(branch, self.this_branch, revision_id)
517
self.base_tree = self.revision_tree(revision_id)
519
def _maybe_fetch(self, source, target, revision_id):
520
if not source.repository.has_same_location(target.repository):
521
target.fetch(source, revision_id)
524
revisions = [_mod_revision.ensure_null(self.this_basis),
525
_mod_revision.ensure_null(self.other_basis)]
526
if _mod_revision.NULL_REVISION in revisions:
527
self.base_rev_id = _mod_revision.NULL_REVISION
528
self.base_tree = self.revision_tree(self.base_rev_id)
529
self._is_criss_cross = False
531
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
532
self._is_criss_cross = False
534
self.base_rev_id = _mod_revision.NULL_REVISION
536
self.base_rev_id = list(lcas)[0]
537
else: # len(lcas) > 1
539
# find_unique_lca can only handle 2 nodes, so we have to
540
# start back at the beginning. It is a shame to traverse
541
# the graph again, but better than re-implementing
543
self.base_rev_id = self.revision_graph.find_unique_lca(
544
revisions[0], revisions[1])
546
self.base_rev_id = self.revision_graph.find_unique_lca(
548
self._is_criss_cross = True
549
if self.base_rev_id == _mod_revision.NULL_REVISION:
550
raise errors.UnrelatedBranches()
551
if self._is_criss_cross:
552
trace.warning('Warning: criss-cross merge encountered. See bzr'
553
' help criss-cross.')
554
trace.mutter('Criss-cross lcas: %r' % lcas)
555
interesting_revision_ids = [self.base_rev_id]
556
interesting_revision_ids.extend(lcas)
557
interesting_trees = dict((t.get_revision_id(), t)
558
for t in self.this_branch.repository.revision_trees(
559
interesting_revision_ids))
560
self._cached_trees.update(interesting_trees)
561
self.base_tree = interesting_trees.pop(self.base_rev_id)
562
sorted_lca_keys = self.revision_graph.find_merge_order(
564
self._lca_trees = [interesting_trees[key]
565
for key in sorted_lca_keys]
567
self.base_tree = self.revision_tree(self.base_rev_id)
568
self.base_is_ancestor = True
569
self.base_is_other_ancestor = True
570
trace.mutter('Base revid: %r' % self.base_rev_id)
208
572
def set_base(self, base_revision):
209
mutter("doing merge() with no base_revision specified")
573
"""Set the base revision to use for the merge.
575
:param base_revision: A 2-list containing a path and revision number.
577
trace.mutter("doing merge() with no base_revision specified")
210
578
if base_revision == [None, None]:
212
pb = bzrlib.ui.ui_factory.nested_progress_bar()
214
this_repo = self.this_branch.repository
215
self.base_rev_id = common_ancestor(self.this_basis,
220
except NoCommonAncestor:
221
raise UnrelatedBranches()
222
self.base_tree = _get_revid_tree(self.this_branch, self.base_rev_id,
224
self.base_is_ancestor = True
226
base_branch, self.base_tree = _get_tree(base_revision)
581
base_branch, self.base_tree = self._get_tree(base_revision)
227
582
if base_revision[1] == -1:
228
583
self.base_rev_id = base_branch.last_revision()
229
584
elif base_revision[1] is None:
230
self.base_rev_id = None
585
self.base_rev_id = _mod_revision.NULL_REVISION
232
self.base_rev_id = base_branch.get_rev_id(base_revision[1])
233
if self.this_branch.base != base_branch.base:
234
self.this_branch.fetch(base_branch)
235
self.base_is_ancestor = is_ancestor(self.this_basis,
587
self.base_rev_id = _mod_revision.ensure_null(
588
base_branch.get_rev_id(base_revision[1]))
589
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
240
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
241
'other_tree': self.other_tree,
591
def make_merger(self):
592
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
593
'other_tree': self.other_tree,
242
594
'interesting_ids': self.interesting_ids,
595
'interesting_files': self.interesting_files,
596
'this_branch': self.this_branch,
244
598
if self.merge_type.requires_base:
245
599
kwargs['base_tree'] = self.base_tree
246
600
if self.merge_type.supports_reprocess:
247
601
kwargs['reprocess'] = self.reprocess
248
602
elif self.reprocess:
249
raise BzrError("Conflict reduction is not supported for merge"
250
" type %s." % self.merge_type)
603
raise errors.BzrError(
604
"Conflict reduction is not supported for merge"
605
" type %s." % self.merge_type)
251
606
if self.merge_type.supports_show_base:
252
607
kwargs['show_base'] = self.show_base
253
608
elif self.show_base:
254
raise BzrError("Showing base is not supported for this"
609
raise errors.BzrError("Showing base is not supported for this"
255
610
" merge type. %s" % self.merge_type)
256
merge = self.merge_type(pb=self._pb, **kwargs)
611
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
612
and not self.base_is_other_ancestor):
613
raise errors.CannotReverseCherrypick()
614
if self.merge_type.supports_cherrypick:
615
kwargs['cherrypick'] = (not self.base_is_ancestor or
616
not self.base_is_other_ancestor)
617
if self._is_criss_cross and getattr(self.merge_type,
618
'supports_lca_trees', False):
619
kwargs['lca_trees'] = self._lca_trees
620
return self.merge_type(pb=None,
621
change_reporter=self.change_reporter,
624
def _do_merge_to(self):
625
merge = self.make_merger()
626
if self.other_branch is not None:
627
self.other_branch.update_references(self.this_branch)
629
if self.recurse == 'down':
630
for relpath, file_id in self.this_tree.iter_references():
631
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
632
other_revision = self.other_tree.get_reference_revision(
634
if other_revision == sub_tree.last_revision():
636
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
637
sub_merge.merge_type = self.merge_type
638
other_branch = self.other_branch.reference_parent(file_id, relpath)
639
sub_merge.set_other_revision(other_revision, other_branch)
640
base_revision = self.base_tree.get_reference_revision(file_id)
641
sub_merge.base_tree = \
642
sub_tree.branch.repository.revision_tree(base_revision)
643
sub_merge.base_rev_id = base_revision
648
operation = OperationWithCleanups(self._do_merge_to)
649
self.this_tree.lock_tree_write()
650
operation.add_cleanup(self.this_tree.unlock)
651
if self.base_tree is not None:
652
self.base_tree.lock_read()
653
operation.add_cleanup(self.base_tree.unlock)
654
if self.other_tree is not None:
655
self.other_tree.lock_read()
656
operation.add_cleanup(self.other_tree.unlock)
657
merge = operation.run_simple()
257
658
if len(merge.cooked_conflicts) == 0:
258
if not self.ignore_zero:
259
note("All changes applied successfully.")
659
if not self.ignore_zero and not trace.is_quiet():
660
trace.note("All changes applied successfully.")
261
note("%d conflicts encountered." % len(merge.cooked_conflicts))
662
trace.note("%d conflicts encountered."
663
% len(merge.cooked_conflicts))
263
665
return len(merge.cooked_conflicts)
265
def regen_inventory(self, new_entries):
266
old_entries = self.this_tree.read_working_inventory()
270
for path, file_id in new_entries:
273
new_entries_map[file_id] = path
275
def id2path(file_id):
276
path = new_entries_map.get(file_id)
279
entry = old_entries[file_id]
280
if entry.parent_id is None:
282
return pathjoin(id2path(entry.parent_id), entry.name)
284
for file_id in old_entries:
285
entry = old_entries[file_id]
286
path = id2path(file_id)
287
if file_id in self.base_tree.inventory:
288
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
290
executable = getattr(entry, 'executable', False)
291
new_inventory[file_id] = (path, file_id, entry.parent_id,
292
entry.kind, executable)
294
by_path[path] = file_id
299
for path, file_id in new_entries:
301
del new_inventory[file_id]
304
new_path_list.append((path, file_id))
305
if file_id not in old_entries:
307
# Ensure no file is added before its parent
309
for path, file_id in new_path_list:
313
parent = by_path[os.path.dirname(path)]
314
abspath = pathjoin(self.this_tree.basedir, path)
315
kind = bzrlib.osutils.file_kind(abspath)
316
if file_id in self.base_tree.inventory:
317
executable = getattr(self.base_tree.inventory[file_id], 'executable', False)
320
new_inventory[file_id] = (path, file_id, parent, kind, executable)
321
by_path[path] = file_id
323
# Get a list in insertion order
324
new_inventory_list = new_inventory.values()
325
mutter ("""Inventory regeneration:
326
old length: %i insertions: %i deletions: %i new_length: %i"""\
327
% (len(old_entries), insertions, deletions,
328
len(new_inventory_list)))
329
assert len(new_inventory_list) == len(old_entries) + insertions\
331
new_inventory_list.sort()
332
return new_inventory_list
668
class _InventoryNoneEntry(object):
669
"""This represents an inventory entry which *isn't there*.
671
It simplifies the merging logic if we always have an InventoryEntry, even
672
if it isn't actually present
679
symlink_target = None
682
_none_entry = _InventoryNoneEntry()
335
685
class Merge3Merger(object):
338
688
supports_reprocess = True
339
689
supports_show_base = True
340
690
history_based = False
691
supports_cherrypick = True
692
supports_reverse_cherrypick = True
693
winner_idx = {"this": 2, "other": 1, "conflict": 1}
694
supports_lca_trees = True
342
def __init__(self, working_tree, this_tree, base_tree, other_tree,
696
def __init__(self, working_tree, this_tree, base_tree, other_tree,
343
697
interesting_ids=None, reprocess=False, show_base=False,
344
pb=DummyProgress(), pp=None):
345
"""Initialize the merger object and perform the merge."""
698
pb=None, pp=None, change_reporter=None,
699
interesting_files=None, do_merge=True,
700
cherrypick=False, lca_trees=None, this_branch=None):
701
"""Initialize the merger object and perform the merge.
703
:param working_tree: The working tree to apply the merge to
704
:param this_tree: The local tree in the merge operation
705
:param base_tree: The common tree in the merge operation
706
:param other_tree: The other tree to merge changes from
707
:param this_branch: The branch associated with this_tree
708
:param interesting_ids: The file_ids of files that should be
709
participate in the merge. May not be combined with
711
:param: reprocess If True, perform conflict-reduction processing.
712
:param show_base: If True, show the base revision in text conflicts.
713
(incompatible with reprocess)
715
:param pp: A ProgressPhase object
716
:param change_reporter: An object that should report changes made
717
:param interesting_files: The tree-relative paths of files that should
718
participate in the merge. If these paths refer to directories,
719
the contents of those directories will also be included. May not
720
be combined with interesting_ids. If neither interesting_files nor
721
interesting_ids is specified, all files may participate in the
723
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
724
if the ancestry was found to include a criss-cross merge.
725
Otherwise should be None.
346
727
object.__init__(self)
728
if interesting_files is not None and interesting_ids is not None:
730
'specify either interesting_ids or interesting_files')
731
self.interesting_ids = interesting_ids
732
self.interesting_files = interesting_files
347
733
self.this_tree = working_tree
348
734
self.base_tree = base_tree
349
735
self.other_tree = other_tree
736
self.this_branch = this_branch
350
737
self._raw_conflicts = []
351
738
self.cooked_conflicts = []
352
739
self.reprocess = reprocess
353
740
self.show_base = show_base
357
self.pp = ProgressPhase("Merge phase", 3, self.pb)
359
if interesting_ids is not None:
360
all_ids = interesting_ids
362
all_ids = set(base_tree)
363
all_ids.update(other_tree)
364
working_tree.lock_write()
365
self.tt = TreeTransform(working_tree, self.pb)
368
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
370
for num, file_id in enumerate(all_ids):
371
child_pb.update('Preparing file merge', num, len(all_ids))
372
self.merge_names(file_id)
373
file_status = self.merge_contents(file_id)
374
self.merge_executable(file_id, file_status)
379
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
381
fs_conflicts = resolve_conflicts(self.tt, child_pb)
384
self.cook_conflicts(fs_conflicts)
385
for conflict in self.cooked_conflicts:
388
results = self.tt.apply()
389
self.write_modified(results)
391
working_tree.set_conflicts(ConflictList(self.cooked_conflicts))
392
except UnsupportedOperation:
399
working_tree.unlock()
741
self._lca_trees = lca_trees
742
# Uncommenting this will change the default algorithm to always use
743
# _entries_lca. This can be useful for running the test suite and
744
# making sure we haven't missed any corner cases.
745
# if lca_trees is None:
746
# self._lca_trees = [self.base_tree]
747
self.change_reporter = change_reporter
748
self.cherrypick = cherrypick
752
warnings.warn("pp argument to Merge3Merger is deprecated")
754
warnings.warn("pb argument to Merge3Merger is deprecated")
757
operation = OperationWithCleanups(self._do_merge)
758
self.this_tree.lock_tree_write()
759
operation.add_cleanup(self.this_tree.unlock)
760
self.base_tree.lock_read()
761
operation.add_cleanup(self.base_tree.unlock)
762
self.other_tree.lock_read()
763
operation.add_cleanup(self.other_tree.unlock)
766
def _do_merge(self, operation):
767
self.tt = transform.TreeTransform(self.this_tree, None)
768
operation.add_cleanup(self.tt.finalize)
769
self._compute_transform()
770
results = self.tt.apply(no_conflicts=True)
771
self.write_modified(results)
773
self.this_tree.add_conflicts(self.cooked_conflicts)
774
except errors.UnsupportedOperation:
777
def make_preview_transform(self):
778
operation = OperationWithCleanups(self._make_preview_transform)
779
self.base_tree.lock_read()
780
operation.add_cleanup(self.base_tree.unlock)
781
self.other_tree.lock_read()
782
operation.add_cleanup(self.other_tree.unlock)
783
return operation.run_simple()
785
def _make_preview_transform(self):
786
self.tt = transform.TransformPreview(self.this_tree)
787
self._compute_transform()
790
def _compute_transform(self):
791
if self._lca_trees is None:
792
entries = self._entries3()
793
resolver = self._three_way
795
entries = self._entries_lca()
796
resolver = self._lca_multi_way
797
child_pb = ui.ui_factory.nested_progress_bar()
799
factories = Merger.hooks['merge_file_content']
800
hooks = [factory(self) for factory in factories] + [self]
801
self.active_hooks = [hook for hook in hooks if hook is not None]
802
for num, (file_id, changed, parents3, names3,
803
executable3) in enumerate(entries):
804
child_pb.update('Preparing file merge', num, len(entries))
805
self._merge_names(file_id, parents3, names3, resolver=resolver)
807
file_status = self._do_merge_contents(file_id)
809
file_status = 'unmodified'
810
self._merge_executable(file_id,
811
executable3, file_status, resolver=resolver)
815
child_pb = ui.ui_factory.nested_progress_bar()
817
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
818
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
821
if self.change_reporter is not None:
822
from bzrlib import delta
823
delta.report_changes(
824
self.tt.iter_changes(), self.change_reporter)
825
self.cook_conflicts(fs_conflicts)
826
for conflict in self.cooked_conflicts:
827
trace.warning(conflict)
830
"""Gather data about files modified between three trees.
832
Return a list of tuples of file_id, changed, parents3, names3,
833
executable3. changed is a boolean indicating whether the file contents
834
or kind were changed. parents3 is a tuple of parent ids for base,
835
other and this. names3 is a tuple of names for base, other and this.
836
executable3 is a tuple of execute-bit values for base, other and this.
839
iterator = self.other_tree.iter_changes(self.base_tree,
840
include_unchanged=True, specific_files=self.interesting_files,
841
extra_trees=[self.this_tree])
842
this_entries = dict((e.file_id, e) for p, e in
843
self.this_tree.iter_entries_by_dir(
844
self.interesting_ids))
845
for (file_id, paths, changed, versioned, parents, names, kind,
846
executable) in iterator:
847
if (self.interesting_ids is not None and
848
file_id not in self.interesting_ids):
850
entry = this_entries.get(file_id)
851
if entry is not None:
852
this_name = entry.name
853
this_parent = entry.parent_id
854
this_executable = entry.executable
858
this_executable = None
859
parents3 = parents + (this_parent,)
860
names3 = names + (this_name,)
861
executable3 = executable + (this_executable,)
862
result.append((file_id, changed, parents3, names3, executable3))
865
def _entries_lca(self):
866
"""Gather data about files modified between multiple trees.
868
This compares OTHER versus all LCA trees, and for interesting entries,
869
it then compares with THIS and BASE.
871
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
872
:return: [(file_id, changed, parents, names, executable)]
873
file_id Simple file_id of the entry
874
changed Boolean, True if the kind or contents changed
876
parents ((base, [parent_id, in, lcas]), parent_id_other,
878
names ((base, [name, in, lcas]), name_in_other, name_in_this)
879
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
881
if self.interesting_files is not None:
882
lookup_trees = [self.this_tree, self.base_tree]
883
lookup_trees.extend(self._lca_trees)
884
# I think we should include the lca trees as well
885
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
888
interesting_ids = self.interesting_ids
890
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
892
base_inventory = self.base_tree.inventory
893
this_inventory = self.this_tree.inventory
894
for path, file_id, other_ie, lca_values in walker.iter_all():
895
# Is this modified at all from any of the other trees?
897
other_ie = _none_entry
898
if interesting_ids is not None and file_id not in interesting_ids:
901
# If other_revision is found in any of the lcas, that means this
902
# node is uninteresting. This is because when merging, if there are
903
# multiple heads(), we have to create a new node. So if we didn't,
904
# we know that the ancestry is linear, and that OTHER did not
906
# See doc/developers/lca_merge_resolution.txt for details
907
other_revision = other_ie.revision
908
if other_revision is not None:
909
# We can't use this shortcut when other_revision is None,
910
# because it may be None because things are WorkingTrees, and
911
# not because it is *actually* None.
912
is_unmodified = False
913
for lca_path, ie in lca_values:
914
if ie is not None and ie.revision == other_revision:
921
for lca_path, lca_ie in lca_values:
923
lca_entries.append(_none_entry)
925
lca_entries.append(lca_ie)
927
if file_id in base_inventory:
928
base_ie = base_inventory[file_id]
930
base_ie = _none_entry
932
if file_id in this_inventory:
933
this_ie = this_inventory[file_id]
935
this_ie = _none_entry
941
for lca_ie in lca_entries:
942
lca_kinds.append(lca_ie.kind)
943
lca_parent_ids.append(lca_ie.parent_id)
944
lca_names.append(lca_ie.name)
945
lca_executable.append(lca_ie.executable)
947
kind_winner = self._lca_multi_way(
948
(base_ie.kind, lca_kinds),
949
other_ie.kind, this_ie.kind)
950
parent_id_winner = self._lca_multi_way(
951
(base_ie.parent_id, lca_parent_ids),
952
other_ie.parent_id, this_ie.parent_id)
953
name_winner = self._lca_multi_way(
954
(base_ie.name, lca_names),
955
other_ie.name, this_ie.name)
957
content_changed = True
958
if kind_winner == 'this':
959
# No kind change in OTHER, see if there are *any* changes
960
if other_ie.kind == 'directory':
961
if parent_id_winner == 'this' and name_winner == 'this':
962
# No change for this directory in OTHER, skip
964
content_changed = False
965
elif other_ie.kind is None or other_ie.kind == 'file':
966
def get_sha1(ie, tree):
967
if ie.kind != 'file':
969
return tree.get_file_sha1(file_id)
970
base_sha1 = get_sha1(base_ie, self.base_tree)
971
lca_sha1s = [get_sha1(ie, tree) for ie, tree
972
in zip(lca_entries, self._lca_trees)]
973
this_sha1 = get_sha1(this_ie, self.this_tree)
974
other_sha1 = get_sha1(other_ie, self.other_tree)
975
sha1_winner = self._lca_multi_way(
976
(base_sha1, lca_sha1s), other_sha1, this_sha1,
977
allow_overriding_lca=False)
978
exec_winner = self._lca_multi_way(
979
(base_ie.executable, lca_executable),
980
other_ie.executable, this_ie.executable)
981
if (parent_id_winner == 'this' and name_winner == 'this'
982
and sha1_winner == 'this' and exec_winner == 'this'):
983
# No kind, parent, name, exec, or content change for
984
# OTHER, so this node is not considered interesting
986
if sha1_winner == 'this':
987
content_changed = False
988
elif other_ie.kind == 'symlink':
989
def get_target(ie, tree):
990
if ie.kind != 'symlink':
992
return tree.get_symlink_target(file_id)
993
base_target = get_target(base_ie, self.base_tree)
994
lca_targets = [get_target(ie, tree) for ie, tree
995
in zip(lca_entries, self._lca_trees)]
996
this_target = get_target(this_ie, self.this_tree)
997
other_target = get_target(other_ie, self.other_tree)
998
target_winner = self._lca_multi_way(
999
(base_target, lca_targets),
1000
other_target, this_target)
1001
if (parent_id_winner == 'this' and name_winner == 'this'
1002
and target_winner == 'this'):
1003
# No kind, parent, name, or symlink target change
1006
if target_winner == 'this':
1007
content_changed = False
1008
elif other_ie.kind == 'tree-reference':
1009
# The 'changed' information seems to be handled at a higher
1010
# level. At least, _entries3 returns False for content
1011
# changed, even when at a new revision_id.
1012
content_changed = False
1013
if (parent_id_winner == 'this' and name_winner == 'this'):
1014
# Nothing interesting
1017
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1018
# XXX: We need to handle kind == 'symlink'
1020
# If we have gotten this far, that means something has changed
1021
result.append((file_id, content_changed,
1022
((base_ie.parent_id, lca_parent_ids),
1023
other_ie.parent_id, this_ie.parent_id),
1024
((base_ie.name, lca_names),
1025
other_ie.name, this_ie.name),
1026
((base_ie.executable, lca_executable),
1027
other_ie.executable, this_ie.executable)
1034
self.tt.final_kind(self.tt.root)
1035
except errors.NoSuchFile:
1036
self.tt.cancel_deletion(self.tt.root)
1037
if self.tt.final_file_id(self.tt.root) is None:
1038
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1040
other_root_file_id = self.other_tree.get_root_id()
1041
if other_root_file_id is None:
1043
other_root = self.tt.trans_id_file_id(other_root_file_id)
1044
if other_root == self.tt.root:
1047
self.tt.final_kind(other_root)
1048
except errors.NoSuchFile:
1050
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1051
# the other tree's root is a non-root in the current tree
1053
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
1054
self.tt.cancel_creation(other_root)
1055
self.tt.cancel_versioning(other_root)
1057
def reparent_children(self, ie, target):
1058
for thing, child in ie.children.iteritems():
1059
trans_id = self.tt.trans_id_file_id(child.file_id)
1060
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
402
1062
def write_modified(self, results):
403
1063
modified_hashes = {}
530
1264
return kind, contents
532
def contents_conflict():
533
trans_id = self.tt.trans_id_file_id(file_id)
534
name = self.tt.final_name(trans_id)
535
parent_id = self.tt.final_parent(trans_id)
536
if file_id in self.this_tree.inventory:
537
self.tt.unversion_file(trans_id)
538
self.tt.delete_contents(trans_id)
539
file_group = self._dump_conflicts(name, parent_id, file_id,
541
self._raw_conflicts.append(('contents conflict', file_group))
543
1266
# See SPOT run. run, SPOT, run.
544
1267
# So we're not QUITE repeating ourselves; we do tricky things with
546
1269
base_pair = contents_pair(self.base_tree)
547
1270
other_pair = contents_pair(self.other_tree)
548
if base_pair == other_pair:
549
# OTHER introduced no changes
551
this_pair = contents_pair(self.this_tree)
552
if this_pair == other_pair:
553
# THIS and OTHER introduced the same changes
556
trans_id = self.tt.trans_id_file_id(file_id)
557
if this_pair == base_pair:
558
# only OTHER introduced changes
559
if file_id in self.this_tree:
560
# Remove any existing contents
561
self.tt.delete_contents(trans_id)
562
if file_id in self.other_tree:
563
# OTHER changed the file
564
create_by_entry(self.tt,
565
self.other_tree.inventory[file_id],
566
self.other_tree, trans_id)
567
if file_id not in self.this_tree.inventory:
568
self.tt.version_file(file_id, trans_id)
570
elif file_id in self.this_tree.inventory:
571
# OTHER deleted the file
572
self.tt.unversion_file(trans_id)
574
#BOTH THIS and OTHER introduced changes; scalar conflict
575
elif this_pair[0] == "file" and other_pair[0] == "file":
576
# THIS and OTHER are both files, so text merge. Either
577
# BASE is a file, or both converted to files, so at least we
578
# have agreement that output should be a file.
580
self.text_merge(file_id, trans_id)
582
return contents_conflict()
583
if file_id not in self.this_tree.inventory:
584
self.tt.version_file(file_id, trans_id)
586
self.tt.tree_kind(trans_id)
587
self.tt.delete_contents(trans_id)
592
# Scalar conflict, can't text merge. Dump conflicts
593
return contents_conflict()
1272
this_pair = contents_pair(self.this_tree)
1273
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1274
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1275
this_pair, allow_overriding_lca=False)
1277
if base_pair == other_pair:
1280
# We delayed evaluating this_pair as long as we can to avoid
1281
# unnecessary sha1 calculation
1282
this_pair = contents_pair(self.this_tree)
1283
winner = self._three_way(base_pair, other_pair, this_pair)
1284
if winner == 'this':
1285
# No interesting changes introduced by OTHER
1287
# We have a hypothetical conflict, but if we have files, then we
1288
# can try to merge the content
1289
trans_id = self.tt.trans_id_file_id(file_id)
1290
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1291
other_pair[0], winner)
1292
hooks = self.active_hooks
1293
hook_status = 'not_applicable'
1295
hook_status, lines = hook.merge_contents(params)
1296
if hook_status != 'not_applicable':
1297
# Don't try any more hooks, this one applies.
1300
if hook_status == 'not_applicable':
1301
# This is a contents conflict, because none of the available
1302
# functions could merge it.
1304
name = self.tt.final_name(trans_id)
1305
parent_id = self.tt.final_parent(trans_id)
1306
if self.this_tree.has_id(file_id):
1307
self.tt.unversion_file(trans_id)
1308
file_group = self._dump_conflicts(name, parent_id, file_id,
1310
self._raw_conflicts.append(('contents conflict', file_group))
1311
elif hook_status == 'success':
1312
self.tt.create_file(lines, trans_id)
1313
elif hook_status == 'conflicted':
1314
# XXX: perhaps the hook should be able to provide
1315
# the BASE/THIS/OTHER files?
1316
self.tt.create_file(lines, trans_id)
1317
self._raw_conflicts.append(('text conflict', trans_id))
1318
name = self.tt.final_name(trans_id)
1319
parent_id = self.tt.final_parent(trans_id)
1320
self._dump_conflicts(name, parent_id, file_id)
1321
elif hook_status == 'delete':
1322
self.tt.unversion_file(trans_id)
1324
elif hook_status == 'done':
1325
# The hook function did whatever it needs to do directly, no
1326
# further action needed here.
1329
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1330
if not self.this_tree.has_id(file_id) and result == "modified":
1331
self.tt.version_file(file_id, trans_id)
1332
# The merge has been performed, so the old contents should not be
1335
self.tt.delete_contents(trans_id)
1336
except errors.NoSuchFile:
1340
def _default_other_winner_merge(self, merge_hook_params):
1341
"""Replace this contents with other."""
1342
file_id = merge_hook_params.file_id
1343
trans_id = merge_hook_params.trans_id
1344
file_in_this = self.this_tree.has_id(file_id)
1345
if self.other_tree.has_id(file_id):
1346
# OTHER changed the file
1348
if wt.supports_content_filtering():
1349
# We get the path from the working tree if it exists.
1350
# That fails though when OTHER is adding a file, so
1351
# we fall back to the other tree to find the path if
1352
# it doesn't exist locally.
1354
filter_tree_path = wt.id2path(file_id)
1355
except errors.NoSuchId:
1356
filter_tree_path = self.other_tree.id2path(file_id)
1358
# Skip the id2path lookup for older formats
1359
filter_tree_path = None
1360
transform.create_from_tree(self.tt, trans_id,
1361
self.other_tree, file_id,
1362
filter_tree_path=filter_tree_path)
1365
# OTHER deleted the file
1366
return 'delete', None
1368
raise AssertionError(
1369
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1372
def merge_contents(self, merge_hook_params):
1373
"""Fallback merge logic after user installed hooks."""
1374
# This function is used in merge hooks as the fallback instance.
1375
# Perhaps making this function and the functions it calls be a
1376
# a separate class would be better.
1377
if merge_hook_params.winner == 'other':
1378
# OTHER is a straight winner, so replace this contents with other
1379
return self._default_other_winner_merge(merge_hook_params)
1380
elif merge_hook_params.is_file_merge():
1381
# THIS and OTHER are both files, so text merge. Either
1382
# BASE is a file, or both converted to files, so at least we
1383
# have agreement that output should be a file.
1385
self.text_merge(merge_hook_params.file_id,
1386
merge_hook_params.trans_id)
1387
except errors.BinaryFile:
1388
return 'not_applicable', None
1391
return 'not_applicable', None
595
1393
def get_lines(self, tree, file_id):
596
1394
"""Return the lines in a file, or an empty list."""
1395
if tree.has_id(file_id):
598
1396
return tree.get_file(file_id).readlines()
650
1449
determined automatically. If set_version is true, the .OTHER, .THIS
651
1450
or .BASE (in that order) will be created as versioned files.
653
data = [('OTHER', self.other_tree, other_lines),
1452
data = [('OTHER', self.other_tree, other_lines),
654
1453
('THIS', self.this_tree, this_lines)]
656
1455
data.append(('BASE', self.base_tree, base_lines))
1457
# We need to use the actual path in the working tree of the file here,
1458
# ignoring the conflict suffixes
1460
if wt.supports_content_filtering():
1462
filter_tree_path = wt.id2path(file_id)
1463
except errors.NoSuchId:
1464
# file has been deleted
1465
filter_tree_path = None
1467
# Skip the id2path lookup for older formats
1468
filter_tree_path = None
657
1470
versioned = False
659
1472
for suffix, tree, lines in data:
1473
if tree.has_id(file_id):
661
1474
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1475
suffix, lines, filter_tree_path)
663
1476
file_group.append(trans_id)
664
1477
if set_version and not versioned:
665
1478
self.tt.version_file(file_id, trans_id)
666
1479
versioned = True
667
1480
return file_group
669
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1482
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1483
lines=None, filter_tree_path=None):
671
1484
"""Emit a single conflict file."""
672
1485
name = name + '.' + suffix
673
1486
trans_id = self.tt.create_path(name, parent_id)
674
entry = tree.inventory[file_id]
675
create_by_entry(self.tt, entry, tree, trans_id, lines)
1487
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
678
1491
def merge_executable(self, file_id, file_status):
679
1492
"""Perform a merge on the execute bit."""
1493
executable = [self.executable(t, file_id) for t in (self.base_tree,
1494
self.other_tree, self.this_tree)]
1495
self._merge_executable(file_id, executable, file_status,
1496
resolver=self._three_way)
1498
def _merge_executable(self, file_id, executable, file_status,
1500
"""Perform a merge on the execute bit."""
1501
base_executable, other_executable, this_executable = executable
680
1502
if file_status == "deleted":
682
trans_id = self.tt.trans_id_file_id(file_id)
684
if self.tt.final_kind(trans_id) != "file":
688
winner = self.scalar_three_way(self.this_tree, self.base_tree,
689
self.other_tree, file_id,
1504
winner = resolver(*executable)
691
1505
if winner == "conflict":
692
1506
# There must be a None in here, if we have a conflict, but we
693
1507
# need executability since file status was not deleted.
694
if self.other_tree.is_executable(file_id) is None:
1508
if self.executable(self.other_tree, file_id) is None:
697
1511
winner = "other"
1512
if winner == 'this' and file_status != "modified":
1514
trans_id = self.tt.trans_id_file_id(file_id)
1516
if self.tt.final_kind(trans_id) != "file":
1518
except errors.NoSuchFile:
698
1520
if winner == "this":
699
if file_status == "modified":
700
executability = self.this_tree.is_executable(file_id)
701
if executability is not None:
702
trans_id = self.tt.trans_id_file_id(file_id)
703
self.tt.set_executability(executability, trans_id)
1521
executability = this_executable
705
assert winner == "other"
706
if file_id in self.other_tree:
707
executability = self.other_tree.is_executable(file_id)
708
elif file_id in self.this_tree:
709
executability = self.this_tree.is_executable(file_id)
710
elif file_id in self.base_tree:
711
executability = self.base_tree.is_executable(file_id)
712
if executability is not None:
713
trans_id = self.tt.trans_id_file_id(file_id)
714
self.tt.set_executability(executability, trans_id)
1523
if self.other_tree.has_id(file_id):
1524
executability = other_executable
1525
elif self.this_tree.has_id(file_id):
1526
executability = this_executable
1527
elif self.base_tree_has_id(file_id):
1528
executability = base_executable
1529
if executability is not None:
1530
trans_id = self.tt.trans_id_file_id(file_id)
1531
self.tt.set_executability(executability, trans_id)
716
1533
def cook_conflicts(self, fs_conflicts):
717
1534
"""Convert all conflicts into a form that doesn't depend on trans_id"""
718
from conflicts import Conflict
720
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
721
fp = FinalPaths(self.tt)
1535
self.cooked_conflicts.extend(transform.cook_conflicts(
1536
fs_conflicts, self.tt))
1537
fp = transform.FinalPaths(self.tt)
722
1538
for conflict in self._raw_conflicts:
723
1539
conflict_type = conflict[0]
724
if conflict_type in ('name conflict', 'parent conflict'):
725
trans_id = conflict[1]
726
conflict_args = conflict[2:]
727
if trans_id not in name_conflicts:
728
name_conflicts[trans_id] = {}
729
unique_add(name_conflicts[trans_id], conflict_type,
731
if conflict_type == 'contents conflict':
1540
if conflict_type == 'path conflict':
1542
this_parent, this_name,
1543
other_parent, other_name) = conflict[1:]
1544
if this_parent is None or this_name is None:
1545
this_path = '<deleted>'
1547
parent_path = fp.get_path(
1548
self.tt.trans_id_file_id(this_parent))
1549
this_path = osutils.pathjoin(parent_path, this_name)
1550
if other_parent is None or other_name is None:
1551
other_path = '<deleted>'
1553
parent_path = fp.get_path(
1554
self.tt.trans_id_file_id(other_parent))
1555
other_path = osutils.pathjoin(parent_path, other_name)
1556
c = _mod_conflicts.Conflict.factory(
1557
'path conflict', path=this_path,
1558
conflict_path=other_path,
1560
elif conflict_type == 'contents conflict':
732
1561
for trans_id in conflict[1]:
733
1562
file_id = self.tt.final_file_id(trans_id)
734
1563
if file_id is not None:
738
1567
if path.endswith(suffix):
739
1568
path = path[:-len(suffix)]
741
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
742
self.cooked_conflicts.append(c)
743
if conflict_type == 'text conflict':
1570
c = _mod_conflicts.Conflict.factory(conflict_type,
1571
path=path, file_id=file_id)
1572
elif conflict_type == 'text conflict':
744
1573
trans_id = conflict[1]
745
1574
path = fp.get_path(trans_id)
746
1575
file_id = self.tt.final_file_id(trans_id)
747
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
748
self.cooked_conflicts.append(c)
750
for trans_id, conflicts in name_conflicts.iteritems():
752
this_parent, other_parent = conflicts['parent conflict']
753
assert this_parent != other_parent
755
this_parent = other_parent = \
756
self.tt.final_file_id(self.tt.final_parent(trans_id))
758
this_name, other_name = conflicts['name conflict']
759
assert this_name != other_name
761
this_name = other_name = self.tt.final_name(trans_id)
762
other_path = fp.get_path(trans_id)
763
if this_parent is not None:
765
fp.get_path(self.tt.trans_id_file_id(this_parent))
766
this_path = pathjoin(this_parent_path, this_name)
1576
c = _mod_conflicts.Conflict.factory(conflict_type,
1577
path=path, file_id=file_id)
768
this_path = "<deleted>"
769
file_id = self.tt.final_file_id(trans_id)
770
c = Conflict.factory('path conflict', path=this_path,
771
conflict_path=other_path, file_id=file_id)
1579
raise AssertionError('bad conflict type: %r' % (conflict,))
772
1580
self.cooked_conflicts.append(c)
773
self.cooked_conflicts.sort(key=Conflict.sort_key)
1581
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
776
1584
class WeaveMerger(Merge3Merger):
777
1585
"""Three-way tree merger, text weave merger."""
778
1586
supports_reprocess = True
779
1587
supports_show_base = False
781
def __init__(self, working_tree, this_tree, base_tree, other_tree,
782
interesting_ids=None, pb=DummyProgress(), pp=None,
784
self.this_revision_tree = self._get_revision_tree(this_tree)
785
self.other_revision_tree = self._get_revision_tree(other_tree)
786
super(WeaveMerger, self).__init__(working_tree, this_tree,
787
base_tree, other_tree,
788
interesting_ids=interesting_ids,
789
pb=pb, pp=pp, reprocess=reprocess)
791
def _get_revision_tree(self, tree):
792
"""Return a revision tree releated to this tree.
793
If the tree is a WorkingTree, the basis will be returned.
795
if getattr(tree, 'get_weave', False) is False:
796
# If we have a WorkingTree, try using the basis
797
return tree.branch.basis_tree()
801
def _check_file(self, file_id):
802
"""Check that the revision tree's version of the file matches."""
803
for tree, rt in ((self.this_tree, self.this_revision_tree),
804
(self.other_tree, self.other_revision_tree)):
807
if tree.get_file_sha1(file_id) != rt.get_file_sha1(file_id):
808
raise WorkingTreeNotRevision(self.this_tree)
1588
supports_reverse_cherrypick = False
1589
history_based = True
1591
def _generate_merge_plan(self, file_id, base):
1592
return self.this_tree.plan_file_merge(file_id, self.other_tree,
810
1595
def _merged_lines(self, file_id):
811
1596
"""Generate the merged lines.
812
1597
There is no distinction between lines that are meant to contain <<<<<<<
815
weave = self.this_revision_tree.get_weave(file_id)
816
this_revision_id = self.this_revision_tree.inventory[file_id].revision
817
other_revision_id = \
818
self.other_revision_tree.inventory[file_id].revision
819
wm = WeaveMerge(weave, this_revision_id, other_revision_id,
820
'<<<<<<< TREE\n', '>>>>>>> MERGE-SOURCE\n')
821
return wm.merge_lines(self.reprocess)
1601
base = self.base_tree
1604
plan = self._generate_merge_plan(file_id, base)
1605
if 'merge' in debug.debug_flags:
1607
trans_id = self.tt.trans_id_file_id(file_id)
1608
name = self.tt.final_name(trans_id) + '.plan'
1609
contents = ('%11s|%s' % l for l in plan)
1610
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1611
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1612
'>>>>>>> MERGE-SOURCE\n')
1613
lines, conflicts = textmerge.merge_lines(self.reprocess)
1615
base_lines = textmerge.base_from_plan()
1618
return lines, base_lines
823
1620
def text_merge(self, file_id, trans_id):
824
1621
"""Perform a (weave) text merge for a given file and file-id.
825
1622
If conflicts are encountered, .THIS and .OTHER files will be emitted,
826
1623
and a conflict will be noted.
828
self._check_file(file_id)
829
lines, conflicts = self._merged_lines(file_id)
1625
lines, base_lines = self._merged_lines(file_id)
830
1626
lines = list(lines)
831
# Note we're checking whether the OUTPUT is binary in this case,
1627
# Note we're checking whether the OUTPUT is binary in this case,
832
1628
# because we don't want to get into weave merge guts.
833
check_text_lines(lines)
1629
textfile.check_text_lines(lines)
834
1630
self.tt.create_file(lines, trans_id)
1631
if base_lines is not None:
836
1633
self._raw_conflicts.append(('text conflict', trans_id))
837
1634
name = self.tt.final_name(trans_id)
838
1635
parent_id = self.tt.final_parent(trans_id)
839
file_group = self._dump_conflicts(name, parent_id, file_id,
1636
file_group = self._dump_conflicts(name, parent_id, file_id,
1638
base_lines=base_lines)
841
1639
file_group.append(trans_id)
1642
class LCAMerger(WeaveMerger):
1644
def _generate_merge_plan(self, file_id, base):
1645
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
844
1648
class Diff3Merger(Merge3Merger):
845
1649
"""Three-way merger using external diff3 for text merging"""
846
1651
def dump_file(self, temp_dir, name, tree, file_id):
847
out_path = pathjoin(temp_dir, name)
848
out_file = file(out_path, "wb")
849
in_file = tree.get_file(file_id)
1652
out_path = osutils.pathjoin(temp_dir, name)
1653
out_file = open(out_path, "wb")
1655
in_file = tree.get_file(file_id)
1656
for line in in_file:
1657
out_file.write(line)
854
1662
def text_merge(self, file_id, trans_id):
857
1665
will be dumped, and a will be conflict noted.
859
1667
import bzrlib.patch
860
temp_dir = mkdtemp(prefix="bzr-")
1668
temp_dir = osutils.mkdtemp(prefix="bzr-")
862
new_file = pathjoin(temp_dir, "new")
1670
new_file = osutils.pathjoin(temp_dir, "new")
863
1671
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
864
1672
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
865
1673
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
866
1674
status = bzrlib.patch.diff3(new_file, this, base, other)
867
1675
if status not in (0, 1):
868
raise BzrError("Unhandled diff3 exit code")
869
self.tt.create_file(file(new_file, "rb"), trans_id)
1676
raise errors.BzrError("Unhandled diff3 exit code")
1677
f = open(new_file, 'rb')
1679
self.tt.create_file(f, trans_id)
871
1683
name = self.tt.final_name(trans_id)
872
1684
parent_id = self.tt.final_parent(trans_id)
873
1685
self._dump_conflicts(name, parent_id, file_id)
874
self._raw_conflicts.append(('text conflict', trans_id))
1686
self._raw_conflicts.append(('text conflict', trans_id))
1688
osutils.rmtree(temp_dir)
879
1691
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
881
merge_type=Merge3Merger,
882
interesting_ids=None,
1693
merge_type=Merge3Merger,
1694
interesting_ids=None,
885
1697
other_rev_id=None,
886
1698
interesting_files=None,
889
"""Primary interface for merging.
1701
change_reporter=None):
1702
"""Primary interface for merging.
891
typical use is probably
1704
typical use is probably
892
1705
'merge_inner(branch, branch.get_revision_tree(other_revision),
893
1706
branch.get_revision_tree(base_revision))'
895
1708
if this_tree is None:
896
warn("bzrlib.merge.merge_inner requires a this_tree parameter as of "
897
"bzrlib version 0.8.",
900
this_tree = this_branch.bzrdir.open_workingtree()
901
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1709
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1710
"parameter as of bzrlib version 0.8.")
1711
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1712
pb=pb, change_reporter=change_reporter)
903
1713
merger.backup_files = backup_files
904
1714
merger.merge_type = merge_type
905
1715
merger.interesting_ids = interesting_ids
906
1716
merger.ignore_zero = ignore_zero
907
1717
if interesting_files:
908
assert not interesting_ids, ('Only supply interesting_ids'
909
' or interesting_files')
910
merger._set_interesting_files(interesting_files)
911
merger.show_base = show_base
1719
raise ValueError('Only supply interesting_ids'
1720
' or interesting_files')
1721
merger.interesting_files = interesting_files
1722
merger.show_base = show_base
912
1723
merger.reprocess = reprocess
913
1724
merger.other_rev_id = other_rev_id
914
1725
merger.other_basis = other_rev_id
1726
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1727
if get_revision_id is None:
1728
get_revision_id = base_tree.last_revision
1729
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1730
merger.set_base_revision(get_revision_id(), this_branch)
915
1731
return merger.do_merge()
918
merge_types = { "merge3": (Merge3Merger, "Native diff3-style merge"),
919
"diff3": (Diff3Merger, "Merge using external diff3"),
920
'weave': (WeaveMerger, "Weave-based merge")
924
def merge_type_help():
925
templ = '%s%%7s: %%s' % (' '*12)
926
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
927
return '\n'.join(lines)
1733
def get_merge_type_registry():
1734
"""Merge type registry is in bzrlib.option to avoid circular imports.
1736
This method provides a sanctioned way to retrieve it.
1738
from bzrlib import option
1739
return option._merge_type_registry
1742
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1743
def status_a(revision, text):
1744
if revision in ancestors_b:
1745
return 'killed-b', text
1747
return 'new-a', text
1749
def status_b(revision, text):
1750
if revision in ancestors_a:
1751
return 'killed-a', text
1753
return 'new-b', text
1755
plain_a = [t for (a, t) in annotated_a]
1756
plain_b = [t for (a, t) in annotated_b]
1757
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1758
blocks = matcher.get_matching_blocks()
1761
for ai, bi, l in blocks:
1762
# process all mismatched sections
1763
# (last mismatched section is handled because blocks always
1764
# includes a 0-length last block)
1765
for revision, text in annotated_a[a_cur:ai]:
1766
yield status_a(revision, text)
1767
for revision, text in annotated_b[b_cur:bi]:
1768
yield status_b(revision, text)
1769
# and now the matched section
1772
for text_a in plain_a[ai:a_cur]:
1773
yield "unchanged", text_a
1776
class _PlanMergeBase(object):
1778
def __init__(self, a_rev, b_rev, vf, key_prefix):
1781
:param a_rev: Revision-id of one revision to merge
1782
:param b_rev: Revision-id of the other revision to merge
1783
:param vf: A VersionedFiles containing both revisions
1784
:param key_prefix: A prefix for accessing keys in vf, typically
1790
self._last_lines = None
1791
self._last_lines_revision_id = None
1792
self._cached_matching_blocks = {}
1793
self._key_prefix = key_prefix
1794
self._precache_tip_lines()
1796
def _precache_tip_lines(self):
1797
lines = self.get_lines([self.a_rev, self.b_rev])
1798
self.lines_a = lines[self.a_rev]
1799
self.lines_b = lines[self.b_rev]
1801
def get_lines(self, revisions):
1802
"""Get lines for revisions from the backing VersionedFiles.
1804
:raises RevisionNotPresent: on absent texts.
1806
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1808
for record in self.vf.get_record_stream(keys, 'unordered', True):
1809
if record.storage_kind == 'absent':
1810
raise errors.RevisionNotPresent(record.key, self.vf)
1811
result[record.key[-1]] = osutils.chunks_to_lines(
1812
record.get_bytes_as('chunked'))
1815
def plan_merge(self):
1816
"""Generate a 'plan' for merging the two revisions.
1818
This involves comparing their texts and determining the cause of
1819
differences. If text A has a line and text B does not, then either the
1820
line was added to text A, or it was deleted from B. Once the causes
1821
are combined, they are written out in the format described in
1822
VersionedFile.plan_merge
1824
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
1825
unique_a, unique_b = self._unique_lines(blocks)
1826
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
1827
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
1828
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
1830
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
1833
for i, j, n in blocks:
1834
for a_index in range(last_i, i):
1835
if a_index in new_a:
1836
if a_index in killed_b:
1837
yield 'conflicted-a', self.lines_a[a_index]
1839
yield 'new-a', self.lines_a[a_index]
1841
yield 'killed-b', self.lines_a[a_index]
1842
for b_index in range(last_j, j):
1843
if b_index in new_b:
1844
if b_index in killed_a:
1845
yield 'conflicted-b', self.lines_b[b_index]
1847
yield 'new-b', self.lines_b[b_index]
1849
yield 'killed-a', self.lines_b[b_index]
1850
# handle common lines
1851
for a_index in range(i, i+n):
1852
yield 'unchanged', self.lines_a[a_index]
1856
def _get_matching_blocks(self, left_revision, right_revision):
1857
"""Return a description of which sections of two revisions match.
1859
See SequenceMatcher.get_matching_blocks
1861
cached = self._cached_matching_blocks.get((left_revision,
1863
if cached is not None:
1865
if self._last_lines_revision_id == left_revision:
1866
left_lines = self._last_lines
1867
right_lines = self.get_lines([right_revision])[right_revision]
1869
lines = self.get_lines([left_revision, right_revision])
1870
left_lines = lines[left_revision]
1871
right_lines = lines[right_revision]
1872
self._last_lines = right_lines
1873
self._last_lines_revision_id = right_revision
1874
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1876
return matcher.get_matching_blocks()
1878
def _unique_lines(self, matching_blocks):
1879
"""Analyse matching_blocks to determine which lines are unique
1881
:return: a tuple of (unique_left, unique_right), where the values are
1882
sets of line numbers of unique lines.
1888
for i, j, n in matching_blocks:
1889
unique_left.extend(range(last_i, i))
1890
unique_right.extend(range(last_j, j))
1893
return unique_left, unique_right
1896
def _subtract_plans(old_plan, new_plan):
1897
"""Remove changes from new_plan that came from old_plan.
1899
It is assumed that the difference between the old_plan and new_plan
1900
is their choice of 'b' text.
1902
All lines from new_plan that differ from old_plan are emitted
1903
verbatim. All lines from new_plan that match old_plan but are
1904
not about the 'b' revision are emitted verbatim.
1906
Lines that match and are about the 'b' revision are the lines we
1907
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
1908
is skipped entirely.
1910
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
1913
for i, j, n in matcher.get_matching_blocks():
1914
for jj in range(last_j, j):
1916
for jj in range(j, j+n):
1917
plan_line = new_plan[jj]
1918
if plan_line[0] == 'new-b':
1920
elif plan_line[0] == 'killed-b':
1921
yield 'unchanged', plan_line[1]
1927
class _PlanMerge(_PlanMergeBase):
1928
"""Plan an annotate merge using on-the-fly annotation"""
1930
def __init__(self, a_rev, b_rev, vf, key_prefix):
1931
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1932
self.a_key = self._key_prefix + (self.a_rev,)
1933
self.b_key = self._key_prefix + (self.b_rev,)
1934
self.graph = _mod_graph.Graph(self.vf)
1935
heads = self.graph.heads((self.a_key, self.b_key))
1937
# one side dominates, so we can just return its values, yay for
1939
# Ideally we would know that before we get this far
1940
self._head_key = heads.pop()
1941
if self._head_key == self.a_key:
1945
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1946
self._head_key[-1], other)
1949
self._head_key = None
1952
def _precache_tip_lines(self):
1953
# Turn this into a no-op, because we will do this later
1956
def _find_recursive_lcas(self):
1957
"""Find all the ancestors back to a unique lca"""
1958
cur_ancestors = (self.a_key, self.b_key)
1959
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1960
# rather than a key tuple. We will just map that directly to no common
1964
next_lcas = self.graph.find_lca(*cur_ancestors)
1965
# Map a plain NULL_REVISION to a simple no-ancestors
1966
if next_lcas == set([_mod_revision.NULL_REVISION]):
1968
# Order the lca's based on when they were merged into the tip
1969
# While the actual merge portion of weave merge uses a set() of
1970
# active revisions, the order of insertion *does* effect the
1971
# implicit ordering of the texts.
1972
for rev_key in cur_ancestors:
1973
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1975
parent_map[rev_key] = ordered_parents
1976
if len(next_lcas) == 0:
1978
elif len(next_lcas) == 1:
1979
parent_map[list(next_lcas)[0]] = ()
1981
elif len(next_lcas) > 2:
1982
# More than 2 lca's, fall back to grabbing all nodes between
1983
# this and the unique lca.
1984
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
1986
self.a_key, self.b_key, cur_ancestors)
1987
cur_lcas = next_lcas
1988
while len(cur_lcas) > 1:
1989
cur_lcas = self.graph.find_lca(*cur_lcas)
1990
if len(cur_lcas) == 0:
1991
# No common base to find, use the full ancestry
1994
unique_lca = list(cur_lcas)[0]
1995
if unique_lca == _mod_revision.NULL_REVISION:
1996
# find_lca will return a plain 'NULL_REVISION' rather
1997
# than a key tuple when there is no common ancestor, we
1998
# prefer to just use None, because it doesn't confuse
1999
# _get_interesting_texts()
2001
parent_map.update(self._find_unique_parents(next_lcas,
2004
cur_ancestors = next_lcas
2007
def _find_unique_parents(self, tip_keys, base_key):
2008
"""Find ancestors of tip that aren't ancestors of base.
2010
:param tip_keys: Nodes that are interesting
2011
:param base_key: Cull all ancestors of this node
2012
:return: The parent map for all revisions between tip_keys and
2013
base_key. base_key will be included. References to nodes outside of
2014
the ancestor set will also be removed.
2016
# TODO: this would be simpler if find_unique_ancestors took a list
2017
# instead of a single tip, internally it supports it, but it
2018
# isn't a "backwards compatible" api change.
2019
if base_key is None:
2020
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2021
# We remove NULL_REVISION because it isn't a proper tuple key, and
2022
# thus confuses things like _get_interesting_texts, and our logic
2023
# to add the texts into the memory weave.
2024
if _mod_revision.NULL_REVISION in parent_map:
2025
parent_map.pop(_mod_revision.NULL_REVISION)
2028
for tip in tip_keys:
2030
self.graph.find_unique_ancestors(tip, [base_key]))
2031
parent_map = self.graph.get_parent_map(interesting)
2032
parent_map[base_key] = ()
2033
culled_parent_map, child_map, tails = self._remove_external_references(
2035
# Remove all the tails but base_key
2036
if base_key is not None:
2037
tails.remove(base_key)
2038
self._prune_tails(culled_parent_map, child_map, tails)
2039
# Now remove all the uninteresting 'linear' regions
2040
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2044
def _remove_external_references(parent_map):
2045
"""Remove references that go outside of the parent map.
2047
:param parent_map: Something returned from Graph.get_parent_map(keys)
2048
:return: (filtered_parent_map, child_map, tails)
2049
filtered_parent_map is parent_map without external references
2050
child_map is the {parent_key: [child_keys]} mapping
2051
tails is a list of nodes that do not have any parents in the map
2053
# TODO: The basic effect of this function seems more generic than
2054
# _PlanMerge. But the specific details of building a child_map,
2055
# and computing tails seems very specific to _PlanMerge.
2056
# Still, should this be in Graph land?
2057
filtered_parent_map = {}
2060
for key, parent_keys in parent_map.iteritems():
2061
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2062
if not culled_parent_keys:
2064
for parent_key in culled_parent_keys:
2065
child_map.setdefault(parent_key, []).append(key)
2066
# TODO: Do we want to do this, it adds overhead for every node,
2067
# just to say that the node has no children
2068
child_map.setdefault(key, [])
2069
filtered_parent_map[key] = culled_parent_keys
2070
return filtered_parent_map, child_map, tails
2073
def _prune_tails(parent_map, child_map, tails_to_remove):
2074
"""Remove tails from the parent map.
2076
This will remove the supplied revisions until no more children have 0
2079
:param parent_map: A dict of {child: [parents]}, this dictionary will
2080
be modified in place.
2081
:param tails_to_remove: A list of tips that should be removed,
2082
this list will be consumed
2083
:param child_map: The reverse dict of parent_map ({parent: [children]})
2084
this dict will be modified
2085
:return: None, parent_map will be modified in place.
2087
while tails_to_remove:
2088
next = tails_to_remove.pop()
2089
parent_map.pop(next)
2090
children = child_map.pop(next)
2091
for child in children:
2092
child_parents = parent_map[child]
2093
child_parents.remove(next)
2094
if len(child_parents) == 0:
2095
tails_to_remove.append(child)
2097
def _get_interesting_texts(self, parent_map):
2098
"""Return a dict of texts we are interested in.
2100
Note that the input is in key tuples, but the output is in plain
2103
:param parent_map: The output from _find_recursive_lcas
2104
:return: A dict of {'revision_id':lines} as returned by
2105
_PlanMergeBase.get_lines()
2107
all_revision_keys = set(parent_map)
2108
all_revision_keys.add(self.a_key)
2109
all_revision_keys.add(self.b_key)
2111
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2112
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2115
def _build_weave(self):
2116
from bzrlib import weave
2117
self._weave = weave.Weave(weave_name='in_memory_weave',
2118
allow_reserved=True)
2119
parent_map = self._find_recursive_lcas()
2121
all_texts = self._get_interesting_texts(parent_map)
2123
# Note: Unfortunately, the order given by topo_sort will effect the
2124
# ordering resolution in the output. Specifically, if you add A then B,
2125
# then in the output text A lines will show up before B lines. And, of
2126
# course, topo_sort doesn't guarantee any real ordering.
2127
# So we use merge_sort, and add a fake node on the tip.
2128
# This ensures that left-hand parents will always be inserted into the
2129
# weave before right-hand parents.
2130
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2131
parent_map[tip_key] = (self.a_key, self.b_key)
2133
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2137
# for key in tsort.topo_sort(parent_map):
2138
parent_keys = parent_map[key]
2139
revision_id = key[-1]
2140
parent_ids = [k[-1] for k in parent_keys]
2141
self._weave.add_lines(revision_id, parent_ids,
2142
all_texts[revision_id])
2144
def plan_merge(self):
2145
"""Generate a 'plan' for merging the two revisions.
2147
This involves comparing their texts and determining the cause of
2148
differences. If text A has a line and text B does not, then either the
2149
line was added to text A, or it was deleted from B. Once the causes
2150
are combined, they are written out in the format described in
2151
VersionedFile.plan_merge
2153
if self._head_key is not None: # There was a single head
2154
if self._head_key == self.a_key:
2157
if self._head_key != self.b_key:
2158
raise AssertionError('There was an invalid head: %s != %s'
2159
% (self.b_key, self._head_key))
2161
head_rev = self._head_key[-1]
2162
lines = self.get_lines([head_rev])[head_rev]
2163
return ((plan, line) for line in lines)
2164
return self._weave.plan_merge(self.a_rev, self.b_rev)
2167
class _PlanLCAMerge(_PlanMergeBase):
2169
This merge algorithm differs from _PlanMerge in that:
2170
1. comparisons are done against LCAs only
2171
2. cases where a contested line is new versus one LCA but old versus
2172
another are marked as conflicts, by emitting the line as conflicted-a
2175
This is faster, and hopefully produces more useful output.
2178
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2179
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2180
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2183
if lca == _mod_revision.NULL_REVISION:
2186
self.lcas.add(lca[-1])
2187
for lca in self.lcas:
2188
if _mod_revision.is_null(lca):
2191
lca_lines = self.get_lines([lca])[lca]
2192
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2194
blocks = list(matcher.get_matching_blocks())
2195
self._cached_matching_blocks[(a_rev, lca)] = blocks
2196
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2198
blocks = list(matcher.get_matching_blocks())
2199
self._cached_matching_blocks[(b_rev, lca)] = blocks
2201
def _determine_status(self, revision_id, unique_line_numbers):
2202
"""Determines the status unique lines versus all lcas.
2204
Basically, determines why the line is unique to this revision.
2206
A line may be determined new, killed, or both.
2208
If a line is determined new, that means it was not present in at least
2209
one LCA, and is not present in the other merge revision.
2211
If a line is determined killed, that means the line was present in
2214
If a line is killed and new, this indicates that the two merge
2215
revisions contain differing conflict resolutions.
2216
:param revision_id: The id of the revision in which the lines are
2218
:param unique_line_numbers: The line numbers of unique lines.
2219
:return a tuple of (new_this, killed_other):
2223
unique_line_numbers = set(unique_line_numbers)
2224
for lca in self.lcas:
2225
blocks = self._get_matching_blocks(revision_id, lca)
2226
unique_vs_lca, _ignored = self._unique_lines(blocks)
2227
new.update(unique_line_numbers.intersection(unique_vs_lca))
2228
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
