Pretty Messages

About

A small and customizable header file that allows you to format the messages your program prints out. I developed this header for personal use, so not all code may be "clean".

Example

#include <prettymsgs.h>

int main(void)
{
    pm_info("This is an %s message.\n", "info");
    pm_debug("This is a %s message.\n", "debug");

    // pm_error and pm_assert will terminate the program.
    pm_error("This is an %s message.\n", "error");
    pm_assert(1 == 2);
}

Usage

Primary macros

These are the primary macros to output colored messages.

Macro name	Description
`pm_error(msg, ...)`	Output a message prefixed by `PM_ERROR_MSG` and terminate the program.
`pm_warn(msg, ...)`	Output a message prefixed by `PM_WARN_MSG`.
`pm_debug(msg, ...)`	Output a message prefixed by `PM_DEBUG_MSG`.
`pm_info(msg, ...)`	Output a message prefixed by `PM_INFO_MSG`.
`pm_assert(expression)`	Create an assertion. On failure, output a message prefixed by `PM_ASSERT_MSG` and terminate the program.

Customizations

If you choose to change the defaults, these macros must be defined before you include prettymsgs.h.

Macro name	Description
`PM_IMPLEMENTATION`	Define this to use the macros listed below.

Customize standard library functions

Macro name	Description
`PM_FPRINTF_FUNCTION`	To use your own `fprintf` function, set this macro to your function. Default will include `stdio.h`.
`PM_STDERR_FILE_DESC`	To use your own `stderr` file descriptor (of type `FILE *`), set this macro to your descriptor. Default will be `stderr`.
`PM_EXIT_FUNCTION`	To use your own `exit` function, set this macro to your function. Default will include `stdlib.h`.
`PM_EXIT_FAILURE`	To use your own `EXIT_FAILURE` exit code, set this macro to your exit code. Default will be `EXIT_FAILURE`.

Color escape sequences

Macro name	Description
`PM_RESET_COLOR`	To use your own reset ANSI escape sequence, set this macro to your escape sequence. Default will be `\033[39m\033[49m`.
`PM_ERROR_COLOR`	To use your own reset ANSI escape sequence, set this macro to your escape sequence. Default will be `\033[38;5;124m`.
`PM_WARN_COLOR`	To use your own reset ANSI escape sequence, set this macro to your escape sequence. Default will be `\033[38;5;214m`.
`PM_DEBUG_COLOR`	To use your own reset ANSI escape sequence, set this macro to your escape sequence. Default will be `\033[38;5;27m`.
`PM_INFO_COLOR`	To use your own reset ANSI escape sequence, set this macro to your escape sequence. Default will be `\033[38;5;66m`.

Message prefixes

Macro name	Description
`PM_ERROR_MSG`	To use a custom error message, set this macro to your error message.
`PM_WARN_MSG`	To use a custom warn message, set this macro to your warn message.
`PM_DEBUG_MSG`	To use a custom debug message, set this macro to your debug message.
`PM_INFO_MSG`	To use a custom info message, set this macro to your info message.
`PM_ASSERT_MSG`	To use a custom assert message, set this macro to your assert message.

Disables

Macro name	Description
`PM_DISABLE_ALL_MSGS`	Define this to disable all messages. `pm_error` and `pm_assert` will still be able to terminate the program.
`PM_DISABLE_ERROR_MSG`	Define this to disable "error" messages. Error messages will still terminate the program.
`PM_DISABLE_WARN_MSG`	Define this to disable "warn" messages.
`PM_DISABLE_DEBUG_MSG`	Define this to disable "debug" messages.
`PM_DISABLE_INFO_MSG`	Define this to disable "info" messages.
`PM_DISABLE_ASSERT_MSG`	Define this to disable "assert" messages. Failed assertions will still terminate the program.

Miscellaneous

These macros are used internally by PrettyMessages, but you can still use them if you want:

Macro name
`pm_debug_unlikely(expression)`
`pm_debug_likely(expression)`
`PM_FUNCTION_NAME`

TSOA2/PrettyMessages