2006-02-28 02:07:25 +03:00
|
|
|
# templater.py - template expansion for output
|
|
|
|
#
|
|
|
|
# Copyright 2005, 2006 Matt Mackall <mpm@selenic.com>
|
|
|
|
#
|
2009-04-26 03:08:54 +04:00
|
|
|
# This software may be used and distributed according to the terms of the
|
2010-01-20 07:20:08 +03:00
|
|
|
# GNU General Public License version 2 or any later version.
|
2006-02-28 02:07:25 +03:00
|
|
|
|
2006-12-15 05:25:19 +03:00
|
|
|
from i18n import _
|
2014-09-28 18:57:06 +04:00
|
|
|
import os, re
|
template: add revset() template function
Adds a template function that executes a revset and returns the list of
revisions as the result. It has the signature 'revset(query [, args...])'. The
args are optional and are applied to the query string using the standard
python string.format(args) pattern. This allows things like:
'{revset("parents({0})", rev)}' to produce the parents of each individual
commit in the log output. If no args are specified, the revset result is
cached for the duration of the templater; so it's better to not use args if
performance is a concern.
By itself, revset() can be used to print commit parents, print the common
ancestor of a commit with the main branch, etc.
It can be used with the ifcontains() function to do things like
'{ifcontains(rev, revset('.'), label(...), ...)}' to color the working copy
parent, to color certain branches, to color draft commits, etc.
2014-02-12 09:04:12 +04:00
|
|
|
import util, config, templatefilters, templatekw, parser, error
|
2014-08-23 16:23:02 +04:00
|
|
|
import revset as revsetmod
|
2012-11-29 02:55:42 +04:00
|
|
|
import types
|
2013-02-10 01:51:21 +04:00
|
|
|
import minirst
|
2010-12-20 21:09:00 +03:00
|
|
|
|
|
|
|
# template parsing
|
|
|
|
|
|
|
|
elements = {
|
|
|
|
"(": (20, ("group", 1, ")"), ("func", 1, ")")),
|
|
|
|
",": (2, None, ("list", 2)),
|
|
|
|
"|": (5, None, ("|", 5)),
|
|
|
|
"%": (6, None, ("%", 6)),
|
|
|
|
")": (0, None, None),
|
|
|
|
"symbol": (0, ("symbol",), None),
|
|
|
|
"string": (0, ("string",), None),
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
"rawstring": (0, ("rawstring",), None),
|
2010-12-20 21:09:00 +03:00
|
|
|
"end": (0, None, None),
|
|
|
|
}
|
|
|
|
|
|
|
|
def tokenizer(data):
|
|
|
|
program, start, end = data
|
|
|
|
pos = start
|
|
|
|
while pos < end:
|
|
|
|
c = program[pos]
|
|
|
|
if c.isspace(): # skip inter-token whitespace
|
|
|
|
pass
|
|
|
|
elif c in "(,)%|": # handle simple operators
|
|
|
|
yield (c, None, pos)
|
|
|
|
elif (c in '"\'' or c == 'r' and
|
|
|
|
program[pos:pos + 2] in ("r'", 'r"')): # handle quoted strings
|
|
|
|
if c == 'r':
|
|
|
|
pos += 1
|
|
|
|
c = program[pos]
|
2012-09-25 00:24:27 +04:00
|
|
|
decode = False
|
2010-12-20 21:09:00 +03:00
|
|
|
else:
|
2012-09-25 00:24:27 +04:00
|
|
|
decode = True
|
2010-12-20 21:09:00 +03:00
|
|
|
pos += 1
|
|
|
|
s = pos
|
|
|
|
while pos < end: # find closing quote
|
|
|
|
d = program[pos]
|
2012-09-25 00:24:27 +04:00
|
|
|
if decode and d == '\\': # skip over escaped characters
|
2010-12-20 21:09:00 +03:00
|
|
|
pos += 2
|
|
|
|
continue
|
|
|
|
if d == c:
|
2012-09-25 00:24:27 +04:00
|
|
|
if not decode:
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
yield ('rawstring', program[s:pos], s)
|
2012-09-25 00:24:27 +04:00
|
|
|
break
|
2013-11-18 23:02:26 +04:00
|
|
|
yield ('string', program[s:pos], s)
|
2010-12-20 21:09:00 +03:00
|
|
|
break
|
|
|
|
pos += 1
|
|
|
|
else:
|
|
|
|
raise error.ParseError(_("unterminated string"), s)
|
|
|
|
elif c.isalnum() or c in '_':
|
|
|
|
s = pos
|
|
|
|
pos += 1
|
|
|
|
while pos < end: # find end of symbol
|
|
|
|
d = program[pos]
|
|
|
|
if not (d.isalnum() or d == "_"):
|
|
|
|
break
|
|
|
|
pos += 1
|
|
|
|
sym = program[s:pos]
|
2013-04-10 08:38:08 +04:00
|
|
|
yield ('symbol', sym, s)
|
2010-12-20 21:09:00 +03:00
|
|
|
pos -= 1
|
|
|
|
elif c == '}':
|
|
|
|
pos += 1
|
|
|
|
break
|
|
|
|
else:
|
|
|
|
raise error.ParseError(_("syntax error"), pos)
|
|
|
|
pos += 1
|
|
|
|
yield ('end', None, pos)
|
|
|
|
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
def compiletemplate(tmpl, context, strtoken="string"):
|
2010-12-20 21:09:00 +03:00
|
|
|
parsed = []
|
|
|
|
pos, stop = 0, len(tmpl)
|
|
|
|
p = parser.parser(tokenizer, elements)
|
|
|
|
while pos < stop:
|
|
|
|
n = tmpl.find('{', pos)
|
|
|
|
if n < 0:
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
parsed.append((strtoken, tmpl[pos:]))
|
2010-12-20 21:09:00 +03:00
|
|
|
break
|
|
|
|
if n > 0 and tmpl[n - 1] == '\\':
|
|
|
|
# escaped
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
parsed.append((strtoken, (tmpl[pos:n - 1] + "{")))
|
2010-12-20 21:09:00 +03:00
|
|
|
pos = n + 1
|
|
|
|
continue
|
|
|
|
if n > pos:
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
parsed.append((strtoken, tmpl[pos:n]))
|
2010-12-20 21:09:00 +03:00
|
|
|
|
|
|
|
pd = [tmpl, n + 1, stop]
|
2011-03-17 01:09:14 +03:00
|
|
|
parseres, pos = p.parse(pd)
|
|
|
|
parsed.append(parseres)
|
2010-12-20 21:09:00 +03:00
|
|
|
|
|
|
|
return [compileexp(e, context) for e in parsed]
|
|
|
|
|
|
|
|
def compileexp(exp, context):
|
|
|
|
t = exp[0]
|
|
|
|
if t in methods:
|
|
|
|
return methods[t](exp, context)
|
|
|
|
raise error.ParseError(_("unknown method '%s'") % t)
|
|
|
|
|
|
|
|
# template evaluation
|
|
|
|
|
|
|
|
def getsymbol(exp):
|
|
|
|
if exp[0] == 'symbol':
|
|
|
|
return exp[1]
|
2014-06-13 05:07:21 +04:00
|
|
|
raise error.ParseError(_("expected a symbol, got '%s'") % exp[0])
|
2010-12-20 21:09:00 +03:00
|
|
|
|
|
|
|
def getlist(x):
|
|
|
|
if not x:
|
|
|
|
return []
|
|
|
|
if x[0] == 'list':
|
|
|
|
return getlist(x[1]) + [x[2]]
|
|
|
|
return [x]
|
|
|
|
|
|
|
|
def getfilter(exp, context):
|
|
|
|
f = getsymbol(exp)
|
|
|
|
if f not in context._filters:
|
|
|
|
raise error.ParseError(_("unknown function '%s'") % f)
|
|
|
|
return context._filters[f]
|
|
|
|
|
|
|
|
def gettemplate(exp, context):
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
if exp[0] == 'string' or exp[0] == 'rawstring':
|
|
|
|
return compiletemplate(exp[1], context, strtoken=exp[0])
|
2010-12-20 21:09:00 +03:00
|
|
|
if exp[0] == 'symbol':
|
|
|
|
return context._load(exp[1])
|
|
|
|
raise error.ParseError(_("expected template specifier"))
|
|
|
|
|
|
|
|
def runstring(context, mapping, data):
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
return data.decode("string-escape")
|
|
|
|
|
|
|
|
def runrawstring(context, mapping, data):
|
2010-12-20 21:09:00 +03:00
|
|
|
return data
|
|
|
|
|
|
|
|
def runsymbol(context, mapping, key):
|
|
|
|
v = mapping.get(key)
|
|
|
|
if v is None:
|
2013-09-22 13:52:18 +04:00
|
|
|
v = context._defaults.get(key)
|
|
|
|
if v is None:
|
|
|
|
try:
|
|
|
|
v = context.process(key, mapping)
|
|
|
|
except TemplateNotFound:
|
|
|
|
v = ''
|
2014-06-23 17:24:56 +04:00
|
|
|
if callable(v):
|
2010-12-20 21:09:00 +03:00
|
|
|
return v(**mapping)
|
2012-11-29 02:55:42 +04:00
|
|
|
if isinstance(v, types.GeneratorType):
|
|
|
|
v = list(v)
|
2010-12-20 21:09:00 +03:00
|
|
|
return v
|
|
|
|
|
|
|
|
def buildfilter(exp, context):
|
|
|
|
func, data = compileexp(exp[1], context)
|
|
|
|
filt = getfilter(exp[2], context)
|
|
|
|
return (runfilter, (func, data, filt))
|
|
|
|
|
|
|
|
def runfilter(context, mapping, data):
|
|
|
|
func, data, filt = data
|
2012-08-18 02:12:01 +04:00
|
|
|
try:
|
|
|
|
return filt(func(context, mapping, data))
|
|
|
|
except (ValueError, AttributeError, TypeError):
|
|
|
|
if isinstance(data, tuple):
|
|
|
|
dt = data[1]
|
|
|
|
else:
|
|
|
|
dt = data
|
|
|
|
raise util.Abort(_("template filter '%s' is not compatible with "
|
|
|
|
"keyword '%s'") % (filt.func_name, dt))
|
2010-12-20 21:09:00 +03:00
|
|
|
|
|
|
|
def buildmap(exp, context):
|
|
|
|
func, data = compileexp(exp[1], context)
|
|
|
|
ctmpl = gettemplate(exp[2], context)
|
|
|
|
return (runmap, (func, data, ctmpl))
|
|
|
|
|
2012-09-22 22:02:33 +04:00
|
|
|
def runtemplate(context, mapping, template):
|
|
|
|
for func, data in template:
|
|
|
|
yield func(context, mapping, data)
|
|
|
|
|
2010-12-20 21:09:00 +03:00
|
|
|
def runmap(context, mapping, data):
|
|
|
|
func, data, ctmpl = data
|
|
|
|
d = func(context, mapping, data)
|
2014-06-23 17:24:56 +04:00
|
|
|
if callable(d):
|
2012-09-22 03:54:00 +04:00
|
|
|
d = d()
|
|
|
|
|
2010-12-20 21:09:00 +03:00
|
|
|
lm = mapping.copy()
|
|
|
|
|
|
|
|
for i in d:
|
|
|
|
if isinstance(i, dict):
|
|
|
|
lm.update(i)
|
2012-11-13 02:05:39 +04:00
|
|
|
lm['originalnode'] = mapping.get('node')
|
2012-09-22 22:02:33 +04:00
|
|
|
yield runtemplate(context, lm, ctmpl)
|
2010-12-20 21:09:00 +03:00
|
|
|
else:
|
|
|
|
# v is not an iterable of dicts, this happen when 'key'
|
|
|
|
# has been fully expanded already and format is useless.
|
|
|
|
# If so, return the expanded value.
|
|
|
|
yield i
|
|
|
|
|
|
|
|
def buildfunc(exp, context):
|
|
|
|
n = getsymbol(exp[1])
|
|
|
|
args = [compileexp(x, context) for x in getlist(exp[2])]
|
2011-07-23 23:33:35 +04:00
|
|
|
if n in funcs:
|
|
|
|
f = funcs[n]
|
|
|
|
return (f, args)
|
2010-12-20 21:09:00 +03:00
|
|
|
if n in context._filters:
|
|
|
|
if len(args) != 1:
|
|
|
|
raise error.ParseError(_("filter %s expects one argument") % n)
|
|
|
|
f = context._filters[n]
|
|
|
|
return (runfilter, (args[0][0], args[0][1], f))
|
2014-03-28 02:21:27 +04:00
|
|
|
raise error.ParseError(_("unknown function '%s'") % n)
|
2010-12-20 21:09:00 +03:00
|
|
|
|
2013-06-29 14:27:53 +04:00
|
|
|
def date(context, mapping, args):
|
|
|
|
if not (1 <= len(args) <= 2):
|
2014-10-31 20:43:08 +03:00
|
|
|
# i18n: "date" is a keyword
|
2013-06-29 14:27:53 +04:00
|
|
|
raise error.ParseError(_("date expects one or two arguments"))
|
|
|
|
|
|
|
|
date = args[0][0](context, mapping, args[0][1])
|
|
|
|
if len(args) == 2:
|
|
|
|
fmt = stringify(args[1][0](context, mapping, args[1][1]))
|
|
|
|
return util.datestr(date, fmt)
|
|
|
|
return util.datestr(date)
|
|
|
|
|
2014-08-28 17:45:36 +04:00
|
|
|
def diff(context, mapping, args):
|
|
|
|
if len(args) > 2:
|
|
|
|
# i18n: "diff" is a keyword
|
|
|
|
raise error.ParseError(_("diff expects one, two or no arguments"))
|
|
|
|
|
|
|
|
def getpatterns(i):
|
|
|
|
if i < len(args):
|
|
|
|
s = args[i][1].strip()
|
|
|
|
if s:
|
|
|
|
return [s]
|
|
|
|
return []
|
|
|
|
|
|
|
|
ctx = mapping['ctx']
|
|
|
|
chunks = ctx.diff(match=ctx.match([], getpatterns(0), getpatterns(1)))
|
|
|
|
|
|
|
|
return ''.join(chunks)
|
|
|
|
|
2013-06-29 14:27:53 +04:00
|
|
|
def fill(context, mapping, args):
|
|
|
|
if not (1 <= len(args) <= 4):
|
2014-10-31 20:43:08 +03:00
|
|
|
# i18n: "fill" is a keyword
|
2013-06-29 14:27:53 +04:00
|
|
|
raise error.ParseError(_("fill expects one to four arguments"))
|
|
|
|
|
|
|
|
text = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
width = 76
|
|
|
|
initindent = ''
|
|
|
|
hangindent = ''
|
|
|
|
if 2 <= len(args) <= 4:
|
|
|
|
try:
|
|
|
|
width = int(stringify(args[1][0](context, mapping, args[1][1])))
|
|
|
|
except ValueError:
|
2014-10-31 20:43:08 +03:00
|
|
|
# i18n: "fill" is a keyword
|
2013-06-29 14:27:53 +04:00
|
|
|
raise error.ParseError(_("fill expects an integer width"))
|
|
|
|
try:
|
2014-03-09 20:01:42 +04:00
|
|
|
initindent = stringify(_evalifliteral(args[2], context, mapping))
|
|
|
|
hangindent = stringify(_evalifliteral(args[3], context, mapping))
|
2013-06-29 14:27:53 +04:00
|
|
|
except IndexError:
|
|
|
|
pass
|
|
|
|
|
|
|
|
return templatefilters.fill(text, width, initindent, hangindent)
|
|
|
|
|
2014-01-17 12:16:48 +04:00
|
|
|
def pad(context, mapping, args):
|
|
|
|
"""usage: pad(text, width, fillchar=' ', right=False)
|
|
|
|
"""
|
|
|
|
if not (2 <= len(args) <= 4):
|
2014-10-31 20:43:08 +03:00
|
|
|
# i18n: "pad" is a keyword
|
2014-01-17 12:16:48 +04:00
|
|
|
raise error.ParseError(_("pad() expects two to four arguments"))
|
|
|
|
|
|
|
|
width = int(args[1][1])
|
|
|
|
|
|
|
|
text = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
if args[0][0] == runstring:
|
|
|
|
text = stringify(runtemplate(context, mapping,
|
|
|
|
compiletemplate(text, context)))
|
|
|
|
|
|
|
|
right = False
|
|
|
|
fillchar = ' '
|
|
|
|
if len(args) > 2:
|
|
|
|
fillchar = stringify(args[2][0](context, mapping, args[2][1]))
|
|
|
|
if len(args) > 3:
|
|
|
|
right = util.parsebool(args[3][1])
|
|
|
|
|
|
|
|
if right:
|
|
|
|
return text.rjust(width, fillchar)
|
|
|
|
else:
|
|
|
|
return text.ljust(width, fillchar)
|
|
|
|
|
2013-02-09 02:49:14 +04:00
|
|
|
def get(context, mapping, args):
|
|
|
|
if len(args) != 2:
|
|
|
|
# i18n: "get" is a keyword
|
|
|
|
raise error.ParseError(_("get() expects two arguments"))
|
|
|
|
|
|
|
|
dictarg = args[0][0](context, mapping, args[0][1])
|
|
|
|
if not util.safehasattr(dictarg, 'get'):
|
|
|
|
# i18n: "get" is a keyword
|
|
|
|
raise error.ParseError(_("get() expects a dict as first argument"))
|
|
|
|
|
|
|
|
key = args[1][0](context, mapping, args[1][1])
|
|
|
|
yield dictarg.get(key)
|
|
|
|
|
2013-11-19 00:37:09 +04:00
|
|
|
def _evalifliteral(arg, context, mapping):
|
|
|
|
t = stringify(arg[0](context, mapping, arg[1]))
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
if arg[0] == runstring or arg[0] == runrawstring:
|
|
|
|
yield runtemplate(context, mapping,
|
|
|
|
compiletemplate(t, context, strtoken='rawstring'))
|
2013-11-19 00:37:09 +04:00
|
|
|
else:
|
|
|
|
yield t
|
|
|
|
|
2012-09-25 00:26:56 +04:00
|
|
|
def if_(context, mapping, args):
|
|
|
|
if not (2 <= len(args) <= 3):
|
2012-10-30 22:59:27 +04:00
|
|
|
# i18n: "if" is a keyword
|
2012-09-25 00:26:56 +04:00
|
|
|
raise error.ParseError(_("if expects two or three arguments"))
|
|
|
|
|
|
|
|
test = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
if test:
|
2013-11-19 00:37:09 +04:00
|
|
|
yield _evalifliteral(args[1], context, mapping)
|
2012-09-25 00:26:56 +04:00
|
|
|
elif len(args) == 3:
|
2013-11-19 00:37:09 +04:00
|
|
|
yield _evalifliteral(args[2], context, mapping)
|
2012-09-25 00:26:56 +04:00
|
|
|
|
2014-02-12 09:10:00 +04:00
|
|
|
def ifcontains(context, mapping, args):
|
|
|
|
if not (3 <= len(args) <= 4):
|
|
|
|
# i18n: "ifcontains" is a keyword
|
|
|
|
raise error.ParseError(_("ifcontains expects three or four arguments"))
|
|
|
|
|
|
|
|
item = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
items = args[1][0](context, mapping, args[1][1])
|
|
|
|
|
2014-05-24 03:25:55 +04:00
|
|
|
# Iterating over items gives a formatted string, so we iterate
|
|
|
|
# directly over the raw values.
|
2014-10-10 20:38:00 +04:00
|
|
|
if ((callable(items) and item in [i.values()[0] for i in items()]) or
|
|
|
|
(isinstance(items, str) and item in items)):
|
2014-02-12 09:10:00 +04:00
|
|
|
yield _evalifliteral(args[2], context, mapping)
|
|
|
|
elif len(args) == 4:
|
|
|
|
yield _evalifliteral(args[3], context, mapping)
|
|
|
|
|
2012-09-25 00:26:56 +04:00
|
|
|
def ifeq(context, mapping, args):
|
|
|
|
if not (3 <= len(args) <= 4):
|
2012-10-30 22:59:27 +04:00
|
|
|
# i18n: "ifeq" is a keyword
|
2012-09-25 00:26:56 +04:00
|
|
|
raise error.ParseError(_("ifeq expects three or four arguments"))
|
|
|
|
|
|
|
|
test = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
match = stringify(args[1][0](context, mapping, args[1][1]))
|
|
|
|
if test == match:
|
2013-11-19 00:37:09 +04:00
|
|
|
yield _evalifliteral(args[2], context, mapping)
|
2012-09-25 00:26:56 +04:00
|
|
|
elif len(args) == 4:
|
2013-11-19 00:37:09 +04:00
|
|
|
yield _evalifliteral(args[3], context, mapping)
|
2012-09-25 00:26:56 +04:00
|
|
|
|
2013-06-29 14:27:53 +04:00
|
|
|
def join(context, mapping, args):
|
|
|
|
if not (1 <= len(args) <= 2):
|
|
|
|
# i18n: "join" is a keyword
|
|
|
|
raise error.ParseError(_("join expects one or two arguments"))
|
|
|
|
|
|
|
|
joinset = args[0][0](context, mapping, args[0][1])
|
2014-06-23 17:24:56 +04:00
|
|
|
if callable(joinset):
|
2013-06-29 14:27:53 +04:00
|
|
|
jf = joinset.joinfmt
|
|
|
|
joinset = [jf(x) for x in joinset()]
|
|
|
|
|
|
|
|
joiner = " "
|
|
|
|
if len(args) > 1:
|
2014-03-09 20:01:43 +04:00
|
|
|
joiner = stringify(args[1][0](context, mapping, args[1][1]))
|
2013-06-29 14:27:53 +04:00
|
|
|
|
|
|
|
first = True
|
|
|
|
for x in joinset:
|
|
|
|
if first:
|
|
|
|
first = False
|
|
|
|
else:
|
|
|
|
yield joiner
|
|
|
|
yield x
|
|
|
|
|
2012-12-23 07:46:26 +04:00
|
|
|
def label(context, mapping, args):
|
|
|
|
if len(args) != 2:
|
|
|
|
# i18n: "label" is a keyword
|
|
|
|
raise error.ParseError(_("label expects two arguments"))
|
|
|
|
|
|
|
|
# ignore args[0] (the label string) since this is supposed to be a a no-op
|
2013-11-19 00:37:09 +04:00
|
|
|
yield _evalifliteral(args[1], context, mapping)
|
2012-12-23 07:46:26 +04:00
|
|
|
|
template: add revset() template function
Adds a template function that executes a revset and returns the list of
revisions as the result. It has the signature 'revset(query [, args...])'. The
args are optional and are applied to the query string using the standard
python string.format(args) pattern. This allows things like:
'{revset("parents({0})", rev)}' to produce the parents of each individual
commit in the log output. If no args are specified, the revset result is
cached for the duration of the templater; so it's better to not use args if
performance is a concern.
By itself, revset() can be used to print commit parents, print the common
ancestor of a commit with the main branch, etc.
It can be used with the ifcontains() function to do things like
'{ifcontains(rev, revset('.'), label(...), ...)}' to color the working copy
parent, to color certain branches, to color draft commits, etc.
2014-02-12 09:04:12 +04:00
|
|
|
def revset(context, mapping, args):
|
|
|
|
"""usage: revset(query[, formatargs...])
|
|
|
|
"""
|
|
|
|
if not len(args) > 0:
|
|
|
|
# i18n: "revset" is a keyword
|
|
|
|
raise error.ParseError(_("revset expects one or more arguments"))
|
|
|
|
|
|
|
|
raw = args[0][1]
|
|
|
|
ctx = mapping['ctx']
|
|
|
|
repo = ctx._repo
|
|
|
|
|
2014-08-23 16:23:02 +04:00
|
|
|
def query(expr):
|
|
|
|
m = revsetmod.match(repo.ui, expr)
|
2015-02-02 16:21:07 +03:00
|
|
|
return m(repo)
|
2014-08-23 16:23:02 +04:00
|
|
|
|
template: add revset() template function
Adds a template function that executes a revset and returns the list of
revisions as the result. It has the signature 'revset(query [, args...])'. The
args are optional and are applied to the query string using the standard
python string.format(args) pattern. This allows things like:
'{revset("parents({0})", rev)}' to produce the parents of each individual
commit in the log output. If no args are specified, the revset result is
cached for the duration of the templater; so it's better to not use args if
performance is a concern.
By itself, revset() can be used to print commit parents, print the common
ancestor of a commit with the main branch, etc.
It can be used with the ifcontains() function to do things like
'{ifcontains(rev, revset('.'), label(...), ...)}' to color the working copy
parent, to color certain branches, to color draft commits, etc.
2014-02-12 09:04:12 +04:00
|
|
|
if len(args) > 1:
|
|
|
|
formatargs = list([a[0](context, mapping, a[1]) for a in args[1:]])
|
2014-08-23 16:23:02 +04:00
|
|
|
revs = query(revsetmod.formatspec(raw, *formatargs))
|
template: add revset() template function
Adds a template function that executes a revset and returns the list of
revisions as the result. It has the signature 'revset(query [, args...])'. The
args are optional and are applied to the query string using the standard
python string.format(args) pattern. This allows things like:
'{revset("parents({0})", rev)}' to produce the parents of each individual
commit in the log output. If no args are specified, the revset result is
cached for the duration of the templater; so it's better to not use args if
performance is a concern.
By itself, revset() can be used to print commit parents, print the common
ancestor of a commit with the main branch, etc.
It can be used with the ifcontains() function to do things like
'{ifcontains(rev, revset('.'), label(...), ...)}' to color the working copy
parent, to color certain branches, to color draft commits, etc.
2014-02-12 09:04:12 +04:00
|
|
|
revs = list([str(r) for r in revs])
|
|
|
|
else:
|
|
|
|
revsetcache = mapping['cache'].setdefault("revsetcache", {})
|
|
|
|
if raw in revsetcache:
|
|
|
|
revs = revsetcache[raw]
|
|
|
|
else:
|
2014-08-23 16:23:02 +04:00
|
|
|
revs = query(raw)
|
template: add revset() template function
Adds a template function that executes a revset and returns the list of
revisions as the result. It has the signature 'revset(query [, args...])'. The
args are optional and are applied to the query string using the standard
python string.format(args) pattern. This allows things like:
'{revset("parents({0})", rev)}' to produce the parents of each individual
commit in the log output. If no args are specified, the revset result is
cached for the duration of the templater; so it's better to not use args if
performance is a concern.
By itself, revset() can be used to print commit parents, print the common
ancestor of a commit with the main branch, etc.
It can be used with the ifcontains() function to do things like
'{ifcontains(rev, revset('.'), label(...), ...)}' to color the working copy
parent, to color certain branches, to color draft commits, etc.
2014-02-12 09:04:12 +04:00
|
|
|
revs = list([str(r) for r in revs])
|
|
|
|
revsetcache[raw] = revs
|
|
|
|
|
|
|
|
return templatekw.showlist("revision", revs, **mapping)
|
|
|
|
|
2013-02-10 01:51:21 +04:00
|
|
|
def rstdoc(context, mapping, args):
|
|
|
|
if len(args) != 2:
|
|
|
|
# i18n: "rstdoc" is a keyword
|
|
|
|
raise error.ParseError(_("rstdoc expects two arguments"))
|
|
|
|
|
|
|
|
text = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
style = stringify(args[1][0](context, mapping, args[1][1]))
|
|
|
|
|
2013-04-22 12:27:56 +04:00
|
|
|
return minirst.format(text, style=style, keep=['verbose'])
|
2013-02-10 01:51:21 +04:00
|
|
|
|
2014-01-17 12:10:37 +04:00
|
|
|
def shortest(context, mapping, args):
|
|
|
|
"""usage: shortest(node, minlength=4)
|
|
|
|
"""
|
|
|
|
if not (1 <= len(args) <= 2):
|
2014-10-31 20:43:08 +03:00
|
|
|
# i18n: "shortest" is a keyword
|
2014-01-17 12:10:37 +04:00
|
|
|
raise error.ParseError(_("shortest() expects one or two arguments"))
|
|
|
|
|
|
|
|
node = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
|
|
|
|
minlength = 4
|
|
|
|
if len(args) > 1:
|
|
|
|
minlength = int(args[1][1])
|
|
|
|
|
|
|
|
cl = mapping['ctx']._repo.changelog
|
|
|
|
def isvalid(test):
|
|
|
|
try:
|
2014-02-06 08:22:28 +04:00
|
|
|
try:
|
|
|
|
cl.index.partialmatch(test)
|
|
|
|
except AttributeError:
|
|
|
|
# Pure mercurial doesn't support partialmatch on the index.
|
|
|
|
# Fallback to the slow way.
|
|
|
|
if cl._partialmatch(test) is None:
|
|
|
|
return False
|
|
|
|
|
2014-01-17 12:10:37 +04:00
|
|
|
try:
|
2014-02-20 10:46:13 +04:00
|
|
|
i = int(test)
|
|
|
|
# if we are a pure int, then starting with zero will not be
|
|
|
|
# confused as a rev; or, obviously, if the int is larger than
|
|
|
|
# the value of the tip rev
|
|
|
|
if test[0] == '0' or i > len(cl):
|
|
|
|
return True
|
2014-01-17 12:10:37 +04:00
|
|
|
return False
|
|
|
|
except ValueError:
|
|
|
|
return True
|
|
|
|
except error.RevlogError:
|
|
|
|
return False
|
|
|
|
|
|
|
|
shortest = node
|
|
|
|
startlength = max(6, minlength)
|
|
|
|
length = startlength
|
|
|
|
while True:
|
|
|
|
test = node[:length]
|
|
|
|
if isvalid(test):
|
|
|
|
shortest = test
|
|
|
|
if length == minlength or length > startlength:
|
|
|
|
return shortest
|
|
|
|
length -= 1
|
|
|
|
else:
|
|
|
|
length += 1
|
|
|
|
if len(shortest) <= length:
|
|
|
|
return shortest
|
|
|
|
|
2013-06-25 21:02:22 +04:00
|
|
|
def strip(context, mapping, args):
|
|
|
|
if not (1 <= len(args) <= 2):
|
2014-10-31 20:43:08 +03:00
|
|
|
# i18n: "strip" is a keyword
|
2013-06-25 21:02:22 +04:00
|
|
|
raise error.ParseError(_("strip expects one or two arguments"))
|
|
|
|
|
2014-03-09 20:01:43 +04:00
|
|
|
text = stringify(args[0][0](context, mapping, args[0][1]))
|
2013-06-25 21:02:22 +04:00
|
|
|
if len(args) == 2:
|
2014-03-09 20:01:43 +04:00
|
|
|
chars = stringify(args[1][0](context, mapping, args[1][1]))
|
2013-06-25 21:02:22 +04:00
|
|
|
return text.strip(chars)
|
|
|
|
return text.strip()
|
|
|
|
|
2013-06-29 14:27:53 +04:00
|
|
|
def sub(context, mapping, args):
|
|
|
|
if len(args) != 3:
|
|
|
|
# i18n: "sub" is a keyword
|
|
|
|
raise error.ParseError(_("sub expects three arguments"))
|
|
|
|
|
|
|
|
pat = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
rpl = stringify(args[1][0](context, mapping, args[1][1]))
|
2014-03-09 20:01:42 +04:00
|
|
|
src = stringify(_evalifliteral(args[2], context, mapping))
|
2013-06-29 14:27:53 +04:00
|
|
|
yield re.sub(pat, rpl, src)
|
|
|
|
|
2014-06-13 04:53:37 +04:00
|
|
|
def startswith(context, mapping, args):
|
|
|
|
if len(args) != 2:
|
2014-07-31 21:14:24 +04:00
|
|
|
# i18n: "startswith" is a keyword
|
2014-06-13 04:53:37 +04:00
|
|
|
raise error.ParseError(_("startswith expects two arguments"))
|
|
|
|
|
|
|
|
patn = stringify(args[0][0](context, mapping, args[0][1]))
|
|
|
|
text = stringify(args[1][0](context, mapping, args[1][1]))
|
|
|
|
if text.startswith(patn):
|
|
|
|
return text
|
|
|
|
return ''
|
|
|
|
|
|
|
|
|
2014-06-13 05:02:23 +04:00
|
|
|
def word(context, mapping, args):
|
|
|
|
"""return nth word from a string"""
|
|
|
|
if not (2 <= len(args) <= 3):
|
2014-07-31 21:14:24 +04:00
|
|
|
# i18n: "word" is a keyword
|
2014-06-13 05:02:23 +04:00
|
|
|
raise error.ParseError(_("word expects two or three arguments, got %d")
|
|
|
|
% len(args))
|
|
|
|
|
|
|
|
num = int(stringify(args[0][0](context, mapping, args[0][1])))
|
|
|
|
text = stringify(args[1][0](context, mapping, args[1][1]))
|
|
|
|
if len(args) == 3:
|
|
|
|
splitter = stringify(args[2][0](context, mapping, args[2][1]))
|
|
|
|
else:
|
|
|
|
splitter = None
|
|
|
|
|
|
|
|
tokens = text.split(splitter)
|
|
|
|
if num >= len(tokens):
|
|
|
|
return ''
|
|
|
|
else:
|
|
|
|
return tokens[num]
|
|
|
|
|
2010-12-20 21:09:00 +03:00
|
|
|
methods = {
|
|
|
|
"string": lambda e, c: (runstring, e[1]),
|
templater: make strings in template expressions be "string-escape"-ed correctly
Changeset 83ff877959a6 (released with 2.8.1) fixed "recursively
evaluate string literals as templates" problem (issue4102) by moving
the location of "string-escape"-ing from "tokenizer()" to
"compiletemplate()".
But some parts in template expressions below are not processed by
"compiletemplate()", and it may cause unexpected result.
- 'expr' of 'if(expr, then, else)'
- 'expr's of 'ifeq(expr, expr, then, else)'
- 'sep' of 'join(list, sep)'
- 'text' and 'style' of 'rstdoc(text, style)'
- 'text' and 'chars' of 'strip(text, chars)'
- 'pat' and 'repl' of 'sub(pat, repl, expr)'
For example, '\n' of "{join(extras, '\n')}" is not "string-escape"-ed
and treated as a literal '\n'. This breaks "Display the contents of
the 'extra' field, one per line" example in "hg help templates".
Just "string-escape"-ing on each parts above may not work correctly,
because inside expression of nested ones already applies
"string-escape" on string literals. For example:
- "{join(files, '\n')}" doesn't return "string-escape"-ed string, but
- "{join(files, if(branch, '\n', '\n'))}" does
To fix this problem, this patch does:
- introduce "rawstring" token and "runrawstring" method to handle
strings not to be "string-escape"-ed correctly, and
- make "runstring" method return "string-escape"-ed string, and
delay "string-escape"-ing until evaluation
This patch invokes "compiletemplate()" with "strtoken=exp[0]" in
"gettemplate()", because "exp[1]" is not yet evaluated. This code path
is tested via mapping ("expr % '{template}'").
In the other hand, this patch invokes it with "strtoken='rawstring'"
in "_evalifliteral()", because "t" is the result of "arg" evaluation
and it should be "string-escape"-ed if "arg" is "string" expression.
This patch doesn't test "string-escape"-ing on 'expr' of 'if(expr,
then, else)', because it doesn't affect the result.
2014-03-09 20:01:43 +04:00
|
|
|
"rawstring": lambda e, c: (runrawstring, e[1]),
|
2010-12-20 21:09:00 +03:00
|
|
|
"symbol": lambda e, c: (runsymbol, e[1]),
|
|
|
|
"group": lambda e, c: compileexp(e[1], c),
|
|
|
|
# ".": buildmember,
|
|
|
|
"|": buildfilter,
|
|
|
|
"%": buildmap,
|
|
|
|
"func": buildfunc,
|
|
|
|
}
|
|
|
|
|
2011-07-23 23:33:35 +04:00
|
|
|
funcs = {
|
2013-06-29 14:27:53 +04:00
|
|
|
"date": date,
|
2014-08-28 17:45:36 +04:00
|
|
|
"diff": diff,
|
2013-06-29 14:27:53 +04:00
|
|
|
"fill": fill,
|
2013-02-09 02:49:14 +04:00
|
|
|
"get": get,
|
2012-09-25 00:26:56 +04:00
|
|
|
"if": if_,
|
2014-02-12 09:10:00 +04:00
|
|
|
"ifcontains": ifcontains,
|
2012-09-25 00:26:56 +04:00
|
|
|
"ifeq": ifeq,
|
2012-09-22 22:04:36 +04:00
|
|
|
"join": join,
|
2012-12-23 07:46:26 +04:00
|
|
|
"label": label,
|
2014-01-17 12:16:48 +04:00
|
|
|
"pad": pad,
|
template: add revset() template function
Adds a template function that executes a revset and returns the list of
revisions as the result. It has the signature 'revset(query [, args...])'. The
args are optional and are applied to the query string using the standard
python string.format(args) pattern. This allows things like:
'{revset("parents({0})", rev)}' to produce the parents of each individual
commit in the log output. If no args are specified, the revset result is
cached for the duration of the templater; so it's better to not use args if
performance is a concern.
By itself, revset() can be used to print commit parents, print the common
ancestor of a commit with the main branch, etc.
It can be used with the ifcontains() function to do things like
'{ifcontains(rev, revset('.'), label(...), ...)}' to color the working copy
parent, to color certain branches, to color draft commits, etc.
2014-02-12 09:04:12 +04:00
|
|
|
"revset": revset,
|
2013-02-10 01:51:21 +04:00
|
|
|
"rstdoc": rstdoc,
|
2014-01-17 12:10:37 +04:00
|
|
|
"shortest": shortest,
|
2014-06-13 04:53:37 +04:00
|
|
|
"startswith": startswith,
|
2013-06-25 21:02:22 +04:00
|
|
|
"strip": strip,
|
2013-06-29 14:27:53 +04:00
|
|
|
"sub": sub,
|
2014-06-13 05:02:23 +04:00
|
|
|
"word": word,
|
2011-07-23 23:33:35 +04:00
|
|
|
}
|
|
|
|
|
2010-12-20 21:09:00 +03:00
|
|
|
# template engine
|
2006-02-27 20:35:43 +03:00
|
|
|
|
2009-05-12 14:04:05 +04:00
|
|
|
stringify = templatefilters.stringify
|
2008-10-17 22:34:31 +04:00
|
|
|
|
2010-04-06 00:25:08 +04:00
|
|
|
def _flatten(thing):
|
|
|
|
'''yield a single stream from a possibly nested set of iterators'''
|
|
|
|
if isinstance(thing, str):
|
|
|
|
yield thing
|
2011-07-26 00:30:19 +04:00
|
|
|
elif not util.safehasattr(thing, '__iter__'):
|
2010-06-08 11:30:45 +04:00
|
|
|
if thing is not None:
|
2010-04-06 00:25:08 +04:00
|
|
|
yield str(thing)
|
|
|
|
else:
|
2010-04-06 00:25:08 +04:00
|
|
|
for i in thing:
|
|
|
|
if isinstance(i, str):
|
|
|
|
yield i
|
2011-07-26 00:30:19 +04:00
|
|
|
elif not util.safehasattr(i, '__iter__'):
|
2010-04-06 00:25:08 +04:00
|
|
|
if i is not None:
|
|
|
|
yield str(i)
|
2010-04-06 00:25:08 +04:00
|
|
|
elif i is not None:
|
|
|
|
for j in _flatten(i):
|
|
|
|
yield j
|
|
|
|
|
2006-02-27 22:18:56 +03:00
|
|
|
def parsestring(s, quoted=True):
|
2006-02-28 02:07:25 +03:00
|
|
|
'''parse a string using simple c-like syntax.
|
|
|
|
string must be in quotes if quoted is True.'''
|
2006-02-27 22:18:56 +03:00
|
|
|
if quoted:
|
2006-11-13 22:26:57 +03:00
|
|
|
if len(s) < 2 or s[0] != s[-1]:
|
|
|
|
raise SyntaxError(_('unmatched quotes'))
|
|
|
|
return s[1:-1].decode('string_escape')
|
2006-11-13 22:26:57 +03:00
|
|
|
|
|
|
|
return s.decode('string_escape')
|
2006-02-26 23:59:28 +03:00
|
|
|
|
2009-04-06 17:09:54 +04:00
|
|
|
class engine(object):
|
2006-02-28 02:07:25 +03:00
|
|
|
'''template expansion engine.
|
|
|
|
|
|
|
|
template expansion works like this. a map file contains key=value
|
|
|
|
pairs. if value is quoted, it is treated as string. otherwise, it
|
|
|
|
is treated as name of template file.
|
|
|
|
|
|
|
|
templater is asked to expand a key in map. it looks up key, and
|
2007-04-10 21:24:28 +04:00
|
|
|
looks for strings like this: {foo}. it expands {foo} by looking up
|
2006-02-28 02:07:25 +03:00
|
|
|
foo in map, and substituting it. expansion is recursive: it stops
|
|
|
|
when there is no more {foo} to replace.
|
|
|
|
|
|
|
|
expansion also allows formatting and filtering.
|
|
|
|
|
|
|
|
format uses key to expand each item in list. syntax is
|
|
|
|
{key%format}.
|
|
|
|
|
|
|
|
filter uses function to transform value. syntax is
|
|
|
|
{key|filter1|filter2|...}.'''
|
|
|
|
|
2009-04-06 17:09:54 +04:00
|
|
|
def __init__(self, loader, filters={}, defaults={}):
|
2010-04-06 00:25:08 +04:00
|
|
|
self._loader = loader
|
|
|
|
self._filters = filters
|
|
|
|
self._defaults = defaults
|
|
|
|
self._cache = {}
|
2009-04-06 17:09:54 +04:00
|
|
|
|
2010-04-06 00:25:08 +04:00
|
|
|
def _load(self, t):
|
|
|
|
'''load, parse, and cache a template'''
|
|
|
|
if t not in self._cache:
|
2010-12-20 21:09:00 +03:00
|
|
|
self._cache[t] = compiletemplate(self._loader(t), self)
|
2010-04-06 00:25:08 +04:00
|
|
|
return self._cache[t]
|
|
|
|
|
2010-12-20 21:09:00 +03:00
|
|
|
def process(self, t, mapping):
|
|
|
|
'''Perform expansion. t is name of map element to expand.
|
|
|
|
mapping contains added elements for use during expansion. Is a
|
|
|
|
generator.'''
|
2012-09-22 22:02:33 +04:00
|
|
|
return _flatten(runtemplate(self, mapping, self._load(t)))
|
2009-04-06 17:09:54 +04:00
|
|
|
|
2009-05-12 14:05:19 +04:00
|
|
|
engines = {'default': engine}
|
|
|
|
|
2013-05-03 05:23:14 +04:00
|
|
|
def stylelist():
|
2014-09-28 18:57:37 +04:00
|
|
|
paths = templatepaths()
|
2014-01-23 04:29:50 +04:00
|
|
|
if not paths:
|
|
|
|
return _('no templates found, try `hg debuginstall` for more info')
|
|
|
|
dirlist = os.listdir(paths[0])
|
2013-05-03 05:23:14 +04:00
|
|
|
stylelist = []
|
|
|
|
for file in dirlist:
|
|
|
|
split = file.split(".")
|
|
|
|
if split[0] == "map-cmdline":
|
|
|
|
stylelist.append(split[1])
|
2013-05-03 05:41:22 +04:00
|
|
|
return ", ".join(sorted(stylelist))
|
2013-05-03 05:23:14 +04:00
|
|
|
|
2013-09-22 13:52:18 +04:00
|
|
|
class TemplateNotFound(util.Abort):
|
|
|
|
pass
|
|
|
|
|
2009-04-06 17:09:54 +04:00
|
|
|
class templater(object):
|
|
|
|
|
2008-11-22 02:51:40 +03:00
|
|
|
def __init__(self, mapfile, filters={}, defaults={}, cache={},
|
|
|
|
minchunk=1024, maxchunk=65536):
|
2006-02-28 02:07:25 +03:00
|
|
|
'''set up template engine.
|
|
|
|
mapfile is name of file to read map definitions from.
|
|
|
|
filters is dict of functions. each transforms a value into another.
|
|
|
|
defaults is dict of default map definitions.'''
|
2006-02-27 23:41:20 +03:00
|
|
|
self.mapfile = mapfile or 'template'
|
2006-03-18 20:51:25 +03:00
|
|
|
self.cache = cache.copy()
|
2006-02-26 23:59:28 +03:00
|
|
|
self.map = {}
|
2006-02-27 23:41:20 +03:00
|
|
|
self.base = (mapfile and os.path.dirname(mapfile)) or ''
|
2009-05-12 14:04:05 +04:00
|
|
|
self.filters = templatefilters.filters.copy()
|
|
|
|
self.filters.update(filters)
|
2006-03-15 22:28:00 +03:00
|
|
|
self.defaults = defaults
|
2008-11-22 02:51:40 +03:00
|
|
|
self.minchunk, self.maxchunk = minchunk, maxchunk
|
2010-12-22 22:16:03 +03:00
|
|
|
self.ecache = {}
|
2006-02-26 23:59:28 +03:00
|
|
|
|
2006-02-27 23:41:20 +03:00
|
|
|
if not mapfile:
|
|
|
|
return
|
2008-03-21 14:05:01 +03:00
|
|
|
if not os.path.exists(mapfile):
|
2013-05-03 05:23:14 +04:00
|
|
|
raise util.Abort(_("style '%s' not found") % mapfile,
|
|
|
|
hint=_("available styles: %s") % stylelist())
|
2008-03-21 14:05:01 +03:00
|
|
|
|
2009-04-27 01:50:43 +04:00
|
|
|
conf = config.config()
|
|
|
|
conf.read(mapfile)
|
|
|
|
|
|
|
|
for key, val in conf[''].items():
|
2012-08-04 16:37:17 +04:00
|
|
|
if not val:
|
|
|
|
raise SyntaxError(_('%s: missing value') % conf.source('', key))
|
2009-04-27 01:50:43 +04:00
|
|
|
if val[0] in "'\"":
|
|
|
|
try:
|
|
|
|
self.cache[key] = parsestring(val)
|
|
|
|
except SyntaxError, inst:
|
|
|
|
raise SyntaxError('%s: %s' %
|
2009-04-27 01:50:43 +04:00
|
|
|
(conf.source('', key), inst.args[0]))
|
2006-02-27 23:41:20 +03:00
|
|
|
else:
|
2009-05-12 14:05:19 +04:00
|
|
|
val = 'default', val
|
|
|
|
if ':' in val[1]:
|
|
|
|
val = val[1].split(':', 1)
|
|
|
|
self.map[key] = val[0], os.path.join(self.base, val[1])
|
2006-02-26 23:59:28 +03:00
|
|
|
|
2006-02-27 07:53:37 +03:00
|
|
|
def __contains__(self, key):
|
2006-11-13 22:26:57 +03:00
|
|
|
return key in self.cache or key in self.map
|
2006-02-27 07:53:37 +03:00
|
|
|
|
2009-04-06 17:09:54 +04:00
|
|
|
def load(self, t):
|
2008-06-29 15:16:25 +04:00
|
|
|
'''Get the template for the given template name. Use a local cache.'''
|
2012-05-12 18:00:57 +04:00
|
|
|
if t not in self.cache:
|
2006-02-27 23:41:20 +03:00
|
|
|
try:
|
2011-05-02 12:11:18 +04:00
|
|
|
self.cache[t] = util.readfile(self.map[t][1])
|
2010-12-20 21:09:00 +03:00
|
|
|
except KeyError, inst:
|
2013-09-22 13:52:18 +04:00
|
|
|
raise TemplateNotFound(_('"%s" not in template map') %
|
|
|
|
inst.args[0])
|
2006-02-27 23:41:20 +03:00
|
|
|
except IOError, inst:
|
|
|
|
raise IOError(inst.args[0], _('template file %s: %s') %
|
2009-05-12 14:05:19 +04:00
|
|
|
(self.map[t][1], inst.args[1]))
|
2008-06-29 15:16:25 +04:00
|
|
|
return self.cache[t]
|
2006-02-27 20:15:59 +03:00
|
|
|
|
2010-04-06 00:25:08 +04:00
|
|
|
def __call__(self, t, **mapping):
|
2009-05-12 14:05:19 +04:00
|
|
|
ttype = t in self.map and self.map[t][0] or 'default'
|
2010-12-22 22:16:03 +03:00
|
|
|
if ttype not in self.ecache:
|
|
|
|
self.ecache[ttype] = engines[ttype](self.load,
|
|
|
|
self.filters, self.defaults)
|
|
|
|
proc = self.ecache[ttype]
|
2009-05-12 14:05:19 +04:00
|
|
|
|
2010-04-06 00:25:08 +04:00
|
|
|
stream = proc.process(t, mapping)
|
2008-11-22 02:51:40 +03:00
|
|
|
if self.minchunk:
|
|
|
|
stream = util.increasingchunks(stream, min=self.minchunk,
|
|
|
|
max=self.maxchunk)
|
|
|
|
return stream
|
2008-11-27 18:07:13 +03:00
|
|
|
|
2014-09-28 18:57:37 +04:00
|
|
|
def templatepaths():
|
|
|
|
'''return locations used for template files.'''
|
2014-09-28 18:57:37 +04:00
|
|
|
pathsrel = ['templates']
|
2014-09-28 18:57:37 +04:00
|
|
|
paths = [os.path.normpath(os.path.join(util.datapath, f))
|
|
|
|
for f in pathsrel]
|
|
|
|
return [p for p in paths if os.path.isdir(p)]
|
2006-05-03 21:25:28 +04:00
|
|
|
|
2014-09-28 18:57:37 +04:00
|
|
|
def templatepath(name):
|
|
|
|
'''return location of template file. returns None if not found.'''
|
|
|
|
for p in templatepaths():
|
|
|
|
f = os.path.join(p, name)
|
|
|
|
if os.path.exists(f):
|
|
|
|
return f
|
|
|
|
return None
|
|
|
|
|
2009-11-12 18:39:11 +03:00
|
|
|
def stylemap(styles, paths=None):
|
2009-04-04 19:46:11 +04:00
|
|
|
"""Return path to mapfile for a given style.
|
|
|
|
|
|
|
|
Searches mapfile in the following locations:
|
|
|
|
1. templatepath/style/map
|
|
|
|
2. templatepath/map-style
|
|
|
|
3. templatepath/map
|
|
|
|
"""
|
|
|
|
|
|
|
|
if paths is None:
|
2014-09-28 18:57:37 +04:00
|
|
|
paths = templatepaths()
|
2009-04-04 19:46:11 +04:00
|
|
|
elif isinstance(paths, str):
|
2009-04-27 18:26:31 +04:00
|
|
|
paths = [paths]
|
2009-04-04 19:46:11 +04:00
|
|
|
|
2009-11-12 18:39:11 +03:00
|
|
|
if isinstance(styles, str):
|
|
|
|
styles = [styles]
|
|
|
|
|
|
|
|
for style in styles:
|
|
|
|
if not style:
|
|
|
|
continue
|
|
|
|
locations = [os.path.join(style, 'map'), 'map-' + style]
|
|
|
|
locations.append('map')
|
|
|
|
|
|
|
|
for path in paths:
|
|
|
|
for location in locations:
|
|
|
|
mapfile = os.path.join(path, location)
|
|
|
|
if os.path.isfile(mapfile):
|
|
|
|
return style, mapfile
|
2009-04-04 19:46:11 +04:00
|
|
|
|
|
|
|
raise RuntimeError("No hgweb templates found in %r" % paths)
|