exception-abstract.h

// -*- mode: c++ -*-
// Copyright 2010, François Bleibel, Thomas Moulard, Olivier Stasse,
// JRL, CNRS/AIST.
//

#ifndef DYNAMIC_GRAPH_EXCEPTION_ABSTRACT_H
#define DYNAMIC_GRAPH_EXCEPTION_ABSTRACT_H
#include <string>

#include <dynamic-graph/dynamic-graph-api.h>
#include <dynamic-graph/fwd.hh>

// Uncomment this macros to have lines parameter on the throw display
// #define DYNAMIC-GRAPH_EXCEPTION_PASSING_PARAM

#define DG_RETHROW                                                             \
  (const ::dynamicgraph::ExceptionAbstract &err) { throw err; }

#ifdef DYNAMICGRAPH_EXCEPTION_PASSING_PARAM
#define DG_THROW                                                               \
  throw ::dynamicgraph::ExceptionAbstract::Param(__LINE__, __FUNCTION__,       \
                                                 __FILE__) +
#else
#define DG_THROW throw
#endif // DYNAMICGRAPH_EXCEPTION_PASSING_PARAM

namespace dynamicgraph {
class DYNAMIC_GRAPH_DLLAPI ExceptionAbstract : public std::exception {
public:
  class Param {
  public:
    static const int BUFFER_SIZE = 80;

    Param(const int &_line, const char *_function, const char *_file);
    Param()
        : functionPTR(), function(), line(), filePTR(), file(),
          pointersSet(false), set(false) {}
    Param &initCopy(const Param &p);

    const char *functionPTR;
    char function[BUFFER_SIZE];
    int line;
    const char *filePTR;
    char file[BUFFER_SIZE];
    bool pointersSet;
    bool set;
  };

  enum ExceptionEnum {
    ABSTRACT = 0,
    SIGNAL = 100,
    FACTORY = 200,
    TRACES = 300,
    TOOLS = 700
  };

  static const std::string EXCEPTION_NAME;

  explicit ExceptionAbstract(const int &code, const std::string &msg = "");
  virtual ~ExceptionAbstract() throw() {}

  virtual const std::string &getExceptionName() const { return EXCEPTION_NAME; }

  int getCode() const;

  const std::string &getStringMessage() const;

  const char *getMessage() const;

  virtual const char *what() const throw() {
    return getStringMessage().c_str();
  }

  DYNAMIC_GRAPH_DLLAPI friend std::ostream &
  operator<<(std::ostream &os, const ExceptionAbstract &err);

protected:
  int code;

  std::string message;

#ifdef DYNAMICGRAPH_EXCEPTION_PASSING_PARAM
  mutable Param p;

  template <class Exc>
  friend const Exc &operator+(const ExceptionAbstract::Param &p, const Exc &e) {
    e.p.initCopy(p);
    return e;
  }

  template <class Exc>
  friend Exc &operator+(const ExceptionAbstract::Param &p, Exc &e) {
    e.p.initCopy(p);
    return e;
  }

#endif // DYNAMICGRAPH_EXCEPTION_PASSING_PARAM

private:
  ExceptionAbstract();
};
} // end of namespace dynamicgraph

#endif