gzExceptions.h

Go to the documentation of this file.

//******************************************************************************
// File         : gzExceptions.h
// Module       : gzBase
// Description  : Class definition of exception classes
// Author       : Anders Modén      
// Product      : GizmoBase 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden
//          
// NOTE:    GizmoBase is a platform abstraction utility layer for C++. It contains 
//          design patterns and C++ solutions for the advanced programmer.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980819  Created file    
//
//******************************************************************************

#ifndef __GZ_EXCEPTIONS_H__
#define __GZ_EXCEPTIONS_H__

#include "gzBase.h"
#include "gzDebug.h"

//******************************************************************************
// Class    : gzBaseError
//                                  
// Purpose  : Base class for gizmo exceptions
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980912  Created 
//                                  
//******************************************************************************
class gzBaseError
{
public:
    GZ_BASE_EXPORT gzBaseError(const char *, gzInt errcode = 0 , gzMessageEncoding enc=GZ_MESSAGE_ENCODING_UTF8);
    GZ_BASE_EXPORT virtual ~gzBaseError();

    GZ_BASE_EXPORT virtual gzVoid       reportError()=0;
    GZ_BASE_EXPORT gzInt                getErrorCode() const;
    GZ_BASE_EXPORT gzString             getErrorString() const;
    GZ_BASE_EXPORT gzMessageEncoding    getMessageEncoding() const;

protected:
    gzInt               m_errCode;
    gzString            m_errString;
    gzMessageEncoding   m_errMessEncode;
};


// **************** Warning exceptions *****************************************

//******************************************************************************
// Class    : gzWarningError
//                                  
// Purpose  : Warning exception
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980912  Created 
//                                  
//******************************************************************************
class gzWarningError : public gzBaseError
{
public:
    typedef gzVoid (* ReportFunc)(const gzWarningError&);

    GZ_BASE_EXPORT gzWarningError(const char *, gzInt errcode = 0, gzMessageEncoding enc=GZ_MESSAGE_ENCODING_UTF8);
    GZ_BASE_EXPORT virtual ~gzWarningError();

    GZ_BASE_EXPORT virtual gzVoid       reportError();
    GZ_BASE_EXPORT static gzVoid        setReportFunction(ReportFunc foo);

private:
    static ReportFunc   s_reportFunc;
};


// **************** FATAL! exceptions *****************************************

//******************************************************************************
// Class    : gzFatalError
//                                  
// Purpose  : Fatal exception
//                                  
// Notes    : Does not return. Terminates program.  
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980912  Created 
//                                  
//******************************************************************************
class gzFatalError : public gzBaseError
{
public:
    typedef gzVoid (* ReportFunc)(const gzFatalError&);

    GZ_BASE_EXPORT gzFatalError(const char *, gzInt errcode = 0, gzMessageEncoding enc=GZ_MESSAGE_ENCODING_UTF8);
    GZ_BASE_EXPORT virtual ~gzFatalError();

    GZ_BASE_EXPORT virtual gzVoid       reportError();
    GZ_BASE_EXPORT static gzVoid        setReportFunction(ReportFunc foo);

private:
    static ReportFunc s_reportFunc;
};

// These functions can be overrided to provide custom gzInterface
// to exception reporting ...

GZ_BASE_EXPORT gzVoid gzDefaultWarningHandler( const gzWarningError & );

GZ_BASE_EXPORT gzVoid gzDefaultFatalHandler( const gzFatalError & );

// ********************* THROW macros *****************************************

class gzExceptionThrows
{
public:


    GZ_BASE_EXPORT static gzVoid gzThrowWarning(const char * fmt , ARG_DECL_LIST);
    GZ_BASE_EXPORT static gzVoid gzThrowWarning(gzMessageEncoding encoding , const char * fmt , ARG_DECL_LIST);

    GZ_BASE_EXPORT static gzVoid gzThrowWarning(const gzWideChar * fmtWide , ARG_DECL_LIST);
    GZ_BASE_EXPORT static gzVoid gzThrowWarning(gzMessageEncoding encoding , const gzWideChar * fmtWide , ARG_DECL_LIST);

    GZ_BASE_EXPORT static gzVoid gzThrowFatal(const char * fmt , ARG_DECL_LIST);
    GZ_BASE_EXPORT static gzVoid gzThrowFatal(gzMessageEncoding encoding , const char * fmt , ARG_DECL_LIST);

    GZ_BASE_EXPORT static gzVoid gzThrowFatal(const gzWideChar * fmtWide, ARG_DECL_LIST);
    GZ_BASE_EXPORT static gzVoid gzThrowFatal(gzMessageEncoding encoding , const gzWideChar * fmtWide , ARG_DECL_LIST);
};

#define gzThrowWarning gzExceptionThrows::gzThrowWarning
#define gzThrowFatal gzExceptionThrows::gzThrowFatal

#endif

---