MeVis/Foundation/Sources/MLUtilities/mlLogging.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------

#ifndef __mlLogging_H
#define __mlLogging_H

#include "mlUtilsSystem.h"
#include "mlTypeDefs.h"

#include "mlSystemWarningsDisable.h"
#include <sstream>
#include "mlSystemWarningsRestore.h"

ML_UTILS_START_NAMESPACE

//--------------------------------------------------------------------------------------------
//

//--------------------------------------------------------------------------------------------

#define mlFatalError(FUNCTION, ERRORCODE) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_FATAL, ERRORCODE, FUNCTION).getStream()

#define mlError(FUNCTION, ERRORCODE) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_ERROR, ERRORCODE, FUNCTION).getStream()

#define mlWarning(FUNCTION, ERRORCODE) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_WARNING, ERRORCODE, FUNCTION).getStream()

#define mlInfo(FUNCTION) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_INFORMATION, ML_RESULT_OK, FUNCTION).getStream()


#define mlFatalErrorWithDump(FUNCTION, ERRORCODE, OBJECT) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_FATAL, ERRORCODE, FUNCTION, (OBJECT), ML_NAMESPACE::internal::MLSecureGetRuntimeTypeId((OBJECT))).getStream()

#define mlErrorWithDump(FUNCTION, ERRORCODE, OBJECT) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_ERROR, ERRORCODE, FUNCTION, (OBJECT), ML_NAMESPACE::internal::MLSecureGetRuntimeTypeId((OBJECT))).getStream()

#define mlWarningWithDump(FUNCTION, ERRORCODE, OBJECT) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_WARNING, ERRORCODE, FUNCTION, (OBJECT), ML_NAMESPACE::internal::MLSecureGetRuntimeTypeId((OBJECT))).getStream()

#define mlInfoWithDump(FUNCTION, OBJECT) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_INFORMATION, ML_RESULT_OK, FUNCTION, (OBJECT), ML_NAMESPACE::internal::MLSecureGetRuntimeTypeId((OBJECT))).getStream()


#ifndef DOXYGEN_SHOULD_SKIP_THIS

class RuntimeType;

namespace internal {

template <typename T>
inline const RuntimeType* MLSecureGetRuntimeTypeId(const T* object) {
  const RuntimeType* type = NULL;
  if (object) {
    try { 
      type = object->getTypeId();
    } catch(...) {};
  }
  return type;
}

#ifdef _MSC_VER
#pragma warning( push )
// suppress warning that doesn't seem to be relevant:
#pragma warning(disable : 4251 )  // class 'std::ostringstream' needs to have dll-interface to be used by clients of class 'ml::OpenGL'
#endif

class ML_UTILS_EXPORT LogCollector
{
public:
  LogCollector(const char* file, int line, MLMessageType type, MLErrorCode errorCode,
    const char        *functionName,
    const void        *dumpObj  = NULL, 
    const RuntimeType *dumpObjRT= NULL);

  ~LogCollector();

  std::ostringstream& getStream() { return _stream; }

private:
  std::ostringstream _stream;
  const char*        _file;
  int                _line;
  MLMessageType      _type;
  MLErrorCode        _errorCode;
  const char*        _functionName;
  const void        *_dumpObj; 
  const RuntimeType *_dumpObjRT;
};

#ifdef _MSC_VER
#pragma warning( pop )
#endif

} // end namespace internal

#endif // DOXYGEN_SHOULD_SKIP_THIS

ML_UTILS_END_NAMESPACE


#endif // __mlLogging_H