Evolving macros, reduce casting in accessors, add const collection access.
[shibboleth/cpp-xmltooling.git] / xmltooling / base.h
index de15fe1..7de34c5 100644 (file)
         type(const type&); \
         type& operator=(const type&);
 
+#define UNICODE_LITERAL_1(a) {chLatin_##a, chNull}
+#define UNICODE_LITERAL_2(a,b) {chLatin_##a, chLatin_##b, chNull}
+#define UNICODE_LITERAL_3(a,b,c) {chLatin_##a, chLatin_##b, chLatin_##c, chNull}
+#define UNICODE_LITERAL_4(a,b,c,d) {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chNull}
+#define UNICODE_LITERAL_5(a,b,c,d,e) {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chNull}
+#define UNICODE_LITERAL_6(a,b,c,d,e,f) {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chNull}
+#define UNICODE_LITERAL_7(a,b,c,d,e,f,g) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chNull}
+#define UNICODE_LITERAL_8(a,b,c,d,e,f,g,h) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chNull}
+#define UNICODE_LITERAL_9(a,b,c,d,e,f,g,h,i) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, chNull}
+#define UNICODE_LITERAL_10(a,b,c,d,e,f,g,h,i,j) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chNull}
+#define UNICODE_LITERAL_11(a,b,c,d,e,f,g,h,i,j,k) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chNull}
+#define UNICODE_LITERAL_12(a,b,c,d,e,f,g,h,i,j,k,l) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chNull}
+#define UNICODE_LITERAL_13(a,b,c,d,e,f,g,h,i,j,k,l,m) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chNull}
+#define UNICODE_LITERAL_14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chNull}
+#define UNICODE_LITERAL_15(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chNull}
+#define UNICODE_LITERAL_16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chNull}
+#define UNICODE_LITERAL_17(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chNull}
+#define UNICODE_LITERAL_18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, chNull}
+#define UNICODE_LITERAL_19(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
+        chLatin_##s, chNull}
+#define UNICODE_LITERAL_20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
+        chLatin_##s, chLatin_##t, chNull}
+#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) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
+        chLatin_##s, chLatin_##t, chLatin_##u, chNull}
+#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) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
+        chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chNull}
+#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) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
+        chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chLatin_##w, chNull}
+#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) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
+        chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chLatin_##w, chLatin_##x, chNull}
+#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) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
+        chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chLatin_##w, chLatin_##x, chLatin_##y, chNull}
+#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) \
+    {chLatin_##a, chLatin_##b, chLatin_##c, chLatin_##d, chLatin_##e, chLatin_##f, chLatin_##g, chLatin_##h, chLatin_##i, \
+        chLatin_##j, chLatin_##k, chLatin_##l, chLatin_##m, chLatin_##n, chLatin_##o, chLatin_##p, chLatin_##q, chLatin_##r, \
+        chLatin_##s, chLatin_##t, chLatin_##u, chLatin_##v, chLatin_##w, chLatin_##x, chLatin_##y, chLatin_##z, chNull}
+
 /**
  * Begins the declaration of an XMLObject specialization.
  * Basic boilerplate includes a protected constructor, empty virtual destructor,
  * and Unicode constants for the default associated element's name and prefix.
  * 
- * @param cname the name of the class to declare
- * @param base  the base class to derive from using public virtual inheritance
+ * @param linkage   linkage specifier for the class
+ * @param cname     the name of the class to declare
+ * @param base      the base class to derive from using public virtual inheritance
  */
-#define BEGIN_XMLOBJECT(cname,base) \
-    class XMLTOOL_API cname : public virtual base, public virtual ValidatingXMLObject { \
+#define BEGIN_XMLOBJECT(linkage,cname,base) \
+    class linkage cname : public virtual base, public virtual ValidatingXMLObject { \
     protected: \
         cname() {} \
     public: \
  * @param upcased   the upcased name of the attribute
  */
 #define DECL_XMLOBJECT_ATTRIB(proper,upcased) \
-    XMLTOOLING_DOXYGEN(proper attribute name) \
-    static const XMLCh upcased##_ATTRIB_NAME[]; \
-    XMLTOOLING_DOXYGEN(Returns the proper attribute.) \
-    virtual const XMLCh* get##proper() const=0; \
-    XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
-    virtual void set##proper(const XMLCh* proper)=0
+    public: \
+        XMLTOOLING_DOXYGEN(proper attribute name) \
+        static const XMLCh upcased##_ATTRIB_NAME[]; \
+        XMLTOOLING_DOXYGEN(Returns the proper attribute.) \
+        virtual const XMLCh* get##proper() const=0; \
+        XMLTOOLING_DOXYGEN(Sets the proper attribute.) \
+        virtual void set##proper(const XMLCh* proper)=0
 
 /**
  * Implements get/set methods and a private member for a named XML attribute.
         }
 
 /**
+ * Declares abstract get/set methods for a typed XML child object.
+ * 
+ * @param proper    the proper name of the child type
+ */
+#define DECL_XMLOBJECT_CHILD(proper) \
+    public: \
+        XMLTOOLING_DOXYGEN(Returns the proper child.) \
+        virtual proper* get##proper() const=0; \
+        XMLTOOLING_DOXYGEN(Sets the proper child.) \
+        virtual void set##proper(proper* child)=0
+
+/**
+ * Implements get/set methods and a private list iterator member for a typed XML child object.
+ * 
+ * @param proper    the proper name of the child type
+ */
+#define IMPL_XMLOBJECT_CHILD(proper) \
+    private: \
+        proper* m_##proper; \
+        std::list<XMLObject*>::iterator m_pos_##proper; \
+    public: \
+        proper* get##proper() const { \
+            return m_##proper; \
+        } \
+        void set##proper(proper* child) { \
+            prepareForAssignment(m_##proper,child); \
+            *m_pos_##proper = m_##proper = child; \
+        }
+
+/**
+ * Declares abstract get/set methods for a typed XML child collection.
+ * 
+ * @param proper    the proper name of the child type
+ */
+#define DECL_XMLOBJECT_CHILDREN(proper) \
+    public: \
+        XMLTOOLING_DOXYGEN(Returns modifiable proper collection.) \
+        virtual VectorOf(proper) get##proper##s()=0; \
+        XMLTOOLING_DOXYGEN(Returns reference to immutable proper collection.) \
+        virtual const std::vector<proper*>& get##proper##s() const=0
+
+/**
+ * Implements get method and a private vector member for a typed XML child collection.
+ * 
+ * @param proper    the proper name of the child type
+ * @param fence     insertion fence for new objects of the child collection in backing list
+ */
+#define IMPL_XMLOBJECT_CHILDREN(proper,fence) \
+    private: \
+        std::vector<proper*> m_##proper##s; \
+    public: \
+        VectorOf(proper) get##proper##s() { \
+            return VectorOf(proper)(this, m_##proper##s, &m_children, fence); \
+        } \
+        const std::vector<proper*>& get##proper##s() const { \
+            return m_##proper##s; \
+        } 
+
+/**
+ * Implements unmarshalling process branch for typed child collection element
+ * 
+ * @param proper        the proper name of the child type
+ * @param namespaceURI  the XML namespace of the child element
+ */
+#define PROC_XMLOBJECT_CHILDREN(proper,namespaceURI) \
+    if (XMLHelper::isNodeNamed(root,namespaceURI,proper##::LOCAL_NAME)) { \
+        proper* typesafe=dynamic_cast<proper*>(childXMLObject); \
+        if (typesafe) { \
+            get##proper##s().push_back(typesafe); \
+            return; \
+        } \
+    }
+
+/**
+ * Implements unmarshalling process branch for typed child singleton element
+ * 
+ * @param proper        the proper name of the child type
+ * @param namespaceURI  the XML namespace of the child element
+ */
+#define PROC_XMLOBJECT_CHILD(proper,namespaceURI) \
+    if (XMLHelper::isNodeNamed(root,namespaceURI,proper##::LOCAL_NAME)) { \
+        proper* typesafe=dynamic_cast<proper*>(childXMLObject); \
+        if (typesafe) { \
+            set##proper(typesafe); \
+            return; \
+        } \
+    }
+
+/**
  * Declares abstract get/set methods for named XML element content.
  * 
  * @param proper    the proper name to label the element's content
     }
 
 /**
+ * Declares and defines an implementation class for an XMLObject with
+ * a simple content model and type, handling it as string data.
+ * 
+ * @param linkage   linkage specifier for the class
+ * @param cname     the name of the XMLObject specialization
+ * @param proper    the proper name to label the element's content
+ */
+#define DECL_XMLOBJECTIMPL_SIMPLE(linkage,cname,proper) \
+    class linkage cname##Impl \
+        : public cname, \
+            public AbstractDOMCachingXMLObject, \
+            public AbstractValidatingXMLObject, \
+            public AbstractXMLObjectMarshaller, \
+            public AbstractXMLObjectUnmarshaller \
+    { \
+    public: \
+        virtual ~cname##Impl() {} \
+        cname##Impl(const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const QName* schemaType) \
+            : AbstractXMLObject(nsURI, localName, prefix, schemaType), m_##proper(NULL) { \
+        } \
+        cname##Impl(const cname##Impl& src) \
+            : AbstractXMLObject(src), \
+                AbstractDOMCachingXMLObject(src), \
+                AbstractValidatingXMLObject(src), \
+                m_##proper(XMLString::replicate(src.m_##proper)) { \
+        } \
+        IMPL_XMLOBJECT_CLONE(cname) \
+        IMPL_XMLOBJECT_CONTENT(proper) \
+    }
+    
+/**
  * Begins the declaration of an XMLObjectBuilder specialization.
  * Basic boilerplate includes an empty virtual destructor, and
- * a default builder.
+ * a default builder that defaults the element name.
  * 
- * @param cname the name of the XMLObject specialization
+ * @param linkage           linkage specifier for the class
+ * @param cname             the name of the XMLObject specialization
+ * @param namespaceURI      the XML namespace of the default associated element
+ * @param namespacePrefix   the XML namespace prefix of the default associated element
  */
-#define BEGIN_XMLOBJECTBUILDER(cname) \
+#define BEGIN_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix) \
     XMLTOOLING_DOXYGEN(Builder for cname objects.) \
-    class XMLTOOL_API cname##Builder : public xmltooling::XMLObjectBuilder { \
+    class linkage cname##Builder : public xmltooling::XMLObjectBuilder { \
     public: \
         virtual ~cname##Builder() {} \
         XMLTOOLING_DOXYGEN(Default builder.) \
-        virtual cname* buildObject() const=0
+        virtual cname* buildObject() const { \
+            return buildObject(namespaceURI,cname::LOCAL_NAME,namespacePrefix); \
+        } \
+        virtual cname* buildObject( \
+            const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const QName* schemaType=NULL \
+            ) const
 
 /**
  * Ends the declaration of an XMLObjectBuilder specialization.
 #define END_XMLOBJECTBUILDER }
 
 /**
- * Begins the declaration of an XMLObjectBuilder specialization implementation class.
+ * Declares a generic XMLObjectBuilder specialization.
  * 
+ * @param linkage           linkage specifier for the class
  * @param cname             the name of the XMLObject specialization
  * @param namespaceURI      the XML namespace of the default associated element
  * @param namespacePrefix   the XML namespace prefix of the default associated element
  */
-#define BEGIN_XMLOBJECTBUILDERIMPL(cname,namespaceURI,namespacePrefix) \
-    class XMLTOOL_DLLLOCAL cname##BuilderImpl : public cname##Builder { \
-    public: \
-        cname* buildObject( \
-            const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const QName* schemaType=NULL \
-            ) const; \
-        cname* buildObject() const { \
-            return buildObject(namespaceURI,cname::LOCAL_NAME,namespacePrefix); \
-        }
+ #define DECL_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix) \
+    BEGIN_XMLOBJECTBUILDER(linkage,cname,namespaceURI,namespacePrefix); \
+    END_XMLOBJECTBUILDER
 
 /**
- * Begins the declaration of an XMLObjectBuilder specialization implementation class.
+ * Implements the standard XMLObjectBuilder specialization function. 
  * 
  * @param cname the name of the XMLObject specialization
  */
 #define IMPL_XMLOBJECTBUILDER(cname) \
-    cname* cname##BuilderImpl::buildObject( \
+    cname* cname##Builder::buildObject( \
         const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const QName* schemaType \
         ) const \
     { \
     }
 
 /**
- * Ends the declaration of an XMLObjectBuilder specialization implementation class.
- */
-#define END_XMLOBJECTBUILDERIMPL }
-
-/**
- * Begins the declaration of a Validator specialization.
+ * Begins the declaration of a Schema Validator specialization.
  * 
+ * @param linkage           linkage specifier for the class
  * @param cname the base name of the Validator specialization
  */
- #define BEGIN_XMLOBJECTVALIDATOR(cname) \
-    class cname##Validator : public Validator \
+ #define BEGIN_XMLOBJECTVALIDATOR(linkage,cname) \
+    class linkage cname##SchemaValidator : public Validator \
     { \
     public: \
-        virtual ~cname##Validator() {} \
-        Validator* clone() const { \
-            return new cname##Validator(); \
+        virtual ~cname##SchemaValidator() {} \
+        virtual cname##SchemaValidator* clone() const { \
+            return new cname##SchemaValidator(); \
         } \
-        void validate(const XMLObject* xmlObject) const
+        virtual void validate(const XMLObject* xmlObject) const { \
+            const cname* ptr=dynamic_cast<const cname*>(xmlObject); \
+            if (!ptr) \
+                throw ValidationException(#cname"SchemaValidator: unsupported object type ($1).",xmltooling::params(1,typeid(xmlObject).name()))
 
 /**
  * Ends the declaration of a Validator specialization.
  */
-#define END_XMLOBJECTVALIDATOR }
+#define END_XMLOBJECTVALIDATOR } }
 
+/**
+ * Validator code that checks the object type.
+ * 
+ * @param cname     the name of the XMLObject specialization
+ */
+#define XMLOBJECTVALIDATOR_CHECKTYPE(cname) \
+    const cname* ptr=dynamic_cast<const cname*>(xmlObject); \
+    if (!ptr) \
+        throw ValidationException(#cname"SchemaValidator: unsupported object type ($1).",xmltooling::params(1,typeid(xmlObject).name()))
+
+/**
+ * Validator code that checks for a required attribute, content, or singleton.
+ * 
+ * @param cname     the name of the XMLObject specialization
+ * @param proper    the proper name of the attribute, content, or singleton member 
+ */
+#define XMLOBJECTVALIDATOR_REQUIRE(cname,proper) \
+    if (!ptr->get##proper()) \
+        throw ValidationException(#cname" must have "#proper".")
+
+/**
+ * Validator code that checks for a non-empty collection.
+ * 
+ * @param cname     the name of the XMLObject specialization
+ * @param proper    the proper name of the collection item 
+ */
+#define XMLOBJECTVALIDATOR_CHECKEMPTY(cname,proper) \
+    if (ptr->get##proper##s().empty()) \
+        throw ValidationException(#cname" must have at least one "#proper".")
 
 #include <utility>