log

Header: udo/log.h

Table of contents (click to go)

Macros

1. udo_log

2. udo_log_success

3. udo_log_info

4. udo_log_warning

5. udo_log_error

6. udo_log_print

7. udo_log_set_error

Enums

1. udo_log_level_type

2. udo_log_error_type

Unions

Structs

1. udo_log_error_struct

Functions

1. udo_log_set_level()

2. udo_log_set_write_fd()

3. udo_log_remove_colors()

4. udo_log_reset_colors()

5. udo_log_get_error()

6. udo_log_get_error_code()

7. udo_log_set_error_struct()

8. udo_log_time()

9. udo_log_notime()

API Documentation

udo_log_level_type

enum udo_log_level_type

Sets which messages of a given type to print and is used to

help determine which ANSI Escape Codes to utilize.

1. Log level options used by

   • udo_log_set_level()

   • udo_log

   • udo_log_error

   • udo_log_print

enumerator UDO_LOG_NONE

enumerator UDO_LOG_SUCCESS

enumerator UDO_LOG_DANGER

enumerator UDO_LOG_INFO

enumerator UDO_LOG_WARNING

enumerator UDO_LOG_RESET

enumerator UDO_LOG_ALL

UDO_LOG_NONE

Value set to 0x00000000

Term color

UDO_LOG_SUCCESS

Value set to 0x00000001

Green

UDO_LOG_DANGER

Value set to 0x00000002

Red

UDO_LOG_INFO

Value set to 0x00000004

Light purple

UDO_LOG_WARNING

Value set to 0x00000008

Yellow

UDO_LOG_RESET

Value set to 0x00000010

Term color

UDO_LOG_ALL

Value set to 0xFFFFFFFF

Term color

---

udo_log_set_level

void udo_log_set_level(enum udo_log_level_type level);

Sets which type of messages that are allowed

to be printed to an open file.

Default is set to UDO_LOG_NONE.

Param	Decription
level	32-bit integer representing the type of log to print to an open file. Each log type has a different color.

---

udo_log_set_write_fd

void udo_log_set_write_fd(const int fd);

Sets the internal global write file descriptor

to caller define file descriptor.

Default is set to STDOUT_FILENO.

Param	Decription
fd	File descriptor to an open file.

---

udo_log_remove_colors

void udo_log_remove_colors(void);

Sets the internal global ansi color

storage array to remove the ansi colors

and replace with “[LOG_TYPE] “.

---

udo_log_reset_colors

void udo_log_reset_colors(void);

Sets the internal global ansi color

storage array to it’s original values.

---

udo_log_error_type

enum udo_log_error_type

Enum with enumerators defining an error type.

1. Log error types used by

   • udo_log_get_error()

   • udo_log_get_error_code()

enumerator UDO_LOG_ERR_UNCOMMON

enumerator UDO_LOG_ERR_INCORRECT_DATA

UDO_LOG_ERR_UNCOMMON

Value set to 0x1000

Errors that can’t be given a common

error string are given this error code.

Caller would then need to set buffer themselves.

UDO_LOG_ERR_INCORRECT_DATA

Value set to 0x1001

Code for incorrect data passed in function arguments.

udo_log_error_struct

struct udo_log_error_struct

Structure used to store and acquire

error string and code for multiple

struct context’s.

uint32_t code;

char buffer[(1 << 9)];

code

enum udo_log_error_tye code or errno.

buffer

Buffer to store error string.

udo_log_get_error

const char *udo_log_get_error(const void *context);

Returns a string with the error defined given

caller provided a context with first members

of the context being a struct udo_log_error_struct.

Param	Decription
context	Pointer to an arbitrary context. Start of context must be a struct udo_log_error_struct.

Returns:

on success: Passed context error string

on failure: NULL

udo_log_get_error_code

uint32_t udo_log_get_error_code(const void *context);

Returns unsigned integer with the error code

given caller provided a context with first members

of the context being a struct udo_log_error_struct.

Param	Decription
context	Pointer to an arbitrary context. Start of context must be a struct udo_log_error_struct.

Returns:

on success: Passed context error code or errno

on failure: UINT32_MAX

udo_log_set_error_struct

void udo_log_set_error_struct(void *context, const uint32_t code, const char *fmt, ...);

Sets struct udo_log_error_struct members value.

Param	Decription
context	Pointer to an arbitrary context. Start of context must be a struct udo_log_error_struct.
code	Error code to set for a context May be errno or enum udo_log_error_type.
fmt	Format of the log passed to va_args.
…	Variable list arguments.

---

udo_log_time

void udo_log_time(enum udo_log_level_type type, const char *fmt, ...);

Provides applications/library way to write to an open file

with a time stamp and ansi color codes to colorize

different message.

Param	Decription
type	The type of color to use with log.
fmt	Format of the log passed to va_args.
…	Variable list arguments.

udo_log_notime

void udo_log_notime(enum udo_log_level_type type, const char *fmt, ...);

Provides applications/library way to write to an open file

without time stamp with ansi color codes to colorize

different message.

Param	Decription
type	The type of color to use with log.
fmt	Format of the log passed to va_args.
…	Variable list arguments.

---

udo_log

udo_log(log_type, fmt, ...)

Log format

timestamp [file:line] message

Default prints to stdout using ansi color codes to color text.

Caller may change the open file in which logs are printed to via

a call to udo_log_set_write_fd().

#define udo_log(log_type, fmt, ...) \
        udo_log_time(log_type, "[%s:%d] " fmt, __FILE_NAME__, __LINE__, ##__VA_ARGS__)

udo_log_success

udo_log_success(fmt, ...)

Log format

timestamp [file:line] message

Prints to stdout with ansi color codes the color GREEN.

Caller may change the open file in which logs are printed to via

a call to udo_log_set_write_fd().

#define udo_log_success(fmt, ...) \
        udo_log_time(UDO_LOG_SUCCESS, "[%s:%d] " fmt, __FILE_NAME__, __LINE__, ##__VA_ARGS__)

udo_log_info

udo_log_info(fmt, ...)

Log format

timestamp [file:line] message

Prints to stdout with ansi color codes the color BLUE.

Caller may change the open file in which logs are printed to via

a call to udo_log_set_write_fd().

#define udo_log_info(fmt, ...) \
        udo_log_time(UDO_LOG_INFO, "[%s:%d] " fmt, __FILE_NAME__, __LINE__, ##__VA_ARGS__)

udo_log_warning

udo_log_warning(fmt, ...)

Log format

timestamp [file:line] message

Prints to stdout with ansi color codes the color YELLOW.

Caller may change the open file in which logs are printed to via

a call to udo_log_set_write_fd().

#define udo_log_warning(fmt, ...) \
        udo_log_time(UDO_LOG_WARNING, "[%s:%d] " fmt, __FILE_NAME__, __LINE__, ##__VA_ARGS__)

udo_log_error

udo_log_error(fmt, ...)

Log format

timestamp [file:line] message

Prints to stderr with ansi color codes the color RED.

Caller may change the open file in which logs are printed to via

a call to udo_log_set_write_fd().

#define udo_log_error(fmt, ...) \
        udo_log_time(UDO_LOG_ERROR, "[%s:%d] " fmt, __FILE_NAME__, __LINE__, ##__VA_ARGS__)

udo_log_print

udo_log_print(log_type, fmt, ...)

Log format

NONE

Default prints to stdout using ansi color codes to color text.

Caller may change the open file in which logs are printed to via

a call to udo_log_set_write_fd().

#define udo_log_print(log_type, fmt, ...) \
        udo_log_notime(log_type, fmt, ##__VA_ARGS__)

udo_log_set_error

udo_log_set_error(ptr, code, fmt, ...)

Log format

[file:line] message

Sets struct udo_log_error_struct to later be called by

udo_log_get_error() and udo_log_get_error_code().

#define udo_log_set_error(ptr, code, fmt, ...) \
        udo_log_set_error_struct(ptr, code, "[%s:%d] " fmt, __FILE_NAME__, __LINE__, ##__VA_ARGS__)