ra8_log.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
/* =============================================================================
 * Log levels
 * =============================================================================
 */

#define RA8_LOG_LEVEL_NONE (0)
#define RA8_LOG_LEVEL_ERROR (1)
#define RA8_LOG_LEVEL_WARN (2)
#define RA8_LOG_LEVEL_INFO (3)
#define RA8_LOG_LEVEL_DEBUG (4)
 
typedef enum : uint8_t {
  k_ra8_log_level_none  = RA8_LOG_LEVEL_NONE,  
  k_ra8_log_level_error = RA8_LOG_LEVEL_ERROR, 
  k_ra8_log_level_warn  = RA8_LOG_LEVEL_WARN,  
  k_ra8_log_level_info  = RA8_LOG_LEVEL_INFO,  
  k_ra8_log_level_debug = RA8_LOG_LEVEL_DEBUG, 
} ra8_log_level_t;
 
#ifndef RA8_LOG_LEVEL
#ifdef DEBUG
#define RA8_LOG_LEVEL RA8_LOG_LEVEL_INFO
#else
#define RA8_LOG_LEVEL RA8_LOG_LEVEL_WARN
#endif
#endif
 
/* =============================================================================
 * Backend entry points (implemented in ra8_log.c)
 * =============================================================================
 */

void ra8_log_init(void);

typedef void (*ra8_log_byte_sink_fn_t)(void* ctx, uint8_t byte);

void ra8_log_set_byte_sink(ra8_log_byte_sink_fn_t fn, void* ctx);

void ra8_log_emit_error(const char* tag, const char* message);

void ra8_log_emit_warn(const char* tag, const char* message);

void ra8_log_emit_info(const char* tag, const char* message);

void ra8_log_emit_debug(const char* tag, const char* message);

void ra8_log_emit_error_val(const char* tag, const char* message, uint32_t value);

void ra8_log_emit_warn_val(const char* tag, const char* message, uint32_t value);

void ra8_log_emit_info_val(const char* tag, const char* message, uint32_t value);

void ra8_log_emit_debug_val(const char* tag, const char* message, int32_t value);
 
/* =============================================================================
 * Public macros (level-gated)
 * =============================================================================
 */
 
#if RA8_LOG_LEVEL >= RA8_LOG_LEVEL_ERROR
#define ra8_log_error(tag, message) ra8_log_emit_error((tag), (message))
#define ra8_log_error_val(tag, message, value) ra8_log_emit_error_val((tag), (message), (value))
#else
#define ra8_log_error(tag, message)            ((void)0)
#define ra8_log_error_val(tag, message, value) ((void)0)
#endif
 
#if RA8_LOG_LEVEL >= RA8_LOG_LEVEL_WARN
#define ra8_log_warn(tag, message) ra8_log_emit_warn((tag), (message))
#define ra8_log_warn_val(tag, message, value) ra8_log_emit_warn_val((tag), (message), (value))
#else
#define ra8_log_warn(tag, message)            ((void)0)
#define ra8_log_warn_val(tag, message, value) ((void)0)
#endif
 
#if RA8_LOG_LEVEL >= RA8_LOG_LEVEL_INFO
#define ra8_log_info(tag, message) ra8_log_emit_info((tag), (message))
#define ra8_log_info_val(tag, message, value) ra8_log_emit_info_val((tag), (message), (value))
#else
#define ra8_log_info(tag, message)            ((void)0)
#define ra8_log_info_val(tag, message, value) ((void)0)
#endif
 
#if RA8_LOG_LEVEL >= RA8_LOG_LEVEL_DEBUG
#define ra8_log_debug(tag, message) ra8_log_emit_debug((tag), (message))
#define ra8_log_debug_val(tag, message, value) ra8_log_emit_debug_val((tag), (message), (value))
#else
#define ra8_log_debug(tag, message)            ((void)0)
#define ra8_log_debug_val(tag, message, value) ((void)0)
#endif
 
#ifdef __cplusplus
}
#endif