boost_mirror/boostbook
1
0
Fork 0
mirror of https://github.com/boostorg/boostbook.git synced 2025-05-11 13:23:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed a problem with boostbook printing an extra colon in the class

Browse Source 
synopsis, when a class inherits from a single base class and it's too 
long to fit on one line.


[SVN r40048]
This commit is contained in:
Frank Mori Hess 2007-10-15 13:27:50 +00:00
parent caeaebade4
commit ebff982ef1
1 changed files with 64 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
xsl/type.xsl
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<!-- <!--
Copyright (c) 2002 Douglas Gregor <doug.gregor -at- gmail.com> Copyright (c) 2002 Douglas Gregor <doug.gregor -at- gmail.com>
Distributed under the Boost Software License, Version 1.0. Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at (See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt) http://www.boost.org/LICENSE_1_0.txt)
@ -60,7 +60,7 @@
<xsl:template name="type.display.name"> <xsl:template name="type.display.name">
<xsl:choose> <xsl:choose>
<xsl:when test="contains(local-name(.), 'class')"> <xsl:when test="contains(local-name(.), 'class')">
<xsl:text>Class </xsl:text> <xsl:text>Class </xsl:text>
</xsl:when> </xsl:when>
<xsl:when test="contains(local-name(.), 'struct')"> <xsl:when test="contains(local-name(.), 'struct')">
<xsl:text>Struct </xsl:text> <xsl:text>Struct </xsl:text>
@ -85,7 +85,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:apply-templates select="specialization"/> <xsl:apply-templates select="specialization"/>
</xsl:with-param> </xsl:with-param>
</xsl:call-template> </xsl:call-template>
</xsl:template> </xsl:template>
<!-- Determine the class key for the given node --> <!-- Determine the class key for the given node -->
@ -98,7 +98,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:otherwise> <xsl:otherwise>
<xsl:value-of select="local-name($node)"/> <xsl:value-of select="local-name($node)"/>
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
</xsl:template> </xsl:template>
<!-- Emit class synopsis --> <!-- Emit class synopsis -->
@ -106,7 +106,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
struct|struct-specialization| struct|struct-specialization|
union|union-specialization" mode="synopsis"> union|union-specialization" mode="synopsis">
<xsl:param name="indentation"/> <xsl:param name="indentation"/>
<!-- The keyword used to declare this class type, e.g., class, <!-- The keyword used to declare this class type, e.g., class,
struct, or union. --> struct, or union. -->
<xsl:variable name="class-key"> <xsl:variable name="class-key">
@ -135,7 +135,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
</xsl:variable> </xsl:variable>
<xsl:choose> <xsl:choose>
<xsl:when test="(string-length($full-decl-string) + <xsl:when test="(string-length($full-decl-string) +
string-length($indentation)) &lt; $max-columns"> string-length($indentation)) &lt; $max-columns">
<xsl:call-template name="indent"> <xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$indentation"/> <xsl:with-param name="indentation" select="$indentation"/>
@ -170,11 +170,11 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:with-param name="indentation" select="$indentation"/> <xsl:with-param name="indentation" select="$indentation"/>
</xsl:apply-templates> </xsl:apply-templates>
<xsl:text>&#10;</xsl:text> <xsl:text>&#10;</xsl:text>
<!-- Indent class templates' names in the synopsis --> <!-- Indent class templates' names in the synopsis -->
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
</xsl:if> </xsl:if>
<!-- Class name --> <!-- Class name -->
<xsl:call-template name="indent"> <xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$indentation"/> <xsl:with-param name="indentation" select="$indentation"/>
@ -256,21 +256,21 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<!-- Create a vertical ellipsis --> <!-- Create a vertical ellipsis -->
<xsl:when test="@name = '...'"> <xsl:when test="@name = '...'">
<xsl:call-template name="indent"> <xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$indentation + 3"/> <xsl:with-param name="indentation" select="$indentation + 3"/>
</xsl:call-template>
<xsl:text>.&#10;</xsl:text>
<xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$indentation + 3"/>
</xsl:call-template> </xsl:call-template>
<xsl:text>.&#10;</xsl:text> <xsl:text>.&#10;</xsl:text>
<xsl:call-template name="indent"> <xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$indentation + 3"/> <xsl:with-param name="indentation" select="$indentation + 3"/>
</xsl:call-template>
<xsl:text>.&#10;</xsl:text>
<xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$indentation + 3"/>
</xsl:call-template> </xsl:call-template>
<xsl:text>.</xsl:text> <xsl:text>.</xsl:text>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:call-template name="indent"> <xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$indentation"/> <xsl:with-param name="indentation" select="$indentation"/>
</xsl:call-template> </xsl:call-template>
<xsl:call-template name="highlight-keyword"> <xsl:call-template name="highlight-keyword">
<xsl:with-param name="keyword" select="'typedef'"/> <xsl:with-param name="keyword" select="'typedef'"/>
@ -299,24 +299,24 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:value-of select="@type"/> <xsl:value-of select="@type"/>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:apply-templates select="type/*|type/text()" <xsl:apply-templates select="type/*|type/text()"
mode="highlight"/> mode="highlight"/>
<!-- <!--
<xsl:call-template name="source-highlight"> <xsl:call-template name="source-highlight">
<xsl:with-param name="text"> <xsl:with-param name="text">
<xsl:apply-templates select="type/*|type/text()"/> <xsl:apply-templates select="type/*|type/text()"/>
</xsl:with-param> </xsl:with-param>
</xsl:call-template> </xsl:call-template>
--> -->
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
<xsl:choose> <xsl:choose>
<xsl:when test="$max-type-length &gt; 0"> <xsl:when test="$max-type-length &gt; 0">
<xsl:value-of select="substring($type-padding, 1, <xsl:value-of select="substring($type-padding, 1,
$max-type-length - $type-length)"/> $max-type-length - $type-length)"/>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<xsl:value-of select="substring(concat(@name, ';', $name-padding), <xsl:value-of select="substring(concat(@name, ';', $name-padding),
1, $max-name-length)"/> 1, $max-name-length)"/>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
@ -348,7 +348,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:param name="indentation"/> <xsl:param name="indentation"/>
<xsl:param name="max-type-length" select="0"/> <xsl:param name="max-type-length" select="0"/>
<xsl:param name="max-name-length" select="0"/> <xsl:param name="max-name-length" select="0"/>
<!-- True if we should compact this typedef --> <!-- True if we should compact this typedef -->
<xsl:variable name="compact" <xsl:variable name="compact"
select="not (para|description) and ($boost.compact.typedef='1')"/> select="not (para|description) and ($boost.compact.typedef='1')"/>
@ -426,10 +426,10 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:call-template name="source-highlight"> <xsl:call-template name="source-highlight">
<xsl:with-param name="text"> <xsl:with-param name="text">
<xsl:apply-templates select="type/*|type/text()"/> <xsl:apply-templates select="type/*|type/text()"/>
</xsl:with-param> </xsl:with-param>
</xsl:call-template> </xsl:call-template>
<xsl:if test="not(@name = '')"> <xsl:if test="not(@name = '')">
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
@ -462,7 +462,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:template name="print.base.classes.multi"> <xsl:template name="print.base.classes.multi">
<xsl:param name="indentation"/> <xsl:param name="indentation"/>
<xsl:variable name="n" select="count(inherit)"/> <xsl:variable name="n" select="count(inherit)"/>
<xsl:for-each select="inherit"> <xsl:for-each select="inherit">
<!-- Indentation --> <!-- Indentation -->
@ -543,20 +543,20 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
</xsl:variable> </xsl:variable>
<xsl:choose> <xsl:choose>
<xsl:when test="$single-line-candidate and <xsl:when test="$single-line-candidate and
(string-length($single-line) + $indentation + 3 (string-length($single-line) + $indentation + 3
&lt; $max-columns)"> &lt; $max-columns)">
<xsl:text> : </xsl:text>
<xsl:call-template name="print.base.classes.single"/> <xsl:call-template name="print.base.classes.single"/>
<xsl:text> {</xsl:text> <xsl:text> {</xsl:text>
</xsl:when> </xsl:when>
<xsl:when test="$single-line-candidate and <xsl:when test="$single-line-candidate and
(string-length($single-line) + $base-indentation + 5 (string-length($single-line) + $base-indentation + 2
&lt; $max-columns)"> &lt; $max-columns)">
<xsl:text>&#10;</xsl:text> <xsl:text> :&#10;</xsl:text>
<xsl:call-template name="indent"> <xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$base-indentation"/> <xsl:with-param name="indentation" select="$base-indentation + 2"/>
</xsl:call-template> </xsl:call-template>
<xsl:text> : </xsl:text>
<xsl:call-template name="print.base.classes.single"/> <xsl:call-template name="print.base.classes.single"/>
<xsl:text>&#10;</xsl:text> <xsl:text>&#10;</xsl:text>
<xsl:call-template name="indent"> <xsl:call-template name="indent">
@ -582,7 +582,6 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:template match="inherit"> <xsl:template match="inherit">
<xsl:choose> <xsl:choose>
<xsl:when test="position()=1"> <xsl:when test="position()=1">
<xsl:text> : </xsl:text>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:text>, </xsl:text> <xsl:text>, </xsl:text>
@ -644,7 +643,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:with-param name="typedefs" select="$rest"/> <xsl:with-param name="typedefs" select="$rest"/>
<xsl:with-param name="max-length" select="$max-length"/> <xsl:with-param name="max-length" select="$max-length"/>
<xsl:with-param name="want-name" select="$want-name"/> <xsl:with-param name="want-name" select="$want-name"/>
</xsl:call-template> </xsl:call-template>
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
</xsl:when> </xsl:when>
@ -652,7 +651,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:value-of select="$max-length"/> <xsl:value-of select="$max-length"/>
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
</xsl:template> </xsl:template>
<xsl:template match="constructor" mode="synopsis"> <xsl:template match="constructor" mode="synopsis">
<xsl:param name="indentation"/> <xsl:param name="indentation"/>
@ -724,7 +723,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
</xsl:apply-templates> </xsl:apply-templates>
</xsl:if> </xsl:if>
<xsl:text>&#10;</xsl:text> <xsl:text>&#10;</xsl:text>
<!-- Class name --> <!-- Class name -->
<xsl:call-template name="indent"> <xsl:call-template name="indent">
<xsl:with-param name="indentation" select="$indentation"/> <xsl:with-param name="indentation" select="$indentation"/>
@ -735,13 +734,13 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:apply-templates select="specialization"/> <xsl:apply-templates select="specialization"/>
<xsl:choose> <xsl:choose>
<xsl:when test="inherit"> <xsl:when test="inherit">
<!-- Base class list (with opening brace) --> <!-- Base class list (with opening brace) -->
<xsl:call-template name="print.base.classes"> <xsl:call-template name="print.base.classes">
<xsl:with-param name="indentation" <xsl:with-param name="indentation"
select="string-length($class-key) + string-length(@name) select="string-length($class-key) + string-length(@name)
+ $indentation + 1"/> + $indentation + 1"/>
<xsl:with-param name="base-indentation" select="$indentation"/> <xsl:with-param name="base-indentation" select="$indentation"/>
</xsl:call-template> </xsl:call-template>
@ -773,7 +772,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:call-template name="highlight-comment"> <xsl:call-template name="highlight-comment">
<xsl:with-param name="text" select="'// types'"/> <xsl:with-param name="text" select="'// types'"/>
</xsl:call-template> </xsl:call-template>
<xsl:variable name="max-type-length"> <xsl:variable name="max-type-length">
<xsl:call-template name="find-max-type-length"/> <xsl:call-template name="find-max-type-length"/>
</xsl:variable> </xsl:variable>
@ -784,13 +783,13 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
</xsl:variable> </xsl:variable>
<xsl:apply-templates select="typedef" mode="synopsis"> <xsl:apply-templates select="typedef" mode="synopsis">
<xsl:with-param name="indentation" select="$indentation + 2"/> <xsl:with-param name="indentation" select="$indentation + 2"/>
<xsl:with-param name="max-type-length" <xsl:with-param name="max-type-length"
select="$max-type-length"/> select="$max-type-length"/>
<xsl:with-param name="max-name-length" <xsl:with-param name="max-name-length"
select="$max-name-length"/> select="$max-name-length"/>
</xsl:apply-templates> </xsl:apply-templates>
</xsl:if> </xsl:if>
<!-- Static constants --> <!-- Static constants -->
<xsl:if test="static-constant"> <xsl:if test="static-constant">
<xsl:text>&#10;</xsl:text> <xsl:text>&#10;</xsl:text>
@ -807,7 +806,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:with-param name="indentation" select="$indentation + 2"/> <xsl:with-param name="indentation" select="$indentation + 2"/>
</xsl:apply-templates> </xsl:apply-templates>
</xsl:if> </xsl:if>
<!-- Nested classes/structs/unions --> <!-- Nested classes/structs/unions -->
<xsl:apply-templates select="class|class-specialization| <xsl:apply-templates select="class|class-specialization|
struct|struct-specialization| struct|struct-specialization|
@ -827,8 +826,8 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
</xsl:call-template> </xsl:call-template>
<!-- Member functions --> <!-- Member functions -->
<xsl:apply-templates <xsl:apply-templates
select="method-group|method|overloaded-method" select="method-group|method|overloaded-method"
mode="synopsis"> mode="synopsis">
<xsl:with-param name="indentation" select="$indentation + 2"/> <xsl:with-param name="indentation" select="$indentation + 2"/>
</xsl:apply-templates> </xsl:apply-templates>
@ -900,41 +899,41 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:apply-templates select="para" mode="annotation"/> <xsl:apply-templates select="para" mode="annotation"/>
</xsl:if> </xsl:if>
<xsl:apply-templates select="description"/> <xsl:apply-templates select="description"/>
<xsl:apply-templates select="typedef" mode="reference"/> <xsl:apply-templates select="typedef" mode="reference"/>
<xsl:call-template name="construct-copy-destruct-reference"/> <xsl:call-template name="construct-copy-destruct-reference"/>
<xsl:apply-templates <xsl:apply-templates
select="method-group|method|overloaded-method" select="method-group|method|overloaded-method"
mode="reference"/> mode="reference"/>
<!-- Emit reference docs for nested classes --> <!-- Emit reference docs for nested classes -->
<xsl:apply-templates <xsl:apply-templates
select="class|class-specialization| select="class|class-specialization|
struct|struct-specialization| struct|struct-specialization|
union|union-specialization" union|union-specialization"
mode="namespace-reference"/> mode="namespace-reference"/>
<!-- Emit reference docs for nested enums --> <!-- Emit reference docs for nested enums -->
<xsl:apply-templates <xsl:apply-templates
select="enum" select="enum"
mode="namespace-reference"/> mode="namespace-reference"/>
<xsl:apply-templates select="free-function-group" mode="reference"> <xsl:apply-templates select="free-function-group" mode="reference">
<xsl:with-param name="class" select="@name"/> <xsl:with-param name="class" select="@name"/>
</xsl:apply-templates> </xsl:apply-templates>
<!-- Specializations of this class --> <!-- Specializations of this class -->
<!-- TBD: fix this. We should key off the class name and match <!-- TBD: fix this. We should key off the class name and match
fully-qualified names --> fully-qualified names -->
<xsl:variable name="name" select="@name"/> <xsl:variable name="name" select="@name"/>
<xsl:if test="local-name(.)='class' and <xsl:if test="local-name(.)='class' and
../class-specialization[@name=$name]"> ../class-specialization[@name=$name]">
<refsect2> <refsect2>
<title>Specializations</title> <title>Specializations</title>
<itemizedlist> <itemizedlist>
<xsl:apply-templates <xsl:apply-templates
select="../class-specialization[@name=$name]" select="../class-specialization[@name=$name]"
mode="specialization-list"/> mode="specialization-list"/>
</itemizedlist> </itemizedlist>
@ -974,7 +973,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
ancestor::union|ancestor::union-specialization"> ancestor::union|ancestor::union-specialization">
<!-- Spacing --> <!-- Spacing -->
<xsl:if <xsl:if
test="not(local-name(preceding-sibling::*[position()=1])=local-name(.))"> test="not(local-name(preceding-sibling::*[position()=1])=local-name(.))">
<xsl:text>&#10;</xsl:text> <xsl:text>&#10;</xsl:text>
</xsl:if> </xsl:if>
@ -1023,9 +1022,9 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:param name="indentation"/> <xsl:param name="indentation"/>
<!-- Spacing --> <!-- Spacing -->
<xsl:if <xsl:if
test="(not (local-name(preceding-sibling::*[position()=1])=local-name(.)) test="(not (local-name(preceding-sibling::*[position()=1])=local-name(.))
and (position() &gt; 1)) or and (position() &gt; 1)) or
not (para or description or not ($boost.compact.enum=1))"> not (para or description or not ($boost.compact.enum=1))">
<xsl:text>&#10;</xsl:text> <xsl:text>&#10;</xsl:text>
</xsl:if> </xsl:if>
@ -1082,7 +1081,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
</xsl:call-template> </xsl:call-template>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<xsl:call-template name="anchor"> <xsl:call-template name="anchor">
<xsl:with-param name="to"> <xsl:with-param name="to">
<xsl:call-template name="generate.id"> <xsl:call-template name="generate.id">
@ -1153,7 +1152,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:text>&#10;</xsl:text> <xsl:text>&#10;</xsl:text>
</xsl:if> </xsl:if>
<xsl:text>&#10;</xsl:text> <xsl:text>&#10;</xsl:text>
<xsl:call-template name="highlight-keyword"> <xsl:call-template name="highlight-keyword">
<xsl:with-param name="keyword" select="'enum'"/> <xsl:with-param name="keyword" select="'enum'"/>
@ -1168,12 +1167,12 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:with-param name="indentation" select="4 + string-length($header)"/> <xsl:with-param name="indentation" select="4 + string-length($header)"/>
</xsl:call-template> </xsl:call-template>
<xsl:text> };</xsl:text> <xsl:text> };</xsl:text>
</xsl:template> </xsl:template>
<!-- List enumeration values in a compact form e.g., <!-- List enumeration values in a compact form e.g.,
enum Name { value1 = foo, value2 = bar, ... }; enum Name { value1 = foo, value2 = bar, ... };
This routine prints only the enumeration values; the caller is This routine prints only the enumeration values; the caller is
responsible for printing everything outside the braces responsible for printing everything outside the braces
(inclusive). --> (inclusive). -->
<xsl:template name="type.enum.list.compact"> <xsl:template name="type.enum.list.compact">
@ -1193,7 +1192,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:if test="not($pos &gt; count(enumvalue))"> <xsl:if test="not($pos &gt; count(enumvalue))">
<xsl:variable name="value" select="enumvalue[position()=$pos]"/> <xsl:variable name="value" select="enumvalue[position()=$pos]"/>
<!-- Compute the string to be printed for this value --> <!-- Compute the string to be printed for this value -->
<xsl:variable name="result"> <xsl:variable name="result">
<xsl:value-of select="$prefix"/> <xsl:value-of select="$prefix"/>
@ -1217,8 +1216,8 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
<xsl:value-of select="$end"/> <xsl:value-of select="$end"/>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:value-of select="$indentation <xsl:value-of select="$indentation
+ string-length($result) + string-length($result)
- string-length($prefix)"/> - string-length($prefix)"/>
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
@ -1257,7 +1256,7 @@ Unknown type element "<xsl:value-of select="local-name(.)"/>" in type.display.na
print it. --> print it. -->
<xsl:if test="$value/default"> <xsl:if test="$value/default">
<xsl:text> = </xsl:text> <xsl:text> = </xsl:text>
<xsl:apply-templates <xsl:apply-templates
select="$value/default/*|$value/default/text()"/> select="$value/default/*|$value/default/text()"/>
</xsl:if> </xsl:if>