youmetme/logging
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 2 Wiki Activity

修改api函数名，加入Default关键字，减除歧义

Browse Source
This commit is contained in:
你遇了我
2024-11-21 12:48:11 +08:00
parent 7afc3d3b41
commit 6ac7afd4c2
6 changed files with 90 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.en.md
View File

@@ -26,15 +26,15 @@ conan create .
#include "logging.h" #include "logging.h"
int main() { int main() {
Logger *logger = newLogger("testLogger", LOG_DEBUG); Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
destroyLogger(); destroyDefaultLogger();
return 0; return 0;
} }
``` ```
@@ -45,16 +45,16 @@ int main() {
#include "logging/logging-handler.h" #include "logging/logging-handler.h"
int main() { int main() {
Logger *logger = newLogger("testLogger", LOG_DEBUG); Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
logger->addHandler(loggingFileHandler("test1", 1024*1024)); logger->addHandler(loggingFileHandler("test1", 1024*1024));
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
destroyLogger(); destroyDefaultLogger();
return 0; return 0;
} }
``` ```
@@ -71,13 +71,13 @@ Redirects intercepted logs to a dedicated file processor
#include <stdio.h> #include <stdio.h>
int main() { int main() {
Logger *logger = newLogger("testLogger", LOG_DEBUG); Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
char *test1[] = {"123", "tt"}; char *test1[] = {"123", "tt"};
@@ -93,13 +93,13 @@ int main() {
printf("Interceptor added\n"); printf("Interceptor added\n");
printf("\n"); printf("\n");
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
destroyLogger(); destroyDefaultLogger();
return 0; return 0;
} }
``` ```

52
README.md
View File

@@ -29,15 +29,15 @@ conan create .
#include "logging.h" #include "logging.h"
int main() { int main() {
Logger *logger = newLogger("testLogger", LOG_DEBUG); Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
destroyLogger(); destroyDefaultLogger();
return 0; return 0;
} }
``` ```
@@ -48,16 +48,16 @@ int main() {
#include "logging/logging-handler.h" #include "logging/logging-handler.h"
int main() { int main() {
Logger *logger = newLogger("testLogger", LOG_DEBUG); Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
logger->addHandler(loggingFileHandler("test1", 1024*1024)); logger->addHandler(loggingFileHandler("test1", 1024*1024));
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
destroyLogger(); destroyDefaultLogger();
return 0; return 0;
} }
``` ```
@@ -75,13 +75,13 @@ int main() {
#include <stdio.h> #include <stdio.h>
int main() { int main() {
Logger *logger = newLogger("testLogger", LOG_DEBUG); Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
char *test1[] = {"123", "tt"}; char *test1[] = {"123", "tt"};
@@ -97,13 +97,13 @@ int main() {
printf("Interceptor added\n"); printf("Interceptor added\n");
printf("\n"); printf("\n");
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
destroyLogger(); destroyDefaultLogger();
return 0; return 0;
} }
``` ```

27
include/logging.h
View File

@@ -17,38 +17,35 @@ typedef struct Logger {
log_Handler *handler; log_Handler *handler;
log_Interceptor *interceptor; log_Interceptor *interceptor;
const char *name; const char *name;
void (*fatal)(const char *format, ...);
void (*error)(const char *format, ...);
void (*warning)(const char *format, ...);
void (*info)(const char *format, ...);
void (*debug)(const char *format, ...);
bool (*addHandler)(log_Handler *handler); bool (*addHandler)(log_Handler *handler);
bool (*addInterceptor)(log_Interceptor *Interceptor); bool (*addInterceptor)(log_Interceptor *Interceptor);
} Logger; } Logger;
void log_fatal(const char *format, ...);
void log_error(const char *format, ...);
void log_warning(const char *format, ...);
void log_info(const char *format, ...);
void log_debug(const char *format, ...);
/** /**
* @brief 创建日志对象,日志对象为单例模式，后续可通过getDefaultLogger方法获取， * @brief
创建默认日志对象,日志对象为单例模式，后续可通过getDefaultLogger方法获取，
重复调用该方法不会创建新的日志对象，只会返回默认日志对象，并且会修改默认日志对象的名称和等级 重复调用该方法不会创建新的日志对象，只会返回默认日志对象，并且会修改默认日志对象的名称和等级
* @param name 日志名称 * @param name 日志名称
* @param level 日志等级 * @param level 日志等级
* @return Logger* 日志对象指针 * @return Logger* 日志对象指针
*/ */
Logger *newLogger(const char *name, log_level level); Logger *newDefaultLogger(const char *name, log_level level);
/**
* @brief 设置日志等级
* @param logger 日志对象
* @param level 日志等级
*/
log_status setLevel(Logger *logger, log_level level);
/** /**
* @brief 获取默认日志对象 * @brief 获取默认日志对象
*/ */
Logger *getDefaultLogger(void); Logger *getDefaultLogger(void);
/** /**
* @brief 销毁日志对象,该方法会销毁默认日志对象 * @brief 销毁日志对象,该方法会销毁默认日志对象
*/ */
log_status destroyLogger(void); log_status destroyDefaultLogger(void);
#ifdef __cplusplus #ifdef __cplusplus
} }

20
src/logging.c
View File

@@ -101,7 +101,7 @@ _builtin_log(char *level, const char *color, const char *message, ...) {
handler->output(handler, logStr); handler->output(handler, logStr);
} }
static void fatal(const char *message, ...) { void log_fatal(const char *message, ...) {
if (G_LOGGER->level >= LOG_ERROR) { if (G_LOGGER->level >= LOG_ERROR) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
va_list args; va_list args;
@@ -112,7 +112,7 @@ static void fatal(const char *message, ...) {
} }
} }
static void error(const char *message, ...) { void log_error(const char *message, ...) {
if (G_LOGGER->level >= LOG_ERROR) { if (G_LOGGER->level >= LOG_ERROR) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
va_list args; va_list args;
@@ -123,7 +123,7 @@ static void error(const char *message, ...) {
} }
} }
static void warning(const char *message, ...) { void log_warning(const char *message, ...) {
if (G_LOGGER->level >= LOG_WARNING) { if (G_LOGGER->level >= LOG_WARNING) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
va_list args; va_list args;
@@ -134,7 +134,7 @@ static void warning(const char *message, ...) {
} }
} }
static void info(const char *message, ...) { void log_info(const char *message, ...) {
if (G_LOGGER->level >= LOG_INFO) { if (G_LOGGER->level >= LOG_INFO) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
va_list args; va_list args;
@@ -145,7 +145,7 @@ static void info(const char *message, ...) {
} }
} }
static void debug(const char *message, ...) { void log_debug(const char *message, ...) {
if (G_LOGGER->level >= LOG_DEBUG) { if (G_LOGGER->level >= LOG_DEBUG) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
va_list args; va_list args;
@@ -156,7 +156,7 @@ static void debug(const char *message, ...) {
} }
} }
Logger *newLogger(const char *name, log_level level) { Logger *newDefaultLogger(const char *name, log_level level) {
if (G_LOGGER != NULL) { if (G_LOGGER != NULL) {
G_LOGGER->name = name; G_LOGGER->name = name;
G_LOGGER->level = level; G_LOGGER->level = level;
@@ -165,12 +165,6 @@ Logger *newLogger(const char *name, log_level level) {
Logger *logger = (Logger *)malloc(sizeof(Logger)); Logger *logger = (Logger *)malloc(sizeof(Logger));
logger->fatal = fatal;
logger->error = error;
logger->warning = warning;
logger->info = info;
logger->debug = debug;
logger->addHandler = addHandler; logger->addHandler = addHandler;
logger->addInterceptor = addInterceptor; logger->addInterceptor = addInterceptor;
@@ -186,7 +180,7 @@ Logger *newLogger(const char *name, log_level level) {
/** /**
* @brief 销毁日志对象 * @brief 销毁日志对象
*/ */
log_status destroyLogger(void) { log_status destroyDefaultLogger(void) {
if (G_LOGGER != NULL) { if (G_LOGGER != NULL) {
if (G_LOGGER->handler != NULL) { if (G_LOGGER->handler != NULL) {
G_LOGGER->handler->_free(G_LOGGER->handler); G_LOGGER->handler->_free(G_LOGGER->handler);

24
tests/test_interceptor.c
View File

@@ -2,13 +2,13 @@
#include <stdio.h> #include <stdio.h>
int main() { int main() {
Logger *logger = newLogger("testLogger", LOG_DEBUG); Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
char *test1[] = {"123", "tt"}; char *test1[] = {"123", "tt"};
@@ -24,12 +24,12 @@ int main() {
printf("Interceptor added\n"); printf("Interceptor added\n");
printf("\n"); printf("\n");
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
destroyLogger(); destroyDefaultLogger();
return 0; return 0;
} }

14
tests/test_simple.c
View File

@@ -1,14 +1,14 @@
#include "logging.h" #include "logging.h"
int main() { int main() {
Logger *logger = newLogger("testLogger", LOG_DEBUG); Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
logger->info("This is an info message"); log_info("This is an info message");
logger->error("This is an error message%s", "123"); log_error("This is an error message%s", "123");
logger->fatal("This is an fatal message"); log_fatal("This is an fatal message");
logger->debug("This is a debug message"); log_debug("This is a debug message");
logger->warning("This is a warning message%s", "123"); log_warning("This is a warning message%s", "123");
destroyLogger(); destroyDefaultLogger();
return 0; return 0;
} }