1
from merge_core import merge_flex, ApplyMerge3, BackupBeforeChange
2
from changeset import generate_changeset, ExceptionConflictHandler
3
from changeset import Inventory, Diff3Merge
4
from bzrlib import find_branch
6
from bzrlib.errors import BzrCommandError
7
from bzrlib.delta import compare_trees
8
from trace import mutter, warning
14
class UnrelatedBranches(BzrCommandError):
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):
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):
137
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,
168
this_dir=None, backup_files=False, merge_type=ApplyMerge3,
170
"""Merge changes into a tree.
173
Base for three-way merge.
175
Other revision for three-way merge.
177
Directory to merge changes into; '.' by default.
179
If true, this_dir must have no uncommitted changes before the
182
tempdir = tempfile.mkdtemp(prefix="bzr-")
1
# Copyright (C) 2005, 2006, 2008 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
20
branch as _mod_branch,
21
conflicts as _mod_conflicts,
29
revision as _mod_revision,
38
from bzrlib.symbol_versioning import (
42
# TODO: Report back as changes are merged in
45
def transform_tree(from_tree, to_tree, interesting_ids=None):
46
from_tree.lock_tree_write()
186
this_branch = find_branch(this_dir)
48
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
49
interesting_ids=interesting_ids, this_tree=from_tree)
55
def __init__(self, this_branch, other_tree=None, base_tree=None,
56
this_tree=None, pb=None, change_reporter=None,
57
recurse='down', revision_graph=None):
59
self.this_branch = this_branch
60
self.this_basis = _mod_revision.ensure_null(
61
this_branch.last_revision())
62
self.this_rev_id = None
63
self.this_tree = this_tree
64
self.this_revision_tree = None
65
self.this_basis_tree = None
66
self.other_tree = other_tree
67
self.other_branch = None
68
self.base_tree = base_tree
69
self.ignore_zero = False
70
self.backup_files = False
71
self.interesting_ids = None
72
self.interesting_files = None
73
self.show_base = False
74
self.reprocess = False
76
warnings.warn("pb parameter to Merger() is deprecated and ignored")
78
self.recurse = recurse
79
self.change_reporter = change_reporter
80
self._cached_trees = {}
81
self._revision_graph = revision_graph
82
self._base_is_ancestor = None
83
self._base_is_other_ancestor = None
84
self._is_criss_cross = None
85
self._lca_trees = None
87
def cache_trees_with_revision_ids(self, trees):
88
"""Cache any tree in trees if it has a revision_id."""
89
for maybe_tree in trees:
90
if maybe_tree is None:
93
rev_id = maybe_tree.get_revision_id()
94
except AttributeError:
96
self._cached_trees[rev_id] = maybe_tree
99
def revision_graph(self):
100
if self._revision_graph is None:
101
self._revision_graph = self.this_branch.repository.get_graph()
102
return self._revision_graph
104
def _set_base_is_ancestor(self, value):
105
self._base_is_ancestor = value
107
def _get_base_is_ancestor(self):
108
if self._base_is_ancestor is None:
109
self._base_is_ancestor = self.revision_graph.is_ancestor(
110
self.base_rev_id, self.this_basis)
111
return self._base_is_ancestor
113
base_is_ancestor = property(_get_base_is_ancestor, _set_base_is_ancestor)
115
def _set_base_is_other_ancestor(self, value):
116
self._base_is_other_ancestor = value
118
def _get_base_is_other_ancestor(self):
119
if self._base_is_other_ancestor is None:
120
if self.other_basis is None:
122
self._base_is_other_ancestor = self.revision_graph.is_ancestor(
123
self.base_rev_id, self.other_basis)
124
return self._base_is_other_ancestor
126
base_is_other_ancestor = property(_get_base_is_other_ancestor,
127
_set_base_is_other_ancestor)
130
def from_uncommitted(tree, other_tree, pb=None, base_tree=None):
131
"""Return a Merger for uncommitted changes in other_tree.
133
:param tree: The tree to merge into
134
:param other_tree: The tree to get uncommitted changes from
135
:param pb: A progress indicator
136
:param base_tree: The basis to use for the merge. If unspecified,
137
other_tree.basis_tree() will be used.
139
if base_tree is None:
140
base_tree = other_tree.basis_tree()
141
merger = Merger(tree.branch, other_tree, base_tree, tree, pb)
142
merger.base_rev_id = merger.base_tree.get_revision_id()
143
merger.other_rev_id = None
144
merger.other_basis = merger.base_rev_id
148
def from_mergeable(klass, tree, mergeable, pb):
149
"""Return a Merger for a bundle or merge directive.
151
:param tree: The tree to merge changes into
152
:param mergeable: A merge directive or bundle
153
:param pb: A progress indicator
155
mergeable.install_revisions(tree.branch.repository)
156
base_revision_id, other_revision_id, verified =\
157
mergeable.get_merge_request(tree.branch.repository)
158
revision_graph = tree.branch.repository.get_graph()
159
if base_revision_id is not None:
160
if (base_revision_id != _mod_revision.NULL_REVISION and
161
revision_graph.is_ancestor(
162
base_revision_id, tree.branch.last_revision())):
163
base_revision_id = None
165
trace.warning('Performing cherrypick')
166
merger = klass.from_revision_ids(pb, tree, other_revision_id,
167
base_revision_id, revision_graph=
169
return merger, verified
172
def from_revision_ids(pb, tree, other, base=None, other_branch=None,
173
base_branch=None, revision_graph=None,
175
"""Return a Merger for revision-ids.
177
:param pb: A progress indicator
178
:param tree: The tree to merge changes into
179
:param other: The revision-id to use as OTHER
180
:param base: The revision-id to use as BASE. If not specified, will
182
:param other_branch: A branch containing the other revision-id. If
183
not supplied, tree.branch is used.
184
:param base_branch: A branch containing the base revision-id. If
185
not supplied, other_branch or tree.branch will be used.
186
:param revision_graph: If you have a revision_graph precomputed, pass
187
it in, otherwise it will be created for you.
188
:param tree_branch: The branch associated with tree. If not supplied,
189
tree.branch will be used.
191
if tree_branch is None:
192
tree_branch = tree.branch
193
merger = Merger(tree_branch, this_tree=tree, pb=pb,
194
revision_graph=revision_graph)
195
if other_branch is None:
196
other_branch = tree.branch
197
merger.set_other_revision(other, other_branch)
201
if base_branch is None:
202
base_branch = other_branch
203
merger.set_base_revision(base, base_branch)
206
def revision_tree(self, revision_id, branch=None):
207
if revision_id not in self._cached_trees:
209
branch = self.this_branch
211
tree = self.this_tree.revision_tree(revision_id)
212
except errors.NoSuchRevisionInTree:
213
tree = branch.repository.revision_tree(revision_id)
214
self._cached_trees[revision_id] = tree
215
return self._cached_trees[revision_id]
217
def _get_tree(self, treespec, possible_transports=None):
218
from bzrlib import workingtree
219
location, revno = treespec
221
tree = workingtree.WorkingTree.open_containing(location)[0]
222
return tree.branch, tree
223
branch = _mod_branch.Branch.open_containing(
224
location, possible_transports)[0]
226
revision_id = branch.last_revision()
228
revision_id = branch.get_rev_id(revno)
229
revision_id = _mod_revision.ensure_null(revision_id)
230
return branch, self.revision_tree(revision_id, branch)
232
@deprecated_method(deprecated_in((2, 1, 0)))
233
def ensure_revision_trees(self):
234
if self.this_revision_tree is None:
235
self.this_basis_tree = self.revision_tree(self.this_basis)
236
if self.this_basis == self.this_rev_id:
237
self.this_revision_tree = self.this_basis_tree
239
if self.other_rev_id is None:
240
other_basis_tree = self.revision_tree(self.other_basis)
241
if other_basis_tree.has_changes(self.other_tree):
242
raise errors.WorkingTreeNotRevision(self.this_tree)
243
other_rev_id = self.other_basis
244
self.other_tree = other_basis_tree
246
@deprecated_method(deprecated_in((2, 1, 0)))
247
def file_revisions(self, file_id):
248
self.ensure_revision_trees()
249
def get_id(tree, file_id):
250
revision_id = tree.inventory[file_id].revision
252
if self.this_rev_id is None:
253
if self.this_basis_tree.get_file_sha1(file_id) != \
254
self.this_tree.get_file_sha1(file_id):
255
raise errors.WorkingTreeNotRevision(self.this_tree)
257
trees = (self.this_basis_tree, self.other_tree)
258
return [get_id(tree, file_id) for tree in trees]
260
@deprecated_method(deprecated_in((2, 1, 0)))
261
def check_basis(self, check_clean, require_commits=True):
262
if self.this_basis is None and require_commits is True:
263
raise errors.BzrCommandError(
264
"This branch has no commits."
265
" (perhaps you would prefer 'bzr pull')")
188
changes = compare_trees(this_branch.working_tree(),
189
this_branch.basis_tree(), False)
190
if changes.has_changed():
191
raise BzrCommandError("Working tree has uncommitted changes.")
192
other_branch, other_tree = get_tree(other_revision, tempdir, "other")
268
if self.this_basis != self.this_rev_id:
269
raise errors.UncommittedChanges(self.this_tree)
271
@deprecated_method(deprecated_in((2, 1, 0)))
272
def compare_basis(self):
274
basis_tree = self.revision_tree(self.this_tree.last_revision())
275
except errors.NoSuchRevision:
276
basis_tree = self.this_tree.basis_tree()
277
if not self.this_tree.has_changes(basis_tree):
278
self.this_rev_id = self.this_basis
280
def set_interesting_files(self, file_list):
281
self.interesting_files = file_list
283
def set_pending(self):
284
if (not self.base_is_ancestor or not self.base_is_other_ancestor
285
or self.other_rev_id is None):
289
def _add_parent(self):
290
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
291
new_parent_trees = []
292
for revision_id in new_parents:
294
tree = self.revision_tree(revision_id)
295
except errors.NoSuchRevision:
299
new_parent_trees.append((revision_id, tree))
301
self.this_tree.set_parent_trees(new_parent_trees,
302
allow_leftmost_as_ghost=True)
304
for _revision_id, tree in new_parent_trees:
308
def set_other(self, other_revision, possible_transports=None):
309
"""Set the revision and tree to merge from.
311
This sets the other_tree, other_rev_id, other_basis attributes.
313
:param other_revision: The [path, revision] list to merge from.
315
self.other_branch, self.other_tree = self._get_tree(other_revision,
317
if other_revision[1] == -1:
318
self.other_rev_id = _mod_revision.ensure_null(
319
self.other_branch.last_revision())
320
if _mod_revision.is_null(self.other_rev_id):
321
raise errors.NoCommits(self.other_branch)
322
self.other_basis = self.other_rev_id
323
elif other_revision[1] is not None:
324
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
325
self.other_basis = self.other_rev_id
327
self.other_rev_id = None
328
self.other_basis = self.other_branch.last_revision()
329
if self.other_basis is None:
330
raise errors.NoCommits(self.other_branch)
331
if self.other_rev_id is not None:
332
self._cached_trees[self.other_rev_id] = self.other_tree
333
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
335
def set_other_revision(self, revision_id, other_branch):
336
"""Set 'other' based on a branch and revision id
338
:param revision_id: The revision to use for a tree
339
:param other_branch: The branch containing this tree
341
self.other_rev_id = revision_id
342
self.other_branch = other_branch
343
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
344
self.other_tree = self.revision_tree(revision_id)
345
self.other_basis = revision_id
347
def set_base_revision(self, revision_id, branch):
348
"""Set 'base' based on a branch and revision id
350
:param revision_id: The revision to use for a tree
351
:param branch: The branch containing this tree
353
self.base_rev_id = revision_id
354
self.base_branch = branch
355
self._maybe_fetch(branch, self.this_branch, revision_id)
356
self.base_tree = self.revision_tree(revision_id)
358
def _maybe_fetch(self, source, target, revision_id):
359
if not source.repository.has_same_location(target.repository):
360
target.fetch(source, revision_id)
363
revisions = [_mod_revision.ensure_null(self.this_basis),
364
_mod_revision.ensure_null(self.other_basis)]
365
if _mod_revision.NULL_REVISION in revisions:
366
self.base_rev_id = _mod_revision.NULL_REVISION
367
self.base_tree = self.revision_tree(self.base_rev_id)
368
self._is_criss_cross = False
370
lcas = self.revision_graph.find_lca(revisions[0], revisions[1])
371
self._is_criss_cross = False
373
self.base_rev_id = _mod_revision.NULL_REVISION
375
self.base_rev_id = list(lcas)[0]
376
else: # len(lcas) > 1
378
# find_unique_lca can only handle 2 nodes, so we have to
379
# start back at the beginning. It is a shame to traverse
380
# the graph again, but better than re-implementing
382
self.base_rev_id = self.revision_graph.find_unique_lca(
383
revisions[0], revisions[1])
385
self.base_rev_id = self.revision_graph.find_unique_lca(
387
self._is_criss_cross = True
388
if self.base_rev_id == _mod_revision.NULL_REVISION:
389
raise errors.UnrelatedBranches()
390
if self._is_criss_cross:
391
trace.warning('Warning: criss-cross merge encountered. See bzr'
392
' help criss-cross.')
393
trace.mutter('Criss-cross lcas: %r' % lcas)
394
interesting_revision_ids = [self.base_rev_id]
395
interesting_revision_ids.extend(lcas)
396
interesting_trees = dict((t.get_revision_id(), t)
397
for t in self.this_branch.repository.revision_trees(
398
interesting_revision_ids))
399
self._cached_trees.update(interesting_trees)
400
self.base_tree = interesting_trees.pop(self.base_rev_id)
401
sorted_lca_keys = self.revision_graph.find_merge_order(
403
self._lca_trees = [interesting_trees[key]
404
for key in sorted_lca_keys]
406
self.base_tree = self.revision_tree(self.base_rev_id)
407
self.base_is_ancestor = True
408
self.base_is_other_ancestor = True
409
trace.mutter('Base revid: %r' % self.base_rev_id)
411
def set_base(self, base_revision):
412
"""Set the base revision to use for the merge.
414
:param base_revision: A 2-list containing a path and revision number.
416
trace.mutter("doing merge() with no base_revision specified")
193
417
if base_revision == [None, None]:
194
if other_revision[1] == -1:
197
o_revno = other_revision[1]
198
base_revno = this_branch.common_ancestor(other_branch,
199
other_revno=o_revno)[0]
200
if base_revno is None:
201
raise UnrelatedBranches()
202
base_revision = ['.', base_revno]
203
base_branch, base_tree = get_tree(base_revision, tempdir, "base")
204
if file_list is None:
205
interesting_ids = None
207
interesting_ids = set()
208
this_tree = this_branch.working_tree()
209
for fname in file_list:
210
path = this_branch.relpath(fname)
212
for tree in (this_tree, base_tree.tree, other_tree.tree):
213
file_id = tree.inventory.path2id(path)
420
base_branch, self.base_tree = self._get_tree(base_revision)
421
if base_revision[1] == -1:
422
self.base_rev_id = base_branch.last_revision()
423
elif base_revision[1] is None:
424
self.base_rev_id = _mod_revision.NULL_REVISION
426
self.base_rev_id = _mod_revision.ensure_null(
427
base_branch.get_rev_id(base_revision[1]))
428
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
430
def make_merger(self):
431
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
432
'other_tree': self.other_tree,
433
'interesting_ids': self.interesting_ids,
434
'interesting_files': self.interesting_files,
437
if self.merge_type.requires_base:
438
kwargs['base_tree'] = self.base_tree
439
if self.merge_type.supports_reprocess:
440
kwargs['reprocess'] = self.reprocess
442
raise errors.BzrError(
443
"Conflict reduction is not supported for merge"
444
" type %s." % self.merge_type)
445
if self.merge_type.supports_show_base:
446
kwargs['show_base'] = self.show_base
448
raise errors.BzrError("Showing base is not supported for this"
449
" merge type. %s" % self.merge_type)
450
if (not getattr(self.merge_type, 'supports_reverse_cherrypick', True)
451
and not self.base_is_other_ancestor):
452
raise errors.CannotReverseCherrypick()
453
if self.merge_type.supports_cherrypick:
454
kwargs['cherrypick'] = (not self.base_is_ancestor or
455
not self.base_is_other_ancestor)
456
if self._is_criss_cross and getattr(self.merge_type,
457
'supports_lca_trees', False):
458
kwargs['lca_trees'] = self._lca_trees
459
return self.merge_type(pb=None,
460
change_reporter=self.change_reporter,
463
def _do_merge_to(self, merge):
464
if self.other_branch is not None:
465
self.other_branch.update_references(self.this_branch)
467
if self.recurse == 'down':
468
for relpath, file_id in self.this_tree.iter_references():
469
sub_tree = self.this_tree.get_nested_tree(file_id, relpath)
470
other_revision = self.other_tree.get_reference_revision(
472
if other_revision == sub_tree.last_revision():
474
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
475
sub_merge.merge_type = self.merge_type
476
other_branch = self.other_branch.reference_parent(file_id, relpath)
477
sub_merge.set_other_revision(other_revision, other_branch)
478
base_revision = self.base_tree.get_reference_revision(file_id)
479
sub_merge.base_tree = \
480
sub_tree.branch.repository.revision_tree(base_revision)
481
sub_merge.base_rev_id = base_revision
485
self.this_tree.lock_tree_write()
487
if self.base_tree is not None:
488
self.base_tree.lock_read()
490
if self.other_tree is not None:
491
self.other_tree.lock_read()
493
merge = self.make_merger()
494
self._do_merge_to(merge)
496
if self.other_tree is not None:
497
self.other_tree.unlock()
499
if self.base_tree is not None:
500
self.base_tree.unlock()
502
self.this_tree.unlock()
503
if len(merge.cooked_conflicts) == 0:
504
if not self.ignore_zero and not trace.is_quiet():
505
trace.note("All changes applied successfully.")
507
trace.note("%d conflicts encountered."
508
% len(merge.cooked_conflicts))
510
return len(merge.cooked_conflicts)
513
class _InventoryNoneEntry(object):
514
"""This represents an inventory entry which *isn't there*.
516
It simplifies the merging logic if we always have an InventoryEntry, even
517
if it isn't actually present
524
symlink_target = None
527
_none_entry = _InventoryNoneEntry()
530
class Merge3Merger(object):
531
"""Three-way merger that uses the merge3 text merger"""
533
supports_reprocess = True
534
supports_show_base = True
535
history_based = False
536
supports_cherrypick = True
537
supports_reverse_cherrypick = True
538
winner_idx = {"this": 2, "other": 1, "conflict": 1}
539
supports_lca_trees = True
541
def __init__(self, working_tree, this_tree, base_tree, other_tree,
542
interesting_ids=None, reprocess=False, show_base=False,
543
pb=None, pp=None, change_reporter=None,
544
interesting_files=None, do_merge=True,
545
cherrypick=False, lca_trees=None):
546
"""Initialize the merger object and perform the merge.
548
:param working_tree: The working tree to apply the merge to
549
:param this_tree: The local tree in the merge operation
550
:param base_tree: The common tree in the merge operation
551
:param other_tree: The other tree to merge changes from
552
:param interesting_ids: The file_ids of files that should be
553
participate in the merge. May not be combined with
555
:param: reprocess If True, perform conflict-reduction processing.
556
:param show_base: If True, show the base revision in text conflicts.
557
(incompatible with reprocess)
559
:param pp: A ProgressPhase object
560
:param change_reporter: An object that should report changes made
561
:param interesting_files: The tree-relative paths of files that should
562
participate in the merge. If these paths refer to directories,
563
the contents of those directories will also be included. May not
564
be combined with interesting_ids. If neither interesting_files nor
565
interesting_ids is specified, all files may participate in the
567
:param lca_trees: Can be set to a dictionary of {revision_id:rev_tree}
568
if the ancestry was found to include a criss-cross merge.
569
Otherwise should be None.
571
object.__init__(self)
572
if interesting_files is not None and interesting_ids is not None:
574
'specify either interesting_ids or interesting_files')
575
self.interesting_ids = interesting_ids
576
self.interesting_files = interesting_files
577
self.this_tree = working_tree
578
self.base_tree = base_tree
579
self.other_tree = other_tree
580
self._raw_conflicts = []
581
self.cooked_conflicts = []
582
self.reprocess = reprocess
583
self.show_base = show_base
584
self._lca_trees = lca_trees
585
# Uncommenting this will change the default algorithm to always use
586
# _entries_lca. This can be useful for running the test suite and
587
# making sure we haven't missed any corner cases.
588
# if lca_trees is None:
589
# self._lca_trees = [self.base_tree]
590
self.change_reporter = change_reporter
591
self.cherrypick = cherrypick
595
warnings.warn("pp argument to Merge3Merger is deprecated")
597
warnings.warn("pb argument to Merge3Merger is deprecated")
600
self.this_tree.lock_tree_write()
601
self.base_tree.lock_read()
602
self.other_tree.lock_read()
604
self.tt = transform.TreeTransform(self.this_tree, None)
606
self._compute_transform()
607
results = self.tt.apply(no_conflicts=True)
608
self.write_modified(results)
610
self.this_tree.add_conflicts(self.cooked_conflicts)
611
except errors.UnsupportedOperation:
616
self.other_tree.unlock()
617
self.base_tree.unlock()
618
self.this_tree.unlock()
620
def make_preview_transform(self):
621
self.base_tree.lock_read()
622
self.other_tree.lock_read()
623
self.tt = transform.TransformPreview(self.this_tree)
625
self._compute_transform()
627
self.other_tree.unlock()
628
self.base_tree.unlock()
631
def _compute_transform(self):
632
if self._lca_trees is None:
633
entries = self._entries3()
634
resolver = self._three_way
636
entries = self._entries_lca()
637
resolver = self._lca_multi_way
638
child_pb = ui.ui_factory.nested_progress_bar()
640
for num, (file_id, changed, parents3, names3,
641
executable3) in enumerate(entries):
642
child_pb.update('Preparing file merge', num, len(entries))
643
self._merge_names(file_id, parents3, names3, resolver=resolver)
645
file_status = self.merge_contents(file_id)
647
file_status = 'unmodified'
648
self._merge_executable(file_id,
649
executable3, file_status, resolver=resolver)
653
child_pb = ui.ui_factory.nested_progress_bar()
655
fs_conflicts = transform.resolve_conflicts(self.tt, child_pb,
656
lambda t, c: transform.conflict_pass(t, c, self.other_tree))
659
if self.change_reporter is not None:
660
from bzrlib import delta
661
delta.report_changes(
662
self.tt.iter_changes(), self.change_reporter)
663
self.cook_conflicts(fs_conflicts)
664
for conflict in self.cooked_conflicts:
665
trace.warning(conflict)
668
"""Gather data about files modified between three trees.
670
Return a list of tuples of file_id, changed, parents3, names3,
671
executable3. changed is a boolean indicating whether the file contents
672
or kind were changed. parents3 is a tuple of parent ids for base,
673
other and this. names3 is a tuple of names for base, other and this.
674
executable3 is a tuple of execute-bit values for base, other and this.
677
iterator = self.other_tree.iter_changes(self.base_tree,
678
include_unchanged=True, specific_files=self.interesting_files,
679
extra_trees=[self.this_tree])
680
this_entries = dict((e.file_id, e) for p, e in
681
self.this_tree.iter_entries_by_dir(
682
self.interesting_ids))
683
for (file_id, paths, changed, versioned, parents, names, kind,
684
executable) in iterator:
685
if (self.interesting_ids is not None and
686
file_id not in self.interesting_ids):
688
entry = this_entries.get(file_id)
689
if entry is not None:
690
this_name = entry.name
691
this_parent = entry.parent_id
692
this_executable = entry.executable
696
this_executable = None
697
parents3 = parents + (this_parent,)
698
names3 = names + (this_name,)
699
executable3 = executable + (this_executable,)
700
result.append((file_id, changed, parents3, names3, executable3))
703
def _entries_lca(self):
704
"""Gather data about files modified between multiple trees.
706
This compares OTHER versus all LCA trees, and for interesting entries,
707
it then compares with THIS and BASE.
709
For the multi-valued entries, the format will be (BASE, [lca1, lca2])
710
:return: [(file_id, changed, parents, names, executable)]
711
file_id Simple file_id of the entry
712
changed Boolean, True if the kind or contents changed
714
parents ((base, [parent_id, in, lcas]), parent_id_other,
716
names ((base, [name, in, lcas]), name_in_other, name_in_this)
717
executable ((base, [exec, in, lcas]), exec_in_other, exec_in_this)
719
if self.interesting_files is not None:
720
lookup_trees = [self.this_tree, self.base_tree]
721
lookup_trees.extend(self._lca_trees)
722
# I think we should include the lca trees as well
723
interesting_ids = self.other_tree.paths2ids(self.interesting_files,
726
interesting_ids = self.interesting_ids
728
walker = _mod_tree.MultiWalker(self.other_tree, self._lca_trees)
730
base_inventory = self.base_tree.inventory
731
this_inventory = self.this_tree.inventory
732
for path, file_id, other_ie, lca_values in walker.iter_all():
733
# Is this modified at all from any of the other trees?
735
other_ie = _none_entry
736
if interesting_ids is not None and file_id not in interesting_ids:
739
# If other_revision is found in any of the lcas, that means this
740
# node is uninteresting. This is because when merging, if there are
741
# multiple heads(), we have to create a new node. So if we didn't,
742
# we know that the ancestry is linear, and that OTHER did not
744
# See doc/developers/lca_merge_resolution.txt for details
745
other_revision = other_ie.revision
746
if other_revision is not None:
747
# We can't use this shortcut when other_revision is None,
748
# because it may be None because things are WorkingTrees, and
749
# not because it is *actually* None.
750
is_unmodified = False
751
for lca_path, ie in lca_values:
752
if ie is not None and ie.revision == other_revision:
759
for lca_path, lca_ie in lca_values:
761
lca_entries.append(_none_entry)
763
lca_entries.append(lca_ie)
765
if file_id in base_inventory:
766
base_ie = base_inventory[file_id]
768
base_ie = _none_entry
770
if file_id in this_inventory:
771
this_ie = this_inventory[file_id]
773
this_ie = _none_entry
779
for lca_ie in lca_entries:
780
lca_kinds.append(lca_ie.kind)
781
lca_parent_ids.append(lca_ie.parent_id)
782
lca_names.append(lca_ie.name)
783
lca_executable.append(lca_ie.executable)
785
kind_winner = self._lca_multi_way(
786
(base_ie.kind, lca_kinds),
787
other_ie.kind, this_ie.kind)
788
parent_id_winner = self._lca_multi_way(
789
(base_ie.parent_id, lca_parent_ids),
790
other_ie.parent_id, this_ie.parent_id)
791
name_winner = self._lca_multi_way(
792
(base_ie.name, lca_names),
793
other_ie.name, this_ie.name)
795
content_changed = True
796
if kind_winner == 'this':
797
# No kind change in OTHER, see if there are *any* changes
798
if other_ie.kind == 'directory':
799
if parent_id_winner == 'this' and name_winner == 'this':
800
# No change for this directory in OTHER, skip
802
content_changed = False
803
elif other_ie.kind is None or other_ie.kind == 'file':
804
def get_sha1(ie, tree):
805
if ie.kind != 'file':
807
return tree.get_file_sha1(file_id)
808
base_sha1 = get_sha1(base_ie, self.base_tree)
809
lca_sha1s = [get_sha1(ie, tree) for ie, tree
810
in zip(lca_entries, self._lca_trees)]
811
this_sha1 = get_sha1(this_ie, self.this_tree)
812
other_sha1 = get_sha1(other_ie, self.other_tree)
813
sha1_winner = self._lca_multi_way(
814
(base_sha1, lca_sha1s), other_sha1, this_sha1,
815
allow_overriding_lca=False)
816
exec_winner = self._lca_multi_way(
817
(base_ie.executable, lca_executable),
818
other_ie.executable, this_ie.executable)
819
if (parent_id_winner == 'this' and name_winner == 'this'
820
and sha1_winner == 'this' and exec_winner == 'this'):
821
# No kind, parent, name, exec, or content change for
822
# OTHER, so this node is not considered interesting
824
if sha1_winner == 'this':
825
content_changed = False
826
elif other_ie.kind == 'symlink':
827
def get_target(ie, tree):
828
if ie.kind != 'symlink':
830
return tree.get_symlink_target(file_id)
831
base_target = get_target(base_ie, self.base_tree)
832
lca_targets = [get_target(ie, tree) for ie, tree
833
in zip(lca_entries, self._lca_trees)]
834
this_target = get_target(this_ie, self.this_tree)
835
other_target = get_target(other_ie, self.other_tree)
836
target_winner = self._lca_multi_way(
837
(base_target, lca_targets),
838
other_target, this_target)
839
if (parent_id_winner == 'this' and name_winner == 'this'
840
and target_winner == 'this'):
841
# No kind, parent, name, or symlink target change
844
if target_winner == 'this':
845
content_changed = False
846
elif other_ie.kind == 'tree-reference':
847
# The 'changed' information seems to be handled at a higher
848
# level. At least, _entries3 returns False for content
849
# changed, even when at a new revision_id.
850
content_changed = False
851
if (parent_id_winner == 'this' and name_winner == 'this'):
852
# Nothing interesting
855
raise AssertionError('unhandled kind: %s' % other_ie.kind)
856
# XXX: We need to handle kind == 'symlink'
858
# If we have gotten this far, that means something has changed
859
result.append((file_id, content_changed,
860
((base_ie.parent_id, lca_parent_ids),
861
other_ie.parent_id, this_ie.parent_id),
862
((base_ie.name, lca_names),
863
other_ie.name, this_ie.name),
864
((base_ie.executable, lca_executable),
865
other_ie.executable, this_ie.executable)
872
self.tt.final_kind(self.tt.root)
873
except errors.NoSuchFile:
874
self.tt.cancel_deletion(self.tt.root)
875
if self.tt.final_file_id(self.tt.root) is None:
876
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
878
other_root_file_id = self.other_tree.get_root_id()
879
if other_root_file_id is None:
881
other_root = self.tt.trans_id_file_id(other_root_file_id)
882
if other_root == self.tt.root:
885
self.tt.final_kind(other_root)
886
except errors.NoSuchFile:
888
if self.other_tree.inventory.root.file_id in self.this_tree.inventory:
889
# the other tree's root is a non-root in the current tree
891
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
892
self.tt.cancel_creation(other_root)
893
self.tt.cancel_versioning(other_root)
895
def reparent_children(self, ie, target):
896
for thing, child in ie.children.iteritems():
897
trans_id = self.tt.trans_id_file_id(child.file_id)
898
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
900
def write_modified(self, results):
902
for path in results.modified_paths:
903
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
906
hash = self.this_tree.get_file_sha1(file_id)
909
modified_hashes[file_id] = hash
910
self.this_tree.set_merge_modified(modified_hashes)
913
def parent(entry, file_id):
914
"""Determine the parent for a file_id (used as a key method)"""
917
return entry.parent_id
920
def name(entry, file_id):
921
"""Determine the name for a file_id (used as a key method)"""
927
def contents_sha1(tree, file_id):
928
"""Determine the sha1 of the file contents (used as a key method)."""
929
if file_id not in tree:
931
return tree.get_file_sha1(file_id)
934
def executable(tree, file_id):
935
"""Determine the executability of a file-id (used as a key method)."""
936
if file_id not in tree:
938
if tree.kind(file_id) != "file":
940
return tree.is_executable(file_id)
943
def kind(tree, file_id):
944
"""Determine the kind of a file-id (used as a key method)."""
945
if file_id not in tree:
947
return tree.kind(file_id)
950
def _three_way(base, other, this):
951
#if base == other, either they all agree, or only THIS has changed.
954
elif this not in (base, other):
956
# "Ambiguous clean merge" -- both sides have made the same change.
959
# this == base: only other has changed.
964
def _lca_multi_way(bases, other, this, allow_overriding_lca=True):
965
"""Consider LCAs when determining whether a change has occurred.
967
If LCAS are all identical, this is the same as a _three_way comparison.
969
:param bases: value in (BASE, [LCAS])
970
:param other: value in OTHER
971
:param this: value in THIS
972
:param allow_overriding_lca: If there is more than one unique lca
973
value, allow OTHER to override THIS if it has a new value, and
974
THIS only has an lca value, or vice versa. This is appropriate for
975
truly scalar values, not as much for non-scalars.
976
:return: 'this', 'other', or 'conflict' depending on whether an entry
979
# See doc/developers/lca_tree_merging.txt for details about this
982
# Either Ambiguously clean, or nothing was actually changed. We
985
base_val, lca_vals = bases
986
# Remove 'base_val' from the lca_vals, because it is not interesting
987
filtered_lca_vals = [lca_val for lca_val in lca_vals
988
if lca_val != base_val]
989
if len(filtered_lca_vals) == 0:
990
return Merge3Merger._three_way(base_val, other, this)
992
unique_lca_vals = set(filtered_lca_vals)
993
if len(unique_lca_vals) == 1:
994
return Merge3Merger._three_way(unique_lca_vals.pop(), other, this)
996
if allow_overriding_lca:
997
if other in unique_lca_vals:
998
if this in unique_lca_vals:
999
# Each side picked a different lca, conflict
1002
# This has a value which supersedes both lca values, and
1003
# other only has an lca value
1005
elif this in unique_lca_vals:
1006
# OTHER has a value which supersedes both lca values, and this
1007
# only has an lca value
1010
# At this point, the lcas disagree, and the tips disagree
1014
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
1015
"""Do a three-way test on a scalar.
1016
Return "this", "other" or "conflict", depending whether a value wins.
1018
key_base = key(base_tree, file_id)
1019
key_other = key(other_tree, file_id)
1020
#if base == other, either they all agree, or only THIS has changed.
1021
if key_base == key_other:
1023
key_this = key(this_tree, file_id)
1024
# "Ambiguous clean merge"
1025
if key_this == key_other:
1027
elif key_this == key_base:
1032
def merge_names(self, file_id):
1033
def get_entry(tree):
1034
if file_id in tree.inventory:
1035
return tree.inventory[file_id]
1038
this_entry = get_entry(self.this_tree)
1039
other_entry = get_entry(self.other_tree)
1040
base_entry = get_entry(self.base_tree)
1041
entries = (base_entry, other_entry, this_entry)
1044
for entry in entries:
1047
parents.append(None)
1049
names.append(entry.name)
1050
parents.append(entry.parent_id)
1051
return self._merge_names(file_id, parents, names,
1052
resolver=self._three_way)
1054
def _merge_names(self, file_id, parents, names, resolver):
1055
"""Perform a merge on file_id names and parents"""
1056
base_name, other_name, this_name = names
1057
base_parent, other_parent, this_parent = parents
1059
name_winner = resolver(*names)
1061
parent_id_winner = resolver(*parents)
1062
if this_name is None:
1063
if name_winner == "this":
1064
name_winner = "other"
1065
if parent_id_winner == "this":
1066
parent_id_winner = "other"
1067
if name_winner == "this" and parent_id_winner == "this":
1069
if name_winner == "conflict":
1070
trans_id = self.tt.trans_id_file_id(file_id)
1071
self._raw_conflicts.append(('name conflict', trans_id,
1072
this_name, other_name))
1073
if parent_id_winner == "conflict":
1074
trans_id = self.tt.trans_id_file_id(file_id)
1075
self._raw_conflicts.append(('parent conflict', trans_id,
1076
this_parent, other_parent))
1077
if other_name is None:
1078
# it doesn't matter whether the result was 'other' or
1079
# 'conflict'-- if there's no 'other', we leave it alone.
1081
# if we get here, name_winner and parent_winner are set to safe values.
1082
trans_id = self.tt.trans_id_file_id(file_id)
1083
parent_id = parents[self.winner_idx[parent_id_winner]]
1084
if parent_id is not None:
1085
parent_trans_id = self.tt.trans_id_file_id(parent_id)
1086
self.tt.adjust_path(names[self.winner_idx[name_winner]],
1087
parent_trans_id, trans_id)
1089
def merge_contents(self, file_id):
1090
"""Performs a merge on file_id contents."""
1091
def contents_pair(tree):
1092
if file_id not in tree:
1094
kind = tree.kind(file_id)
1096
contents = tree.get_file_sha1(file_id)
1097
elif kind == "symlink":
1098
contents = tree.get_symlink_target(file_id)
1101
return kind, contents
1103
def contents_conflict():
1104
trans_id = self.tt.trans_id_file_id(file_id)
1105
name = self.tt.final_name(trans_id)
1106
parent_id = self.tt.final_parent(trans_id)
1107
if file_id in self.this_tree.inventory:
1108
self.tt.unversion_file(trans_id)
1109
if file_id in self.this_tree:
1110
self.tt.delete_contents(trans_id)
1111
file_group = self._dump_conflicts(name, parent_id, file_id,
1113
self._raw_conflicts.append(('contents conflict', file_group))
1115
# See SPOT run. run, SPOT, run.
1116
# So we're not QUITE repeating ourselves; we do tricky things with
1118
base_pair = contents_pair(self.base_tree)
1119
other_pair = contents_pair(self.other_tree)
1121
this_pair = contents_pair(self.this_tree)
1122
lca_pairs = [contents_pair(tree) for tree in self._lca_trees]
1123
winner = self._lca_multi_way((base_pair, lca_pairs), other_pair,
1124
this_pair, allow_overriding_lca=False)
1126
if base_pair == other_pair:
1129
# We delayed evaluating this_pair as long as we can to avoid
1130
# unnecessary sha1 calculation
1131
this_pair = contents_pair(self.this_tree)
1132
winner = self._three_way(base_pair, other_pair, this_pair)
1133
if winner == 'this':
1134
# No interesting changes introduced by OTHER
1136
trans_id = self.tt.trans_id_file_id(file_id)
1137
if winner == 'other':
1138
# OTHER is a straight winner, so replace this contents with other
1139
file_in_this = file_id in self.this_tree
1141
# Remove any existing contents
1142
self.tt.delete_contents(trans_id)
1143
if file_id in self.other_tree:
1144
# OTHER changed the file
1146
if wt.supports_content_filtering():
1147
# We get the path from the working tree if it exists.
1148
# That fails though when OTHER is adding a file, so
1149
# we fall back to the other tree to find the path if
1150
# it doesn't exist locally.
1152
filter_tree_path = wt.id2path(file_id)
1153
except errors.NoSuchId:
1154
filter_tree_path = self.other_tree.id2path(file_id)
1156
# Skip the id2path lookup for older formats
1157
filter_tree_path = None
1158
transform.create_from_tree(self.tt, trans_id,
1159
self.other_tree, file_id,
1160
filter_tree_path=filter_tree_path)
1161
if not file_in_this:
1162
self.tt.version_file(file_id, trans_id)
1165
# OTHER deleted the file
1166
self.tt.unversion_file(trans_id)
1169
# We have a hypothetical conflict, but if we have files, then we
1170
# can try to merge the content
1171
if this_pair[0] == 'file' and other_pair[0] == 'file':
1172
# THIS and OTHER are both files, so text merge. Either
1173
# BASE is a file, or both converted to files, so at least we
1174
# have agreement that output should be a file.
1176
self.text_merge(file_id, trans_id)
1177
except errors.BinaryFile:
1178
return contents_conflict()
1179
if file_id not in self.this_tree:
1180
self.tt.version_file(file_id, trans_id)
1182
self.tt.tree_kind(trans_id)
1183
self.tt.delete_contents(trans_id)
1184
except errors.NoSuchFile:
1188
return contents_conflict()
1190
def get_lines(self, tree, file_id):
1191
"""Return the lines in a file, or an empty list."""
1193
return tree.get_file(file_id).readlines()
1197
def text_merge(self, file_id, trans_id):
1198
"""Perform a three-way text merge on a file_id"""
1199
# it's possible that we got here with base as a different type.
1200
# if so, we just want two-way text conflicts.
1201
if file_id in self.base_tree and \
1202
self.base_tree.kind(file_id) == "file":
1203
base_lines = self.get_lines(self.base_tree, file_id)
1206
other_lines = self.get_lines(self.other_tree, file_id)
1207
this_lines = self.get_lines(self.this_tree, file_id)
1208
m3 = merge3.Merge3(base_lines, this_lines, other_lines,
1209
is_cherrypick=self.cherrypick)
1210
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
1211
if self.show_base is True:
1212
base_marker = '|' * 7
1216
def iter_merge3(retval):
1217
retval["text_conflicts"] = False
1218
for line in m3.merge_lines(name_a = "TREE",
1219
name_b = "MERGE-SOURCE",
1220
name_base = "BASE-REVISION",
1221
start_marker=start_marker,
1222
base_marker=base_marker,
1223
reprocess=self.reprocess):
1224
if line.startswith(start_marker):
1225
retval["text_conflicts"] = True
1226
yield line.replace(start_marker, '<' * 7)
1230
merge3_iterator = iter_merge3(retval)
1231
self.tt.create_file(merge3_iterator, trans_id)
1232
if retval["text_conflicts"] is True:
1233
self._raw_conflicts.append(('text conflict', trans_id))
1234
name = self.tt.final_name(trans_id)
1235
parent_id = self.tt.final_parent(trans_id)
1236
file_group = self._dump_conflicts(name, parent_id, file_id,
1237
this_lines, base_lines,
1239
file_group.append(trans_id)
1241
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
1242
base_lines=None, other_lines=None, set_version=False,
1244
"""Emit conflict files.
1245
If this_lines, base_lines, or other_lines are omitted, they will be
1246
determined automatically. If set_version is true, the .OTHER, .THIS
1247
or .BASE (in that order) will be created as versioned files.
1249
data = [('OTHER', self.other_tree, other_lines),
1250
('THIS', self.this_tree, this_lines)]
1252
data.append(('BASE', self.base_tree, base_lines))
1254
# We need to use the actual path in the working tree of the file here,
1255
# ignoring the conflict suffixes
1257
if wt.supports_content_filtering():
1259
filter_tree_path = wt.id2path(file_id)
1260
except errors.NoSuchId:
1261
# file has been deleted
1262
filter_tree_path = None
1264
# Skip the id2path lookup for older formats
1265
filter_tree_path = None
1269
for suffix, tree, lines in data:
1271
trans_id = self._conflict_file(name, parent_id, tree, file_id,
1272
suffix, lines, filter_tree_path)
1273
file_group.append(trans_id)
1274
if set_version and not versioned:
1275
self.tt.version_file(file_id, trans_id)
1279
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
1280
lines=None, filter_tree_path=None):
1281
"""Emit a single conflict file."""
1282
name = name + '.' + suffix
1283
trans_id = self.tt.create_path(name, parent_id)
1284
transform.create_from_tree(self.tt, trans_id, tree, file_id, lines,
1288
def merge_executable(self, file_id, file_status):
1289
"""Perform a merge on the execute bit."""
1290
executable = [self.executable(t, file_id) for t in (self.base_tree,
1291
self.other_tree, self.this_tree)]
1292
self._merge_executable(file_id, executable, file_status,
1293
resolver=self._three_way)
1295
def _merge_executable(self, file_id, executable, file_status,
1297
"""Perform a merge on the execute bit."""
1298
base_executable, other_executable, this_executable = executable
1299
if file_status == "deleted":
1301
winner = resolver(*executable)
1302
if winner == "conflict":
1303
# There must be a None in here, if we have a conflict, but we
1304
# need executability since file status was not deleted.
1305
if self.executable(self.other_tree, file_id) is None:
1309
if winner == 'this' and file_status != "modified":
1311
trans_id = self.tt.trans_id_file_id(file_id)
1313
if self.tt.final_kind(trans_id) != "file":
1315
except errors.NoSuchFile:
1317
if winner == "this":
1318
executability = this_executable
1320
if file_id in self.other_tree:
1321
executability = other_executable
1322
elif file_id in self.this_tree:
1323
executability = this_executable
1324
elif file_id in self.base_tree:
1325
executability = base_executable
1326
if executability is not None:
1327
trans_id = self.tt.trans_id_file_id(file_id)
1328
self.tt.set_executability(executability, trans_id)
1330
def cook_conflicts(self, fs_conflicts):
1331
"""Convert all conflicts into a form that doesn't depend on trans_id"""
1333
self.cooked_conflicts.extend(transform.cook_conflicts(
1334
fs_conflicts, self.tt))
1335
fp = transform.FinalPaths(self.tt)
1336
for conflict in self._raw_conflicts:
1337
conflict_type = conflict[0]
1338
if conflict_type in ('name conflict', 'parent conflict'):
1339
trans_id = conflict[1]
1340
conflict_args = conflict[2:]
1341
if trans_id not in name_conflicts:
1342
name_conflicts[trans_id] = {}
1343
transform.unique_add(name_conflicts[trans_id], conflict_type,
1345
if conflict_type == 'contents conflict':
1346
for trans_id in conflict[1]:
1347
file_id = self.tt.final_file_id(trans_id)
214
1348
if file_id is not None:
215
interesting_ids.add(file_id)
218
raise BzrCommandError("%s is not a source file in any"
220
merge_inner(this_branch, other_tree, base_tree, tempdir,
221
ignore_zero=ignore_zero, backup_files=backup_files,
222
merge_type=merge_type, interesting_ids=interesting_ids)
224
shutil.rmtree(tempdir)
227
def set_interesting(inventory_a, inventory_b, interesting_ids):
228
"""Mark files whose ids are in interesting_ids as interesting
230
for inventory in (inventory_a, inventory_b):
231
for path, source_file in inventory.iteritems():
232
source_file.interesting = source_file.id in interesting_ids
235
def set_optimized(tree_a, tree_b, inventory_a, inventory_b):
236
"""Mark files that have changed texts as interesting
238
for file_id in tree_a.tree.inventory:
239
if file_id not in tree_b.tree.inventory:
241
entry_a = tree_a.tree.inventory[file_id]
242
entry_b = tree_b.tree.inventory[file_id]
243
if (entry_a.kind, entry_b.kind) != ("file", "file"):
245
if None in (entry_a.text_id, entry_b.text_id):
247
if entry_a.text_id != entry_b.text_id:
249
inventory_a[abspath(tree_a.tree, file_id)].interesting = False
250
inventory_b[abspath(tree_b.tree, file_id)].interesting = False
253
def generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
254
interesting_ids=None):
255
"""Generate a changeset, with preprocessing to select interesting files.
256
using the text_id to mark really-changed files.
257
This permits blazing comparisons when text_ids are present. It also
258
disables metadata comparison for files with identical texts.
260
if interesting_ids is None:
261
set_optimized(tree_a, tree_b, inventory_a, inventory_b)
263
set_interesting(inventory_a, inventory_b, interesting_ids)
264
cset = generate_changeset(tree_a, tree_b, inventory_a, inventory_b)
265
for entry in cset.entries.itervalues():
266
entry.metadata_change = None
270
def merge_inner(this_branch, other_tree, base_tree, tempdir,
271
ignore_zero=False, merge_type=ApplyMerge3, backup_files=False,
272
interesting_ids=None):
274
def merge_factory(base_file, other_file):
275
contents_change = merge_type(base_file, other_file)
277
contents_change = BackupBeforeChange(contents_change)
278
return contents_change
280
def generate_cset(tree_a, tree_b, inventory_a, inventory_b):
281
return generate_cset_optimized(tree_a, tree_b, inventory_a, inventory_b,
284
this_tree = get_tree((this_branch.base, None), tempdir, "this")[1]
286
def get_inventory(tree):
287
return tree.inventory
289
inv_changes = merge_flex(this_tree, base_tree, other_tree,
290
generate_cset, get_inventory,
291
MergeConflictHandler(base_tree.root,
292
ignore_zero=ignore_zero),
293
merge_factory=merge_factory)
296
for id, path in inv_changes.iteritems():
301
assert path.startswith('./')
303
adjust_ids.append((path, id))
304
this_branch.set_inventory(regen_inventory(this_branch, this_tree.root, adjust_ids))
307
def regen_inventory(this_branch, root, new_entries):
308
old_entries = this_branch.read_working_inventory()
311
for file_id in old_entries:
312
entry = old_entries[file_id]
313
path = old_entries.id2path(file_id)
314
new_inventory[file_id] = (path, file_id, entry.parent_id, entry.kind)
315
by_path[path] = file_id
320
for path, file_id in new_entries:
322
del new_inventory[file_id]
325
new_path_list.append((path, file_id))
326
if file_id not in old_entries:
328
# Ensure no file is added before its parent
330
for path, file_id in new_path_list:
334
parent = by_path[os.path.dirname(path)]
335
kind = bzrlib.osutils.file_kind(os.path.join(root, path))
336
new_inventory[file_id] = (path, file_id, parent, kind)
337
by_path[path] = file_id
339
# Get a list in insertion order
340
new_inventory_list = new_inventory.values()
341
mutter ("""Inventory regeneration:
342
old length: %i insertions: %i deletions: %i new_length: %i"""\
343
% (len(old_entries), insertions, deletions, len(new_inventory_list)))
344
assert len(new_inventory_list) == len(old_entries) + insertions - deletions
345
new_inventory_list.sort()
346
return new_inventory_list
348
merge_types = { "merge3": (ApplyMerge3, "Native diff3-style merge"),
349
"diff3": (Diff3Merge, "Merge using external diff3")
1350
path = fp.get_path(trans_id)
1351
for suffix in ('.BASE', '.THIS', '.OTHER'):
1352
if path.endswith(suffix):
1353
path = path[:-len(suffix)]
1355
c = _mod_conflicts.Conflict.factory(conflict_type,
1356
path=path, file_id=file_id)
1357
self.cooked_conflicts.append(c)
1358
if conflict_type == 'text conflict':
1359
trans_id = conflict[1]
1360
path = fp.get_path(trans_id)
1361
file_id = self.tt.final_file_id(trans_id)
1362
c = _mod_conflicts.Conflict.factory(conflict_type,
1363
path=path, file_id=file_id)
1364
self.cooked_conflicts.append(c)
1366
for trans_id, conflicts in name_conflicts.iteritems():
1368
this_parent, other_parent = conflicts['parent conflict']
1369
if this_parent == other_parent:
1370
raise AssertionError()
1372
this_parent = other_parent = \
1373
self.tt.final_file_id(self.tt.final_parent(trans_id))
1375
this_name, other_name = conflicts['name conflict']
1376
if this_name == other_name:
1377
raise AssertionError()
1379
this_name = other_name = self.tt.final_name(trans_id)
1380
other_path = fp.get_path(trans_id)
1381
if this_parent is not None and this_name is not None:
1382
this_parent_path = \
1383
fp.get_path(self.tt.trans_id_file_id(this_parent))
1384
this_path = osutils.pathjoin(this_parent_path, this_name)
1386
this_path = "<deleted>"
1387
file_id = self.tt.final_file_id(trans_id)
1388
c = _mod_conflicts.Conflict.factory('path conflict', path=this_path,
1389
conflict_path=other_path,
1391
self.cooked_conflicts.append(c)
1392
self.cooked_conflicts.sort(key=_mod_conflicts.Conflict.sort_key)
1395
class WeaveMerger(Merge3Merger):
1396
"""Three-way tree merger, text weave merger."""
1397
supports_reprocess = True
1398
supports_show_base = False
1399
supports_reverse_cherrypick = False
1400
history_based = True
1402
def _generate_merge_plan(self, file_id, base):
1403
return self.this_tree.plan_file_merge(file_id, self.other_tree,
1406
def _merged_lines(self, file_id):
1407
"""Generate the merged lines.
1408
There is no distinction between lines that are meant to contain <<<<<<<
1412
base = self.base_tree
1415
plan = self._generate_merge_plan(file_id, base)
1416
if 'merge' in debug.debug_flags:
1418
trans_id = self.tt.trans_id_file_id(file_id)
1419
name = self.tt.final_name(trans_id) + '.plan'
1420
contents = ('%11s|%s' % l for l in plan)
1421
self.tt.new_file(name, self.tt.final_parent(trans_id), contents)
1422
textmerge = versionedfile.PlanWeaveMerge(plan, '<<<<<<< TREE\n',
1423
'>>>>>>> MERGE-SOURCE\n')
1424
lines, conflicts = textmerge.merge_lines(self.reprocess)
1426
base_lines = textmerge.base_from_plan()
1429
return lines, base_lines
1431
def text_merge(self, file_id, trans_id):
1432
"""Perform a (weave) text merge for a given file and file-id.
1433
If conflicts are encountered, .THIS and .OTHER files will be emitted,
1434
and a conflict will be noted.
1436
lines, base_lines = self._merged_lines(file_id)
1438
# Note we're checking whether the OUTPUT is binary in this case,
1439
# because we don't want to get into weave merge guts.
1440
textfile.check_text_lines(lines)
1441
self.tt.create_file(lines, trans_id)
1442
if base_lines is not None:
1444
self._raw_conflicts.append(('text conflict', trans_id))
1445
name = self.tt.final_name(trans_id)
1446
parent_id = self.tt.final_parent(trans_id)
1447
file_group = self._dump_conflicts(name, parent_id, file_id,
1449
base_lines=base_lines)
1450
file_group.append(trans_id)
1453
class LCAMerger(WeaveMerger):
1455
def _generate_merge_plan(self, file_id, base):
1456
return self.this_tree.plan_file_lca_merge(file_id, self.other_tree,
1459
class Diff3Merger(Merge3Merger):
1460
"""Three-way merger using external diff3 for text merging"""
1462
def dump_file(self, temp_dir, name, tree, file_id):
1463
out_path = osutils.pathjoin(temp_dir, name)
1464
out_file = open(out_path, "wb")
1466
in_file = tree.get_file(file_id)
1467
for line in in_file:
1468
out_file.write(line)
1473
def text_merge(self, file_id, trans_id):
1474
"""Perform a diff3 merge using a specified file-id and trans-id.
1475
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
1476
will be dumped, and a will be conflict noted.
1479
temp_dir = osutils.mkdtemp(prefix="bzr-")
1481
new_file = osutils.pathjoin(temp_dir, "new")
1482
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
1483
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
1484
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
1485
status = bzrlib.patch.diff3(new_file, this, base, other)
1486
if status not in (0, 1):
1487
raise errors.BzrError("Unhandled diff3 exit code")
1488
f = open(new_file, 'rb')
1490
self.tt.create_file(f, trans_id)
1494
name = self.tt.final_name(trans_id)
1495
parent_id = self.tt.final_parent(trans_id)
1496
self._dump_conflicts(name, parent_id, file_id)
1497
self._raw_conflicts.append(('text conflict', trans_id))
1499
osutils.rmtree(temp_dir)
1502
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1504
merge_type=Merge3Merger,
1505
interesting_ids=None,
1509
interesting_files=None,
1512
change_reporter=None):
1513
"""Primary interface for merging.
1515
typical use is probably
1516
'merge_inner(branch, branch.get_revision_tree(other_revision),
1517
branch.get_revision_tree(base_revision))'
1519
if this_tree is None:
1520
raise errors.BzrError("bzrlib.merge.merge_inner requires a this_tree "
1521
"parameter as of bzrlib version 0.8.")
1522
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1523
pb=pb, change_reporter=change_reporter)
1524
merger.backup_files = backup_files
1525
merger.merge_type = merge_type
1526
merger.interesting_ids = interesting_ids
1527
merger.ignore_zero = ignore_zero
1528
if interesting_files:
1530
raise ValueError('Only supply interesting_ids'
1531
' or interesting_files')
1532
merger.interesting_files = interesting_files
1533
merger.show_base = show_base
1534
merger.reprocess = reprocess
1535
merger.other_rev_id = other_rev_id
1536
merger.other_basis = other_rev_id
1537
get_revision_id = getattr(base_tree, 'get_revision_id', None)
1538
if get_revision_id is None:
1539
get_revision_id = base_tree.last_revision
1540
merger.cache_trees_with_revision_ids([other_tree, base_tree, this_tree])
1541
merger.set_base_revision(get_revision_id(), this_branch)
1542
return merger.do_merge()
1544
def get_merge_type_registry():
1545
"""Merge type registry is in bzrlib.option to avoid circular imports.
1547
This method provides a sanctioned way to retrieve it.
1549
from bzrlib import option
1550
return option._merge_type_registry
1553
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1554
def status_a(revision, text):
1555
if revision in ancestors_b:
1556
return 'killed-b', text
1558
return 'new-a', text
1560
def status_b(revision, text):
1561
if revision in ancestors_a:
1562
return 'killed-a', text
1564
return 'new-b', text
1566
plain_a = [t for (a, t) in annotated_a]
1567
plain_b = [t for (a, t) in annotated_b]
1568
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1569
blocks = matcher.get_matching_blocks()
1572
for ai, bi, l in blocks:
1573
# process all mismatched sections
1574
# (last mismatched section is handled because blocks always
1575
# includes a 0-length last block)
1576
for revision, text in annotated_a[a_cur:ai]:
1577
yield status_a(revision, text)
1578
for revision, text in annotated_b[b_cur:bi]:
1579
yield status_b(revision, text)
1580
# and now the matched section
1583
for text_a in plain_a[ai:a_cur]:
1584
yield "unchanged", text_a
1587
class _PlanMergeBase(object):
1589
def __init__(self, a_rev, b_rev, vf, key_prefix):
1592
:param a_rev: Revision-id of one revision to merge
1593
:param b_rev: Revision-id of the other revision to merge
1594
:param vf: A VersionedFiles containing both revisions
1595
:param key_prefix: A prefix for accessing keys in vf, typically
1601
self._last_lines = None
1602
self._last_lines_revision_id = None
1603
self._cached_matching_blocks = {}
1604
self._key_prefix = key_prefix
1605
self._precache_tip_lines()
1607
def _precache_tip_lines(self):
1608
lines = self.get_lines([self.a_rev, self.b_rev])
1609
self.lines_a = lines[self.a_rev]
1610
self.lines_b = lines[self.b_rev]
1612
def get_lines(self, revisions):
1613
"""Get lines for revisions from the backing VersionedFiles.
1615
:raises RevisionNotPresent: on absent texts.
1617
keys = [(self._key_prefix + (rev,)) for rev in revisions]
1619
for record in self.vf.get_record_stream(keys, 'unordered', True):
1620
if record.storage_kind == 'absent':
1621
raise errors.RevisionNotPresent(record.key, self.vf)
1622
result[record.key[-1]] = osutils.chunks_to_lines(
1623
record.get_bytes_as('chunked'))
1626
def plan_merge(self):
1627
"""Generate a 'plan' for merging the two revisions.
1629
This involves comparing their texts and determining the cause of
1630
differences. If text A has a line and text B does not, then either the
1631
line was added to text A, or it was deleted from B. Once the causes
1632
are combined, they are written out in the format described in
1633
VersionedFile.plan_merge
1635
blocks = self._get_matching_blocks(self.a_rev, self.b_rev)
1636
unique_a, unique_b = self._unique_lines(blocks)
1637
new_a, killed_b = self._determine_status(self.a_rev, unique_a)
1638
new_b, killed_a = self._determine_status(self.b_rev, unique_b)
1639
return self._iter_plan(blocks, new_a, killed_b, new_b, killed_a)
1641
def _iter_plan(self, blocks, new_a, killed_b, new_b, killed_a):
1644
for i, j, n in blocks:
1645
for a_index in range(last_i, i):
1646
if a_index in new_a:
1647
if a_index in killed_b:
1648
yield 'conflicted-a', self.lines_a[a_index]
1650
yield 'new-a', self.lines_a[a_index]
1652
yield 'killed-b', self.lines_a[a_index]
1653
for b_index in range(last_j, j):
1654
if b_index in new_b:
1655
if b_index in killed_a:
1656
yield 'conflicted-b', self.lines_b[b_index]
1658
yield 'new-b', self.lines_b[b_index]
1660
yield 'killed-a', self.lines_b[b_index]
1661
# handle common lines
1662
for a_index in range(i, i+n):
1663
yield 'unchanged', self.lines_a[a_index]
1667
def _get_matching_blocks(self, left_revision, right_revision):
1668
"""Return a description of which sections of two revisions match.
1670
See SequenceMatcher.get_matching_blocks
1672
cached = self._cached_matching_blocks.get((left_revision,
1674
if cached is not None:
1676
if self._last_lines_revision_id == left_revision:
1677
left_lines = self._last_lines
1678
right_lines = self.get_lines([right_revision])[right_revision]
1680
lines = self.get_lines([left_revision, right_revision])
1681
left_lines = lines[left_revision]
1682
right_lines = lines[right_revision]
1683
self._last_lines = right_lines
1684
self._last_lines_revision_id = right_revision
1685
matcher = patiencediff.PatienceSequenceMatcher(None, left_lines,
1687
return matcher.get_matching_blocks()
1689
def _unique_lines(self, matching_blocks):
1690
"""Analyse matching_blocks to determine which lines are unique
1692
:return: a tuple of (unique_left, unique_right), where the values are
1693
sets of line numbers of unique lines.
1699
for i, j, n in matching_blocks:
1700
unique_left.extend(range(last_i, i))
1701
unique_right.extend(range(last_j, j))
1704
return unique_left, unique_right
1707
def _subtract_plans(old_plan, new_plan):
1708
"""Remove changes from new_plan that came from old_plan.
1710
It is assumed that the difference between the old_plan and new_plan
1711
is their choice of 'b' text.
1713
All lines from new_plan that differ from old_plan are emitted
1714
verbatim. All lines from new_plan that match old_plan but are
1715
not about the 'b' revision are emitted verbatim.
1717
Lines that match and are about the 'b' revision are the lines we
1718
don't want, so we convert 'killed-b' -> 'unchanged', and 'new-b'
1719
is skipped entirely.
1721
matcher = patiencediff.PatienceSequenceMatcher(None, old_plan,
1724
for i, j, n in matcher.get_matching_blocks():
1725
for jj in range(last_j, j):
1727
for jj in range(j, j+n):
1728
plan_line = new_plan[jj]
1729
if plan_line[0] == 'new-b':
1731
elif plan_line[0] == 'killed-b':
1732
yield 'unchanged', plan_line[1]
1738
class _PlanMerge(_PlanMergeBase):
1739
"""Plan an annotate merge using on-the-fly annotation"""
1741
def __init__(self, a_rev, b_rev, vf, key_prefix):
1742
super(_PlanMerge, self).__init__(a_rev, b_rev, vf, key_prefix)
1743
self.a_key = self._key_prefix + (self.a_rev,)
1744
self.b_key = self._key_prefix + (self.b_rev,)
1745
self.graph = _mod_graph.Graph(self.vf)
1746
heads = self.graph.heads((self.a_key, self.b_key))
1748
# one side dominates, so we can just return its values, yay for
1750
# Ideally we would know that before we get this far
1751
self._head_key = heads.pop()
1752
if self._head_key == self.a_key:
1756
trace.mutter('found dominating revision for %s\n%s > %s', self.vf,
1757
self._head_key[-1], other)
1760
self._head_key = None
1763
def _precache_tip_lines(self):
1764
# Turn this into a no-op, because we will do this later
1767
def _find_recursive_lcas(self):
1768
"""Find all the ancestors back to a unique lca"""
1769
cur_ancestors = (self.a_key, self.b_key)
1770
# graph.find_lca(uncommon, keys) now returns plain NULL_REVISION,
1771
# rather than a key tuple. We will just map that directly to no common
1775
next_lcas = self.graph.find_lca(*cur_ancestors)
1776
# Map a plain NULL_REVISION to a simple no-ancestors
1777
if next_lcas == set([_mod_revision.NULL_REVISION]):
1779
# Order the lca's based on when they were merged into the tip
1780
# While the actual merge portion of weave merge uses a set() of
1781
# active revisions, the order of insertion *does* effect the
1782
# implicit ordering of the texts.
1783
for rev_key in cur_ancestors:
1784
ordered_parents = tuple(self.graph.find_merge_order(rev_key,
1786
parent_map[rev_key] = ordered_parents
1787
if len(next_lcas) == 0:
1789
elif len(next_lcas) == 1:
1790
parent_map[list(next_lcas)[0]] = ()
1792
elif len(next_lcas) > 2:
1793
# More than 2 lca's, fall back to grabbing all nodes between
1794
# this and the unique lca.
1795
trace.mutter('More than 2 LCAs, falling back to all nodes for:'
1797
self.a_key, self.b_key, cur_ancestors)
1798
cur_lcas = next_lcas
1799
while len(cur_lcas) > 1:
1800
cur_lcas = self.graph.find_lca(*cur_lcas)
1801
if len(cur_lcas) == 0:
1802
# No common base to find, use the full ancestry
1805
unique_lca = list(cur_lcas)[0]
1806
if unique_lca == _mod_revision.NULL_REVISION:
1807
# find_lca will return a plain 'NULL_REVISION' rather
1808
# than a key tuple when there is no common ancestor, we
1809
# prefer to just use None, because it doesn't confuse
1810
# _get_interesting_texts()
1812
parent_map.update(self._find_unique_parents(next_lcas,
1815
cur_ancestors = next_lcas
1818
def _find_unique_parents(self, tip_keys, base_key):
1819
"""Find ancestors of tip that aren't ancestors of base.
1821
:param tip_keys: Nodes that are interesting
1822
:param base_key: Cull all ancestors of this node
1823
:return: The parent map for all revisions between tip_keys and
1824
base_key. base_key will be included. References to nodes outside of
1825
the ancestor set will also be removed.
1827
# TODO: this would be simpler if find_unique_ancestors took a list
1828
# instead of a single tip, internally it supports it, but it
1829
# isn't a "backwards compatible" api change.
1830
if base_key is None:
1831
parent_map = dict(self.graph.iter_ancestry(tip_keys))
1832
# We remove NULL_REVISION because it isn't a proper tuple key, and
1833
# thus confuses things like _get_interesting_texts, and our logic
1834
# to add the texts into the memory weave.
1835
if _mod_revision.NULL_REVISION in parent_map:
1836
parent_map.pop(_mod_revision.NULL_REVISION)
1839
for tip in tip_keys:
1841
self.graph.find_unique_ancestors(tip, [base_key]))
1842
parent_map = self.graph.get_parent_map(interesting)
1843
parent_map[base_key] = ()
1844
culled_parent_map, child_map, tails = self._remove_external_references(
1846
# Remove all the tails but base_key
1847
if base_key is not None:
1848
tails.remove(base_key)
1849
self._prune_tails(culled_parent_map, child_map, tails)
1850
# Now remove all the uninteresting 'linear' regions
1851
simple_map = _mod_graph.collapse_linear_regions(culled_parent_map)
1855
def _remove_external_references(parent_map):
1856
"""Remove references that go outside of the parent map.
1858
:param parent_map: Something returned from Graph.get_parent_map(keys)
1859
:return: (filtered_parent_map, child_map, tails)
1860
filtered_parent_map is parent_map without external references
1861
child_map is the {parent_key: [child_keys]} mapping
1862
tails is a list of nodes that do not have any parents in the map
1864
# TODO: The basic effect of this function seems more generic than
1865
# _PlanMerge. But the specific details of building a child_map,
1866
# and computing tails seems very specific to _PlanMerge.
1867
# Still, should this be in Graph land?
1868
filtered_parent_map = {}
1871
for key, parent_keys in parent_map.iteritems():
1872
culled_parent_keys = [p for p in parent_keys if p in parent_map]
1873
if not culled_parent_keys:
1875
for parent_key in culled_parent_keys:
1876
child_map.setdefault(parent_key, []).append(key)
1877
# TODO: Do we want to do this, it adds overhead for every node,
1878
# just to say that the node has no children
1879
child_map.setdefault(key, [])
1880
filtered_parent_map[key] = culled_parent_keys
1881
return filtered_parent_map, child_map, tails
1884
def _prune_tails(parent_map, child_map, tails_to_remove):
1885
"""Remove tails from the parent map.
1887
This will remove the supplied revisions until no more children have 0
1890
:param parent_map: A dict of {child: [parents]}, this dictionary will
1891
be modified in place.
1892
:param tails_to_remove: A list of tips that should be removed,
1893
this list will be consumed
1894
:param child_map: The reverse dict of parent_map ({parent: [children]})
1895
this dict will be modified
1896
:return: None, parent_map will be modified in place.
1898
while tails_to_remove:
1899
next = tails_to_remove.pop()
1900
parent_map.pop(next)
1901
children = child_map.pop(next)
1902
for child in children:
1903
child_parents = parent_map[child]
1904
child_parents.remove(next)
1905
if len(child_parents) == 0:
1906
tails_to_remove.append(child)
1908
def _get_interesting_texts(self, parent_map):
1909
"""Return a dict of texts we are interested in.
1911
Note that the input is in key tuples, but the output is in plain
1914
:param parent_map: The output from _find_recursive_lcas
1915
:return: A dict of {'revision_id':lines} as returned by
1916
_PlanMergeBase.get_lines()
1918
all_revision_keys = set(parent_map)
1919
all_revision_keys.add(self.a_key)
1920
all_revision_keys.add(self.b_key)
1922
# Everything else is in 'keys' but get_lines is in 'revision_ids'
1923
all_texts = self.get_lines([k[-1] for k in all_revision_keys])
1926
def _build_weave(self):
1927
from bzrlib import weave
1928
self._weave = weave.Weave(weave_name='in_memory_weave',
1929
allow_reserved=True)
1930
parent_map = self._find_recursive_lcas()
1932
all_texts = self._get_interesting_texts(parent_map)
1934
# Note: Unfortunately, the order given by topo_sort will effect the
1935
# ordering resolution in the output. Specifically, if you add A then B,
1936
# then in the output text A lines will show up before B lines. And, of
1937
# course, topo_sort doesn't guarantee any real ordering.
1938
# So we use merge_sort, and add a fake node on the tip.
1939
# This ensures that left-hand parents will always be inserted into the
1940
# weave before right-hand parents.
1941
tip_key = self._key_prefix + (_mod_revision.CURRENT_REVISION,)
1942
parent_map[tip_key] = (self.a_key, self.b_key)
1944
for seq_num, key, depth, eom in reversed(tsort.merge_sort(parent_map,
1948
# for key in tsort.topo_sort(parent_map):
1949
parent_keys = parent_map[key]
1950
revision_id = key[-1]
1951
parent_ids = [k[-1] for k in parent_keys]
1952
self._weave.add_lines(revision_id, parent_ids,
1953
all_texts[revision_id])
1955
def plan_merge(self):
1956
"""Generate a 'plan' for merging the two revisions.
1958
This involves comparing their texts and determining the cause of
1959
differences. If text A has a line and text B does not, then either the
1960
line was added to text A, or it was deleted from B. Once the causes
1961
are combined, they are written out in the format described in
1962
VersionedFile.plan_merge
1964
if self._head_key is not None: # There was a single head
1965
if self._head_key == self.a_key:
1968
if self._head_key != self.b_key:
1969
raise AssertionError('There was an invalid head: %s != %s'
1970
% (self.b_key, self._head_key))
1972
head_rev = self._head_key[-1]
1973
lines = self.get_lines([head_rev])[head_rev]
1974
return ((plan, line) for line in lines)
1975
return self._weave.plan_merge(self.a_rev, self.b_rev)
1978
class _PlanLCAMerge(_PlanMergeBase):
1980
This merge algorithm differs from _PlanMerge in that:
1981
1. comparisons are done against LCAs only
1982
2. cases where a contested line is new versus one LCA but old versus
1983
another are marked as conflicts, by emitting the line as conflicted-a
1986
This is faster, and hopefully produces more useful output.
1989
def __init__(self, a_rev, b_rev, vf, key_prefix, graph):
1990
_PlanMergeBase.__init__(self, a_rev, b_rev, vf, key_prefix)
1991
lcas = graph.find_lca(key_prefix + (a_rev,), key_prefix + (b_rev,))
1994
if lca == _mod_revision.NULL_REVISION:
1997
self.lcas.add(lca[-1])
1998
for lca in self.lcas:
1999
if _mod_revision.is_null(lca):
2002
lca_lines = self.get_lines([lca])[lca]
2003
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_a,
2005
blocks = list(matcher.get_matching_blocks())
2006
self._cached_matching_blocks[(a_rev, lca)] = blocks
2007
matcher = patiencediff.PatienceSequenceMatcher(None, self.lines_b,
2009
blocks = list(matcher.get_matching_blocks())
2010
self._cached_matching_blocks[(b_rev, lca)] = blocks
2012
def _determine_status(self, revision_id, unique_line_numbers):
2013
"""Determines the status unique lines versus all lcas.
2015
Basically, determines why the line is unique to this revision.
2017
A line may be determined new, killed, or both.
2019
If a line is determined new, that means it was not present in at least
2020
one LCA, and is not present in the other merge revision.
2022
If a line is determined killed, that means the line was present in
2025
If a line is killed and new, this indicates that the two merge
2026
revisions contain differing conflict resolutions.
2027
:param revision_id: The id of the revision in which the lines are
2029
:param unique_line_numbers: The line numbers of unique lines.
2030
:return a tuple of (new_this, killed_other):
2034
unique_line_numbers = set(unique_line_numbers)
2035
for lca in self.lcas:
2036
blocks = self._get_matching_blocks(revision_id, lca)
2037
unique_vs_lca, _ignored = self._unique_lines(blocks)
2038
new.update(unique_line_numbers.intersection(unique_vs_lca))
2039
killed.update(unique_line_numbers.difference(unique_vs_lca))
added
removed
bzrlib/merge.py
