Error.h

Go to the documentation of this file.

#ifndef __ERROR_H__
#define __ERROR_H__

/*

$Header$

*/

#include <errno.h>
#include <stdarg.h>

#include "Object.h"
#include "Limits.h"
#include "Messages.h"
#include "SignalDeclaration.h"
#include "SingletonDeclaration.h"
#include "String.h"

// Error codes.
static const int OK      =  0;
static const int FAILURE = -1;

#define ERROR(...) ERR()->error(__FILE__, __LINE__, __PRETTY_FUNCTION__, ##__VA_ARGS__)
#define WARNING(...) ERR()->warning(__FILE__, __LINE__, __PRETTY_FUNCTION__, ##__VA_ARGS__)
#define ERROR_FATAL(...) ERR()->errorFatal(__FILE__, __LINE__, __PRETTY_FUNCTION__, ##__VA_ARGS__)
#define INFO(...) ERR()->info(__FILE__, __LINE__, __PRETTY_FUNCTION__, ##__VA_ARGS__)

#ifdef DEBUG_MODE
#define ERROR_BACKTRACE(code) ERR()->errorBackTrace(__FILE__, __LINE__, __PRETTY_FUNCTION__, code)
#define DEBUG(...) ERR()->debug(__FILE__, __LINE__, __PRETTY_FUNCTION__, ##__VA_ARGS__)
#define MARKER ERR()->debug(__FILE__, __LINE__, __PRETTY_FUNCTION__, "MARKER")
#else

inline
int ERROR_BACKTRACE(const int code)
{
  return code;
}

#define DEBUG(...)
#define MARKER
#endif

#define BACKTRACE Error::printBackTrace()

#define CHECK_POINTER(ptr) \
if (!(ptr)) \
  return ERROR(MSG_NULL_POINTER);

#define CHECK_PARENT \
{ \
  int res; \
  if (FAILED(res = failureCode())) { \
    failure(ERROR_BACKTRACE(res)); \
    return; \
  } \
}

#define CHECK_CREATION(ptr, className) \
{ \
  CHECK_POINTER(ptr); \
  int res; \
  if (FAILED(res = ptr->failureCode())) { \
    delete ptr; \
    return ERROR_BACKTRACE(res); \
  } \
}

using namespace std;

inline bool SUCCEEDED(const int res)
{
  return (res == OK);
}

inline bool FAILED(const int res)
{
  return (res != OK);
}

class Error : public Object,
              public Singleton<Error>
{

friend class Singleton<Error>;

  PYLON_OBJECT

public:

#ifdef DEBUG_MODE
  int debug(const String &fileName, const unsigned int lineNum, const String &functionName, const char *format, ...) __attribute__ ((format (printf, 5, 6)));
#endif

  int verror(const String &fileName, const unsigned int lineNum, const String &functionName, const char *format, va_list ap);
  int error(const String &fileName, const unsigned int lineNum, const String &functionName, const char *format, ...) __attribute__ ((format (printf, 5, 6)));
  int errorFatal(const String &fileName, const unsigned int lineNum, const String &functionName, const char *format, ...) __attribute__ ((format (printf, 5, 6)));

#ifdef DEBUG_MODE
  int errorBackTrace(const String &fileName, const unsigned int lineNum, const String &functionName, const int code);
#endif

  int warning(const String &fileName, const unsigned int lineNum, const String &functionName, const char *format, ...) __attribute__ ((format (printf, 5, 6)));

  int info(const String &fileName, const unsigned int lineNum, const String &functionName, const char *format, ...) __attribute__ ((format (printf, 5, 6)));

  static void printBackTrace();

  SIGNAL(debug, const String &, const String &, const unsigned int, const String &, const String &);
  SIGNAL(error, const String &, const String &, const unsigned int, const String &, const String &);
  SIGNAL(errorFatal, const String &, const String &, const unsigned int, const String &, const String &);
  SIGNAL(warning, const String &, const String &, const unsigned int, const String &, const String &);
  SIGNAL(info, const String &, const String &, const unsigned int, const String &, const String &);

private:

  Error();
  virtual ~Error();
};

inline
Error *ERR()
{
  return Error::instance();
}

inline
String COLOR_DEBUG()
{
  return COLOR_STRING("  DEBUG   ", YELLOW, BLUE);
}

inline
String COLOR_ERROR()
{
  return COLOR_STRING("  ERROR   ", YELLOW, RED);
}

inline
String COLOR_ERROR_FATAL()
{
  return COLOR_STRING(" FATAL ERROR ", YELLOW, RED);
}

inline
String COLOR_WARNING()
{
  return COLOR_STRING(" WARNING  ", RED, WHITE);
}

inline
String COLOR_INFO()
{
  return COLOR_STRING("  INFO    ", BLACK, CYAN);
}

inline
String COLOR_DEFERRED()
{
  return COLOR_STRING(" DEFERRED ", BLACK, GREEN);
}

inline
String COLOR_BACKTRACE()
{
  return COLOR_STRING(" BACKTRACE ", YELLOW, RED);
}

#endif

---