afw_log.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework afw_log interface helpers header
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_LOG_H__
#define __AFW_LOG_H__
 
#include "afw_interface.h"
 
#define afw_log_release afw_log_destroy
 
AFW_BEGIN_DECLARES
 
typedef struct afw_log_priority_id_map_entry_s {
    const afw_utf8_t *priority_id;
    afw_log_priority_t priority;
    const afw_utf8_z_t *description;
} afw_log_priority_id_map_entry_t;
 
 
AFW_DECLARE(const afw_log_priority_id_map_entry_t *)
afw_log_get_priority_id_map();
 
 
AFW_DECLARE(afw_log_priority_t)
afw_log_priority_id_to_priority(
    const afw_utf8_t *priority_id);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_log_priority_to_priority_id(
    afw_log_priority_t priority);
 
 
AFW_DEFINE_STATIC_INLINE(afw_log_priority_mask_t)
afw_log_priority_mask(
    afw_log_priority_t priority)
{
    return 1 << priority;
}
 
AFW_DEFINE_STATIC_INLINE(afw_log_priority_mask_t)
afw_log_up_to_priority_mask(
    afw_log_priority_t priority)
{
    return (1 << (priority + 1) ) - 1;
}
 
AFW_DEFINE_STATIC_INLINE(afw_boolean_t)
afw_log_priority_in_mask(
    afw_log_priority_mask_t mask, afw_log_priority_t priority)
{
    return ((1 << priority) & mask) != 0;
}
 
AFW_DEFINE_STATIC_INLINE(void)
afw_log_set_priority_in_mask(
    afw_log_priority_mask_t *mask,
    afw_log_priority_t priority,
    afw_boolean_t value)
{
    if (value) {
        *mask |= (1 << priority);
    }
 
    else {
        *mask &= ~(1 << priority);
    }
}
 
#define AFW_LOG(priority, message, xctx) \
    afw_log_write(xctx->env->log, afw_log_priority_ ## priority, \
        AFW__FILE_LINE__, message, xctx)
 
#define AFW_LOG_Z(priority, message_z, xctx) \
    afw_log_write_z(xctx->env->log, afw_log_priority_ ## priority, \
        AFW__FILE_LINE__, message_z, xctx)
 
#define AFW_LOG_VZ(priority, format_z, ap, xctx) \
    afw_log_write_vz(xctx->env->log, afw_log_priority_ ## priority, \
        AFW__FILE_LINE__, format_z, ap, xctx)
 
#define AFW_LOG_FZ(priority, xctx, format_z, ...) \
    afw_log_write_fz(xctx->env->log, afw_log_priority_ ## priority, \
        AFW__FILE_LINE__, xctx, format_z, __VA_ARGS__)
 
 
AFW_DEFINE_STATIC_INLINE(void)
afw_log_write_z(
    const afw_log_t * instance,
    afw_log_priority_t priority,
    const afw_utf8_z_t * source_z,
    const afw_utf8_z_t * message_z,
    afw_xctx_t *xctx)
{
    afw_utf8_t message;
 
    message.s = message_z;
    message.len = strlen(message_z);
    afw_log_write(instance, priority, source_z, &message,
        xctx);
}
 
AFW_DECLARE(void)
afw_log_write_vz(
    const afw_log_t * instance,
    afw_log_priority_t priority,
    const afw_utf8_z_t * source_z,
    const afw_utf8_z_t * format_z,
    va_list ap,
    afw_xctx_t *xctx);
 
AFW_DEFINE_STATIC_INLINE(void)
afw_log_write_fz(
    const afw_log_t * instance,
    afw_log_priority_t priority,
    const afw_utf8_z_t * source_z,
    afw_xctx_t *xctx,
    const afw_utf8_z_t * format_z,
    ...)
{
    va_list ap;
 
    va_start(ap, format_z);
    afw_log_write_vz(instance, priority, source_z, format_z,
        ap, xctx);
    va_end(ap);
}
 
 
AFW_DECLARE(const afw_log_factory_t *)
afw_log_file_factory_get();
 
 
 
AFW_DECLARE(const afw_log_factory_t *)
afw_log_standard_factory_get();
 
 
 
AFW_DECLARE(void)
afw_log_add_to_environment(
    const afw_log_t * instance,
    afw_xctx_t *xctx);
 
 
/*
 * @brief Set a log's mask and insure env->mask is correct.
 * @param instance
 * @param mask
 * @param xctx of caller.
 */
AFW_DECLARE(void)
afw_log_set_mask(
    const afw_log_t * instance,
    afw_log_priority_mask_t mask,
    afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_LOG_H__ */