mirror
/
pinelog
mirror of https://github.com/nirenjan/pinelog.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Rename functions and macros to use the pinelog_ prefix

master
nirenjan 2021-07-13 11:40:33 -07:00
parent aa330a2cbf
commit 091dd29d3b
2 changed files with 42 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
pinelog.c
View File

@ -81,13 +81,13 @@ static int log_level = PINELOG_DEFAULT_LEVEL;
#if HAVE_FUNC_ATTRIBUTE_CONSTRUCTOR #if HAVE_FUNC_ATTRIBUTE_CONSTRUCTOR
__attribute__((constructor)) __attribute__((constructor))
#endif #endif
void log_set_defaults(void) void pinelog_set_defaults(void)
{ {
output_stream = PINELOG_DEFAULT_STREAM; output_stream = PINELOG_DEFAULT_STREAM;
log_level = PINELOG_DEFAULT_LEVEL; log_level = PINELOG_DEFAULT_LEVEL;
} }
int log_set_output_stream(FILE *stream) int pinelog_set_output_stream(FILE *stream)
{ {
if (stream == NULL) { if (stream == NULL) {
return EINVAL; return EINVAL;
@ -103,7 +103,7 @@ int log_set_output_stream(FILE *stream)
return 0; return 0;
} }
int log_set_output_file(const char *file) int pinelog_set_output_file(const char *file)
{ {
FILE *stream; FILE *stream;
if (file == NULL) { if (file == NULL) {
@ -116,15 +116,15 @@ int log_set_output_file(const char *file)
return errno; return errno;
} }
return log_set_output_stream(stream); return pinelog_set_output_stream(stream);
} }
int log_get_level(void) int pinelog_get_level(void)
{ {
return log_level; return log_level;
} }
int log_set_level(int level) int pinelog_set_level(int level)
{ {
if (level < LOG_LVL_NONE || level > LOG_LVL_TRACE) { if (level < LOG_LVL_NONE || level > LOG_LVL_TRACE) {
return EINVAL; return EINVAL;
@ -137,7 +137,7 @@ int log_set_level(int level)
/********************************************************************** /**********************************************************************
* Log the message to the output stream * Log the message to the output stream
*********************************************************************/ *********************************************************************/
void log_message(int level, const char *file, int line, const char *fmt, ...) void pinelog_log_message(int level, const char *file, int line, const char *fmt, ...)
{ {
va_list ap; va_list ap;
@ -191,4 +191,6 @@ void log_message(int level, const char *file, int line, const char *fmt, ...)
va_start(ap, fmt); va_start(ap, fmt);
vfprintf(output_stream, fmt, ap); vfprintf(output_stream, fmt, ap);
va_end(ap); va_end(ap);
// Append a trailing newline to flush the log message
fputs("\n", output_stream);
} }

65
pinelog.h
View File

@ -19,6 +19,7 @@
#define LOGGING_H #define LOGGING_H
#include <stdio.h> #include <stdio.h>
#include <stdlib.h>
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@ -32,31 +33,31 @@ extern "C" {
*/ */
enum { enum {
/** No messages will be logged */ /** No messages will be logged */
LOG_LVL_NONE = -1, PINELOG_LVL_NONE = -1,
/** Only fatal messages will be logged */ /** Only fatal messages will be logged */
LOG_LVL_FATAL, PINELOG_LVL_FATAL,
/** Error messages. This is the default log level */ /** Error messages. This is the default log level */
LOG_LVL_ERROR, PINELOG_LVL_ERROR,
/** Warning messages */ /** Warning messages */
LOG_LVL_WARNING, PINELOG_LVL_WARNING,
/** Informational messages */ /** Informational messages */
LOG_LVL_INFO, PINELOG_LVL_INFO,
/** Debug messages */ /** Debug messages */
LOG_LVL_DEBUG, PINELOG_LVL_DEBUG,
/** Trace messages */ /** Trace messages */
LOG_LVL_TRACE, PINELOG_LVL_TRACE,
}; };
/** /**
* @brief Set the default log level and output stream * @brief Set the default log level and output stream
*/ */
void log_set_defaults(void); void pinelog_set_defaults(void);
/** /**
* @brief Set the output stream. Must be a FILE pointer. * @brief Set the output stream. Must be a FILE pointer.
@ -65,7 +66,7 @@ void log_set_defaults(void);
* *
* @returns 0 on success, EINVAL if the pointer is not valid. * @returns 0 on success, EINVAL if the pointer is not valid.
*/ */
int log_set_output_stream(FILE *stream); int pinelog_set_output_stream(FILE *stream);
/** /**
* @brief Set the output file. * @brief Set the output file.
@ -75,7 +76,7 @@ int log_set_output_stream(FILE *stream);
* @returns 0 on success, EINVAL if the filename pointer is not valid, other * @returns 0 on success, EINVAL if the filename pointer is not valid, other
* error if the file could not be opened for writing. * error if the file could not be opened for writing.
*/ */
int log_set_output_file(const char *file); int pinelog_set_output_file(const char *file);
/** /**
* @brief Set the logging level * @brief Set the logging level
@ -84,63 +85,63 @@ int log_set_output_file(const char *file);
* *
* @returns 0 on success, EINVAL if the level is not valid * @returns 0 on success, EINVAL if the level is not valid
*/ */
int log_set_level(int level); int pinelog_set_level(int level);
/** /**
* @brief Get the logging level * @brief Get the logging level
* *
* @returns the configured logging level * @returns the configured logging level
*/ */
int log_get_level(void); int pinelog_get_level(void);
/** /**
* @brief Log a message to the logger * @brief Log a message to the logger
* *
* This is the actual function that logs the message. The application should * This is the actual function that logs the message. The application should
* never need to call this directly, but instead, should always use the * never need to call this directly, but instead, should always use the
* \code LOG_* macros. * \code PINELOG_* macros.
* *
* @param[in] level Level to log the message at * @param[in] level Level to log the message at
* @param[in] fmt Format string * @param[in] fmt Format string
* *
* @returns None * @returns None
*/ */
void log_message(int level, const char *file, int line, const char *fmt, ...); void pinelog_log_message(int level, const char *file, int line, const char *fmt, ...);
#define LOG_FATAL(fmt, ...) do { \ #define PINELOG_FATAL(fmt, ...) do { \
if (LOG_LVL_FATAL <= log_get_level()) { \ if (PINELOG_LVL_FATAL <= pinelog_get_level()) { \
log_message(LOG_LVL_FATAL, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \ pinelog_log_message(PINELOG_LVL_FATAL, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \
} \ } \
exit(1); \ exit(1); \
} while (0) } while (0)
#define LOG_ERROR(fmt, ...) do { \ #define PINELOG_ERROR(fmt, ...) do { \
if (LOG_LVL_ERROR <= log_get_level()) { \ if (PINELOG_LVL_ERROR <= pinelog_get_level()) { \
log_message(LOG_LVL_ERROR, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \ pinelog_log_message(PINELOG_LVL_ERROR, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \
} \ } \
} while (0) } while (0)
#define LOG_WARN(fmt, ...) do { \ #define PINELOG_WARN(fmt, ...) do { \
if (LOG_LVL_WARNING <= log_get_level()) { \ if (PINELOG_LVL_WARNING <= pinelog_get_level()) { \
log_message(LOG_LVL_WARNING, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \ pinelog_log_message(PINELOG_LVL_WARNING, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \
} \ } \
} while(0) } while(0)
#define LOG_INFO(fmt, ...) do { \ #define PINELOG_INFO(fmt, ...) do { \
if (LOG_LVL_INFO <= log_get_level()) { \ if (PINELOG_LVL_INFO <= pinelog_get_level()) { \
log_message(LOG_LVL_INFO, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \ pinelog_log_message(PINELOG_LVL_INFO, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \
} \ } \
} while(0) } while(0)
#define LOG_DEBUG(fmt, ...) do { \ #define PINELOG_DEBUG(fmt, ...) do { \
if (LOG_LVL_DEBUG <= log_get_level()) { \ if (PINELOG_LVL_DEBUG <= pinelog_get_level()) { \
log_message(LOG_LVL_DEBUG, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \ pinelog_log_message(PINELOG_LVL_DEBUG, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \
} \ } \
} while(0) } while(0)
#define LOG_TRACE(fmt, ...) do { \ #define PINELOG_TRACE(fmt, ...) do { \
if (LOG_LVL_TRACE <= log_get_level()) { \ if (PINELOG_LVL_TRACE <= pinelog_get_level()) { \
log_message(LOG_LVL_TRACE, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \ pinelog_log_message(PINELOG_LVL_TRACE, __FILE__, __LINE__, fmt, ##__VA_ARGS__); \
} \ } \
} while(0) } while(0)