( )⚙ D12013 simplemerge: take arguments as annotated context objects

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D12013

simplemerge: take arguments as annotated context objects
ClosedPublic

Authored by martinvonz on Jan 21 2022, 6:31 PM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG77e24ee8994b: simplemerge: take arguments as annotated context objects
Summary

The labels we put in conflict markers are formatted so the part before
the ':' (typically says things like "local") is padded so the ':' is
aligned among the labels. That means that if you specify a long label
for "base" but the conflict marker style is "merge" (i.e. 2-way), the
other two will have unwanted padding. We often don't specify a label
for the base, so we don't notice the problem (and it may very well be
that it didn't exist before my D11972).

I think the best fix is to pass the labels along with the context
objects, so the low-level code that switches on the marker style to
use (i.e. simplemerge) can do the formatting. This patch starts
doing that by passing a fully-formatted label to simplemerge. A
coming patch will move the formatting to simplemerge.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

martinvonz created this revision.Jan 21 2022, 6:31 PM
Alphare requested changes to this revision.Jan 24 2022, 4:54 AM
Alphare added a subscriber: Alphare.
Alphare added inline comments.
mercurial/simplemerge.py
520

This is slightly out of date now

This revision now requires changes to proceed.Jan 24 2022, 4:54 AM
martinvonz marked an inline comment as done.Jan 24 2022, 11:41 AM
Alphare accepted this revision.Jan 24 2022, 11:49 AM
This revision is now accepted and ready to land.Jan 24 2022, 11:49 AM

Revision Contents
Changeset List

PathPackages
Mcontrib/simplemerge (18 lines)
Mmercurial/filemerge.py (16 lines)
Mmercurial/simplemerge.py (44 lines)

Diff 31826

contrib/simplemerge

showhelp() showhelp()
sys.exit(0) sys.exit(0)
if len(args) != 3: if len(args) != 3:
raise ParseError(_(b'wrong number of arguments').decode('utf8')) raise ParseError(_(b'wrong number of arguments').decode('utf8'))
if len(opts[b'label']) > 2: if len(opts[b'label']) > 2:
opts[b'mode'] = b'merge3' opts[b'mode'] = b'merge3'
local, base, other = args local, base, other = args
overrides = opts[b'label'] overrides = opts[b'label']
if len(overrides) > 3:
raise error.InputError(b'can only specify three labels.')
labels = [local, other, base] labels = [local, other, base]
labels[: len(overrides)] = overrides labels[: len(overrides)] = overrides
opts[b'label'] = labels local_input = simplemerge.MergeInput(
context.arbitraryfilectx(local), labels[0]
)
other_input = simplemerge.MergeInput(
context.arbitraryfilectx(other), labels[1]
)
base_input = simplemerge.MergeInput(
context.arbitraryfilectx(base), labels[2]
)
sys.exit( sys.exit(
simplemerge.simplemerge( simplemerge.simplemerge(
uimod.ui.load(), uimod.ui.load(),
context.arbitraryfilectx(local), local_input,
context.arbitraryfilectx(base), base_input,
context.arbitraryfilectx(other), other_input,
**pycompat.strkwargs(opts) **pycompat.strkwargs(opts)
) )
) )
except ParseError as e: except ParseError as e:
e = stringutil.forcebytestr(e) e = stringutil.forcebytestr(e)
procutil.stdout.write(b"%s: %s\n" % (sys.argv[0].encode('utf8'), e)) procutil.stdout.write(b"%s: %s\n" % (sys.argv[0].encode('utf8'), e))
showhelp() showhelp()
sys.exit(1) sys.exit(1)
except error.Abort as e: except error.Abort as e:
procutil.stderr.write(b"abort: %s\n" % e) procutil.stderr.write(b"abort: %s\n" % e)
sys.exit(255) sys.exit(255)
except KeyboardInterrupt: except KeyboardInterrupt:
sys.exit(255) sys.exit(255)

mercurial/filemerge.py

if premerge: if premerge:
if len(labels) < 3: if len(labels) < 3:
labels.append(b'base') labels.append(b'base')
mode = b'merge' mode = b'merge'
if premerge == b'keep-mergediff': if premerge == b'keep-mergediff':
mode = b'mergediff' mode = b'mergediff'
elif premerge == b'keep-merge3': elif premerge == b'keep-merge3':
mode = b'merge3' mode = b'merge3'
local = simplemerge.MergeInput(fcd, labels[0])
other = simplemerge.MergeInput(fco, labels[1])
base = simplemerge.MergeInput(fca, labels[2])
r = simplemerge.simplemerge( r = simplemerge.simplemerge(
ui, fcd, fca, fco, quiet=True, label=labels, mode=mode ui, local, base, other, quiet=True, mode=mode
) )
if not r: if not r:
ui.debug(b" premerge successful\n") ui.debug(b" premerge successful\n")
return 0 return 0
if premerge not in validkeep: if premerge not in validkeep:
# restore from backup and try again # restore from backup and try again
_restorebackup(fcd, backup) _restorebackup(fcd, backup)
return 1 # continue merging return 1 # continue merging
def _merge(repo, mynode, fcd, fco, fca, toolconf, backup, labels, mode): def _merge(repo, mynode, fcd, fco, fca, toolconf, backup, labels, mode):
""" """
Uses the internal non-interactive simple merge algorithm for merging Uses the internal non-interactive simple merge algorithm for merging
files. It will fail if there are any conflicts and leave markers in files. It will fail if there are any conflicts and leave markers in
the partially merged file. Markers will have two sections, one for each side the partially merged file. Markers will have two sections, one for each side
of merge, unless mode equals 'union' which suppresses the markers.""" of merge, unless mode equals 'union' which suppresses the markers."""
ui = repo.ui ui = repo.ui
r = simplemerge.simplemerge(ui, fcd, fca, fco, label=labels, mode=mode) local = simplemerge.MergeInput(fcd)
if len(labels) > 0:
local.label = labels[0]
other = simplemerge.MergeInput(fco)
if len(labels) > 1:
other.label = labels[1]
base = simplemerge.MergeInput(fca)
if len(labels) > 2:
base.label = labels[2]
r = simplemerge.simplemerge(ui, local, base, other, mode=mode)
return True, r, False return True, r, False
@internaltool( @internaltool(
b'union', b'union',
fullmerge, fullmerge,
_( _(
b"warning: conflicts while merging %s! " b"warning: conflicts while merging %s! "

mercurial/simplemerge.py

# along with this program; if not, see <http://www.gnu.org/licenses/>. # along with this program; if not, see <http://www.gnu.org/licenses/>.
# mbp: "you know that thing where cvs gives you conflict markers?" # mbp: "you know that thing where cvs gives you conflict markers?"
# s: "i hate that." # s: "i hate that."
from __future__ import absolute_import from __future__ import absolute_import
from .i18n import _ from .i18n import _
from .thirdparty import attr
from . import ( from . import (
error, error,
mdiff, mdiff,
pycompat, pycompat,
) )
from .utils import stringutil from .utils import stringutil
msg = _(b"%s looks like a binary file.") % path msg = _(b"%s looks like a binary file.") % path
if not opts.get('quiet'): if not opts.get('quiet'):
ui.warn(_(b'warning: %s\n') % msg) ui.warn(_(b'warning: %s\n') % msg)
if not opts.get('text'): if not opts.get('text'):
raise error.Abort(msg) raise error.Abort(msg)
return text return text
def _picklabels(overrides): def _format_labels(*inputs):
if len(overrides) > 3: labels = []
raise error.Abort(_(b"can only specify three labels.")) for input in inputs:
result = [None, None, None] if input.label:
for i, override in enumerate(overrides): labels.append(input.label)
result[i] = override else:
return result labels.append(None)
return labels
def _detect_newline(m3): def _detect_newline(m3):
if len(m3.a) > 0: if len(m3.a) > 0:
if m3.a[0].endswith(b'\r\n'): if m3.a[0].endswith(b'\r\n'):
return b'\r\n' return b'\r\n'
elif m3.a[0].endswith(b'\r'): elif m3.a[0].endswith(b'\r'):
return b'\r' return b'\r'
if what == b'conflict': if what == b'conflict':
for side in sides: for side in sides:
lines.extend(group_lines[side]) lines.extend(group_lines[side])
else: else:
lines.extend(group_lines) lines.extend(group_lines)
return lines return lines
def simplemerge(ui, localctx, basectx, otherctx, **opts): @attr.s
class MergeInput(object):
fctx = attr.ib()
label = attr.ib(default=None)
def simplemerge(ui, local, base, other, **opts):
"""Performs the simplemerge algorithm. """Performs the simplemerge algorithm.
The merged result is written into `localctx`. The merged result is written into `localctx`.
""" """
def readctx(ctx): def readctx(ctx):
# Merges were always run in the working copy before, which means # Merges were always run in the working copy before, which means
# they used decoded data, if the user defined any repository # they used decoded data, if the user defined any repository
# filters. # filters.
# #
# Maintain that behavior today for BC, though perhaps in the future # Maintain that behavior today for BC, though perhaps in the future
# it'd be worth considering whether merging encoded data (what the # it'd be worth considering whether merging encoded data (what the
# repository usually sees) might be more useful. # repository usually sees) might be more useful.
return _verifytext(ctx.decodeddata(), ctx.path(), ui, opts) return _verifytext(ctx.decodeddata(), ctx.path(), ui, opts)
try: try:
localtext = readctx(localctx) localtext = readctx(local.fctx)
basetext = readctx(basectx) basetext = readctx(base.fctx)
othertext = readctx(otherctx) othertext = readctx(other.fctx)
except error.Abort: except error.Abort:
return True return True
m3 = Merge3Text(basetext, localtext, othertext) m3 = Merge3Text(basetext, localtext, othertext)
conflicts = False conflicts = False
mode = opts.get('mode', b'merge') mode = opts.get('mode', b'merge')
if mode == b'union': if mode == b'union':
lines = _resolve(m3, (1, 2)) lines = _resolve(m3, (1, 2))
elif mode == b'local': elif mode == b'local':
lines = _resolve(m3, (1,)) lines = _resolve(m3, (1,))
elif mode == b'other': elif mode == b'other':
lines = _resolve(m3, (2,)) lines = _resolve(m3, (2,))
else: else:
name_a, name_b, name_base = _picklabels(opts.get('label', []))
if mode == b'mergediff': if mode == b'mergediff':
lines, conflicts = render_mergediff(m3, name_a, name_b, name_base) labels = _format_labels(local, other, base)
lines, conflicts = render_mergediff(m3, *labels)
elif mode == b'merge3': elif mode == b'merge3':
lines, conflicts = render_merge3(m3, name_a, name_b, name_base) labels = _format_labels(local, other, base)
lines, conflicts = render_merge3(m3, *labels)
else: else:
lines, conflicts = render_minimized(m3, name_a, name_b) labels = _format_labels(local, other)
lines, conflicts = render_minimized(m3, *labels)
mergedtext = b''.join(lines) mergedtext = b''.join(lines)
if opts.get('print'): if opts.get('print'):
ui.fout.write(mergedtext) ui.fout.write(mergedtext)
else: else:
# localctx.flags() already has the merged flags (done in # local.fctx.flags() already has the merged flags (done in
AlphareUnsubmitted
Done

This is slightly out of date now

Alphare: This is slightly out of date now
# mergestate.resolve()) # mergestate.resolve())
localctx.write(mergedtext, localctx.flags()) local.fctx.write(mergedtext, local.fctx.flags())
return conflicts return conflicts