# templater.py - template expansion for output

#

# Copyright 2005, 2006 Matt Mackall <mpm@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.

from __future__ import absolute_import

import os

import re

import types

from .i18n import _

from . import (

    config,

    error,

    minirst,

    parser,

    revset as revsetmod,

    templatefilters,

    templatekw,

    util,

)

# template parsing

elements = {

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

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

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

    "|": (5, None, None, ("|", 5), None),

    "%": (6, None, None, ("%", 6), None),

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

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

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

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

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

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

}

def tokenize(program, start, end):

    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 '"\'': # handle quoted templates

            s = pos + 1

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

            yield ('template', data, s)

            pos -= 1

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

            # handle quoted strings

            c = program[pos + 1]

            s = pos = pos + 2

            while pos < end: # find closing quote

                d = program[pos]

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

                    pos += 2

                    continue

                if d == c:

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

                    break

                pos += 1

            else:

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

        elif c.isdigit() or c == '-':

            s = pos

            if c == '-': # simply take negate operator as part of integer

                pos += 1

            if pos >= end or not program[pos].isdigit():

                raise error.ParseError(_("integer literal without digits"), s)

            pos += 1

            while pos < end:

                d = program[pos]

                if not d.isdigit():

                    break

                pos += 1

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

            pos -= 1

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

              or c == 'r' and program[pos:pos + 3] in (r"r\'", r'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 == 'r':

                pos += 1

                token = 'string'

            else:

                token = 'template'

            quote = program[pos:pos + 2]

            s = pos = pos + 2

            while pos < end: # find closing escaped quote

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

                    pos += 4 # skip over double escaped characters

                    continue

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

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

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

                    if token == 'template':

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

                    yield (token, data, s)

                    pos += 1

                    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]

            yield ('symbol', sym, s)

            pos -= 1

        elif c == '}':

            yield ('end', None, pos + 1)

            return

        else:

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

        pos += 1

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

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

    r"""

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

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

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

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

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

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

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

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

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

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

    """

    parsed = []

    sepchars = '{' + quote

    pos = start

    p = parser.parser(elements)

    while pos < stop:

        n = min((tmpl.find(c, pos, stop) for c in sepchars),

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

        if n < 0:

            parsed.append(('string', parser.unescapestr(tmpl[pos:stop])))

            pos = stop

            break

        c = tmpl[n]

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

        if bs % 2 == 1:

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

            parsed.append(('string', parser.unescapestr(tmpl[pos:n - 1]) + c))

            pos = n + 1

            continue

        if n > pos:

            parsed.append(('string', parser.unescapestr(tmpl[pos:n])))

        if c == quote:

            return parsed, n + 1

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

        parsed.append(parseres)

    if quote:

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

    return parsed, pos

    parsed, pos = _parsetemplate(tmpl, 0, len(tmpl))

def compileexp(exp, context, curmethods):

    t = exp[0]

    if t in curmethods:

        return curmethods[t](exp, context)

    raise error.ParseError(_("unknown method '%s'") % t)

# template evaluation

def getsymbol(exp):

    if exp[0] == 'symbol':

        return exp[1]

    raise error.ParseError(_("expected a symbol, got '%s'") % exp[0])

def getlist(x):

    if not x:

        return []

    if x[0] == 'list':

        return getlist(x[1]) + [x[2]]

    return [x]

def gettemplate(exp, context):

    if exp[0] == 'template':

    if exp[0] == 'symbol':

        # unlike runsymbol(), here 'symbol' is always taken as template name

        # even if it exists in mapping. this allows us to override mapping

        # by web templates, e.g. 'changelogtag' is redefined in map file.

        return context._load(exp[1])

    raise error.ParseError(_("expected template specifier"))

def evalfuncarg(context, mapping, arg):

    func, data = arg

    # func() may return string, generator of strings or arbitrary object such

    # as date tuple, but filter does not want generator.

    thing = func(context, mapping, data)

    if isinstance(thing, types.GeneratorType):

        thing = stringify(thing)

    return thing

def evalinteger(context, mapping, arg, err):

    v = evalfuncarg(context, mapping, arg)

    try:

        return int(v)

    except (TypeError, ValueError):

        raise error.ParseError(err)

def evalstring(context, mapping, arg):

    func, data = arg

    return stringify(func(context, mapping, data))

def evalstringliteral(context, mapping, arg):

    """Evaluate given argument as string template, but returns symbol name

    if it is unknown"""

    func, data = arg

    if func is runsymbol:

        thing = func(context, mapping, data, default=data)

    else:

        thing = func(context, mapping, data)

    return stringify(thing)

def runinteger(context, mapping, data):

    return int(data)

def runstring(context, mapping, data):

    return data

def _recursivesymbolblocker(key):

    def showrecursion(**args):

        raise error.Abort(_("recursive reference '%s' in template") % key)

    return showrecursion

def _runrecursivesymbol(context, mapping, key):

    raise error.Abort(_("recursive reference '%s' in template") % key)

def runsymbol(context, mapping, key, default=''):

    v = mapping.get(key)

    if v is None:

        v = context._defaults.get(key)

    if v is None:

        # put poison to cut recursion. we can't move this to parsing phase

        # because "x = {x}" is allowed if "x" is a keyword. (issue4758)

        safemapping = mapping.copy()

        safemapping[key] = _recursivesymbolblocker(key)

        try:

            v = context.process(key, safemapping)

        except TemplateNotFound:

            v = default

    if callable(v):

        return v(**mapping)

    return v

def buildtemplate(exp, context):

    ctmpl = [compileexp(e, context, methods) for e in exp[1]]

    if len(ctmpl) == 1:

        return ctmpl[0]  # fast path for string with no template fragment

    return (runtemplate, ctmpl)

def runtemplate(context, mapping, template):

    for func, data in template:

        yield func(context, mapping, data)

def buildfilter(exp, context):

    arg = compileexp(exp[1], context, methods)

    n = getsymbol(exp[2])

    if n in context._filters:

        filt = context._filters[n]

        return (runfilter, (arg, filt))

    if n in funcs:

        f = funcs[n]

        return (f, [arg])

    raise error.ParseError(_("unknown function '%s'") % n)

def runfilter(context, mapping, data):

    arg, filt = data

    thing = evalfuncarg(context, mapping, arg)

    try:

        return filt(thing)

    except (ValueError, AttributeError, TypeError):

        if isinstance(arg[1], tuple):

            dt = arg[1][1]

        else:

            dt = arg[1]

        raise error.Abort(_("template filter '%s' is not compatible with "

                           "keyword '%s'") % (filt.func_name, dt))

def buildmap(exp, context):

    func, data = compileexp(exp[1], context, methods)

def runmap(context, mapping, data):

    d = func(context, mapping, data)

    if util.safehasattr(d, 'itermaps'):

        diter = d.itermaps()

    else:

        try:

            diter = iter(d)

        except TypeError:

            if func is runsymbol:

                raise error.ParseError(_("keyword '%s' is not iterable") % data)

            else:

                raise error.ParseError(_("%r is not iterable") % d)

    for i in diter:

        lm = mapping.copy()

        if isinstance(i, dict):

            lm.update(i)

            lm['originalnode'] = mapping.get('node')

        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, exprmethods) for x in getlist(exp[2])]

    if n in funcs:

        f = funcs[n]

        return (f, args)

    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], f))

    raise error.ParseError(_("unknown function '%s'") % n)

def date(context, mapping, args):

    """:date(date[, fmt]): Format a date. See :hg:`help dates` for formatting

    strings. The default is a Unix date format, including the timezone:

    "Mon Sep 04 15:13:13 2006 0700"."""

    if not (1 <= len(args) <= 2):

        # i18n: "date" is a keyword

        raise error.ParseError(_("date expects one or two arguments"))

    date = evalfuncarg(context, mapping, args[0])

    fmt = None

    if len(args) == 2:

        fmt = evalstring(context, mapping, args[1])

    try:

        if fmt is None:

            return util.datestr(date)

        else:

            return util.datestr(date, fmt)

    except (TypeError, ValueError):

        # i18n: "date" is a keyword

        raise error.ParseError(_("date expects a date information"))

def diff(context, mapping, args):

    """:diff([includepattern [, excludepattern]]): Show a diff, optionally

    specifying files to include or exclude."""

    if len(args) > 2:

        # i18n: "diff" is a keyword

        raise error.ParseError(_("diff expects zero, one, or two arguments"))

    def getpatterns(i):

        if i < len(args):

            s = evalstring(context, mapping, args[i]).strip()

            if s:

                return [s]

        return []

    ctx = mapping['ctx']

    chunks = ctx.diff(match=ctx.match([], getpatterns(0), getpatterns(1)))

    return ''.join(chunks)

def fill(context, mapping, args):

    """:fill(text[, width[, initialident[, hangindent]]]): Fill many

    paragraphs with optional indentation. See the "fill" filter."""

    if not (1 <= len(args) <= 4):

        # i18n: "fill" is a keyword

        raise error.ParseError(_("fill expects one to four arguments"))

    text = evalstring(context, mapping, args[0])

    width = 76

    initindent = ''

    hangindent = ''

    if 2 <= len(args) <= 4:

        width = evalinteger(context, mapping, args[1],

                            # i18n: "fill" is a keyword

                            _("fill expects an integer width"))

        try:

            initindent = evalstring(context, mapping, args[2])

            hangindent = evalstring(context, mapping, args[3])

        except IndexError:

            pass

    return templatefilters.fill(text, width, initindent, hangindent)

def pad(context, mapping, args):

    """:pad(text, width[, fillchar=' '[, right=False]]): Pad text with a

    fill character."""

    if not (2 <= len(args) <= 4):

        # i18n: "pad" is a keyword

        raise error.ParseError(_("pad() expects two to four arguments"))

    width = evalinteger(context, mapping, args[1],

                        # i18n: "pad" is a keyword

                        _("pad() expects an integer width"))

    text = evalstring(context, mapping, args[0])

    right = False

    fillchar = ' '

    if len(args) > 2:

        fillchar = evalstring(context, mapping, args[2])

    if len(args) > 3:

        right = util.parsebool(args[3][1])

    if right:

        return text.rjust(width, fillchar)

    else:

        return text.ljust(width, fillchar)

def indent(context, mapping, args):

    """:indent(text, indentchars[, firstline]): Indents all non-empty lines

    with the characters given in the indentchars string. An optional

    third parameter will override the indent for the first line only

    if present."""

    if not (2 <= len(args) <= 3):

        # i18n: "indent" is a keyword

        raise error.ParseError(_("indent() expects two or three arguments"))

    text = evalstring(context, mapping, args[0])

    indent = evalstring(context, mapping, args[1])

    if len(args) == 3:

        firstline = evalstring(context, mapping, args[2])

    else:

        firstline = indent

    # the indent function doesn't indent the first line, so we do it here

    return templatefilters.indent(firstline + text, indent)

def get(context, mapping, args):

    """:get(dict, key): Get an attribute/key from an object. Some keywords

    are complex types. This function allows you to obtain the value of an

    attribute on these types."""

    if len(args) != 2:

        # i18n: "get" is a keyword

        raise error.ParseError(_("get() expects two arguments"))

    dictarg = evalfuncarg(context, mapping, args[0])

    if not util.safehasattr(dictarg, 'get'):

        # i18n: "get" is a keyword

        raise error.ParseError(_("get() expects a dict as first argument"))

    key = evalfuncarg(context, mapping, args[1])

    return dictarg.get(key)