debugging.h

Go to the documentation of this file.

 
#include "elementa/license.inc"
#include "elementa/checks.inc"
 
#ifndef ELEMENTA_BASE_DEBUGGING_H
#define ELEMENTA_BASE_DEBUGGING_H
 
#include <string>
#include <iostream>
#include <sstream>
#include "elementa/base/enums.h"
#include "elementa/base/threads.h"
 
namespace elementa
{
 
namespace base
{
 
/* ====================================================================== */
 
/* ========================================================================= */
 
 
#ifdef ELE_MAKE_PRODUCTION
    #undef ELE_PRE_TRACED
#endif
 
/* ****************************************************************************
 
    Const expression: kHiddenPlaceMsg
    Macros: ELE_PRE_FILELONGNAME, ELE_PRE_FILEBASENAME, 
            ELE_CODE_PLACE, ELE_CODE_LONGPLACE
 
******************************************************************************/
 
constexpr char kHiddenPlaceMsg[] = "place hidden in production";
 
#ifdef ELE_MAKE_PRODUCTION
 
    #define ELE_PRE_FILELONGNAME std::string{elementa::base::kHiddenPlaceMsg}
 
    #define ELE_PRE_FILEBASENAME std::string{elementa::base::kHiddenPlaceMsg}
 
#else
 
    #define ELE_PRE_FILELONGNAME std::string{__FILE__}
 
    #define ELE_PRE_FILEBASENAME (std::string{__FILE__}.rfind('/') >= \
                                    std::string{__FILE__}.size()-1 ? \
                                  std::string{__FILE__} : \
                                  std::string{__FILE__}.substr(\
                                    std::string{__FILE__}.rfind('/')+1) )
#endif
 
 
#define ELE_CODE_PLACE (ELE_PRE_FILEBASENAME + ":" + std::string{__func__} + \
                        ":" + std::to_string(__LINE__) )
 
 
#define ELE_CODE_LONGPLACE (ELE_PRE_FILELONGNAME + ":" +std::string{__func__} +\
                            ":" + std::to_string(__LINE__) )
 
 
/* ****************************************************************************
 
    Function: runtime_src_place
 
******************************************************************************/
 
 
ELE_CLASS_ENUM(RTTextWith,  
                kTime,
                kThread); 
 
 
std::string runtime_src_place(const std::string & place,
                              const RTTextWithEnum::Combination & flags = {},
                              const std::string & placepreff = "Place:",
                              const std::string & timepreff = "Time:",
                              const std::string & threadpreff = "Thread:");
 
/* ========================================================================= */
 
/* ========================================================================= */
 
/* ***************************************************************************
 
    Macros for enabling/disabling traces
 
*****************************************************************************/
 
#ifdef ELE_PRE_TRACED
 
 
    #define ELE_CODE_TRACE_ON constexpr bool kTraceOn_ = true
 
 
    #define ELE_CODE_TRACE_OFF constexpr bool kTraceOn_ = false
 
 
    #define ELE_CODE_TRACE_IF if (kTraceOn_) {
 
    #define ELE_CODE_TRACE_ELSE } else {
 
    #define ELE_CODE_TRACE_ENDIF }
 
#else
 
 
    #define ELE_CODE_TRACE_ON 
 
 
    #define ELE_CODE_TRACE_OFF
 
 
    #define ELE_CODE_TRACE_IF if (false) {
 
    #define ELE_CODE_TRACE_ELSE } else {
 
    #define ELE_CODE_TRACE_ENDIF }
 
 
#endif
 
/* **************************************************************************
 
    Macro: TRACE
 
*****************************************************************************/
 
#define ELE_PRE_TRACE_PREFFIX "--- TR : "
 
#ifdef ELE_PRE_TRACED
 
    #if ELE_PRE_CPPVER == 2017
        // C++17; supports if-constexpr and generates no code if traces off
 
        #define ELE_CODE_TRACE(flags,...) {\
                                            if constexpr(kTraceOn_)\
                                            {\
                                            std::cout << ELE_PRE_TRACE_PREFFIX \
                                              << "[" << \
                                            elementa::base::runtime_src_place(\
                                                    ELE_CODE_PLACE,\
                                                    flags) << \
                                              "]. " << __VA_ARGS__ << \
                                              std::endl;\
                                            }\
                                          }
 
        #define ELE_CODE_TRACEPOINT {\
                                            if constexpr(kTraceOn_)\
                                            {\
                                            std::cout << ELE_PRE_TRACE_PREFFIX \
                                              << "[TRACEPOINT - " << \
                                            elementa::base::runtime_src_place(\
                                                    ELE_CODE_PLACE,\
                                                    {}) << \
                                              "]." << \
                                              std::endl;\
                                            }\
                                          }     
                                          
        #define ELE_CODE_TRACENUDE(...) {\
                                            if constexpr(kTraceOn_)\
                                            {\
                                                std::cout << __VA_ARGS__; \
                                            }\
                                          }     
 
        #define ELE_CODE_PAUSE(flags,...) {\
                                            if constexpr(kTraceOn_)\
                                            {\
                                            std::cout << ELE_PRE_TRACE_PREFFIX \
                                              << "[" << \
                                            elementa::base::runtime_src_place(\
                                                    ELE_CODE_PLACE,\
                                                    flags) << \
                                              "]. " << __VA_ARGS__ << \
                                              ".\n----> Enter a number to " << \
                                              "go on: ";\
                                            int x;\
                                            std::cin >> x;\
                                            }\
                                          }
 
    #else
 
        #define ELE_CODE_TRACE(flags,...) {\
                                            if (kTraceOn_) \
                                            {\
                                            std::cout << ELE_PRE_TRACE_PREFFIX \
                                              << "[" << \
                                            elementa::base::runtime_src_place(\
                                                    ELE_CODE_PLACE,\
                                                    flags) << \
                                              "]. " << __VA_ARGS__ << \
                                              std::endl;\
                                            }\
                                          }
                                          
        #define ELE_CODE_TRACEPOINT {\
                                            if (kTraceOn_) \
                                            {\
                                            std::cout << ELE_PRE_TRACE_PREFFIX \
                                              << "[TRACEPOINT - " << \
                                            elementa::base::runtime_src_place(\
                                                    ELE_CODE_PLACE,\
                                                    {}) << \
                                              "]." << \
                                              std::endl;\
                                            }\
                                          }
 
        #define ELE_CODE_TRACENUDE(...) {\
                                            if constexpr(kTraceOn_)\
                                            {\
                                                std::cout << __VA_ARGS__; \
                                            }\
                                          }     
 
        #define ELE_CODE_PAUSE(flags,...) {\
                                            if (kTraceOn_) \
                                            {\
                                            std::cout << ELE_PRE_TRACE_PREFFIX \
                                              << "[" << \
                                            elementa::base::runtime_src_place(\
                                                    ELE_CODE_PLACE,\
                                                    flags) << \
                                              "]. " << __VA_ARGS__ << \
                                              ".\n----> Enter a number to " << \
                                              "go on: ";\
                                            int x;\
                                            std::cin >> x;\
                                            }\
                                          }
                                        
    #endif
 
#else
 
    #define ELE_CODE_TRACE(flags,...) {}
 
    #define ELE_CODE_TRACEPOINT {}
    
    #define ELE_CODE_TRACENUDE(...) {}
    
    #define ELE_CODE_PAUSE(flags,...) {}
 
#endif
 
#define ELE_CODE_UNTRACE(flags,...)
 
#define ELE_CODE_UNTRACEPOINT
 
#define ELE_CODE_UNPAUSE(flags,...)
 
 
#define ELE_CODE_UNTRACE_IF if (false) {
 
#define ELE_CODE_UNTRACE_ELSE } else {
 
#define ELE_CODE_UNTRACE_ENDIF }
 
 // Debugging
 
 
} // end namespace base
 
} // end namespace elementa
 
#endif