mitkEndoDebug.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/
#ifndef mitkEndoDebug_h
#define mitkEndoDebug_h

#include <set>
#include <string>
#include <iostream>
#include <sstream>
#include <MitkCameraCalibrationExports.h>

namespace mitk
{
  struct EndoDebugData;

  struct MITKCAMERACALIBRATION_EXPORT EndoDebug
  {
    static EndoDebug& GetInstance();

    static std::string GetUniqueFileName(const std::string& dir, const std::string& ext="jpg" , const std::string &prefix="");

    void SetDebugEnabled(bool _DebugEnabled);

    bool GetDebugEnabled();

    void SetShowImagesInDebug(bool _ShowImagesInDebug);

    bool GetShowImagesInDebug();

    void SetShowImagesTimeOut(size_t _ShowImagesTimeOut);

    size_t GetShowImagesTimeOut();

    void SetDebugImagesOutputDirectory(const std::string& _DebugImagesOutputDirectory);

    std::string GetDebugImagesOutputDirectory() const;

    std::string GetFilenameWithoutExtension(const std::string& s);

    bool AddFileToDebug(const std::string& fileToDebug);

    void SetFilesToDebug(const std::set<std::string>& filesToDebug);

    std::set<std::string> GetFilesToDebug();

    bool AddSymbolToDebug(const std::string& symbolToDebug);

    void SetSymbolsToDebug(const std::set<std::string>& symbolsToDebug);

    std::set<std::string> GetSymbolsToDebug();

    bool DebugFile( const std::string& fileToDebug );

    bool DebugSymbol( const std::string& symbolToDebug );
    bool Debug( const std::string& fileToDebug, const std::string& symbol="" );
    void SetLogFile( const std::string& file );
    void ShowMessage( const std::string& message );
    EndoDebug();
    virtual ~EndoDebug();

   private:
    EndoDebugData* d;
  };
}

// DISABLE DEBUGGING FOR RELEASE MODE ON WINDOWS
#if (defined(WIN32) &&  !defined(_DEBUG)) || defined(NDEBUG)
    #define endodebugmarker
    #define endodebug(msg)
    #define endodebugvar(var)
    #define endodebugsymbol(var, mSymbol)
    #define endodebugimg(imgVariableName)
    #define endodebugbegin if( false ) {
    #define endodebugend }
    #define endoAssert(a) \
    if(!(a)) { \
        throw std::invalid_argument("FAILED: " #a); \
    }

    #define endoAssertMsg(a, msg) \
    if(!(a)) { \
    throw std::invalid_argument( "FAILED: " #a ); \
    }

    #define endodebugcode(code)
    #define endoAssertCode(assertCode)
#else
  #define endodebugmarker\
    if( mitk::EndoDebug::GetInstance().Debug(__FILE__) ) \
    { \
      std::ostringstream ___ostringstream; \
      ___ostringstream << mitk::EndoDebug::GetInstance().GetFilenameWithoutExtension(__FILE__) << ", " << __LINE__\
      << ": " << __FUNCTION__ << std::endl;\
      mitk::EndoDebug::GetInstance().ShowMessage( ___ostringstream.str() ); \
    }

  #define endodebug(msg)\
    if( mitk::EndoDebug::GetInstance().Debug(__FILE__) ) \
    { \
      std::ostringstream ___ostringstream; \
      ___ostringstream << mitk::EndoDebug::GetInstance().GetFilenameWithoutExtension(__FILE__) << ", " << __LINE__\
        << ": " << msg << std::endl;\
      mitk::EndoDebug::GetInstance().ShowMessage( ___ostringstream.str() ); \
    }

  #define endodebugvar(var)\
    if( mitk::EndoDebug::GetInstance().Debug(__FILE__) ) \
    { \
      std::ostringstream ___ostringstream; \
      ___ostringstream << mitk::EndoDebug::GetInstance().GetFilenameWithoutExtension(__FILE__) << ", " << __LINE__\
        << ": " #var " = " << var << std::endl;\
      mitk::EndoDebug::GetInstance().ShowMessage( ___ostringstream.str() ); \
    }

  #define endodebugsymbol(var, mSymbol)\
    if( mitk::EndoDebug::GetInstance().Debug(__FILE__, mSymbol) ) \
    { \
      std::ostringstream ___ostringstream; \
      ___ostringstream << mitk::EndoDebug::GetInstance().GetFilenameWithoutExtension(__FILE__) << ", " << __LINE__\
        << ": " #var " = " << var << std::endl;\
      mitk::EndoDebug::GetInstance().ShowMessage( ___ostringstream.str() ); \
    }

  #define endodebugimg(imgVariableName)\
    if( mitk::EndoDebug::GetInstance().Debug(__FILE__) \
        && mitk::EndoDebug::GetInstance().GetShowImagesInDebug() \
        && (imgVariableName).cols > 0 && (imgVariableName).rows > 0 && (imgVariableName).data) \
    { \
      std::ostringstream ___ostringstream; \
      ___ostringstream << mitk::EndoDebug::GetInstance().GetFilenameWithoutExtension(__FILE__) << ", " << __LINE__\
        << ": Showing " #imgVariableName << std::endl; \
      mitk::EndoDebug::GetInstance().ShowMessage( ___ostringstream.str() ); \
      std::string outputFile = mitk::EndoDebug::GetInstance().GetDebugImagesOutputDirectory(); \
      if( !outputFile.empty() ) \
      {\
        outputFile =  mitk::EndoDebug::GetInstance().GetUniqueFileName(outputFile, "jpg", std::string(#imgVariableName) );\
        cv::imwrite(outputFile, imgVariableName);\
      }\
      else\
      {\
        cv::imshow( "Debug", imgVariableName ); \
        cv::waitKey( mitk::EndoDebug::GetInstance().GetShowImagesTimeOut() ); \
      }\
    }

  #define endodebugbegin \
    if( mitk::EndoDebug::GetInstance().Debug(__FILE__) ) \
    {

  #define endodebugend \
    }

  #define endodebugcode(code) \
    endodebugbegin \
    code \
    endodebugend

#define endoAssert(a) \
if(!(a)) { \
std::ostringstream s; \
s << mitk::EndoDebug::GetInstance().GetFilenameWithoutExtension(__FILE__) << ", " \
  << __LINE__ << ", failed: " << #a; \
throw std::invalid_argument(s.str()); }

#define endoAssertMsg(a, msg) \
if(!(a)) { \
  std::ostringstream s; \
  s << mitk::EndoDebug::GetInstance().GetFilenameWithoutExtension(__FILE__) << ", " \
    << __LINE__ << ": " << msg; \
  throw std::invalid_argument(s.str()); \
  }

#define endoAssertCode(assertCode) \
    assertCode

#endif

#endif // mitkEndoDebug_h