1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27
revision as _mod_revision,
29
from bzrlib.branch import Branch
30
from bzrlib.conflicts import ConflictList, Conflict
31
from bzrlib.errors import (BzrCommandError,
41
WorkingTreeNotRevision,
44
from bzrlib.merge3 import Merge3
45
from bzrlib.osutils import rename, pathjoin
46
from progress import DummyProgress, ProgressPhase
47
from bzrlib.revision import (is_ancestor, NULL_REVISION, ensure_null)
48
from bzrlib.textfile import check_text_lines
49
from bzrlib.trace import mutter, warning, note
50
from bzrlib.transform import (TreeTransform, resolve_conflicts, cook_conflicts,
51
conflict_pass, FinalPaths, create_by_entry,
52
unique_add, ROOT_PARENT)
53
from bzrlib.versionedfile import PlanWeaveMerge
56
# TODO: Report back as changes are merged in
59
def transform_tree(from_tree, to_tree, interesting_ids=None):
60
merge_inner(from_tree.branch, to_tree, from_tree, ignore_zero=True,
61
interesting_ids=interesting_ids, this_tree=from_tree)
65
def __init__(self, this_branch, other_tree=None, base_tree=None,
66
this_tree=None, pb=DummyProgress(), change_reporter=None,
69
assert this_tree is not None, "this_tree is required"
70
self.this_branch = this_branch
71
self.this_basis = _mod_revision.ensure_null(
72
this_branch.last_revision())
73
self.this_rev_id = None
74
self.this_tree = this_tree
75
self.this_revision_tree = None
76
self.this_basis_tree = None
77
self.other_tree = other_tree
78
self.other_branch = None
79
self.base_tree = base_tree
80
self.ignore_zero = False
81
self.backup_files = False
82
self.interesting_ids = None
83
self.interesting_files = None
84
self.show_base = False
85
self.reprocess = False
88
self.recurse = recurse
89
self.change_reporter = change_reporter
90
self._cached_trees = {}
92
def revision_tree(self, revision_id, branch=None):
93
if revision_id not in self._cached_trees:
95
branch = self.this_branch
97
tree = self.this_tree.revision_tree(revision_id)
98
except errors.NoSuchRevisionInTree:
99
tree = branch.repository.revision_tree(revision_id)
100
self._cached_trees[revision_id] = tree
101
return self._cached_trees[revision_id]
103
def _get_tree(self, treespec, possible_transports=None):
104
from bzrlib import workingtree
105
location, revno = treespec
107
tree = workingtree.WorkingTree.open_containing(location)[0]
108
return tree.branch, tree
109
branch = Branch.open_containing(location, possible_transports)[0]
111
revision_id = branch.last_revision()
113
revision_id = branch.get_rev_id(revno)
114
revision_id = ensure_null(revision_id)
115
return branch, self.revision_tree(revision_id, branch)
117
def ensure_revision_trees(self):
118
if self.this_revision_tree is None:
119
self.this_basis_tree = self.revision_tree(self.this_basis)
120
if self.this_basis == self.this_rev_id:
121
self.this_revision_tree = self.this_basis_tree
123
if self.other_rev_id is None:
124
other_basis_tree = self.revision_tree(self.other_basis)
125
changes = other_basis_tree.changes_from(self.other_tree)
126
if changes.has_changed():
127
raise WorkingTreeNotRevision(self.this_tree)
128
other_rev_id = self.other_basis
129
self.other_tree = other_basis_tree
131
def file_revisions(self, file_id):
132
self.ensure_revision_trees()
133
def get_id(tree, file_id):
134
revision_id = tree.inventory[file_id].revision
135
assert revision_id is not None
137
if self.this_rev_id is None:
138
if self.this_basis_tree.get_file_sha1(file_id) != \
139
self.this_tree.get_file_sha1(file_id):
140
raise WorkingTreeNotRevision(self.this_tree)
142
trees = (self.this_basis_tree, self.other_tree)
143
return [get_id(tree, file_id) for tree in trees]
145
def check_basis(self, check_clean, require_commits=True):
146
if self.this_basis is None and require_commits is True:
147
raise BzrCommandError("This branch has no commits."
148
" (perhaps you would prefer 'bzr pull')")
151
if self.this_basis != self.this_rev_id:
152
raise BzrCommandError("Working tree has uncommitted changes.")
154
def compare_basis(self):
156
basis_tree = self.revision_tree(self.this_tree.last_revision())
157
except errors.RevisionNotPresent:
158
basis_tree = self.this_tree.basis_tree()
159
changes = self.this_tree.changes_from(basis_tree)
160
if not changes.has_changed():
161
self.this_rev_id = self.this_basis
163
def set_interesting_files(self, file_list):
164
self.interesting_files = file_list
166
def set_pending(self):
167
if not self.base_is_ancestor or not self.base_is_other_ancestor or self.other_rev_id is None:
171
def _add_parent(self):
172
new_parents = self.this_tree.get_parent_ids() + [self.other_rev_id]
173
new_parent_trees = []
174
for revision_id in new_parents:
176
tree = self.revision_tree(revision_id)
177
except errors.RevisionNotPresent:
181
new_parent_trees.append((revision_id, tree))
183
self.this_tree.set_parent_trees(new_parent_trees,
184
allow_leftmost_as_ghost=True)
186
for _revision_id, tree in new_parent_trees:
190
def set_other(self, other_revision, possible_transports=None):
191
"""Set the revision and tree to merge from.
193
This sets the other_tree, other_rev_id, other_basis attributes.
195
:param other_revision: The [path, revision] list to merge from.
197
self.other_branch, self.other_tree = self._get_tree(other_revision,
199
if other_revision[1] == -1:
200
self.other_rev_id = _mod_revision.ensure_null(
201
self.other_branch.last_revision())
202
if _mod_revision.is_null(self.other_rev_id):
203
raise NoCommits(self.other_branch)
204
self.other_basis = self.other_rev_id
205
elif other_revision[1] is not None:
206
self.other_rev_id = self.other_branch.get_rev_id(other_revision[1])
207
self.other_basis = self.other_rev_id
209
self.other_rev_id = None
210
self.other_basis = self.other_branch.last_revision()
211
if self.other_basis is None:
212
raise NoCommits(self.other_branch)
213
if self.other_rev_id is not None:
214
self._cached_trees[self.other_rev_id] = self.other_tree
215
self._maybe_fetch(self.other_branch,self.this_branch, self.other_basis)
217
def set_other_revision(self, revision_id, other_branch):
218
"""Set 'other' based on a branch and revision id
220
:param revision_id: The revision to use for a tree
221
:param other_branch: The branch containing this tree
223
self.other_rev_id = revision_id
224
self.other_branch = other_branch
225
self._maybe_fetch(other_branch, self.this_branch, self.other_rev_id)
226
self.other_tree = self.revision_tree(revision_id)
227
self.other_basis = revision_id
229
def set_base_revision(self, revision_id, branch):
230
"""Set 'base' based on a branch and revision id
232
:param revision_id: The revision to use for a tree
233
:param branch: The branch containing this tree
235
self.base_rev_id = revision_id
236
self.base_branch = branch
237
self._maybe_fetch(branch, self.this_branch, revision_id)
238
self.base_tree = self.revision_tree(revision_id)
239
self.base_is_ancestor = is_ancestor(self.this_basis,
242
self.base_is_other_ancestor = is_ancestor(self.other_basis,
246
def _maybe_fetch(self, source, target, revision_id):
247
if (source.repository.bzrdir.root_transport.base !=
248
target.repository.bzrdir.root_transport.base):
249
target.fetch(source, revision_id)
252
this_repo = self.this_branch.repository
253
graph = this_repo.get_graph()
254
revisions = [ensure_null(self.this_basis),
255
ensure_null(self.other_basis)]
256
if NULL_REVISION in revisions:
257
self.base_rev_id = NULL_REVISION
259
self.base_rev_id = graph.find_unique_lca(*revisions)
260
if self.base_rev_id == NULL_REVISION:
261
raise UnrelatedBranches()
262
self.base_tree = self.revision_tree(self.base_rev_id)
263
self.base_is_ancestor = True
264
self.base_is_other_ancestor = True
266
def set_base(self, base_revision):
267
"""Set the base revision to use for the merge.
269
:param base_revision: A 2-list containing a path and revision number.
271
mutter("doing merge() with no base_revision specified")
272
if base_revision == [None, None]:
275
base_branch, self.base_tree = self._get_tree(base_revision)
276
if base_revision[1] == -1:
277
self.base_rev_id = base_branch.last_revision()
278
elif base_revision[1] is None:
279
self.base_rev_id = _mod_revision.NULL_REVISION
281
self.base_rev_id = _mod_revision.ensure_null(
282
base_branch.get_rev_id(base_revision[1]))
283
self._maybe_fetch(base_branch, self.this_branch, self.base_rev_id)
284
self.base_is_ancestor = is_ancestor(self.this_basis,
287
self.base_is_other_ancestor = is_ancestor(self.other_basis,
292
kwargs = {'working_tree':self.this_tree, 'this_tree': self.this_tree,
293
'other_tree': self.other_tree,
294
'interesting_ids': self.interesting_ids,
295
'interesting_files': self.interesting_files,
297
if self.merge_type.requires_base:
298
kwargs['base_tree'] = self.base_tree
299
if self.merge_type.supports_reprocess:
300
kwargs['reprocess'] = self.reprocess
302
raise BzrError("Conflict reduction is not supported for merge"
303
" type %s." % self.merge_type)
304
if self.merge_type.supports_show_base:
305
kwargs['show_base'] = self.show_base
307
raise BzrError("Showing base is not supported for this"
308
" merge type. %s" % self.merge_type)
309
self.this_tree.lock_tree_write()
310
if self.base_tree is not None:
311
self.base_tree.lock_read()
312
if self.other_tree is not None:
313
self.other_tree.lock_read()
315
merge = self.merge_type(pb=self._pb,
316
change_reporter=self.change_reporter,
318
if self.recurse == 'down':
319
for path, file_id in self.this_tree.iter_references():
320
sub_tree = self.this_tree.get_nested_tree(file_id, path)
321
other_revision = self.other_tree.get_reference_revision(
323
if other_revision == sub_tree.last_revision():
325
sub_merge = Merger(sub_tree.branch, this_tree=sub_tree)
326
sub_merge.merge_type = self.merge_type
327
relpath = self.this_tree.relpath(path)
328
other_branch = self.other_branch.reference_parent(file_id, relpath)
329
sub_merge.set_other_revision(other_revision, other_branch)
330
base_revision = self.base_tree.get_reference_revision(file_id)
331
sub_merge.base_tree = \
332
sub_tree.branch.repository.revision_tree(base_revision)
336
if self.other_tree is not None:
337
self.other_tree.unlock()
338
if self.base_tree is not None:
339
self.base_tree.unlock()
340
self.this_tree.unlock()
341
if len(merge.cooked_conflicts) == 0:
342
if not self.ignore_zero:
343
note("All changes applied successfully.")
345
note("%d conflicts encountered." % len(merge.cooked_conflicts))
347
return len(merge.cooked_conflicts)
350
class Merge3Merger(object):
351
"""Three-way merger that uses the merge3 text merger"""
353
supports_reprocess = True
354
supports_show_base = True
355
history_based = False
356
winner_idx = {"this": 2, "other": 1, "conflict": 1}
358
def __init__(self, working_tree, this_tree, base_tree, other_tree,
359
interesting_ids=None, reprocess=False, show_base=False,
360
pb=DummyProgress(), pp=None, change_reporter=None,
361
interesting_files=None):
362
"""Initialize the merger object and perform the merge.
364
:param working_tree: The working tree to apply the merge to
365
:param this_tree: The local tree in the merge operation
366
:param base_tree: The common tree in the merge operation
367
:param other_tree: The other other tree to merge changes from
368
:param interesting_ids: The file_ids of files that should be
369
participate in the merge. May not be combined with
371
:param: reprocess If True, perform conflict-reduction processing.
372
:param show_base: If True, show the base revision in text conflicts.
373
(incompatible with reprocess)
374
:param pb: A Progress bar
375
:param pp: A ProgressPhase object
376
:param change_reporter: An object that should report changes made
377
:param interesting_files: The tree-relative paths of files that should
378
participate in the merge. If these paths refer to directories,
379
the contents of those directories will also be included. May not
380
be combined with interesting_ids. If neither interesting_files nor
381
interesting_ids is specified, all files may participate in the
384
object.__init__(self)
385
if interesting_files is not None:
386
assert interesting_ids is None
387
self.interesting_ids = interesting_ids
388
self.interesting_files = interesting_files
389
self.this_tree = working_tree
390
self.this_tree.lock_tree_write()
391
self.base_tree = base_tree
392
self.base_tree.lock_read()
393
self.other_tree = other_tree
394
self.other_tree.lock_read()
395
self._raw_conflicts = []
396
self.cooked_conflicts = []
397
self.reprocess = reprocess
398
self.show_base = show_base
401
self.change_reporter = change_reporter
403
self.pp = ProgressPhase("Merge phase", 3, self.pb)
405
self.tt = TreeTransform(working_tree, self.pb)
408
entries = self._entries3()
409
child_pb = ui.ui_factory.nested_progress_bar()
411
for num, (file_id, changed, parents3, names3,
412
executable3) in enumerate(entries):
413
child_pb.update('Preparing file merge', num, len(entries))
414
self._merge_names(file_id, parents3, names3)
416
file_status = self.merge_contents(file_id)
418
file_status = 'unmodified'
419
self._merge_executable(file_id,
420
executable3, file_status)
425
child_pb = ui.ui_factory.nested_progress_bar()
427
fs_conflicts = resolve_conflicts(self.tt, child_pb,
428
lambda t, c: conflict_pass(t, c, self.other_tree))
431
if change_reporter is not None:
432
from bzrlib import delta
433
delta.report_changes(self.tt._iter_changes(), change_reporter)
434
self.cook_conflicts(fs_conflicts)
435
for conflict in self.cooked_conflicts:
438
results = self.tt.apply(no_conflicts=True)
439
self.write_modified(results)
441
working_tree.add_conflicts(self.cooked_conflicts)
442
except UnsupportedOperation:
446
self.other_tree.unlock()
447
self.base_tree.unlock()
448
self.this_tree.unlock()
452
"""Gather data about files modified between three trees.
454
Return a list of tuples of file_id, changed, parents3, names3,
455
executable3. changed is a boolean indicating whether the file contents
456
or kind were changed. parents3 is a tuple of parent ids for base,
457
other and this. names3 is a tuple of names for base, other and this.
458
executable3 is a tuple of execute-bit values for base, other and this.
461
iterator = self.other_tree._iter_changes(self.base_tree,
462
include_unchanged=True, specific_files=self.interesting_files,
463
extra_trees=[self.this_tree])
464
for (file_id, paths, changed, versioned, parents, names, kind,
465
executable) in iterator:
466
if (self.interesting_ids is not None and
467
file_id not in self.interesting_ids):
469
if file_id in self.this_tree.inventory:
470
entry = self.this_tree.inventory[file_id]
471
this_name = entry.name
472
this_parent = entry.parent_id
473
this_executable = entry.executable
477
this_executable = None
478
parents3 = parents + (this_parent,)
479
names3 = names + (this_name,)
480
executable3 = executable + (this_executable,)
481
result.append((file_id, changed, parents3, names3, executable3))
486
self.tt.final_kind(self.tt.root)
488
self.tt.cancel_deletion(self.tt.root)
489
if self.tt.final_file_id(self.tt.root) is None:
490
self.tt.version_file(self.tt.tree_file_id(self.tt.root),
492
if self.other_tree.inventory.root is None:
494
other_root_file_id = self.other_tree.inventory.root.file_id
495
other_root = self.tt.trans_id_file_id(other_root_file_id)
496
if other_root == self.tt.root:
499
self.tt.final_kind(other_root)
502
self.reparent_children(self.other_tree.inventory.root, self.tt.root)
503
self.tt.cancel_creation(other_root)
504
self.tt.cancel_versioning(other_root)
506
def reparent_children(self, ie, target):
507
for thing, child in ie.children.iteritems():
508
trans_id = self.tt.trans_id_file_id(child.file_id)
509
self.tt.adjust_path(self.tt.final_name(trans_id), target, trans_id)
511
def write_modified(self, results):
513
for path in results.modified_paths:
514
file_id = self.this_tree.path2id(self.this_tree.relpath(path))
517
hash = self.this_tree.get_file_sha1(file_id)
520
modified_hashes[file_id] = hash
521
self.this_tree.set_merge_modified(modified_hashes)
524
def parent(entry, file_id):
525
"""Determine the parent for a file_id (used as a key method)"""
528
return entry.parent_id
531
def name(entry, file_id):
532
"""Determine the name for a file_id (used as a key method)"""
538
def contents_sha1(tree, file_id):
539
"""Determine the sha1 of the file contents (used as a key method)."""
540
if file_id not in tree:
542
return tree.get_file_sha1(file_id)
545
def executable(tree, file_id):
546
"""Determine the executability of a file-id (used as a key method)."""
547
if file_id not in tree:
549
if tree.kind(file_id) != "file":
551
return tree.is_executable(file_id)
554
def kind(tree, file_id):
555
"""Determine the kind of a file-id (used as a key method)."""
556
if file_id not in tree:
558
return tree.kind(file_id)
561
def _three_way(base, other, this):
562
#if base == other, either they all agree, or only THIS has changed.
565
elif this not in (base, other):
567
# "Ambiguous clean merge" -- both sides have made the same change.
570
# this == base: only other has changed.
575
def scalar_three_way(this_tree, base_tree, other_tree, file_id, key):
576
"""Do a three-way test on a scalar.
577
Return "this", "other" or "conflict", depending whether a value wins.
579
key_base = key(base_tree, file_id)
580
key_other = key(other_tree, file_id)
581
#if base == other, either they all agree, or only THIS has changed.
582
if key_base == key_other:
584
key_this = key(this_tree, file_id)
585
if key_this not in (key_base, key_other):
587
# "Ambiguous clean merge"
588
elif key_this == key_other:
591
assert key_this == key_base
594
def merge_names(self, file_id):
596
if file_id in tree.inventory:
597
return tree.inventory[file_id]
600
this_entry = get_entry(self.this_tree)
601
other_entry = get_entry(self.other_tree)
602
base_entry = get_entry(self.base_tree)
603
entries = (base_entry, other_entry, this_entry)
606
for entry in entries:
611
names.append(entry.name)
612
parents.append(entry.parent_id)
613
return self._merge_names(file_id, parents, names)
615
def _merge_names(self, file_id, parents, names):
616
"""Perform a merge on file_id names and parents"""
617
base_name, other_name, this_name = names
618
base_parent, other_parent, this_parent = parents
620
name_winner = self._three_way(*names)
622
parent_id_winner = self._three_way(*parents)
623
if this_name is None:
624
if name_winner == "this":
625
name_winner = "other"
626
if parent_id_winner == "this":
627
parent_id_winner = "other"
628
if name_winner == "this" and parent_id_winner == "this":
630
if name_winner == "conflict":
631
trans_id = self.tt.trans_id_file_id(file_id)
632
self._raw_conflicts.append(('name conflict', trans_id,
633
this_name, other_name))
634
if parent_id_winner == "conflict":
635
trans_id = self.tt.trans_id_file_id(file_id)
636
self._raw_conflicts.append(('parent conflict', trans_id,
637
this_parent, other_parent))
638
if other_name is None:
639
# it doesn't matter whether the result was 'other' or
640
# 'conflict'-- if there's no 'other', we leave it alone.
642
# if we get here, name_winner and parent_winner are set to safe values.
643
trans_id = self.tt.trans_id_file_id(file_id)
644
parent_id = parents[self.winner_idx[parent_id_winner]]
645
if parent_id is not None:
646
parent_trans_id = self.tt.trans_id_file_id(parent_id)
647
self.tt.adjust_path(names[self.winner_idx[name_winner]],
648
parent_trans_id, trans_id)
650
def merge_contents(self, file_id):
651
"""Performa a merge on file_id contents."""
652
def contents_pair(tree):
653
if file_id not in tree:
655
kind = tree.kind(file_id)
657
contents = tree.get_file_sha1(file_id)
658
elif kind == "symlink":
659
contents = tree.get_symlink_target(file_id)
662
return kind, contents
664
def contents_conflict():
665
trans_id = self.tt.trans_id_file_id(file_id)
666
name = self.tt.final_name(trans_id)
667
parent_id = self.tt.final_parent(trans_id)
668
if file_id in self.this_tree.inventory:
669
self.tt.unversion_file(trans_id)
670
if file_id in self.this_tree:
671
self.tt.delete_contents(trans_id)
672
file_group = self._dump_conflicts(name, parent_id, file_id,
674
self._raw_conflicts.append(('contents conflict', file_group))
676
# See SPOT run. run, SPOT, run.
677
# So we're not QUITE repeating ourselves; we do tricky things with
679
base_pair = contents_pair(self.base_tree)
680
other_pair = contents_pair(self.other_tree)
681
if base_pair == other_pair:
682
# OTHER introduced no changes
684
this_pair = contents_pair(self.this_tree)
685
if this_pair == other_pair:
686
# THIS and OTHER introduced the same changes
689
trans_id = self.tt.trans_id_file_id(file_id)
690
if this_pair == base_pair:
691
# only OTHER introduced changes
692
if file_id in self.this_tree:
693
# Remove any existing contents
694
self.tt.delete_contents(trans_id)
695
if file_id in self.other_tree:
696
# OTHER changed the file
697
create_by_entry(self.tt,
698
self.other_tree.inventory[file_id],
699
self.other_tree, trans_id)
700
if file_id not in self.this_tree.inventory:
701
self.tt.version_file(file_id, trans_id)
703
elif file_id in self.this_tree.inventory:
704
# OTHER deleted the file
705
self.tt.unversion_file(trans_id)
707
#BOTH THIS and OTHER introduced changes; scalar conflict
708
elif this_pair[0] == "file" and other_pair[0] == "file":
709
# THIS and OTHER are both files, so text merge. Either
710
# BASE is a file, or both converted to files, so at least we
711
# have agreement that output should be a file.
713
self.text_merge(file_id, trans_id)
715
return contents_conflict()
716
if file_id not in self.this_tree.inventory:
717
self.tt.version_file(file_id, trans_id)
719
self.tt.tree_kind(trans_id)
720
self.tt.delete_contents(trans_id)
725
# Scalar conflict, can't text merge. Dump conflicts
726
return contents_conflict()
728
def get_lines(self, tree, file_id):
729
"""Return the lines in a file, or an empty list."""
731
return tree.get_file(file_id).readlines()
735
def text_merge(self, file_id, trans_id):
736
"""Perform a three-way text merge on a file_id"""
737
# it's possible that we got here with base as a different type.
738
# if so, we just want two-way text conflicts.
739
if file_id in self.base_tree and \
740
self.base_tree.kind(file_id) == "file":
741
base_lines = self.get_lines(self.base_tree, file_id)
744
other_lines = self.get_lines(self.other_tree, file_id)
745
this_lines = self.get_lines(self.this_tree, file_id)
746
m3 = Merge3(base_lines, this_lines, other_lines)
747
start_marker = "!START OF MERGE CONFLICT!" + "I HOPE THIS IS UNIQUE"
748
if self.show_base is True:
749
base_marker = '|' * 7
753
def iter_merge3(retval):
754
retval["text_conflicts"] = False
755
for line in m3.merge_lines(name_a = "TREE",
756
name_b = "MERGE-SOURCE",
757
name_base = "BASE-REVISION",
758
start_marker=start_marker,
759
base_marker=base_marker,
760
reprocess=self.reprocess):
761
if line.startswith(start_marker):
762
retval["text_conflicts"] = True
763
yield line.replace(start_marker, '<' * 7)
767
merge3_iterator = iter_merge3(retval)
768
self.tt.create_file(merge3_iterator, trans_id)
769
if retval["text_conflicts"] is True:
770
self._raw_conflicts.append(('text conflict', trans_id))
771
name = self.tt.final_name(trans_id)
772
parent_id = self.tt.final_parent(trans_id)
773
file_group = self._dump_conflicts(name, parent_id, file_id,
774
this_lines, base_lines,
776
file_group.append(trans_id)
778
def _dump_conflicts(self, name, parent_id, file_id, this_lines=None,
779
base_lines=None, other_lines=None, set_version=False,
781
"""Emit conflict files.
782
If this_lines, base_lines, or other_lines are omitted, they will be
783
determined automatically. If set_version is true, the .OTHER, .THIS
784
or .BASE (in that order) will be created as versioned files.
786
data = [('OTHER', self.other_tree, other_lines),
787
('THIS', self.this_tree, this_lines)]
789
data.append(('BASE', self.base_tree, base_lines))
792
for suffix, tree, lines in data:
794
trans_id = self._conflict_file(name, parent_id, tree, file_id,
796
file_group.append(trans_id)
797
if set_version and not versioned:
798
self.tt.version_file(file_id, trans_id)
802
def _conflict_file(self, name, parent_id, tree, file_id, suffix,
804
"""Emit a single conflict file."""
805
name = name + '.' + suffix
806
trans_id = self.tt.create_path(name, parent_id)
807
entry = tree.inventory[file_id]
808
create_by_entry(self.tt, entry, tree, trans_id, lines)
811
def merge_executable(self, file_id, file_status):
812
"""Perform a merge on the execute bit."""
813
executable = [self.executable(t, file_id) for t in (self.base_tree,
814
self.other_tree, self.this_tree)]
815
self._merge_executable(file_id, executable, file_status)
817
def _merge_executable(self, file_id, executable, file_status):
818
"""Perform a merge on the execute bit."""
819
base_executable, other_executable, this_executable = executable
820
if file_status == "deleted":
822
trans_id = self.tt.trans_id_file_id(file_id)
824
if self.tt.final_kind(trans_id) != "file":
828
winner = self._three_way(*executable)
829
if winner == "conflict":
830
# There must be a None in here, if we have a conflict, but we
831
# need executability since file status was not deleted.
832
if self.executable(self.other_tree, file_id) is None:
837
if file_status == "modified":
838
executability = this_executable
839
if executability is not None:
840
trans_id = self.tt.trans_id_file_id(file_id)
841
self.tt.set_executability(executability, trans_id)
843
assert winner == "other"
844
if file_id in self.other_tree:
845
executability = other_executable
846
elif file_id in self.this_tree:
847
executability = this_executable
848
elif file_id in self.base_tree:
849
executability = base_executable
850
if executability is not None:
851
trans_id = self.tt.trans_id_file_id(file_id)
852
self.tt.set_executability(executability, trans_id)
854
def cook_conflicts(self, fs_conflicts):
855
"""Convert all conflicts into a form that doesn't depend on trans_id"""
856
from conflicts import Conflict
858
self.cooked_conflicts.extend(cook_conflicts(fs_conflicts, self.tt))
859
fp = FinalPaths(self.tt)
860
for conflict in self._raw_conflicts:
861
conflict_type = conflict[0]
862
if conflict_type in ('name conflict', 'parent conflict'):
863
trans_id = conflict[1]
864
conflict_args = conflict[2:]
865
if trans_id not in name_conflicts:
866
name_conflicts[trans_id] = {}
867
unique_add(name_conflicts[trans_id], conflict_type,
869
if conflict_type == 'contents conflict':
870
for trans_id in conflict[1]:
871
file_id = self.tt.final_file_id(trans_id)
872
if file_id is not None:
874
path = fp.get_path(trans_id)
875
for suffix in ('.BASE', '.THIS', '.OTHER'):
876
if path.endswith(suffix):
877
path = path[:-len(suffix)]
879
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
880
self.cooked_conflicts.append(c)
881
if conflict_type == 'text conflict':
882
trans_id = conflict[1]
883
path = fp.get_path(trans_id)
884
file_id = self.tt.final_file_id(trans_id)
885
c = Conflict.factory(conflict_type, path=path, file_id=file_id)
886
self.cooked_conflicts.append(c)
888
for trans_id, conflicts in name_conflicts.iteritems():
890
this_parent, other_parent = conflicts['parent conflict']
891
assert this_parent != other_parent
893
this_parent = other_parent = \
894
self.tt.final_file_id(self.tt.final_parent(trans_id))
896
this_name, other_name = conflicts['name conflict']
897
assert this_name != other_name
899
this_name = other_name = self.tt.final_name(trans_id)
900
other_path = fp.get_path(trans_id)
901
if this_parent is not None and this_name is not None:
903
fp.get_path(self.tt.trans_id_file_id(this_parent))
904
this_path = pathjoin(this_parent_path, this_name)
906
this_path = "<deleted>"
907
file_id = self.tt.final_file_id(trans_id)
908
c = Conflict.factory('path conflict', path=this_path,
909
conflict_path=other_path, file_id=file_id)
910
self.cooked_conflicts.append(c)
911
self.cooked_conflicts.sort(key=Conflict.sort_key)
914
class WeaveMerger(Merge3Merger):
915
"""Three-way tree merger, text weave merger."""
916
supports_reprocess = True
917
supports_show_base = False
919
def __init__(self, working_tree, this_tree, base_tree, other_tree,
920
interesting_ids=None, pb=DummyProgress(), pp=None,
921
reprocess=False, change_reporter=None,
922
interesting_files=None):
923
super(WeaveMerger, self).__init__(working_tree, this_tree,
924
base_tree, other_tree,
925
interesting_ids=interesting_ids,
926
pb=pb, pp=pp, reprocess=reprocess,
927
change_reporter=change_reporter)
929
def _merged_lines(self, file_id):
930
"""Generate the merged lines.
931
There is no distinction between lines that are meant to contain <<<<<<<
934
plan = self.this_tree.plan_file_merge(file_id, self.other_tree)
935
textmerge = PlanWeaveMerge(plan, '<<<<<<< TREE\n',
936
'>>>>>>> MERGE-SOURCE\n')
937
return textmerge.merge_lines(self.reprocess)
939
def text_merge(self, file_id, trans_id):
940
"""Perform a (weave) text merge for a given file and file-id.
941
If conflicts are encountered, .THIS and .OTHER files will be emitted,
942
and a conflict will be noted.
944
lines, conflicts = self._merged_lines(file_id)
946
# Note we're checking whether the OUTPUT is binary in this case,
947
# because we don't want to get into weave merge guts.
948
check_text_lines(lines)
949
self.tt.create_file(lines, trans_id)
951
self._raw_conflicts.append(('text conflict', trans_id))
952
name = self.tt.final_name(trans_id)
953
parent_id = self.tt.final_parent(trans_id)
954
file_group = self._dump_conflicts(name, parent_id, file_id,
956
file_group.append(trans_id)
959
class Diff3Merger(Merge3Merger):
960
"""Three-way merger using external diff3 for text merging"""
962
def dump_file(self, temp_dir, name, tree, file_id):
963
out_path = pathjoin(temp_dir, name)
964
out_file = open(out_path, "wb")
966
in_file = tree.get_file(file_id)
973
def text_merge(self, file_id, trans_id):
974
"""Perform a diff3 merge using a specified file-id and trans-id.
975
If conflicts are encountered, .BASE, .THIS. and .OTHER conflict files
976
will be dumped, and a will be conflict noted.
979
temp_dir = osutils.mkdtemp(prefix="bzr-")
981
new_file = pathjoin(temp_dir, "new")
982
this = self.dump_file(temp_dir, "this", self.this_tree, file_id)
983
base = self.dump_file(temp_dir, "base", self.base_tree, file_id)
984
other = self.dump_file(temp_dir, "other", self.other_tree, file_id)
985
status = bzrlib.patch.diff3(new_file, this, base, other)
986
if status not in (0, 1):
987
raise BzrError("Unhandled diff3 exit code")
988
f = open(new_file, 'rb')
990
self.tt.create_file(f, trans_id)
994
name = self.tt.final_name(trans_id)
995
parent_id = self.tt.final_parent(trans_id)
996
self._dump_conflicts(name, parent_id, file_id)
997
self._raw_conflicts.append(('text conflict', trans_id))
999
osutils.rmtree(temp_dir)
1002
def merge_inner(this_branch, other_tree, base_tree, ignore_zero=False,
1004
merge_type=Merge3Merger,
1005
interesting_ids=None,
1009
interesting_files=None,
1012
change_reporter=None):
1013
"""Primary interface for merging.
1015
typical use is probably
1016
'merge_inner(branch, branch.get_revision_tree(other_revision),
1017
branch.get_revision_tree(base_revision))'
1019
if this_tree is None:
1020
raise BzrError("bzrlib.merge.merge_inner requires a this_tree "
1021
"parameter as of bzrlib version 0.8.")
1022
merger = Merger(this_branch, other_tree, base_tree, this_tree=this_tree,
1023
pb=pb, change_reporter=change_reporter)
1024
merger.backup_files = backup_files
1025
merger.merge_type = merge_type
1026
merger.interesting_ids = interesting_ids
1027
merger.ignore_zero = ignore_zero
1028
if interesting_files:
1029
assert not interesting_ids, ('Only supply interesting_ids'
1030
' or interesting_files')
1031
merger.interesting_files = interesting_files
1032
merger.show_base = show_base
1033
merger.reprocess = reprocess
1034
merger.other_rev_id = other_rev_id
1035
merger.other_basis = other_rev_id
1036
return merger.do_merge()
1038
def get_merge_type_registry():
1039
"""Merge type registry is in bzrlib.option to avoid circular imports.
1041
This method provides a sanctioned way to retrieve it.
1043
from bzrlib import option
1044
return option._merge_type_registry
1047
def _plan_annotate_merge(annotated_a, annotated_b, ancestors_a, ancestors_b):
1048
def status_a(revision, text):
1049
if revision in ancestors_b:
1050
return 'killed-b', text
1052
return 'new-a', text
1054
def status_b(revision, text):
1055
if revision in ancestors_a:
1056
return 'killed-a', text
1058
return 'new-b', text
1060
plain_a = [t for (a, t) in annotated_a]
1061
plain_b = [t for (a, t) in annotated_b]
1062
matcher = patiencediff.PatienceSequenceMatcher(None, plain_a, plain_b)
1063
blocks = matcher.get_matching_blocks()
1066
for ai, bi, l in blocks:
1067
# process all mismatched sections
1068
# (last mismatched section is handled because blocks always
1069
# includes a 0-length last block)
1070
for revision, text in annotated_a[a_cur:ai]:
1071
yield status_a(revision, text)
1072
for revision, text in annotated_b[b_cur:bi]:
1073
yield status_b(revision, text)
1075
# and now the matched section
1078
for text_a, text_b in zip(plain_a[ai:a_cur], plain_b[bi:b_cur]):
1079
assert text_a == text_b
1080
yield "unchanged", text_a
added
removed
bzrlib/merge.py
