1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
<?xml version="1.0"?>
<!--
docbook-refentry-to-H-help.xsl:
XSLT stylesheet for generating command and sub-command
constants header for the built-in help.
-->
<!--
Copyright (C) 2006-2024 Oracle and/or its affiliates.
This file is part of VirtualBox base platform packages, as
available from https://www.virtualbox.org.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, in version 3 of the
License.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses>.
SPDX-License-Identifier: GPL-3.0-only
-->
<xsl:stylesheet
version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:str="http://xsltsl.org/string"
>
<xsl:import href="string.xsl"/>
<xsl:output method="text" version="1.0" encoding="utf-8" indent="yes"/>
<xsl:strip-space elements="*"/>
<xsl:param name="g_sMode" select="not-specified"/>
<!-- Default action, do nothing. -->
<xsl:template match="node()|@*"/>
<!--
Generate SCOPE enum for a refentry. We convert the
cmdsynopsisdiv/cmdsynopsis IDs into constants.
-->
<xsl:template match="refentry">
<xsl:variable name="RefEntry" select="."/>
<xsl:variable name="sRefEntryId" select="@id"/>
<xsl:variable name="sBaseNm">
<xsl:choose>
<xsl:when test="contains($sRefEntryId, '-')"> <!-- Multi level command. -->
<xsl:call-template name="str:to-upper">
<xsl:with-param name="text" select="translate(substring-after($sRefEntryId, '-'), '-', '_')"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise> <!-- Simple command. -->
<xsl:call-template name="str:to-upper">
<xsl:with-param name="text" select="translate($sRefEntryId, '-', '_')"/>
</xsl:call-template>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<xsl:choose>
<!-- Generate subcommand enums and defines -->
<xsl:when test="$g_sMode = 'subcmd'">
<!-- Start enum type and start off with the refentry id. -->
<xsl:text>
enum
{
#define HELP_SCOPE_</xsl:text>
<xsl:value-of select="$sBaseNm"/>
<xsl:value-of select="substring(' ',1,56 - string-length($sBaseNm) - 11)"/>
<xsl:text> RT_BIT_64(HELP_SCOPE_</xsl:text><xsl:value-of select="$sBaseNm"/><xsl:text>_BIT)
HELP_SCOPE_</xsl:text><xsl:value-of select="$sBaseNm"/><xsl:text>_BIT = 0</xsl:text>
<!-- Synopsis IDs -->
<xsl:for-each select="./refsynopsisdiv/cmdsynopsis[@id != concat('synopsis-', $sRefEntryId)]">
<xsl:variable name="sSubNm">
<xsl:text>HELP_SCOPE_</xsl:text>
<xsl:call-template name="str:to-upper">
<xsl:with-param name="text" select="translate(substring-after(substring-after(@id, '-'), '-'), '-', '_')"/>
</xsl:call-template>
</xsl:variable>
<xsl:text>,
#define </xsl:text>
<xsl:value-of select="$sSubNm"/>
<xsl:value-of select="substring(' ',1,56 - string-length($sSubNm))"/>
<xsl:text> RT_BIT_64(</xsl:text><xsl:value-of select="$sSubNm"/><xsl:text>_BIT)
</xsl:text>
<xsl:value-of select="$sSubNm"/><xsl:text>_BIT</xsl:text>
</xsl:for-each>
<!-- Add scoping info for refsect1 and refsect2 IDs that aren't part of the synopsis. -->
<xsl:for-each select=".//refsect1[@id] | .//refsect2[@id]">
<xsl:variable name="sThisId" select="@id"/>
<xsl:if test=" not($RefEntry[@id = $sThisId])
and not($RefEntry/refsynopsisdiv/cmdsynopsis[@id = concat('synopsis-', $sThisId)])
and not(contains($sThisId, '-see-also'))
and not(contains($sThisId, '-examples')) "> <!-- controlvm is too big, so skip these two -->
<xsl:variable name="sSubNm">
<xsl:text>HELP_SCOPE_</xsl:text>
<xsl:choose>
<xsl:when test="contains($sRefEntryId, '-')"> <!-- Multi level command. -->
<xsl:call-template name="str:to-upper">
<xsl:with-param name="text" select="translate(substring-after(@id, '-'), '-', '_')"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise> <!-- Simple command. -->
<xsl:call-template name="str:to-upper">
<xsl:with-param name="text" select="translate(@id, '-', '_')"/>
</xsl:call-template>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<xsl:text>,
#define </xsl:text>
<xsl:value-of select="$sSubNm"/>
<xsl:value-of select="substring(' ',1,56 - string-length($sSubNm))"/>
<xsl:text> RT_BIT_64(</xsl:text><xsl:value-of select="$sSubNm"/><xsl:text>_BIT)
</xsl:text>
<xsl:value-of select="$sSubNm"/><xsl:text>_BIT</xsl:text>
</xsl:if>
</xsl:for-each>
<!-- Done - complete the enum. -->
<xsl:text>,
HELP_SCOPE_</xsl:text><xsl:value-of select="$sBaseNm"/><xsl:text>_END
};
AssertCompile((int)HELP_SCOPE_</xsl:text><xsl:value-of select="$sBaseNm"/><xsl:text>_END >= 1);
AssertCompile((int)HELP_SCOPE_</xsl:text><xsl:value-of select="$sBaseNm"/><xsl:text>_END < 64);
AssertCompile(RT_BIT_64(HELP_SCOPE_</xsl:text><xsl:value-of select="$sBaseNm"/><xsl:text>_END - 1) & RTMSGREFENTRYSTR_SCOPE_MASK);
</xsl:text>
</xsl:when>
<!-- Generate command enum value. -->
<xsl:when test="$g_sMode = 'cmd'">
<xsl:text> HELP_CMD_</xsl:text><xsl:value-of select="$sBaseNm"/><xsl:text>,
</xsl:text>
</xsl:when>
<!-- Shouldn't happen. -->
<xsl:otherwise>
<xsl:message terminate="yes">Bad or missing g_sMode string parameter value.</xsl:message>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
</xsl:stylesheet>
|
