[gtk-doc] db2html: add more docbook tag converters

[Stefan Sauer <stefkost src gnome org>]

commit c28aed340b59c9505dc5124fe21dd30788f75666
Author: Stefan Sauer <ensonic users sf net>
Date:   Sat Jan 13 22:47:43 2018 +0100

    db2html: add more docbook tag converters

 tools/db2html.py              |  129 ++++++++++++++++++++++++++++++++++++++++-
 tools/templates/refentry.html |    9 +--
 2 files changed, 129 insertions(+), 9 deletions(-)
---
diff --git a/tools/db2html.py b/tools/db2html.py
index cdd3853..4e3eab4 100644
--- a/tools/db2html.py
+++ b/tools/db2html.py
@@ -119,8 +119,9 @@ TEMPLATE_ENV = Environment(
     # loader=PackageLoader('gtkdoc', 'templates'),
     # autoescape=select_autoescape(['html', 'xml'])
     loader=FileSystemLoader(os.path.join(TOOL_PATH, 'templates')),
-    extensions=['jinja2.ext.do'],
+    # extensions=['jinja2.ext.do'],
     autoescape=False,
+    lstrip_blocks=True,
     trim_blocks=True,
 )
 
@@ -188,6 +189,8 @@ def chunk(xml_node, parent=None):
 
     return parent
 
+# conversion helpers
+
 
 def convert__inner(xml):
     result = ''
@@ -196,6 +199,10 @@ def convert__inner(xml):
     return result
 
 
+def convert_ignore(xml):
+    return ''
+
+
 missing_tags = {}
 
 
@@ -210,6 +217,60 @@ def convert__unknown(xml):
     return result
 
 
+def convert_refsect(xml, h_tag):
+    result = '<div class="%s">\n' % xml.tag
+    title = xml.find('title')
+    if title is not None:
+        if 'id' in xml.attrib:
+            result += '<a name="%s"></a>' % xml.attrib['id']
+        result += '<%s>%s</%s>' % (h_tag, title.text, h_tag)
+        xml.remove(title)
+    if xml.text:
+        result += xml.text
+    result += convert__inner(xml)
+    result += '</div>'
+    if xml.tail:
+        result += xml.tail
+    return result
+
+# docbook tags
+
+
+def convert_em_class(xml):
+    result = '<em class="%s"><code>' % xml.tag
+    if xml.text:
+        result += xml.text
+    result += convert__inner(xml)
+    result += '</code></em>'
+    if xml.tail:
+        result += xml.tail
+    return result
+
+
+def convert_link(xml):
+    # TODO: inline fixxref functionality
+    # TODO: need to build an 'id' map and resolve against internal links too
+    result = '<!-- GTKDOCLINK HREF="%s" -->' % xml.attrib.get('linkend', '')
+    if xml.text:
+        result += xml.text
+    result += convert__inner(xml)
+    result += '<!-- /GTKDOCLINK -->'
+    if xml.tail:
+        result += xml.tail
+    return result
+
+
+def convert_literal(xml):
+    result = '<code class="%s">' % xml.tag
+    if xml.text:
+        result += xml.text
+    result += convert__inner(xml)
+    result += '</code>'
+    if xml.tail:
+        result += xml.tail
+    return result
+
+
 def convert_para(xml):
     result = '<p>'
     if xml.tag != 'para':
@@ -223,6 +284,57 @@ def convert_para(xml):
     return result
 
 
+def convert_phrase(xml):
+    result = '<span'
+    if 'role' in xml.attrib:
+        result += ' class="%s">' % xml.attrib['role']
+    else:
+        result += '>'
+    if xml.text:
+        result += xml.text
+    result += convert__inner(xml)
+    result += '</span>'
+    if xml.tail:
+        result += xml.tail
+    return result
+
+# TODO: encode entities
+
+
+def convert_programlisting(xml):
+    result = '<pre class="programlisting">'
+    if xml.text:
+        result += xml.text
+    result += convert__inner(xml)
+    result += '</pre>'
+    if xml.tail:
+        result += xml.tail
+    return result
+
+
+def convert_refsect1(xml):
+    return convert_refsect(xml, 'h2')
+
+
+def convert_refsect2(xml):
+    return convert_refsect(xml, 'h3')
+
+
+def convert_refsect3(xml):
+    return convert_refsect(xml, 'h4')
+
+
+def convert_span(xml):
+    result = '<span class="%s">' % xml.tag
+    if xml.text:
+        result += xml.text
+    result += convert__inner(xml)
+    result += '</span>'
+    if xml.tail:
+        result += xml.tail
+    return result
+
+
 def convert_ulink(xml):
     result = '<a class="%s" href="%s">%s</a>' % (xml.tag, xml.attrib['url'], xml.text)
     if xml.tail:
@@ -231,7 +343,20 @@ def convert_ulink(xml):
 
 
 convert_tags = {
+    'function': convert_span,
+    'indexterm': convert_ignore,
+    'link': convert_link,
+    'literal': convert_literal,
     'para': convert_para,
+    'parameter': convert_em_class,
+    'phrase': convert_phrase,
+    'programlisting': convert_programlisting,
+    'refsect1': convert_refsect1,
+    'refsect2': convert_refsect2,
+    'refsect3': convert_refsect3,
+    'returnvalue': convert_span,
+    'structfield': convert_em_class,
+    'type': convert_span,
     'ulink': convert_ulink,
 }
 
@@ -253,8 +378,8 @@ def convert(out_dir, files, node):
             #     return xml.xpath(expr)
 
             template = TEMPLATES[node.name]
+            template.globals['convert_refsect1'] = convert_refsect1
             template.globals['convert_para'] = convert_para
-            template.globals['convert_inner'] = convert__inner
             params = {
                 'xml': node.xml,
                 'title': node.title,
diff --git a/tools/templates/refentry.html b/tools/templates/refentry.html
index d98449a..90bf4b1 100644
--- a/tools/templates/refentry.html
+++ b/tools/templates/refentry.html
@@ -21,13 +21,8 @@
   </tr></table>
 </div>
 
-{%- for sect in xml.findall('refsect1') %}
-<div class="refsect1">
-{% set tag=sect.find('title') -%}
-<a name="{{ sect.attrib['id'] }}"></a><h2>{{ tag.text }}</h2>
-{% do sect.remove(tag) %}
-{{ convert_inner(sect) }}
-</div>
+{%- for sect in xml.findall('refsect1') -%}
+{{ convert_refsect1(sect) }}
 {%- endfor %}
 
 </div>