logging.h

Go to the documentation of this file.

#pragma once
 
#include <stdarg.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
 
 
#define MICROSTRAIN_LOGGING_LEVEL_OFF_   0
#define MICROSTRAIN_LOGGING_LEVEL_FATAL_ 1
#define MICROSTRAIN_LOGGING_LEVEL_ERROR_ 2
#define MICROSTRAIN_LOGGING_LEVEL_WARN_  3
#define MICROSTRAIN_LOGGING_LEVEL_INFO_  4
#define MICROSTRAIN_LOGGING_LEVEL_DEBUG_ 5
#define MICROSTRAIN_LOGGING_LEVEL_TRACE_ 6
 
#ifndef MICROSTRAIN_LOGGING_MAX_LEVEL
// Define a default logging level
#define MICROSTRAIN_LOGGING_MAX_LEVEL MICROSTRAIN_LOGGING_LEVEL_OFF_
#endif // !MICROSTRAIN_LOGGING_MAX_LEVEL
 
#if MICROSTRAIN_LOGGING_MAX_LEVEL > MICROSTRAIN_LOGGING_LEVEL_OFF_
#define MICROSTRAIN_LOGGING_ENABLED
#endif // MICROSTRAIN_LOGGING_MAX_LEVEL > MICROSTRAIN_LOGGING_LEVEL_OFF_
 
#if MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_FATAL_
#define MICROSTRAIN_LOGGING_ENABLED_FATAL
#endif // MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_FATAL_
 
#if MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_ERROR_
#define MICROSTRAIN_LOGGING_ENABLED_ERROR
#endif // MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_ERROR_
 
#if MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_WARN_
#define MICROSTRAIN_LOGGING_ENABLED_WARN
#endif // MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_WARN_
 
#if MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_INFO_
#define MICROSTRAIN_LOGGING_ENABLED_INFO
#endif // MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_INFO_
 
#if MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_DEBUG_
#define MICROSTRAIN_LOGGING_ENABLED_DEBUG
#endif // MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_DEBUG_
 
#if MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_TRACE_
#define MICROSTRAIN_LOGGING_ENABLED_TRACE
#endif // MICROSTRAIN_LOGGING_MAX_LEVEL >= MICROSTRAIN_LOGGING_LEVEL_TRACE_
 
// Helper function to avoid unused parameter warnings
static inline void microstrain_log_unused_v(const char* fmt, ...)
{
    (void)fmt;
}
 
typedef enum microstrain_log_level
{
    MICROSTRAIN_LOG_LEVEL_OFF   = MICROSTRAIN_LOGGING_LEVEL_OFF_,   
    MICROSTRAIN_LOG_LEVEL_FATAL = MICROSTRAIN_LOGGING_LEVEL_FATAL_, 
    MICROSTRAIN_LOG_LEVEL_ERROR = MICROSTRAIN_LOGGING_LEVEL_ERROR_, 
    MICROSTRAIN_LOG_LEVEL_WARN  = MICROSTRAIN_LOGGING_LEVEL_WARN_,  
    MICROSTRAIN_LOG_LEVEL_INFO  = MICROSTRAIN_LOGGING_LEVEL_INFO_,  
    MICROSTRAIN_LOG_LEVEL_DEBUG = MICROSTRAIN_LOGGING_LEVEL_DEBUG_, 
    MICROSTRAIN_LOG_LEVEL_TRACE = MICROSTRAIN_LOGGING_LEVEL_TRACE_, 
} microstrain_log_level;
 
typedef void (*microstrain_log_callback)(void* user, const microstrain_log_level level, const char* fmt, va_list args);
 
void microstrain_logging_init(const microstrain_log_callback callback, const microstrain_log_level level, void* user);
 
microstrain_log_callback microstrain_logging_callback(void);
 
microstrain_log_level microstrain_logging_level(void);
 
void* microstrain_logging_user_data(void);
 
void microstrain_logging_log_v(const microstrain_log_level level, const char* fmt, va_list args);
 
void microstrain_logging_log(const microstrain_log_level level, const char* fmt, ...);
 
const char* microstrain_logging_level_name(const microstrain_log_level level);
 
void microstrain_log_bytes(const microstrain_log_level level, const char* msg, const uint8_t* data, size_t length);
 
#ifdef MICROSTRAIN_LOGGING_ENABLED
#define MICROSTRAIN_LOG_INIT(callback, level, user) microstrain_logging_init(callback, level, user)
#else // !MICROSTRAIN_LOGGING_ENABLED
#define MICROSTRAIN_LOG_INIT(callback, level, user) (void)callback; (void)level; (void)user
#endif // MICROSTRAIN_LOGGING_ENABLED
 
#ifdef MICROSTRAIN_LOGGING_ENABLED
#define MICROSTRAIN_LOG_LOG(level, ...) microstrain_logging_log(level, __VA_ARGS__)
#define MICROSTRAIN_LOG_LOG_V(level, fmt, args) microstrain_logging_log_v(level, fmt, args)
#else // !MICROSTRAIN_LOGGING_ENABLED
#define MICROSTRAIN_LOG_LOG(level, ...) microstrain_log_unused_v(__VA_ARGS__)
#define MICROSTRAIN_LOG_LOG_V(level, fmt, args) (void)fmt; (void)args
#endif // MICROSTRAIN_LOGGING_ENABLED
 
#ifdef MICROSTRAIN_LOGGING_ENABLED_FATAL
#define MICROSTRAIN_LOG_FATAL(...) MICROSTRAIN_LOG_LOG(MICROSTRAIN_LOG_LEVEL_FATAL, __VA_ARGS__)
#define MICROSTRAIN_LOG_FATAL_V(fmt, args) MICROSTRAIN_LOG_LOG_V(MICROSTRAIN_LOG_LEVEL_FATAL, fmt, args)
#else // !MICROSTRAIN_LOGGING_ENABLED_FATAL
#define MICROSTRAIN_LOG_FATAL(...) microstrain_log_unused_v(__VA_ARGS__)
#define MICROSTRAIN_LOG_FATAL_V(fmt, args) (void)fmt; (void)args
#endif // MICROSTRAIN_LOGGING_ENABLED_FATAL
 
#ifdef MICROSTRAIN_LOGGING_ENABLED_ERROR
#define MICROSTRAIN_LOG_ERROR(...) MICROSTRAIN_LOG_LOG(MICROSTRAIN_LOG_LEVEL_ERROR, __VA_ARGS__)
#define MICROSTRAIN_LOG_ERROR_V(fmt, args) MICROSTRAIN_LOG_LOG_V(MICROSTRAIN_LOG_LEVEL_ERROR, fmt, args)
#else // !MICROSTRAIN_LOGGING_ENABLED_ERROR
#define MICROSTRAIN_LOG_ERROR(...) microstrain_log_unused_v(__VA_ARGS__)
#define MICROSTRAIN_LOG_ERROR_V(fmt, args) (void)fmt; (void)args
#endif // MICROSTRAIN_LOGGING_ENABLED_ERROR
 
#ifdef MICROSTRAIN_LOGGING_ENABLED_WARN
#define MICROSTRAIN_LOG_WARN(...) MICROSTRAIN_LOG_LOG(MICROSTRAIN_LOG_LEVEL_WARN, __VA_ARGS__)
#define MICROSTRAIN_LOG_WARN_V(fmt, args) MICROSTRAIN_LOG_LOG_V(MICROSTRAIN_LOG_LEVEL_WARN, fmt, args)
#else // !MICROSTRAIN_LOGGING_ENABLED_WARN
#define MICROSTRAIN_LOG_WARN(...) microstrain_log_unused_v(__VA_ARGS__)
#define MICROSTRAIN_LOG_WARN_V(fmt, args) (void)fmt; (void)args
#endif // MICROSTRAIN_LOGGING_ENABLED_WARN
 
#ifdef MICROSTRAIN_LOGGING_ENABLED_INFO
#define MICROSTRAIN_LOG_INFO(...) MICROSTRAIN_LOG_LOG(MICROSTRAIN_LOG_LEVEL_INFO, __VA_ARGS__)
#define MICROSTRAIN_LOG_INFO_V(fmt, args) MICROSTRAIN_LOG_LOG_V(MICROSTRAIN_LOG_LEVEL_INFO, fmt, args)
#else // !MICROSTRAIN_LOGGING_ENABLED_INFO
#define MICROSTRAIN_LOG_INFO(...) microstrain_log_unused_v(__VA_ARGS__)
#define MICROSTRAIN_LOG_INFO_V(fmt, args) (void)fmt; (void)args
#endif // MICROSTRAIN_LOGGING_ENABLED_INFO
 
#ifdef MICROSTRAIN_LOGGING_ENABLED_DEBUG
#define MICROSTRAIN_LOG_DEBUG(...) MICROSTRAIN_LOG_LOG(MICROSTRAIN_LOG_LEVEL_DEBUG, __VA_ARGS__)
#define MICROSTRAIN_LOG_DEBUG_V(fmt, args) MICROSTRAIN_LOG_LOG_V(MICROSTRAIN_LOG_LEVEL_DEBUG, fmt, args)
#else // !MICROSTRAIN_LOGGING_ENABLED_DEBUG
#define MICROSTRAIN_LOG_DEBUG(...) microstrain_log_unused_v(__VA_ARGS__)
#define MICROSTRAIN_LOG_DEBUG_V(fmt, args) (void)fmt; (void)args
#endif // MICROSTRAIN_LOGGING_ENABLED_DEBUG
 
#ifdef MICROSTRAIN_LOGGING_ENABLED_TRACE
#define MICROSTRAIN_LOG_TRACE(...) MICROSTRAIN_LOG_LOG(MICROSTRAIN_LOG_LEVEL_TRACE, __VA_ARGS__)
#define MICROSTRAIN_LOG_TRACE_V(fmt, args) MICROSTRAIN_LOG_LOG_V(MICROSTRAIN_LOG_LEVEL_TRACE, fmt, args)
#else // !MICROSTRAIN_LOGGING_ENABLED_TRACE
#define MICROSTRAIN_LOG_TRACE(...) microstrain_log_unused_v(__VA_ARGS__)
#define MICROSTRAIN_LOG_TRACE_V(fmt, args) (void)fmt; (void)args
#endif // MICROSTRAIN_LOGGING_ENABLED_TRACE
 
#ifdef MICROSTRAIN_LOGGING_ENABLED
#define MICROSTRAIN_LOG_BYTES(level, msg, data, length) microstrain_log_bytes(level, msg, data, length)
#else // !MICROSTRAIN_LOGGING_ENABLED
#define MICROSTRAIN_LOG_BYTES(level, msg, data, length) (void)level; (void)msg; (void)data; (void)length
#endif // MICROSTRAIN_LOGGING_ENABLED
 
#ifdef MICROSTRAIN_LOGGING_ENABLED_TRACE
#define MICROSTRAIN_LOG_BYTES_TRACE(msg, data, length) microstrain_log_bytes(MICROSTRAIN_LOG_LEVEL_TRACE, msg, data, length)
#else // !MICROSTRAIN_LOGGING_ENABLED_TRACE
#define MICROSTRAIN_LOG_BYTES_TRACE(msg, data, length) (void)msg; (void)data; (void)length
#endif // MICROSTRAIN_LOGGING_ENABLED_TRACE
 
 
#define MICROSTRAIN_LOG_ERROR_WITH_ERRNO(msg) MICROSTRAIN_LOG_ERROR(msg ": %d %s\n", errno, strerror(errno))
 
#define MICROSTRAIN_LOG_ERROR_WITH_ERRNO_EX(msg, ...) MICROSTRAIN_LOG_ERROR(msg ": %d %s\n", __VA_ARGS__, errno, strerror(errno))
 
 
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus