common/error.hpp

/*
  ERROR.hpp  -  Lumiera Exception Interface
 
  Copyright (C)         Lumiera.org
    2008,               Hermann Vosseler <Ichthyostega@web.de>
 
  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.
 
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
*/


#ifndef LUMIERA_ERROR_HPP_
#define LUMIERA_ERROR_HPP_

#include <string>
#include "proc/nobugcfg.hpp"
#include "lib/appconfig.hpp"
#include "lib/error.h"


namespace lumiera
  {
  using std::string;


  
  LUMIERA_ERROR_DECLARE(EXCEPTION);  
  
  class Error : public std::exception
    {
    public:
      Error (string description="", const char* id=LUMIERA_ERROR_EXCEPTION) throw();
      Error (std::exception& cause,
             string description="", const char* id=LUMIERA_ERROR_EXCEPTION) throw();
      
      Error (const Error&) throw();
      virtual ~Error () throw() {};
      
      virtual const char* what () const throw();

      const char* getID () const throw() { return this->id_; }
      
      const string& getUsermsg () const throw();
      
      const string& rootCause () const throw()  { return this->cause_; }

      Error& setUsermsg (const string& newMsg) throw() { this->msg_ = newMsg; return *this; }

      Error& prependInfo (const string& text) throw() { this->desc_.insert (0,text); return *this; }
      
      
    private:
      const char* id_;       
      string msg_;           
      string desc_;          
      mutable string what_;  
      const string cause_;   

      static const string extractCauseMsg (const std::exception&)  throw();
    };
  
    
    
    
    
    
  /* === Exception Subcategories === */
    
  namespace error
    {
    
    void lumiera_unexpectedException ()  throw();

    void assertion_terminate (const string& location);
    

    /* constants to be used as error IDs */
    LUMIERA_ERROR_DECLARE (LOGIC    );    
    LUMIERA_ERROR_DECLARE (FATAL    );    
    LUMIERA_ERROR_DECLARE (CONFIG   );    
    LUMIERA_ERROR_DECLARE (STATE    );    
    LUMIERA_ERROR_DECLARE (INVALID  );    
    LUMIERA_ERROR_DECLARE (EXTERNAL );    
    LUMIERA_ERROR_DECLARE (ASSERTION);    
    
#define LUMIERA_EXCEPTION_DECLARE(CLASS, PARENT, _ID_) \
    class CLASS : public PARENT                         \
      {                                                 \
      public:                                           \
        CLASS (std::string description="",              \
               const char* id=_ID_) throw()             \
        : PARENT (description, id)  {}                  \
                                                        \
        CLASS (std::exception& cause,                   \
               std::string description="",              \
               const char* id=_ID_) throw()             \
        : PARENT (cause, description, id)   {}          \
      };

    //-------------------------CLASS-----PARENT--ID----------------------
    LUMIERA_EXCEPTION_DECLARE (Logic,    Error,  LUMIERA_ERROR_LOGIC);
    LUMIERA_EXCEPTION_DECLARE (Fatal,    Logic,  LUMIERA_ERROR_FATAL);
    LUMIERA_EXCEPTION_DECLARE (Config,   Error,  LUMIERA_ERROR_CONFIG);
    LUMIERA_EXCEPTION_DECLARE (State,    Error,  LUMIERA_ERROR_STATE);
    LUMIERA_EXCEPTION_DECLARE (Invalid,  Error,  LUMIERA_ERROR_INVALID);
    LUMIERA_EXCEPTION_DECLARE (External, Error,  LUMIERA_ERROR_EXTERNAL);
    
    
    void install_unexpectedException_handler ();
    namespace {
      LifecycleHook schedule_ (ON_BASIC_INIT, &install_unexpectedException_handler);         
    }
    
  } // namespace error

} // namespace lumiera



/******************************************************
 * if NoBug is used, redefine some macros 
 * to rather throw Lumiera Errors instead of aborting
 */
#ifdef NOBUG_ABORT
#undef NOBUG_ABORT
#define LUMIERA_NOBUG_LOCATION \
  std::string (NOBUG_BASENAME(__FILE__)) +":"+ NOBUG_STRINGIZE(__LINE__) + ", function " + __func__
#define NOBUG_ABORT \
  lumiera::error::assertion_terminate (LUMIERA_NOBUG_LOCATION);
#endif


#endif // LUMIERA_ERROR_HPP_

---