Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XalanVersion.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 #if !defined(XALANVERSION_HEADER_GUARD_1357924680)
20 #define XALANVERSION_HEADER_GUARD_1357924680
21 
22 // ---------------------------------------------------------------------------
23 // X A L A N V E R S I O N H E A D E R D O C U M E N T A T I O N
24 
25 /**
26  * User Documentation for Xalan Version Values:
27  *
28  *
29  *
30  * Xalan Notes:
31  *
32  * Xalan Committers Documentation:
33  *
34  * Xalan committers normally only need to modify one or two of the
35  * following macros:
36  *
37  * XALAN_VERSION_MAJOR
38  * XALAN_VERSION_MINOR
39  * XALAN_VERSION_REVISION
40  *
41  * The integer values of these macros define the Xalan version number. All
42  * other constants and preprocessor macros are automatically generated from
43  * these three definitions.
44  *
45  * Xalan User Documentation:
46  *
47  * The following sections in the user documentation have examples based upon
48  * the following three version input values:
49  *
50  * #define XALAN_VERSION_MAJOR 19
51  * #define XALAN_VERSION_MINOR 3
52  * #define XALAN_VERSION_REVISION 74
53  *
54  * The minor and revision (patch level) numbers have two digits of resolution
55  * which means that '3' becomes '03' in this example. This policy guarantees
56  * that when using preprocessor macros, version 19.3.74 will be greater than
57  * version 1.94.74 since the first will expand to 190374 and the second to
58  * 19474.
59  *
60  * Preprocessor Macros:
61  *
62  * _XALAN_VERSION defines the primary preprocessor macro that users will
63  * introduce into their code to perform conditional compilation where the
64  * version of Xalan is detected in order to enable or disable version
65  * specific capabilities. The value of _XALAN_VERSION for the above example
66  * will be 190374. To use it a user would perform an operation such as the
67  * following:
68  *
69  * #if _XALAN_VERSION >= 190374
70  * // code specific to new version of Xalan...
71  * #else
72  * // old code here...
73  * #endif
74  *
75  * XALAN_FULLVERSIONSTR is a preprocessor macro that expands to a string
76  * constant whose value, for the above example, will be "19_3_74".
77  *
78  * XALAN_FULLVERSIONDOT is a preprocessor macro that expands to a string
79  * constant whose value, for the above example, will be "19.3.74".
80  *
81  * XALAN_VERSIONSTR is a preprocessor macro that expands to a string
82  * constant whose value, for the above example, will be "19374". This
83  * particular macro is very dangerous if it were to be used for comparing
84  * version numbers since ordering will not be guaranteed.
85  *
86  * Xalan_DLLVersionStr is a preprocessor macro that expands to a string
87  * constant whose value, for the above example, will be "19_3_74". This
88  * macro is provided for backwards compatibility to pre-1.7 versions of
89  * Xalan.
90  *
91  * String Constants:
92  *
93  * gXalanVersionStr is a global string constant whose value corresponds to
94  * the value "19_3" for the above example.
95  *
96  * gXalanFullVersionStr is a global string constant whose value corresponds
97  * to the value "19_3_74" for the above example.
98  *
99  * Numeric Constants:
100  *
101  * gXalanMajVersion is a global integer constant whose value corresponds to
102  * the major version number. For the above example its value will be 19.
103  *
104  * gXalanMinVersion is a global integer constant whose value corresponds to
105  * the minor version number. For the above example its value will be 3.
106  *
107  * gXalanRevision is a global integer constant whose value corresponds to
108  * the revision (patch) version number. For the above example its value will
109  * be 74.
110  *
111  */
112 
113 // ---------------------------------------------------------------------------
114 // X A L A N V E R S I O N S P E C I F I C A T I O N
115 
116 /**
117  * MODIFY THESE NUMERIC VALUES TO COINCIDE WITH XALAN VERSION
118  * AND DO NOT MODIFY ANYTHING ELSE IN THIS VERSION HEADER FILE
119  */
120 
121 #define XALAN_VERSION_MAJOR 1
122 #define XALAN_VERSION_MINOR 11
123 #define XALAN_VERSION_REVISION 0
124 
125 
126 /** DO NOT MODIFY BELOW THIS LINE */
127 
128 /**
129  * MAGIC THAT AUTOMATICALLY GENERATES THE FOLLOWING:
130  *
131  * Xalan_DLLVersionStr, gXalanVersionStr, gXalanFullVersionStr,
132  * gXalanMajVersion, gXalanMinVersion, gXalanRevision
133  */
134 
135 // ---------------------------------------------------------------------------
136 // T W O A R G U M E N T C O N C A T E N A T I O N M A C R O S
137 
138 // two argument concatenation routines
139 #define CAT2_SEP_UNDERSCORE(a, b) #a "_" #b
140 #define CAT2_SEP_PERIOD(a, b) #a "." #b
141 #define CAT2_SEP_NIL(a, b) #a #b
142 #define CAT2_RAW_NUMERIC(a, b) a ## b
143 #define CAT2_RAW_NUMERIC_SEP_UNDERSCORE(a, b) a ## _ ## b
144 
145 // two argument macro invokers
146 #define INVK_CAT2_SEP_UNDERSCORE(a,b) CAT2_SEP_UNDERSCORE(a,b)
147 #define INVK_CAT2_SEP_PERIOD(a,b) CAT2_SEP_PERIOD(a,b)
148 #define INVK_CAT2_STR_SEP_NIL(a,b) CAT2_SEP_NIL(a,b)
149 #define INVK_CAT2_RAW_NUMERIC(a,b) CAT2_RAW_NUMERIC(a,b)
150 #define INVK_CAT2_RAW_NUMERIC_SEP_UNDERSCORE(a,b) CAT2_RAW_NUMERIC_SEP_UNDERSCORE(a,b)
151 
152 // ---------------------------------------------------------------------------
153 // T H R E E A R G U M E N T C O N C A T E N A T I O N M A C R O S
154 
155 // three argument concatenation routines
156 #define CAT3_SEP_UNDERSCORE(a, b, c) #a "_" #b "_" #c
157 #define CAT3_SEP_PERIOD(a, b, c) #a "." #b "." #c
158 #define CAT3_SEP_NIL(a, b, c) #a #b #c
159 #define CAT3_RAW_NUMERIC(a, b, c) a ## b ## c
160 #define CAT3_RAW_NUMERIC_SEP_UNDERSCORE(a, b, c) a ## _ ## b ## _ ## c
161 
162 // three argument macro invokers
163 #define INVK_CAT3_SEP_UNDERSCORE(a,b,c) CAT3_SEP_UNDERSCORE(a,b,c)
164 #define INVK_CAT3_SEP_PERIOD(a,b,c) CAT3_SEP_PERIOD(a,b,c)
165 #define INVK_CAT3_SEP_NIL(a,b,c) CAT3_SEP_NIL(a,b,c)
166 #define INVK_CAT3_RAW_NUMERIC(a,b,c) CAT3_RAW_NUMERIC(a,b,c)
167 #define INVK_CAT3_RAW_NUMERIC_SEP_UNDERSCORE(a,b,c) CAT3_RAW_NUMERIC_SEP_UNDERSCORE(a,b,c)
168 
169 // ---------------------------------------------------------------------------
170 // C A L C U L A T E V E R S I O N - E X P A N D E D F O R M
171 
172 #define MULTIPLY(factor,value) factor * value
173 #define CALC_EXPANDED_FORM(a,b,c) ( MULTIPLY(10000,a) + MULTIPLY(100,b) + MULTIPLY(1,c) )
174 
175 // ---------------------------------------------------------------------------
176 // X A L A N V E R S I O N I N F O R M A T I O N
177 
178 // Xalan version strings; these particular macros cannot be used for
179 // conditional compilation as they are not numeric constants
180 
181 #define XALAN_FULLVERSIONSTR INVK_CAT3_SEP_UNDERSCORE(XALAN_VERSION_MAJOR,XALAN_VERSION_MINOR,XALAN_VERSION_REVISION)
182 #define XALAN_FULLVERSIONDOT INVK_CAT3_SEP_PERIOD(XALAN_VERSION_MAJOR,XALAN_VERSION_MINOR,XALAN_VERSION_REVISION)
183 #define XALAN_FULLVERSIONNUM INVK_CAT3_SEP_NIL(XALAN_VERSION_MAJOR,XALAN_VERSION_MINOR,XALAN_VERSION_REVISION)
184 #define XALAN_VERSIONSTR INVK_CAT2_SEP_UNDERSCORE(XALAN_VERSION_MAJOR,XALAN_VERSION_MINOR)
185 
186 // Xalan C++ Namespace string, concatenated with full version string
187 #define XALAN_PRODUCT xalanc
188 #define XALAN_CPP_NAMESPACE INVK_CAT3_RAW_NUMERIC_SEP_UNDERSCORE(XALAN_PRODUCT,XALAN_VERSION_MAJOR,XALAN_VERSION_MINOR)
189 
190 
191 // original from Xalan header
192 #define Xalan_DLLVersionStr XALAN_FULLVERSIONSTR
193 
194 const char* const gXalanVersionStr = XALAN_VERSIONSTR;
199 
200 // Xalan version numeric constants that can be used for conditional
201 // compilation purposes.
202 
203 #define _XALAN_VERSION CALC_EXPANDED_FORM (XALAN_VERSION_MAJOR,XALAN_VERSION_MINOR,XALAN_VERSION_REVISION)
204 
205 #endif // XALANVERSION_HEADER_GUARD_1357924680
#define XALAN_FULLVERSIONSTR
#define XALAN_VERSIONSTR
const unsigned int gXalanMinVersion
#define XALAN_VERSION_MAJOR
User Documentation for Xalan Version Values:
const unsigned int gXalanMajVersion
#define XALAN_VERSION_MINOR
const char *const gXalanFullVersionStr
const unsigned int gXalanRevision
const char *const gXalanVersionStr
#define XALAN_VERSION_REVISION

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo