From 529ad13fa259a55ef02d77c8bcd09ebd35302476 Mon Sep 17 00:00:00 2001
From: Douglas Gregor <doug.gregor@gmail.com>
Date: Fri, 29 Aug 2003 01:37:03 +0000
Subject: [PATCH] Added preliminary support for macro documentation

[SVN r19845]
---
 xsl/annotation.xsl       | 37 +++++++++++++++++++++
 xsl/docbook.xsl          | 14 ++++++--
 xsl/macro.xsl            | 70 ++++++++++++++++++++++++++++++++++++++++
 xsl/reference.xsl        |  1 +
 xsl/source-highlight.xsl |  2 +-
 5 files changed, 121 insertions(+), 3 deletions(-)
 create mode 100644 xsl/macro.xsl

diff --git a/xsl/annotation.xsl b/xsl/annotation.xsl
index 4c7dea2..4c0d7d0 100644
--- a/xsl/annotation.xsl
+++ b/xsl/annotation.xsl
@@ -5,6 +5,7 @@
   <xsl:key name="methods" match="method|overloaded-method" use="@name"/>
   <xsl:key name="functions" match="function|overloaded-function" use="@name"/>
   <xsl:key name="libraries" match="library" use="@name"/>
+  <xsl:key name="macros" match="macro" use="@name"/>
 
   <xsl:template match="classname" mode="annotation">
     <!-- Determine the (possibly qualified) class name we are looking for -->
@@ -161,6 +162,42 @@
     </xsl:call-template>
   </xsl:template>
 
+  <xsl:template match="macroname" mode="annotation">
+    <xsl:param name="name" select="text()"/>
+    
+    <xsl:variable name="node" select="key('macros', $name)"/>
+    <xsl:choose>
+      <xsl:when test="count($node) = 0">
+        <xsl:message>
+          <xsl:text>warning: cannot find macro `</xsl:text>
+          <xsl:value-of select="$name"/>
+          <xsl:text>'</xsl:text>
+        </xsl:message>
+        <xsl:value-of select="$name"/>
+      </xsl:when>
+
+      <xsl:when test="count($node) = 1">
+        <xsl:call-template name="internal-link">
+          <xsl:with-param name="to">
+            <xsl:call-template name="generate.id">
+              <xsl:with-param name="node" select="$node"/>
+            </xsl:call-template>
+          </xsl:with-param>
+          <xsl:with-param name="text" select="$name"/>
+        </xsl:call-template>
+      </xsl:when>
+
+      <xsl:otherwise>
+        <xsl:message>
+          <xsl:text>error: macro `</xsl:text>
+          <xsl:value-of select="$name"/>
+          <xsl:text>' is multiply defined.</xsl:text>
+        </xsl:message>
+        <xsl:value-of select="$node"/>
+      </xsl:otherwise>
+    </xsl:choose>
+  </xsl:template>
+
   <xsl:template match="text()" mode="annotation">
     <xsl:param name="highlight" select="false()"/>
     <xsl:choose>
diff --git a/xsl/docbook.xsl b/xsl/docbook.xsl
index fe8eddf..c149726 100644
--- a/xsl/docbook.xsl
+++ b/xsl/docbook.xsl
@@ -69,7 +69,17 @@
 
         <xsl:apply-templates select="para|section" mode="annotation"/>
         
-        <xsl:apply-templates mode="synopsis">
+        <xsl:if test="macro and namespace">
+          <xsl:call-template name="synopsis">
+            <xsl:with-param name="text">
+              <xsl:apply-templates mode="synopsis" select="macro">
+                <xsl:with-param name="indentation" select="0"/>
+              </xsl:apply-templates>
+            </xsl:with-param>
+          </xsl:call-template>
+        </xsl:if>
+
+        <xsl:apply-templates mode="synopsis" select="namespace">
           <xsl:with-param name="indentation" select="0"/>
         </xsl:apply-templates>
         
@@ -341,7 +351,7 @@ Error: XSL template 'link-or-anchor' called with invalid link-type '<xsl:value-o
 
   <!-- These DocBook elements have special meaning. Use the annotation mode -->
   <xsl:template match="classname|methodname|functionname|libraryname|
-                       conceptname">
+                       conceptname|macroname">
     <xsl:apply-templates select="." mode="annotation"/>
   </xsl:template>
 
diff --git a/xsl/macro.xsl b/xsl/macro.xsl
new file mode 100644
index 0000000..d31a7b3
--- /dev/null
+++ b/xsl/macro.xsl
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+                version="1.0">
+  <xsl:template match="macro" mode="synopsis">
+    <xsl:param name="indentation" select="0"/>
+
+    <xsl:text>&#10;</xsl:text>
+    <xsl:if 
+      test="not(local-name(preceding-sibling::*[position()=1])=local-name(.))">
+      <xsl:text>&#10;</xsl:text>
+    </xsl:if>
+    <xsl:call-template name="indent">
+      <xsl:with-param name="indentation" select="$indentation"/>
+    </xsl:call-template>
+    <xsl:call-template name="macro-synopsis">
+      <xsl:with-param name="link-type" select="'link'"/>
+    </xsl:call-template>
+  </xsl:template>
+
+  <xsl:template match="macro" mode="reference">
+    <xsl:call-template name="reference-documentation">
+      <xsl:with-param name="refname" select="@name"/>
+      <xsl:with-param name="purpose" select="purpose"/>
+      <xsl:with-param name="anchor">
+        <xsl:call-template name="generate.id"/>
+      </xsl:with-param>
+      <xsl:with-param name="name">
+        <xsl:text>Macro </xsl:text>
+        <xsl:call-template name="monospaced">
+          <xsl:with-param name="text" select="@name"/>
+        </xsl:call-template>
+      </xsl:with-param>
+      <xsl:with-param name="synopsis">
+        <xsl:call-template name="macro-synopsis">
+          <xsl:with-param name="link-type" select="'none'"/>
+        </xsl:call-template>
+      </xsl:with-param>
+      <xsl:with-param name="text">
+        <xsl:apply-templates select="description"/>
+      </xsl:with-param>
+    </xsl:call-template>
+  </xsl:template>
+
+  <xsl:template name="macro-synopsis">
+    <xsl:param name="link-type"/>
+
+    <xsl:call-template name="link-or-anchor">
+      <xsl:with-param name="to">
+        <xsl:call-template name="generate.id" select="."/>
+      </xsl:with-param>
+      <xsl:with-param name="text" select="@name"/>
+      <xsl:with-param name="link-type" select="$link-type"/>
+    </xsl:call-template>
+
+    <xsl:if test="@kind='functionlike'">
+      <xsl:text>(</xsl:text>
+      <xsl:for-each select="macro-parameter">
+        <xsl:if test="position() &gt; 1">
+          <xsl:text>, </xsl:text>
+        </xsl:if>
+        <xsl:value-of select="@name"/>
+      </xsl:for-each>
+      <xsl:text>)</xsl:text>
+    </xsl:if>
+  </xsl:template>
+
+  <xsl:template match="macro" mode="generate.id">
+    <xsl:value-of select="@name"/>
+  </xsl:template>
+</xsl:stylesheet>
diff --git a/xsl/reference.xsl b/xsl/reference.xsl
index 61df4c6..e081e20 100644
--- a/xsl/reference.xsl
+++ b/xsl/reference.xsl
@@ -11,6 +11,7 @@
   <xsl:include href="library.xsl"/>
   <xsl:include href="index.xsl"/>
   <xsl:include href="error.xsl"/>
+  <xsl:include href="macro.xsl"/>
   <xsl:include href="testing/testsuite.xsl"/>
   <xsl:include href="caramel/concept2docbook.xsl"/>
   
diff --git a/xsl/source-highlight.xsl b/xsl/source-highlight.xsl
index 69030f2..14e7dc8 100644
--- a/xsl/source-highlight.xsl
+++ b/xsl/source-highlight.xsl
@@ -152,7 +152,7 @@
   </xsl:template>
 
   <xsl:template match="classname|methodname|functionname|libraryname|
-                       conceptname" mode="highlight">
+                       conceptname|macroname" mode="highlight">
     <xsl:apply-templates select="." mode="annotation"/>
   </xsl:template>
 </xsl:stylesheet>