1 <?xml version="1.0" encoding="utf-8"?>
3 Copyright (c) 2002 Douglas Gregor <doug.gregor -at- gmail.com>
5 Distributed under the Boost Software License, Version 1.0.
6 (See accompanying file LICENSE_1_0.txt or copy at
7 http://www.boost.org/LICENSE_1_0.txt)
9 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
10 xmlns:exsl="http://exslt.org/common"
13 <!-- Maximum length of directory and file names is 31 characters.
14 '.html' uses 5 characters.
16 <xsl:param name="boost.max.id.part.length">26</xsl:param>
18 <!-- Generate an ID for the entity referenced -->
19 <xsl:template name="generate.id">
20 <xsl:param name="node" select="."/>
21 <xsl:apply-templates select="$node" mode="generate.id"/>
24 <xsl:template match="*" mode="generate.id">
25 <xsl:variable name="raw.id"><xsl:call-template name="object.id"/></xsl:variable>
26 <xsl:value-of select="translate($raw.id, '.', '_')"/>
27 <xsl:text>-bb</xsl:text>
30 <xsl:template name="postfix.id">
31 <xsl:variable name="raw.id"><xsl:call-template name="object.id"/></xsl:variable>
33 <xsl:when test="starts-with($raw.id, 'id-')">
34 <xsl:value-of select="translate(substring-after($raw.id, 'id-'), '.', '_')"/>
37 <xsl:value-of select="$raw.id"/>
42 <xsl:template name="strip-qualifiers-non-template">
43 <xsl:param name="name"/>
45 <xsl:when test="contains($name, '>')">
46 <xsl:call-template name="strip-qualifiers-non-template">
47 <xsl:with-param name="name" select="substring-after($name, '>')"/>
50 <xsl:when test="contains($name, '::')">
51 <xsl:call-template name="strip-qualifiers-non-template">
52 <xsl:with-param name="name" select="substring-after($name, '::')"/>
56 <xsl:value-of select="$name"/>
61 <xsl:template name="strip-balanced">
62 <xsl:param name="name"/>
63 <xsl:param name="open" select="'<'"/>
64 <xsl:param name="close" select="'>'"/>
65 <xsl:param name="depth" select="0"/>
67 <xsl:when test="contains($name, $open)
68 and not(contains(substring-before($name, $open), $close))">
69 <xsl:call-template name="strip-balanced">
70 <xsl:with-param name="name" select="substring-after($name, $open)"/>
71 <xsl:with-param name="open" select="$open"/>
72 <xsl:with-param name="close" select="$close"/>
73 <xsl:with-param name="depth" select="$depth + 1"/>
76 <xsl:when test="contains($name, $close) and ($depth > 1)">
77 <xsl:call-template name="strip-balanced">
78 <xsl:with-param name="name" select="substring-after($name, $close)"/>
79 <xsl:with-param name="open" select="$open"/>
80 <xsl:with-param name="close" select="$close"/>
81 <xsl:with-param name="depth" select="$depth - 1"/>
85 <xsl:value-of select="substring-after($name, $close)"/>
90 <xsl:template name="strip-qualifiers-template">
91 <xsl:param name="name"/>
93 <xsl:when test="contains($name, '::')
94 and not(contains(substring-before($name, '::'), '<'))">
95 <xsl:call-template name="strip-qualifiers-template">
96 <xsl:with-param name="name" select="substring-after($name, '::')"/>
100 <xsl:variable name="rest">
101 <xsl:call-template name="strip-balanced">
102 <xsl:with-param name="name" select="$name"/>
106 <xsl:when test="$rest != ''">
107 <xsl:call-template name="strip-qualifiers-template">
108 <xsl:with-param name="name" select="$rest"/>
112 <xsl:value-of select="$name"/>
119 <!-- Strip the qualifiers off a qualified name and return the unqualified
120 name. For instance, "boost::python::function" would become just
122 Must handle ns::foo -> foo
123 Must handle ns::foo<bar::baz> -> foo<bar::baz>
124 Must handle ns::foo<bar::baz>::nested -> nested
125 Must handle ns::foo<x>::bar<y> -> bar<y> -->
126 <xsl:template name="strip-qualifiers">
127 <xsl:param name="name"/>
129 <xsl:when test="substring($name, string-length($name)) = '>'">
130 <xsl:call-template name="strip-qualifiers-template">
131 <xsl:with-param name="name" select="$name"/>
135 <xsl:call-template name="strip-qualifiers-non-template">
136 <xsl:with-param name="name" select="$name"/>
142 <!-- Build the fully-qualified id of the given node -->
143 <xsl:template name="fully-qualified-id">
144 <xsl:param name="node"/>
146 <xsl:apply-templates select="$node" mode="fully-qualified-name">
147 <xsl:with-param name="is.id" select="true()"/>
148 </xsl:apply-templates>
151 <!-- Build the fully-qualified name of the given node -->
152 <xsl:template name="fully-qualified-name">
153 <xsl:param name="node"/>
154 <xsl:apply-templates select="$node" mode="fully-qualified-name"/>
157 <!-- Hack to make the node we are building the current node so that the
158 ancestor:: syntax will work -->
159 <xsl:template match="*" mode="fully-qualified-name">
160 <xsl:param name="is.id" select="false()" />
161 <xsl:call-template name="build-fully-qualified-name">
162 <xsl:with-param name="is.id" select="$is.id"/>
166 <!-- The real routine that builds a fully-qualified name for the current
168 <xsl:template name="build-fully-qualified-name">
169 <xsl:param name="is.id" select="false()" />
171 <!-- Determine the set of ancestor namespaces -->
172 <xsl:variable name="ancestors"
173 select="ancestor::namespace|
174 ancestor::class|ancestor::struct|ancestor::union|
175 ancestor::class-specialization|ancestor::struct-specialization|ancestor::union-specialization"/>
177 <xsl:for-each select="$ancestors">
178 <xsl:apply-templates select="." mode="fast-print-id-part">
179 <xsl:with-param name="is.id" select="$is.id"/>
180 </xsl:apply-templates>
182 <xsl:when test="$is.id"><xsl:text>.</xsl:text></xsl:when>
183 <xsl:otherwise><xsl:text>::</xsl:text></xsl:otherwise>
186 <xsl:apply-templates select="." mode="fast-print-id-part">
187 <xsl:with-param name="is.id" select="$is.id"/>
188 </xsl:apply-templates>
191 <xsl:variable name="elements-with-ids">
192 <xsl:apply-templates select="namespace|class|struct|union|class-specialization|struct-specialization|union-specialization"
193 mode="preprocess-ids"/>
196 <xsl:variable name="fast-elements" select="exsl:node-set($elements-with-ids)"/>
198 <xsl:template match="*" mode="preprocess-ids">
200 <xsl:attribute name="id">
201 <xsl:value-of select="generate-id()"/>
203 <xsl:attribute name="part-id">
204 <xsl:call-template name="print-id-part"/>
209 <xsl:template name="print-id-part">
210 <xsl:apply-templates select="." mode="print-id-part"/>
213 <xsl:template match="*" mode="fast-print-id-part">
214 <xsl:param name="is.id"/>
216 <xsl:when test="not($is.id)">
217 <xsl:apply-templates select="." mode="print-name"/>
219 <xsl:when test="$fast-elements[@id=generate-id()]">
220 <xsl:value-of select="$fast-elements[@id=generate-id()]/@part-id"/>
223 <xsl:apply-templates select="." mode="print-id-part">
224 <xsl:with-param name="is.id" select="$is.id"/>
225 </xsl:apply-templates>
230 <!-- Print the part of a fully qualified name for a single element -->
231 <xsl:template match="*" mode="print-id-part">
232 <xsl:param name="is.id"/>
234 <xsl:variable name="part">
235 <xsl:apply-templates select="." mode="print-name"/>
238 <xsl:variable name="unique-name">
239 <xsl:apply-templates select="." mode="unique.name"/>
245 string-length($part) > $boost.max.id.part.length or
247 translate($part, '.<>;\:*?"| ', '') != $part
249 <xsl:variable name="normalized" select="translate(normalize-space(translate($part, '.<>;\:*?"|_', ' ')), ' ', '_')"/>
250 <xsl:variable name="id"><xsl:call-template name="postfix.id"/></xsl:variable>
251 <xsl:value-of select =
253 substring($normalized, 1, $boost.max.id.part.length - string-length($id) - 1),
257 <xsl:value-of select="$part"/>
262 <!-- Override this if an id might not be unique -->
263 <xsl:template match="*" mode="unique.name">
264 <xsl:value-of select="1"/>
267 <xsl:template match="function|overloaded-function" mode="unique.name">
268 <xsl:variable name="func-name">
269 <xsl:call-template name="fully-qualified-name">
270 <xsl:with-param name="node" select="."/>
274 <!-- Count the number of elements with the same qualified name -->
275 <xsl:variable name="count-elements">
276 <xsl:for-each select="key('named-entities', translate(@name, $uppercase-letters, $lowercase-letters))">
277 <xsl:variable name="other-name">
278 <xsl:call-template name="fully-qualified-name">
279 <xsl:with-param name="node" select="."/>
282 <xsl:if test="$func-name = $other-name">
283 <xsl:text> </xsl:text>
288 <xsl:value-of select="number(string-length($count-elements) = 1)"/>
291 <!-- Print the name of the current node -->
292 <xsl:template match="*" mode="print-name">
293 <xsl:value-of select="@name"/>
296 <xsl:template match="template-arg" mode="print-name">
297 <xsl:if test="position() > 1">
298 <xsl:text>, </xsl:text>
300 <xsl:value-of select="text()"/>
301 <xsl:if test="@pack=1">
302 <xsl:text>...</xsl:text>
307 match="struct-specialization|class-specialization|union-specialization"
309 <xsl:value-of select="@name"/>
310 <xsl:text><</xsl:text>
311 <xsl:apply-templates select="specialization/template-arg" mode="print-name"/>
312 <xsl:text>></xsl:text>
315 <xsl:template name="concat-directives">
316 <xsl:param name="directives"/>
317 <xsl:for-each select="$directives">
318 <xsl:apply-templates select="." mode="print-name"/>
319 <xsl:text>::</xsl:text>
323 <xsl:template name="find-nodes-matching-name">
324 <!-- The name we are looking for -->
325 <xsl:param name="name"/>
327 <!-- The context in which this name occurs -->
328 <xsl:param name="context"/>
330 <!-- The node that we are checking against -->
331 <xsl:param name="nodes"/>
333 <!-- The set of using directives for this context node -->
334 <xsl:variable name="directives"
335 select="$context/ancestor::*/using-namespace |
336 $context/ancestor::namespace |
337 $context/ancestor::*/using-class |
338 $context/ancestor::class |
339 $context/ancestor::struct"/>
341 <xsl:variable name="directives-str">
342 <xsl:call-template name="concat-directives">
343 <xsl:with-param name="directives" select="$directives"/>
347 <xsl:apply-templates select="$nodes" mode="generate-cxx-links">
348 <xsl:with-param name="name" select="$name"/>
349 <xsl:with-param name="directives-str" select="$directives-str"/>
350 </xsl:apply-templates>
353 <xsl:template match="*" mode="generate-cxx-links">
354 <xsl:param name="name"/>
355 <xsl:param name="directives-str"/>
357 <xsl:variable name="node-name">
358 <xsl:call-template name="fully-qualified-name">
359 <xsl:with-param name="node" select="."/>
363 <xsl:variable name="leading-chars"
364 select="string-length($node-name) - string-length($name)"/>
366 <!-- Check if this node matches any visible namespace -->
367 <xsl:if test="string-length($node-name) >= string-length($name) and
368 substring($node-name, $leading-chars + 1,
369 string-length($name)) = $name">
370 <xsl:variable name="qualifiers"
371 select="substring($node-name, 1, $leading-chars)"/>
372 <xsl:if test="contains($directives-str, $qualifiers)">
373 <xsl:variable name="myid">
374 <xsl:call-template name="generate.id">
375 <xsl:with-param name="node" select="."/>
379 <xsl:attribute name="id">
380 <xsl:value-of select="$myid"/>
382 <xsl:attribute name="namespace">
383 <xsl:value-of select="$qualifiers"/>
385 <xsl:text>random text</xsl:text>
391 <xsl:template name="cxx-link-name">
392 <!-- The actual lookup node -->
393 <xsl:param name="lookup"/>
395 <!-- The type of name to lookup (e.g., class) -->
396 <xsl:param name="type"/>
398 <!-- The name we are looking for -->
399 <xsl:param name="name"/>
401 <!-- The name we will display -->
402 <xsl:param name="display-name"/>
404 <!-- The name we are looking for (unqualified)-->
405 <xsl:param name="unqualified-name"/>
407 <!-- The list of nodes that match the lookup node in both name and type -->
408 <xsl:param name="nodes"/>
410 <!-- Filter the nodes to leave only the ones that are in scope. -->
411 <xsl:variable name="matches1">
412 <xsl:call-template name="find-nodes-matching-name">
413 <xsl:with-param name="name" select="$name"/>
414 <xsl:with-param name="nodes" select="$nodes"/>
415 <xsl:with-param name="context" select="$lookup"/>
419 <xsl:variable name="matches" select="exsl:node-set($matches1)//cxx-link-helper"/>
422 <xsl:when test="count($matches) = 0">
424 <xsl:text>Cannot find </xsl:text>
425 <xsl:value-of select="$type"/>
426 <xsl:text> named '</xsl:text>
427 <xsl:value-of select="$name"/>
428 <xsl:text>'</xsl:text>
430 <xsl:value-of select="$display-name"/>
433 <!-- If we found more than one, print a message and take the first -->
434 <xsl:if test="count($matches) > 1">
436 <xsl:text>Reference to </xsl:text>
437 <xsl:value-of select="$type"/>
438 <xsl:text> '</xsl:text>
439 <xsl:value-of select="$name"/>
440 <xsl:text>' is ambiguous. Found:</xsl:text>
441 <xsl:for-each select="$matches">
443 Match in namespace ::</xsl:text>
444 <xsl:value-of select="@namespace"/>
448 <xsl:call-template name="internal-link">
449 <xsl:with-param name="to">
450 <xsl:value-of select="$matches[position() = 1]/@id"/>
452 <xsl:with-param name="text" select="$display-name"/>