debug.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_DEBUG_H
#define AJA_DEBUG_H

#include <stdio.h>
#include <sstream>
#include <set>
#include "ajabase/common/public.h"
#include "ajabase/system/debugshare.h"



#if defined(AJA_WINDOWS) 

    #if defined(AJA_DEBUG)
        #define AJA_ASSERT(_expression_) \
            if (!(_expression_)) AJADebug::AssertWithMessage(__FILE__, __LINE__, #_expression_);
        #define AJA_PRINT(...) \
            AJADebug::Report(0, AJA_DebugSeverity_Debug, NULL, 0, __VA_ARGS__)
    #else
        #define AJA_ASSERT(_expression_)
        #define AJA_PRINT(...)
    #endif

    #define AJA_REPORT(_index_, _severity_, ...) \
        AJADebug::Report(_index_, _severity_, __FILE__, __LINE__, __VA_ARGS__);

#elif defined(AJA_LINUX)

    #if defined(AJA_DEBUG)
        #define AJA_ASSERT(_expression_) \
            if(!(_expression_)) AJADebug::AssertWithMessage(NULL, 0, #_expression_);
        #define AJA_PRINT(...) \
            AJADebug::Report(0, AJA_DebugSeverity_Error, NULL, 0, __VA_ARGS__)
    #else
        #define AJA_ASSERT(_expression_)
        #define AJA_PRINT(...)
    #endif

    #define AJA_REPORT(_index_, _severity_, ...) \
        AJADebug::Report(_index_, _severity_, __FILE__, __LINE__, __VA_ARGS__);

#elif defined(AJA_MAC) 

    #if defined(AJA_DEBUG)
        #define AJA_ASSERT(_expression_) \
            if (!(_expression_)) AJADebug::AssertWithMessage(__FILE__, __LINE__, #_expression_);
        #if !defined (AJA_PRINTTYPE)
            #define AJA_PRINTTYPE       0
        #endif  //  if AJA_PRINTTYPE undefined
        #if (AJA_PRINTTYPE==0)
            #define AJA_PRINT(...) \
                AJADebug::Report(0, AJA_DebugSeverity_Error, NULL, 0, __VA_ARGS__)
        #elif (AJA_PRINTTYPE==1)
            #include <stdio.h>
            #define AJA_PRINT(_format_...) printf(_format_)
        #elif (AJA_PRINTTYPE==3)
            #include <stdio.h>
            #define AJA_PRINT(_format_...) fprintf(stderr, _format_)
        #elif (AJA_PRINTTYPE==4)
            #include <syslog.h>
            #include <stdarg.h>
            #define AJA_PRINT(_format_...) syslog(LOG_ERR, _format_)
        #endif
    #else
        #define AJA_ASSERT(_expression_)
        #define AJA_PRINT(...)
    #endif

    #define AJA_REPORT(_index_, _severity_, ...) \
        AJADebug::Report(_index_, _severity_, __FILE__, __LINE__, __VA_ARGS__);

#else

    #if defined(AJA_DEBUG)
        #define AJA_ASSERT(_expression_) \
            if(!(_expression_)) AJADebug::AssertWithMessage(NULL, 0, #_expression_);
        #define AJA_PRINT(_format_,...) \
            AJADebug::Report(0, AJA_DebugSeverity_Error, NULL, 0, _format_)
    #else
        #define AJA_ASSERT(_expression_)
        #define AJA_PRINT(_format_,...)
    #endif

    #define AJA_REPORT(_index_, _severity_, _format_, ...) \
        AJADebug::Report(_index_, _severity_, NULL, 0, _format_);

#endif



//  Handy ostream-based macros...

#define AJA_sASSERT(_expr_)             do  {   std::ostringstream  __ss__;  __ss__ << #_expr_;                 \
                                                AJADebug::AssertWithMessage(__FILE__, __LINE__, __ss__.str());  \
                                            } while (false)


#define AJA_sREPORT(_index_,_severity_,_expr_)      do {std::ostringstream  __ss__;  __ss__ << _expr_;                                  \
                                                        AJADebug::Report((_index_), (_severity_), __FILE__, __LINE__, __ss__.str());    \
                                                        } while (false)

#define AJA_sEMERGENCY(_index_,_expr_)      AJA_sREPORT((_index_), AJA_DebugSeverity_Emergency, _expr_)

#define AJA_sALERT(_index_,_expr_)          AJA_sREPORT((_index_), AJA_DebugSeverity_Alert,     _expr_)

#define AJA_sERROR(_index_,_expr_)          AJA_sREPORT((_index_), AJA_DebugSeverity_Error,     _expr_)

#define AJA_sWARNING(_index_,_expr_)        AJA_sREPORT((_index_), AJA_DebugSeverity_Warning,   _expr_)

#define AJA_sNOTICE(_index_,_expr_)         AJA_sREPORT((_index_), AJA_DebugSeverity_Notice,    _expr_)

#define AJA_sINFO(_index_,_expr_)           AJA_sREPORT((_index_), AJA_DebugSeverity_Info,      _expr_)

#define AJA_sDEBUG(_index_,_expr_)          AJA_sREPORT((_index_), AJA_DebugSeverity_Debug,     _expr_)

// forward declarations
class AJAMemory;

AJA_EXPORT std::string AJAStatusToString (const AJAStatus inStatus, const bool inDetailed = false);


class AJA_EXPORT AJADebug
{
public:

    AJADebug()          {}
    virtual ~AJADebug() {}

    static uint32_t Version (void); //  New in SDK 16.0

    static uint32_t TotalBytes (void);  //  New in SDK 16.0

    static AJAStatus Open (bool incrementRefCount = false);

    static AJAStatus Close (bool decrementRefCount = false);

    static AJAStatus Enable (int32_t index, uint32_t destination = AJA_DEBUG_DESTINATION_NONE);

    static AJAStatus Disable (int32_t index, uint32_t destination = AJA_DEBUG_DESTINATION_NONE);

    static AJAStatus SetDestination (int32_t index, uint32_t destination = AJA_DEBUG_DESTINATION_NONE);

    static AJAStatus GetDestination (const int32_t inGroup, uint32_t & outDestination);

    static bool IsActive (int32_t index);

    static bool IsOpen (void);

    static bool IsDebugBuild (void);

    static void Report (int32_t index, int32_t severity, const char* pFileName, int32_t lineNumber, ...);

    static void Report (int32_t index, int32_t severity, const char* pFileName, int32_t lineNumber, const std::string& message);

    static void AssertWithMessage (const char* pFileName, int32_t lineNumber, const std::string& pExpression);

    static uint32_t MessageRingCapacity (void); //  New in SDK 16.0

    static AJAStatus GetClientReferenceCount (int32_t & outRefCount);

    static AJAStatus SetClientReferenceCount (int32_t refCount);

    static AJAStatus GetSequenceNumber (uint64_t & outSequenceNumber);

    static AJAStatus GetMessageSequenceNumber (const uint64_t sequenceNumber, uint64_t & outSequenceNumber);

    static AJAStatus GetMessageGroup (const uint64_t sequenceNumber, int32_t & outGroupIndex);

    static AJAStatus GetMessageDestination (const uint64_t sequenceNumber, uint32_t & outDestination);

    static AJAStatus GetMessageTime (const uint64_t sequenceNumber, uint64_t & outTime);

    static AJAStatus GetMessageWallClockTime (const uint64_t sequenceNumber, int64_t & outTime);


    static AJAStatus GetMessageFileName (const uint64_t sequenceNumber, std::string & outFileName);

    static AJAStatus GetMessageLineNumber (const uint64_t sequenceNumber, int32_t & outLineNumber);

    static AJAStatus GetMessageSeverity (const uint64_t sequenceNumber, int32_t & outSeverity);

    static AJAStatus GetMessageText (const uint64_t sequenceNumber, std::string & outMessage);

    static AJAStatus GetProcessId (const uint64_t sequenceNumber, uint64_t & outPid);

    static AJAStatus GetThreadId (const uint64_t sequenceNumber, uint64_t & outTid);

    static AJAStatus GetMessagesAccepted (uint64_t & outCount);

    static AJAStatus GetMessagesIgnored (uint64_t & outCount);

    static const std::string & SeverityName (const int32_t severity);


    static const std::string & GroupName (const int32_t group);

    static AJAStatus SaveState (const std::string & inFilePath);

    static AJAStatus RestoreState (const std::string & inFilePath);

    static uint32_t StatsCapacity (void);   //  New in SDK 16.0

    static bool HasStats (void);    //  New in SDK 16.0

    static AJAStatus StatAllocate (const uint32_t inKey);   //  New in SDK 16.0

    static AJAStatus StatFree (const uint32_t inKey);   //  New in SDK 16.0

    static bool StatIsAllocated (const uint32_t inKey); //  New in SDK 16.0

    static AJAStatus StatReset (const uint32_t inKey);  //  New in SDK 16.0

    static AJAStatus StatTimerStart (const uint32_t inKey); //  New in SDK 16.0

    static AJAStatus StatTimerStop (const uint32_t inKey);  //  New in SDK 16.0

    static AJAStatus StatCounterIncrement (const uint32_t inKey, const uint32_t inIncrement = 1);   //  New in SDK 16.0

    static AJAStatus StatSetValue (const uint32_t inKey, const uint32_t inValue);   //  New in SDK 16.0

    static AJAStatus StatGetInfo (const uint32_t inKey, AJADebugStat & outInfo);    //  New in SDK 16.0

    static AJAStatus StatGetKeys (std::vector<uint32_t> & outKeys, uint32_t & outSeqNum);   //  New in SDK 16.0

    static AJAStatus StatGetKeys (std::set<uint32_t> & outKeys, uint32_t & outSeqNum);  //  New in SDK 16.3

    static AJAStatus StatGetSequenceNum (uint32_t & outSeqNum); //  New in SDK 16.3

    static int64_t DebugTime (void);

    //  Old APIs
    static const char* GetSeverityString (int32_t severity);
    static const char* GetGroupString (int32_t group);
    static AJAStatus GetDestination (int32_t index, uint32_t* pDestination) {return pDestination ? GetDestination(index, *pDestination) : AJA_STATUS_NULL;}
    static AJAStatus GetClientReferenceCount (int32_t* pRefCount)           {return pRefCount ? GetClientReferenceCount(*pRefCount) : AJA_STATUS_NULL;}
    static AJAStatus GetSequenceNumber (uint64_t* pSequenceNumber)          {return pSequenceNumber ? GetSequenceNumber(*pSequenceNumber) : AJA_STATUS_NULL;}
    static AJAStatus GetMessageSequenceNumber (uint64_t sequenceNumber, uint64_t *pSequenceNumber)  {return pSequenceNumber ? GetMessageSequenceNumber(sequenceNumber, *pSequenceNumber) : AJA_STATUS_NULL;}
    static AJAStatus GetMessageGroup (uint64_t sequenceNumber, int32_t* pGroupIndex)                {return pGroupIndex ? GetMessageGroup(sequenceNumber, *pGroupIndex) : AJA_STATUS_NULL;}
    static AJAStatus GetMessageDestination (uint64_t sequenceNumber, uint32_t* pDestination)        {return pDestination ? GetMessageDestination(sequenceNumber, *pDestination) : AJA_STATUS_NULL;}
    static AJAStatus GetMessageTime (uint64_t sequenceNumber, uint64_t* pTime)                      {return pTime ? GetMessageTime(sequenceNumber, *pTime) : AJA_STATUS_NULL;}
    static AJAStatus GetMessageWallClockTime (uint64_t sequenceNumber, int64_t *pTime)              {return pTime ? GetMessageWallClockTime(sequenceNumber, *pTime) : AJA_STATUS_NULL;}
    static AJAStatus GetMessageFileName (uint64_t sequenceNumber, const char** ppFileName);
    static AJAStatus GetMessageLineNumber (uint64_t sequenceNumber, int32_t* pLineNumber)           {return pLineNumber ? GetMessageLineNumber(sequenceNumber, *pLineNumber) : AJA_STATUS_NULL;}
    static AJAStatus GetMessageSeverity (uint64_t sequenceNumber, int32_t* pSeverity)               {return pSeverity ? GetMessageSeverity(sequenceNumber, *pSeverity) : AJA_STATUS_NULL;}
    static AJAStatus GetMessageText (uint64_t sequenceNumber, const char** ppMessage);
    static AJAStatus GetProcessId (uint64_t sequenceNumber, uint64_t* pPid)                         {return pPid ? GetProcessId(sequenceNumber, *pPid) : AJA_STATUS_NULL;}
    static AJAStatus GetThreadId (uint64_t sequenceNumber, uint64_t* pTid)                          {return pTid ? GetThreadId(sequenceNumber, *pTid) : AJA_STATUS_NULL;}
    static AJAStatus GetMessagesAccepted (uint64_t* pCount)                 {return pCount ? GetMessagesAccepted(*pCount) : AJA_STATUS_NULL;}
    static AJAStatus GetMessagesIgnored (uint64_t* pCount)                  {return pCount ? GetMessagesIgnored(*pCount) : AJA_STATUS_NULL;}

    //  Other APIs
    static void * GetPrivateDataLoc (void);
    static size_t GetPrivateDataLen (void);

};  //  AJADebug

std::ostream & operator << (std::ostream & oss, const AJADebugStat & inStat);

#endif  //  AJA_DEBUG_H