libjuno/log__api_8h_source.html

/*

    MIT License


    Copyright (c) 2025 Robin A. Onsay


    Permission is hereby granted, free of charge, to any person obtaining

    a copy of this software and associated documentation files

    (the "Software"), to deal in the Software without restriction,

    including without limitation the rights to use, copy, modify, merge,

    publish, distribute, sublicense, and/or sell copies of the Software,

    and to permit persons to whom the Software is furnished to do so,

    subject to the following conditions:


    The above copyright notice and this permission notice shall be

    included in all copies or substantial portions of the Software.

*/


#ifndef JUNO_LOG_API_H

#define JUNO_LOG_API_H

#include "juno/macros.h"

#include "juno/status.h"

#include "juno/module.h"

#ifdef __cplusplus

extern "C"

{

#endif


typedef struct JUNO_LOG_API_TAG JUNO_LOG_API_T;


typedef struct JUNO_LOG_ROOT_TAG JUNO_LOG_ROOT_T;


// @{"req": ["REQ-LOG-001"]}

struct JUNO_LOG_ROOT_TAG JUNO_MODULE_ROOT(JUNO_LOG_API_T, JUNO_MODULE_EMPTY);


struct JUNO_LOG_API_TAG

{

    // @{"req": ["REQ-LOG-002", "REQ-LOG-007"]}

    JUNO_STATUS_T (*LogDebug)(const JUNO_LOG_ROOT_T *ptJunoLog, const char *pcMsg, ...);

    // @{"req": ["REQ-LOG-003", "REQ-LOG-007"]}

    JUNO_STATUS_T (*LogInfo)(const JUNO_LOG_ROOT_T *ptJunoLog, const char *pcMsg, ...);

    // @{"req": ["REQ-LOG-004", "REQ-LOG-007"]}

    JUNO_STATUS_T (*LogWarning)(const JUNO_LOG_ROOT_T *ptJunoLog, const char *pcMsg, ...);

    // @{"req": ["REQ-LOG-005", "REQ-LOG-007"]}

    JUNO_STATUS_T (*LogError)(const JUNO_LOG_ROOT_T *ptJunoLog, const char *pcMsg, ...);

};


// @{"req": ["REQ-LOG-006"]}


static inline JUNO_STATUS_T JunoLog_LogInit(JUNO_LOG_ROOT_T *ptLog, const JUNO_LOG_API_T *ptApi, JUNO_FAILURE_HANDLER_T pfcnFailureHandler, JUNO_USER_DATA_T *pvUserData)

{

    JUNO_ASSERT_EXISTS(ptLog);

    ptLog->_pfcnFailureHandler = pfcnFailureHandler;

    ptLog->_pvFailureUserData = pvUserData;

    ptLog->ptApi = ptApi;

    return JUNO_STATUS_SUCCESS;

}


#ifdef __cplusplus

}

#endif

#endif // JUNO_LOG_API_H

JUNO_ASSERT_EXISTS
#define JUNO_ASSERT_EXISTS(ptr)
Returns JUNO_STATUS_NULLPTR_ERROR if the expression is falsy.
Definition macros.h:51

JUNO_MODULE_EMPTY
#define JUNO_MODULE_EMPTY
Helper for module definitions with no additional members.
Definition module.h:87

JUNO_MODULE_ROOT
#define JUNO_MODULE_ROOT(API_T,...)
Implement a module root struct containing ptApi and failure fields.
Definition module.h:129

JUNO_STATUS_SUCCESS
#define JUNO_STATUS_SUCCESS
Operation completed successfully.
Definition status.h:59

JUNO_FAILURE_HANDLER_T
void(* JUNO_FAILURE_HANDLER_T)(JUNO_STATUS_T tStatus, const char *pcCustomMessage, JUNO_USER_DATA_T *pvUserData)
Failure handler callback signature.
Definition status.h:110

JUNO_STATUS_T
int32_t JUNO_STATUS_T
Canonical status type for LibJuno functions.
Definition status.h:51

JUNO_USER_DATA_T
void JUNO_USER_DATA_T
Opaque user data type for failure callbacks.
Definition status.h:101

JUNO_LOG_ROOT_T
struct JUNO_LOG_ROOT_TAG JUNO_LOG_ROOT_T
Definition log_api.h:49

JunoLog_LogInit
static JUNO_STATUS_T JunoLog_LogInit(JUNO_LOG_ROOT_T *ptLog, const JUNO_LOG_API_T *ptApi, JUNO_FAILURE_HANDLER_T pfcnFailureHandler, JUNO_USER_DATA_T *pvUserData)
Initialize a log instance with an API implementation and failure handler.
Definition log_api.h:72

macros.h
Common assertion and helper macros for LibJuno modules.

module.h
Module system and dependency injection primitives for LibJuno.

status.h
Status codes and failure-handling helpers for LibJuno.

JUNO_LOG_API_TAG
Definition log_api.h:55

JUNO_LOG_API_TAG::LogError
JUNO_STATUS_T(* LogError)(const JUNO_LOG_ROOT_T *ptJunoLog, const char *pcMsg,...)
Log an error-level message.
Definition log_api.h:67

JUNO_LOG_API_TAG::LogWarning
JUNO_STATUS_T(* LogWarning)(const JUNO_LOG_ROOT_T *ptJunoLog, const char *pcMsg,...)
Log a warning-level message.
Definition log_api.h:64

JUNO_LOG_API_TAG::LogDebug
JUNO_STATUS_T(* LogDebug)(const JUNO_LOG_ROOT_T *ptJunoLog, const char *pcMsg,...)
Log a debug-level message (most verbose).
Definition log_api.h:58

JUNO_LOG_API_TAG::LogInfo
JUNO_STATUS_T(* LogInfo)(const JUNO_LOG_ROOT_T *ptJunoLog, const char *pcMsg,...)
Log an info-level message.
Definition log_api.h:61