/*
** AreaEditor - a program for editing SMAUG and ROM area files.
** Author: Nick Gammon
** http://www.gammon.com.au/
** See Copyright Notice at the end of AreaEditor.h
*/

#pragma once

/////////////////////////////////////////////////////////////////////////////
// CSystemException

void ThrowSystemException(DWORD dwError = 0);

class CSystemException : public CException
{
	// Construction
	DECLARE_DYNAMIC(CSystemException)
public:
	CSystemException(DWORD dwError);

	// Attributes
public:
	DWORD	m_dwError;

	// Implementation
public:
	virtual BOOL GetErrorMessage(LPTSTR lpszError, UINT nMaxError, PUINT pnHelpContext = NULL);
};


/////////////////////////////////////////////////////////////////////////////
// CErrorException

void ThrowErrorException(UINT nFormatID, ...);
void ThrowErrorException(LPCTSTR lpszFormat, ...);

class CErrorException : public CException
{
	// Construction
	DECLARE_DYNAMIC(CErrorException)
public:
	CErrorException(LPCTSTR lpszFormat, ...);
	CErrorException(UINT nFormatID, ...);

	// Attributes
public:
	CString	m_strError;

	// Implementation
public:
	virtual BOOL GetErrorMessage(LPTSTR lpszError, UINT nMaxError, PUINT pnHelpContext = NULL);
};


/////////////////////////////////////////////////////////////////////////////
// CHECKHRESULT_EXCEPTION

// Use this for calls which return the high-order bit set on an error (ie. on a COM
// call).

struct CHECKHRESULT_EXCEPTION
  {
  CHECKHRESULT_EXCEPTION (HRESULT hr = 0) { if (FAILED(hr)) ThrowSystemException (hr); }
  HRESULT operator = (HRESULT hr)         { if (FAILED(hr)) ThrowSystemException (hr); return hr; }
  };

/////////////////////////////////////////////////////////////////////////////
// CHECKOSSTATUS_EXCEPTION

// Use this for calls which return 0 if successfull, but on failure the error is
//  returned directly.

struct CHECKOSSTATUS_EXCEPTION
  {
  CHECKOSSTATUS_EXCEPTION (long i = 0) { if (i != 0) ThrowSystemException (i); }
  long operator = (long i)             { if (i != 0) ThrowSystemException (i); return i; }
  };

/////////////////////////////////////////////////////////////////////////////
// CHECKZERO_EXCEPTION

// Use this for calls which return 0 if successfull, but on failure the error is
//  returned in GetLastError ()

struct CHECKZERO_EXCEPTION
  {
  CHECKZERO_EXCEPTION (long i = 0) { if (i != 0) ThrowSystemException (); }
  long operator = (long i)         { if (i != 0) ThrowSystemException (); return i; }
  };

/////////////////////////////////////////////////////////////////////////////
// CHECKNONZERO_EXCEPTION

// Use this for calls which return non-zero if successfull, but on failure the error is
//  returned in GetLastError ()

struct CHECKNONZERO_EXCEPTION
  {
  CHECKNONZERO_EXCEPTION (long i = 1) { if (i == 0) ThrowSystemException (); }
  long operator = (long i)            { if (i == 0) ThrowSystemException (); return i; }
  };

/////////////////////////////////////////////////////////////////////////////
// CHECKNOTMINUSONE_EXCEPTION

// Use this for calls which return -1 on an error, but any other value if OK.

struct CHECKNOTMINUSONE_EXCEPTION
  {
  CHECKNOTMINUSONE_EXCEPTION (long i = 0) { if (i == -1) ThrowSystemException (); }
  long operator = (long i)                { if (i == -1) ThrowSystemException (); return i; }
  };