file.h File Reference

#include <derive-c/core/prelude.h>
#include <derive-c/utils/log/trait.h>
#include <derive-c/utils/timestamp.h>
#include <stdarg.h>
#include <stdio.h>

Go to the source code of this file.

Data Structures
struct	dc_log_file_global_config
struct	_dc_log_file

Macros
#define	DC_LOG_ANSI_RESET   "\033[0m"
#define	DC_LOG_ANSI_PURPLE   "\033[35m"
#define	DC_LOG_ANSI_BLUE   "\033[34m"
#define	DC_LOG_ANSI_GREEN   "\033[32m"
#define	DC_LOG_ANSI_ORANGE   "\033[33m"
#define	DC_LOG_ANSI_RED   "\033[31m"
#define	DC_LOGGER   dc_log_file

Typedefs
typedef struct _dc_log_file	dc_log_file

Functions
static DC_INTERNAL char const *	dc_log_level_ansi_colour (dc_log_level level)
static DC_PUBLIC bool	dc_log_file_should_log (dc_log_file const *self, dc_log_level level)
static DC_PUBLIC dc_log_level	dc_log_file_get_filter (dc_log_file const *self)
static DC_INTERNAL void	dc_log_file_print_descriptor (dc_log_file const *self, FILE *stream)
static DC_PUBLIC void	dc_log_file_log (dc_log_file *self, dc_log_location location, dc_log_level level, const char *const message,...)
static DC_PUBLIC void	dc_log_file_set_filter (dc_log_file *self, dc_log_level level)
static DC_PUBLIC dc_log_file	dc_log_file_new_global (dc_log_file_global_config config, dc_log_id id)
static DC_PUBLIC dc_log_file	dc_log_file_from_parent (dc_log_file *parent, dc_log_id id)
static DC_PUBLIC void	dc_log_file_delete (dc_log_file *self)
static DC_PUBLIC void	dc_log_file_debug (dc_log_file const *self, dc_debug_fmt fmt, FILE *stream)
	DC_TRAIT_LOGGER (dc_log_file)

Macro Definition Documentation

DC_LOG_ANSI_BLUE

#define DC_LOG_ANSI_BLUE   "\033[34m"

Definition at line 24 of file file.h.

DC_LOG_ANSI_GREEN

#define DC_LOG_ANSI_GREEN   "\033[32m"

Definition at line 25 of file file.h.

DC_LOG_ANSI_ORANGE

#define DC_LOG_ANSI_ORANGE   "\033[33m"

Definition at line 26 of file file.h.

DC_LOG_ANSI_PURPLE

#define DC_LOG_ANSI_PURPLE   "\033[35m"

Definition at line 23 of file file.h.

DC_LOG_ANSI_RED

#define DC_LOG_ANSI_RED   "\033[31m"

Definition at line 27 of file file.h.

DC_LOG_ANSI_RESET

#define DC_LOG_ANSI_RESET   "\033[0m"

Definition at line 22 of file file.h.

DC_LOGGER

#define DC_LOGGER   dc_log_file

Examples

complex/employees.c, complex/prime_sieve.c, container/arena.c, container/bitset.c, container/map.c, container/queue.c, container/set.c, container/vector.c, utils/log.c, utils/option.c, utils/result.c, and utils/string_builder.c.

Definition at line 168 of file file.h.

Typedef Documentation

dc_log_file

typedef struct _dc_log_file dc_log_file

Examples

utils/log.c.

Function Documentation

dc_log_file_debug()

DC_PUBLIC void dc_log_file_debug ( dc_log_file const * self, dc_debug_fmt fmt, FILE * stream )

static

Examples

utils/log.c.

Definition at line 144 of file file.h.

                                                                                                 {
    fprintf(stream, "dc_log_file@%p {\n", (void const*)self);
    fmt = dc_debug_fmt_scope_begin(fmt);
 
    dc_debug_fmt_print(fmt, stream, "parent: ");
    if (self->parent != NULL) {
        dc_log_file_debug(self->parent, fmt, stream);
    } else {
        fprintf(stream, "NULL");
    }
    fprintf(stream, ",\n");
 
    dc_debug_fmt_print(fmt, stream, "stream: %p,\n", (void const*)self->stream);
    dc_debug_fmt_print(fmt, stream, "id: \"%s\",\n", self->id.name);
    dc_debug_fmt_print(fmt, stream, "filter: %s,\n", dc_log_level_to_string(self->filter));
    dc_debug_fmt_print(fmt, stream, "ansi_colours: %s,\n", self->ansi_colours ? "true" : "false");
 
    fmt = dc_debug_fmt_scope_end(fmt);
    dc_debug_fmt_print(fmt, stream, "}");
}

dc_log_file_delete()

DC_PUBLIC void dc_log_file_delete ( dc_log_file * self )

static

Definition at line 140 of file file.h.

                                                            {
    dc_log_file_log(self, DC_LOCATION, DC_INFO, "Logger deleted");
}

dc_log_file_from_parent()

DC_PUBLIC dc_log_file dc_log_file_from_parent ( dc_log_file * parent, dc_log_id id )

static

Definition at line 128 of file file.h.

                                                                                        {
    dc_log_file self = {
        .parent = parent,
        .stream = parent->stream,
        .id = id,
        .filter = parent->filter,
        .ansi_colours = parent->ansi_colours,
    };
    dc_log_file_log(&self, DC_LOCATION, DC_INFO, "Logger created");
    return self;
}

dc_log_file_get_filter()

DC_PUBLIC dc_log_level dc_log_file_get_filter ( dc_log_file const * self )

static

Definition at line 55 of file file.h.

                                                                              {
    return self->filter;
}

dc_log_file_log()

DC_PUBLIC void dc_log_file_log ( dc_log_file * self, dc_log_location location, dc_log_level level, const char *const message, ... )

static

Definition at line 74 of file file.h.

                                                                                          {
    if (!dc_log_file_should_log(self, level)) {
        return;
    }
 
    if (self->ansi_colours) {
        fprintf(self->stream, "%s", dc_log_level_ansi_colour(level));
    }
 
    dc_datetime dt = dc_datetime_now_utc();
    fprintf(self->stream, "[");
    dc_datetime_format(&dt, self->stream);
    fprintf(self->stream, "] [%s] [", dc_log_level_to_string(level));
    dc_log_file_print_descriptor(self, self->stream);
    fprintf(self->stream, "] ");
 
    va_list args;
    va_start(args, message);
    vfprintf(self->stream, message, args);
    va_end(args);
 
    if (level <= DC_DEBUG) {
        fprintf(self->stream, " [%s:%d]", location.file, location.line);
    }
 
    if (self->ansi_colours) {
        fprintf(self->stream, "%s", DC_LOG_ANSI_RESET);
    }
 
    fprintf(self->stream, "\n");
    fflush(self->stream);
}

dc_log_file_new_global()

DC_PUBLIC dc_log_file dc_log_file_new_global ( dc_log_file_global_config config, dc_log_id id )

static

Definition at line 115 of file file.h.

                                                                  {
    dc_log_file self = {
        .parent = NULL,
        .stream = config.stream,
        .id = id,
        .filter = DC_INFO,
        .ansi_colours = config.ansi_colours,
    };
    dc_log_file_log(&self, DC_LOCATION, DC_INFO, "Logger created");
    return self;
}

dc_log_file_print_descriptor()

DC_INTERNAL void dc_log_file_print_descriptor ( dc_log_file const * self, FILE * stream )

static

Definition at line 59 of file file.h.

                                                                                            {
    if (self->parent != NULL) {
        dc_log_file_print_descriptor(self->parent, stream);
        fprintf(stream, "/");
    }
    fprintf(stream, "%s", self->id.name);
}

dc_log_file_set_filter()

DC_PUBLIC void dc_log_file_set_filter ( dc_log_file * self, dc_log_level level )

static

Examples

utils/log.c.

Definition at line 108 of file file.h.

                                                                                    {
    dc_log_level old_level = self->filter;
    self->filter = level;
    dc_log_file_log(self, DC_LOCATION, DC_INFO, "Log level changed from %s to %s",
                    dc_log_level_to_string(old_level), dc_log_level_to_string(level));
}

dc_log_file_should_log()

DC_PUBLIC bool dc_log_file_should_log ( dc_log_file const * self, dc_log_level level )

static

Definition at line 45 of file file.h.

                                                                                          {
    if (level < self->filter) {
        return false;
    }
    if (self->parent != NULL) {
        return dc_log_file_should_log(self->parent, level);
    }
    return true;
}

dc_log_level_ansi_colour()

DC_INTERNAL char const * dc_log_level_ansi_colour ( dc_log_level level )

static

Definition at line 29 of file file.h.

                                                                            {
    switch (level) {
    case DC_TRACE:
        return DC_LOG_ANSI_PURPLE;
    case DC_DEBUG:
        return DC_LOG_ANSI_BLUE;
    case DC_INFO:
        return DC_LOG_ANSI_GREEN;
    case DC_WARN:
        return DC_LOG_ANSI_ORANGE;
    case DC_ERROR:
        return DC_LOG_ANSI_RED;
    }
    return DC_LOG_ANSI_RESET;
}

DC_TRAIT_LOGGER()

DC_TRAIT_LOGGER

(

dc_log_file

)