clog's Introduction

clog

Very simplistic logging for C.

Description

Logging macros that log to stderr. It takes sprintf formatted arguments. Example:

CLOG_INFO("Hello, %s", "world");

CLOG_VERBOSE(). For logging that happens very frequently.
CLOG_DEBUG(). Internal debugging information. Rarely interesting for the user.
CLOG_INFO(). Information that can be useful for the user.
CLOG_WARN(). Something that is not supposed to happen, but we can continue execution safely.
CLOG_SOFT_ERROR(). It is clearly an an error, but can be handled with returning an error code. Does not stop execution in Debug.
CLOG_NOTICE(). Something is not optimal but is being handled. Usually used for serialization or network. e.g. "latency is high", "packet received out of order".
CLOG_ERROR(). An illegal state or operation, we should not handle it in debug and stops execution. In other build types than Debug, execution continues.
CLOG_OUTPUT(). Outputs information no matter the log level. Will probably be deprecated.
CLOG_ASSERT(expression, ...). Checks that the expression is true, otherwise it issues a CLOG_ERROR with the format string.

Usage

You need to provide a global clog_config g_clog; for it to link.

And in your main(), set a function to the log field that will handle the actual logging. Normally you use the provided clog_console.

#include <clog/clog.h>
#include <clog/console.h> // optional, if you want to use the provided `clog_console`.

clog_config g_clog;

int main(int argc, const char* argv[])
{
    g_clog.log = clog_console;

    return 0;
}

Recommend Projects