debug.h

Go to the documentation of this file.

// Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/

#pragma once

#include <iostream>
#include <stdint.h>
#include <functional>
#include <sstream>
#include <memory>

#include <nx/kit/utils.h>

#if !defined(NX_KIT_API)
    #define NX_KIT_API /*empty*/
#endif

namespace nx {
namespace kit {
namespace debug {

//-------------------------------------------------------------------------------------------------
// Tools

NX_KIT_API std::string srcFileRelativePath(const std::string& file);

NX_KIT_API std::string srcFileBaseNameWithoutExt(const std::string& file);

//-------------------------------------------------------------------------------------------------
// Output

#if defined(NX_PRINT_TO_QDEBUG)
    #define NX_DEBUG_STREAM qDebug().nospace().noquote()
    #define NX_DEBUG_ENDL ""
    static inline QDebug operator<<(QDebug d, const std::string& s)
    {
        return d << QString::fromStdString(s);
    }
#endif

#if !defined(NX_DEBUG_INI)

    #define NX_DEBUG_INI ini().
#endif

#if !defined(NX_DEBUG_ENABLE_OUTPUT)

    #define NX_DEBUG_ENABLE_OUTPUT NX_DEBUG_INI enableOutput
#endif

#if !defined(NX_PRINT_PREFIX)

    #define NX_PRINT_PREFIX ::nx::kit::debug::detail::printPrefix(__FILE__)
#endif

#if !defined(NX_DEBUG_STREAM)

    #define NX_DEBUG_STREAM *::nx::kit::debug::stream()
#endif

#if !defined(NX_DEBUG_ENDL)

    #define NX_DEBUG_ENDL "\n"
#endif

NX_KIT_API std::ostream*& stream();

#if !defined(NX_PRINT)

     #define NX_PRINT /* << args... */ \
         nx::kit::debug::detail::Print(&(NX_DEBUG_STREAM), NX_DEBUG_ENDL) << NX_PRINT_PREFIX
#endif

#define NX_OUTPUT /* << args... */ \
    for (/* Executed either once or never; `for` instead of `if` gives no warnings. */ \
        int NX_KIT_DEBUG_DETAIL_CONCAT(nxOutput_, __line__) = 0; \
        NX_KIT_DEBUG_DETAIL_CONCAT(nxOutput_, __line__) != 1 && (NX_DEBUG_ENABLE_OUTPUT); \
        ++NX_KIT_DEBUG_DETAIL_CONCAT(nxOutput_, __line__) \
    ) NX_PRINT

//-------------------------------------------------------------------------------------------------
// Assertions

#define NX_KIT_ASSERT(/* CONDITION, MESSAGE = "" */ ...) \
    NX_KIT_DEBUG_DETAIL_MSVC_EXPAND(NX_KIT_DEBUG_DETAIL_GET_3RD_ARG( \
        __VA_ARGS__, NX_KIT_DEBUG_DETAIL_ASSERT2, NX_KIT_DEBUG_DETAIL_ASSERT1, \
        /* Helps to generate a reasonable compiler error. */ args_required)(__VA_ARGS__))

NX_KIT_API void intentionallyCrash(const char* message);

//-------------------------------------------------------------------------------------------------
// Print info

#define LL \
    NX_PRINT << "####### LL line " + ::nx::kit::utils::toString(__LINE__) \
        + NX_KIT_DEBUG_DETAIL_THREAD_ID \
        + ", " + ::nx::kit::debug::srcFileRelativePath(__FILE__) \
        /* The final semicolon allows to use this macro as a line prefix. */;

#define NX_PRINT_VALUE(VALUE) \
    NX_PRINT << "####### " #VALUE ": " + ::nx::kit::utils::toString(VALUE)

#define NX_PRINT_HEX_DUMP(CAPTION, BYTES, SIZE) \
    ::nx::kit::debug::detail::printHexDump( \
        NX_KIT_DEBUG_DETAIL_PRINT_FUNC, (CAPTION), (const char*) (BYTES), (int) (SIZE))

NX_KIT_API std::string hexDumpLine(const char* bytes, int size, int bytesPerLine = 0);

#if !defined(NX_DEBUG_SAVE_DIR)

    #define NX_DEBUG_SAVE_DIR ::nx::kit::IniConfig::iniFilesDir()
#endif

#define NX_SAVE_STR(FILENAME, STR) \
    ::nx::kit::debug::detail::saveStr( \
        NX_KIT_DEBUG_DETAIL_PRINT_FUNC, (NX_DEBUG_SAVE_DIR), (FILENAME), #STR, (STR))

#define NX_SAVE_BIN(FILENAME, BYTES, SIZE) \
    ::nx::kit::debug::detail::saveBin( \
        NX_KIT_DEBUG_DETAIL_PRINT_FUNC, (NX_DEBUG_SAVE_DIR), (FILENAME), (BYTES), (SIZE))

//-------------------------------------------------------------------------------------------------
// Time

#if !defined(NX_DEBUG_ENABLE_TIME)

    #define NX_DEBUG_ENABLE_TIME NX_DEBUG_INI enableTime
#endif

#define NX_TIME_BEGIN(TAG) \
    ::nx::kit::debug::detail::Timer nxTimer_##TAG( \
        (NX_DEBUG_ENABLE_TIME), NX_KIT_DEBUG_DETAIL_PRINT_FUNC, #TAG)

#define NX_TIME_MARK(TAG, MARK) do \
{ \
    if (NX_DEBUG_ENABLE_TIME) \
        nxTimer_##TAG.mark((MARK)); \
} while (0)

#define NX_TIME_END(TAG) do \
{ \
    if (NX_DEBUG_ENABLE_TIME) \
        nxTimer_##TAG.finish(); \
} while (0)

//-------------------------------------------------------------------------------------------------
// Fps

#if !defined(NX_DEBUG_ENABLE_FPS)

    #define NX_DEBUG_ENABLE_FPS NX_DEBUG_INI enableFps
#endif

#define NX_FPS(TAG, /*OPTIONAL_MARK*/...) do \
{ \
    if (NX_KIT_DEBUG_DETAIL_CONCAT(NX_DEBUG_ENABLE_FPS, TAG)) \
    { \
        static ::nx::kit::debug::detail::Fps fps( \
            NX_KIT_DEBUG_DETAIL_PRINT_FUNC, #TAG); \
        fps.mark(__VA_ARGS__); \
    } \
} while (0)

//-------------------------------------------------------------------------------------------------
// Implementation

namespace detail {

class Print: public std::ostringstream
{
public:
    Print(std::ostream* outputStream, const char* const newline):
        m_outputStream(outputStream), m_newline(newline)
    {
    }

    ~Print()
    {
        (*this) << m_newline;
        *m_outputStream << (*this).str(); //< Perform the actual output.
    }

private:
    std::ostream* m_outputStream;
    const char* const m_newline;
};

typedef std::function<void(const char*)> PrintFunc;

#define NX_KIT_DEBUG_DETAIL_PRINT_FUNC ([&](const char* message) { NX_PRINT << message; })

#define NX_KIT_DEBUG_DETAIL_MSVC_EXPAND(ARG) ARG

#define NX_KIT_DEBUG_DETAIL_GET_3RD_ARG(ARG1, ARG2, ARG3, ...) ARG3

#define NX_KIT_DEBUG_DETAIL_ASSERT1(CONDITION) \
    ::nx::kit::debug::detail::doAssert( \
        !!(CONDITION), NX_KIT_DEBUG_DETAIL_PRINT_FUNC, #CONDITION, "", __FILE__, __LINE__)

#define NX_KIT_DEBUG_DETAIL_ASSERT2(CONDITION, MESSAGE) \
    ::nx::kit::debug::detail::doAssert( \
        !!(CONDITION), NX_KIT_DEBUG_DETAIL_PRINT_FUNC, #CONDITION, MESSAGE, __FILE__, __LINE__)

NX_KIT_API void assertionFailed(
    PrintFunc printFunc, const char* conditionStr, const std::string& message,
    const char* file, int line);

inline bool doAssert(
    bool condition, PrintFunc printFunc, const char* conditionStr, const std::string& message,
    const char* file, int line)
{
    if (!condition)
        assertionFailed(printFunc, conditionStr, message, file, line);
    return condition;
}

#define NX_KIT_DEBUG_DETAIL_CONCAT(X, Y) NX_KIT_DEBUG_DETAIL_CONCAT2(X, Y)
#define NX_KIT_DEBUG_DETAIL_CONCAT2(X, Y) X##Y

NX_KIT_API std::string printPrefix(const char* file);

class NX_KIT_API Timer
{
public:
    Timer(bool enabled, PrintFunc printFunc, const char* tag);
    ~Timer();
    void mark(const char* markStr);
    void finish();

private:
    struct Impl;
    Impl* const d;
};

class NX_KIT_API Fps
{
public:
    Fps(PrintFunc printFunc, const char* tag);
    ~Fps();
    void mark(const char* markStr = nullptr);

private:
    struct Impl;
    Impl* const d;
};

NX_KIT_API void printHexDump(
    PrintFunc printFunc, const char* caption, const char* bytes, int size);

NX_KIT_API void saveStr(
    PrintFunc printFunc,
    const char* originDir,
    const char* filename,
    const char* strCaption,
    const std::string& str);

NX_KIT_API void saveBin(
    PrintFunc printFunc,
    const char* originDir,
    const char* filename,
    const char* bytes,
    int size);

} // namespace detail

} // namespace debug
} // namespace kit
} // namespace nx

// Define NX_KIT_DEBUG_DETAIL_THREAD_ID.
#if defined(__linux__)
    #if defined(__has_include) //< This C++17 feature was available in GCC/Clang long before.
        #if __has_include(<pthread.h>)
            #include <pthread.h>
            #define NX_KIT_DEBUG_DETAIL_THREAD_ID \
                ::nx::kit::utils::format(", thread %llx", (long long) pthread_self())
        #endif
    #endif
#elif defined(QT_CORE_LIB)
    #include <QtCore/QThread>
    #define NX_KIT_DEBUG_DETAIL_THREAD_ID \
        ::nx::kit::utils::format(", thread %llx", (long long) QThread::currentThreadId())
#endif
#if !defined(NX_KIT_DEBUG_DETAIL_THREAD_ID)
    // No threading libs available - do not print thread id.
    #define NX_KIT_DEBUG_DETAIL_THREAD_ID ""
#endif