---

     

---

CHMerrorClass.h

#ifndef __CHM_ERROR_CLASS_H__
#define __CHM_ERROR_CLASS_H__
//---------------------------------------------------------------------------
// Copyright (C) 1997-2007 iNTERFACEWARE Inc.  All Rights Reserved
//
// Module: CHMerrorClass
//
// Author: Eliot Muir
// Revision: $Revision: 1.34 $
//
// Last Edit Date: $Date: 2009-06-19 02:49:53 $
// Source: $Source: /home/cvs/cvsroot/CHM/CHMerrorClass.h,v $
//---------------------------------------------------------------------------

#include <CHM/CHMminimumInclude.h>
class CHMstring;

const long CHM_BAD_VERSION = 123112;

#ifdef _MFC_VER
#define _USE_MFC_EXCEPTIONS
#endif

#if defined(_USE_MFC_EXCEPTIONS)
#include <afx.h>

class CHMerror : public CException
{
    DECLARE_DYNAMIC(CHMerror)
public:
   CHMerror(const CHMchar* Message, long Line, const char* File, long Code);
   CHMerror(const CHMresult Code, long Line, const char* File);
   CHMerror(const CHMerror& Orig);

   virtual ~CHMerror();

    //void Empty();
    
    virtual BOOL GetErrorMessage(LPTSTR lpszError, UINT nMaxError,
                                PUINT pnHelpContext = NULL);
   const long Code()        const;
   CHMchar*   Description() const;
   const char* Parameter(const CHMchar* pKey) const;

   // This function is deprecated. Use Dump instead. See manual for migration guide.
   // 
   // void printOn(IOostream& Stream) const;
   
   CHMstring Dump() const;

//#ifdef _DEBUG
//  void TraceErrorMessage(LPCTSTR szTrace) const;
//#endif // DEBUG
protected:
   CHMchar* m_pDescription;
   long     m_Code;
   long     m_Line;
   char*    m_File;
   CHMreferenceHandle m_Handle;
private:
   CHMerror& operator=(const CHMerror& Error);  // not allowed
};

#else
class CHMerror
{
public:
   CHMerror(const CHMchar* Message, long Line, const char* File, long Code);
   CHMerror(const CHMerror& Error);
   CHMerror(const CHMresult Handle, long Line, const char* File);
   virtual ~CHMerror();

   const long      Code()       const;

   unsigned int CountOfParameter() const;
   
   CHMchar* Description() const;

   CHMstring Dump() const;
   
   CHMboolean HasParameter(const CHMchar* pKey) const; 
   
   const char* Parameter(const CHMchar* pKey) const;

   const char* ParameterName(unsigned int Index) const;

   // This function is deprecated. Use Dump instead. See manual for migration guide.
   //
   // void printOn(IOostream& Stream) const;
   
 

protected:
   CHMchar*    m_pDescription;
   long        m_Code;
   long        m_Line;
   char* m_File;
   CHMreferenceHandle m_Handle;
private:
   CHMerror& operator=(const CHMerror& Error);  // not allowed
};
#endif  // end of defining compilation of error determined by the type of
        // environment being used...

// This function is deprecated. Use Dump instead. See manual for migration guide.
//
// IOostream& operator<<(IOostream& Stream, const CHMerror& Error);

void CHMactivateCondition(const CHMchar* Message, long Line, const char* File, CHMresult Code);
void CHMactivateCondition(const CHMchar* Message, long Line, const char* File);

#if defined(WIN32) && defined(CHM_64)
#define CHM_CHECK_CALL(x) { CHMresult Result = x; if (Result != CHM_OK) { CHMactivateCondition(CHM_TEXT(#x), __LINE__, __FILE__, Result); } }
#else
#define CHM_CHECK_CALL(x) { CHMresult Result = _##x; if (Result != CHM_OK) { CHMactivateCondition(CHM_TEXT(#x), __LINE__, __FILE__, Result); } }
#endif

#define CHM_ASSERT(x) if (!(x))  { CHMactivateCondition(CHM_TEXT(#x), __LINE__, __FILE__); }

#define CHM_ASSERT_COMMENT(x, y) if (!(x)) { CHMactivateCondition(CHM_TEXT(y), __LINE__, __FILE__);  }

#define CHM_HANDLE_UNKNOWN_MESSAGE throw CHMerror(CHM_TEXT("Unknown message encountered."), __LINE__, __FILE__, 0); 

#ifndef CHMPRECONDITION
#  define CHMPRECONDITION(x) CHM_ASSERT(#x)
#endif

#endif // end of defensive include

---