Mike Gerwitz

Activist for User Freedom

summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMike Gerwitz <mtg@gnu.org>2015-09-29 21:37:34 -0400
committerMike Gerwitz <mtg@gnu.org>2015-09-29 21:37:38 -0400
commit10b270250fafd838b70be642a4057ae5f1e28871 (patch)
tree01466c73fdf38e5efa8dc0958498bfc2259d3c63
parent5c4059e20ad0aa85262b20797ea32b9e02af16c2 (diff)
downloadliterate-xsl-10b270250fafd838b70be642a4057ae5f1e28871.tar.gz
literate-xsl-10b270250fafd838b70be642a4057ae5f1e28871.tar.bz2
literate-xsl-10b270250fafd838b70be642a4057ae5f1e28871.zip
De-indent docblocks when rendering Texinfo
-rw-r--r--src/texinfo.xsl50
1 files changed, 45 insertions, 5 deletions
diff --git a/src/texinfo.xsl b/src/texinfo.xsl
index 07c7e99..9dcb121 100644
--- a/src/texinfo.xsl
+++ b/src/texinfo.xsl
@@ -56,7 +56,7 @@
-->
<template mode="xt:doc-gen" priority="7"
match="xsl:template[ @match ]">
- <variable name="doc" as="comment()?"
+ <variable name="doc" as="xs:string?"
select="xt:get-docblock( . )" />
<variable name="mode" as="xs:string"
@@ -116,7 +116,7 @@
-->
<template mode="xt:doc-gen" priority="5"
match="xsl:template|xsl:function">
- <variable name="doc" as="comment()?"
+ <variable name="doc" as="xs:string?"
select="xt:get-docblock( . )" />
<variable name="param-str" as="xs:string"
@@ -188,14 +188,54 @@
Only the immediately preceding comment is considered according to
the @code{xt:is-docblock} predicate above.
-->
-<function name="xt:get-docblock" as="comment()?">
+<function name="xt:get-docblock" as="xs:string?">
<param name="context" as="node()" />
- <sequence select="( ( $context/preceding-sibling::node()[
+ <variable name="docblock" as="comment()?"
+ select="( ( $context/preceding-sibling::node()[
not( . instance of text()
and . = $xt:nl ) ] )
[ last() ] )
[ . instance of comment() ]" />
+
+ <sequence select="if ( not( $docblock ) ) then
+ ()
+ else
+ xt:format-block( $docblock )" />
+</function>
+
+
+<!--
+ Format docblock for Texinfo
+
+ Currently, this only handles de-indenting text: certain Texinfo commands
+ must begin in column 1, and certain environments (like @code{example} and
+ @code{verbatim}) incur extra indentation based on how the XML docblock is
+ formatted.
+
+ This considers the indentation of the first line of the docblock following
+ the opening delimiter to be the indentation throughout the entire
+ docblock, and strips those characters from the beginning of each
+ line. Both tabs and spaces are recognized.
+-->
+<function name="xt:format-block" as="xs:string">
+ <param name="text" as="xs:string" />
+
+ <variable name="re" as="xs:string"
+ select="concat(
+ '^',
+ replace(
+ substring-before(
+ substring-after( $text, $xt:nl ),
+ $xt:nl ),
+ '(^[ ]*).+$', '$1', 'm' ) )" />
+
+ <!-- regexes that match empty strings aren't permitted, so we must check
+ against it -->
+ <sequence select="if ( $re = '^' ) then
+ $text
+ else
+ replace( $text, $re, '', 'm' )" />
</function>
@@ -214,7 +254,7 @@
-->
<template mode="xt:doc-gen" priority="5"
match="comment()[ not( starts-with( ., '@comment' ) ) ]">
- <value-of select="concat( ., $xt:nl )" />
+ <value-of select="xt:format-block( concat( ., $xt:nl ) )" />
</template>