VuoLog.h

Go to the documentation of this file.

 
// Don't use `#pragma once` here, since this header is included both from the source tree and from Vuo.framework.
#ifndef VUO_LOG
#define VUO_LOG
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <dlfcn.h>
#include <libgen.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
 
double VuoLogGetTime(void);
double VuoLogGetElapsedTime(void);
bool VuoIsDebugEnabled(void);
 
void VuoLog_backtrace(void);
#ifdef __cplusplus
}
#include <vector>
std::vector<std::string> VuoLog_getBacktrace(void);
extern "C" {
#endif
 
bool VuoLog_isDebuggerAttached(void);
 
static char *VuoLog_moduleName = 0;  
 
static void __attribute__((constructor(90))) VuoLog_initModuleName(void)
{
    Dl_info info;
    if (dladdr((void *)VuoLog_initModuleName, &info) && info.dli_fname)
    {
        VuoLog_moduleName = basename_r(info.dli_fname, (char *)malloc(strlen(info.dli_fname + 1)));
 
        if (VuoLog_moduleName)
        {
            // Trim off the `lib` prefix, if any.
            if (strncmp(VuoLog_moduleName, "lib", 3) == 0)
                VuoLog_moduleName += 3;
 
            // Trim off the extension, if any.
            char *dot = strrchr(VuoLog_moduleName, '.');
            if (dot)
                *dot = 0;
        }
    }
}
 
#define VuoLog_status(format, ...) VuoLog_statusF(VuoLog_moduleName, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)
 
#ifdef DOXYGEN
void VuoLog_statusF(const char *moduleName, const char *file, const unsigned int linenumber, const char *function, const char *format, ...);
#else
void VuoLog_statusF(const char *moduleName, const char *file, const unsigned int linenumber, const char *function, const char *format, ...) __attribute__((format(printf, 5, 6)));
#endif
 
#ifdef DOXYGEN
void VuoLog(const char *moduleName, const char *file, const unsigned int linenumber, const char *function, const char *format, ...);
#else
void VuoLog(const char *moduleName, const char *file, const unsigned int linenumber, const char *function, const char *format, ...) __attribute__((format(printf, 5, 6)));
#endif
 
#define VL() VuoLog(VuoLog_moduleName, __FILE__, __LINE__, __func__, "")
 
#define VLog(format, ...) VuoLog(VuoLog_moduleName, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)
 
#define VUserLog(format, ...) VuoLog(VuoLog_moduleName, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)
 
#define VDebugLog(format, ...) do { if (VuoIsDebugEnabled()) VuoLog(VuoLog_moduleName, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__); } while(0)
 
#define VLogHeap(heapPointer) do { \
    char *description = VuoHeap_getDescription(heapPointer); \
    VLog("%s = %p (registered at %s)", #heapPointer, heapPointer, description); \
    free(description); \
    } while(0)
 
 
void VuoLog_recordTime(const char *name, double time);
 
#ifdef VUO_PROFILE
#define VUOLOG_PROFILE_BEGIN(object) double VuoLog_time_ ## object = VuoLogGetTime();
#define VUOLOG_PROFILE_END(object) VuoLog_recordTime(#object, VuoLogGetTime() - VuoLog_time_ ## object);
#else
#define VUOLOG_PROFILE_BEGIN(object)
 
#define VUOLOG_PROFILE_END(object)
#endif
 
#ifndef DOXYGEN
// Executes the block passed to it (an adapter in order to use `__attribute__((cleanup(…)))` with C Blocks).
static inline void VuoDeferCleanup(void (^*b)(void)) { if (*b) (*b)(); }
 
// Combines two strings into an identifier.
#define VuoDeferMerge(a,b) a##b
 
// Create the name of the defer scope variable.
#define VuoDeferVarName(a) VuoDeferMerge(VuoDeferScopeVar, a)
#endif
 
#define VuoDefer __attribute__((cleanup(VuoDeferCleanup),unused)) void (^VuoDeferVarName(__COUNTER__))(void) =
 
#ifdef __cplusplus
}
#endif
 
#endif