changeset 28538:009f58f1ea75

registrar: add templatekeyword to mark a function as template keyword (API)

_templateregistrarbase is defined as a super class of templatekeyword,
for ease of adding template common features between "keyword",
"filter" and "function".

This patch also adds loadkeyword() to templatekw, because this
combination helps to figure out how they cooperate with each other.

Listing up loadkeyword() in dispatch.extraloaders causes implicit
loading template keyword functions at loading (3rd party) extension.

This change requires that "templatekeyword" attribute of (3rd party)
extension is registrar.templatekeyword or so.

--- a/mercurial/dispatch.py	Wed Mar 16 11:57:09 2016 +0000
+++ b/mercurial/dispatch.py	Sun Mar 13 05:17:06 2016 +0900
@@ -35,6 +35,7 @@
     hg,
     hook,
     revset,
+    templatekw,
     ui as uimod,
     util,
 )
@@ -758,6 +759,7 @@
     ('cmdtable', commands, 'loadcmdtable'),
     ('filesetpredicate', fileset, 'loadpredicate'),
     ('revsetpredicate', revset, 'loadpredicate'),
+    ('templatekeyword', templatekw, 'loadkeyword'),
 ]
 
 def _dispatch(req):

--- a/mercurial/registrar.py	Wed Mar 16 11:57:09 2016 +0000
+++ b/mercurial/registrar.py	Sun Mar 13 05:17:06 2016 +0900
@@ -161,3 +161,33 @@
     def _extrasetup(self, name, func, callstatus=False, callexisting=False):
         func._callstatus = callstatus
         func._callexisting = callexisting
+
+class _templateregistrarbase(_funcregistrarbase):
+    """Base of decorator to register functions as template specific one
+    """
+    _docformat = ":%s: %s"
+
+class templatekeyword(_templateregistrarbase):
+    """Decorator to register template keyword
+
+    Usage::
+
+        templaetkeyword = registrar.templatekeyword()
+
+        @templatekeyword('mykeyword')
+        def mykeywordfunc(repo, ctx, templ, cache, revcache, **args):
+            '''Explanation of this template keyword ....
+            '''
+            pass
+
+    The first string argument is used also in online help.
+
+    'templatekeyword' instance in example above can be used to
+    decorate multiple functions.
+
+    Decorated functions are registered automatically at loading
+    extension, if an instance named as 'templatekeyword' is used for
+    decorating in extension.
+
+    Otherwise, explicit 'templatekw.loadkeyword()' is needed.
+    """

--- a/mercurial/templatekw.py	Wed Mar 16 11:57:09 2016 +0000
+++ b/mercurial/templatekw.py	Sun Mar 13 05:17:06 2016 +0900
@@ -574,5 +574,11 @@
     'tags': showtags,
 }
 
+def loadkeyword(ui, extname, registrarobj):
+    """Load template keyword from specified registrarobj
+    """
+    for name, func in registrarobj._table.iteritems():
+        keywords[name] = func
+
 # tell hggettext to extract docstrings from these functions:
 i18nfunctions = keywords.values()