2 * Copyright 2001-2007 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.
18 * @file xmltooling/exceptions.h
23 #ifndef __xmltooling_exceptions_h__
24 #define __xmltooling_exceptions_h__
30 #include <xmltooling/base.h>
33 * Declares a derived exception class
35 * @param name the exception class
36 * @param linkage linkage specification for class
37 * @param ns the exception class C++ namespace
38 * @param base the base class
39 * @param desc documentation comment for class
41 #define DECL_XMLTOOLING_EXCEPTION(name,linkage,ns,base,desc) \
42 XMLTOOLING_DOXYGEN(desc) \
43 class linkage name : public base { \
45 XMLTOOLING_DOXYGEN(Constructor) \
46 name(const char* msg=NULL, const xmltooling::params& p=xmltooling::params()) : base(msg,p) {} \
47 XMLTOOLING_DOXYGEN(Constructor) \
48 name(const char* msg, const xmltooling::namedparams& p) : base(msg,p) {} \
49 XMLTOOLING_DOXYGEN(Constructor) \
50 name(const std::string& msg, const xmltooling::params& p=xmltooling::params()) : base(msg,p) {} \
51 XMLTOOLING_DOXYGEN(Constructor) \
52 name(const std::string& msg, const xmltooling::namedparams& p) : base(msg,p) {} \
53 virtual ~name() throw () {} \
54 virtual const char* getClassName() const { return #ns"::"#name; } \
55 void raise() const {throw *this;} \
59 * Declares a factory function for an exception class.
61 * @param name the exception class name
62 * @param ns the exception class C++ namespace
64 #define DECL_XMLTOOLING_EXCEPTION_FACTORY(name,ns) \
65 xmltooling::XMLToolingException* name##Factory() \
67 return new ns::name(); \
71 * Registers a factory for an exception class.
73 * @param name the exception class name
74 * @param ns the exception class C++ namespace
76 #define REGISTER_XMLTOOLING_EXCEPTION_FACTORY(name,ns) XMLToolingException::registerFactory(#ns"::"#name,name##Factory)
78 #if defined (_MSC_VER)
79 #pragma warning( push )
80 #pragma warning( disable : 4250 4251 )
83 namespace xmltooling {
86 * Wrapper around a variable number of arguments.
88 class XMLTOOL_API params
92 * Initializes with zero parameters.
97 * Initializes the parameter set.
99 * @param count the number of parameters that follow
101 params(int count,...);
104 * Returns an immutable reference to the set of parameters.
106 * @return the parameter set
108 const std::vector<const char*>& get() const {return v;}
111 /** Contains the parameters being passed. */
112 std::vector<const char*> v;
116 * Wrapper around a variable number of name/value pairs.
118 class XMLTOOL_API namedparams : public params
122 * Initializes with zero parameters.
127 * Initializes the named parameter set.
129 * @param count the number of name/value pairs that follow (must be even)
131 namedparams(int count,...);
135 * Base exception class, supports parametrized messages and XML serialization.
136 * Parameters are prefixed with a dollar sign ($) and can be positional ($1)
139 class XMLTOOL_EXCEPTIONAPI(XMLTOOL_API) XMLToolingException : public std::exception
142 virtual ~XMLToolingException() throw () {}
145 * Constructs an exception using a message and positional parameters.
147 * @param msg error message
148 * @param p an ordered set of positional parameter strings
150 XMLToolingException(const char* msg=NULL, const params& p=params());
153 * Constructs an exception using a message and named parameters.
155 * @param msg error message
156 * @param p a set of named parameter strings
158 XMLToolingException(const char* msg, const namedparams& p);
161 * Constructs an exception using a message and positional parameters.
163 * @param msg error message
164 * @param p an ordered set of positional parameter strings
166 XMLToolingException(const std::string& msg, const params& p=params());
169 * Constructs an exception using a message and named parameters.
171 * @param msg error message
172 * @param p a set of named parameter strings
174 XMLToolingException(const std::string& msg, const namedparams& p);
177 * Returns the error message, after processing any parameter references.
179 * @return the processed message
181 const char* getMessage() const;
184 * Returns the error message, after processing any parameter references.
186 * @return the processed message
188 const char* what() const throw () {return getMessage();}
191 * Sets the error message.
193 * @param msg the error message
195 void setMessage(const char* msg);
198 * Sets the error message.
200 * @param msg the error message
202 void setMessage(const std::string& msg) {
203 setMessage(msg.c_str());
207 * Attach a set of positional parameters to the exception.
209 * @param p an ordered set of named parameter strings
211 void addProperties(const params& p);
214 * Attach a set of named parameters to the exception.
216 * @param p a set of named parameter strings
218 void addProperties(const namedparams& p);
221 * Attach a single positional parameter at the next available position.
223 * @param value the parameter value
225 void addProperty(const char* value) {
226 addProperties(params(1,value));
230 * Attach a single named parameter.
232 * @param name the parameter name
233 * @param value the parameter value
235 void addProperty(const char* name, const char* value) {
236 addProperties(namedparams(1,name,value));
240 * Returns the parameter property with the designated position (based from one).
242 * @param index position to access
243 * @return the parameter property or NULL
245 const char* getProperty(unsigned int index) const;
248 * Returns the parameter property with the designated name.
250 * @param name named parameter to access
251 * @return the parameter property or NULL
253 const char* getProperty(const char* name) const;
256 * Raises an exception using itself.
257 * Used to raise an exception of a derived type.
259 virtual void raise() const {
264 * Returns a unique name for the exception class.
268 virtual const char* getClassName() const {
269 return "xmltooling::XMLToolingException";
273 * Returns a string containing a serialized representation of the exception.
275 * @return the serialization
277 std::string toString() const;
280 * Returns a set of query string name/value pairs, URL-encoded, representing the
281 * exception's type, message, and parameters.
283 * @return the query string representation
285 std::string toQueryString() const;
289 mutable std::string m_processedmsg;
290 std::map<std::string,std::string> m_params;
294 * Builds an empty exception of the given type.
296 * @param exceptionClass the name of the exception type to build
297 * @return an empty exception object
299 static XMLToolingException* getInstance(const char* exceptionClass);
302 * Builds an exception from a serialized input stream.
304 * @param in input stream
305 * @return the exception object found in the stream
307 static XMLToolingException* fromStream(std::istream& in);
310 * Builds an exception from a serialized input buffer.
312 * @param s input buffer
313 * @return the exception object found in the buffer
315 static XMLToolingException* fromString(const char* s);
317 /** A factory function that returns an empty exception object of a given type. */
318 typedef XMLToolingException* ExceptionFactory();
321 * Registers a factory to create exceptions of a given class name.
323 * @param exceptionClass name of exception type
324 * @param factory factory function to build exceptions with
326 static void registerFactory(const char* exceptionClass, ExceptionFactory* factory) {
327 m_factoryMap[exceptionClass] = factory;
331 * Unregisters the factory for a given class name.
333 * @param exceptionClass name of exception type
335 static void deregisterFactory(const char* exceptionClass) {
336 m_factoryMap.erase(exceptionClass);
340 * Unregisters all factories.
342 static void deregisterFactories() {
343 m_factoryMap.clear();
347 typedef std::map<std::string,ExceptionFactory*> ExceptionFactoryMap;
348 static ExceptionFactoryMap m_factoryMap;
351 DECL_XMLTOOLING_EXCEPTION(XMLParserException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions related to XML parsing);
352 DECL_XMLTOOLING_EXCEPTION(XMLObjectException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions in basic object usage);
353 DECL_XMLTOOLING_EXCEPTION(MarshallingException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions during object marshalling);
354 DECL_XMLTOOLING_EXCEPTION(UnmarshallingException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions during object unmarshalling);
355 DECL_XMLTOOLING_EXCEPTION(UnknownElementException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions due to processing of unknown element content);
356 DECL_XMLTOOLING_EXCEPTION(UnknownAttributeException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions due to processing of unknown attributes);
357 DECL_XMLTOOLING_EXCEPTION(UnknownExtensionException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions from use of an unrecognized extension/plugin);
358 DECL_XMLTOOLING_EXCEPTION(ValidationException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions during object validation);
359 DECL_XMLTOOLING_EXCEPTION(IOException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions related to physical input/output errors);
361 #ifndef XMLTOOLING_NO_XMLSEC
362 DECL_XMLTOOLING_EXCEPTION(XMLSecurityException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmltooling,XMLToolingException,Exceptions related to the XML security layer);
366 #if defined (_MSC_VER)
367 #pragma warning( pop )
370 #endif /* __xmltooling_exceptions_h__ */