mlLogging.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2009, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_LOGGING_H
#define ML_LOGGING_H
 
#include "mlUtilsSystem.h"
#include "mlTypeDefs.h"
 
#include <ThirdPartyWarningsDisable.h>
#include <sstream>
#include <ThirdPartyWarningsRestore.h>
 
ML_UTILS_START_NAMESPACE
 
//--------------------------------------------------------------------------------------------
//
//--------------------------------------------------------------------------------------------
 
#define mlFatalError(FUNCTION, ...) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_FATAL, ML_NAMESPACE::internal::LogCollector::getErrorCode(__VA_ARGS__) ,FUNCTION).getStream()
 
#define mlError(FUNCTION, ...) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_ERROR, ML_NAMESPACE::internal::LogCollector::getErrorCode(__VA_ARGS__) , FUNCTION).getStream()
 
#define mlWarning(FUNCTION, ...) \
  ML_NAMESPACE::internal::LogCollector(__FILE__, __LINE__, ML_WARNING, ML_NAMESPACE::internal::LogCollector::getErrorCode(__VA_ARGS__) , 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 = nullptr;
  if (object) {
    try {
      type = object->getTypeId();
    } catch(...) {};
  }
  return type;
}
 
#ifdef _MSC_VER
#pragma warning( push )
// Suppresses warning that does not 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  = nullptr,
    const RuntimeType *dumpObjRT= nullptr);
 
  ~LogCollector();
 
  std::ostringstream& getStream() { return _stream; }
 
  static int getErrorCode(int code) { return code; }
  static int getErrorCode() { return ML_BAD_PARAMETER; }
 
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