exception_c.h

Go to the documentation of this file.

/**********************************************************//**
 **
 ** @file base/exception_c.h
 **
 ** Copyright (C) 2012  Xpace, LLC.  All rights reserved
 **
 ** www.xpace.net
 **
 **************************************************************/

#ifndef XPACE_EXCEPTION_C_H
#define XPACE_EXCEPTION_C_H

#include "base/c/types_c.h"

#ifdef __cplusplus
# include "base/exception.h"

  // ================================ ANY EXCEPTION ===========

  namespace Xpace
  {
    /// Never thrown, but a convenient holder for std and Xpace exceptions
    class XPACE_EXPORT AnyException : public Xpace::Exception
    {
    public:
      AnyException
        ();
      explicit AnyException
        (const Xpace::Exception& ex);
      explicit AnyException
        (const std::exception& ex);

      /// @return true if empty
      bool operator!
        ()
        const;    

      const Xpace::String getTemplate
        () 
        const;

      String getMessage
        (const String& templ = String())   
        const;

      Exception why
        ();

      const char* what
        ()
        const throw();

      bool isBadAlloc
        ()
        const;

    private:
      const Exception xpace_ex;
      Exception cur_ex;
      const std::exception std_ex;
    };
  }

  typedef Xpace::AnyException* Xpace_Error;

  XPACE_C_EXPORT(Xpace_Error) Xpace_Error_create
    (const Xpace::Exception& ex);
  XPACE_C_EXPORT(Xpace_Error) Xpace_Error_create_std
    (const std::exception& ex = std::bad_alloc());

#else
  typedef void* Xpace_Error;
#endif

extern Xpace_Error Xpace_Error_None;

XPACE_C_EXPORT(Xpace_Error) Xpace_Error_copy
  (Xpace_Error);

XPACE_C_EXPORT(void) Xpace_Error_destroy
  (Xpace_Error);

/// Get to the error that cause this one (if any)
/// @return the error we there is such an error
XPACE_C_EXPORT(Xpace_Error)  Xpace_Error_why
  (Xpace_Error);

/// @return English template into which params will be inserted
XPACE_C_EXPORT(const Xpace_Char16*) Xpace_Error_getTemplate
  (Xpace_Error);

/// Construct an error message
/// @param templ the template into which params will be inserted
///   (I.e., a translation of getTemplate() for this exception)
///   if = Xpace_String(), use English template
/// @return the translated template with params insterted
XPACE_C_EXPORT(const Xpace_Char16*) Xpace_Error_getMessage
  (Xpace_Error, 
   const Xpace_Char16* templ);

/// @return an English error message with params inserted
XPACE_C_EXPORT(char*) Xpace_Error_what
  (const Xpace_Error);

#ifdef __cplusplus
  #define CALL_CATCH(x)                     \
    try                                     \
    {                                       \
      x;                                    \
    }                                       \
    catch (Xpace::Exception& ex)            \
    {                                       \
      return Xpace_Error_create(ex);        \
    }                                       \
    catch (std::exception& ex)              \
    {                                       \
      return Xpace_Error_create_std(ex);    \
    }                                       \
    return Xpace_Error_None;
#endif

#endif