Parameter to plugin should be a const reference.
[shibboleth/cpp-xmltooling.git] / xmltooling / validation / AbstractValidatingXMLObject.h
1 /*\r
2  *  Copyright 2001-2006 Internet2\r
3  * \r
4  * Licensed under the Apache License, Version 2.0 (the "License");\r
5  * you may not use this file except in compliance with the License.\r
6  * You may obtain a copy of the License at\r
7  *\r
8  *     http://www.apache.org/licenses/LICENSE-2.0\r
9  *\r
10  * Unless required by applicable law or agreed to in writing, software\r
11  * distributed under the License is distributed on an "AS IS" BASIS,\r
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
13  * See the License for the specific language governing permissions and\r
14  * limitations under the License.\r
15  */\r
16 \r
17 /**\r
18  * @file AbstractValidatingXMLObject.h\r
19  * \r
20  * Extension of AbstractXMLObject that implements a ValidatingXMLObject. \r
21  */\r
22 \r
23 #if !defined(__xmltooling_abstractvalxmlobj_h__)\r
24 #define __xmltooling_abstractvalxmlobj_h__\r
25 \r
26 #include <xmltooling/AbstractXMLObject.h>\r
27 #include <xmltooling/validation/ValidatingXMLObject.h>\r
28 \r
29 #if defined (_MSC_VER)\r
30     #pragma warning( push )\r
31     #pragma warning( disable : 4250 4251 )\r
32 #endif\r
33 \r
34 namespace xmltooling {\r
35 \r
36     /**\r
37      * Extension of AbstractXMLObject that implements a ValidatingXMLObject.\r
38      */\r
39     class XMLTOOL_API AbstractValidatingXMLObject : public virtual AbstractXMLObject, public virtual ValidatingXMLObject\r
40     {\r
41     public:\r
42         virtual ~AbstractValidatingXMLObject();\r
43         \r
44         /**\r
45          * @see ValidatingXMLObject::registerValidator()\r
46          */\r
47         void registerValidator(Validator* validator);\r
48         \r
49         /**\r
50          * @see ValidatingXMLObject::deregisterValidator()\r
51          */\r
52         void deregisterValidator(Validator* validator);\r
53 \r
54         /**\r
55          * @see ValidatingXMLObject::deregisterAll()\r
56          */\r
57         void deregisterAll();\r
58         \r
59         /**\r
60          * @see ValidatingXMLObject::validate()\r
61          */\r
62         void validate(bool validateDescendants) const;\r
63 \r
64     protected:\r
65         AbstractValidatingXMLObject() : m_validators(NULL) {}\r
66 \r
67         /** Copy constructor. */\r
68         AbstractValidatingXMLObject(const AbstractValidatingXMLObject& src);\r
69 \r
70     private:\r
71         struct XMLTOOL_DLLLOCAL ValidatorWrapper {\r
72             ~ValidatorWrapper(); \r
73             std::vector<Validator*> v;\r
74         };\r
75     \r
76         mutable ValidatorWrapper* m_validators;\r
77     };\r
78     \r
79 };\r
80 \r
81 #if defined (_MSC_VER)\r
82     #pragma warning( pop )\r
83 #endif\r
84 \r
85 #endif /* __xmltooling_abstractvalxmlobj_h__ */\r