1
from merge_core import merge_flex
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory
4
from bzrlib import find_branch
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.diff import compare_trees
8
from trace import mutter, warning
14
class UnrelatedBranches(BzrCommandError):
1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
19
branch as _mod_branch,
20
conflicts as _mod_conflicts,
30
revision as _mod_revision,
39
from bzrlib.symbol_versioning import (
43
# TODO: Report back as changes are merged in
46
def transform_tree(from_tree, to_tree, interesting_ids=None):
47
from_tree.lock_tree_write()
49
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
50
interesting_ids=interesting_ids, this_tree=from_tree)
55
class MergeHooks(hooks.Hooks):
15
57
def __init__(self):
16
msg = "Branches have no common ancestor, and no base revision"\
18
BzrCommandError.__init__(self, msg)
21
class MergeConflictHandler(ExceptionConflictHandler):
22
"""Handle conflicts encountered while merging"""
23
def __init__(self, dir, ignore_zero=False):
24
ExceptionConflictHandler.__init__(self, dir)
26
self.ignore_zero = ignore_zero
28
def copy(self, source, dest):
29
"""Copy the text and mode of a file
30
:param source: The path of the file to copy
31
:param dest: The distination file to create
33
s_file = file(source, "rb")
34
d_file = file(dest, "wb")
37
os.chmod(dest, 0777 & os.stat(source).st_mode)
39
def add_suffix(self, name, suffix, last_new_name=None):
40
"""Rename a file to append a suffix. If the new name exists, the
41
suffix is added repeatedly until a non-existant name is found
43
:param name: The path of the file
44
:param suffix: The suffix to append
45
:param last_new_name: (used for recursive calls) the last name tried
47
if last_new_name is None:
49
new_name = last_new_name+suffix
51
os.rename(name, new_name)
54
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
56
return self.add_suffix(name, suffix, last_new_name=new_name)
58
def conflict(self, text):
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.
63
def merge_conflict(self, new_file, this_path, base_path, other_path):
65
Handle diff3 conflicts by producing a .THIS, .BASE and .OTHER. The
66
main file will be a version with diff3 conflicts.
67
:param new_file: Path to the output file with diff3 markers
68
:param this_path: Path to the file text for the THIS tree
69
:param base_path: Path to the file text for the BASE tree
70
:param other_path: Path to the file text for the OTHER tree
72
self.add_suffix(this_path, ".THIS")
73
self.copy(base_path, this_path+".BASE")
74
self.copy(other_path, this_path+".OTHER")
75
os.rename(new_file, this_path)
76
self.conflict("Diff3 conflict encountered in %s" % this_path)
78
def target_exists(self, entry, target, old_path):
79
"""Handle the case when the target file or dir exists"""
80
moved_path = self.add_suffix(target, ".moved")
81
self.conflict("Moved existing %s to %s" % (target, moved_path))
83
def rmdir_non_empty(self, filename):
84
"""Handle the case where the dir to be removed still has contents"""
85
self.conflict("Directory %s not removed because it is not empty"\
90
if not self.ignore_zero:
91
print "%d conflicts encountered.\n" % self.conflicts
93
class SourceFile(object):
94
def __init__(self, path, id, present=None, isdir=None):
97
self.present = present
99
self.interesting = True
102
return "SourceFile(%s, %s)" % (self.path, self.id)
104
def get_tree(treespec, temp_root, label):
105
location, revno = treespec
106
branch = find_branch(location)
108
base_tree = branch.working_tree()
110
base_tree = branch.basis_tree()
112
base_tree = branch.revision_tree(branch.lookup_revision(revno))
113
temp_path = os.path.join(temp_root, label)
115
return branch, MergeTree(base_tree, temp_path)
118
def abspath(tree, file_id):
119
path = tree.inventory.id2path(file_id)
124
def file_exists(tree, file_id):
125
return tree.has_filename(tree.id2path(file_id))
127
def inventory_map(tree):
129
for file_id in tree.inventory:
130
path = abspath(tree, file_id)
131
inventory[path] = SourceFile(path, file_id)
135
class MergeTree(object):
136
def __init__(self, tree, tempdir):
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
:ivar affected_files: The configured file paths to merge.
103
:cvar name_prefix: The prefix to use when looking up configuration
105
:cvar default_files: The default file paths to merge when no configuration
112
def __init__(self, merger):
113
super(ConfigurableFileMerger, self).__init__(merger)
114
self.affected_files = None
115
self.default_files = self.__class__.default_files or []
116
self.name_prefix = self.__class__.name_prefix
117
if self.name_prefix is None:
118
raise ValueError("name_prefix must be set.")
120
def filename_matches_config(self, params):
121
affected_files = self.affected_files
122
if affected_files is None:
123
config = self.merger.this_tree.branch.get_config()
124
# Until bzr provides a better policy for caching the config, we
125
# just add the part we're interested in to the params to avoid
126
# reading the config files repeatedly (bazaar.conf, location.conf,
128
config_key = self.name_prefix + '_merge_files'
129
affected_files = config.get_user_option_as_list(config_key)
130
if affected_files is None:
131
# If nothing was specified in the config, use the default.
132
affected_files = self.default_files
133
self.affected_files = affected_files
135
filename = self.merger.this_tree.id2path(params.file_id)
136
if filename in affected_files:
140
def merge_contents(self, params):
141
"""Merge the contents of a single file."""
142
# First, check whether this custom merge logic should be used. We
143
# expect most files should not be merged by this handler.
145
# OTHER is a straight winner, rely on default merge.
146
params.winner == 'other' or
147
# THIS and OTHER aren't both files.
148
not params.is_file_merge() or
149
# The filename isn't listed in the 'NAME_merge_files' config
151
not self.filename_matches_config(params)):
152
return 'not_applicable', None
153
return self.merge_text(self, params)
155
def merge_text(self, params):
156
"""Merge the byte contents of a single file.
158
This is called after checking that the merge should be performed in
159
merge_contents, and it should behave as per
160
``bzrlib.merge.AbstractPerFileMerger.merge_contents``.
162
raise NotImplementedError(self.merge_text)
165
class MergeHookParams(object):
166
"""Object holding parameters passed to merge_file_content hooks.
168
There are some fields hooks can access:
170
:ivar file_id: the file ID of the file being merged
171
:ivar trans_id: the transform ID for the merge of this file
172
:ivar this_kind: kind of file_id in 'this' tree
173
:ivar other_kind: kind of file_id in 'other' tree
174
:ivar winner: one of 'this', 'other', 'conflict'
177
def __init__(self, merger, file_id, trans_id, this_kind, other_kind,
179
self._merger = merger
180
self.file_id = file_id
181
self.trans_id = trans_id
182
self.this_kind = this_kind
183
self.other_kind = other_kind
186
def is_file_merge(self):
187
"""True if this_kind and other_kind are both 'file'."""
188
return self.this_kind == 'file' and self.other_kind == 'file'
190
@decorators.cachedproperty
191
def base_lines(self):
192
"""The lines of the 'base' version of the file."""
193
return self._merger.get_lines(self._merger.base_tree, self.file_id)
195
@decorators.cachedproperty
196
def this_lines(self):
197
"""The lines of the 'this' version of the file."""
198
return self._merger.get_lines(self._merger.this_tree, self.file_id)
200
@decorators.cachedproperty
201
def other_lines(self):
202
"""The lines of the 'other' version of the file."""
203
return self._merger.get_lines(self._merger.other_tree, self.file_id)
206
class Merger(object):
210
def __init__(self, this_branch, other_tree=None, base_tree=None,
211
this_tree=None, pb=None, change_reporter=None,
212
recurse='down', revision_graph=None):
137
213
object.__init__(self)
138
if hasattr(tree, "basedir"):
139
self.root = tree.basedir
142
self.inventory = inventory_map(tree)
144
self.tempdir = tempdir
145
os.mkdir(os.path.join(self.tempdir, "texts"))
148
def readonly_path(self, id):
149
if id not in self.tree:
151
if self.root is not None:
152
return self.tree.abspath(self.tree.id2path(id))
154
if self.tree.inventory[id].kind in ("directory", "root_directory"):
156
if not self.cached.has_key(id):
157
path = os.path.join(self.tempdir, "texts", id)
158
outfile = file(path, "wb")
159
outfile.write(self.tree.get_file(id).read())
160
assert(os.path.exists(path))
161
self.cached[id] = path
162
return self.cached[id]
166
def merge(other_revision, base_revision,
167
check_clean=True, ignore_zero=False,
169
"""Merge changes into a tree.
172
Base for three-way merge.
174
Other revision for three-way merge.
176
Directory to merge changes into; '.' by default.
178
If true, this_dir must have no uncommitted changes before the
181
tempdir = tempfile.mkdtemp(prefix="bzr-")
185
this_branch = find_branch(this_dir)
214
self.this_branch = this_branch
215
self.this_basis = _mod_revision.ensure_null(
216
this_branch.last_revision())
217
self.this_rev_id = None
218
self.this_tree = this_tree
219
self.this_revision_tree = None
220
self.this_basis_tree = None
221
self.other_tree = other_tree
222
self.other_branch = None
223
self.base_tree = base_tree
224
self.ignore_zero = False
225
self.backup_files = False
226
self.interesting_ids = None
227
self.interesting_files = None
228
self.show_base = False
229
self.reprocess = False
231
pb = progress.DummyProgress()
234
self.recurse = recurse
235
self.change_reporter = change_reporter
236
self._cached_trees = {}
237
self._revision_graph = revision_graph
238
self._base_is_ancestor = None
239
self._base_is_other_ancestor = None
240
self._is_criss_cross = None
241
self._lca_trees = None
243
def cache_trees_with_revision_ids(self, trees):
244
"""Cache any tree in trees if it has a revision_id."""
245
for maybe_tree in trees:
246
if maybe_tree is None:
249
rev_id = maybe_tree.get_revision_id()
250
except AttributeError:
252
self._cached_trees[rev_id] = maybe_tree
255
def revision_graph(self):
256
if self._revision_graph is None:
257
self._revision_graph = self.this_branch.repository.get_graph()
258
return self._revision_graph
260
def _set_base_is_ancestor(self, value):
261
self._base_is_ancestor = value
263
def _get_base_is_ancestor(self):
264
if self._base_is_ancestor is None:
265
self._base_is_ancestor = self.revision_graph.is_ancestor(
266
self.base_rev_id, self.this_basis)
267
return self._base_is_ancestor
269
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
271
def _set_base_is_other_ancestor(self, value):
272
self._base_is_other_ancestor = value
274
def _get_base_is_other_ancestor(self):
275
if self._base_is_other_ancestor is None:
276
if self.other_basis is None:
278
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
279
self.base_rev_id, self.other_basis)
280
return self._base_is_other_ancestor
282
base_is_other_ancestor = property(_get_base_is_other_ancestor,
283
_set_base_is_other_ancestor)
286
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
287
"""Return a Merger for uncommitted changes in other_tree.
289
:param tree: The tree to merge into
290
:param other_tree: The tree to get uncommitted changes from
291
:param pb: A progress indicator
292
:param base_tree: The basis to use for the merge. If unspecified,
293
other_tree.basis_tree() will be used.
295
if base_tree is None:
296
base_tree = other_tree.basis_tree()
297
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
298
merger.base_rev_id = merger.base_tree.get_revision_id()
299
merger.other_rev_id = None
300
merger.other_basis = merger.base_rev_id
304
def from_mergeable(klass, tree, mergeable, pb):
305
"""Return a Merger for a bundle or merge directive.
307
:param tree: The tree to merge changes into
308
:param mergeable: A merge directive or bundle
309
:param pb: A progress indicator
311
mergeable.install_revisions(tree.branch.repository)
312
base_revision_id, other_revision_id, verified =\
313
mergeable.get_merge_request(tree.branch.repository)
314
revision_graph = tree.branch.repository.get_graph()
315
if base_revision_id is not None:
316
if (base_revision_id != _mod_revision.NULL_REVISION and
317
revision_graph.is_ancestor(
318
base_revision_id, tree.branch.last_revision())):
319
base_revision_id = None
321
trace.warning('Performing cherrypick')
322
merger = klass.from_revision_ids(pb, tree, other_revision_id,
323
base_revision_id, revision_graph=
325
return merger, verified
328
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
329
base_branch=None, revision_graph=None,
331
"""Return a Merger for revision-ids.
333
:param pb: A progress indicator
334
:param tree: The tree to merge changes into
335
:param other: The revision-id to use as OTHER
336
:param base: The revision-id to use as BASE. If not specified, will
338
:param other_branch: A branch containing the other revision-id. If
339
not supplied, tree.branch is used.
340
:param base_branch: A branch containing the base revision-id. If
341
not supplied, other_branch or tree.branch will be used.
342
:param revision_graph: If you have a revision_graph precomputed, pass
343
it in, otherwise it will be created for you.
344
:param tree_branch: The branch associated with tree. If not supplied,
345
tree.branch will be used.
347
if tree_branch is None:
348
tree_branch = tree.branch
349
merger = Merger(tree_branch, this_tree=tree, pb=pb,
350
revision_graph=revision_graph)
351
if other_branch is None:
352
other_branch = tree.branch
353
merger.set_other_revision(other, other_branch)
357
if base_branch is None:
358
base_branch = other_branch
359
merger.set_base_revision(base, base_branch)
362
def revision_tree(self, revision_id, branch=None):
363
if revision_id not in self._cached_trees:
365
branch = self.this_branch
367
tree = self.this_tree.revision_tree(revision_id)
368
except errors.NoSuchRevisionInTree:
369
tree = branch.repository.revision_tree(revision_id)
370
self._cached_trees[revision_id] = tree
371
return self._cached_trees[revision_id]
373
def _get_tree(self, treespec, possible_transports=None):
374
from bzrlib import workingtree
375
location, revno = treespec
377
tree = workingtree.WorkingTree.open_containing(location)[0]
378
return tree.branch, tree
379
branch = _mod_branch.Branch.open_containing(
380
location, possible_transports)[0]
382
revision_id = branch.last_revision()
384
revision_id = branch.get_rev_id(revno)
385
revision_id = _mod_revision.ensure_null(revision_id)
386
return branch, self.revision_tree(revision_id, branch)
388
@deprecated_method(deprecated_in((2, 1, 0)))
389
def ensure_revision_trees(self):
390
if self.this_revision_tree is None:
391
self.this_basis_tree = self.revision_tree(self.this_basis)
392
if self.this_basis == self.this_rev_id:
393
self.this_revision_tree = self.this_basis_tree
395
if self.other_rev_id is None:
396
other_basis_tree = self.revision_tree(self.other_basis)
397
if other_basis_tree.has_changes(self.other_tree):
398
raise errors.WorkingTreeNotRevision(self.this_tree)
399
other_rev_id = self.other_basis
400
self.other_tree = other_basis_tree
402
@deprecated_method(deprecated_in((2, 1, 0)))
403
def file_revisions(self, file_id):
404
self.ensure_revision_trees()
405
def get_id(tree, file_id):
406
revision_id = tree.inventory[file_id].revision
408
if self.this_rev_id is None:
409
if self.this_basis_tree.get_file_sha1(file_id) != \
410
self.this_tree.get_file_sha1(file_id):
411
raise errors.WorkingTreeNotRevision(self.this_tree)
413
trees = (self.this_basis_tree, self.other_tree)
414
return [get_id(tree, file_id) for tree in trees]
416
@deprecated_method(deprecated_in((2, 1, 0)))
417
def check_basis(self, check_clean, require_commits=True):
418
if self.this_basis is None and require_commits is True:
419
raise errors.BzrCommandError(
420
"This branch has no commits."
421
" (perhaps you would prefer 'bzr pull')")
187
changes = compare_trees(this_branch.working_tree(),
188
this_branch.basis_tree(), False)
189
if changes.has_changed():
190
raise BzrCommandError("Working tree has uncommitted changes.")
191
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
424
if self.this_basis != self.this_rev_id:
425
raise errors.UncommittedChanges(self.this_tree)
427
@deprecated_method(deprecated_in((2, 1, 0)))
428
def compare_basis(self):
430
basis_tree = self.revision_tree(self.this_tree.last_revision())
431
except errors.NoSuchRevision:
432
basis_tree = self.this_tree.basis_tree()
433
if not self.this_tree.has_changes(basis_tree):
434
self.this_rev_id = self.this_basis
436
def set_interesting_files(self, file_list):
437
self.interesting_files = file_list
439
def set_pending(self):
440
if (not self.base_is_ancestor or not self.base_is_other_ancestor
441
or self.other_rev_id is None):
445
def _add_parent(self):
446
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
447
new_parent_trees = []
448
for revision_id in new_parents:
450
tree = self.revision_tree(revision_id)
451
except errors.NoSuchRevision:
455
new_parent_trees.append((revision_id, tree))
457
self.this_tree.set_parent_trees(new_parent_trees,
458
allow_leftmost_as_ghost=True)
460
for _revision_id, tree in new_parent_trees:
464
def set_other(self, other_revision, possible_transports=None):
465
"""Set the revision and tree to merge from.
467
This sets the other_tree, other_rev_id, other_basis attributes.
469
:param other_revision: The [path, revision] list to merge from.
471
self.other_branch, self.other_tree = self._get_tree(other_revision,
473
if other_revision[1] == -1:
474
self.other_rev_id = _mod_revision.ensure_null(
475
self.other_branch.last_revision())
476
if _mod_revision.is_null(self.other_rev_id):
477
raise errors.NoCommits(self.other_branch)
478
self.other_basis = self.other_rev_id
479
elif other_revision[1] is not None:
480
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
481
self.other_basis = self.other_rev_id
483
self.other_rev_id = None
484
self.other_basis = self.other_branch.last_revision()
485
if self.other_basis is None:
486
raise errors.NoCommits(self.other_branch)
487
if self.other_rev_id is not None:
488
self._cached_trees[self.other_rev_id] = self.other_tree
489
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
491
def set_other_revision(self, revision_id, other_branch):
492
"""Set 'other' based on a branch and revision id
494
:param revision_id: The revision to use for a tree
495
:param other_branch: The branch containing this tree
497
self.other_rev_id = revision_id
498
self.other_branch = other_branch
499
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
500
self.other_tree = self.revision_tree(revision_id)
501
self.other_basis = revision_id
503
def set_base_revision(self, revision_id, branch):
504
"""Set 'base' based on a branch and revision id
506
:param revision_id: The revision to use for a tree
507
:param branch: The branch containing this tree
509
self.base_rev_id = revision_id
510
self.base_branch = branch
511
self._maybe_fetch(branch, self.this_branch, revision_id)
512
self.base_tree = self.revision_tree(revision_id)
514
def _maybe_fetch(self, source, target, revision_id):
515
if not source.repository.has_same_location(target.repository):
516
target.fetch(source, revision_id)
519
revisions = [_mod_revision.ensure_null(self.this_basis),
520
_mod_revision.ensure_null(self.other_basis)]
521
if _mod_revision.NULL_REVISION in revisions:
522
self.base_rev_id = _mod_revision.NULL_REVISION
523
self.base_tree = self.revision_tree(self.base_rev_id)
524
self._is_criss_cross = False
526
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
527
self._is_criss_cross = False
529
self.base_rev_id = _mod_revision.NULL_REVISION
531
self.base_rev_id = list(lcas)[0]
532
else: # len(lcas) > 1
534
# find_unique_lca can only handle 2 nodes, so we have to
535
# start back at the beginning. It is a shame to traverse
536
# the graph again, but better than re-implementing
538
self.base_rev_id = self.revision_graph.find_unique_lca(
539
revisions[0], revisions[1])
541
self.base_rev_id = self.revision_graph.find_unique_lca(
543
self._is_criss_cross = True
544
if self.base_rev_id == _mod_revision.NULL_REVISION:
545
raise errors.UnrelatedBranches()
546
if self._is_criss_cross:
547
trace.warning('Warning: criss-cross merge encountered. See bzr'
548
' help criss-cross.')
549
trace.mutter('Criss-cross lcas: %r' % lcas)
550
interesting_revision_ids = [self.base_rev_id]
551
interesting_revision_ids.extend(lcas)
552
interesting_trees = dict((t.get_revision_id(), t)
553
for t in self.this_branch.repository.revision_trees(
554
interesting_revision_ids))
555
self._cached_trees.update(interesting_trees)
556
self.base_tree = interesting_trees.pop(self.base_rev_id)
557
sorted_lca_keys = self.revision_graph.find_merge_order(
559
self._lca_trees = [interesting_trees[key]
560
for key in sorted_lca_keys]
562
self.base_tree = self.revision_tree(self.base_rev_id)
563
self.base_is_ancestor = True
564
self.base_is_other_ancestor = True
565
trace.mutter('Base revid: %r' % self.base_rev_id)
567
def set_base(self, base_revision):
568
"""Set the base revision to use for the merge.
570
:param base_revision: A 2-list containing a path and revision number.
572
trace.mutter("doing merge() with no base_revision specified")
192
573
if base_revision == [None, None]:
193
if other_revision[1] == -1:
196
o_revno = other_revision[1]
197
base_revno = this_branch.common_ancestor(other_branch,
198
other_revno=o_revno)[0]
199
if base_revno is None:
200
raise UnrelatedBranches()
201
base_revision = ['.', base_revno]
202
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
203
merge_inner(this_branch, other_tree, base_tree, tempdir,
204
ignore_zero=ignore_zero)
206
shutil.rmtree(tempdir)
209
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b):
210
"""Generate a changeset, using the text_id to mark really-changed files.
211
This permits blazing comparisons when text_ids are present. It also
212
disables metadata comparison for files with identical texts.
214
for file_id in tree_a.tree.inventory:
215
if file_id not in tree_b.tree.inventory:
217
entry_a = tree_a.tree.inventory[file_id]
218
entry_b = tree_b.tree.inventory[file_id]
219
if (entry_a.kind, entry_b.kind) != ("file", "file"):
221
if None in (entry_a.text_id, entry_b.text_id):
223
if entry_a.text_id != entry_b.text_id:
225
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
226
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
227
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
228
for entry in cset.entries.itervalues():
229
entry.metadata_change = None
233
def merge_inner(this_branch, other_tree, base_tree, tempdir,
235
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
237
def get_inventory(tree):
238
return tree.inventory
240
inv_changes = merge_flex(this_tree, base_tree, other_tree,
241
generate_cset_optimized, get_inventory,
242
MergeConflictHandler(base_tree.root,
243
ignore_zero=ignore_zero))
246
for id, path in inv_changes.iteritems():
251
assert path.startswith('./')
253
adjust_ids.append((path, id))
254
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
257
def regen_inventory(this_branch, root, new_entries):
258
old_entries = this_branch.read_working_inventory()
261
for file_id in old_entries:
262
entry = old_entries[file_id]
263
path = old_entries.id2path(file_id)
264
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
265
by_path[path] = file_id
270
for path, file_id in new_entries:
272
del new_inventory[file_id]
275
new_path_list.append((path, file_id))
276
if file_id not in old_entries:
278
# Ensure no file is added before its parent
280
for path, file_id in new_path_list:
284
parent = by_path[os.path.dirname(path)]
285
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
286
new_inventory[file_id] = (path, file_id, parent, kind)
287
by_path[path] = file_id
289
# Get a list in insertion order
290
new_inventory_list = new_inventory.values()
291
mutter ("""Inventory regeneration:
292
old length: %i insertions: %i deletions: %i new_length: %i"""\
293
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
294
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
295
new_inventory_list.sort()
296
return new_inventory_list
576
base_branch, self.base_tree = self._get_tree(base_revision)
577
if base_revision[1] == -1:
578
self.base_rev_id = base_branch.last_revision()
579
elif base_revision[1] is None:
580
self.base_rev_id = _mod_revision.NULL_REVISION
582
self.base_rev_id = _mod_revision.ensure_null(
583
base_branch.get_rev_id(base_revision[1]))
584
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
586
def make_merger(self):
587
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
588
'other_tree': self.other_tree,
589
'interesting_ids': self.interesting_ids,
590
'interesting_files': self.interesting_files,
591
'pp': self.pp, 'this_branch': self.this_branch,
593
if self.merge_type.requires_base:
594
kwargs['base_tree'] = self.base_tree
595
if self.merge_type.supports_reprocess:
596
kwargs['reprocess'] = self.reprocess
598
raise errors.BzrError(
599
"Conflict reduction is not supported for merge"
600
" type %s." % self.merge_type)
601
if self.merge_type.supports_show_base:
602
kwargs['show_base'] = self.show_base
604
raise errors.BzrError("Showing base is not supported for this"
605
" merge type. %s" % self.merge_type)
606
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
607
and not self.base_is_other_ancestor):
608
raise errors.CannotReverseCherrypick()
609
if self.merge_type.supports_cherrypick:
610
kwargs['cherrypick'] = (not self.base_is_ancestor or
611
not self.base_is_other_ancestor)
612
if self._is_criss_cross and getattr(self.merge_type,
613
'supports_lca_trees', False):
614
kwargs['lca_trees'] = self._lca_trees
615
return self.merge_type(pb=self._pb,
616
change_reporter=self.change_reporter,
619
def _do_merge_to(self, merge):
620
if self.other_branch is not None:
621
self.other_branch.update_references(self.this_branch)
623
if self.recurse == 'down':
624
for relpath, file_id in self.this_tree.iter_references():
625
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
626
other_revision = self.other_tree.get_reference_revision(
628
if other_revision == sub_tree.last_revision():
630
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
631
sub_merge.merge_type = self.merge_type
632
other_branch = self.other_branch.reference_parent(file_id, relpath)
633
sub_merge.set_other_revision(other_revision, other_branch)
634
base_revision = self.base_tree.get_reference_revision(file_id)
635
sub_merge.base_tree = \
636
sub_tree.branch.repository.revision_tree(base_revision)
637
sub_merge.base_rev_id = base_revision
641
self.this_tree.lock_tree_write()
643
if self.base_tree is not None:
644
self.base_tree.lock_read()
646
if self.other_tree is not None:
647
self.other_tree.lock_read()
649
merge = self.make_merger()
650
self._do_merge_to(merge)
652
if self.other_tree is not None:
653
self.other_tree.unlock()
655
if self.base_tree is not None:
656
self.base_tree.unlock()
658
self.this_tree.unlock()
659
if len(merge.cooked_conflicts) == 0:
660
if not self.ignore_zero and not trace.is_quiet():
661
trace.note("All changes applied successfully.")
663
trace.note("%d conflicts encountered."
664
% len(merge.cooked_conflicts))
666
return len(merge.cooked_conflicts)
669
class _InventoryNoneEntry(object):
670
"""This represents an inventory entry which *isn't there*.
672
It simplifies the merging logic if we always have an InventoryEntry, even
673
if it isn't actually present
680
symlink_target = None
683
_none_entry = _InventoryNoneEntry()
686
class Merge3Merger(object):
687
"""Three-way merger that uses the merge3 text merger"""
689
supports_reprocess = True
690
supports_show_base = True
691
history_based = False
692
supports_cherrypick = True
693
supports_reverse_cherrypick = True
694
winner_idx = {"this": 2, "other": 1, "conflict": 1}
695
supports_lca_trees = True
697
def __init__(self, working_tree, this_tree, base_tree, other_tree,
698
interesting_ids=None, reprocess=False, show_base=False,
699
pb=progress.DummyProgress(), pp=None, change_reporter=None,
700
interesting_files=None, do_merge=True,
701
cherrypick=False, lca_trees=None, this_branch=None):
702
"""Initialize the merger object and perform the merge.
704
:param working_tree: The working tree to apply the merge to
705
:param this_tree: The local tree in the merge operation
706
:param base_tree: The common tree in the merge operation
707
:param other_tree: The other tree to merge changes from
708
:param this_branch: The branch associated with this_tree
709
:param interesting_ids: The file_ids of files that should be
710
participate in the merge. May not be combined with
712
:param: reprocess If True, perform conflict-reduction processing.
713
:param show_base: If True, show the base revision in text conflicts.
714
(incompatible with reprocess)
715
:param pb: A Progress bar
716
:param pp: A ProgressPhase object
717
:param change_reporter: An object that should report changes made
718
:param interesting_files: The tree-relative paths of files that should
719
participate in the merge. If these paths refer to directories,
720
the contents of those directories will also be included. May not
721
be combined with interesting_ids. If neither interesting_files nor
722
interesting_ids is specified, all files may participate in the
724
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
725
if the ancestry was found to include a criss-cross merge.
726
Otherwise should be None.
728
object.__init__(self)
729
if interesting_files is not None and interesting_ids is not None:
731
'specify either interesting_ids or interesting_files')
732
self.interesting_ids = interesting_ids
733
self.interesting_files = interesting_files
734
self.this_tree = working_tree
735
self.base_tree = base_tree
736
self.other_tree = other_tree
737
self.this_branch = this_branch
738
self._raw_conflicts = []
739
self.cooked_conflicts = []
740
self.reprocess = reprocess
741
self.show_base = show_base
742
self._lca_trees = lca_trees
743
# Uncommenting this will change the default algorithm to always use
744
# _entries_lca. This can be useful for running the test suite and
745
# making sure we haven't missed any corner cases.
746
# if lca_trees is None:
747
# self._lca_trees = [self.base_tree]
750
self.change_reporter = change_reporter
751
self.cherrypick = cherrypick
753
self.pp = progress.ProgressPhase("Merge phase", 3, self.pb)
758
self.this_tree.lock_tree_write()
759
self.base_tree.lock_read()
760
self.other_tree.lock_read()
762
self.tt = transform.TreeTransform(self.this_tree, self.pb)
765
self._compute_transform()
767
results = self.tt.apply(no_conflicts=True)
768
self.write_modified(results)
770
self.this_tree.add_conflicts(self.cooked_conflicts)
771
except errors.UnsupportedOperation:
776
self.other_tree.unlock()
777
self.base_tree.unlock()
778
self.this_tree.unlock()
781
def make_preview_transform(self):
782
self.base_tree.lock_read()
783
self.other_tree.lock_read()
784
self.tt = transform.TransformPreview(self.this_tree)
787
self._compute_transform()
790
self.other_tree.unlock()
791
self.base_tree.unlock()
795
def _compute_transform(self):
796
if self._lca_trees is None:
797
entries = self._entries3()
798
resolver = self._three_way
800
entries = self._entries_lca()
801
resolver = self._lca_multi_way
802
child_pb = ui.ui_factory.nested_progress_bar()
804
factories = Merger.hooks['merge_file_content']
805
hooks = [factory(self) for factory in factories] + [self]
806
self.active_hooks = [hook for hook in hooks if hook is not None]
807
for num, (file_id, changed, parents3, names3,
808
executable3) in enumerate(entries):
809
child_pb.update('Preparing file merge', num, len(entries))
810
self._merge_names(file_id, parents3, names3, resolver=resolver)
812
file_status = self._do_merge_contents(file_id)
814
file_status = 'unmodified'
815
self._merge_executable(file_id,
816
executable3, file_status, resolver=resolver)
821
child_pb = ui.ui_factory.nested_progress_bar()
823
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
824
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
827
if self.change_reporter is not None:
828
from bzrlib import delta
829
delta.report_changes(
830
self.tt.iter_changes(), self.change_reporter)
831
self.cook_conflicts(fs_conflicts)
832
for conflict in self.cooked_conflicts:
833
trace.warning(conflict)
836
"""Gather data about files modified between three trees.
838
Return a list of tuples of file_id, changed, parents3, names3,
839
executable3. changed is a boolean indicating whether the file contents
840
or kind were changed. parents3 is a tuple of parent ids for base,
841
other and this. names3 is a tuple of names for base, other and this.
842
executable3 is a tuple of execute-bit values for base, other and this.
845
iterator = self.other_tree.iter_changes(self.base_tree,
846
include_unchanged=True, specific_files=self.interesting_files,
847
extra_trees=[self.this_tree])
848
this_entries = dict((e.file_id, e) for p, e in
849
self.this_tree.iter_entries_by_dir(
850
self.interesting_ids))
851
for (file_id, paths, changed, versioned, parents, names, kind,
852
executable) in iterator:
853
if (self.interesting_ids is not None and
854
file_id not in self.interesting_ids):
856
entry = this_entries.get(file_id)
857
if entry is not None:
858
this_name = entry.name
859
this_parent = entry.parent_id
860
this_executable = entry.executable
864
this_executable = None
865
parents3 = parents + (this_parent,)
866
names3 = names + (this_name,)
867
executable3 = executable + (this_executable,)
868
result.append((file_id, changed, parents3, names3, executable3))
871
def _entries_lca(self):
872
"""Gather data about files modified between multiple trees.
874
This compares OTHER versus all LCA trees, and for interesting entries,
875
it then compares with THIS and BASE.
877
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
878
:return: [(file_id, changed, parents, names, executable)]
879
file_id Simple file_id of the entry
880
changed Boolean, True if the kind or contents changed
882
parents ((base, [parent_id, in, lcas]), parent_id_other,
884
names ((base, [name, in, lcas]), name_in_other, name_in_this)
885
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
887
if self.interesting_files is not None:
888
lookup_trees = [self.this_tree, self.base_tree]
889
lookup_trees.extend(self._lca_trees)
890
# I think we should include the lca trees as well
891
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
894
interesting_ids = self.interesting_ids
896
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
898
base_inventory = self.base_tree.inventory
899
this_inventory = self.this_tree.inventory
900
for path, file_id, other_ie, lca_values in walker.iter_all():
901
# Is this modified at all from any of the other trees?
903
other_ie = _none_entry
904
if interesting_ids is not None and file_id not in interesting_ids:
907
# If other_revision is found in any of the lcas, that means this
908
# node is uninteresting. This is because when merging, if there are
909
# multiple heads(), we have to create a new node. So if we didn't,
910
# we know that the ancestry is linear, and that OTHER did not
912
# See doc/developers/lca_merge_resolution.txt for details
913
other_revision = other_ie.revision
914
if other_revision is not None:
915
# We can't use this shortcut when other_revision is None,
916
# because it may be None because things are WorkingTrees, and
917
# not because it is *actually* None.
918
is_unmodified = False
919
for lca_path, ie in lca_values:
920
if ie is not None and ie.revision == other_revision:
927
for lca_path, lca_ie in lca_values:
929
lca_entries.append(_none_entry)
931
lca_entries.append(lca_ie)
933
if file_id in base_inventory:
934
base_ie = base_inventory[file_id]
936
base_ie = _none_entry
938
if file_id in this_inventory:
939
this_ie = this_inventory[file_id]
941
this_ie = _none_entry
947
for lca_ie in lca_entries:
948
lca_kinds.append(lca_ie.kind)
949
lca_parent_ids.append(lca_ie.parent_id)
950
lca_names.append(lca_ie.name)
951
lca_executable.append(lca_ie.executable)
953
kind_winner = self._lca_multi_way(
954
(base_ie.kind, lca_kinds),
955
other_ie.kind, this_ie.kind)
956
parent_id_winner = self._lca_multi_way(
957
(base_ie.parent_id, lca_parent_ids),
958
other_ie.parent_id, this_ie.parent_id)
959
name_winner = self._lca_multi_way(
960
(base_ie.name, lca_names),
961
other_ie.name, this_ie.name)
963
content_changed = True
964
if kind_winner == 'this':
965
# No kind change in OTHER, see if there are *any* changes
966
if other_ie.kind == 'directory':
967
if parent_id_winner == 'this' and name_winner == 'this':
968
# No change for this directory in OTHER, skip
970
content_changed = False
971
elif other_ie.kind is None or other_ie.kind == 'file':
972
def get_sha1(ie, tree):
973
if ie.kind != 'file':
975
return tree.get_file_sha1(file_id)
976
base_sha1 = get_sha1(base_ie, self.base_tree)
977
lca_sha1s = [get_sha1(ie, tree) for ie, tree
978
in zip(lca_entries, self._lca_trees)]
979
this_sha1 = get_sha1(this_ie, self.this_tree)
980
other_sha1 = get_sha1(other_ie, self.other_tree)
981
sha1_winner = self._lca_multi_way(
982
(base_sha1, lca_sha1s), other_sha1, this_sha1,
983
allow_overriding_lca=False)
984
exec_winner = self._lca_multi_way(
985
(base_ie.executable, lca_executable),
986
other_ie.executable, this_ie.executable)
987
if (parent_id_winner == 'this' and name_winner == 'this'
988
and sha1_winner == 'this' and exec_winner == 'this'):
989
# No kind, parent, name, exec, or content change for
990
# OTHER, so this node is not considered interesting
992
if sha1_winner == 'this':
993
content_changed = False
994
elif other_ie.kind == 'symlink':
995
def get_target(ie, tree):
996
if ie.kind != 'symlink':
998
return tree.get_symlink_target(file_id)
999
base_target = get_target(base_ie, self.base_tree)
1000
lca_targets = [get_target(ie, tree) for ie, tree
1001
in zip(lca_entries, self._lca_trees)]
1002
this_target = get_target(this_ie, self.this_tree)
1003
other_target = get_target(other_ie, self.other_tree)
1004
target_winner = self._lca_multi_way(
1005
(base_target, lca_targets),
1006
other_target, this_target)
1007
if (parent_id_winner == 'this' and name_winner == 'this'
1008
and target_winner == 'this'):
1009
# No kind, parent, name, or symlink target change
1012
if target_winner == 'this':
1013
content_changed = False
1014
elif other_ie.kind == 'tree-reference':
1015
# The 'changed' information seems to be handled at a higher
1016
# level. At least, _entries3 returns False for content
1017
# changed, even when at a new revision_id.
1018
content_changed = False
1019
if (parent_id_winner == 'this' and name_winner == 'this'):
1020
# Nothing interesting
1023
raise AssertionError('unhandled kind: %s' % other_ie.kind)
1024
# XXX: We need to handle kind == 'symlink'
1026
# If we have gotten this far, that means something has changed
1027
result.append((file_id, content_changed,
1028
((base_ie.parent_id, lca_parent_ids),
1029
other_ie.parent_id, this_ie.parent_id),
1030
((base_ie.name, lca_names),
1031
other_ie.name, this_ie.name),
1032
((base_ie.executable, lca_executable),
1033
other_ie.executable, this_ie.executable)
1040
self.tt.final_kind(self.tt.root)
1041
except errors.NoSuchFile:
1042
self.tt.cancel_deletion(self.tt.root)
1043
if self.tt.final_file_id(self.tt.root) is None:
1044
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
1046
other_root_file_id = self.other_tree.get_root_id()
1047
if other_root_file_id is None:
1049
other_root = self.tt.trans_id_file_id(other_root_file_id)
1050
if other_root == self.tt.root:
1053
self.tt.final_kind(other_root)
1054
except errors.NoSuchFile:
1056
if self.this_tree.has_id(self.other_tree.inventory.root.file_id):
1057
# the other tree's root is a non-root in the current tree
1059
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
1060
self.tt.cancel_creation(other_root)
1061
self.tt.cancel_versioning(other_root)
1063
def reparent_children(self, ie, target):
1064
for thing, child in ie.children.iteritems():
1065
trans_id = self.tt.trans_id_file_id(child.file_id)
1066
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
1068
def write_modified(self, results):
1069
modified_hashes = {}
1070
for path in results.modified_paths:
1071
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
1074
hash = self.this_tree.get_file_sha1(file_id)
1077
modified_hashes[file_id] = hash
1078
self.this_tree.set_merge_modified(modified_hashes)
1081
def parent(entry, file_id):
1082
"""Determine the parent for a file_id (used as a key method)"""
1085
return entry.parent_id
1088
def name(entry, file_id):
1089
"""Determine the name for a file_id (used as a key method)"""
1095
def contents_sha1(tree, file_id):
1096
"""Determine the sha1 of the file contents (used as a key method)."""
1097
if file_id not in tree:
1099
return tree.get_file_sha1(file_id)
1102
def executable(tree, file_id):
1103
"""Determine the executability of a file-id (used as a key method)."""
1104
if not tree.has_id(file_id):
1106
if tree.kind(file_id) != "file":
1108
return tree.is_executable(file_id)
1111
def kind(tree, file_id):
1112
"""Determine the kind of a file-id (used as a key method)."""
1113
if not tree.has_id(file_id):
1115
return tree.kind(file_id)
1118
def _three_way(base, other, this):
1119
#if base == other, either they all agree, or only THIS has changed.
1122
elif this not in (base, other):
1124
# "Ambiguous clean merge" -- both sides have made the same change.
1127
# this == base: only other has changed.
1132
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
1133
"""Consider LCAs when determining whether a change has occurred.
1135
If LCAS are all identical, this is the same as a _three_way comparison.
1137
:param bases: value in (BASE, [LCAS])
1138
:param other: value in OTHER
1139
:param this: value in THIS
1140
:param allow_overriding_lca: If there is more than one unique lca
1141
value, allow OTHER to override THIS if it has a new value, and
1142
THIS only has an lca value, or vice versa. This is appropriate for
1143
truly scalar values, not as much for non-scalars.
1144
:return: 'this', 'other', or 'conflict' depending on whether an entry
1147
# See doc/developers/lca_tree_merging.txt for details about this
1150
# Either Ambiguously clean, or nothing was actually changed. We
1153
base_val, lca_vals = bases
1154
# Remove 'base_val' from the lca_vals, because it is not interesting
1155
filtered_lca_vals = [lca_val for lca_val in lca_vals
1156
if lca_val != base_val]
1157
if len(filtered_lca_vals) == 0:
1158
return Merge3Merger._three_way(base_val, other, this)
1160
unique_lca_vals = set(filtered_lca_vals)
1161
if len(unique_lca_vals) == 1:
1162
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
1164
if allow_overriding_lca:
1165
if other in unique_lca_vals:
1166
if this in unique_lca_vals:
1167
# Each side picked a different lca, conflict
1170
# This has a value which supersedes both lca values, and
1171
# other only has an lca value
1173
elif this in unique_lca_vals:
1174
# OTHER has a value which supersedes both lca values, and this
1175
# only has an lca value
1178
# At this point, the lcas disagree, and the tips disagree
1182
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1183
"""Do a three-way test on a scalar.
1184
Return "this", "other" or "conflict", depending whether a value wins.
1186
key_base = key(base_tree, file_id)
1187
key_other = key(other_tree, file_id)
1188
#if base == other, either they all agree, or only THIS has changed.
1189
if key_base == key_other:
1191
key_this = key(this_tree, file_id)
1192
# "Ambiguous clean merge"
1193
if key_this == key_other:
1195
elif key_this == key_base:
1200
def merge_names(self, file_id):
1201
def get_entry(tree):
1202
if tree.has_id(file_id):
1203
return tree.inventory[file_id]
1206
this_entry = get_entry(self.this_tree)
1207
other_entry = get_entry(self.other_tree)
1208
base_entry = get_entry(self.base_tree)
1209
entries = (base_entry, other_entry, this_entry)
1212
for entry in entries:
1215
parents.append(None)
1217
names.append(entry.name)
1218
parents.append(entry.parent_id)
1219
return self._merge_names(file_id, parents, names,
1220
resolver=self._three_way)
1222
def _merge_names(self, file_id, parents, names, resolver):
1223
"""Perform a merge on file_id names and parents"""
1224
base_name, other_name, this_name = names
1225
base_parent, other_parent, this_parent = parents
1227
name_winner = resolver(*names)
1229
parent_id_winner = resolver(*parents)
1230
if this_name is None:
1231
if name_winner == "this":
1232
name_winner = "other"
1233
if parent_id_winner == "this":
1234
parent_id_winner = "other"
1235
if name_winner == "this" and parent_id_winner == "this":
1237
if name_winner == "conflict":
1238
trans_id = self.tt.trans_id_file_id(file_id)
1239
self._raw_conflicts.append(('name conflict', trans_id,
1240
this_name, other_name))
1241
if parent_id_winner == "conflict":
1242
trans_id = self.tt.trans_id_file_id(file_id)
1243
self._raw_conflicts.append(('parent conflict', trans_id,
1244
this_parent, other_parent))
1245
if other_name is None:
1246
# it doesn't matter whether the result was 'other' or
1247
# 'conflict'-- if there's no 'other', we leave it alone.
1249
# if we get here, name_winner and parent_winner are set to safe values.
1250
trans_id = self.tt.trans_id_file_id(file_id)
1251
parent_id = parents[self.winner_idx[parent_id_winner]]
1252
if parent_id is not None:
1253
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1254
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1255
parent_trans_id, trans_id)
1257
def _do_merge_contents(self, file_id):
1258
"""Performs a merge on file_id contents."""
1259
def contents_pair(tree):
1260
if file_id not in tree:
1262
kind = tree.kind(file_id)
1264
contents = tree.get_file_sha1(file_id)
1265
elif kind == "symlink":
1266
contents = tree.get_symlink_target(file_id)
1269
return kind, contents
1271
# See SPOT run. run, SPOT, run.
1272
# So we're not QUITE repeating ourselves; we do tricky things with
1274
base_pair = contents_pair(self.base_tree)
1275
other_pair = contents_pair(self.other_tree)
1277
this_pair = contents_pair(self.this_tree)
1278
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1279
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1280
this_pair, allow_overriding_lca=False)
1282
if base_pair == other_pair:
1285
# We delayed evaluating this_pair as long as we can to avoid
1286
# unnecessary sha1 calculation
1287
this_pair = contents_pair(self.this_tree)
1288
winner = self._three_way(base_pair, other_pair, this_pair)
1289
if winner == 'this':
1290
# No interesting changes introduced by OTHER
1292
# We have a hypothetical conflict, but if we have files, then we
1293
# can try to merge the content
1294
trans_id = self.tt.trans_id_file_id(file_id)
1295
params = MergeHookParams(self, file_id, trans_id, this_pair[0],
1296
other_pair[0], winner)
1297
hooks = self.active_hooks
1298
hook_status = 'not_applicable'
1300
hook_status, lines = hook.merge_contents(params)
1301
if hook_status != 'not_applicable':
1302
# Don't try any more hooks, this one applies.
1305
if hook_status == 'not_applicable':
1306
# This is a contents conflict, because none of the available
1307
# functions could merge it.
1309
name = self.tt.final_name(trans_id)
1310
parent_id = self.tt.final_parent(trans_id)
1311
if self.this_tree.has_id(file_id):
1312
self.tt.unversion_file(trans_id)
1313
file_group = self._dump_conflicts(name, parent_id, file_id,
1315
self._raw_conflicts.append(('contents conflict', file_group))
1316
elif hook_status == 'success':
1317
self.tt.create_file(lines, trans_id)
1318
elif hook_status == 'conflicted':
1319
# XXX: perhaps the hook should be able to provide
1320
# the BASE/THIS/OTHER files?
1321
self.tt.create_file(lines, trans_id)
1322
self._raw_conflicts.append(('text conflict', trans_id))
1323
name = self.tt.final_name(trans_id)
1324
parent_id = self.tt.final_parent(trans_id)
1325
self._dump_conflicts(name, parent_id, file_id)
1326
elif hook_status == 'delete':
1327
self.tt.unversion_file(trans_id)
1329
elif hook_status == 'done':
1330
# The hook function did whatever it needs to do directly, no
1331
# further action needed here.
1334
raise AssertionError('unknown hook_status: %r' % (hook_status,))
1335
if not self.this_tree.has_id(file_id) and result == "modified":
1336
self.tt.version_file(file_id, trans_id)
1337
# The merge has been performed, so the old contents should not be
1340
self.tt.delete_contents(trans_id)
1341
except errors.NoSuchFile:
1345
def _default_other_winner_merge(self, merge_hook_params):
1346
"""Replace this contents with other."""
1347
file_id = merge_hook_params.file_id
1348
trans_id = merge_hook_params.trans_id
1349
file_in_this = self.this_tree.has_id(file_id)
1350
if self.other_tree.has_id(file_id):
1351
# OTHER changed the file
1353
if wt.supports_content_filtering():
1354
# We get the path from the working tree if it exists.
1355
# That fails though when OTHER is adding a file, so
1356
# we fall back to the other tree to find the path if
1357
# it doesn't exist locally.
1359
filter_tree_path = wt.id2path(file_id)
1360
except errors.NoSuchId:
1361
filter_tree_path = self.other_tree.id2path(file_id)
1363
# Skip the id2path lookup for older formats
1364
filter_tree_path = None
1365
transform.create_from_tree(self.tt, trans_id,
1366
self.other_tree, file_id,
1367
filter_tree_path=filter_tree_path)
1370
# OTHER deleted the file
1371
return 'delete', None
1373
raise AssertionError(
1374
'winner is OTHER, but file_id %r not in THIS or OTHER tree'
1377
def merge_contents(self, merge_hook_params):
1378
"""Fallback merge logic after user installed hooks."""
1379
# This function is used in merge hooks as the fallback instance.
1380
# Perhaps making this function and the functions it calls be a
1381
# a separate class would be better.
1382
if merge_hook_params.winner == 'other':
1383
# OTHER is a straight winner, so replace this contents with other
1384
return self._default_other_winner_merge(merge_hook_params)
1385
elif merge_hook_params.is_file_merge():
1386
# THIS and OTHER are both files, so text merge. Either
1387
# BASE is a file, or both converted to files, so at least we
1388
# have agreement that output should be a file.
1390
self.text_merge(merge_hook_params.file_id,
1391
merge_hook_params.trans_id)
1392
except errors.BinaryFile:
1393
return 'not_applicable', None
1396
return 'not_applicable', None
1398
def get_lines(self, tree, file_id):
1399
"""Return the lines in a file, or an empty list."""
1400
if tree.has_id(file_id):
1401
return tree.get_file(file_id).readlines()
1405
def text_merge(self, file_id, trans_id):
1406
"""Perform a three-way text merge on a file_id"""
1407
# it's possible that we got here with base as a different type.
1408
# if so, we just want two-way text conflicts.
1409
if self.base_tree.has_id(file_id) and \
1410
self.base_tree.kind(file_id) == "file":
1411
base_lines = self.get_lines(self.base_tree, file_id)
1414
other_lines = self.get_lines(self.other_tree, file_id)
1415
this_lines = self.get_lines(self.this_tree, file_id)
1416
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1417
is_cherrypick=self.cherrypick)
1418
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1419
if self.show_base is True:
1420
base_marker = '|' * 7
1424
def iter_merge3(retval):
1425
retval["text_conflicts"] = False
1426
for line in m3.merge_lines(name_a = "TREE",
1427
name_b = "MERGE-SOURCE",
1428
name_base = "BASE-REVISION",
1429
start_marker=start_marker,
1430
base_marker=base_marker,
1431
reprocess=self.reprocess):
1432
if line.startswith(start_marker):
1433
retval["text_conflicts"] = True
1434
yield line.replace(start_marker, '<' * 7)
1438
merge3_iterator = iter_merge3(retval)
1439
self.tt.create_file(merge3_iterator, trans_id)
1440
if retval["text_conflicts"] is True:
1441
self._raw_conflicts.append(('text conflict', trans_id))
1442
name = self.tt.final_name(trans_id)
1443
parent_id = self.tt.final_parent(trans_id)
1444
file_group = self._dump_conflicts(name, parent_id, file_id,
1445
this_lines, base_lines,
1447
file_group.append(trans_id)
1449
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1450
base_lines=None, other_lines=None, set_version=False,
1452
"""Emit conflict files.
1453
If this_lines, base_lines, or other_lines are omitted, they will be
1454
determined automatically. If set_version is true, the .OTHER, .THIS
1455
or .BASE (in that order) will be created as versioned files.
1457
data = [('OTHER', self.other_tree, other_lines),
1458
('THIS', self.this_tree, this_lines)]
1460
data.append(('BASE', self.base_tree, base_lines))
1462
# We need to use the actual path in the working tree of the file here,
1463
# ignoring the conflict suffixes
1465
if wt.supports_content_filtering():
1467
filter_tree_path = wt.id2path(file_id)
1468
except errors.NoSuchId:
1469
# file has been deleted
1470
filter_tree_path = None
1472
# Skip the id2path lookup for older formats
1473
filter_tree_path = None
1477
for suffix, tree, lines in data:
1478
if tree.has_id(file_id):
1479
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1480
suffix, lines, filter_tree_path)
1481
file_group.append(trans_id)
1482
if set_version and not versioned:
1483
self.tt.version_file(file_id, trans_id)
1487
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1488
lines=None, filter_tree_path=None):
1489
"""Emit a single conflict file."""
1490
name = name + '.' + suffix
1491
trans_id = self.tt.create_path(name, parent_id)
1492
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1496
def merge_executable(self, file_id, file_status):
1497
"""Perform a merge on the execute bit."""
1498
executable = [self.executable(t, file_id) for t in (self.base_tree,
1499
self.other_tree, self.this_tree)]
1500
self._merge_executable(file_id, executable, file_status,
1501
resolver=self._three_way)
1503
def _merge_executable(self, file_id, executable, file_status,
1505
"""Perform a merge on the execute bit."""
1506
base_executable, other_executable, this_executable = executable
1507
if file_status == "deleted":
1509
winner = resolver(*executable)
1510
if winner == "conflict":
1511
# There must be a None in here, if we have a conflict, but we
1512
# need executability since file status was not deleted.
1513
if self.executable(self.other_tree, file_id) is None:
1517
if winner == 'this' and file_status != "modified":
1519
trans_id = self.tt.trans_id_file_id(file_id)
1521
if self.tt.final_kind(trans_id) != "file":
1523
except errors.NoSuchFile:
1525
if winner == "this":
1526
executability = this_executable
1528
if self.other_tree.has_id(file_id):
1529
executability = other_executable
1530
elif self.this_tree.has_id(file_id):
1531
executability = this_executable
1532
elif self.base_tree_has_id(file_id):
1533
executability = base_executable
1534
if executability is not None:
1535
trans_id = self.tt.trans_id_file_id(file_id)
1536
self.tt.set_executability(executability, trans_id)
1538
def cook_conflicts(self, fs_conflicts):
1539
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1541
self.cooked_conflicts.extend(transform.cook_conflicts(
1542
fs_conflicts, self.tt))
1543
fp = transform.FinalPaths(self.tt)
1544
for conflict in self._raw_conflicts:
1545
conflict_type = conflict[0]
1546
if conflict_type in ('name conflict', 'parent conflict'):
1547
trans_id = conflict[1]
1548
conflict_args = conflict[2:]
1549
if trans_id not in name_conflicts:
1550
name_conflicts[trans_id] = {}
1551
transform.unique_add(name_conflicts[trans_id], conflict_type,
1553
if conflict_type == 'contents conflict':
1554
for trans_id in conflict[1]:
1555
file_id = self.tt.final_file_id(trans_id)
1556
if file_id is not None:
1558
path = fp.get_path(trans_id)
1559
for suffix in ('.BASE', '.THIS', '.OTHER'):
1560
if path.endswith(suffix):
1561
path = path[:-len(suffix)]
1563
c = _mod_conflicts.Conflict.factory(conflict_type,
1564
path=path, file_id=file_id)
1565
self.cooked_conflicts.append(c)
1566
if conflict_type == 'text conflict':
1567
trans_id = conflict[1]
1568
path = fp.get_path(trans_id)
1569
file_id = self.tt.final_file_id(trans_id)
1570
c = _mod_conflicts.Conflict.factory(conflict_type,
1571
path=path, file_id=file_id)
1572
self.cooked_conflicts.append(c)
1574
for trans_id, conflicts in name_conflicts.iteritems():
1576
this_parent, other_parent = conflicts['parent conflict']
1577
if this_parent == other_parent:
1578
raise AssertionError()
1580
this_parent = other_parent = \
1581
self.tt.final_file_id(self.tt.final_parent(trans_id))
1583
this_name, other_name = conflicts['name conflict']
1584
if this_name == other_name:
1585
raise AssertionError()
1587
this_name = other_name = self.tt.final_name(trans_id)
1588
other_path = fp.get_path(trans_id)
1589
if this_parent is not None and this_name is not None:
1590
this_parent_path = \
1591
fp.get_path(self.tt.trans_id_file_id(this_parent))
1592
this_path = osutils.pathjoin(this_parent_path, this_name)
1594
this_path = "<deleted>"
1595
file_id = self.tt.final_file_id(trans_id)
1596
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1597
conflict_path=other_path,
1599
self.cooked_conflicts.append(c)
1600
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1603
class WeaveMerger(Merge3Merger):
1604
"""Three-way tree merger, text weave merger."""
1605
supports_reprocess = True
1606
supports_show_base = False
1607
supports_reverse_cherrypick = False
1608
history_based = True
1610
def _generate_merge_plan(self, file_id, base):
1611
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1614
def _merged_lines(self, file_id):
1615
"""Generate the merged lines.
1616
There is no distinction between lines that are meant to contain <<<<<<<
1620
base = self.base_tree
1623
plan = self._generate_merge_plan(file_id, base)
1624
if 'merge' in debug.debug_flags:
1626
trans_id = self.tt.trans_id_file_id(file_id)
1627
name = self.tt.final_name(trans_id) + '.plan'
1628
contents = ('%11s|%s' % l for l in plan)
1629
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1630
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1631
'>>>>>>> MERGE-SOURCE\n')
1632
lines, conflicts = textmerge.merge_lines(self.reprocess)
1634
base_lines = textmerge.base_from_plan()
1637
return lines, base_lines
1639
def text_merge(self, file_id, trans_id):
1640
"""Perform a (weave) text merge for a given file and file-id.
1641
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1642
and a conflict will be noted.
1644
lines, base_lines = self._merged_lines(file_id)
1646
# Note we're checking whether the OUTPUT is binary in this case,
1647
# because we don't want to get into weave merge guts.
1648
textfile.check_text_lines(lines)
1649
self.tt.create_file(lines, trans_id)
1650
if base_lines is not None:
1652
self._raw_conflicts.append(('text conflict', trans_id))
1653
name = self.tt.final_name(trans_id)
1654
parent_id = self.tt.final_parent(trans_id)
1655
file_group = self._dump_conflicts(name, parent_id, file_id,
1657
base_lines=base_lines)
1658
file_group.append(trans_id)
1661
class LCAMerger(WeaveMerger):
1663
def _generate_merge_plan(self, file_id, base):
1664
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1667
class Diff3Merger(Merge3Merger):
1668
"""Three-way merger using external diff3 for text merging"""
1670
def dump_file(self, temp_dir, name, tree, file_id):
1671
out_path = osutils.pathjoin(temp_dir, name)
1672
out_file = open(out_path, "wb")
1674
in_file = tree.get_file(file_id)
1675
for line in in_file:
1676
out_file.write(line)
1681
def text_merge(self, file_id, trans_id):
1682
"""Perform a diff3 merge using a specified file-id and trans-id.
1683
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1684
will be dumped, and a will be conflict noted.
1687
temp_dir = osutils.mkdtemp(prefix="bzr-")
1689
new_file = osutils.pathjoin(temp_dir, "new")
1690
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1691
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1692
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1693
status = bzrlib.patch.diff3(new_file, this, base, other)
1694
if status not in (0, 1):
1695
raise errors.BzrError("Unhandled diff3 exit code")
1696
f = open(new_file, 'rb')
1698
self.tt.create_file(f, trans_id)
1702
name = self.tt.final_name(trans_id)
1703
parent_id = self.tt.final_parent(trans_id)
1704
self._dump_conflicts(name, parent_id, file_id)
1705
self._raw_conflicts.append(('text conflict', trans_id))
1707
osutils.rmtree(temp_dir)
1710
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1712
merge_type=Merge3Merger,
1713
interesting_ids=None,
1717
interesting_files=None,
1719
pb=progress.DummyProgress(),
1720
change_reporter=None):
1721
"""Primary interface for merging.
1723
typical use is probably
1724
'merge_inner(branch, branch.get_revision_tree(other_revision),
1725
branch.get_revision_tree(base_revision))'
1727
if this_tree is None:
1728
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1729
"parameter as of bzrlib version 0.8.")
1730
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1731
pb=pb, change_reporter=change_reporter)
1732
merger.backup_files = backup_files
1733
merger.merge_type = merge_type
1734
merger.interesting_ids = interesting_ids
1735
merger.ignore_zero = ignore_zero
1736
if interesting_files:
1738
raise ValueError('Only supply interesting_ids'
1739
' or interesting_files')
1740
merger.interesting_files = interesting_files
1741
merger.show_base = show_base
1742
merger.reprocess = reprocess
1743
merger.other_rev_id = other_rev_id
1744
merger.other_basis = other_rev_id
1745
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1746
if get_revision_id is None:
1747
get_revision_id = base_tree.last_revision
1748
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1749
merger.set_base_revision(get_revision_id(), this_branch)
1750
return merger.do_merge()
1752
def get_merge_type_registry():
1753
"""Merge type registry is in bzrlib.option to avoid circular imports.
1755
This method provides a sanctioned way to retrieve it.
1757
from bzrlib import option
1758
return option._merge_type_registry
1761
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1762
def status_a(revision, text):
1763
if revision in ancestors_b:
1764
return 'killed-b', text
1766
return 'new-a', text
1768
def status_b(revision, text):
1769
if revision in ancestors_a:
1770
return 'killed-a', text
1772
return 'new-b', text
1774
plain_a = [t for (a, t) in annotated_a]
1775
plain_b = [t for (a, t) in annotated_b]
1776
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1777
blocks = matcher.get_matching_blocks()
1780
for ai, bi, l in blocks:
1781
# process all mismatched sections
1782
# (last mismatched section is handled because blocks always
1783
# includes a 0-length last block)
1784
for revision, text in annotated_a[a_cur:ai]:
1785
yield status_a(revision, text)
1786
for revision, text in annotated_b[b_cur:bi]:
1787
yield status_b(revision, text)
1788
# and now the matched section
1791
for text_a in plain_a[ai:a_cur]:
1792
yield "unchanged", text_a
1795
class _PlanMergeBase(object):
1797
def __init__(self, a_rev, b_rev, vf, key_prefix):
1800
:param a_rev: Revision-id of one revision to merge
1801
:param b_rev: Revision-id of the other revision to merge
1802
:param vf: A VersionedFiles containing both revisions
1803
:param key_prefix: A prefix for accessing keys in vf, typically
1809
self._last_lines = None
1810
self._last_lines_revision_id = None
1811
self._cached_matching_blocks = {}
1812
self._key_prefix = key_prefix
1813
self._precache_tip_lines()
1815
def _precache_tip_lines(self):
1816
lines = self.get_lines([self.a_rev, self.b_rev])
1817
self.lines_a = lines[self.a_rev]
1818
self.lines_b = lines[self.b_rev]
1820
def get_lines(self, revisions):
1821
"""Get lines for revisions from the backing VersionedFiles.
1823
:raises RevisionNotPresent: on absent texts.
1825
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1827
for record in self.vf.get_record_stream(keys, 'unordered', True):
1828
if record.storage_kind == 'absent':
1829
raise errors.RevisionNotPresent(record.key, self.vf)
1830
result[record.key[-1]] = osutils.chunks_to_lines(
1831
record.get_bytes_as('chunked'))
1834
def plan_merge(self):
1835
"""Generate a 'plan' for merging the two revisions.
1837
This involves comparing their texts and determining the cause of
1838
differences. If text A has a line and text B does not, then either the
1839
line was added to text A, or it was deleted from B. Once the causes
1840
are combined, they are written out in the format described in
1841
VersionedFile.plan_merge
1843
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
1844
unique_a, unique_b = self._unique_lines(blocks)
1845
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
1846
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
1847
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
1849
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
1852
for i, j, n in blocks:
1853
for a_index in range(last_i, i):
1854
if a_index in new_a:
1855
if a_index in killed_b:
1856
yield 'conflicted-a', self.lines_a[a_index]
1858
yield 'new-a', self.lines_a[a_index]
1860
yield 'killed-b', self.lines_a[a_index]
1861
for b_index in range(last_j, j):
1862
if b_index in new_b:
1863
if b_index in killed_a:
1864
yield 'conflicted-b', self.lines_b[b_index]
1866
yield 'new-b', self.lines_b[b_index]
1868
yield 'killed-a', self.lines_b[b_index]
1869
# handle common lines
1870
for a_index in range(i, i+n):
1871
yield 'unchanged', self.lines_a[a_index]
1875
def _get_matching_blocks(self, left_revision, right_revision):
1876
"""Return a description of which sections of two revisions match.
1878
See SequenceMatcher.get_matching_blocks
1880
cached = self._cached_matching_blocks.get((left_revision,
1882
if cached is not None:
1884
if self._last_lines_revision_id == left_revision:
1885
left_lines = self._last_lines
1886
right_lines = self.get_lines([right_revision])[right_revision]
1888
lines = self.get_lines([left_revision, right_revision])
1889
left_lines = lines[left_revision]
1890
right_lines = lines[right_revision]
1891
self._last_lines = right_lines
1892
self._last_lines_revision_id = right_revision
1893
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1895
return matcher.get_matching_blocks()
1897
def _unique_lines(self, matching_blocks):
1898
"""Analyse matching_blocks to determine which lines are unique
1900
:return: a tuple of (unique_left, unique_right), where the values are
1901
sets of line numbers of unique lines.
1907
for i, j, n in matching_blocks:
1908
unique_left.extend(range(last_i, i))
1909
unique_right.extend(range(last_j, j))
1912
return unique_left, unique_right
1915
def _subtract_plans(old_plan, new_plan):
1916
"""Remove changes from new_plan that came from old_plan.
1918
It is assumed that the difference between the old_plan and new_plan
1919
is their choice of 'b' text.
1921
All lines from new_plan that differ from old_plan are emitted
1922
verbatim. All lines from new_plan that match old_plan but are
1923
not about the 'b' revision are emitted verbatim.
1925
Lines that match and are about the 'b' revision are the lines we
1926
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
1927
is skipped entirely.
1929
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
1932
for i, j, n in matcher.get_matching_blocks():
1933
for jj in range(last_j, j):
1935
for jj in range(j, j+n):
1936
plan_line = new_plan[jj]
1937
if plan_line[0] == 'new-b':
1939
elif plan_line[0] == 'killed-b':
1940
yield 'unchanged', plan_line[1]
1946
class _PlanMerge(_PlanMergeBase):
1947
"""Plan an annotate merge using on-the-fly annotation"""
1949
def __init__(self, a_rev, b_rev, vf, key_prefix):
1950
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1951
self.a_key = self._key_prefix + (self.a_rev,)
1952
self.b_key = self._key_prefix + (self.b_rev,)
1953
self.graph = _mod_graph.Graph(self.vf)
1954
heads = self.graph.heads((self.a_key, self.b_key))
1956
# one side dominates, so we can just return its values, yay for
1958
# Ideally we would know that before we get this far
1959
self._head_key = heads.pop()
1960
if self._head_key == self.a_key:
1964
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1965
self._head_key[-1], other)
1968
self._head_key = None
1971
def _precache_tip_lines(self):
1972
# Turn this into a no-op, because we will do this later
1975
def _find_recursive_lcas(self):
1976
"""Find all the ancestors back to a unique lca"""
1977
cur_ancestors = (self.a_key, self.b_key)
1978
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1979
# rather than a key tuple. We will just map that directly to no common
1983
next_lcas = self.graph.find_lca(*cur_ancestors)
1984
# Map a plain NULL_REVISION to a simple no-ancestors
1985
if next_lcas == set([_mod_revision.NULL_REVISION]):
1987
# Order the lca's based on when they were merged into the tip
1988
# While the actual merge portion of weave merge uses a set() of
1989
# active revisions, the order of insertion *does* effect the
1990
# implicit ordering of the texts.
1991
for rev_key in cur_ancestors:
1992
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1994
parent_map[rev_key] = ordered_parents
1995
if len(next_lcas) == 0:
1997
elif len(next_lcas) == 1:
1998
parent_map[list(next_lcas)[0]] = ()
2000
elif len(next_lcas) > 2:
2001
# More than 2 lca's, fall back to grabbing all nodes between
2002
# this and the unique lca.
2003
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
2005
self.a_key, self.b_key, cur_ancestors)
2006
cur_lcas = next_lcas
2007
while len(cur_lcas) > 1:
2008
cur_lcas = self.graph.find_lca(*cur_lcas)
2009
if len(cur_lcas) == 0:
2010
# No common base to find, use the full ancestry
2013
unique_lca = list(cur_lcas)[0]
2014
if unique_lca == _mod_revision.NULL_REVISION:
2015
# find_lca will return a plain 'NULL_REVISION' rather
2016
# than a key tuple when there is no common ancestor, we
2017
# prefer to just use None, because it doesn't confuse
2018
# _get_interesting_texts()
2020
parent_map.update(self._find_unique_parents(next_lcas,
2023
cur_ancestors = next_lcas
2026
def _find_unique_parents(self, tip_keys, base_key):
2027
"""Find ancestors of tip that aren't ancestors of base.
2029
:param tip_keys: Nodes that are interesting
2030
:param base_key: Cull all ancestors of this node
2031
:return: The parent map for all revisions between tip_keys and
2032
base_key. base_key will be included. References to nodes outside of
2033
the ancestor set will also be removed.
2035
# TODO: this would be simpler if find_unique_ancestors took a list
2036
# instead of a single tip, internally it supports it, but it
2037
# isn't a "backwards compatible" api change.
2038
if base_key is None:
2039
parent_map = dict(self.graph.iter_ancestry(tip_keys))
2040
# We remove NULL_REVISION because it isn't a proper tuple key, and
2041
# thus confuses things like _get_interesting_texts, and our logic
2042
# to add the texts into the memory weave.
2043
if _mod_revision.NULL_REVISION in parent_map:
2044
parent_map.pop(_mod_revision.NULL_REVISION)
2047
for tip in tip_keys:
2049
self.graph.find_unique_ancestors(tip, [base_key]))
2050
parent_map = self.graph.get_parent_map(interesting)
2051
parent_map[base_key] = ()
2052
culled_parent_map, child_map, tails = self._remove_external_references(
2054
# Remove all the tails but base_key
2055
if base_key is not None:
2056
tails.remove(base_key)
2057
self._prune_tails(culled_parent_map, child_map, tails)
2058
# Now remove all the uninteresting 'linear' regions
2059
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
2063
def _remove_external_references(parent_map):
2064
"""Remove references that go outside of the parent map.
2066
:param parent_map: Something returned from Graph.get_parent_map(keys)
2067
:return: (filtered_parent_map, child_map, tails)
2068
filtered_parent_map is parent_map without external references
2069
child_map is the {parent_key: [child_keys]} mapping
2070
tails is a list of nodes that do not have any parents in the map
2072
# TODO: The basic effect of this function seems more generic than
2073
# _PlanMerge. But the specific details of building a child_map,
2074
# and computing tails seems very specific to _PlanMerge.
2075
# Still, should this be in Graph land?
2076
filtered_parent_map = {}
2079
for key, parent_keys in parent_map.iteritems():
2080
culled_parent_keys = [p for p in parent_keys if p in parent_map]
2081
if not culled_parent_keys:
2083
for parent_key in culled_parent_keys:
2084
child_map.setdefault(parent_key, []).append(key)
2085
# TODO: Do we want to do this, it adds overhead for every node,
2086
# just to say that the node has no children
2087
child_map.setdefault(key, [])
2088
filtered_parent_map[key] = culled_parent_keys
2089
return filtered_parent_map, child_map, tails
2092
def _prune_tails(parent_map, child_map, tails_to_remove):
2093
"""Remove tails from the parent map.
2095
This will remove the supplied revisions until no more children have 0
2098
:param parent_map: A dict of {child: [parents]}, this dictionary will
2099
be modified in place.
2100
:param tails_to_remove: A list of tips that should be removed,
2101
this list will be consumed
2102
:param child_map: The reverse dict of parent_map ({parent: [children]})
2103
this dict will be modified
2104
:return: None, parent_map will be modified in place.
2106
while tails_to_remove:
2107
next = tails_to_remove.pop()
2108
parent_map.pop(next)
2109
children = child_map.pop(next)
2110
for child in children:
2111
child_parents = parent_map[child]
2112
child_parents.remove(next)
2113
if len(child_parents) == 0:
2114
tails_to_remove.append(child)
2116
def _get_interesting_texts(self, parent_map):
2117
"""Return a dict of texts we are interested in.
2119
Note that the input is in key tuples, but the output is in plain
2122
:param parent_map: The output from _find_recursive_lcas
2123
:return: A dict of {'revision_id':lines} as returned by
2124
_PlanMergeBase.get_lines()
2126
all_revision_keys = set(parent_map)
2127
all_revision_keys.add(self.a_key)
2128
all_revision_keys.add(self.b_key)
2130
# Everything else is in 'keys' but get_lines is in 'revision_ids'
2131
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
2134
def _build_weave(self):
2135
from bzrlib import weave
2136
self._weave = weave.Weave(weave_name='in_memory_weave',
2137
allow_reserved=True)
2138
parent_map = self._find_recursive_lcas()
2140
all_texts = self._get_interesting_texts(parent_map)
2142
# Note: Unfortunately, the order given by topo_sort will effect the
2143
# ordering resolution in the output. Specifically, if you add A then B,
2144
# then in the output text A lines will show up before B lines. And, of
2145
# course, topo_sort doesn't guarantee any real ordering.
2146
# So we use merge_sort, and add a fake node on the tip.
2147
# This ensures that left-hand parents will always be inserted into the
2148
# weave before right-hand parents.
2149
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
2150
parent_map[tip_key] = (self.a_key, self.b_key)
2152
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
2156
# for key in tsort.topo_sort(parent_map):
2157
parent_keys = parent_map[key]
2158
revision_id = key[-1]
2159
parent_ids = [k[-1] for k in parent_keys]
2160
self._weave.add_lines(revision_id, parent_ids,
2161
all_texts[revision_id])
2163
def plan_merge(self):
2164
"""Generate a 'plan' for merging the two revisions.
2166
This involves comparing their texts and determining the cause of
2167
differences. If text A has a line and text B does not, then either the
2168
line was added to text A, or it was deleted from B. Once the causes
2169
are combined, they are written out in the format described in
2170
VersionedFile.plan_merge
2172
if self._head_key is not None: # There was a single head
2173
if self._head_key == self.a_key:
2176
if self._head_key != self.b_key:
2177
raise AssertionError('There was an invalid head: %s != %s'
2178
% (self.b_key, self._head_key))
2180
head_rev = self._head_key[-1]
2181
lines = self.get_lines([head_rev])[head_rev]
2182
return ((plan, line) for line in lines)
2183
return self._weave.plan_merge(self.a_rev, self.b_rev)
2186
class _PlanLCAMerge(_PlanMergeBase):
2188
This merge algorithm differs from _PlanMerge in that:
2189
1. comparisons are done against LCAs only
2190
2. cases where a contested line is new versus one LCA but old versus
2191
another are marked as conflicts, by emitting the line as conflicted-a
2194
This is faster, and hopefully produces more useful output.
2197
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
2198
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
2199
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
2202
if lca == _mod_revision.NULL_REVISION:
2205
self.lcas.add(lca[-1])
2206
for lca in self.lcas:
2207
if _mod_revision.is_null(lca):
2210
lca_lines = self.get_lines([lca])[lca]
2211
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2213
blocks = list(matcher.get_matching_blocks())
2214
self._cached_matching_blocks[(a_rev, lca)] = blocks
2215
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2217
blocks = list(matcher.get_matching_blocks())
2218
self._cached_matching_blocks[(b_rev, lca)] = blocks
2220
def _determine_status(self, revision_id, unique_line_numbers):
2221
"""Determines the status unique lines versus all lcas.
2223
Basically, determines why the line is unique to this revision.
2225
A line may be determined new, killed, or both.
2227
If a line is determined new, that means it was not present in at least
2228
one LCA, and is not present in the other merge revision.
2230
If a line is determined killed, that means the line was present in
2233
If a line is killed and new, this indicates that the two merge
2234
revisions contain differing conflict resolutions.
2235
:param revision_id: The id of the revision in which the lines are
2237
:param unique_line_numbers: The line numbers of unique lines.
2238
:return a tuple of (new_this, killed_other):
2242
unique_line_numbers = set(unique_line_numbers)
2243
for lca in self.lcas:
2244
blocks = self._get_matching_blocks(revision_id, lca)
2245
unique_vs_lca, _ignored = self._unique_lines(blocks)
2246
new.update(unique_line_numbers.intersection(unique_vs_lca))
2247
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
