Exception.h

Go to the documentation of this file.

//    Copyright 2004, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API 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.
//
//    H3D API 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 H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
//
#ifndef __EXCEPTION_H__
#define __EXCEPTION_H__

#include <string>
#include <iostream>
#include "H3DApi.h"
using namespace std;

namespace H3D {
  namespace Exception {
    
    class H3DAPI_API H3DException {
    public:
      
      H3DException( const string &_message = "" ) : message( _message ) {}

      virtual ~H3DException() {};
      virtual void print( ostream &os ) const  {
        os << "H3DException: " << message;
      }

      string message;
    };

    class H3DAPI_API H3DAPIException : public H3DException {
    public:
      H3DAPIException( const string &_message = "", 
                       const string &_function = "",
                       const string &_filename = "",
                       const int    &_linenumber = -1 ) : 
        H3DException( _message ),
        function(_function), filename(_filename), linenumber(_linenumber ) {}
  

      virtual string className() const {
        return "H3DAPIException";
      }

      virtual void print( ostream &os ) const;
      
      string function;

      string filename;

      int linenumber;
    };

    template < class ValueType >
    class ValueException : public H3DAPIException {
    public:
      ValueException( ValueType _value,
                      const string &_message  = "",
                      const string &_function = "",
                      const string &_filename = "",
                      const int &_linenumber  =  -1 ) : 
        H3DAPIException( _message, _function, _filename, _linenumber ),
        value( _value ) {}


      virtual string className() const {
        return "ValueException";
      }

      virtual void print( ostream &os ) const {
        os << className() << ": " << value << ".";
        if( message.length() ) {
          os << " " << message;
        }
        if( function.length() || filename.length() || linenumber != -1 ) {
          os << " (";
          if( function.length() ) os << "" << function;
          if( filename.length() ) os << " in " << filename;
          if( linenumber != -1 ) os << " line " << linenumber;
          os << ")";
        }
      }
      
      ValueType value;
    };
    
    class QuitAPI: public H3DException {};
   
    inline ostream &operator<<( ostream& os, const H3DException &e ) {
      e.print( os );
      return os;
    }
 
  }

#define H3D_FULL_LOCATION __FUNCTION__, __FILE__, __LINE__

#define H3D_FILE_LOCATION "", __FILE__, __LINE__

#define H3D_FUNCTION_LOCATION __FUNCTION__

#define H3D_VALUE_EXCEPTION( value_type, name )                             \
  class name : public H3D::Exception::ValueException< value_type > {        \
  public:                                                                   \
    name( value_type _value,                                                \
          const string &_message = "",                                      \
          const string &_function = "",                                     \
          const string &_filename = "",                                     \
          const int &_linenumber = -1 ) :                                   \
      H3D::Exception::ValueException< value_type >( _value, _message,       \
    _function,                                                              \
    _filename, _linenumber) {}                                              \
  protected:                                                                \
    string className() const { return #name; }                         \
}

#define H3D_API_EXCEPTION( name )                                           \
  class name : public H3D::Exception::H3DAPIException {                     \
  public:                                                                   \
    name( const string &_message = "",                                      \
          const string &_function = "",                                     \
          const string &_filename = "",                                     \
          const int &_linenumber = -1 ) :                                   \
      H3D::Exception::H3DAPIException( _message, _function,                 \
                _filename, _linenumber) {}                                  \
  protected:                                                                \
    string className() const { return #name; }                         \
}

}

#endif

---