plugins: reST directive for linking to Doxygen docs.

diff --git a/pelican-plugins/m/dox.py b/pelican-plugins/m/dox.py
new file mode 100644 (file)
index 0000000..47925c9
--- /dev/null
+++ b/pelican-plugins/m/dox.py
@@ -0,0 +1,98 @@
+#!/usr/bin/env python
+
+from . import parse_link
+from docutils.parsers.rst.states import Inliner
+from docutils import nodes, utils
+from docutils.parsers import rst
+from pelican import signals
+import xml.etree.ElementTree as ET
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+symbol_mapping = {}
+symbol_prefixes = ['']
+
+def init(pelicanobj):
+    global symbol_mapping, symbol_prefixes
+
+    tagfiles = pelicanobj.settings.get('DOXYGEN_TAGFILES', [])
+
+    # Pre-round to populate subclasses
+
+    for tagfile, path, prefixes in tagfiles:
+        symbol_prefixes += prefixes
+
+        tree = ET.parse(tagfile)
+        root = tree.getroot()
+        for child in root:
+            if child.tag == 'compound' and 'kind' in child.attrib:
+                # Linking to pages
+                if child.attrib['kind'] == 'page':
+                    link = path + child.find('filename').text + '.html'
+                    symbol_mapping[child.find('name').text] = link
+
+                    # Page sections
+                    for section in child.findall('docanchor'):
+                        symbol_mapping[section.text] = link + '#' + section.text
+
+                # Linking to files
+                if child.attrib['kind'] == 'file':
+                    link = path + child.find('filename').text + ".html"
+                    symbol_mapping[child.find('path').text + child.find('name').text] = link
+
+                    for member in child.findall('member'):
+                        if not 'kind' in member.attrib: continue
+
+                        # Preprocessor defines and macros
+                        if member.attrib['kind'] == 'define':
+                            symbol_mapping[member.find('name').text + ('()' if member.find('arglist').text else '')] = link + '#' + member.find('anchor').text
+
+                # Linking to namespaces, structs and classes
+                if child.attrib['kind'] in ['class', 'struct', 'namespace']:
+                    symbol_mapping[child.find('name').text] = path + child.find('filename').text
+                    name = child.find('name').text
+                    link = path + child.find('filename').text
+                    symbol_mapping[name] = link
+                    for member in child.findall('member'):
+                        if not 'kind' in member.attrib: continue
+
+                        # Typedefs, constants
+                        if member.attrib['kind'] == 'typedef' or member.attrib['kind'] == 'enumvalue':
+                            symbol_mapping[name + '::' + member.find('name').text] = link + '#' + member.find('anchor').text
+
+                        # Functions
+                        if member.attrib['kind'] == 'function':
+                            symbol_mapping[name + '::' + member.find('name').text + "()"] = link + '#' + member.find('anchor').text
+
+                        # Enums with values
+                        if member.attrib['kind'] == 'enumeration':
+                            enumeration = name + '::' + member.find('name').text
+                            symbol_mapping[enumeration] = link + '#' + member.find('anchor').text
+
+                            for value in member.findall('enumvalue'):
+                                symbol_mapping[enumeration + '::' + value.text] = link + '#' + value.attrib['anchor']
+
+def dox(name, rawtext, text, lineno, inliner: Inliner, options={}, content=[]):
+    title, target = parse_link(text)
+    if not title: title = target
+
+    for prefix in symbol_prefixes:
+        if prefix + target in symbol_mapping:
+            url = symbol_mapping[prefix + target]
+            node = nodes.reference(rawtext, title, refuri=url, **options)
+            return [node], []
+
+    # TODO: print file and line
+    #msg = inliner.reporter.warning(
+        #'Doxygen symbol %s not found' % target, line=lineno)
+    #prb = inliner.problematic(rawtext, rawtext, msg)
+    logger.warning('Doxygen symbol `%s` not found, rendering as monospace' % target)
+    node = nodes.literal(rawtext, title, **options)
+    return [node], []
+
+def register():
+    signals.initialized.connect(init)
+
+    rst.roles.register_local_role('dox', dox)