Changeset 540 for library/bdm/base/user_info.h

Timestamp:

08/17/09 09:25:19 (15 years ago)

Author:

vbarta

Message:

split UIException into 3

Files:

• library/bdm/base/user_info.h (modified) (10 diffs)

library/bdm/base/user_info.h

@@ -34 +34 @@
 namespace bdm {
 
-//! Exception prepared for reporting user-info errors which are always related to some concrete Setting path
+//! Generic exception for reporting configuration errors
 //!
 //!  \ref ui_page
 class UIException : public std::exception {
-
-public:
+private:
         //! Error message
         const string message;
 
-        //! Path to the problematic setting
-        const string path;
-
-private:
-        string what_message;
-
+public:
+        /*!
+          \brief The constructor
+          \param message the reason for throwing the exception. Should be a complete English sentence (or a couple sentences), starting with "UIException: ".
+        */
+        UIException ( const string &message ) :
+                message ( message ) {
+        }
+
+        //! Overriden method for reporting the error message
+        virtual const char* what() const throw() {
+                return message.c_str();
+        }
+
+        ~UIException() throw() {};
+
+protected:
+        /*!
+          Formats error messages for derived classes, which use a
+          Setting path in addition to the message.
+        */
+        static string format_message( const string &reason, const string &path );
+};
+
+//! Exception for reporting configuration errors related to some concrete Setting path
+//!
+//!  \ref ui_page
+class UISettingException : public UIException {
 public:
         //! Use this constructor when you can pass the problematical Setting as a parameter
-        UIException ( const string &message, const Setting &element )
-                        : message ( "UI error: " + message + "." ), path ( "Check path \"" + string ( element.getPath() ) + "\"." ) {
-                init_what_message();
+        UISettingException ( const string &message, const Setting &element ):
+                UIException ( format_message ( message, string ( element.getPath() ) ) ) {
         }
 
         //! This constructor is for other occasions, when only path of problematical Setting is known
-        UIException ( const string &message, const string &path )
-                        : message ( "UI error: " + message + "." ), path ( "Check path \"" + path + "\"." ) {
-                init_what_message();
-        }
-
-        //! Overriden method for reporting an error message
-        virtual const char* what() const throw() {
-                return what_message.c_str();
-        }
-
-        ~UIException() throw() {};
-
-private:
-        void init_what_message() {
-                what_message = message;
-                what_message += ' ';
-                what_message += path;
-        }
+        UISettingException ( const string &message, const string &path ):
+                UIException ( format_message ( message, path ) ) {
+        }
+
+        ~UISettingException() throw() {};
 };
 
+//! Exception for reporting configuration errors in the "class" attribute
+//!
+//!  \ref ui_page
+class UIClassException : public UIException {
+public:
+        //! Use this constructor when you can pass the problematical Setting as a parameter
+        UIClassException ( const string &message, const Setting &element ):
+                UIException ( format_message ( message, string ( element.getPath() ) ) ) {
+        }
+
+        //! This constructor is for other occasions, when only path of problematical Setting is known
+        UIClassException ( const string &message, const string &path ):
+                UIException ( format_message ( message, path ) ) {
+        }
+
+        ~UIClassException() throw() {};
+};
 
 /*!
@@ -291 +315 @@
                 string class_name;
                 if ( !link.result.lookupValue ( "class", class_name ) )
-                        throw UIException ( "the obligatory \"class\" identifier is missing", link.result );
+                        throw UIClassException ( "UIException: the obligatory \"class\" identifier is missing.", link.result );
 
                 // then we find a user-info related to this type
@@ -302 +326 @@
                 if ( !instance ) {
                         delete typeless_instance;
-                        throw UIException ( "class " + class_name + " is not a descendant of the desired output class. Try to call the UI::build<T> function with a different type parameter.", link.result );
+                        throw UIClassException ( "UIException: class " + class_name + " is not a descendant of the desired output class. Try to call the UI::build<T> function with a different type parameter.", link.result );
                 }
 
@@ -308 +332 @@
                         instance->from_setting ( link.result );
                 } catch ( SettingException sttng_xcptn ) {
-                        string msg = "the method " + class_name + ".from_setting(Setting&) has thrown a SettingException. Try to correct this method. Check path \"" + sttng_xcptn.getPath() + "\".";
-                        throw UIException(msg, link.result);
+                        string msg = "UIException: method ";
+                        msg += class_name;
+                        msg += ".from_setting(Setting&) has thrown a SettingException.";
+                        throw UISettingException(msg, sttng_xcptn.getPath());
                 }
         }
@@ -342 +368 @@
         //! The exception can help to find the place where the template is misused and also to correct it.
         template<class T> static void from_setting ( T &variable_to_load, const Setting &element ) {
-                std::string msg = "from_setting is not implemented for type ";
+                std::string msg = "UIException: from_setting is not implemented for type ";
                 msg += typeid(T).name();
-                throw UIException ( msg, element );
+                msg += '.';
+                throw UISettingException ( msg, element );
         }
 
@@ -372 +399 @@
                                 return shared_ptr<T>();
                         else
-                                throw UIException ( "the compulsory Setting named \"" + name + "\" is missing", element );
+                                throw UISettingException ( "UIException: the compulsory Setting named \"" + name + "\" is missing.", element );
                 }
 
@@ -391 +418 @@
                                 stringstream stream;
                                 stream << index;
-                                throw UIException ( "the compulsory Setting with the index " + stream.str() + " is missing", element );
+                                throw UISettingException ( "UIException: the compulsory Setting with the index " + stream.str() + " is missing.", element );
                         }
                 }
@@ -413 +440 @@
                                 return false;
                         else
-                                throw UIException ( "the compulsory Setting named \"" + name + "\" is missing", element );
+                                throw UISettingException ( "UIException: the compulsory Setting named \"" + name + "\" is missing.", element );
                 }
 
@@ -428 +455 @@
                         else {
                                 stringstream stream;
+                                stream << "UIException: the compulsory Setting with the index " << index << " is missing.";
                                 stream << index;
-                                throw UIException ( "the compulsory Setting with the index " + stream.str() + " is missing", element );
+                                throw UISettingException (stream.str(), element );
                         }
                 }
@@ -494 +522 @@
                         instance->to_setting ( set );
                 } catch ( SettingException sttng_xcptn ) {
-                    string msg = "the method ";
-                    msg += class_name;
-                    msg += ".to_setting(Setting&) has thrown a SettingException. Try to correct this method.";
-                    throw UIException(msg, sttng_xcptn.getPath());
+                        string msg = "UIException: method ";
+                        msg += class_name;
+                        msg += ".to_setting(Setting&) has thrown a SettingException.";
+                        throw UISettingException(msg, sttng_xcptn.getPath());
                 }
         }