# templatekw.py - common changeset template keywords

#

# Copyright 2005-2009 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

from .i18n import _

from .node import hex, nullid

from . import (

    encoding,

    error,

    hbisect,

    patch,

    registrar,

    scmutil,

    util,

)

class _hybrid(object):

    """Wrapper for list or dict to support legacy template

    This class allows us to handle both:

    - "{files}" (legacy command-line-specific list hack) and

    - "{files % '{file}\n'}" (hgweb-style with inlining and function support)

    and to access raw values:

    - "{ifcontains(file, files, ...)}", "{ifcontains(key, extras, ...)}"

    - "{get(extras, key)}"

    """

    def __init__(self, gen, values, makemap, joinfmt):

        self.gen = gen

        self._values = values

        self._makemap = makemap

        self.joinfmt = joinfmt

    def itermaps(self):

        makemap = self._makemap

        for x in self._values:

            yield makemap(x)

    def __contains__(self, x):

        return x in self._values

    def __len__(self):

        return len(self._values)

    def __getattr__(self, name):

            raise AttributeError(name)

        return getattr(self._values, name)

def unwraphybrid(thing):

    """Return an object which can be stringified possibly by using a legacy

    template"""

    if not util.safehasattr(thing, 'gen'):

        return thing

    return thing.gen

def showlist(name, values, plural=None, element=None, separator=' ', **args):

    if not element:

        element = name

    f = _showlist(name, values, plural, separator, **args)

    return _hybrid(f, values, lambda x: {element: x}, lambda d: d[element])

def _showlist(name, values, plural=None, separator=' ', **args):

    '''expand set of values.

    name is name of key in template map.

    values is list of strings or dicts.

    plural is plural of name, if not simply name + 's'.

    separator is used to join values as a string

    expansion works like this, given name 'foo'.

    if values is empty, expand 'no_foos'.

    if 'foo' not in template map, return values as a string,

    joined by 'separator'.

    expand 'start_foos'.

    for each value, expand 'foo'. if 'last_foo' in template

    map, expand it instead of 'foo' for last key.

    expand 'end_foos'.

    '''

    templ = args['templ']

    if plural:

        names = plural

    else: names = name + 's'

    if not values:

        noname = 'no_' + names

        if noname in templ:

            yield templ(noname, **args)

        return

    if name not in templ:

        if isinstance(values[0], str):

            yield separator.join(values)

        else:

            for v in values:

                yield dict(v, **args)

        return

    startname = 'start_' + names

    if startname in templ:

        yield templ(startname, **args)

    vargs = args.copy()

    def one(v, tag=name):

        try:

            vargs.update(v)

        except (AttributeError, ValueError):

            try:

                for a, b in v:

                    vargs[a] = b

            except ValueError:

                vargs[name] = v

        return templ(tag, **vargs)

    lastname = 'last_' + name

    if lastname in templ:

        last = values.pop()

    else:

        last = None

    for v in values:

        yield one(v)

    if last is not None:

        yield one(last, tag=lastname)

    endname = 'end_' + names

    if endname in templ:

        yield templ(endname, **args)

def _formatrevnode(ctx):

    """Format changeset as '{rev}:{node|formatnode}', which is the default

    template provided by cmdutil.changeset_templater"""

    repo = ctx.repo()

    if repo.ui.debugflag:

        hexnode = ctx.hex()

    else:

        hexnode = ctx.hex()[:12]

    return '%d:%s' % (scmutil.intrev(ctx.rev()), hexnode)

def getfiles(repo, ctx, revcache):

    if 'files' not in revcache:

        revcache['files'] = repo.status(ctx.p1(), ctx)[:3]

    return revcache['files']

def getlatesttags(repo, ctx, cache, pattern=None):

    '''return date, distance and name for the latest tag of rev'''

    cachename = 'latesttags'

    if pattern is not None:

        cachename += '-' + pattern

        match = util.stringmatcher(pattern)[2]

    else:

        match = util.always

    if cachename not in cache:

        # Cache mapping from rev to a tuple with tag date, tag

        # distance and tag name

        cache[cachename] = {-1: (0, 0, ['null'])}

    latesttags = cache[cachename]

    rev = ctx.rev()

    todo = [rev]

    while todo:

        rev = todo.pop()

        if rev in latesttags:

            continue

        ctx = repo[rev]

        tags = [t for t in ctx.tags()

                if (repo.tagtype(t) and repo.tagtype(t) != 'local'

                    and match(t))]

        if tags:

            latesttags[rev] = ctx.date()[0], 0, [t for t in sorted(tags)]

            continue

        try:

            # The tuples are laid out so the right one can be found by

            # comparison.

            pdate, pdist, ptag = max(

                latesttags[p.rev()] for p in ctx.parents())

        except KeyError:

            # Cache miss - recurse

            todo.append(rev)

            todo.extend(p.rev() for p in ctx.parents())

            continue

        latesttags[rev] = pdate, pdist + 1, ptag

    return latesttags[rev]

def getrenamedfn(repo, endrev=None):

    rcache = {}

    if endrev is None:

        endrev = len(repo)

    def getrenamed(fn, rev):

        '''looks up all renames for a file (up to endrev) the first

        time the file is given. It indexes on the changerev and only

        parses the manifest if linkrev != changerev.

        Returns rename info for fn at changerev rev.'''

        if fn not in rcache:

            rcache[fn] = {}

            fl = repo.file(fn)

            for i in fl:

                lr = fl.linkrev(i)

                renamed = fl.renamed(fl.node(i))

                rcache[fn][lr] = renamed

                if lr >= endrev:

                    break

        if rev in rcache[fn]:

            return rcache[fn][rev]

        # If linkrev != rev (i.e. rev not found in rcache) fallback to

        # filectx logic.

        try:

            return repo[rev][fn].renamed()

        except error.LookupError:

            return None

    return getrenamed

# default templates internally used for rendering of lists

defaulttempl = {

    'parent': '{rev}:{node|formatnode} ',

    'manifest': '{rev}:{node|formatnode}',

    'file_copy': '{name} ({source})',

    'envvar': '{key}={value}',

    'extra': '{key}={value|stringescape}'

}

# filecopy is preserved for compatibility reasons

defaulttempl['filecopy'] = defaulttempl['file_copy']

# keywords are callables like:

# fn(repo, ctx, templ, cache, revcache, **args)

# with:

# repo - current repository instance

# ctx - the changectx being displayed

# templ - the templater instance

# cache - a cache dictionary for the whole templater run

# revcache - a cache dictionary for the current revision

keywords = {}

templatekeyword = registrar.templatekeyword(keywords)

@templatekeyword('author')

def showauthor(repo, ctx, templ, **args):

    """String. The unmodified author of the changeset."""

    return ctx.user()

@templatekeyword('bisect')

def showbisect(repo, ctx, templ, **args):

    """String. The changeset bisection status."""

    return hbisect.label(repo, ctx.node())

@templatekeyword('branch')

def showbranch(**args):

    """String. The name of the branch on which the changeset was

    committed.

    """

    return args['ctx'].branch()

@templatekeyword('branches')

def showbranches(**args):

    """List of strings. The name of the branch on which the

    changeset was committed. Will be empty if the branch name was

    default. (DEPRECATED)

    """

    branch = args['ctx'].branch()

    if branch != 'default':

        return showlist('branch', [branch], plural='branches', **args)

    return showlist('branch', [], plural='branches', **args)

@templatekeyword('bookmarks')

def showbookmarks(**args):

    """List of strings. Any bookmarks associated with the

    changeset. Also sets 'active', the name of the active bookmark.

    """

    repo = args['ctx']._repo

    bookmarks = args['ctx'].bookmarks()

    active = repo._activebookmark

    makemap = lambda v: {'bookmark': v, 'active': active, 'current': active}

    f = _showlist('bookmark', bookmarks, **args)

    return _hybrid(f, bookmarks, makemap, lambda x: x['bookmark'])

@templatekeyword('children')

def showchildren(**args):

    """List of strings. The children of the changeset."""

    ctx = args['ctx']

    childrevs = ['%d:%s' % (cctx, cctx) for cctx in ctx.children()]

    return showlist('children', childrevs, element='child', **args)

# Deprecated, but kept alive for help generation a purpose.

@templatekeyword('currentbookmark')

def showcurrentbookmark(**args):

    """String. The active bookmark, if it is

    associated with the changeset (DEPRECATED)"""

    return showactivebookmark(**args)

@templatekeyword('activebookmark')

def showactivebookmark(**args):

    """String. The active bookmark, if it is

    associated with the changeset"""

    active = args['repo']._activebookmark

    if active and active in args['ctx'].bookmarks():

        return active

    return ''

@templatekeyword('date')

def showdate(repo, ctx, templ, **args):

    """Date information. The date when the changeset was committed."""

    return ctx.date()

@templatekeyword('desc')

def showdescription(repo, ctx, templ, **args):

    """String. The text of the changeset description."""

    s = ctx.description()

    if isinstance(s, encoding.localstr):

        # try hard to preserve utf-8 bytes

        return encoding.tolocal(encoding.fromlocal(s).strip())

    else:

        return s.strip()

@templatekeyword('diffstat')

def showdiffstat(repo, ctx, templ, **args):

    """String. Statistics of changes with the following format:

    "modified files: +added/-removed lines"

    """

    stats = patch.diffstatdata(util.iterlines(ctx.diff(noprefix=False)))

    maxname, maxtotal, adds, removes, binary = patch.diffstatsum(stats)

    return '%s: +%s/-%s' % (len(stats), adds, removes)

@templatekeyword('envvars')

def showenvvars(repo, **args):

    """A dictionary of environment variables. (EXPERIMENTAL)"""

    env = repo.ui.exportableenviron()

    env = util.sortdict((k, env[k]) for k in sorted(env))

    makemap = lambda k: {'key': k, 'value': env[k]}

    c = [makemap(k) for k in env]

    f = _showlist('envvar', c, plural='envvars', **args)

    return _hybrid(f, env, makemap,

                   lambda x: '%s=%s' % (x['key'], x['value']))

@templatekeyword('extras')

def showextras(**args):

    """List of dicts with key, value entries of the 'extras'

    field of this changeset."""

    extras = args['ctx'].extra()

    extras = util.sortdict((k, extras[k]) for k in sorted(extras))

    makemap = lambda k: {'key': k, 'value': extras[k]}

    c = [makemap(k) for k in extras]

    f = _showlist('extra', c, plural='extras', **args)

    return _hybrid(f, extras, makemap,

                   lambda x: '%s=%s' % (x['key'], util.escapestr(x['value'])))

@templatekeyword('file_adds')

def showfileadds(**args):

    """List of strings. Files added by this changeset."""

    repo, ctx, revcache = args['repo'], args['ctx'], args['revcache']

    return showlist('file_add', getfiles(repo, ctx, revcache)[1],

                    element='file', **args)

@templatekeyword('file_copies')

def showfilecopies(**args):

    """List of strings. Files copied in this changeset with

    their sources.

    """

    cache, ctx = args['cache'], args['ctx']

    copies = args['revcache'].get('copies')

    if copies is None:

        if 'getrenamed' not in cache:

            cache['getrenamed'] = getrenamedfn(args['repo'])

        copies = []

        getrenamed = cache['getrenamed']

        for fn in ctx.files():