This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5000

templatefuncs: add truncate parameter to pad
ClosedPublic

Authored by mbthomas on Oct 12 2018, 11:52 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG9458dbfa7f33: templatefuncs: add truncate parameter to pad
Summary

Add a truncate option to pad that additionally truncates the text to the pad
width if it is wider.

Since color codes can cause a problem with this, when the text is truncated,
the color codes are also stripped. Users of the truncate option should label
the text outside the pad.

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

mbthomas created this revision.Oct 12 2018, 11:52 AM
mbthomas added a parent revision: D4999: absorb: prompt user to accept absorb changes by default.Oct 12 2018, 11:53 AM

This is necessary to recreate something like the original output for hg absorb using the template language. It also allows inclusion of the commit message in the rows of the absorb output, using a template spec like:

hg absorb -pn -T '{ifeq(linetype,"summary","\n{count} changesets affected",ifeq(linetype,"path","showing changes for {label("absorb.path",path)}","{label("absorb.node", pad(node, 7, truncate=true))} {label("yellow", pad(desc, 30, truncate=true))} {label("diff.{linetype}", "{diffchar}{inserted}{deleted}{hunk}")}"))}\n'
Closed by commit rHG9458dbfa7f33: templatefuncs: add truncate parameter to pad (authored by mbthomas). · Explain WhyOct 12 2018, 1:57 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 11941

mercurial/templatefuncs.py

repo = context.resource(mapping, 'repo') repo = context.resource(mapping, 'repo')
if 'mailmap' not in cache: if 'mailmap' not in cache:
data = repo.wvfs.tryread('.mailmap') data = repo.wvfs.tryread('.mailmap')
cache['mailmap'] = stringutil.parsemailmap(data) cache['mailmap'] = stringutil.parsemailmap(data)
return stringutil.mapname(cache['mailmap'], author) return stringutil.mapname(cache['mailmap'], author)
@templatefunc('pad(text, width[, fillchar=\' \'[, left=False]])', @templatefunc(
argspec='text width fillchar left') 'pad(text, width[, fillchar=\' \'[, left=False[, truncate=False]]])',
argspec='text width fillchar left truncate')
def pad(context, mapping, args): def pad(context, mapping, args):
"""Pad text with a """Pad text with a
fill character.""" fill character."""
if 'text' not in args or 'width' not in args: if 'text' not in args or 'width' not in args:
# i18n: "pad" is a keyword # i18n: "pad" is a keyword
raise error.ParseError(_("pad() expects two to four arguments")) raise error.ParseError(_("pad() expects two to four arguments"))
width = evalinteger(context, mapping, args['width'], width = evalinteger(context, mapping, args['width'],
# i18n: "pad" is a keyword # i18n: "pad" is a keyword
_("pad() expects an integer width")) _("pad() expects an integer width"))
text = evalstring(context, mapping, args['text']) text = evalstring(context, mapping, args['text'])
truncate = False
left = False left = False
fillchar = ' ' fillchar = ' '
if 'fillchar' in args: if 'fillchar' in args:
fillchar = evalstring(context, mapping, args['fillchar']) fillchar = evalstring(context, mapping, args['fillchar'])
if len(color.stripeffects(fillchar)) != 1: if len(color.stripeffects(fillchar)) != 1:
# i18n: "pad" is a keyword # i18n: "pad" is a keyword
raise error.ParseError(_("pad() expects a single fill character")) raise error.ParseError(_("pad() expects a single fill character"))
if 'left' in args: if 'left' in args:
left = evalboolean(context, mapping, args['left']) left = evalboolean(context, mapping, args['left'])
if 'truncate' in args:
truncate = evalboolean(context, mapping, args['truncate'])
fillwidth = width - encoding.colwidth(color.stripeffects(text)) fillwidth = width - encoding.colwidth(color.stripeffects(text))
if fillwidth < 0 and truncate:
return encoding.trim(color.stripeffects(text), width, leftside=left)
if fillwidth <= 0: if fillwidth <= 0:
return text return text
if left: if left:
return fillchar * fillwidth + text return fillchar * fillwidth + text
else: else:
return text + fillchar * fillwidth return text + fillchar * fillwidth
@templatefunc('indent(text, indentchars[, firstline])') @templatefunc('indent(text, indentchars[, firstline])')

tests/test-template-functions.t

\x1b[0;31mred\x1b[0;35mma\x1b[0;36mcyan\x1b[0m\x1b[0;31m\x1b[0;35m\x1b[0;33myellow\x1b[0m\x1b[0;31m\x1b[0;35mgenta\x1b[0m (esc) \x1b[0;31mred\x1b[0;35mma\x1b[0;36mcyan\x1b[0m\x1b[0;31m\x1b[0;35m\x1b[0;33myellow\x1b[0m\x1b[0;31m\x1b[0;35mgenta\x1b[0m (esc)
pad() should interact well with color codes (issue5416) pad() should interact well with color codes (issue5416)
$ hg debugtemplate --color=always \ $ hg debugtemplate --color=always \
> '{pad(label(red, "red"), 5, label(cyan, "-"))}\n' > '{pad(label(red, "red"), 5, label(cyan, "-"))}\n'
\x1b[0;31mred\x1b[0m\x1b[0;36m-\x1b[0m\x1b[0;36m-\x1b[0m (esc) \x1b[0;31mred\x1b[0m\x1b[0;36m-\x1b[0m\x1b[0;36m-\x1b[0m (esc)
pad() with truncate has to strip color codes, though
$ hg debugtemplate --color=always \
> '{pad(label(red, "scarlet"), 5, truncate=true)}\n'
scarl
label should be no-op if color is disabled: label should be no-op if color is disabled:
$ hg log --color=never -l 1 --template '{label(red, "text\n")}' $ hg log --color=never -l 1 --template '{label(red, "text\n")}'
text text
$ hg log --config extensions.color=! -l 1 --template '{label(red, "text\n")}' $ hg log --config extensions.color=! -l 1 --template '{label(red, "text\n")}'
text text
Test branches inside if statement: Test branches inside if statement:
1 {node|short} 1 {node|short}
0 test 0 test
$ hg log --template '{pad(rev, 20, "-", False)} {author|user}\n' $ hg log --template '{pad(rev, 20, "-", False)} {author|user}\n'
2------------------- test 2------------------- test
1------------------- {node|short} 1------------------- {node|short}
0------------------- test 0------------------- test
$ hg log --template '{pad(author, 5, "-", False, True)}\n'
test-
{node
test-
$ hg log --template '{pad(author, 5, "-", True, True)}\n'
-test
hort}
-test
Test template string in pad function Test template string in pad function
$ hg log -r 0 -T '{pad("\{{rev}}", 10)} {author|user}\n' $ hg log -r 0 -T '{pad("\{{rev}}", 10)} {author|user}\n'
{0} test {0} test
$ hg log -r 0 -T '{pad(r"\{rev}", 10)} {author|user}\n' $ hg log -r 0 -T '{pad(r"\{rev}", 10)} {author|user}\n'
\{rev} test \{rev} test