2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
22 * @file xmltooling/base.h
24 * Base header file definitions.
25 * Must be included prior to including any other header.
28 #ifndef __xmltooling_base_h__
29 #define __xmltooling_base_h__
33 /* Required for sprintf, used by integer XML attribute macros. */
36 #if defined (_MSC_VER) || defined(__BORLANDC__)
37 #include <xmltooling/config_pub_win32.h>
39 #include <xmltooling/config_pub.h>
42 #ifdef XMLTOOLING_LITE
43 # define XMLTOOLING_NO_XMLSEC 1
50 #if defined(XMLTOOLING_NO_XMLSEC) || !defined(HAVE_XSECSIZE_T)
51 # ifdef XMLTOOLING_XERCESC_64BITSAFE
52 # include <xercesc/util/XercesDefs.hpp>
53 typedef XMLSize_t xsecsize_t;
55 typedef unsigned int xsecsize_t;
59 // Windows and GCC4 Symbol Visibility Macros
61 #define XMLTOOL_IMPORT __declspec(dllimport)
62 #define XMLTOOL_EXPORT __declspec(dllexport)
63 #define XMLTOOL_DLLLOCAL
64 #define XMLTOOL_DLLPUBLIC
66 #define XMLTOOL_IMPORT
67 #ifdef GCC_HASCLASSVISIBILITY
68 #define XMLTOOL_EXPORT __attribute__ ((visibility("default")))
69 #define XMLTOOL_DLLLOCAL __attribute__ ((visibility("hidden")))
70 #define XMLTOOL_DLLPUBLIC __attribute__ ((visibility("default")))
72 #define XMLTOOL_EXPORT
73 #define XMLTOOL_DLLLOCAL
74 #define XMLTOOL_DLLPUBLIC
78 // Define XMLTOOL_API for DLL builds
79 #ifdef XMLTOOLING_EXPORTS
80 #define XMLTOOL_API XMLTOOL_EXPORT
82 #define XMLTOOL_API XMLTOOL_IMPORT
85 // Throwable classes must always be visible on GCC in all binaries
87 #define XMLTOOL_EXCEPTIONAPI(api) api
88 #elif defined(GCC_HASCLASSVISIBILITY)
89 #define XMLTOOL_EXCEPTIONAPI(api) XMLTOOL_EXPORT
91 #define XMLTOOL_EXCEPTIONAPI(api)
95 #define XMLTOOLING_DOXYGEN(desc) /##** desc */
97 #define XMLTOOLING_DOXYGEN(desc)
101 * Blocks copy c'tor and assignment operator for a class.
103 #define MAKE_NONCOPYABLE(type) \
106 type& operator=(const type&)
112 #define UNICODE_LITERAL_1(a) {xercesc::chLatin_##a, xercesc::chNull}
113 #define UNICODE_LITERAL_2(a,b) {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chNull}
114 #define UNICODE_LITERAL_3(a,b,c) {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chNull}
115 #define UNICODE_LITERAL_4(a,b,c,d) {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chNull}
116 #define UNICODE_LITERAL_5(a,b,c,d,e) \
117 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chNull}
118 #define UNICODE_LITERAL_6(a,b,c,d,e,f) \
119 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chNull}
120 #define UNICODE_LITERAL_7(a,b,c,d,e,f,g) \
121 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chNull}
122 #define UNICODE_LITERAL_8(a,b,c,d,e,f,g,h) \
123 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chNull}
124 #define UNICODE_LITERAL_9(a,b,c,d,e,f,g,h,i) \
125 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, xercesc::chNull}
126 #define UNICODE_LITERAL_10(a,b,c,d,e,f,g,h,i,j) \
127 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
128 xercesc::chLatin_##j, xercesc::chNull}
129 #define UNICODE_LITERAL_11(a,b,c,d,e,f,g,h,i,j,k) \
130 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
131 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chNull}
132 #define UNICODE_LITERAL_12(a,b,c,d,e,f,g,h,i,j,k,l) \
133 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
134 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chNull}
135 #define UNICODE_LITERAL_13(a,b,c,d,e,f,g,h,i,j,k,l,m) \
136 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
137 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chNull}
138 #define UNICODE_LITERAL_14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) \
139 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
140 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chNull}
141 #define UNICODE_LITERAL_15(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o) \
142 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
143 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chNull}
144 #define UNICODE_LITERAL_16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) \
145 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
146 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chNull}
147 #define UNICODE_LITERAL_17(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q) \
148 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
149 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chNull}
150 #define UNICODE_LITERAL_18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) \
151 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
152 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, xercesc::chNull}
153 #define UNICODE_LITERAL_19(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s) \
154 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
155 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
156 xercesc::chLatin_##s, xercesc::chNull}
157 #define UNICODE_LITERAL_20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) \
158 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
159 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
160 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chNull}
161 #define UNICODE_LITERAL_21(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u) \
162 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
163 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
164 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chNull}
165 #define UNICODE_LITERAL_22(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v) \
166 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
167 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
168 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chNull}
169 #define UNICODE_LITERAL_23(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w) \
170 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
171 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
172 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chNull}
173 #define UNICODE_LITERAL_24(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x) \
174 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
175 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
176 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chNull}
177 #define UNICODE_LITERAL_25(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y) \
178 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
179 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
180 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chNull}
181 #define UNICODE_LITERAL_26(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z) \
182 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
183 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
184 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, xercesc::chNull}
185 #define UNICODE_LITERAL_27(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,aa) \
186 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
187 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
188 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, \
189 xercesc::chLatin_##aa, xercesc::chNull}
190 #define UNICODE_LITERAL_28(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,aa,bb) \
191 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
192 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
193 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, \
194 xercesc::chLatin_##aa, xercesc::chLatin_##bb, xercesc::chNull}
195 #define UNICODE_LITERAL_29(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,aa,bb,cc) \
196 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
197 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
198 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, \
199 xercesc::chLatin_##aa, xercesc::chLatin_##bb, xercesc::chLatin_##cc, xercesc::chNull}
200 #define UNICODE_LITERAL_30(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,aa,bb,cc,dd) \
201 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
202 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
203 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, \
204 xercesc::chLatin_##aa, xercesc::chLatin_##bb, xercesc::chLatin_##cc, xercesc::chLatin_##dd, xercesc::chNull}
205 #define UNICODE_LITERAL_31(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,aa,bb,cc,dd,ee) \
206 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
207 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
208 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, \
209 xercesc::chLatin_##aa, xercesc::chLatin_##bb, xercesc::chLatin_##cc, xercesc::chLatin_##dd, xercesc::chLatin_##ee, xercesc::chNull}
210 #define UNICODE_LITERAL_32(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,aa,bb,cc,dd,ee,ff) \
211 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
212 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
213 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, \
214 xercesc::chLatin_##aa, xercesc::chLatin_##bb, xercesc::chLatin_##cc, xercesc::chLatin_##dd, xercesc::chLatin_##ee, xercesc::chLatin_##ff, xercesc::chNull}
215 #define UNICODE_LITERAL_33(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,aa,bb,cc,dd,ee,ff,gg) \
216 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
217 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
218 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, \
219 xercesc::chLatin_##aa, xercesc::chLatin_##bb, xercesc::chLatin_##cc, xercesc::chLatin_##dd, xercesc::chLatin_##ee, xercesc::chLatin_##ff, xercesc::chLatin_##gg, xercesc::chNull}
220 #define UNICODE_LITERAL_34(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,aa,bb,cc,dd,ee,ff,gg,hh) \
221 {xercesc::chLatin_##a, xercesc::chLatin_##b, xercesc::chLatin_##c, xercesc::chLatin_##d, xercesc::chLatin_##e, xercesc::chLatin_##f, xercesc::chLatin_##g, xercesc::chLatin_##h, xercesc::chLatin_##i, \
222 xercesc::chLatin_##j, xercesc::chLatin_##k, xercesc::chLatin_##l, xercesc::chLatin_##m, xercesc::chLatin_##n, xercesc::chLatin_##o, xercesc::chLatin_##p, xercesc::chLatin_##q, xercesc::chLatin_##r, \
223 xercesc::chLatin_##s, xercesc::chLatin_##t, xercesc::chLatin_##u, xercesc::chLatin_##v, xercesc::chLatin_##w, xercesc::chLatin_##x, xercesc::chLatin_##y, xercesc::chLatin_##z, \
224 xercesc::chLatin_##aa, xercesc::chLatin_##bb, xercesc::chLatin_##cc, xercesc::chLatin_##dd, xercesc::chLatin_##ee, xercesc::chLatin_##ff, xercesc::chLatin_##gg, xercesc::chLatin_##hh, xercesc::chNull}
225 #endif /* DOXYGEN_SKIP */
228 * Begins the declaration of an XMLObject specialization for an abstract element/type.
229 * Basic boilerplate includes a protected constructor, empty virtual destructor,
230 * and Unicode constants for the default associated element's name and prefix.
232 * @param linkage linkage specifier for the class
233 * @param cname the name of the class to declare
234 * @param base the base class to derive from using public virtual inheritance
235 * @param desc documentation comment for class
237 #define DECL_XMLOBJECT_ABSTRACT(linkage,cname,base,desc) \
238 XMLTOOLING_DOXYGEN(desc) \
239 class linkage cname : public virtual base { \
243 virtual ~cname() {} \
244 XMLTOOLING_DOXYGEN(Element local name) \
245 static const XMLCh LOCAL_NAME[]; \
249 * Begins the declaration of an XMLObject specialization.
250 * Basic boilerplate includes a protected constructor, empty virtual destructor,
251 * and Unicode constants for the default associated element's name and prefix.
253 * @param linkage linkage specifier for the class
254 * @param cname the name of the class to declare
255 * @param base the base class to derive from using public virtual inheritance
256 * @param desc documentation comment for class
258 #define BEGIN_XMLOBJECT(linkage,cname,base,desc) \
259 XMLTOOLING_DOXYGEN(desc) \
260 class linkage cname : public virtual base { \
264 virtual ~cname() {} \
265 XMLTOOLING_DOXYGEN(Type-specific clone method.) \
266 virtual cname* clone##cname() const=0; \
267 XMLTOOLING_DOXYGEN(Element local name) \
268 static const XMLCh LOCAL_NAME[]
271 * Begins the declaration of an XMLObject specialization with two base classes.
272 * Basic boilerplate includes a protected constructor, empty virtual destructor,
273 * and Unicode constants for the default associated element's name and prefix.
275 * @param linkage linkage specifier for the class
276 * @param cname the name of the class to declare
277 * @param base the first base class to derive from using public virtual inheritance
278 * @param base2 the second base class to derive from using public virtual inheritance
279 * @param desc documentation comment for class
281 #define BEGIN_XMLOBJECT2(linkage,cname,base,base2,desc) \
282 XMLTOOLING_DOXYGEN(desc) \
283 class linkage cname : public virtual base, public virtual base2 { \
287 virtual ~cname() {} \
288 XMLTOOLING_DOXYGEN(Type-specific clone method.) \
289 virtual cname* clone##cname() const=0; \
290 XMLTOOLING_DOXYGEN(Element local name) \
291 static const XMLCh LOCAL_NAME[]
294 * Begins the declaration of an XMLObject specialization with three base classes.
295 * Basic boilerplate includes a protected constructor, empty virtual destructor,
296 * and Unicode constants for the default associated element's name and prefix.
298 * @param linkage linkage specifier for the class
299 * @param cname the name of the class to declare
300 * @param base the first base class to derive from using public virtual inheritance
301 * @param base2 the second base class to derive from using public virtual inheritance
302 * @param base3 the third base class to derive from using public virtual inheritance
303 * @param desc documentation comment for class
305 #define BEGIN_XMLOBJECT3(linkage,cname,base,base2,base3,desc) \
306 XMLTOOLING_DOXYGEN(desc) \
307 class linkage cname : public virtual base, public virtual base2, public virtual base3 { \
311 virtual ~cname() {} \
312 XMLTOOLING_DOXYGEN(Type-specific clone method.) \
313 virtual cname* clone##cname() const=0; \
314 XMLTOOLING_DOXYGEN(Element local name) \
315 static const XMLCh LOCAL_NAME[]
318 * Begins the declaration of an XMLObject specialization with four base classes.
319 * Basic boilerplate includes a protected constructor, empty virtual destructor,
320 * and Unicode constants for the default associated element's name and prefix.
322 * @param linkage linkage specifier for the class
323 * @param cname the name of the class to declare
324 * @param base the first base class to derive from using public virtual inheritance
325 * @param base2 the second base class to derive from using public virtual inheritance
326 * @param base3 the third base class to derive from using public virtual inheritance
327 * @param base4 the fourth base class to derive from using public virtual inheritance
328 * @param desc documentation comment for class
330 #define BEGIN_XMLOBJECT4(linkage,cname,base,base2,base3,base4,desc) \
331 XMLTOOLING_DOXYGEN(desc) \
332 class linkage cname : public virtual base, public virtual base2, public virtual base3, public virtual base4 { \
336 virtual ~cname() {} \
337 XMLTOOLING_DOXYGEN(Type-specific clone method.) \
338 virtual cname* clone##cname() const=0; \
339 XMLTOOLING_DOXYGEN(Element local name) \
340 static const XMLCh LOCAL_NAME[]
343 * Begins the declaration of an XMLObject specialization with five base classes.
344 * Basic boilerplate includes a protected constructor, empty virtual destructor,
345 * and Unicode constants for the default associated element's name and prefix.
347 * @param linkage linkage specifier for the class
348 * @param cname the name of the class to declare
349 * @param base the first base class to derive from using public virtual inheritance
350 * @param base2 the second base class to derive from using public virtual inheritance
351 * @param base3 the third base class to derive from using public virtual inheritance
352 * @param base4 the fourth base class to derive from using public virtual inheritance
353 * @param base5 the fifth base class to derive from using public virtual inheritance
354 * @param desc documentation comment for class
356 #define BEGIN_XMLOBJECT5(linkage,cname,base,base2,base3,base4,base5,desc) \
357 XMLTOOLING_DOXYGEN(desc) \
358 class linkage cname : public virtual base, public virtual base2, public virtual base3, public virtual base4, public virtual base5 { \
362 virtual ~cname() {} \
363 XMLTOOLING_DOXYGEN(Type-specific clone method.) \
364 virtual cname* clone##cname() const=0; \
365 XMLTOOLING_DOXYGEN(Element local name) \
366 static const XMLCh LOCAL_NAME[]
369 * Ends the declaration of an XMLObject specialization.
371 #define END_XMLOBJECT }
374 * Declares a static variable holding the XMLObject's element QName.
376 #define DECL_ELEMENT_QNAME \
378 XMLTOOLING_DOXYGEN(Element QName) \
379 static xmltooling::QName ELEMENT_QNAME
382 * Declares a static variable holding the XMLObject's schema type QName.
384 #define DECL_TYPE_QNAME \
386 XMLTOOLING_DOXYGEN(Type QName) \
387 static xmltooling::QName TYPE_QNAME
390 * Implements a static variable holding an XMLObject's element QName.
392 * @param cname the name of the XMLObject specialization
393 * @param namespaceURI the XML namespace of the default associated element
394 * @param namespacePrefix the XML namespace prefix of the default associated element
396 #define IMPL_ELEMENT_QNAME(cname,namespaceURI,namespacePrefix) \
397 xmltooling::QName cname::ELEMENT_QNAME(namespaceURI,cname::LOCAL_NAME,namespacePrefix)
400 * Implements a static variable holding an XMLObject's schema type QName.
402 * @param cname the name of the XMLObject specialization
403 * @param namespaceURI the XML namespace of the default associated element
404 * @param namespacePrefix the XML namespace prefix of the default associated element
406 #define IMPL_TYPE_QNAME(cname,namespaceURI,namespacePrefix) \
407 xmltooling::QName cname::TYPE_QNAME(namespaceURI,cname::TYPE_NAME,namespacePrefix)
410 * Declares abstract set method for a typed XML attribute.
411 * The get method is omitted.
413 * @param proper the proper name of the attribute
414 * @param upcased the upcased name of the attribute
415 * @param type the attribute's data type
417 #define DECL_INHERITED_XMLOBJECT_ATTRIB(proper,upcased,type) \
419 XMLTOOLING_DOXYGEN(proper attribute name) \
420 static const XMLCh upcased##_ATTRIB_NAME[]; \
421 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
422 virtual void set##proper(const type* proper)=0
425 * Declares abstract get/set methods for a typed XML attribute.
427 * @param proper the proper name of the attribute
428 * @param upcased the upcased name of the attribute
429 * @param type the attribute's data type
431 #define DECL_XMLOBJECT_ATTRIB(proper,upcased,type) \
433 XMLTOOLING_DOXYGEN(proper attribute name) \
434 static const XMLCh upcased##_ATTRIB_NAME[]; \
435 XMLTOOLING_DOXYGEN(Returns the proper attribute.) \
436 virtual const type* get##proper() const=0; \
437 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
438 virtual void set##proper(const type* proper)=0
441 * Declares abstract set method for a string XML attribute.
442 * The get method is omitted.
444 * @param proper the proper name of the attribute
445 * @param upcased the upcased name of the attribute
447 #define DECL_INHERITED_STRING_ATTRIB(proper,upcased) \
448 DECL_INHERITED_XMLOBJECT_ATTRIB(proper,upcased,XMLCh)
451 * Declares abstract get/set methods for a string XML attribute.
453 * @param proper the proper name of the attribute
454 * @param upcased the upcased name of the attribute
456 #define DECL_STRING_ATTRIB(proper,upcased) \
457 DECL_XMLOBJECT_ATTRIB(proper,upcased,XMLCh)
460 * Declares abstract set method for a DateTime XML attribute.
461 * The get method is omitted.
463 * @param proper the proper name of the attribute
464 * @param upcased the upcased name of the attribute
466 #define DECL_INHERITED_DATETIME_ATTRIB(proper,upcased) \
467 DECL_INHERITED_XMLOBJECT_ATTRIB(proper,upcased,xmltooling::DateTime); \
468 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
469 virtual void set##proper(time_t proper)=0; \
470 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
471 virtual void set##proper(const XMLCh* proper)=0
474 * Declares abstract get/set methods for a DateTime XML attribute.
476 * @param proper the proper name of the attribute
477 * @param upcased the upcased name of the attribute
479 #define DECL_DATETIME_ATTRIB(proper,upcased) \
480 DECL_XMLOBJECT_ATTRIB(proper,upcased,xmltooling::DateTime); \
481 XMLTOOLING_DOXYGEN(Returns the proper attribute in epoch form.) \
482 virtual time_t get##proper##Epoch() const=0; \
483 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
484 virtual void set##proper(time_t proper)=0; \
485 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
486 virtual void set##proper(const XMLCh* proper)=0
489 * Declares abstract set method for an integer XML attribute.
490 * The get method is omitted.
492 * @param proper the proper name of the attribute
493 * @param upcased the upcased name of the attribute
495 #define DECL_INHERITED_INTEGER_ATTRIB(proper,upcased) \
497 XMLTOOLING_DOXYGEN(proper attribute name) \
498 static const XMLCh upcased##_ATTRIB_NAME[]; \
499 XMLTOOLING_DOXYGEN(Sets the proper attribute using a string value.) \
500 virtual void set##proper(const XMLCh* proper)=0; \
501 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
502 virtual void set##proper(int proper)=0
505 * Declares abstract get/set methods for an integer XML attribute.
507 * @param proper the proper name of the attribute
508 * @param upcased the upcased name of the attribute
510 #define DECL_INTEGER_ATTRIB(proper,upcased) \
512 XMLTOOLING_DOXYGEN(proper attribute name) \
513 static const XMLCh upcased##_ATTRIB_NAME[]; \
514 XMLTOOLING_DOXYGEN(Returns the proper attribute after a NULL indicator.) \
515 virtual std::pair<bool,int> get##proper() const=0; \
516 XMLTOOLING_DOXYGEN(Sets the proper attribute using a string value.) \
517 virtual void set##proper(const XMLCh* proper)=0; \
518 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
519 virtual void set##proper(int proper)=0
522 * Declares abstract get/set methods for a boolean XML attribute.
524 * @param proper the proper name of the attribute
525 * @param upcased the upcased name of the attribute
526 * @param def the default/presumed value, if no explicit value has been set
528 #define DECL_BOOLEAN_ATTRIB(proper,upcased,def) \
530 XMLTOOLING_DOXYGEN(proper attribute name) \
531 static const XMLCh upcased##_ATTRIB_NAME[]; \
532 XMLTOOLING_DOXYGEN(Returns the proper attribute or def if not set.) \
533 bool proper() const { \
534 switch (get##proper()) { \
535 case xmlconstants::XML_BOOL_TRUE: \
536 case xmlconstants::XML_BOOL_ONE: \
538 case xmlconstants::XML_BOOL_FALSE: \
539 case xmlconstants::XML_BOOL_ZERO: \
545 XMLTOOLING_DOXYGEN(Returns the proper attribute as an explicit enumerated value.) \
546 virtual xmlconstants::xmltooling_bool_t get##proper() const=0; \
547 XMLTOOLING_DOXYGEN(Sets the proper attribute using an enumerated value.) \
548 virtual void proper(xmlconstants::xmltooling_bool_t value)=0; \
549 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
550 void proper(bool value) { \
551 proper(value ? xmlconstants::XML_BOOL_ONE : xmlconstants::XML_BOOL_ZERO); \
553 XMLTOOLING_DOXYGEN(Sets the proper attribute using a string constant.) \
554 void set##proper(const XMLCh* value) { \
557 case xercesc::chLatin_t: \
558 proper(xmlconstants::XML_BOOL_TRUE); \
560 case xercesc::chLatin_f: \
561 proper(xmlconstants::XML_BOOL_FALSE); \
563 case xercesc::chDigit_1: \
564 proper(xmlconstants::XML_BOOL_ONE); \
566 case xercesc::chDigit_0: \
567 proper(xmlconstants::XML_BOOL_ZERO); \
570 proper(xmlconstants::XML_BOOL_NULL); \
574 proper(xmlconstants::XML_BOOL_NULL); \
578 * Implements get/set methods and a private member for a typed XML attribute.
580 * @param proper the proper name of the attribute
581 * @param type the attribute's data type
583 #define IMPL_XMLOBJECT_ATTRIB(proper,type) \
587 const type* get##proper() const { \
590 void set##proper(const type* proper) { \
591 m_##proper = prepareForAssignment(m_##proper,proper); \
595 * Implements get/set methods and a private member for a string XML attribute.
597 * @param proper the proper name of the attribute
599 #define IMPL_STRING_ATTRIB(proper) \
600 IMPL_XMLOBJECT_ATTRIB(proper,XMLCh)
603 * Implements get/set methods and a private member for a string XML attribute,
604 * plus a getXMLID override.
606 * @param proper the proper name of the attribute
608 #define IMPL_ID_ATTRIB(proper) \
609 IMPL_XMLOBJECT_ATTRIB(proper,XMLCh) \
610 const XMLCh* getXMLID() const { \
615 * Implements get/set methods and a private member for a string XML attribute,
616 * plus a getXMLID override and attribute node clearance when DOM is dropped.
618 * @param proper the proper name of the attribute
619 * @param ucase the upcased name of the attribute
620 * @param namespaceURI the XML namespace of the attribute
622 #define IMPL_ID_ATTRIB_EX(proper, ucase, namespaceURI) \
623 IMPL_XMLOBJECT_ATTRIB(proper,XMLCh) \
624 const XMLCh* getXMLID() const { \
627 void releaseDOM() const { \
629 getDOM()->removeAttributeNS(namespaceURI, ucase##_ATTRIB_NAME); \
630 AbstractDOMCachingXMLObject::releaseDOM(); \
634 * Implements get/set methods and a private member for a DateTime XML attribute.
636 * @param proper the proper name of the attribute
637 * @param fallback epoch to return when attribute is NULL
639 #define IMPL_DATETIME_ATTRIB(proper,fallback) \
640 IMPL_DATETIME_ATTRIB_EX(proper,fallback,false)
643 * Implements get/set methods and a private member for a duration-valued DateTime XML attribute.
645 * @param proper the proper name of the attribute
646 * @param fallback epoch to return when attribute is NULL
648 #define IMPL_DURATION_ATTRIB(proper,fallback) \
649 IMPL_DATETIME_ATTRIB_EX(proper,fallback,true)
652 * Implements get/set methods and a private member for a DateTime XML attribute.
654 * @param proper the proper name of the attribute
655 * @param fallback epoch to return when attribute is NULL
656 * @param duration true iff the attribute should be handled as a duration
658 #define IMPL_DATETIME_ATTRIB_EX(proper,fallback,duration) \
660 DateTime* m_##proper; \
661 time_t m_##proper##Epoch; \
663 const DateTime* get##proper() const { \
666 time_t get##proper##Epoch() const { \
667 return m_##proper ? m_##proper##Epoch : fallback; \
669 void set##proper(const DateTime* proper) { \
670 m_##proper = prepareForAssignment(m_##proper,proper); \
672 m_##proper##Epoch=m_##proper->getEpoch(duration); \
674 void set##proper(time_t proper) { \
675 m_##proper = prepareForAssignment(m_##proper,proper,duration); \
676 m_##proper##Epoch = proper; \
678 void set##proper(const XMLCh* proper) { \
679 m_##proper = prepareForAssignment(m_##proper,proper,duration); \
681 m_##proper##Epoch=m_##proper->getEpoch(duration); \
685 * Implements get/set methods and a private member for an integer XML attribute.
687 * @param proper the proper name of the attribute
689 #define IMPL_INTEGER_ATTRIB(proper) \
693 pair<bool,int> get##proper() const { \
694 return make_pair((m_##proper!=nullptr),(m_##proper!=nullptr ? xercesc::XMLString::parseInt(m_##proper): 0)); \
696 void set##proper(const XMLCh* proper) { \
697 m_##proper = prepareForAssignment(m_##proper,proper); \
699 void set##proper(int proper) { \
700 char buf##proper[64]; \
701 std::sprintf(buf##proper,"%d",proper); \
702 xmltooling::auto_ptr_XMLCh wide##proper(buf##proper); \
703 set##proper(wide##proper.get()); \
707 * Implements get/set methods and a private member for a boolean XML attribute.
709 * @param proper the proper name of the attribute
711 #define IMPL_BOOLEAN_ATTRIB(proper) \
713 xmlconstants::xmltooling_bool_t m_##proper; \
715 xmlconstants::xmltooling_bool_t get##proper() const { \
718 void proper(xmlconstants::xmltooling_bool_t value) { \
719 if (m_##proper != value) { \
720 releaseThisandParentDOM(); \
721 m_##proper = value; \
726 * Implements get/set methods and a private member for a typed, qualified XML attribute.
728 * @param proper the proper name of the attribute
729 * @param type the attribute's data type
731 #define IMPL_XMLOBJECT_FOREIGN_ATTRIB(proper,type) \
733 XMLCh* m_##proper##Prefix; \
736 const type* get##proper() const { \
739 void set##proper(const type* proper) { \
740 m_##proper = prepareForAssignment(m_##proper,proper); \
741 xercesc::XMLString::release(&m_##proper##Prefix); \
742 m_##proper##Prefix = nullptr; \
746 * Declares abstract set method for a typed XML child object in a foreign namespace.
747 * The get method is omitted.
749 * @param proper the proper name of the child type
750 * @param ns the C++ namespace for the type
752 #define DECL_INHERITED_TYPED_FOREIGN_CHILD(proper,ns) \
754 XMLTOOLING_DOXYGEN(Sets the proper child.) \
755 virtual void set##proper(ns::proper* child)=0
758 * Declares abstract get/set methods for a typed XML child object in a foreign namespace.
760 * @param proper the proper name of the child type
761 * @param ns the C++ namespace for the type
763 #define DECL_TYPED_FOREIGN_CHILD(proper,ns) \
765 XMLTOOLING_DOXYGEN(Returns the proper child.) \
766 virtual ns::proper* get##proper() const=0; \
767 XMLTOOLING_DOXYGEN(Sets the proper child.) \
768 virtual void set##proper(ns::proper* child)=0
771 * Declares abstract set method for a typed XML child object.
772 * The get method is omitted.
774 * @param proper the proper name of the child type
776 #define DECL_INHERITED_TYPED_CHILD(proper) \
778 XMLTOOLING_DOXYGEN(Sets the proper child.) \
779 virtual void set##proper(proper* child)=0
782 * Declares abstract get/set methods for a typed XML child object.
784 * @param proper the proper name of the child type
786 #define DECL_TYPED_CHILD(proper) \
788 XMLTOOLING_DOXYGEN(Returns the proper child.) \
789 virtual proper* get##proper() const=0; \
790 XMLTOOLING_DOXYGEN(Sets the proper child.) \
791 virtual void set##proper(proper* child)=0
794 * Declares abstract get/set methods for a generic XML child object.
796 * @param proper the proper name of the child
798 #define DECL_XMLOBJECT_CHILD(proper) \
800 XMLTOOLING_DOXYGEN(Returns the proper child.) \
801 virtual xmltooling::XMLObject* get##proper() const=0; \
802 XMLTOOLING_DOXYGEN(Sets the proper child.) \
803 virtual void set##proper(xmltooling::XMLObject* child)=0
807 * Implements get/set methods and a private list iterator member for a typed XML child object.
809 * @param proper the proper name of the child type
811 #define IMPL_TYPED_CHILD(proper) \
813 proper* m_##proper; \
814 std::list<xmltooling::XMLObject*>::iterator m_pos_##proper; \
816 proper* get##proper() const { \
819 void set##proper(proper* child) { \
820 prepareForAssignment(m_##proper,child); \
821 *m_pos_##proper = m_##proper = child; \
825 * Implements get/set methods and a private list iterator member for
826 * a typed XML child object in a foreign namespace
828 * @param proper the proper name of the child type
829 * @param ns the C++ namespace for the type
831 #define IMPL_TYPED_FOREIGN_CHILD(proper,ns) \
833 ns::proper* m_##proper; \
834 std::list<xmltooling::XMLObject*>::iterator m_pos_##proper; \
836 ns::proper* get##proper() const { \
839 void set##proper(ns::proper* child) { \
840 prepareForAssignment(m_##proper,child); \
841 *m_pos_##proper = m_##proper = child; \
845 * Implements get/set methods and a private list iterator member for a generic XML child object.
847 * @param proper the proper name of the child
849 #define IMPL_XMLOBJECT_CHILD(proper) \
851 xmltooling::XMLObject* m_##proper; \
852 std::list<xmltooling::XMLObject*>::iterator m_pos_##proper; \
854 xmltooling::XMLObject* get##proper() const { \
857 void set##proper(xmltooling::XMLObject* child) { \
858 prepareForAssignment(m_##proper,child); \
859 *m_pos_##proper = m_##proper = child; \
863 * Declares abstract get/set methods for a typed XML child collection.
865 * @param proper the proper name of the child type
867 #define DECL_TYPED_CHILDREN(proper) \
869 XMLTOOLING_DOXYGEN(Returns modifiable proper collection.) \
870 virtual VectorOf(proper) get##proper##s()=0; \
871 XMLTOOLING_DOXYGEN(Returns reference to immutable proper collection.) \
872 virtual const std::vector<proper*>& get##proper##s() const=0
875 * Declares abstract get/set methods for a typed XML child collection in a foreign namespace.
877 * @param proper the proper name of the child type
878 * @param ns the C++ namespace for the type
880 #define DECL_TYPED_FOREIGN_CHILDREN(proper,ns) \
882 XMLTOOLING_DOXYGEN(Returns modifiable proper collection.) \
883 virtual VectorOf(ns::proper) get##proper##s()=0; \
884 XMLTOOLING_DOXYGEN(Returns reference to immutable proper collection.) \
885 virtual const std::vector<ns::proper*>& get##proper##s() const=0
888 * Declares abstract get/set methods for a generic XML child collection.
890 * @param proper the proper name of the child
892 #define DECL_XMLOBJECT_CHILDREN(proper) \
894 XMLTOOLING_DOXYGEN(Returns modifiable proper collection.) \
895 virtual VectorOf(xmltooling::XMLObject) get##proper##s()=0; \
896 XMLTOOLING_DOXYGEN(Returns reference to immutable proper collection.) \
897 virtual const std::vector<xmltooling::XMLObject*>& get##proper##s() const=0
900 * Implements get method and a private vector member for a typed XML child collection.
902 * @param proper the proper name of the child type
903 * @param fence insertion fence for new objects of the child collection in backing list
905 #define IMPL_TYPED_CHILDREN(proper,fence) \
907 std::vector<proper*> m_##proper##s; \
909 VectorOf(proper) get##proper##s() { \
910 return VectorOf(proper)(this, m_##proper##s, &m_children, fence); \
912 const std::vector<proper*>& get##proper##s() const { \
913 return m_##proper##s; \
917 * Implements get method and a private vector member for a typed XML child collection
918 * in a foreign namespace.
920 * @param proper the proper name of the child type
921 * @param ns the C++ namespace for the type
922 * @param fence insertion fence for new objects of the child collection in backing list
924 #define IMPL_TYPED_FOREIGN_CHILDREN(proper,ns,fence) \
926 std::vector<ns::proper*> m_##proper##s; \
928 VectorOf(ns::proper) get##proper##s() { \
929 return VectorOf(ns::proper)(this, m_##proper##s, &m_children, fence); \
931 const std::vector<ns::proper*>& get##proper##s() const { \
932 return m_##proper##s; \
936 * Implements get method and a private vector member for a generic XML child collection.
938 * @param proper the proper name of the child
939 * @param fence insertion fence for new objects of the child collection in backing list
941 #define IMPL_XMLOBJECT_CHILDREN(proper,fence) \
943 std::vector<xmltooling::XMLObject*> m_##proper##s; \
945 VectorOf(xmltooling::XMLObject) get##proper##s() { \
946 return VectorOf(xmltooling::XMLObject)(this, m_##proper##s, &m_children, fence); \
948 const std::vector<xmltooling::XMLObject*>& get##proper##s() const { \
949 return m_##proper##s; \
953 * Implements marshalling for a string attribute
955 * @param proper the proper name of the attribute
956 * @param ucase the upcased name of the attribute
957 * @param namespaceURI the XML namespace of the attribute
959 #define MARSHALL_STRING_ATTRIB(proper,ucase,namespaceURI) \
960 if (m_##proper && *m_##proper) { \
961 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, m_##proper); \
965 * Implements marshalling for a DateTime attribute
967 * @param proper the proper name of the attribute
968 * @param ucase the upcased name of the attribute
969 * @param namespaceURI the XML namespace of the attribute
971 #define MARSHALL_DATETIME_ATTRIB(proper,ucase,namespaceURI) \
973 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, m_##proper->getRawData()); \
977 * Implements marshalling for an integer attribute
979 * @param proper the proper name of the attribute
980 * @param ucase the upcased name of the attribute
981 * @param namespaceURI the XML namespace of the attribute
983 #define MARSHALL_INTEGER_ATTRIB(proper,ucase,namespaceURI) \
984 if (m_##proper && *m_##proper) { \
985 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, m_##proper); \
989 * Implements marshalling for a boolean attribute
991 * @param proper the proper name of the attribute
992 * @param ucase the upcased name of the attribute
993 * @param namespaceURI the XML namespace of the attribute
995 #define MARSHALL_BOOLEAN_ATTRIB(proper,ucase,namespaceURI) \
996 switch (m_##proper) { \
997 case xmlconstants::XML_BOOL_TRUE: \
998 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, xmlconstants::XML_TRUE); \
1000 case xmlconstants::XML_BOOL_ONE: \
1001 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, xmlconstants::XML_ONE); \
1003 case xmlconstants::XML_BOOL_FALSE: \
1004 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, xmlconstants::XML_FALSE); \
1006 case xmlconstants::XML_BOOL_ZERO: \
1007 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, xmlconstants::XML_ZERO); \
1009 case xmlconstants::XML_BOOL_NULL: \
1014 * Implements marshalling for a QName attribute
1016 * @param proper the proper name of the attribute
1017 * @param ucase the upcased name of the attribute
1018 * @param namespaceURI the XML namespace of the attribute
1020 #define MARSHALL_QNAME_ATTRIB(proper,ucase,namespaceURI) \
1022 xmltooling::auto_ptr_XMLCh qstr(m_##proper->toString().c_str()); \
1023 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, qstr.get()); \
1026 #ifdef XMLTOOLING_XERCESC_BOOLSETIDATTRIBUTE
1028 * Implements marshalling for an ID attribute
1030 * @param proper the proper name of the attribute
1031 * @param ucase the upcased name of the attribute
1032 * @param namespaceURI the XML namespace of the attribute
1034 # define MARSHALL_ID_ATTRIB(proper,ucase,namespaceURI) \
1035 if (m_##proper && *m_##proper) { \
1036 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, m_##proper); \
1037 domElement->setIdAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, true); \
1041 * Implements marshalling for an ID attribute
1043 * @param proper the proper name of the attribute
1044 * @param ucase the upcased name of the attribute
1045 * @param namespaceURI the XML namespace of the attribute
1047 # define MARSHALL_ID_ATTRIB(proper,ucase,namespaceURI) \
1048 if (m_##proper && *m_##proper) { \
1049 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, m_##proper); \
1050 domElement->setIdAttributeNS(namespaceURI, ucase##_ATTRIB_NAME); \
1055 * Implements unmarshalling process branch for a string attribute
1057 * @param proper the proper name of the attribute
1058 * @param ucase the upcased name of the attribute
1059 * @param namespaceURI the XML namespace of the attribute
1061 #define PROC_STRING_ATTRIB(proper,ucase,namespaceURI) \
1062 if (xmltooling::XMLHelper::isNodeNamed(attribute, namespaceURI, ucase##_ATTRIB_NAME)) { \
1063 set##proper(attribute->getValue()); \
1067 #ifdef XMLTOOLING_XERCESC_BOOLSETIDATTRIBUTE
1069 * Implements unmarshalling process branch for an ID attribute
1071 * @param proper the proper name of the attribute
1072 * @param ucase the upcased name of the attribute
1073 * @param namespaceURI the XML namespace of the attribute
1075 # define PROC_ID_ATTRIB(proper,ucase,namespaceURI) \
1076 if (xmltooling::XMLHelper::isNodeNamed(attribute, namespaceURI, ucase##_ATTRIB_NAME)) { \
1077 set##proper(attribute->getValue()); \
1078 attribute->getOwnerElement()->setIdAttributeNode(attribute, true); \
1083 * Implements unmarshalling process branch for an ID attribute
1085 * @param proper the proper name of the attribute
1086 * @param ucase the upcased name of the attribute
1087 * @param namespaceURI the XML namespace of the attribute
1089 # define PROC_ID_ATTRIB(proper,ucase,namespaceURI) \
1090 if (xmltooling::XMLHelper::isNodeNamed(attribute, namespaceURI, ucase##_ATTRIB_NAME)) { \
1091 set##proper(attribute->getValue()); \
1092 attribute->getOwnerElement()->setIdAttributeNode(attribute); \
1098 * Implements unmarshalling process branch for a DateTime attribute
1100 * @param proper the proper name of the attribute
1101 * @param ucase the upcased name of the attribute
1102 * @param namespaceURI the XML namespace of the attribute
1104 #define PROC_DATETIME_ATTRIB(proper,ucase,namespaceURI) \
1105 PROC_STRING_ATTRIB(proper,ucase,namespaceURI)
1108 * Implements unmarshalling process branch for a DateTime attribute
1110 * @param proper the proper name of the attribute
1111 * @param ucase the upcased name of the attribute
1112 * @param namespaceURI the XML namespace of the attribute
1114 #define PROC_QNAME_ATTRIB(proper,ucase,namespaceURI) \
1115 if (xmltooling::XMLHelper::isNodeNamed(attribute, namespaceURI, ucase##_ATTRIB_NAME)) { \
1116 std::auto_ptr<xmltooling::QName> q(xmltooling::XMLHelper::getAttributeValueAsQName(attribute)); \
1117 set##proper(q.get()); \
1122 * Implements unmarshalling process branch for an integer attribute
1124 * @param proper the proper name of the attribute
1125 * @param ucase the upcased name of the attribute
1126 * @param namespaceURI the XML namespace of the attribute
1128 #define PROC_INTEGER_ATTRIB(proper,ucase,namespaceURI) \
1129 PROC_STRING_ATTRIB(proper,ucase,namespaceURI)
1132 * Implements unmarshalling process branch for a boolean attribute
1134 * @param proper the proper name of the attribute
1135 * @param ucase the upcased name of the attribute
1136 * @param namespaceURI the XML namespace of the attribute
1138 #define PROC_BOOLEAN_ATTRIB(proper,ucase,namespaceURI) \
1139 PROC_STRING_ATTRIB(proper,ucase,namespaceURI)
1142 * Implements unmarshalling process branch for typed child collection element
1144 * @param proper the proper name of the child type
1145 * @param namespaceURI the XML namespace of the child element
1146 * @param force bypass use of hint and just cast down to check child
1148 #define PROC_TYPED_CHILDREN(proper,namespaceURI,force) \
1149 if (force || xmltooling::XMLHelper::isNodeNamed(root,namespaceURI,proper::LOCAL_NAME)) { \
1150 proper* typesafe=dynamic_cast<proper*>(childXMLObject); \
1152 get##proper##s().push_back(typesafe); \
1158 * Implements unmarshalling process branch for typed child collection element
1159 * in a foreign namespace.
1161 * @param proper the proper name of the child type
1162 * @param ns the C++ namespace for the type
1163 * @param namespaceURI the XML namespace of the child element
1164 * @param force bypass use of hint and just cast down to check child
1166 #define PROC_TYPED_FOREIGN_CHILDREN(proper,ns,namespaceURI,force) \
1167 if (force || xmltooling::XMLHelper::isNodeNamed(root,namespaceURI,ns::proper::LOCAL_NAME)) { \
1168 ns::proper* typesafe=dynamic_cast<ns::proper*>(childXMLObject); \
1170 get##proper##s().push_back(typesafe); \
1176 * Implements unmarshalling process branch for typed child singleton element
1178 * @param proper the proper name of the child type
1179 * @param namespaceURI the XML namespace of the child element
1180 * @param force bypass use of hint and just cast down to check child
1182 #define PROC_TYPED_CHILD(proper,namespaceURI,force) \
1183 if (force || xmltooling::XMLHelper::isNodeNamed(root,namespaceURI,proper::LOCAL_NAME)) { \
1184 proper* typesafe=dynamic_cast<proper*>(childXMLObject); \
1185 if (typesafe && !m_##proper) { \
1186 typesafe->setParent(this); \
1187 *m_pos_##proper = m_##proper = typesafe; \
1193 * Implements unmarshalling process branch for typed child singleton element
1194 * in a foreign namespace.
1196 * @param proper the proper name of the child type
1197 * @param ns the C++ namespace for the type
1198 * @param namespaceURI the XML namespace of the child element
1199 * @param force bypass use of hint and just cast down to check child
1201 #define PROC_TYPED_FOREIGN_CHILD(proper,ns,namespaceURI,force) \
1202 if (force || xmltooling::XMLHelper::isNodeNamed(root,namespaceURI,ns::proper::LOCAL_NAME)) { \
1203 ns::proper* typesafe=dynamic_cast<ns::proper*>(childXMLObject); \
1204 if (typesafe && !m_##proper) { \
1205 typesafe->setParent(this); \
1206 *m_pos_##proper = m_##proper = typesafe; \
1212 * Implements unmarshalling process branch for a generic child singleton element
1214 * @param proper the proper name of the child type
1215 * @param namespaceURI the XML namespace of the child element
1217 #define PROC_XMLOBJECT_CHILD(proper,namespaceURI) \
1218 if (xmltooling::XMLHelper::isNodeNamed(root,namespaceURI,proper::LOCAL_NAME)) { \
1219 if (!m_##proper) { \
1220 childXMLObject->setParent(this); \
1221 *m_pos_##proper = m_##proper = childXMLObject; \
1227 * Declares aliased get/set methods for named XML element simple content.
1229 * @param proper the proper name to label the element's content
1231 #define DECL_SIMPLE_CONTENT(proper) \
1232 XMLTOOLING_DOXYGEN(Returns proper.) \
1233 const XMLCh* get##proper() const { \
1234 return getTextContent(); \
1236 XMLTOOLING_DOXYGEN(Sets or clears proper.) \
1237 void set##proper(const XMLCh* proper) { \
1238 setTextContent(proper); \
1242 * Declares aliased get/set methods for named integer XML element content.
1244 * @param proper the proper name to label the element's content
1246 #define DECL_INTEGER_CONTENT(proper) \
1247 XMLTOOLING_DOXYGEN(Returns proper in integer form after a NULL indicator.) \
1248 std::pair<bool,int> get##proper() const { \
1249 return std::make_pair((getTextContent()!=nullptr), (getTextContent()!=nullptr ? xercesc::XMLString::parseInt(getTextContent()) : 0)); \
1251 XMLTOOLING_DOXYGEN(Sets proper.) \
1252 void set##proper(int proper) { \
1254 std::sprintf(buf,"%d",proper); \
1255 xmltooling::auto_ptr_XMLCh widebuf(buf); \
1256 setTextContent(widebuf.get()); \
1258 XMLTOOLING_DOXYGEN(Sets or clears proper.) \
1259 void set##proper(const XMLCh* proper) { \
1260 setTextContent(proper); \
1264 * Implements cloning methods for an XMLObject specialization implementation class.
1266 * @param cname the name of the XMLObject specialization
1268 #define IMPL_XMLOBJECT_CLONE(cname) \
1269 cname* clone##cname() const { \
1270 return dynamic_cast<cname*>(clone()); \
1272 xmltooling::XMLObject* clone() const { \
1273 std::auto_ptr<xmltooling::XMLObject> domClone(xmltooling::AbstractDOMCachingXMLObject::clone()); \
1274 cname##Impl* ret=dynamic_cast<cname##Impl*>(domClone.get()); \
1276 domClone.release(); \
1279 return new cname##Impl(*this); \
1283 * Implements cloning methods for an XMLObject specialization implementation class
1284 * that must override a base class clone method.
1286 * @param cname the name of the XMLObject specialization
1287 * @param base name of base type.
1289 #define IMPL_XMLOBJECT_CLONE2(cname,base) \
1290 cname* clone##cname() const { \
1291 return dynamic_cast<cname*>(clone()); \
1293 base* clone##base() const { \
1294 return dynamic_cast<base*>(clone()); \
1296 xmltooling::XMLObject* clone() const { \
1297 std::auto_ptr<xmltooling::XMLObject> domClone(xmltooling::AbstractDOMCachingXMLObject::clone()); \
1298 cname##Impl* ret=dynamic_cast<cname##Impl*>(domClone.get()); \
1300 domClone.release(); \
1303 return new cname##Impl(*this); \
1307 * Implements cloning methods for an XMLObject specialization implementation class that
1308 * needs two stage duplication to avoid invoking virtual methods during construction.
1310 * @param cname the name of the XMLObject specialization
1312 #define IMPL_XMLOBJECT_CLONE_EX(cname) \
1313 cname* clone##cname() const { \
1314 return dynamic_cast<cname*>(clone()); \
1316 xmltooling::XMLObject* clone() const { \
1317 std::auto_ptr<xmltooling::XMLObject> domClone(xmltooling::AbstractDOMCachingXMLObject::clone()); \
1318 cname##Impl* ret=dynamic_cast<cname##Impl*>(domClone.get()); \
1320 domClone.release(); \
1323 std::auto_ptr<cname##Impl> ret2(new cname##Impl(*this)); \
1324 ret2->_clone(*this); \
1325 return ret2.release(); \
1329 * Implements cloning methods for an XMLObject specialization implementation class that
1330 * needs two stage duplication to avoid invoking virtual methods during construction,
1331 * and must override a base class clone method.
1333 * @param cname the name of the XMLObject specialization
1334 * @param base name of base type
1336 #define IMPL_XMLOBJECT_CLONE_EX2(cname,base) \
1337 cname* clone##cname() const { \
1338 return dynamic_cast<cname*>(clone()); \
1340 base* clone##base() const { \
1341 return dynamic_cast<base*>(clone()); \
1343 xmltooling::XMLObject* clone() const { \
1344 std::auto_ptr<xmltooling::XMLObject> domClone(xmltooling::AbstractDOMCachingXMLObject::clone()); \
1345 cname##Impl* ret=dynamic_cast<cname##Impl*>(domClone.get()); \
1347 domClone.release(); \
1350 std::auto_ptr<cname##Impl> ret2(new cname##Impl(*this)); \
1351 ret2->_clone(*this); \
1352 return ret2.release(); \
1356 * Declares an XMLObject specialization with a simple content model and type,
1357 * handling it as string data.
1359 * @param linkage linkage specifier for the class
1360 * @param cname the name of the XMLObject specialization
1361 * @param proper the proper name to label the element's content
1362 * @param desc documentation for class
1364 #define DECL_XMLOBJECT_SIMPLE(linkage,cname,proper,desc) \
1365 BEGIN_XMLOBJECT(linkage,cname,xmltooling::XMLObject,desc); \
1366 DECL_SIMPLE_CONTENT(proper); \
1370 * Declares and defines an implementation class for an XMLObject with
1371 * a simple content model and type, handling it as string data.
1373 * @param linkage linkage specifier for the class
1374 * @param cname the name of the XMLObject specialization
1376 #define DECL_XMLOBJECTIMPL_SIMPLE(linkage,cname) \
1377 class linkage cname##Impl \
1378 : public virtual cname, \
1379 public xmltooling::AbstractSimpleElement, \
1380 public xmltooling::AbstractDOMCachingXMLObject, \
1381 public xmltooling::AbstractXMLObjectMarshaller, \
1382 public xmltooling::AbstractXMLObjectUnmarshaller \
1385 virtual ~cname##Impl() {} \
1386 cname##Impl(const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const xmltooling::QName* schemaType) \
1387 : xmltooling::AbstractXMLObject(nsURI, localName, prefix, schemaType) { \
1389 cname##Impl(const cname##Impl& src) \
1390 : xmltooling::AbstractXMLObject(src), \
1391 xmltooling::AbstractSimpleElement(src), \
1392 xmltooling::AbstractDOMCachingXMLObject(src) {} \
1393 IMPL_XMLOBJECT_CLONE(cname) \
1396 #ifdef HAVE_COVARIANT_RETURNS
1399 * Begins the declaration of an XMLObjectBuilder specialization.
1400 * Basic boilerplate includes an empty virtual destructor, and
1401 * a default builder that defaults the element name.
1403 * @param linkage linkage specifier for the class
1404 * @param cname the name of the XMLObject specialization
1405 * @param namespaceURI the XML namespace of the default associated element
1406 * @param namespacePrefix the XML namespace prefix of the default associated element
1408 #define BEGIN_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix) \
1409 XMLTOOLING_DOXYGEN(Builder for cname objects.) \
1410 class linkage cname##Builder : public xmltooling::ConcreteXMLObjectBuilder { \
1412 virtual ~cname##Builder() {} \
1413 XMLTOOLING_DOXYGEN(Default builder.) \
1414 virtual cname* buildObject() const { \
1415 return buildObject(namespaceURI,cname::LOCAL_NAME,namespacePrefix); \
1417 XMLTOOLING_DOXYGEN(Builder that allows element/type override.) \
1418 virtual cname* buildObject( \
1419 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=nullptr, const xmltooling::QName* schemaType=nullptr \
1423 * Ends the declaration of an XMLObjectBuilder specialization.
1425 #define END_XMLOBJECTBUILDER }
1428 * Declares a generic XMLObjectBuilder specialization.
1430 * @param linkage linkage specifier for the class
1431 * @param cname the name of the XMLObject specialization
1432 * @param namespaceURI the XML namespace of the default associated element
1433 * @param namespacePrefix the XML namespace prefix of the default associated element
1435 #define DECL_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix) \
1436 BEGIN_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix); \
1437 XMLTOOLING_DOXYGEN(Singleton builder.) \
1438 static cname* build##cname() { \
1439 const cname##Builder* b = dynamic_cast<const cname##Builder*>( \
1440 XMLObjectBuilder::getBuilder(xmltooling::QName(namespaceURI,cname::LOCAL_NAME)) \
1443 return b->buildObject(); \
1444 throw xmltooling::XMLObjectException("Unable to obtain typed builder for "#cname"."); \
1446 END_XMLOBJECTBUILDER
1449 * Implements the standard XMLObjectBuilder specialization function.
1451 * @param cname the name of the XMLObject specialization
1453 #define IMPL_XMLOBJECTBUILDER(cname) \
1454 cname* cname##Builder::buildObject( \
1455 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const xmltooling::QName* schemaType \
1458 return new cname##Impl(nsURI,localName,prefix,schemaType); \
1461 #else /* !HAVE_COVARIANT_RETURNS */
1464 * Begins the declaration of an XMLObjectBuilder specialization.
1465 * Basic boilerplate includes an empty virtual destructor, and
1466 * a default builder that defaults the element name.
1468 * @param linkage linkage specifier for the class
1469 * @param cname the name of the XMLObject specialization
1470 * @param namespaceURI the XML namespace of the default associated element
1471 * @param namespacePrefix the XML namespace prefix of the default associated element
1473 #define BEGIN_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix) \
1474 XMLTOOLING_DOXYGEN(Builder for cname objects.) \
1475 class linkage cname##Builder : public xmltooling::ConcreteXMLObjectBuilder { \
1477 virtual ~cname##Builder() {} \
1478 XMLTOOLING_DOXYGEN(Default builder.) \
1479 virtual xmltooling::XMLObject* buildObject() const { \
1480 return buildObject(namespaceURI,cname::LOCAL_NAME,namespacePrefix); \
1482 XMLTOOLING_DOXYGEN(Builder that allows element/type override.) \
1483 virtual xmltooling::XMLObject* buildObject( \
1484 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=nullptr, const xmltooling::QName* schemaType=nullptr \
1488 * Ends the declaration of an XMLObjectBuilder specialization.
1490 #define END_XMLOBJECTBUILDER }
1493 * Declares a generic XMLObjectBuilder specialization.
1495 * @param linkage linkage specifier for the class
1496 * @param cname the name of the XMLObject specialization
1497 * @param namespaceURI the XML namespace of the default associated element
1498 * @param namespacePrefix the XML namespace prefix of the default associated element
1500 #define DECL_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix) \
1501 BEGIN_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix); \
1502 XMLTOOLING_DOXYGEN(Singleton builder.) \
1503 static cname* build##cname() { \
1504 const cname##Builder* b = dynamic_cast<const cname##Builder*>( \
1505 XMLObjectBuilder::getBuilder(xmltooling::QName(namespaceURI,cname::LOCAL_NAME)) \
1508 return dynamic_cast<cname*>(b->buildObject()); \
1509 throw xmltooling::XMLObjectException("Unable to obtain typed builder for "#cname"."); \
1511 END_XMLOBJECTBUILDER
1514 * Implements the standard XMLObjectBuilder specialization function.
1516 * @param cname the name of the XMLObject specialization
1518 #define IMPL_XMLOBJECTBUILDER(cname) \
1519 xmltooling::XMLObject* cname##Builder::buildObject( \
1520 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const xmltooling::QName* schemaType \
1523 return new cname##Impl(nsURI,localName,prefix,schemaType); \
1526 #endif /* HAVE_COVARIANT_RETURNS */
1529 * Begins the declaration of a Schema Validator specialization.
1531 * @param linkage linkage specifier for the class
1532 * @param cname the base name of the Validator specialization
1534 #define BEGIN_XMLOBJECTVALIDATOR(linkage,cname) \
1535 class linkage cname##SchemaValidator : public xmltooling::Validator \
1538 virtual ~cname##SchemaValidator() {} \
1539 virtual void validate(const xmltooling::XMLObject* xmlObject) const { \
1540 const cname* ptr=dynamic_cast<const cname*>(xmlObject); \
1542 throw xmltooling::ValidationException(#cname"SchemaValidator: unsupported object type ($1).",xmltooling::params(1,typeid(xmlObject).name())); \
1543 if (ptr->nil() && (ptr->hasChildren() || ptr->getTextContent())) \
1544 throw xmltooling::ValidationException("Object has nil property but with children or content.")
1547 * Begins the declaration of a Schema Validator specialization subclass.
1549 * @param linkage linkage specifier for the class
1550 * @param cname the base name of the Validator specialization
1551 * @param base base class for the validator
1553 #define BEGIN_XMLOBJECTVALIDATOR_SUB(linkage,cname,base) \
1554 class linkage cname##SchemaValidator : public base##SchemaValidator \
1557 virtual ~cname##SchemaValidator() {} \
1558 virtual void validate(const xmltooling::XMLObject* xmlObject) const { \
1559 const cname* ptr=dynamic_cast<const cname*>(xmlObject); \
1561 throw xmltooling::ValidationException(#cname"SchemaValidator: unsupported object type ($1).",xmltooling::params(1,typeid(xmlObject).name()));
1564 * Ends the declaration of a Validator specialization.
1566 #define END_XMLOBJECTVALIDATOR } }
1569 * Validator code that checks the object type.
1571 * @param cname the name of the XMLObject specialization
1573 #define XMLOBJECTVALIDATOR_CHECKTYPE(cname) \
1574 const cname* ptr=dynamic_cast<const cname*>(xmlObject); \
1576 throw xmltooling::ValidationException(#cname"SchemaValidator: unsupported object type ($1).",xmltooling::params(1,typeid(xmlObject).name()))
1579 * Validator code that checks for a required attribute, content, or singleton.
1581 * @param cname the name of the XMLObject specialization
1582 * @param proper the proper name of the attribute, content, or singleton member
1584 #define XMLOBJECTVALIDATOR_REQUIRE(cname,proper) \
1585 if (!ptr->get##proper()) \
1586 throw xmltooling::ValidationException(#cname" must have "#proper".")
1589 * Validator code that checks for a required integer attribute
1591 * @param cname the name of the XMLObject specialization
1592 * @param proper the proper name of the attribute, content, or singleton member
1594 #define XMLOBJECTVALIDATOR_REQUIRE_INTEGER(cname,proper) \
1595 if (!ptr->get##proper().first) \
1596 throw xmltooling::ValidationException(#cname" must have "#proper".")
1599 * Validator code that checks for one of a pair of
1600 * required attributes, content, or singletons.
1602 * @param cname the name of the XMLObject specialization
1603 * @param proper1 the proper name of the first attribute, content, or singleton member
1604 * @param proper2 the proper name of the second attribute, content, or singleton member
1606 #define XMLOBJECTVALIDATOR_ONEOF(cname,proper1,proper2) \
1607 if (!ptr->get##proper1() && !ptr->get##proper2()) \
1608 throw xmltooling::ValidationException(#cname" must have "#proper1" or "#proper2".")
1611 * Validator code that checks for one of a pair of
1612 * required attributes, content, or singletons, but disallows both.
1614 * @param cname the name of the XMLObject specialization
1615 * @param proper1 the proper name of the first attribute, content, or singleton member
1616 * @param proper2 the proper name of the second attribute, content, or singleton member
1618 #define XMLOBJECTVALIDATOR_ONLYONEOF(cname,proper1,proper2) \
1619 if ((!ptr->get##proper1() && !ptr->get##proper2()) || (ptr->get##proper1() && ptr->get##proper2())) \
1620 throw xmltooling::ValidationException(#cname" must have "#proper1" or "#proper2" but not both.")
1623 * Validator code that checks for one of a set of three
1624 * required attributes, content, or singletons.
1626 * @param cname the name of the XMLObject specialization
1627 * @param proper1 the proper name of the first attribute, content, or singleton member
1628 * @param proper2 the proper name of the second attribute, content, or singleton member
1629 * @param proper3 the proper name of the third attribute, content, or singleton member
1631 #define XMLOBJECTVALIDATOR_ONEOF3(cname,proper1,proper2,proper3) \
1632 if (!ptr->get##proper1() && !ptr->get##proper2() && !ptr->get##proper3()) \
1633 throw xmltooling::ValidationException(#cname" must have "#proper1", "#proper2", or "#proper3".")
1636 * Validator code that checks for one of a set of three
1637 * required attributes, content, or singletons but disallows more than one.
1639 * @param cname the name of the XMLObject specialization
1640 * @param proper1 the proper name of the first attribute, content, or singleton member
1641 * @param proper2 the proper name of the second attribute, content, or singleton member
1642 * @param proper3 the proper name of the third attribute, content, or singleton member
1644 #define XMLOBJECTVALIDATOR_ONLYONEOF3(cname,proper1,proper2,proper3) \
1645 int c##proper1##proper2##proper3=0; \
1646 if (ptr->get##proper1()!=nullptr) \
1647 c##proper1##proper2##proper3++; \
1648 if (ptr->get##proper2()!=nullptr) \
1649 c##proper1##proper2##proper3++; \
1650 if (ptr->get##proper3()!=nullptr) \
1651 c##proper1##proper2##proper3++; \
1652 if (c##proper1##proper2##proper3 != 1) \
1653 throw xmltooling::ValidationException(#cname" must have only one of "#proper1", "#proper2", or "#proper3".")
1656 * Validator code that checks a co-constraint (if one present, the other must be)
1657 * between a pair of attributes, content, or singletons.
1659 * @param cname the name of the XMLObject specialization
1660 * @param proper1 the proper name of the first attribute, content, or singleton member
1661 * @param proper2 the proper name of the second attribute, content, or singleton member
1663 #define XMLOBJECTVALIDATOR_NONEORBOTH(cname,proper1,proper2) \
1664 if ((ptr->get##proper1() && !ptr->get##proper2()) || (!ptr->get##proper1() && ptr->get##proper2())) \
1665 throw xmltooling::ValidationException(#cname" cannot have "#proper1" without "#proper2".")
1668 * Validator code that checks for a non-empty collection.
1670 * @param cname the name of the XMLObject specialization
1671 * @param proper the proper name of the collection item
1673 #define XMLOBJECTVALIDATOR_NONEMPTY(cname,proper) \
1674 if (ptr->get##proper##s().empty()) \
1675 throw xmltooling::ValidationException(#cname" must have at least one "#proper".")
1678 * Declares/defines a Validator specialization that checks object type and
1679 * a non-empty simple content model.
1681 * @param linkage linkage specifier for the class
1682 * @param cname the name of the XMLObject specialization
1684 #define XMLOBJECTVALIDATOR_SIMPLE(linkage,cname) \
1685 BEGIN_XMLOBJECTVALIDATOR(linkage,cname); \
1686 XMLOBJECTVALIDATOR_REQUIRE(cname,TextContent); \
1687 END_XMLOBJECTVALIDATOR
1692 * @namespace xmltooling
1693 * Public namespace of XML Tooling library
1695 namespace xmltooling {
1698 * Template function for cloning a sequence of XMLObjects.
1699 * Invokes the clone() member on each element of the input sequence and adds the copy to
1700 * the output sequence. Order is preserved.
1702 * @param in input sequence to clone
1703 * @param out output sequence to copy cloned pointers into
1705 template<class InputSequence,class OutputSequence> void clone(const InputSequence& in, OutputSequence& out) {
1706 for (typename InputSequence::const_iterator i=in.begin(); i!=in.end(); i++) {
1708 out.push_back((*i)->clone());
1715 * Functor for cleaning up heap objects in containers.
1717 template<class T> struct cleanup
1720 * Function operator to delete an object.
1722 * @param ptr object to delete
1724 void operator()(T* ptr) {delete ptr;}
1727 * Function operator to delete an object stored as const.
1729 * @param ptr object to delete after casting away const
1731 void operator()(const T* ptr) {delete const_cast<T*>(ptr);}
1735 * Functor for cleaning up heap objects in key/value containers.
1737 template<class A,class B> struct cleanup_pair
1740 * Function operator to delete an object.
1742 * @param p a pair in which the second component is the object to delete
1744 void operator()(const std::pair<const A,B*>& p) {delete p.second;}
1748 * Functor for cleaning up const heap objects in key/value containers.
1750 template<class A,class B> struct cleanup_const_pair
1753 * Function operator to delete an object stored as const
1755 * @param p a pair in which the second component is the const object to delete
1757 void operator()(const std::pair<const A,const B*>& p) {delete const_cast<B*>(p.second);}
1761 #endif /* __xmltooling_base_h__ */