kaa_log.h

Go to the documentation of this file.

/*
 * Copyright 2014 CyberVision, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef KAA_LOG_H_
#define KAA_LOG_H_

#include "../kaa_error.h"
#include "../platform/defaults.h"


#ifdef __cplusplus
extern "C" {
#endif


#define KAA_LOG_LEVEL_NONE  0

#define KAA_LOG_LEVEL_FATAL 1

#define KAA_LOG_LEVEL_ERROR 2

#define KAA_LOG_LEVEL_WARN  3

#define KAA_LOG_LEVEL_INFO  4

#define KAA_LOG_LEVEL_DEBUG 5

#define KAA_LOG_LEVEL_TRACE 6

#ifndef KAA_MAX_LOG_LEVEL

#define KAA_MAX_LOG_LEVEL   KAA_LOG_LEVEL_TRACE
#endif

#define KAA_LOG_LEVEL_FATAL_ENABLED     (KAA_MAX_LOG_LEVEL >= KAA_LOG_LEVEL_FATAL)
#define KAA_LOG_LEVEL_ERROR_ENABLED     (KAA_MAX_LOG_LEVEL >= KAA_LOG_LEVEL_ERROR)
#define KAA_LOG_LEVEL_WARN_ENABLED      (KAA_MAX_LOG_LEVEL >= KAA_LOG_LEVEL_WARN)
#define KAA_LOG_LEVEL_INFO_ENABLED      (KAA_MAX_LOG_LEVEL >= KAA_LOG_LEVEL_INFO)
#define KAA_LOG_LEVEL_DEBUG_ENABLED     (KAA_MAX_LOG_LEVEL >= KAA_LOG_LEVEL_DEBUG)
#define KAA_LOG_LEVEL_TRACE_ENABLED     (KAA_MAX_LOG_LEVEL >= KAA_LOG_LEVEL_TRACE)


#ifndef KAA_LOGGER_T
    #define KAA_LOGGER_T
    typedef struct kaa_logger_t             kaa_logger_t;
#endif

typedef uint8_t kaa_log_level_t;

kaa_error_t kaa_log_create(kaa_logger_t **logger_p, size_t buffer_size, kaa_log_level_t max_log_level, FILE* sink);

kaa_error_t kaa_log_destroy(kaa_logger_t *logger);

kaa_log_level_t kaa_get_max_log_level(const kaa_logger_t *self);

kaa_error_t kaa_set_max_log_level(kaa_logger_t *self, kaa_log_level_t max_log_level);

kaa_error_t kaa_log_set_sink(kaa_logger_t *self, FILE *sink);

void kaa_log_write(kaa_logger_t *self, const char* source_file, int lineno, kaa_log_level_t log_level
        , kaa_error_t error_code, const char* format, ...);

/*
 * Shortcut macros for logging at various log levels
 */
#if KAA_LOG_LEVEL_FATAL_ENABLED
#define KAA_LOG_FATAL(logger, err, ...) kaa_log_write(logger, __FILE__, __LINE__, KAA_LOG_LEVEL_FATAL, err, __VA_ARGS__);
#else
#define KAA_LOG_FATAL(...)
#endif

#if KAA_LOG_LEVEL_ERROR_ENABLED
#define KAA_LOG_ERROR(logger, err, ...) kaa_log_write(logger, __FILE__, __LINE__, KAA_LOG_LEVEL_ERROR, err, __VA_ARGS__);
#else
#define KAA_LOG_ERROR(...)
#endif

#if KAA_LOG_LEVEL_WARN_ENABLED
#define KAA_LOG_WARN(logger, err, ...)  kaa_log_write(logger, __FILE__, __LINE__, KAA_LOG_LEVEL_WARN, err, __VA_ARGS__);
#else
#define KAA_LOG_WARN(...)
#endif

#if KAA_LOG_LEVEL_INFO_ENABLED
#define KAA_LOG_INFO(logger, err, ...)  kaa_log_write(logger, __FILE__, __LINE__, KAA_LOG_LEVEL_INFO, err, __VA_ARGS__);
#else
#define KAA_LOG_INFO(...)
#endif

#if KAA_LOG_LEVEL_DEBUG_ENABLED
#define KAA_LOG_DEBUG(logger, err, ...) kaa_log_write(logger, __FILE__, __LINE__, KAA_LOG_LEVEL_DEBUG, err, __VA_ARGS__);
#else
#define KAA_LOG_DEBUG(...)
#endif

#if KAA_LOG_LEVEL_TRACE_ENABLED
#define KAA_LOG_TRACE(logger, err, ...) kaa_log_write(logger, __FILE__, __LINE__, KAA_LOG_LEVEL_TRACE, err, __VA_ARGS__);
#else
#define KAA_LOG_TRACE(...)
#endif

/*
 * Shortcut macros for tracing through the program
 */
#define KAA_TRACE_IN(logger)  KAA_LOG_TRACE(logger, KAA_ERR_NONE, "--> %s()", __FUNCTION__);
#define KAA_TRACE_OUT(logger) KAA_LOG_TRACE(logger, KAA_ERR_NONE, "<-- %s()", __FUNCTION__);

#ifdef __cplusplus
}      /* extern "C" */
#endif
#endif /* KAA_LOG_H_ */