Changeset 1067:47939f501c81 in lemon-0.x

Timestamp:

01/10/05 00:28:18 (20 years ago)

Author:

Mihaly Barasz

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1463

Message:

Advances in error.h

• More clear exception usage concept
• sketch of LEMON_ASSERT interface
• test file

Location:

src/work

Files:

• klao/Makefile (modified) (1 diff)
• klao/error.h (modified) (15 diffs)
• klao/error_test.cc (added)
• makefile (modified) (1 diff)

src/work/klao/Makefile

@@ -1 @@
-BINARIES = tag_demo
+BINARIES = error_test
 INCLUDEDIRS= -I. -I.. -I../.. -I../{marci,jacint,alpar,johanna,athos,akos} -I$(HOME)/boost
 include ../makefile
 
+CXXFLAGS += $(C)

src/work/klao/error.h

@@ -20 +20 @@
 //! \ingroup misc
 //! \file
-//! \brief Basic error handling (signaling) routines.
+//! \brief Basic exception classes and error handling.
 
 #include <exception>
 #include <string>
 #include <sstream>
+#include <iostream>
+#include <cstdlib>
 
 #include <boost/shared_ptr.hpp>
@@ -31 +33 @@
 
   /// Exception-safe convenient "error message" class.
+
+  /// Helper class which provides a convenient ostream-like (operator <<
+  /// based) interface to create a string message. Mostly useful in
+  /// exception classes (therefore the name).
   class ErrorMessage {
   protected:
-  ///\e 
+    ///\e 
     boost::shared_ptr<std::ostringstream> buf;
     
-  ///\e 
+    ///\e 
     bool init() throw() {
       try {
@@ -49 +55 @@
   public:
 
-  ///\e 
+    ///\e 
     ErrorMessage() throw() { init(); }
 
-  ///\e 
+    ///\e 
     ErrorMessage(const char *message) throw() {
       init();
@@ -58 +64 @@
     }
 
-  ///\e 
+    ///\e 
     ErrorMessage(const std::string &message) throw() {
       init();
@@ -64 +70 @@
     }
 
-  ///\e 
+    ///\e 
     template <typename T>
     ErrorMessage& operator<<(const T &t) throw() {
@@ -77 +83 @@
     }
 
-  ///\e 
+    ///\e 
     const char* message() throw() {
       if( !buf ) return 0;
@@ -96 +102 @@
    * Base class for exceptions used in LEMON.
    */
-  class Exception : public std::exception, public ErrorMessage {
-  public:
-  ///\e 
-    Exception() throw() {}
-  ///\e 
-    explicit Exception(const std::string &s) throw()
-      : ErrorMessage(s) {}
-  ///\e 
+  class Exception : public std::exception {
+  protected:
+    ///\e
+    const char *message;
+
+  public:
+    ///\e 
+    Exception() throw() : message(0) {}
+    ///\e 
+    explicit Exception(const char *msg) throw()
+      : message(msg) {}
+    ///\e 
     virtual ~Exception() throw() {}
     
-  ///\e 
+    ///\e 
     virtual const char* what() const throw() {
-      const char *mes = message();
-      if( mes ) return mes;
+      if( message ) return message;
       return "lemon::Exception";
     }
@@ -116 +125 @@
   ///\e 
   class LogicError : public Exception {
-  ///\e 
-    explicit LogicError(const std::string &s)
+  public:
+    ///\e 
+    explicit LogicError() {}
+    ///\e 
+    explicit LogicError(const char *s)
       : Exception(s) {}
   };
@@ -123 +135 @@
   ///\e 
   class RuntimeError : public Exception {
-  ///\e 
-    explicit RuntimeError(const std::string &s)
+  public:
+    ///\e
+    explicit RuntimeError() {}
+    ///\e
+    explicit RuntimeError(const char *s)
       : Exception(s) {}
   };
 
-  ///\e 
+  ///\e
   class RangeError : public RuntimeError {
-  ///\e 
-    explicit RangeError(const std::string &s)
+  public:
+    ///\e 
+    explicit RangeError(const char *s)
       : RuntimeError(s) {}
   };
@@ -137 +153 @@
   ///\e 
   class IOError : public RuntimeError {
-  ///\e 
-    explicit IOError(const std::string &s)
+  public:
+    ///\e 
+    explicit IOError(const char *s)
       : RuntimeError(s) {}
   };
@@ -144 +161 @@
   ///\e 
   class DataFormatError : public IOError {
-  ///\e 
-    explicit DataFormatError(const std::string &message)
-      : IOError(message) : line(0) {}
-  ///\e 
+  protected:
+    int line;
+    boost::shared_ptr<std::string> file;
+
+  public:
+    ///\e 
+    explicit DataFormatError(const char *message)
+      : IOError(message), line(0) {}
+    ///\e 
     DataFormatError(const std::string &file_name, int line_num,
-                    const std::string &message)
+                    const char *message)
       : IOError(message), line(line_num) { set_file(file_name); }
 
-  ///\e 
+    ///\e 
     void set_line(int line_num) { line=line_num; }
-  ///\e 
+    ///\e 
     void set_file(const std::string &file_name) {
       try {
@@ -165 +187 @@
     }
 
-  ///\e 
-    virtual const char* what() const {
+    ///\e
+    int get_line() const { return line; }
+
+    /// \brief Returns the filename.
+    ///
+    /// Returns "(unknown)" if the filename was not specified.
+    const char* get_file() const {
+      if( file )
+        return file->c_str();
+      else
+        return "(unknown)";
+    }
+
+    ///\e 
+    virtual const char* what() const throw() {
       const char *mes = 0;
       try {
@@ -173 +208 @@
         if( file || line ) {
           ostr << " (";
-          if( file ) ostr << "in file" << *file;
-          if( line ) ostr << " at line" << line;
+          if( file ) ostr << "in file '" << *file << "'";
+          if( file && line ) ostr << " ";
+          if( line ) ostr << "at line " << line;
+          ostr << ")";
         }
         mes = ostr.str().c_str();
@@ -182 +219 @@
       return "lemon::DataFormatError";
     }
-  };
-
+
+    virtual ~DataFormatError() throw() {}
+  };
+
+
+  class AssertionFailedError : public LogicError {
+  protected:
+    const char *assertion;
+    const char *file;
+    int line;
+    const char *function;
+    const char *message;
+  public:
+    ///\e
+    AssertionFailedError(const char *_file, int _line, const char *func,
+                         const char *msg, const char *_assertion = 0) :
+      assertion(_assertion), file(_file), line(_line), function(func),
+      message(msg) {}
+
+    ///\e
+    const char* get_assertion() const { return assertion; }
+    ///\e
+    const char* get_message() const { return message; }
+    ///\e
+    const char* get_file() const { return file; }
+    ///\e
+    const char* get_function() const { return function; }
+    ///\e
+    int get_line() const { return line; }
+
+
+    virtual const char* what() const throw() {
+      const char *mes = 0;
+      try {
+        std::ostringstream ostr;
+        ostr << file << ":" << line << ": ";
+        if( function )
+          ostr << function << ": ";
+        ostr << message;
+        if( assertion )
+          ostr << " (assertion '" << assertion << "' failed)";
+        mes = ostr.str().c_str();
+      }
+      catch(...) {}
+      if( mes ) return mes;
+      return "lemon::AssertionFailedError";
+    }
+
+    virtual ~AssertionFailedError() throw() {}
+  };
 
 
@@ -189 +274 @@
 
 
-  /**
-   * \brief Macro for assertions with customizable message
-   */
-
-# define lemon_assert(exp, msg) \
-    if(!(exp)) { \
-      std::cerr << __FILE__ ":" << __LINE__ << ": " << (msg) << std::endl; \
-      abort; \
-    }
-
-
-  /**
-   * \brief Macro for mark not yet implemented features.
-   *
-   * \todo Is this the right place for this? It should be used only in
-   * modules under development.
-   */
-
-# define FIXME(msg) lemon_assert(0, "FIXME: " msg)
+  inline
+  void assert_fail(const char *file, int line, const char *func,
+                   const char *message, const char *assertion = 0,
+                   bool do_abort=true)
+  {
+    using namespace std;
+    cerr << file << ":" << line << ": ";
+    if( func )
+      cerr << func << ": ";
+    cerr << message;
+    if( assertion )
+      cerr << " (assertion '" << assertion << "' failed)";
+    cerr << endl;
+    if(do_abort)
+      abort();
+  }
+
+  inline
+  void assert_fail_throw(const char *file, int line, const char *func,
+                   const char *message, const char *assertion = 0,
+                   bool = true)
+  {
+    throw AssertionFailedError(file, line, func, message, assertion);
+  }
+
 
 }
 #endif // LEMON_ERROR_H
+
+#undef LEMON_ASSERT
+#undef LEMON_FIXME
+
+#ifndef LEMON_ASSERT_ABORT
+#  define LEMON_ASSERT_ABORT 1
+#endif
+
+#ifndef LEMON_ASSERT_HANDLER
+#  define LEMON_ASSERT_HANDLER ::lemon::assert_fail
+#endif
+
+#if defined(NDEBUG) || defined(LEMON_DISABLE_ASSERTS)
+
+#  define LEMON_ASSERT(exp, msg)  (static_cast<void> (0))
+
+#else
+
+/**
+ * \brief Macro for assertions with customizable message
+ *
+ * \todo __PRETTY_FUNCTION__ should be replaced by something
+ * compiler-independant, like BOOST_CURRENT_FUNCTION
+ */
+
+#  define LEMON_ASSERT(exp, msg)                 \
+     (static_cast<void> (!!(exp) ? 0 : (         \
+       LEMON_ASSERT_HANDLER(__FILE__, __LINE__,  \
+                            __PRETTY_FUNCTION__, \
+                            (msg), #exp, LEMON_ASSERT_ABORT), 0)))
+
+# endif // NDEBUG
+
+/**
+ * \brief Macro for mark not yet implemented features.
+ *
+ * \todo Is this the right place for this? It should be used only in
+ * modules under development.
+ *
+ * \todo __PRETTY_FUNCTION__ should be replaced by something
+ * compiler-independant, like BOOST_CURRENT_FUNCTION
+ */
+
+# define LEMON_FIXME(msg) \
+    (LEMON_ASSERT_HANDLER(__FILE__, __LINE__, __PRETTY_FUNCTION__, \
+                          "FIXME: " msg))

src/work/makefile

@@ -1 +1 @@
 INCLUDEDIRS ?= -I.. -I. -I./{marci,jacint,alpar,klao,akos}
-CXXFLAGS = -g -O3 -W -Wall $(INCLUDEDIRS) -ansi -pedantic
+CXXFLAGS += -g -O2 -W -Wall $(INCLUDEDIRS) -ansi -pedantic
 
 BINARIES ?= bin_heap_demo