# templater.py - template expansion for output

#

# Copyright 2005, 2006 Olivia Mackall <olivia@selenic.com>

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

"""Slightly complicated template engine for commands and hgweb

This module provides low-level interface to the template engine. See the

formatter and cmdutil modules if you are looking for high-level functions

such as ``cmdutil.rendertemplate(ctx, tmpl)``.

Internal Data Types

-------------------

Template keywords and functions take a dictionary of current symbols and

resources (a "mapping") and return result. Inputs and outputs must be one

of the following data types:

bytes

    a byte string, which is generally a human-readable text in local encoding.

generator

    a lazily-evaluated byte string, which is a possibly nested generator of

    values of any printable types, and  will be folded by ``stringify()``

    or ``flatten()``.

None

    sometimes represents an empty value, which can be stringified to ''.

True, False, int, float

    can be stringified as such.

wrappedbytes, wrappedvalue

    a wrapper for the above printable types.

date

    represents a (unixtime, offset) tuple.

hybrid

    represents a list/dict of printable values, which can also be converted

    to mappings by % operator.

hybriditem

    represents a scalar printable value, also supports % operator.

revslist

    represents a list of revision numbers.

mappinggenerator, mappinglist

    represents mappings (i.e. a list of dicts), which may have default

    output format.

mappingdict

    represents a single mapping (i.e. a dict), which may have default output

    format.

mappingnone

    represents None of Optional[mappable], which will be mapped to an empty

    string by % operation.

mappedgenerator

    a lazily-evaluated list of byte strings, which is e.g. a result of %

    operation.

"""

import abc

import os

from .i18n import _

from .pycompat import (

    FileNotFoundError,

)

from . import (

    config,

    encoding,

    error,

    parser,

    pycompat,

    templatefilters,

    templatefuncs,

    templateutil,

    util,

)

from .utils import (

    resourceutil,

    stringutil,

)

# template parsing

elements = {

    # token-type: binding-strength, primary, prefix, infix, suffix

    b"(": (20, None, (b"group", 1, b")"), (b"func", 1, b")"), None),

    b".": (18, None, None, (b".", 18), None),

    b"%": (15, None, None, (b"%", 15), None),

    b"|": (15, None, None, (b"|", 15), None),

    b"*": (5, None, None, (b"*", 5), None),

    b"/": (5, None, None, (b"/", 5), None),

    b"+": (4, None, None, (b"+", 4), None),

    b"-": (4, None, (b"negate", 19), (b"-", 4), None),

    b"=": (3, None, None, (b"keyvalue", 3), None),

    b",": (2, None, None, (b"list", 2), None),

    b")": (0, None, None, None, None),

    b"integer": (0, b"integer", None, None, None),

    b"symbol": (0, b"symbol", None, None, None),

    b"string": (0, b"string", None, None, None),

    b"template": (0, b"template", None, None, None),

    b"end": (0, None, None, None, None),

}

def tokenize(program, start, end, term=None):

    """Parse a template expression into a stream of tokens, which must end

    with term if specified"""

    pos = start

    program = pycompat.bytestr(program)

    while pos < end:

        c = program[pos]

        if c.isspace():  # skip inter-token whitespace

            pass

        elif c in b"(=,).%|+-*/":  # handle simple operators

            yield (c, None, pos)

        elif c in b'"\'':  # handle quoted templates

            s = pos + 1

            data, pos = _parsetemplate(program, s, end, c)

            yield (b'template', data, s)

            pos -= 1

        elif c == b'r' and program[pos : pos + 2] in (b"r'", b'r"'):

            # handle quoted strings

            c = program[pos + 1]

            s = pos = pos + 2

            while pos < end:  # find closing quote

                d = program[pos]

                if d == b'\\':  # skip over escaped characters

                    pos += 2

                    continue

                if d == c:

                    yield (b'string', program[s:pos], s)

                    break

                pos += 1

            else:

                raise error.ParseError(_(b"unterminated string"), s)

        elif c.isdigit():

            s = pos

            while pos < end:

                d = program[pos]

                if not d.isdigit():

                    break

                pos += 1

            yield (b'integer', program[s:pos], s)

            pos -= 1

        elif (

            c == b'\\'

            and program[pos : pos + 2] in (br"\'", br'\"')

            or c == b'r'

            and program[pos : pos + 3] in (br"r\'", br'r\"')

        ):

            # handle escaped quoted strings for compatibility with 2.9.2-3.4,

            # where some of nested templates were preprocessed as strings and

            # then compiled. therefore, \"...\" was allowed. (issue4733)

            #

            # processing flow of _evalifliteral() at 5ab28a2e9962:

            # outer template string    -> stringify()  -> compiletemplate()

            # ------------------------    ------------    ------------------

            # {f("\\\\ {g(\"\\\"\")}"}    \\ {g("\"")}    [r'\\', {g("\"")}]

            #             ~~~~~~~~

            #             escaped quoted string

            if c == b'r':

                pos += 1

                token = b'string'

            else:

                token = b'template'

            quote = program[pos : pos + 2]

            s = pos = pos + 2

            while pos < end:  # find closing escaped quote

                # pycompat.bytestr (and bytes) both have .startswith() that

                # takes an optional start and an optional end, but pytype thinks

                # it only takes 2 args.

                # pytype: disable=wrong-arg-count

                if program.startswith(b'\\\\\\', pos, end):

                    pos += 4  # skip over double escaped characters

                    continue

                if program.startswith(quote, pos, end):

                    # pytype: enable=wrong-arg-count

                    # interpret as if it were a part of an outer string

                    data = parser.unescapestr(program[s:pos])

                    if token == b'template':

                        data = _parsetemplate(data, 0, len(data))[0]

                    yield (token, data, s)

                    pos += 1

                    break

                pos += 1

            else:

                raise error.ParseError(_(b"unterminated string"), s)

        elif c.isalnum() or c in b'_':

            s = pos

            pos += 1

            while pos < end:  # find end of symbol

                d = program[pos]

                if not (d.isalnum() or d == b"_"):

                    break

                pos += 1

            sym = program[s:pos]

            yield (b'symbol', sym, s)

            pos -= 1

        elif c == term:

            yield (b'end', None, pos)

            return

        else:

            raise error.ParseError(_(b"syntax error"), pos)

        pos += 1

    if term:

        raise error.ParseError(_(b"unterminated template expansion"), start)

    yield (b'end', None, pos)

def _parsetemplate(tmpl, start, stop, quote=b''):

    r"""

    >>> _parsetemplate(b'foo{bar}"baz', 0, 12)

    ([('string', 'foo'), ('symbol', 'bar'), ('string', '"baz')], 12)

    >>> _parsetemplate(b'foo{bar}"baz', 0, 12, quote=b'"')

    ([('string', 'foo'), ('symbol', 'bar')], 9)

    >>> _parsetemplate(b'foo"{bar}', 0, 9, quote=b'"')

    ([('string', 'foo')], 4)

    >>> _parsetemplate(br'foo\"bar"baz', 0, 12, quote=b'"')

    ([('string', 'foo"'), ('string', 'bar')], 9)

    >>> _parsetemplate(br'foo\\"bar', 0, 10, quote=b'"')

    ([('string', 'foo\\')], 6)

    """

    parsed = []

    for typ, val, pos in _scantemplate(tmpl, start, stop, quote):

        if typ == b'string':

            parsed.append((typ, val))

        elif typ == b'template':

            parsed.append(val)

        elif typ == b'end':

            return parsed, pos

        else:

            raise error.ProgrammingError(b'unexpected type: %s' % typ)

    raise error.ProgrammingError(b'unterminated scanning of template')

def scantemplate(tmpl, raw=False):

    r"""Scan (type, start, end) positions of outermost elements in template

    If raw=True, a backslash is not taken as an escape character just like

    r'' string in Python. Note that this is different from r'' literal in

    template in that no template fragment can appear in r'', e.g. r'{foo}'

    is a literal '{foo}', but ('{foo}', raw=True) is a template expression

    'foo'.

    >>> list(scantemplate(b'foo{bar}"baz'))

    [('string', 0, 3), ('template', 3, 8), ('string', 8, 12)]

    >>> list(scantemplate(b'outer{"inner"}outer'))

    [('string', 0, 5), ('template', 5, 14), ('string', 14, 19)]

    >>> list(scantemplate(b'foo\\{escaped}'))

    [('string', 0, 5), ('string', 5, 13)]

    >>> list(scantemplate(b'foo\\{escaped}', raw=True))

    [('string', 0, 4), ('template', 4, 13)]

    """

    last = None

    for typ, val, pos in _scantemplate(tmpl, 0, len(tmpl), raw=raw):

        if last:

            yield last + (pos,)

        if typ == b'end':

            return

        else:

            last = (typ, pos)

    raise error.ProgrammingError(b'unterminated scanning of template')

def _scantemplate(tmpl, start, stop, quote=b'', raw=False):

    """Parse template string into chunks of strings and template expressions"""

    sepchars = b'{' + quote

    unescape = [parser.unescapestr, pycompat.identity][raw]

    pos = start

    p = parser.parser(elements)

    try:

        while pos < stop:

            n = min(

                (tmpl.find(c, pos, stop) for c in pycompat.bytestr(sepchars)),

                key=lambda n: (n < 0, n),

            )

            if n < 0:

                yield (b'string', unescape(tmpl[pos:stop]), pos)

                pos = stop

                break

            c = tmpl[n : n + 1]

            bs = 0  # count leading backslashes

            if not raw:

                bs = (n - pos) - len(tmpl[pos:n].rstrip(b'\\'))

            if bs % 2 == 1:

                # escaped (e.g. '\{', '\\\{', but not '\\{')

                yield (b'string', unescape(tmpl[pos : n - 1]) + c, pos)

                pos = n + 1

                continue

            if n > pos:

                yield (b'string', unescape(tmpl[pos:n]), pos)

            if c == quote:

                yield (b'end', None, n + 1)

                return

            parseres, pos = p.parse(tokenize(tmpl, n + 1, stop, b'}'))

            # pycompat.bytestr (and bytes) both have .startswith() that

            # takes an optional start and an optional end, but pytype thinks

            # it only takes 2 args.

            # pytype: disable=wrong-arg-count

            if not tmpl.startswith(b'}', pos):

                # pytype: enable=wrong-arg-count

                raise error.ParseError(_(b"invalid token"), pos)

            yield (b'template', parseres, n)

            pos += 1

        if quote:

            raise error.ParseError(_(b"unterminated string"), start)

    except error.ParseError as inst:

        _addparseerrorhint(inst, tmpl)

        raise

    yield (b'end', None, pos)

def _addparseerrorhint(inst, tmpl):

    if inst.location is None:

        return

    loc = inst.location

    # Offset the caret location by the number of newlines before the

    # location of the error, since we will replace one-char newlines

    # with the two-char literal r'\n'.

    offset = tmpl[:loc].count(b'\n')

    tmpl = tmpl.replace(b'\n', br'\n')

    # We want the caret to point to the place in the template that

    # failed to parse, but in a hint we get a open paren at the

    # start. Therefore, we print "loc + 1" spaces (instead of "loc")

    # to line up the caret with the location of the error.

    inst.hint = tmpl + b'\n' + b' ' * (loc + 1 + offset) + b'^ ' + _(b'here')

def _unnesttemplatelist(tree):

    """Expand list of templates to node tuple

    >>> def f(tree):

    ...     print(pycompat.sysstr(prettyformat(_unnesttemplatelist(tree))))

    >>> f((b'template', []))

    (string '')

    >>> f((b'template', [(b'string', b'foo')]))

    (string 'foo')

    >>> f((b'template', [(b'string', b'foo'), (b'symbol', b'rev')]))

    (template

      (string 'foo')

      (symbol 'rev'))

    >>> f((b'template', [(b'symbol', b'rev')]))  # template(rev) -> str

    (template

      (symbol 'rev'))

    >>> f((b'template', [(b'template', [(b'string', b'foo')])]))

    (string 'foo')

    """

    if not isinstance(tree, tuple):

        return tree

    op = tree[0]

    if op != b'template':

        return (op,) + tuple(_unnesttemplatelist(x) for x in tree[1:])

    assert len(tree) == 2

    xs = tuple(_unnesttemplatelist(x) for x in tree[1])

    if not xs:

        return (b'string', b'')  # empty template ""

    elif len(xs) == 1 and xs[0][0] == b'string':

        return xs[0]  # fast path for string with no template fragment "x"

    else:

        return (op,) + xs