2 * Copyright 2001-2006 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 * Base header file definitions
21 * Must be included prior to including any other header
24 #ifndef __xmltooling_base_h__
25 #define __xmltooling_base_h__
27 #if defined (_MSC_VER) || defined(__BORLANDC__)
28 #include <xmltooling/config_pub_win32.h>
30 #include <xmltooling/config_pub.h>
33 // Windows and GCC4 Symbol Visibility Macros
35 #define XMLTOOL_IMPORT __declspec(dllimport)
36 #define XMLTOOL_EXPORT __declspec(dllexport)
37 #define XMLTOOL_DLLLOCAL
38 #define XMLTOOL_DLLPUBLIC
40 #define XMLTOOL_IMPORT
41 #ifdef GCC_HASCLASSVISIBILITY
42 #define XMLTOOL_EXPORT __attribute__ ((visibility("default")))
43 #define XMLTOOL_DLLLOCAL __attribute__ ((visibility("hidden")))
44 #define XMLTOOL_DLLPUBLIC __attribute__ ((visibility("default")))
46 #define XMLTOOL_EXPORT
47 #define XMLTOOL_DLLLOCAL
48 #define XMLTOOL_DLLPUBLIC
52 // Define XMLTOOL_API for DLL builds
53 #ifdef XMLTOOLING_EXPORTS
54 #define XMLTOOL_API XMLTOOL_EXPORT
56 #define XMLTOOL_API XMLTOOL_IMPORT
59 // Throwable classes must always be visible on GCC in all binaries
61 #define XMLTOOL_EXCEPTIONAPI(api) api
62 #elif defined(GCC_HASCLASSVISIBILITY)
63 #define XMLTOOL_EXCEPTIONAPI(api) XMLTOOL_EXPORT
65 #define XMLTOOL_EXCEPTIONAPI(api)
69 #define XMLTOOLING_DOXYGEN(desc) /##** desc */
71 #define XMLTOOLING_DOXYGEN(desc)
75 * Blocks copy c'tor and assignment operator for a class.
77 #define MAKE_NONCOPYABLE(type) \
80 type& operator=(const type&);
86 #define UNICODE_LITERAL_1(a) {chLatin_##a, chNull}
87 #define UNICODE_LITERAL_2(a,b) {chLatin_##a, chLatin_##b, chNull}
88 #define UNICODE_LITERAL_3(a,b,c) {chLatin_##a, chLatin_##b, chLatin_##c, chNull}
89 #define UNICODE_LITERAL_4(a,b,c,d) {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chNull}
90 #define UNICODE_LITERAL_5(a,b,c,d,e) {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chNull}
91 #define UNICODE_LITERAL_6(a,b,c,d,e,f) {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chNull}
92 #define UNICODE_LITERAL_7(a,b,c,d,e,f,g) \
93 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chNull}
94 #define UNICODE_LITERAL_8(a,b,c,d,e,f,g,h) \
95 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chNull}
96 #define UNICODE_LITERAL_9(a,b,c,d,e,f,g,h,i) \
97 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, chNull}
98 #define UNICODE_LITERAL_10(a,b,c,d,e,f,g,h,i,j) \
99 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
101 #define UNICODE_LITERAL_11(a,b,c,d,e,f,g,h,i,j,k) \
102 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
103 chLatin_##j, chLatin_##k, chNull}
104 #define UNICODE_LITERAL_12(a,b,c,d,e,f,g,h,i,j,k,l) \
105 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
106 chLatin_##j, chLatin_##k, chLatin_##l, chNull}
107 #define UNICODE_LITERAL_13(a,b,c,d,e,f,g,h,i,j,k,l,m) \
108 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
109 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chNull}
110 #define UNICODE_LITERAL_14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) \
111 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
112 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chNull}
113 #define UNICODE_LITERAL_15(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o) \
114 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
115 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chNull}
116 #define UNICODE_LITERAL_16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) \
117 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
118 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chNull}
119 #define UNICODE_LITERAL_17(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q) \
120 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
121 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chNull}
122 #define UNICODE_LITERAL_18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) \
123 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
124 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, chNull}
125 #define UNICODE_LITERAL_19(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s) \
126 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
127 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
129 #define UNICODE_LITERAL_20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) \
130 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
131 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
132 chLatin_##s, chLatin_##t, chNull}
133 #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) \
134 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
135 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
136 chLatin_##s, chLatin_##t, chLatin_##u, chNull}
137 #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) \
138 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
139 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
140 chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chNull}
141 #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) \
142 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
143 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
144 chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chLatin_##w, chNull}
145 #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) \
146 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
147 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
148 chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chLatin_##w, chLatin_##x, chNull}
149 #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) \
150 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
151 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
152 chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chLatin_##w, chLatin_##x, chLatin_##y, chNull}
153 #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) \
154 {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
155 chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
156 chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chLatin_##w, chLatin_##x, chLatin_##y, chLatin_##z, chNull}
157 #endif /* DOXYGEN_SKIP */
160 * Begins the declaration of an XMLObject specialization.
161 * Basic boilerplate includes a protected constructor, empty virtual destructor,
162 * and Unicode constants for the default associated element's name and prefix.
164 * @param linkage linkage specifier for the class
165 * @param cname the name of the class to declare
166 * @param base the base class to derive from using public virtual inheritance
167 * @param desc documentation comment for class
169 #define BEGIN_XMLOBJECT(linkage,cname,base,desc) \
170 XMLTOOLING_DOXYGEN(desc) \
171 class linkage cname : public virtual base, public virtual xmltooling::ValidatingXMLObject { \
175 virtual ~cname() {} \
176 XMLTOOLING_DOXYGEN(Type-specific clone method.) \
177 virtual cname* clone##cname() const=0; \
178 XMLTOOLING_DOXYGEN(Element local name) \
179 static const XMLCh LOCAL_NAME[]
182 * Ends the declaration of an XMLObject specialization.
184 #define END_XMLOBJECT }
187 * Declares abstract get/set methods for a named XML attribute.
189 * @param proper the proper name of the attribute
190 * @param upcased the upcased name of the attribute
192 #define DECL_XMLOBJECT_ATTRIB(proper,upcased) \
194 XMLTOOLING_DOXYGEN(proper attribute name) \
195 static const XMLCh upcased##_ATTRIB_NAME[]; \
196 XMLTOOLING_DOXYGEN(Returns the proper attribute.) \
197 virtual const XMLCh* get##proper() const=0; \
198 XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
199 virtual void set##proper(const XMLCh* proper)=0
202 * Implements get/set methods and a private member for a named XML attribute.
204 * @param proper the proper name of the attribute
206 #define IMPL_XMLOBJECT_ATTRIB(proper) \
210 const XMLCh* get##proper() const { \
213 void set##proper(const XMLCh* proper) { \
214 m_##proper = prepareForAssignment(m_##proper,proper); \
218 * Declares abstract get/set methods for a typed XML child object.
220 * @param proper the proper name of the child type
222 #define DECL_XMLOBJECT_CHILD(proper) \
224 XMLTOOLING_DOXYGEN(Returns the proper child.) \
225 virtual proper* get##proper() const=0; \
226 XMLTOOLING_DOXYGEN(Sets the proper child.) \
227 virtual void set##proper(proper* child)=0
230 * Implements get/set methods and a private list iterator member for a typed XML child object.
232 * @param proper the proper name of the child type
234 #define IMPL_XMLOBJECT_CHILD(proper) \
236 proper* m_##proper; \
237 std::list<XMLObject*>::iterator m_pos_##proper; \
239 proper* get##proper() const { \
242 void set##proper(proper* child) { \
243 prepareForAssignment(m_##proper,child); \
244 *m_pos_##proper = m_##proper = child; \
248 * Declares abstract get/set methods for a typed XML child collection.
250 * @param proper the proper name of the child type
252 #define DECL_XMLOBJECT_CHILDREN(proper) \
254 XMLTOOLING_DOXYGEN(Returns modifiable proper collection.) \
255 virtual VectorOf(proper) get##proper##s()=0; \
256 XMLTOOLING_DOXYGEN(Returns reference to immutable proper collection.) \
257 virtual const std::vector<proper*>& get##proper##s() const=0
260 * Implements get method and a private vector member for a typed XML child collection.
262 * @param proper the proper name of the child type
263 * @param fence insertion fence for new objects of the child collection in backing list
265 #define IMPL_XMLOBJECT_CHILDREN(proper,fence) \
267 std::vector<proper*> m_##proper##s; \
269 VectorOf(proper) get##proper##s() { \
270 return VectorOf(proper)(this, m_##proper##s, &m_children, fence); \
272 const std::vector<proper*>& get##proper##s() const { \
273 return m_##proper##s; \
277 * Implements marshalling for an attribute
279 * @param proper the proper name of the attribute
280 * @param ucase the upcased name of the attribute
281 * @param namespaceURI the XML namespace of the attribute
283 #define MARSHALL_XMLOBJECT_ATTRIB(proper,ucase,namespaceURI) \
284 if(get##proper()) { \
285 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, get##proper()); \
289 * Implements marshalling for an ID attribute
291 * @param proper the proper name of the attribute
292 * @param ucase the upcased name of the attribute
293 * @param namespaceURI the XML namespace of the attribute
295 #define MARSHALL_XMLOBJECT_ID_ATTRIB(proper,ucase,namespaceURI) \
296 if(get##proper()) { \
297 domElement->setAttributeNS(namespaceURI, ucase##_ATTRIB_NAME, get##proper()); \
298 domElement->setIdAttributeNS(namespaceURI, ucase##_ATTRIB_NAME); \
302 * Implements unmarshalling process branch for an attribute
304 * @param proper the proper name of the attribute
305 * @param ucase the upcased name of the attribute
306 * @param namespaceURI the XML namespace of the attribute
308 #define PROC_XMLOBJECT_ATTRIB(proper,ucase,namespaceURI) \
309 if (xmltooling::XMLHelper::isNodeNamed(attribute, namespaceURI, ucase##_ATTRIB_NAME)) { \
310 set##proper(attribute->getValue()); \
315 * Implements unmarshalling process branch for an ID attribute
317 * @param proper the proper name of the attribute
318 * @param ucase the upcased name of the attribute
319 * @param namespaceURI the XML namespace of the attribute
321 #define PROC_XMLOBJECT_ID_ATTRIB(proper,ucase,namespaceURI) \
322 if (xmltooling::XMLHelper::isNodeNamed(attribute, namespaceURI, ucase##_ATTRIB_NAME)) { \
323 set##proper(attribute->getValue()); \
324 static_cast<DOMElement*>(attribute->getParentNode())->setIdAttributeNode(attribute); \
329 * Implements unmarshalling process branch for typed child collection element
331 * @param proper the proper name of the child type
332 * @param namespaceURI the XML namespace of the child element
334 #define PROC_XMLOBJECT_CHILDREN(proper,namespaceURI) \
335 if (xmltooling::XMLHelper::isNodeNamed(root,namespaceURI,proper::LOCAL_NAME)) { \
336 proper* typesafe=dynamic_cast<proper*>(childXMLObject); \
338 get##proper##s().push_back(typesafe); \
344 * Implements unmarshalling process branch for typed child singleton element
346 * @param proper the proper name of the child type
347 * @param namespaceURI the XML namespace of the child element
349 #define PROC_XMLOBJECT_CHILD(proper,namespaceURI) \
350 if (xmltooling::XMLHelper::isNodeNamed(root,namespaceURI,proper::LOCAL_NAME)) { \
351 proper* typesafe=dynamic_cast<proper*>(childXMLObject); \
353 set##proper(typesafe); \
359 * Declares abstract get/set methods for named XML element content.
361 * @param proper the proper name to label the element's content
363 #define DECL_XMLOBJECT_CONTENT(proper) \
364 XMLTOOLING_DOXYGEN(Returns proper.) \
365 virtual const XMLCh* get##proper() const=0; \
366 XMLTOOLING_DOXYGEN(Sets proper.) \
367 virtual void set##proper(const XMLCh* proper)=0
370 * Implements get/set methods and a private member for named XML element content.
372 * @param proper the proper name to label the element's content
374 #define IMPL_XMLOBJECT_CONTENT(proper) \
378 const XMLCh* get##proper() const { \
381 void set##proper(const XMLCh* proper) { \
382 m_##proper = prepareForAssignment(m_##proper,proper); \
385 void marshallElementContent(DOMElement* domElement) const { \
386 if(get##proper()) { \
387 domElement->appendChild(domElement->getOwnerDocument()->createTextNode(get##proper())); \
390 void processElementContent(const XMLCh* elementContent) { \
391 set##proper(elementContent); \
396 * Implements cloning methods for an XMLObject specialization implementation class.
398 * @param cname the name of the XMLObject specialization
400 #define IMPL_XMLOBJECT_CLONE(cname) \
401 cname* clone##cname() const { \
404 cname* clone() const { \
405 std::auto_ptr<xmltooling::XMLObject> domClone(xmltooling::AbstractDOMCachingXMLObject::clone()); \
406 cname##Impl* ret=dynamic_cast<cname##Impl*>(domClone.get()); \
408 domClone.release(); \
411 return new cname##Impl(*this); \
415 * Declares an XMLObject specialization with a simple content model and type,
416 * handling it as string data.
418 * @param linkage linkage specifier for the class
419 * @param cname the name of the XMLObject specialization
420 * @param proper the proper name to label the element's content
421 * @param desc documentation for class
423 #define DECL_XMLOBJECT_SIMPLE(linkage,cname,proper,desc) \
424 BEGIN_XMLOBJECT(linkage,cname,xmltooling::XMLObject,desc); \
425 DECL_XMLOBJECT_CONTENT(proper); \
429 * Declares and defines an implementation class for an XMLObject with
430 * a simple content model and type, handling it as string data.
432 * @param linkage linkage specifier for the class
433 * @param cname the name of the XMLObject specialization
434 * @param proper the proper name to label the element's content
436 #define DECL_XMLOBJECTIMPL_SIMPLE(linkage,cname,proper) \
437 class linkage cname##Impl \
439 public xmltooling::AbstractDOMCachingXMLObject, \
440 public xmltooling::AbstractValidatingXMLObject, \
441 public xmltooling::AbstractXMLObjectMarshaller, \
442 public xmltooling::AbstractXMLObjectUnmarshaller \
445 virtual ~cname##Impl() {} \
446 cname##Impl(const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const QName* schemaType) \
447 : xmltooling::AbstractXMLObject(nsURI, localName, prefix, schemaType), m_##proper(NULL) { \
449 cname##Impl(const cname##Impl& src) \
450 : xmltooling::AbstractXMLObject(src), \
451 xmltooling::AbstractDOMCachingXMLObject(src), \
452 xmltooling::AbstractValidatingXMLObject(src), \
453 m_##proper(XMLString::replicate(src.m_##proper)) { \
455 IMPL_XMLOBJECT_CLONE(cname) \
456 IMPL_XMLOBJECT_CONTENT(proper) \
460 * Begins the declaration of an XMLObjectBuilder specialization.
461 * Basic boilerplate includes an empty virtual destructor, and
462 * a default builder that defaults the element name.
464 * @param linkage linkage specifier for the class
465 * @param cname the name of the XMLObject specialization
466 * @param namespaceURI the XML namespace of the default associated element
467 * @param namespacePrefix the XML namespace prefix of the default associated element
469 #define BEGIN_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix) \
470 XMLTOOLING_DOXYGEN(Builder for cname objects.) \
471 class linkage cname##Builder : public xmltooling::XMLObjectBuilder { \
473 virtual ~cname##Builder() {} \
474 XMLTOOLING_DOXYGEN(Default builder.) \
475 virtual cname* buildObject() const { \
476 return buildObject(namespaceURI,cname::LOCAL_NAME,namespacePrefix); \
478 virtual cname* buildObject( \
479 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const xmltooling::QName* schemaType=NULL \
483 * Ends the declaration of an XMLObjectBuilder specialization.
485 #define END_XMLOBJECTBUILDER }
488 * Declares a generic XMLObjectBuilder specialization.
490 * @param linkage linkage specifier for the class
491 * @param cname the name of the XMLObject specialization
492 * @param namespaceURI the XML namespace of the default associated element
493 * @param namespacePrefix the XML namespace prefix of the default associated element
495 #define DECL_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix) \
496 BEGIN_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix); \
500 * Implements the standard XMLObjectBuilder specialization function.
502 * @param cname the name of the XMLObject specialization
504 #define IMPL_XMLOBJECTBUILDER(cname) \
505 cname* cname##Builder::buildObject( \
506 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const QName* schemaType \
509 return new cname##Impl(nsURI,localName,prefix,schemaType); \
513 * Begins the declaration of a Schema Validator specialization.
515 * @param linkage linkage specifier for the class
516 * @param cname the base name of the Validator specialization
518 #define BEGIN_XMLOBJECTVALIDATOR(linkage,cname) \
519 class linkage cname##SchemaValidator : public xmltooling::Validator \
522 virtual ~cname##SchemaValidator() {} \
523 virtual cname##SchemaValidator* clone() const { \
524 return new cname##SchemaValidator(); \
526 virtual void validate(const xmltooling::XMLObject* xmlObject) const { \
527 const cname* ptr=dynamic_cast<const cname*>(xmlObject); \
529 throw xmltooling::ValidationException(#cname"SchemaValidator: unsupported object type ($1).",xmltooling::params(1,typeid(xmlObject).name()))
532 * Ends the declaration of a Validator specialization.
534 #define END_XMLOBJECTVALIDATOR } }
537 * Validator code that checks the object type.
539 * @param cname the name of the XMLObject specialization
541 #define XMLOBJECTVALIDATOR_CHECKTYPE(cname) \
542 const cname* ptr=dynamic_cast<const cname*>(xmlObject); \
544 throw xmltooling::ValidationException(#cname"SchemaValidator: unsupported object type ($1).",xmltooling::params(1,typeid(xmlObject).name()))
547 * Validator code that checks for a required attribute, content, or singleton.
549 * @param cname the name of the XMLObject specialization
550 * @param proper the proper name of the attribute, content, or singleton member
552 #define XMLOBJECTVALIDATOR_REQUIRE(cname,proper) \
553 if (!ptr->get##proper()) \
554 throw xmltooling::ValidationException(#cname" must have "#proper".")
557 * Validator code that checks for one of a pair of
558 * required attributes, content, or singletons.
560 * @param cname the name of the XMLObject specialization
561 * @param proper1 the proper name of the first attribute, content, or singleton member
562 * @param proper2 the proper name of the second attribute, content, or singleton member
564 #define XMLOBJECTVALIDATOR_ONEOF(cname,proper1,proper2) \
565 if (!ptr->get##proper1() && !ptr->get##proper2()) \
566 throw xmltooling::ValidationException(#cname" must have "#proper1" or "#proper2".")
569 * Validator code that checks for one of a set of three
570 * required attributes, content, or singletons.
572 * @param cname the name of the XMLObject specialization
573 * @param proper1 the proper name of the first attribute, content, or singleton member
574 * @param proper2 the proper name of the second attribute, content, or singleton member
575 * @param proper3 the proper name of the third attribute, content, or singleton member
577 #define XMLOBJECTVALIDATOR_ONEOF3(cname,proper1,proper2,proper3) \
578 if (!ptr->get##proper1() && !ptr->get##proper2() && !ptr->get##proper3()) \
579 throw xmltooling::ValidationException(#cname" must have "#proper1", "#proper2", or "#proper3".")
582 * Validator code that checks a co-constraint (if one present, the other must be)
583 * between a pair of attributes, content, or singletons.
585 * @param cname the name of the XMLObject specialization
586 * @param proper1 the proper name of the first attribute, content, or singleton member
587 * @param proper2 the proper name of the second attribute, content, or singleton member
589 #define XMLOBJECTVALIDATOR_NONEORBOTH(cname,proper1,proper2) \
590 if ((ptr->get##proper1() && !ptr->get##proper2()) || (!ptr->get##proper1() && ptr->get##proper2())) \
591 throw xmltooling::ValidationException(#cname" cannot have "#proper1" without "#proper2".")
594 * Validator code that checks for a non-empty collection.
596 * @param cname the name of the XMLObject specialization
597 * @param proper the proper name of the collection item
599 #define XMLOBJECTVALIDATOR_NONEMPTY(cname,proper) \
600 if (ptr->get##proper##s().empty()) \
601 throw xmltooling::ValidationException(#cname" must have at least one "#proper".")
604 * Declares/defines a Validator specialization that checks object type and
605 * a non-empty simple content model.
607 * @param linkage linkage specifier for the class
608 * @param cname the name of the XMLObject specialization
609 * @param proper the proper name to label the element's content
611 #define XMLOBJECTVALIDATOR_SIMPLE(linkage,cname,proper) \
612 BEGIN_XMLOBJECTVALIDATOR(linkage,cname); \
613 XMLOBJECTVALIDATOR_REQUIRE(cname,proper); \
614 END_XMLOBJECTVALIDATOR
619 * @namespace xmltooling
620 * Public namespace of XML Tooling library
622 namespace xmltooling {
625 * Template function for cloning a sequence of XMLObjects.
626 * Invokes the clone() member on each element of the input sequence and adds the copy to
627 * the output sequence. Order is preserved.
629 * @param in input sequence to clone
630 * @param out output sequence to copy cloned pointers into
632 template<class InputSequence,class OutputSequence> void clone(const InputSequence& in, OutputSequence& out) {
633 for (typename InputSequence::const_iterator i=in.begin(); i!=in.end(); i++) {
635 out.push_back((*i)->clone());
642 * Functor for cleaning up heap objects in containers.
644 template<class T> struct cleanup
647 * Function operator to delete an object.
649 * @param ptr object to delete
651 void operator()(T* ptr) {delete ptr;}
654 * Function operator to delete an object stored as const.
656 * @param ptr object to delete after casting away const
658 void operator()(const T* ptr) {delete const_cast<T*>(ptr);}
662 * Functor for cleaning up heap objects in key/value containers.
664 template<class A,class B> struct cleanup_pair
667 * Function operator to delete an object.
669 * @param p a pair in which the second component is the object to delete
671 void operator()(const std::pair<A,B*>& p) {delete p.second;}
675 #endif /* __xmltooling_base_h__ */