nugu_log.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. All rights reserved.
 *
 * 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 __NUGU_LOG_H__
#define __NUGU_LOG_H__
 
#include <stdio.h>
#include <stdint.h>
#include <nugu.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef NUGU_ANSI_COLOR_NORMAL
#ifdef NUGU_LOG_USE_ANSICOLOR
#define NUGU_ANSI_COLOR_NORMAL       "\x1b[0m"
#else
#define NUGU_ANSI_COLOR_NORMAL       ""
#endif
#endif
 
#ifndef NUGU_ANSI_COLOR_BLACK
#define NUGU_ANSI_COLOR_BLACK        "\x1b[0;30m"
#endif
 
#ifndef NUGU_ANSI_COLOR_RED
#define NUGU_ANSI_COLOR_RED          "\x1b[0;31m"
#endif
 
#ifndef NUGU_ANSI_COLOR_GREEN
#define NUGU_ANSI_COLOR_GREEN        "\x1b[0;32m"
#endif
 
#ifndef NUGU_ANSI_COLOR_BROWN
#define NUGU_ANSI_COLOR_BROWN        "\x1b[0;33m"
#endif
 
#ifndef NUGU_ANSI_COLOR_BLUE
#define NUGU_ANSI_COLOR_BLUE         "\x1b[0;34m"
#endif
 
#ifndef NUGU_ANSI_COLOR_MAGENTA
#define NUGU_ANSI_COLOR_MAGENTA      "\x1b[0;35m"
#endif
 
#ifndef NUGU_ANSI_COLOR_CYAN
#define NUGU_ANSI_COLOR_CYAN         "\x1b[0;36m"
#endif
 
#ifndef NUGU_ANSI_COLOR_LIGHTGRAY
#define NUGU_ANSI_COLOR_LIGHTGRAY    "\x1b[0;37m"
#endif
 
#ifndef NUGU_ANSI_COLOR_DARKGRAY
#define NUGU_ANSI_COLOR_DARKGRAY     "\x1b[1;30m"
#endif
 
#ifndef NUGU_ANSI_COLOR_LIGHTRED
#define NUGU_ANSI_COLOR_LIGHTRED     "\x1b[1;31m"
#endif
 
#ifndef NUGU_ANSI_COLOR_LIGHTGREEN
#define NUGU_ANSI_COLOR_LIGHTGREEN   "\x1b[1;32m"
#endif
 
#ifndef NUGU_ANSI_COLOR_YELLOW
#define NUGU_ANSI_COLOR_YELLOW       "\x1b[1;33m"
#endif
 
#ifndef NUGU_ANSI_COLOR_LIGHTBLUE
#define NUGU_ANSI_COLOR_LIGHTBLUE    "\x1b[1;34m"
#endif
 
#ifndef NUGU_ANSI_COLOR_LIGHTMAGENTA
#define NUGU_ANSI_COLOR_LIGHTMAGENTA "\x1b[1;35m"
#endif
 
#ifndef NUGU_ANSI_COLOR_LIGHTCYAN
#define NUGU_ANSI_COLOR_LIGHTCYAN    "\x1b[1;36m"
#endif
 
#ifndef NUGU_ANSI_COLOR_WHITE
#define NUGU_ANSI_COLOR_WHITE        "\x1b[1;37m"
#endif
 
enum nugu_log_level {
        NUGU_LOG_LEVEL_ERROR, 
        NUGU_LOG_LEVEL_WARNING, 
        NUGU_LOG_LEVEL_INFO, 
        NUGU_LOG_LEVEL_DEBUG 
};
 
enum nugu_log_system {
        NUGU_LOG_SYSTEM_STDERR, 
        NUGU_LOG_SYSTEM_STDOUT, 
        NUGU_LOG_SYSTEM_SYSLOG, 
        NUGU_LOG_SYSTEM_NONE, 
        NUGU_LOG_SYSTEM_CUSTOM 
};
 
enum nugu_log_prefix {
        NUGU_LOG_PREFIX_NONE = 0, 
        NUGU_LOG_PREFIX_TIMESTAMP = (1 << 0), 
        NUGU_LOG_PREFIX_PID = (1 << 1), 
        NUGU_LOG_PREFIX_TID = (1 << 2), 
        NUGU_LOG_PREFIX_LEVEL = (1 << 3), 
        NUGU_LOG_PREFIX_FILEPATH = (1 << 4), 
        NUGU_LOG_PREFIX_FILENAME = (1 << 5), 
        NUGU_LOG_PREFIX_FUNCTION = (1 << 6), 
        NUGU_LOG_PREFIX_LINE = (1 << 7), 
        NUGU_LOG_PREFIX_DEFAULT =
                (NUGU_LOG_PREFIX_TIMESTAMP | NUGU_LOG_PREFIX_PID |
                 NUGU_LOG_PREFIX_TID | NUGU_LOG_PREFIX_LEVEL |
                 NUGU_LOG_PREFIX_FILENAME | NUGU_LOG_PREFIX_LINE),
        NUGU_LOG_PREFIX_ALL =
                (NUGU_LOG_PREFIX_DEFAULT | NUGU_LOG_PREFIX_FUNCTION |
                 NUGU_LOG_PREFIX_FILEPATH) 
};
 
enum nugu_log_module {
        NUGU_LOG_MODULE_DEFAULT = 0x01, 
        NUGU_LOG_MODULE_NETWORK = 0x02, 
        NUGU_LOG_MODULE_NETWORK_TRACE = 0x04, 
        NUGU_LOG_MODULE_AUDIO = 0x08, 
        NUGU_LOG_MODULE_PROTOCOL = 0x10, 
        NUGU_LOG_MODULE_PROFILING = 0x20, 
        NUGU_LOG_MODULE_APPLICATION = 0x40, 
        NUGU_LOG_MODULE_PRESET_SDK_DEFAULT =
                (NUGU_LOG_MODULE_DEFAULT | NUGU_LOG_MODULE_NETWORK |
                 NUGU_LOG_MODULE_AUDIO | NUGU_LOG_MODULE_PROTOCOL),
        NUGU_LOG_MODULE_PRESET_DEFAULT = (NUGU_LOG_MODULE_PRESET_SDK_DEFAULT |
                                          NUGU_LOG_MODULE_APPLICATION),
        NUGU_LOG_MODULE_PRESET_NETWORK =
                (NUGU_LOG_MODULE_NETWORK | NUGU_LOG_MODULE_NETWORK_TRACE |
                 NUGU_LOG_MODULE_PROTOCOL),
        NUGU_LOG_MODULE_ALL = 0xFF 
};
 
#ifndef NUGU_LOG_MODULE
#define NUGU_LOG_MODULE NUGU_LOG_MODULE_DEFAULT
#endif
 
NUGU_API void nugu_log_print(enum nugu_log_module module,
                             enum nugu_log_level level, const char *filename,
                             const char *funcname, int line, const char *format,
                             ...);
 
typedef void (*nugu_log_handler)(enum nugu_log_module module,
                                 enum nugu_log_level level, const char *prefix,
                                 const char *msg, void *user_data);
 
NUGU_API int nugu_log_set_system(enum nugu_log_system log_system);
 
NUGU_API enum nugu_log_system nugu_log_get_system(void);
 
NUGU_API int nugu_log_set_handler(nugu_log_handler handler, void *user_data);
 
NUGU_API void nugu_log_set_prefix_fields(enum nugu_log_prefix field_set);
 
NUGU_API enum nugu_log_prefix nugu_log_get_prefix_fields(void);
 
NUGU_API void nugu_log_set_modules(unsigned int bitset);
 
NUGU_API unsigned int nugu_log_get_modules(void);
 
NUGU_API void nugu_log_set_level(enum nugu_log_level level);
 
NUGU_API enum nugu_log_level nugu_log_get_level(void);
 
NUGU_API void nugu_log_set_protocol_line_limit(int length);
 
NUGU_API int nugu_log_get_protocol_line_limit(void);
 
NUGU_API void nugu_hexdump(enum nugu_log_module module, const uint8_t *data,
                           size_t data_size, const char *header,
                           const char *footer, const char *lineindent);
 
#ifdef __cplusplus
}
#endif
 
#ifndef __FILENAME__
#define __FILENAME__ __FILE__
#endif
 
#ifdef _WIN32
#define nugu_log(module, level, fmt, ...)                                      \
        nugu_log_print(module, level, __FILENAME__, __FUNCSIG__, __LINE__,     \
                       fmt, ##__VA_ARGS__)
#else
#define nugu_log(module, level, fmt, ...)                                      \
        nugu_log_print(module, level, __FILENAME__, __PRETTY_FUNCTION__,       \
                       __LINE__, fmt, ##__VA_ARGS__)
#endif
 
#ifdef CONFIG_RELEASE
#define nugu_dbg(fmt, ...)
#define nugu_info(fmt, ...)
#define nugu_warn(fmt, ...)
#else
 
#define nugu_dbg(fmt, ...)                                                     \
        nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_DEBUG, fmt, ##__VA_ARGS__)
 
#define nugu_info(fmt, ...)                                                    \
        nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_INFO, fmt, ##__VA_ARGS__)
 
#define nugu_warn(fmt, ...)                                                    \
        nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_WARNING, fmt, ##__VA_ARGS__)
#endif
 
#define nugu_error(fmt, ...)                                                   \
        nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_ERROR, fmt, ##__VA_ARGS__)
 
#ifndef NUGU_ANSI_COLOR_SEND
#ifdef NUGU_LOG_USE_ANSICOLOR
#define NUGU_ANSI_COLOR_SEND NUGU_ANSI_COLOR_BROWN
#else
#define NUGU_ANSI_COLOR_SEND ""
#endif
#endif
 
#ifndef NUGU_ANSI_COLOR_RECV
#ifdef NUGU_LOG_USE_ANSICOLOR
#define NUGU_ANSI_COLOR_RECV NUGU_ANSI_COLOR_GREEN
#else
#define NUGU_ANSI_COLOR_RECV ""
#endif
#endif
 
#ifndef NUGU_LOG_MARK_SEND
#define NUGU_LOG_MARK_SEND "--> "
#endif
 
#ifndef NUGU_LOG_MARK_RECV
#define NUGU_LOG_MARK_RECV "<-- "
#endif
 
#define nugu_log_protocol_send(level, fmt, ...)                                \
        nugu_log_print(NUGU_LOG_MODULE_PROTOCOL, level, NULL, NULL, -1,        \
                       NUGU_ANSI_COLOR_SEND NUGU_LOG_MARK_SEND fmt             \
                               NUGU_ANSI_COLOR_NORMAL,                         \
                       ##__VA_ARGS__)
 
#define nugu_log_protocol_recv(level, fmt, ...)                                \
        nugu_log_print(NUGU_LOG_MODULE_PROTOCOL, level, NULL, NULL, -1,        \
                       NUGU_ANSI_COLOR_RECV NUGU_LOG_MARK_RECV fmt             \
                               NUGU_ANSI_COLOR_NORMAL,                         \
                       ##__VA_ARGS__)
 
#define nugu_error_nomem() nugu_error("Not enough memory")
 
#endif