hgext/narrow/narrowtemplates.py

narrowrevlog: document excludeddir class and friends

Differential Revision: https://phab.mercurial-scm.org/D2185

# narrowtemplates.py - added template keywords for narrow clones
#
# Copyright 2017 Google, Inc.
#
# 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 mercurial import (
    registrar,
    revlog,
    util,
)

keywords = {}
templatekeyword = registrar.templatekeyword(keywords)
revsetpredicate = registrar.revsetpredicate()

def _isellipsis(repo, rev):
    if repo.changelog.flags(rev) & revlog.REVIDX_ELLIPSIS:
        return True
    return False

@templatekeyword('ellipsis')
def ellipsis(repo, ctx, templ, **args):
    """:ellipsis: String. 'ellipsis' if the change is an ellipsis node,
    else ''."""
    if _isellipsis(repo, ctx.rev()):
        return 'ellipsis'
    return ''

@templatekeyword('outsidenarrow')
def outsidenarrow(repo, ctx, templ, **args):
    """:outsidenarrow: String. 'outsidenarrow' if the change affects no
    tracked files, else ''."""
    if util.safehasattr(repo, 'narrowmatch'):
        m = repo.narrowmatch()
        if not any(m(f) for f in ctx.files()):
            return 'outsidenarrow'
    return ''

@revsetpredicate('ellipsis')
def ellipsisrevset(repo, subset, x):
    """``ellipsis()``
    Changesets that are ellipsis nodes.
    """
    return subset.filter(lambda r: _isellipsis(repo, r))