From 5819f17d6ab8d7c8e3276a1a0940f98b493643b1 Mon Sep 17 00:00:00 2001 From: Daniel Walker Date: Tue, 14 Mar 2023 23:18:57 -0400 Subject: [PATCH 1/6] reworked loggers to use handlers; vasqLoggerCreate now returns the logger; removed the VASQ_RET_ values; now using scrutiny for testing --- .github/workflows/format.yml | 7 +- .github/workflows/make_and_test.yml | 38 -- .github/workflows/test.yml | 17 + Makefile | 6 +- include/vasq/definitions.h | 36 +- include/vasq/logger.h | 317 ++++--------- include/vasq/safe_snprintf.h | 14 +- source/definitions.c | 15 - source/logger.c | 306 +++++-------- tests/.gitignore | 5 +- tests/make.mk | 37 +- tests/requirements.txt | 1 - tests/test_assert.c | 62 --- tests/test_assert.py | 9 - tests/test_format.c | 40 -- tests/test_hexdump.c | 30 -- tests/test_logger.c | 663 ++++++++++++++++++++++++++++ tests/test_logging.py | 156 ------- tests/test_safe_snprintf.c | 348 +++++++++++++++ tests/tests.c | 87 ++++ 20 files changed, 1344 insertions(+), 850 deletions(-) delete mode 100644 .github/workflows/make_and_test.yml create mode 100644 .github/workflows/test.yml delete mode 100644 source/definitions.c delete mode 100644 tests/requirements.txt delete mode 100644 tests/test_assert.c delete mode 100644 tests/test_assert.py delete mode 100644 tests/test_format.c delete mode 100644 tests/test_hexdump.c create mode 100644 tests/test_logger.c delete mode 100644 tests/test_logging.py create mode 100644 tests/test_safe_snprintf.c create mode 100644 tests/tests.c diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index 468d7dd..cef946a 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -1,4 +1,4 @@ -name: check-format +name: Check format on: push: @@ -16,8 +16,3 @@ jobs: - uses: jidicula/clang-format-action@v4.6.2 with: clang-format-version: '14' - - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - run: pip install black - - run: black --check -l 110 tests diff --git a/.github/workflows/make_and_test.yml b/.github/workflows/make_and_test.yml deleted file mode 100644 index 764802f..0000000 --- a/.github/workflows/make_and_test.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: make_and_test - -on: - push: - branches: - - "**" - - workflow_dispatch: - -jobs: - build: - runs-on: ubuntu-latest - container: - image: gcc:latest - steps: - - uses: actions/checkout@v3 - - run: make - - run: mkdir -p artifacts && cp libvanillasquad.a artifacts - - uses: actions/upload-artifact@master - with: - name: static-library - path: artifacts - - test: - needs: build - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: actions/download-artifact@master - with: - name: static-library - path: artifacts - - run: mv artifacts/libvanillasquad.a . - - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - run: pip install pytest - - run: make tests diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..43fcc90 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,17 @@ +name: Run tests + +on: + push: + branches: + - "**" + + workflow_dispatch: + +jobs: + test: + runs-on: ubuntu-latest + container: + image: nickeldan/scrutiny:0.4.0 + steps: + - uses: actions/checkout@v3 + - run: make tests diff --git a/Makefile b/Makefile index 1b7cd8d..0aa63c5 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,3 @@ -CC ?= gcc -debug ?= no - CFLAGS := -std=gnu99 -fdiagnostics-color -Wall -Wextra -Werror ifeq ($(debug),yes) CFLAGS += -O0 -g -DDEBUG @@ -23,13 +20,12 @@ include make.mk TEST_DIR := tests include $(TEST_DIR)/make.mk -.PHONY: all _all tests format install uninstall clean $(CLEAN_TARGETS) +.PHONY: all _all format tests install uninstall clean $(CLEAN_TARGETS) _all: $(VASQ_SHARED_LIBRARY) $(VASQ_STATIC_LIBRARY) format: find . -name '*.[hc]' -print0 | xargs -0 -n 1 clang-format -i - find tests -name '*.py' -print0 | xargs -0 -n 1 black -q -l 110 install: /usr/local/lib/$(notdir $(VASQ_SHARED_LIBRARY)) $(foreach file,$(VASQ_HEADER_FILES),/usr/local/include/vasq/$(notdir $(file))) diff --git a/include/vasq/definitions.h b/include/vasq/definitions.h index 7509705..bf8d3ac 100644 --- a/include/vasq/definitions.h +++ b/include/vasq/definitions.h @@ -9,7 +9,7 @@ /** * @brief Current version of the library. */ -#define VASQ_VERSION "6.0.8" +#define VASQ_VERSION "7.0.0" #ifndef NO_OP #define NO_OP ((void)0) @@ -24,31 +24,21 @@ #endif #ifndef ARRAY_LENGTH -#define ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0])) +#define ARRAY_LENGTH(arr) (sizeof(arr) / sizeof((arr)[0])) #endif -/** - * @brief Error values that some library functions can return. - */ -enum vasqRetValue { - VASQ_RET_OK = 0, - VASQ_RET_USAGE, - VASQ_RET_BAD_FORMAT, - VASQ_RET_OUT_OF_MEMORY, - VASQ_RET_DUP_FAIL, - VASQ_RET_FCNTL_FAIL, +#ifdef __GNUC__ - VASQ_RET_UNUSED, -}; +#define VASQ_NONNULL(...) __attribute__((nonnull(__VA_ARGS__))) +#define VASQ_FORMAT(pos) __attribute__((format(printf, pos, pos + 1))) +#define VASQ_MALLOC __attribute__((malloc)) -/** - * @brief Convert an error value (see enum vasqRetValue) into a string. - * - * @param errnum The error value. - * - * @return The string. - */ -const char * -vasqErrorString(int errnum) __attribute__((pure)); +#else + +#define VASQ_NONNULL(...) +#define VASQ_FORMAT(pos) +#define VASQ_MALLOC + +#endif #endif // VANILLA_SQUAD_DEFINITIONS_H diff --git a/include/vasq/logger.h b/include/vasq/logger.h index def4570..722541e 100644 --- a/include/vasq/logger.h +++ b/include/vasq/logger.h @@ -26,7 +26,7 @@ typedef enum vasqLogLevel { VASQ_LL_WARNING, VASQ_LL_INFO, VASQ_LL_DEBUG, -} vasqLogLevel_t; +} vasqLogLevel; #ifndef VASQ_NO_LOGGING @@ -55,6 +55,47 @@ typedef struct vasqLogger vasqLogger; %% : Literal percent sign */ +/** + * @brief Function type outputting log messages. + * + * @param user User-provided data. + * @param text The message to be printed. + * @param size The number of non-null characters in the message. + */ +typedef void +vasqHandlerFunc(void *user, const char *text, size_t size); + +/** + * @brief Function type for cleaning up a handler. + * + * @param user User-provided data. + */ +typedef void +vasqHandlerCleanup(void *user); + +/** + * @brief Handles the outputting of log messages. + */ +typedef struct vasqLoggerHandler { + vasqHandlerFunc *func; /// Called whenever log messages are generated. + vasqHandlerCleanup *cleanup; /// Called when the logger is freed. + void *user; /// User-provided data. +} vasqHandler; + +/** + * @brief Creates a handler from a file descriptor. + * + * @param fd The file descriptor to be used. The descriptor will be duplicated. + * @param flags Bitwise-or-combined flags. + * @param handler[out] The handler to be populated. + * + * @return 0 if successful. Otherwise, -1 is returned and errno is set. + * + * @note Currently, the only available flag is VASQ_LOGGER_FLAG_CLOEXEC. + */ +int +vasqFdHandlerCreate(int fd, unsigned int flags, vasqHandler *handler); + /** * @brief Function type for processing the %x logger format token. * @@ -65,38 +106,36 @@ typedef struct vasqLogger vasqLogger; * @param remaining A pointer to the remaining number of characters in the destination buffer as used in * vasqIncSnprintf (see safe_snprintf.h). */ -typedef void (*vasqLoggerDataProcessor)(void *user, size_t idx, vasqLogLevel_t level, char **dst, - size_t *remaining); +typedef void +vasqDataProcessor(void *user, size_t idx, vasqLogLevel level, char **dst, size_t *remaining); /** * @brief Options passed to vasqLoggerCreate. */ typedef struct vasqLoggerOptions { - vasqLoggerDataProcessor processor; /// The processor to be used for %x format tokens. - void *user; /// A pointer to user data to be passed to the processor. - unsigned int flags; /// Bitwise-or-combined flags. + vasqDataProcessor *processor; /// The processor to be used for %x format tokens. + void *user; /// User-provided data. + unsigned int flags; /// Bitwise-or-combined flags. } vasqLoggerOptions; -#define VASQ_LOGGER_FLAG_DUP \ - 0x00000001 /// Cause the provided file descriptor to be duplicated (and closed when the logger is - /// freed). -#define VASQ_LOGGER_FLAG_CLOEXEC 0x00000002 /// Set FD_CLOEXEC on the file descriptor. -#define VASQ_LOGGER_FLAG_HEX_DUMP_INFO 0x00000004 /// Emit hex dumps at the INFO level. +#define VASQ_LOGGER_FLAG_CLOEXEC 0x00000001 /// Set FD_CLOEXEC on a file descriptor. +#define VASQ_LOGGER_FLAG_HEX_DUMP_INFO 0x00000002 /// Emit hex dumps at the INFO level. /** * @brief Allocate and initialize a logger. * - * @param fd The descriptor of the file to where log messages will be written. - * @param level The maximum log level that this logger will handle. - * @param format The format string for the log messages. - * @param options A pointer to an options structure. If options is NULL, then default options are used. - * @param logger A pointer to the logger handle to be allocated. + * @param level The maximum log level that this logger will handle. + * @param format The format string for the log messages. + * @param handler A pointer to the handler to be used. + * @param options A pointer to an options structure. If options is NULL, then default options are used. * - * @return VASQ_RET_OK upon success and an error value otherwise. + * @return A pointer to the logger if successful. If not, then NULL is returned and errno is set. + * + * @note Currently, the only available flag for options is VASQ_LOGGER_FLAG_HEX_DUMP_INFO. */ -int -vasqLoggerCreate(int fd, vasqLogLevel_t level, const char *format, const vasqLoggerOptions *options, - vasqLogger **logger); +vasqLogger * +vasqLoggerCreate(vasqLogLevel level, const char *format, const vasqHandler *handler, + const vasqLoggerOptions *options) VASQ_MALLOC; /** * @brief Free a logger. @@ -108,27 +147,6 @@ vasqLoggerCreate(int fd, vasqLogLevel_t level, const char *format, const vasqLog void vasqLoggerFree(vasqLogger *logger); -/** - * @brief Return a logger's file descriptor. - * - * @param logger The logger handle. - * - * @return The logger's file descriptor if not NULL. Otherwise, -1. - */ -int -vasqLoggerFd(const vasqLogger *logger); - -/** - * @brief Set a new format string for a logger. - * - * @param logger The logger handle. - * @param format The new format string. - * - * @return true if the format string is valid and false otherwise. - */ -bool -vasqSetLoggerFormat(vasqLogger *logger, const char *format); - /** * @brief Return a logger's maximum log level. * @@ -136,7 +154,7 @@ vasqSetLoggerFormat(vasqLogger *logger, const char *format); * * @return The maximum log level if logger is not NULL and VASQ_LL_NONE otherwise. */ -vasqLogLevel_t +vasqLogLevel vasqLoggerLevel(const vasqLogger *logger); /** @@ -146,35 +164,7 @@ vasqLoggerLevel(const vasqLogger *logger); * @param level The new maximum log level. */ void -vasqSetLoggerLevel(vasqLogger *logger, vasqLogLevel_t level); - -/** - * @brief Set the processor for a logger. - * - * @param logger The logger handle. - * @param processor The processor to be used. - */ -void -vasqSetLoggerProcessor(vasqLogger *logger, vasqLoggerDataProcessor processor); - -/** - * @brief Return a logger's user data. - * - * @param logger The logger handle. - * - * @return The logger's user data. - */ -void * -vasqLoggerUserData(const vasqLogger *logger); - -/** - * @brief Set the user data for a logger. - * - * @param logger The logger handle. - * @param user_data The user data. - */ -void -vasqSetLoggerUserData(vasqLogger *logger, void *user); +vasqSetLoggerLevel(vasqLogger *logger, vasqLogLevel level); /** * @brief Emit a logging message. @@ -189,11 +179,8 @@ vasqSetLoggerUserData(vasqLogger *logger, void *user); * @param format A format string (corresponding to vasqSafeSnprintf's syntax) for the the message. */ void -vasqLogStatement(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, const char *format, ...) -#ifdef __GNUC__ - __attribute__((format(printf, 6, 7))) -#endif - ; +vasqLogStatement(const vasqLogger *logger, vasqLogLevel level, VASQ_CONTEXT_DECL, const char *format, ...) + VASQ_FORMAT(6); /** * @brief Emit a message at the ALWAYS level. @@ -267,8 +254,8 @@ vasqLogStatement(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DE * @brief Same as vasqLogStatement but takes a va_list instead of variable arguments. */ void -vasqVLogStatement(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, const char *format, - va_list args); +vasqVLogStatement(const vasqLogger *logger, vasqLogLevel level, VASQ_CONTEXT_DECL, const char *format, + va_list args) VASQ_NONNULL(6); /** * @brief Write directly to a logger's descriptor. @@ -277,17 +264,13 @@ vasqVLogStatement(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_D * @param format A format string (corresponding to vasqSafeSnprintf's syntax) for the the message. */ void -vasqRawLog(const vasqLogger *logger, const char *format, ...) -#ifdef __GNUC__ - __attribute__((format(printf, 2, 3))) -#endif - ; +vasqRawLog(const vasqLogger *logger, const char *format, ...) VASQ_FORMAT(2); /** * @brief Same as vasqRawLog but takes a va_list insead of variable arguments. */ void -vasqVRawLog(const vasqLogger *logger, const char *format, va_list args); +vasqVRawLog(const vasqLogger *logger, const char *format, va_list args) VASQ_NONNULL(2); /** * @brief Display a hex dump of a section of memory. The dump appears at the DEBUG level. @@ -301,158 +284,20 @@ vasqVRawLog(const vasqLogger *logger, const char *format, va_list args); * @param size The number of bytes to display. */ void -vasqHexDump(const vasqLogger *logger, VASQ_CONTEXT_DECL, const char *name, const void *data, size_t size); +vasqHexDump(const vasqLogger *logger, VASQ_CONTEXT_DECL, const char *name, const void *data, size_t size) + VASQ_NONNULL(5, 6); /** * @brief Wrap vasqHexDump by automatically supplying the file name, function name, and line number. */ #define VASQ_HEXDUMP(logger, name, data, size) vasqHexDump(logger, VASQ_CONTEXT_PARAMS, name, data, size) -/** - * @brief Wrap malloc. - * - * Emits a log message at the ERROR level if the allocation fails. - * - * @param logger The logger handle. - * @param file_name The name of the file where the message originated. - * @param function_name The name of the function where the message originated. - * @param line_no The line number where the message originated. - * @param size The number of bytes to allocate. - * - * @return The same return value as malloc. - */ -void * -vasqMalloc(const vasqLogger *logger, VASQ_CONTEXT_DECL, size_t size) -#ifdef __GNUC__ - __attribute__((deprecated)) -#endif - ; - -/** - * @brief Wrap vasqMalloc by automatically supplying the file name, function name, and line number. - */ -#define VASQ_MALLOC(logger, size) vasqMalloc(logger, VASQ_CONTEXT_PARAMS, size) - -/** - * @brief Wrap calloc. - * - * Emits a log message at the ERROR level if the allocation fails. - * - * @param logger The logger handle. - * @param file_name The name of the file where the message originated. - * @param function_name The name of the function where the message originated. - * @param line_no The line number where the message originated. - * @param nmemb The number of items to allocate. - * @param size The size of each allocated item. - * - * @return The same return value as calloc. - */ -void * -vasqCalloc(const vasqLogger *logger, VASQ_CONTEXT_DECL, size_t nmemb, size_t size) -#ifdef __GNUC__ - __attribute__((deprecated)) -#endif - ; - -/** - * @brief Wrap vasqCalloc by automatically supplying the file name, function name, and line number. - */ -#define VASQ_CALLOC(logger, nmemb, size) vasqCalloc(logger, VASQ_CONTEXT_PARAMS, nmemb, size) - -/** - * @brief Wrap realloc. - * - * Emits a log message at the ERROR level if the allocation fails. - * - * @param logger The logger handle. - * @param file_name The name of the file where the message originated. - * @param function_name The name of the function where the message originated. - * @param line_no The line number where the message originated. - * @param ptr A pointer to the original data. - * @param size The size of the new data. - * - * @return The same return value as realloc. - */ -void * -vasqRealloc(const vasqLogger *logger, VASQ_CONTEXT_DECL, void *ptr, size_t size) -#ifdef __GNUC__ - __attribute__((deprecated)) -#endif - ; - -/** - * @brief Wrap vasqRealloc by automatically supplying the file name, function name, and line number. - */ -#define VASQ_REALLOC(logger, ptr, size) vasqRealloc(logger, VASQ_CONTEXT_PARAMS, ptr, size) - -/** - * @brief Wrap fork. - * - * Emits a log message at the ERROR level if fork fails. Otherwise, the child process emits a log message - * at the VASQ_LL_PROCESS (see config.h) level. - * - * @param logger The logger handle. - * @param file_name The name of the file where the message originated. - * @param function_name The name of the function where the message originated. - * @param line_no The line number where the message originated. - * - * @return The same return value as fork. - */ -pid_t -vasqFork(const vasqLogger *logger, VASQ_CONTEXT_DECL) -#ifdef __GNUC__ - __attribute__((deprecated)) -#endif - ; - -/** - * @brief Wrap vasqFork by automatically supplying the file name, function name, and line number. - */ -#define VASQ_FORK(logger) vasqFork(logger, VASQ_DECL_PARAMS) - -/** - * @brief Wrap exit or _exit. - * - * Emits a log message at the VASQ_LL_PROCESS (see config.h) level. After that, vasqLoggerFree is called on - * the logger handle. - * - * @param logger The logger handle. - * @param file_name The name of the file where the message originated. - * @param function_name The name of the function where the message originated. - * @param line_no The line number where the message originated. - * @param value The value passed to exit/_exit. - * @param quick If true, _exit is called. Otherwise, exit is called. - */ -void -vasqExit(vasqLogger *logger, VASQ_CONTEXT_DECL, int value, bool quick) -#ifdef __GNUC__ - __attribute__((noreturn)) __attribute__((deprecated)) -#endif - ; - -/** - * @brief Wrap vasqExit by automatically supplying the file name, function name, and line number and setting - * quick to false. - */ -#define VASQ_EXIT(logger, value) vasqExit(logger, VASQ_CONTEXT_PARAMS, value, false) - -/** - * @brief Wrap vasqExit by automatically supplying the file name, function name, and line number and setting - * quick to true. - */ -#define VASQ_QUICK_EXIT(logger, value) vasqExit(logger, VASQ_CONTEXT_PARAMS, value, true) - #else // VASQ_NO_LOGGING -#define vasqLoggerCreate(...) VASQ_RET_OK -#define vasqLoggerFree(logger) NO_OP -#define vasqLoggerFd(logger) -1 -#define vasqSetLoggerFormat(logger, format) true -#define vasqLoggerLevel(logger) VASQ_LL_NONE -#define vasqsetLoggerLevel(logger, level) NO_OP -#define vasqSetLoggerProcessor(logger, processor) NO_OP -#define vasqLoggerUserData(logger) NULL -#define vasqSetLogerUserData(logger, user) NO_OP +#define vasqLoggerCreate(...) VASQ_RET_OK +#define vasqLoggerFree(logger) NO_OP +#define vasqLoggerLevel(logger) VASQ_LL_NONE +#define vasqSetLoggerLevel(logger, level) NO_OP #define vasqLogStatement(...) NO_OP #define vasqVLogStatement(...) NO_OP @@ -470,18 +315,6 @@ vasqExit(vasqLogger *logger, VASQ_CONTEXT_DECL, int value, bool quick) #define vasqHexDump(...) NO_OP #define VASQ_HEXDUMP(...) NO_OP -#define vasqMalloc(logger, file, func, line, size) malloc(size) -#define VASQ_MALLOC(logger, size) malloc(size) -#define vasqCalloc(logger, file, func, line, nmemb, size) calloc(nmemb, size) -#define VASQ_CALLOC(logger, nmemb, size) calloc(nmemb, size) -#define vasqRealloc(logger, file, func, line, ptr, size) realloc(ptr, size) -#define VASQ_REALLOC(logger, ptr, size) realloc(ptr, size) -#define vasqFork(...) fork() -#define VASQ_FORK() fork() -#define vasqExit(logger, file, func, line, value, quick) (((quick) ? _exit : exit)(value)) -#define VASQ_EXIT(logger, value) exit(value) -#define VASQ_QUICK_EXIT(logger, value) _exit(value) - #endif // VASQ_NO_LOGGING #ifdef DEBUG @@ -505,6 +338,10 @@ extern bool _vasq_abort_caught; #endif // VASQ_TEST_ABORT +/** + * @brief Verifies than an expression is true and, if not, logs a critical message and calls abort(). + * Resolves to a no op if the DEBUG preprocessor variable is not defined. + */ #define VASQ_ASSERT(logger, expr) \ do { \ _VASQ_CLEAR_ABORT(); \ diff --git a/include/vasq/safe_snprintf.h b/include/vasq/safe_snprintf.h index ac8f750..1858242 100644 --- a/include/vasq/safe_snprintf.h +++ b/include/vasq/safe_snprintf.h @@ -25,11 +25,7 @@ * buffer or format is NULL or if size is 0, then -1 is returned. */ ssize_t -vasqSafeSnprintf(char *buffer, size_t size, const char *format, ...) -#ifdef __GNUC__ - __attribute__((format(printf, 3, 4))) -#endif - ; +vasqSafeSnprintf(char *buffer, size_t size, const char *format, ...) VASQ_FORMAT(3); /** * @brief Same as vasqSafeSnprintf but takes a va_list instead of variable arguments. @@ -53,16 +49,12 @@ vasqSafeVsnprintf(char *buffer, size_t size, const char *format, va_list args); * @return Same as for vasqSafeSnprintf. */ ssize_t -vasqIncSnprintf(char **output, size_t *capacity, const char *format, ...) -#ifdef __GNUC__ - __attribute__((format(printf, 3, 4))) -#endif - ; +vasqIncSnprintf(char **output, size_t *capacity, const char *format, ...) VASQ_FORMAT(3); /** * @brief Same as vasqIncSnprintf but takes a va_list instead of variable arguments. */ ssize_t -vasqIncVsnprintf(char **output, size_t *capacity, const char *format, va_list args); +vasqIncVsnprintf(char **output, size_t *capacity, const char *format, va_list args) VASQ_NONNULL(3); #endif // VANILLA_SQUAD_SAFE_SNPRINTF_H diff --git a/source/definitions.c b/source/definitions.c deleted file mode 100644 index 1df11aa..0000000 --- a/source/definitions.c +++ /dev/null @@ -1,15 +0,0 @@ -#include "vasq/definitions.h" - -const char * -vasqErrorString(int errnum) -{ - switch (errnum) { - case VASQ_RET_OK: return "No error"; - case VASQ_RET_USAGE: return "A function was called with invalid arguments"; break; - case VASQ_RET_BAD_FORMAT: return "Invalid format string"; - case VASQ_RET_OUT_OF_MEMORY: return "Ran out of memory"; - case VASQ_RET_DUP_FAIL: return "dup failed"; - case VASQ_RET_FCNTL_FAIL: return "fcntl failed"; - default: return "Invalid error value"; - } -} \ No newline at end of file diff --git a/source/logger.c b/source/logger.c index 4b882bd..06eb279 100644 --- a/source/logger.c +++ b/source/logger.c @@ -1,5 +1,6 @@ #ifndef VASQ_NO_LOGGING +#include #include #include #include @@ -16,12 +17,11 @@ #endif struct vasqLogger { + vasqHandler handler; const char *format; - vasqLoggerDataProcessor processor; + vasqDataProcessor *processor; void *user; - int fd; - vasqLogLevel_t level; - unsigned int duped : 1; + vasqLogLevel level; unsigned int hex_dump_info : 1; }; @@ -74,7 +74,7 @@ safeIsPrint(char c) } static const char * -logLevelName(vasqLogLevel_t level) +logLevelName(vasqLogLevel level) { switch (level) { case VASQ_LL_ALWAYS: return "ALWAYS"; @@ -88,7 +88,7 @@ logLevelName(vasqLogLevel_t level) } static unsigned int -logLevelNamePadding(vasqLogLevel_t level) +logLevelNamePadding(vasqLogLevel level) { switch (level) { case VASQ_LL_ALWAYS: return 2; @@ -103,8 +103,8 @@ logLevelNamePadding(vasqLogLevel_t level) } static void -vlogToBuffer(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, char **dst, - size_t *remaining, const char *format, va_list args) +vlogToBuffer(const vasqLogger *logger, vasqLogLevel level, VASQ_CONTEXT_DECL, char **dst, size_t *remaining, + const char *format, va_list args) { size_t position = 0; time_t now; @@ -121,13 +121,14 @@ vlogToBuffer(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, unsigned int padding_length, len; size_t idx; char time_string[30], padding[LOG_LEVEL_NAME_MAX_PADDING + 1]; + struct timespec epoch; case 'M': vasqIncVsnprintf(dst, remaining, format, args); break; case 'p': vasqIncSnprintf(dst, remaining, "%li", (long)getpid()); break; #ifdef __linux__ - case 'T': vasqIncSnprintf(dst, remaining, "%li", (long)syscall(__NR_gettid)); break; + case 'T': vasqIncSnprintf(dst, remaining, "%li", (long)syscall(SYS_gettid)); break; #endif case 'L': vasqIncSnprintf(dst, remaining, "%s", logLevelName(level)); break; @@ -139,7 +140,10 @@ vlogToBuffer(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, vasqIncSnprintf(dst, remaining, "%s", padding); break; - case 'u': vasqIncSnprintf(dst, remaining, "%li", (long)now); break; + case 'u': + clock_gettime(CLOCK_REALTIME, &epoch); + vasqIncSnprintf(dst, remaining, "%lli", (long long)epoch.tv_sec); + break; case 't': ctime_r(&now, time_string); @@ -199,7 +203,7 @@ vlogToBuffer(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, } static void -logToBuffer(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, char **dst, size_t *remaining, +logToBuffer(const vasqLogger *logger, vasqLogLevel level, VASQ_CONTEXT_DECL, char **dst, size_t *remaining, const char *format, ...) { va_list args; @@ -209,158 +213,139 @@ logToBuffer(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, c va_end(args); } -int -vasqLoggerCreate(int fd, vasqLogLevel_t level, const char *format, const vasqLoggerOptions *options, - vasqLogger **logger) +static void +writeToFd(void *user, const char *text, size_t size) { - int new_fd, local_errno; - const vasqLoggerOptions default_options = {0}; + int fd = (intptr_t)user; - if (!options) { - options = &default_options; + if (write(fd, text, size) < 0) { + NO_OP; } +} - if (fd < 0 || !logger) { - return VASQ_RET_USAGE; - } +static void +closeFd(void *user) +{ + int fd = (intptr_t)user; - if (!validLogFormat(format)) { - return VASQ_RET_BAD_FORMAT; - } + close(fd); +} - *logger = malloc(sizeof(**logger)); - if (!*logger) { - return VASQ_RET_OUT_OF_MEMORY; - } +int +vasqFdHandlerCreate(int fd, unsigned int flags, vasqHandler *handler) +{ + int new_fd; - if (options->flags & VASQ_LOGGER_FLAG_DUP) { - while (true) { - new_fd = dup(fd); - if (new_fd == -1) { - local_errno = errno; + if (!handler) { + errno = EINVAL; + return -1; + } - switch (local_errno) { + while ((new_fd = dup(fd)) < 0) { + switch (errno) { #ifdef EBUSY - case EBUSY: + case EBUSY: #endif - case EINTR: continue; + case EINTR: break; - default: - free(*logger); - *logger = NULL; - errno = local_errno; - return VASQ_RET_DUP_FAIL; - } - } - else { - break; - } + default: return -1; } - - (*logger)->duped = true; - } - else { - new_fd = fd; - (*logger)->duped = false; } - (*logger)->fd = new_fd; - (*logger)->format = format; - (*logger)->processor = options->processor; - (*logger)->user = options->user; - (*logger)->hex_dump_info = !!(options->flags & VASQ_LOGGER_FLAG_HEX_DUMP_INFO); - (*logger)->level = level; - - if (options->flags & VASQ_LOGGER_FLAG_CLOEXEC) { - int flags; - - flags = fcntl(new_fd, F_GETFD); - if (flags == -1 || fcntl(new_fd, F_SETFD, flags | FD_CLOEXEC) == -1) { - local_errno = errno; - vasqLoggerFree(*logger); - *logger = NULL; + if (flags & VASQ_LOGGER_FLAG_CLOEXEC) { + int fd_flags; + + fd_flags = fcntl(new_fd, F_GETFD); + if (fd_flags == -1 || fcntl(new_fd, F_SETFD, fd_flags | FD_CLOEXEC) == -1) { + int local_errno = errno; + + close(new_fd); errno = local_errno; - return VASQ_RET_FCNTL_FAIL; + return -1; } } - return VASQ_RET_OK; + handler->func = writeToFd; + handler->cleanup = closeFd; + handler->user = (void *)(intptr_t)new_fd; + + return 0; } -void -vasqLoggerFree(vasqLogger *logger) +vasqLogger * +vasqLoggerCreate(vasqLogLevel level, const char *format, const vasqHandler *handler, + const vasqLoggerOptions *options) { - if (!logger) { - return; - } + int errno_value; + vasqLogger *logger; + const vasqLoggerOptions default_options = {0}; - if (logger->duped) { - close(logger->fd); + if (!options) { + options = &default_options; } - free(logger); -} - -int -vasqLoggerFd(const vasqLogger *logger) -{ - return logger ? logger->fd : -1; -} + if (!handler || !handler->func) { + errno = EINVAL; + return NULL; + } -bool -vasqSetLoggerFormat(vasqLogger *logger, const char *format) -{ - if (logger && validLogFormat(format)) { - logger->format = format; - return true; + if (!validLogFormat(format)) { + errno_value = EINVAL; + goto error; } - else { - return false; + + logger = malloc(sizeof(*logger)); + if (!logger) { + errno_value = ENOMEM; + goto error; } -} -vasqLogLevel_t -vasqLoggerLevel(const vasqLogger *logger) -{ - return logger ? logger->level : VASQ_LL_NONE; -} + memcpy(&logger->handler, handler, sizeof(*handler)); + logger->format = format; + logger->processor = options->processor; + logger->user = options->user; + logger->hex_dump_info = !!(options->flags & VASQ_LOGGER_FLAG_HEX_DUMP_INFO); + logger->level = level; -void -vasqSetLoggerLevel(vasqLogger *logger, vasqLogLevel_t level) -{ - if (logger) { - logger->level = level; + return logger; + +error: + if (handler->cleanup) { + handler->cleanup(handler->user); } + errno = errno_value; + return NULL; } void -vasqSetLoggerProcessor(vasqLogger *logger, vasqLoggerDataProcessor processor) +vasqLoggerFree(vasqLogger *logger) { if (!logger) { return; } - logger->processor = processor; + if (logger->handler.cleanup) { + logger->handler.cleanup(logger->handler.user); + } + free(logger); } -void * -vasqLoggerUserData(const vasqLogger *logger) +vasqLogLevel +vasqLoggerLevel(const vasqLogger *logger) { - return logger ? logger->user : NULL; + return logger ? logger->level : VASQ_LL_NONE; } void -vasqSetLoggerUserData(vasqLogger *logger, void *user) +vasqSetLoggerLevel(vasqLogger *logger, vasqLogLevel level) { - if (!logger) { - return; + if (logger) { + logger->level = level; } - - logger->user = user; } void -vasqLogStatement(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, const char *format, ...) +vasqLogStatement(const vasqLogger *logger, vasqLogLevel level, VASQ_CONTEXT_DECL, const char *format, ...) { va_list args; @@ -370,7 +355,7 @@ vasqLogStatement(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DE } void -vasqVLogStatement(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_DECL, const char *format, +vasqVLogStatement(const vasqLogger *logger, vasqLogLevel level, VASQ_CONTEXT_DECL, const char *format, va_list args) { char output[VASQ_LOGGING_LENGTH]; @@ -383,13 +368,8 @@ vasqVLogStatement(const vasqLogger *logger, vasqLogLevel_t level, VASQ_CONTEXT_D } remote_errno = errno; - vlogToBuffer(logger, level, file_name, function_name, line_no, &dst, &remaining, format, args); - - if (write(logger->fd, output, dst - output) < 0) { - NO_OP; - } - + logger->handler.func(logger->handler.user, output, dst - output); errno = remote_errno; } @@ -415,13 +395,8 @@ vasqVRawLog(const vasqLogger *logger, const char *format, va_list args) } remote_errno = errno; - written = vasqSafeVsnprintf(output, sizeof(output), format, args); - - if (written > 0 && write(logger->fd, output, written) < 0) { - NO_OP; - } - + logger->handler.func(logger->handler.user, output, written); errno = remote_errno; } @@ -438,7 +413,7 @@ vasqHexDump(const vasqLogger *logger, VASQ_CONTEXT_DECL, const char *name, const int remote_errno; unsigned int actual_dump_size; size_t remaining = sizeof(output); - vasqLogLevel_t dump_level; + vasqLogLevel dump_level; if (!logger) { return; @@ -482,10 +457,7 @@ vasqHexDump(const vasqLogger *logger, VASQ_CONTEXT_DECL, const char *name, const (size - actual_dump_size == 1) ? "" : "s"); } - if (write(logger->fd, output, dst - output) < 0) { - NO_OP; - } - + logger->handler.func(logger->handler.user, output, dst - output); errno = remote_errno; #undef NUM_HEXDUMP_LINES @@ -493,74 +465,4 @@ vasqHexDump(const vasqLogger *logger, VASQ_CONTEXT_DECL, const char *name, const #undef HEXDUMP_BUFFER_SIZE } -void * -vasqMalloc(const vasqLogger *logger, VASQ_CONTEXT_DECL, size_t size) -{ - void *ptr; - - ptr = malloc(size); - if (!ptr && size > 0) { - vasqLogStatement(logger, VASQ_LL_ERROR, file_name, function_name, line_no, - "Failed to allocate %zu bytes", size); - } - return ptr; -} - -void * -vasqCalloc(const vasqLogger *logger, VASQ_CONTEXT_DECL, size_t nmemb, size_t size) -{ - void *ptr; - - ptr = calloc(nmemb, size); - if (!ptr && nmemb * size > 0) { - vasqLogStatement(logger, VASQ_LL_ERROR, file_name, function_name, line_no, - "Failed to allocate %zu bytes", nmemb * size); - } - return ptr; -} - -void * -vasqRealloc(const vasqLogger *logger, VASQ_CONTEXT_DECL, void *ptr, size_t size) -{ - void *success; - - success = realloc(ptr, size); - if (!success && size > 0) { - vasqLogStatement(logger, VASQ_LL_ERROR, file_name, function_name, line_no, - "Failed to reallocate %zu bytes", size); - } - return success; -} - -pid_t -vasqFork(const vasqLogger *logger, VASQ_CONTEXT_DECL) -{ - pid_t child; - - switch ((child = fork())) { - case -1: - vasqLogStatement(logger, VASQ_LL_ERROR, file_name, function_name, line_no, "fork: %s", - strerror(errno)); - break; - - case 0: break; - - default: - vasqLogStatement(logger, VASQ_LL_PROCESS, file_name, function_name, line_no, - "Child process started (PID = %li)", (long)child); - break; - } - - return child; -} - -void -vasqExit(vasqLogger *logger, VASQ_CONTEXT_DECL, int value, bool quick) -{ - vasqLogStatement(logger, VASQ_LL_PROCESS, file_name, function_name, line_no, - "Process exiting with value %i", value); - vasqLoggerFree(logger); - (quick ? _exit : exit)(value); -} - #endif // VASQ_NO_LOGGING diff --git a/tests/.gitignore b/tests/.gitignore index 280807b..2b29f27 100644 --- a/tests/.gitignore +++ b/tests/.gitignore @@ -1,4 +1 @@ -__pycache__ -format -hexdump -assert +tests diff --git a/tests/make.mk b/tests/make.mk index fe8d589..ae74f2d 100644 --- a/tests/make.mk +++ b/tests/make.mk @@ -1,12 +1,33 @@ -TESTS := $(patsubst $(TEST_DIR)/test_%.c,$(TEST_DIR)/%,$(wildcard $(TEST_DIR)/test_*.c)) +TEST_BINARY := $(TEST_DIR)/tests +TEST_SOURCE_FILES := $(wildcard $(TEST_DIR)/*.c) +TEST_OBJECT_FILES := $(patsubst %.c,%.o,$(TEST_SOURCE_FILES)) -$(TEST_DIR)/%: $(TEST_DIR)/test_%.c $(VASQ_STATIC_LIBRARY) - $(CC) $(CFLAGS) $(VASQ_INCLUDE_FLAGS) -o $@ $^ +TEST_DEPS_FILE := $(TEST_DIR)/deps.mk +DEPS_FILES += $(TEST_DEPS_FILE) -tests: $(TESTS) $(wildcard $(TEST_DIR)/*.py) - pytest $(TEST_DIR) +BUILD_DEPS ?= $(if $(MAKECMDGOALS),$(subst clean,,$(MAKECMDGOALS)),yes) -test_clean: - @rm -f $(TESTS) +ifneq ($(BUILD_DEPS),) -CLEAN_TARGETS += test_clean +$(TEST_DEPS_FILE): $(TEST_SOURCE_FILES) $(VASQ_HEADER_FILES) + @mkdir -p $(@D) + @rm -f $@ + for file in $(TEST_SOURCE_FILES); do \ + echo "$(TEST_DIR)/`$(CC) $(VASQ_INCLUDE_FLAGS) -MM $$file`" >> $@ && \ + echo '\t$$(CC) $$(CFLAGS) -DVASQ_TEST_ASSERT -DDEBUG $(VASQ_INCLUDE_FLAGS) -c $$< -o $$@' >> $@; \ + done +include $(TEST_DEPS_FILE) + +endif + + +$(TEST_BINARY): $(TEST_OBJECT_FILES) $(VASQ_SHARED_LIBRARY) + $(CC) $(CFLAGS) $(VASQ_INCLUDE_FLAGS) $(filter %.o,$^) -Wl,-rpath $(realpath $(VASQ_LIB_DIR)) -L$(VASQ_LIB_DIR) -lvanillasquad -lscrutiny -o $@ + +tests: $(TEST_BINARY) + @$< + +tests_clean: + @rm -f $(TEST_BINARY) $(TEST_OBJECT_FILES) + +CLEAN_TARGETS += tests_clean diff --git a/tests/requirements.txt b/tests/requirements.txt deleted file mode 100644 index d00689e..0000000 --- a/tests/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -pytest==7.1.2 diff --git a/tests/test_assert.c b/tests/test_assert.c deleted file mode 100644 index 2ff7cbb..0000000 --- a/tests/test_assert.c +++ /dev/null @@ -1,62 +0,0 @@ -#ifndef DEBUG -#define DEBUG -#endif - -#define VASQ_TEST_ASSERT - -#include - -#include - -bool _vasq_abort_caught; - -int -returnsZero(void) -{ - return 0; -} - -int -returnsOne(void) -{ - return 1; -} - -int -main() -{ - int ret; - vasqLogger *logger; - - ret = vasqLoggerCreate(STDOUT_FILENO, VASQ_LL_INFO, "[%L]%_ %M\n", NULL, &logger); - if (ret != VASQ_RET_OK) { - return ret; - } - - VASQ_INFO(logger, "Asserting a false statement"); - VASQ_ASSERT(logger, returnsZero() == 1); - - if (_vasq_abort_caught) { - VASQ_INFO(logger, "Abort caught"); - } - else { - VASQ_ERROR(logger, "Assertion did not cause an abort"); - ret = -1; - goto done; - } - - VASQ_INFO(logger, "Asserting a true statement"); - VASQ_ASSERT(logger, returnsOne() == 1); - - if (_vasq_abort_caught) { - VASQ_ERROR(logger, "Assertion caused an abort"); - ret = -1; - } - else { - VASQ_INFO(logger, "No abort was caught"); - } - -done: - vasqLoggerFree(logger); - return ret; -} \ No newline at end of file diff --git a/tests/test_assert.py b/tests/test_assert.py deleted file mode 100644 index b308a7a..0000000 --- a/tests/test_assert.py +++ /dev/null @@ -1,9 +0,0 @@ -import pathlib -import subprocess - -THIS_DIR = pathlib.Path(__file__).parent -ASSERT_EXECUTABLE = str(THIS_DIR / "assert") - - -def test_assert(): - assert subprocess.run(ASSERT_EXECUTABLE).returncode == 0 diff --git a/tests/test_format.c b/tests/test_format.c deleted file mode 100644 index c48c9b8..0000000 --- a/tests/test_format.c +++ /dev/null @@ -1,40 +0,0 @@ -#include -#include - -#include -#include - -static void -processor(void *user, size_t idx, vasqLogLevel_t level, char **dst, size_t *remaining) -{ - (void)level; - int *x = (int *)user; - - (*x)++; - vasqIncSnprintf(dst, remaining, "%zu-%i", idx, *x); -} - -int -main(int argc, char **argv) -{ - int ret, x = 0; - vasqLogger *logger; - vasqLoggerOptions options = {.processor = processor, .user = &x}; - - if (argc < 2) { - return VASQ_RET_USAGE; - } - - ret = vasqLoggerCreate(STDOUT_FILENO, VASQ_LL_INFO, argv[1], &options, &logger); - if (ret != VASQ_RET_OK) { - return ret; - } - - VASQ_INFO(logger, "Check"); - if (strstr(argv[1], "%l")) { - VASQ_INFO(logger, "Check 2"); - } - vasqLoggerFree(logger); - - return VASQ_RET_OK; -} diff --git a/tests/test_hexdump.c b/tests/test_hexdump.c deleted file mode 100644 index 2206710..0000000 --- a/tests/test_hexdump.c +++ /dev/null @@ -1,30 +0,0 @@ -#include - -#include - -int -main() -{ - int ret; - ssize_t num_bytes; - unsigned char buffer[4096]; - vasqLogger *logger; - vasqLoggerOptions options = {.flags = VASQ_LOGGER_FLAG_HEX_DUMP_INFO}; - - ret = vasqLoggerCreate(STDOUT_FILENO, VASQ_LL_INFO, "%M\n", &options, &logger); - if (ret != VASQ_RET_OK) { - return ret; - } - - num_bytes = read(STDIN_FILENO, buffer, sizeof(buffer)); - if (num_bytes < 0) { - ret = -1; - goto done; - } - - VASQ_HEXDUMP(logger, "stdin", buffer, num_bytes); - -done: - vasqLoggerFree(logger); - return ret; -} diff --git a/tests/test_logger.c b/tests/test_logger.c new file mode 100644 index 0000000..fa2c743 --- /dev/null +++ b/tests/test_logger.c @@ -0,0 +1,663 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +struct test_ctx { + char buffer[100]; +}; + +bool _vasq_abort_caught; + +void +test_logger_null_logger(void) +{ + VASQ_INFO(NULL, "Check"); +} + +static void +handler_func(void *user, const char *text, size_t size) +{ + int *num_ptr = user; + + SCR_ASSERT_STR_EQ(text, "Check"); + SCR_ASSERT_EQ(size, 5); + + SCR_ASSERT_EQ(*num_ptr, 0); + (*num_ptr)++; +} + +static void +handler_cleanup(void *user) +{ + int *num_ptr = user; + + (*num_ptr)++; +} + +void +test_logger_handler(void) +{ + int num = 0; + vasqHandler handler = {.func = handler_func, .cleanup = handler_cleanup, .user = &num}; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = vasqLoggerCreate(VASQ_LL_INFO, "%M", &handler, NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_EQ(num, 1); + vasqLoggerFree(logger); + SCR_ASSERT_EQ(num, 2); +} + +void +test_logger_no_handler(void) +{ + SCR_ASSERT_PTR_EQ(vasqLoggerCreate(VASQ_LL_INFO, "%M", NULL, NULL), NULL); +} + +void +test_logger_handler_no_func(void) +{ + vasqHandler handler = {0}; + + SCR_ASSERT_PTR_EQ(vasqLoggerCreate(VASQ_LL_INFO, "%M", &handler, NULL), NULL); + SCR_ASSERT_EQ(errno, EINVAL); +} + +static void +write_to_ctx(void *user, const char *text, size_t size) +{ + struct test_ctx *ctx = user; + + memset(ctx, 0, sizeof(*ctx)); + size = MIN(size, sizeof(ctx->buffer) - 1); + memcpy(ctx->buffer, text, size); +} + +static vasqLogger * +create_logger(struct test_ctx *ctx, vasqLogLevel level, const char *format, const vasqLoggerOptions *options) +{ + vasqHandler handler = { + .func = write_to_ctx, + .user = ctx, + }; + + memset(ctx, 0, sizeof(*ctx)); + return vasqLoggerCreate(level, format, &handler, options); +} + +void +test_logger_get_level(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "", NULL), NULL); + SCR_ASSERT_EQ(vasqLoggerLevel(logger), VASQ_LL_INFO); + + vasqLoggerFree(logger); +} + +void +test_logger_set_level(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "", NULL), NULL); + vasqSetLoggerLevel(logger, VASQ_LL_DEBUG); + SCR_ASSERT_EQ(vasqLoggerLevel(logger), VASQ_LL_DEBUG); + + vasqLoggerFree(logger); +} + +void +test_logger_empty(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, ""); + + vasqLoggerFree(logger); +} + +void +test_logger_message(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%M", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "Check"); + + vasqLoggerFree(logger); +} + +void +test_logger_none_level(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_NONE, "%M", NULL), NULL); + VASQ_ALWAYS(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, ""); + + vasqLoggerFree(logger); +} + +void +test_logger_level_too_high(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%M", NULL), NULL); + VASQ_DEBUG(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, ""); + + vasqLoggerFree(logger); +} + +void +test_logger_pid(void) +{ + char answer[20]; + struct test_ctx ctx; + vasqLogger *logger; + + snprintf(answer, sizeof(answer), "%li", (long)getpid()); + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%p", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + vasqLoggerFree(logger); +} + +void +test_logger_tid(void) +{ +#ifdef __linux__ + char answer[20]; + struct test_ctx ctx; + vasqLogger *logger; + + snprintf(answer, sizeof(answer), "%li", (long)syscall(SYS_gettid)); + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%T", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + vasqLoggerFree(logger); +#else + SCR_TEST_SKIP(); +#endif +} + +void +test_logger_level(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_DEBUG, "%L", NULL), NULL); + + VASQ_ALWAYS(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "ALWAYS"); + + VASQ_CRITICAL(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "CRITICAL"); + + VASQ_ERROR(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "ERROR"); + + VASQ_WARNING(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "WARNING"); + + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "INFO"); + + VASQ_DEBUG(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "DEBUG"); + + vasqLoggerFree(logger); +} + +void +test_logger_level_with_padding(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_DEBUG, "%L%_", NULL), NULL); + + VASQ_ALWAYS(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "ALWAYS "); + + VASQ_CRITICAL(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "CRITICAL"); + + VASQ_ERROR(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "ERROR "); + + VASQ_WARNING(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "WARNING "); + + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "INFO "); + + VASQ_DEBUG(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "DEBUG "); + + vasqLoggerFree(logger); +} + +void +test_logger_epoch(void) +{ + long long epoch; + char *endptr; + struct timespec now; + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_DEBUG, "%u", NULL), NULL); + VASQ_INFO(logger, "Check"); + if (clock_gettime(CLOCK_REALTIME, &now) != 0) { + SCR_FAIL("clock_gettime: %s", strerror(errno)); + } + + epoch = strtoll(ctx.buffer, &endptr, 10); + if (ctx.buffer[0] == '\0' || *endptr != '\0') { + SCR_FAIL("Invalid logged time: %s", ctx.buffer); + } + + SCR_ASSERT_LE((long long)now.tv_sec, epoch); + SCR_ASSERT_LE(epoch - (long long)now.tv_sec, 1); + + vasqLoggerFree(logger); +} + +void +test_logger_pretty_timestamp(void) +{ + time_t now; + struct test_ctx ctx; + vasqLogger *logger; + char answer[30]; + + now = time(NULL); + ctime_r(&now, answer); + answer[strlen(answer) - 1] = '\0'; // Remove the newline character. + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_DEBUG, "%t", NULL), NULL); + VASQ_INFO(logger, "Check"); + + SCR_LOG("Logged time: %s", ctx.buffer); + SCR_LOG("Actual time: %s", answer); + + // We can't be sure that the seconds will be the same but everything before that should be. + ctx.buffer[17] = '\0'; + answer[17] = '\0'; + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + // The years should be the same. + SCR_ASSERT_STR_EQ(ctx.buffer + 19, answer + 19); + + vasqLoggerFree(logger); +} + +static void +get_date_fields(struct tm *fields) +{ + time_t now; + + now = time(NULL); + localtime_r(&now, fields); +} + +void +test_logger_hour(void) +{ + struct tm date_fields; + struct test_ctx ctx; + vasqLogger *logger; + char answer[10]; + + get_date_fields(&date_fields); + snprintf(answer, sizeof(answer), "%02i", date_fields.tm_hour); + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_DEBUG, "%h", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + vasqLoggerFree(logger); +} + +void +test_logger_minute(void) +{ + struct tm date_fields; + struct test_ctx ctx; + vasqLogger *logger; + char answer[10]; + + get_date_fields(&date_fields); + snprintf(answer, sizeof(answer), "%02i", date_fields.tm_min); + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_DEBUG, "%m", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + vasqLoggerFree(logger); +} + +void +test_logger_second(void) +{ + long second; + struct tm date_fields; + struct test_ctx ctx; + char *endptr; + vasqLogger *logger; + + get_date_fields(&date_fields); + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_DEBUG, "%s", NULL), NULL); + VASQ_INFO(logger, "Check"); + + second = strtol(ctx.buffer, &endptr, 10); + if (ctx.buffer[0] == '\0' || *endptr != '\0') { + SCR_FAIL("Invalid logged second: %s", ctx.buffer); + } + + SCR_ASSERT_LE(date_fields.tm_sec, second); + SCR_ASSERT_LE(second - date_fields.tm_sec, 1); + + vasqLoggerFree(logger); +} + +static const char * +get_file_name(void) +{ + size_t idx; + const char *name = __FILE__; + + for (idx = strlen(name) - 1; idx > 0; idx--) { + if (name[idx] == '/') { + idx++; + goto found_slash; + } + } + + if (name[0] == '/') { + idx = 1; + } + +found_slash: + return name + idx; +} + +void +test_logger_file(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%F", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, get_file_name()); + + vasqLoggerFree(logger); +} + +void +test_logger_func(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%f", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, __func__); + + vasqLoggerFree(logger); +} + +void +test_logger_line(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + char answer[10]; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%l", NULL), NULL); + snprintf(answer, sizeof(answer), "%u", __LINE__ + 1); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + vasqLoggerFree(logger); +} + +static void +processor(void *user, size_t pos, vasqLogLevel level, char **buffer, size_t *remaining) +{ + int num = (intptr_t)user; + + SCR_ASSERT_EQ(level, VASQ_LL_INFO); + + vasqIncSnprintf(buffer, remaining, "%zu-%i", pos, num); +} + +void +test_logger_user_data(void) +{ + struct test_ctx ctx; + vasqLoggerOptions options = {.processor = processor, .user = (void *)(intptr_t)1}; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%x%M%x", &options), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "0-1Check1-1"); + + vasqLoggerFree(logger); +} + +void +test_logger_no_format(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_EQ(logger = create_logger(&ctx, VASQ_LL_INFO, NULL, NULL), NULL); + SCR_ASSERT_EQ(errno, EINVAL); +} + +void +test_logger_invalid_format(void) +{ + struct test_ctx ctx; + + SCR_ASSERT_PTR_EQ(create_logger(&ctx, VASQ_LL_INFO, "%k", NULL), NULL); + SCR_ASSERT_EQ(errno, EINVAL); +} + +void +test_logger_percent(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%%", NULL), NULL); + VASQ_INFO(logger, "Check"); + SCR_ASSERT_STR_EQ(ctx.buffer, "%"); + + vasqLoggerFree(logger); +} + +void +test_logger_raw(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%L: %M", NULL), NULL); + vasqRawLog(logger, "Check: %i", 5); + SCR_ASSERT_STR_EQ(ctx.buffer, "Check: 5"); + + vasqLoggerFree(logger); +} + +static void +do_vraw(vasqLogger *logger, const char *format, ...) +{ + va_list args; + + va_start(args, format); + vasqVRawLog(logger, format, args); + va_end(args); +} + +void +test_logger_vraw(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%L: %M", NULL), NULL); + do_vraw(logger, "Check: %i", 5); + SCR_ASSERT_STR_EQ(ctx.buffer, "Check: 5"); + + vasqLoggerFree(logger); +} + +void +test_logger_perror(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + char answer[50]; + + snprintf(answer, sizeof(answer), "ERROR: Check: %s", strerror(EINVAL)); + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%L: %M", NULL), NULL); + VASQ_PERROR(logger, "Check", EINVAL); + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + vasqLoggerFree(logger); +} + +void +test_logger_pwarning(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + char answer[50]; + + snprintf(answer, sizeof(answer), "WARNING: Check: %s", strerror(EINVAL)); + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%L: %M", NULL), NULL); + VASQ_PWARNING(logger, "Check", EINVAL); + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + vasqLoggerFree(logger); +} + +void +test_logger_pcritical(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + char answer[50]; + + snprintf(answer, sizeof(answer), "CRITICAL: Check: %s", strerror(EINVAL)); + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%L: %M", NULL), NULL); + VASQ_PCRITICAL(logger, "Check", EINVAL); + SCR_ASSERT_STR_EQ(ctx.buffer, answer); + + vasqLoggerFree(logger); +} + +void +test_logger_assert(void) +{ + struct test_ctx ctx; + vasqLogger *logger; + + SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_CRITICAL, "%L: %M", NULL), NULL); + _vasq_abort_caught = false; + VASQ_ASSERT(logger, 1 == 2); + SCR_ASSERT_STR_EQ(ctx.buffer, "CRITICAL: Assertion failed: 1 == 2"); + SCR_ASSERT(_vasq_abort_caught); + + vasqLoggerFree(logger); +} + +void +test_logger_fd_handler(void) +{ + int num_chars; + vasqHandler handler; + vasqLogger *logger; + int fds[2]; + char buffer[100]; + + if (pipe(fds) != 0) { + SCR_FAIL("pipe: %s", strerror(errno)); + } + + SCR_ASSERT_EQ(vasqFdHandlerCreate(fds[1], 0, &handler), 0); + close(fds[1]); + + SCR_ASSERT_PTR_NEQ(logger = vasqLoggerCreate(VASQ_LL_INFO, "%M", &handler, NULL), NULL); + VASQ_INFO(logger, "Check"); + num_chars = read(fds[0], buffer, sizeof(buffer) - 1); + if (num_chars < 0) { + SCR_FAIL("read: %s", strerror(errno)); + } + buffer[num_chars] = '\0'; + SCR_ASSERT_STR_EQ(buffer, "Check"); + + vasqLoggerFree(logger); + close(fds[0]); +} + +void +test_logger_fd_handler_cloexec(void) +{ + int fd_flags, handler_fd; + vasqHandler handler; + int fds[2]; + + if (pipe(fds) != 0) { + SCR_FAIL("pipe: %s", strerror(errno)); + } + + SCR_ASSERT_EQ(vasqFdHandlerCreate(fds[1], VASQ_LOGGER_FLAG_CLOEXEC, &handler), 0); + handler_fd = (intptr_t)handler.user; + fd_flags = fcntl(handler_fd, F_GETFD); + if (fd_flags == -1) { + SCR_FAIL("fcntl (F_GETFD): %s", strerror(errno)); + } + SCR_ASSERT(fd_flags & FD_CLOEXEC); + + close(handler_fd); + close(fds[0]); + close(fds[1]); +} diff --git a/tests/test_logging.py b/tests/test_logging.py deleted file mode 100644 index 36d8430..0000000 --- a/tests/test_logging.py +++ /dev/null @@ -1,156 +0,0 @@ -import pathlib -import re -import subprocess -import sys -import tempfile -import time -import typing - -import pytest - -THIS_DIR = pathlib.Path(__file__).parent -FORMAT_EXECUTABLE = str(THIS_DIR / "format") -HEXDUMP_EXECUTABLE = str(THIS_DIR / "hexdump") - -DATE_PATTERN = re.compile(r"[A-Z][a-z]{2} [A-Z][a-z]{2} [01 ]\d \d{2}:\d{2}:\d{2} \d{4}$") -HEXDUMP_HEADER_PATTERN = re.compile(r"stdin \((\d+) bytes?\):$") -HEXDUMP_PATTERN = re.compile(r"\t([a-f0-9]{4})\t((?:[a-f0-9]{2} )+) *\t(.+)") -HEXDUMP_ELLIPSIS_PATTERN = re.compile(r"\t\.\.\. \((\d+) more bytes?\)$") -HEXDUMP_LINE_LENGTH = 16 - -PRINTABLE_RANGE = range(ord(" "), ord("~") + 1) - -FORMAT_OUTPUT_PAIRS = ( - ("", ""), - ("Hello", "Hello"), - ("%M", "Check"), - ("%L", "INFO"), - ("%_", " " * 4), - ("%F", "test_format.c"), - ("%f", "main"), - ("%%", "%"), - ("%x%M%x", "0-1Check1-2"), -) - - -def encode_data(data: bytes) -> typing.Iterator[str]: - for n in data: - if n in PRINTABLE_RANGE: - yield chr(n) - else: - yield "." - - -@pytest.mark.parametrize("format_str,output", FORMAT_OUTPUT_PAIRS) -def test_simple_format(format_str: str, output: str): - p = subprocess.run([FORMAT_EXECUTABLE, format_str], stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 0 - assert p.stdout == output - - -def test_format_pid(): - p = subprocess.Popen([FORMAT_EXECUTABLE, "%p"], stdout=subprocess.PIPE, encoding="utf-8") - stdout, _ = p.communicate() - assert p.returncode == 0 - assert stdout == str(p.pid) - - -@pytest.mark.skipif("not sys.platform.startswith('linux')", reason="Feature only supported on Linux") -def test_format_tid(): - p = subprocess.Popen([FORMAT_EXECUTABLE, "%T"], stdout=subprocess.PIPE, encoding="utf-8") - stdout, _ = p.communicate() - assert p.returncode == 0 - assert stdout == str(p.pid) - - -def test_format_epoch_time(): - p = subprocess.run([FORMAT_EXECUTABLE, "%u"], stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 0 - assert abs(time.time() - int(p.stdout)) < 2 - - -def test_format_pretty_time(): - p = subprocess.run([FORMAT_EXECUTABLE, "%t"], stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 0 - assert DATE_PATTERN.match(p.stdout) - - -def test_format_hour(): - p = subprocess.run([FORMAT_EXECUTABLE, "%h"], stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 0 - assert int(p.stdout) == time.localtime().tm_hour - - -def test_format_minute(): - p = subprocess.run([FORMAT_EXECUTABLE, "%m"], stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 0 - assert int(p.stdout) == time.localtime().tm_min - - -def test_format_second(): - p = subprocess.run([FORMAT_EXECUTABLE, "%s"], stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 0 - assert abs(time.localtime().tm_sec - int(p.stdout)) < 2 - - -def test_format_line_number(): - p = subprocess.run([FORMAT_EXECUTABLE, "%l\n"], stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 0 - lines = p.stdout.split("\n") - assert int(lines[1]) == int(lines[0]) + 2 - - -def test_format_bad(): - p = subprocess.run([FORMAT_EXECUTABLE, "%v"], stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 2 - - -def data_samples() -> typing.Iterator[bytes]: - yield pytest.param(b"", id='b""') - yield pytest.param(b"a", id='b"a"') - yield pytest.param(b"hello", id='b"hello"') - - chunk = bytes(range(256)) - yield pytest.param(chunk, id="chunk") - - yield pytest.param(chunk * 16, id="big chunk") - - -@pytest.mark.parametrize("data", data_samples()) -def test_hexdump(data): - with tempfile.TemporaryFile() as f: - f.write(data) - f.seek(0) - p = subprocess.run(HEXDUMP_EXECUTABLE, stdin=f, stdout=subprocess.PIPE, encoding="utf-8") - assert p.returncode == 0 - - lines = p.stdout.split("\n") - match = HEXDUMP_HEADER_PATTERN.match(lines[0]) - assert match is not None - assert int(match.group(1)) == len(data) - lines = lines[1:-1] - - out_data = b"" - extra_length = 0 - - if len(lines) > 0: - match = HEXDUMP_ELLIPSIS_PATTERN.match(lines[-1]) - if match is not None: - extra_length = int(match.group(1)) - lines = lines[:-1] - - for k, line in enumerate(lines): - match = HEXDUMP_PATTERN.match(line) - assert match is not None - assert int(match.group(1), 16) == HEXDUMP_LINE_LENGTH * k - line_data = bytes.fromhex(match.group(2).replace(" ", "")) - line_ascii = match.group(3) - line_encode = "".join(encode_data(line_data)) - assert line_encode == line_ascii - out_data += line_data - - assert len(out_data) + extra_length == len(data) - if extra_length > 0: - assert out_data == data[:-extra_length] - else: - assert out_data == data diff --git a/tests/test_safe_snprintf.c b/tests/test_safe_snprintf.c new file mode 100644 index 0000000..a8b4e81 --- /dev/null +++ b/tests/test_safe_snprintf.c @@ -0,0 +1,348 @@ +#include +#include + +#include +#include + +void +test_snprintf(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "Check"), 5); + SCR_ASSERT_STR_EQ(buffer, "Check"); +} + +void +test_snprintf_s(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%s", "hello"), 5); + SCR_ASSERT_STR_EQ(buffer, "hello"); +} + +void +test_snprintf_partial_s(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%.*s", 3, "hello"), 3); + SCR_ASSERT_STR_EQ(buffer, "hel"); +} + +static ssize_t +do_vsnprintf(char *buffer, size_t size, const char *format, ...) +{ + ssize_t ret; + va_list args; + + va_start(args, format); + ret = vasqSafeVsnprintf(buffer, size, format, args); + va_end(args); + return ret; +} + +void +test_vsnprintf(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(do_vsnprintf(buffer, sizeof(buffer), "Hi, %s", "Bob"), 7); + SCR_ASSERT_STR_EQ(buffer, "Hi, Bob"); +} + +void +test_snprintf_percent(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%%"), 1); + SCR_ASSERT_STR_EQ(buffer, "%"); +} + +void +test_snprintf_i(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%i", -5), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_d(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%d", -5), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_u(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%u", 5), 1); + SCR_ASSERT_STR_EQ(buffer, "5"); +} + +void +test_snprintf_li(void) +{ + long value = -5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%li", value), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_ld(void) +{ + long value = -5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%ld", value), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_lu(void) +{ + unsigned long value = 5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%lu", value), 1); + SCR_ASSERT_STR_EQ(buffer, "5"); +} + +void +test_snprintf_lli(void) +{ + long long value = -5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%lli", value), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_lld(void) +{ + long long value = -5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%lld", value), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_llu(void) +{ + unsigned long long value = 5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%llu", value), 1); + SCR_ASSERT_STR_EQ(buffer, "5"); +} + +void +test_snprintf_zi(void) +{ + ssize_t value = -5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%zi", value), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_zd(void) +{ + ssize_t value = -5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%zd", value), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_zu(void) +{ + size_t value = 5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%zu", value), 1); + SCR_ASSERT_STR_EQ(buffer, "5"); +} + +void +test_snprintf_ji(void) +{ + intmax_t value = -5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%ji", value), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_jd(void) +{ + intmax_t value = -5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%jd", value), 2); + SCR_ASSERT_STR_EQ(buffer, "-5"); +} + +void +test_snprintf_ju(void) +{ + uintmax_t value = 5; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%ju", value), 1); + SCR_ASSERT_STR_EQ(buffer, "5"); +} + +void +test_snprintf_x(void) +{ + unsigned int value = 266; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%x", value), 3); + SCR_ASSERT_STR_EQ(buffer, "10a"); +} + +void +test_snprintf_X(void) +{ + unsigned int value = 266; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%X", value), 3); + SCR_ASSERT_STR_EQ(buffer, "10A"); +} + +void +test_snprintf_lx(void) +{ + unsigned long value = 266; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%lx", value), 3); + SCR_ASSERT_STR_EQ(buffer, "10a"); +} + +void +test_snprintf_lX(void) +{ + unsigned long value = 266; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%lX", value), 3); + SCR_ASSERT_STR_EQ(buffer, "10A"); +} + +void +test_snprintf_llx(void) +{ + unsigned long long value = 266; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%llx", value), 3); + SCR_ASSERT_STR_EQ(buffer, "10a"); +} + +void +test_snprintf_llX(void) +{ + unsigned long long value = 266; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%llX", value), 3); + SCR_ASSERT_STR_EQ(buffer, "10A"); +} + +void +test_snprintf_p(void) +{ + void *ptr = (void *)(uintptr_t)0xdeadbeef; + char buffer[15]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%p", ptr), 10); + SCR_ASSERT_STR_EQ(buffer, "0xdeadbeef"); +} + +void +test_snprintf_zero_padding(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%04i", 5), 4); + SCR_ASSERT_STR_EQ(buffer, "0005"); +} + +void +test_snprintf_space_padding(void) +{ + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "%2x", 10), 2); + SCR_ASSERT_STR_EQ(buffer, " a"); +} + +void +test_inc_snprintf(void) +{ + char buffer[10]; + char *ptr = buffer; + size_t remaining = sizeof(buffer); + + SCR_ASSERT_EQ(vasqIncSnprintf(&ptr, &remaining, "Hi"), 2); + SCR_ASSERT_STR_EQ(buffer, "Hi"); + SCR_ASSERT_PTR_EQ(ptr, buffer + 2); + SCR_ASSERT_EQ(remaining, sizeof(buffer) - 2); +} + +void +test_inc_snprintf_none_remaining(void) +{ + char buffer[10] = "dummy"; + char *ptr = buffer; + size_t remaining = 1; + + SCR_ASSERT_EQ(vasqIncSnprintf(&ptr, &remaining, "Hi"), 0); + SCR_ASSERT_CHAR_EQ(buffer[0], '\0'); + SCR_ASSERT_PTR_EQ(ptr, buffer); + SCR_ASSERT_EQ(remaining, 1); +} + +static ssize_t +do_inc_vsnprintf(char **buffer, size_t *remaining, const char *format, ...) +{ + ssize_t ret; + va_list args; + + va_start(args, format); + ret = vasqIncVsnprintf(buffer, remaining, format, args); + va_end(args); + return ret; +} + +void +test_inc_vsnprintf(void) +{ + char buffer[10]; + char *ptr = buffer; + size_t remaining = sizeof(buffer); + + SCR_ASSERT_EQ(do_inc_vsnprintf(&ptr, &remaining, "Hi, %s", "Bob"), 7); + SCR_ASSERT_STR_EQ(buffer, "Hi, Bob"); + SCR_ASSERT_PTR_EQ(ptr, buffer + 7); + SCR_ASSERT_EQ(remaining, sizeof(buffer) - 7); +} diff --git a/tests/tests.c b/tests/tests.c new file mode 100644 index 0000000..97000d4 --- /dev/null +++ b/tests/tests.c @@ -0,0 +1,87 @@ +#include + +#define APPLY_MACRO(M) \ + M(snprintf) \ + M(snprintf_s) \ + M(snprintf_partial_s) \ + M(vsnprintf) \ + M(snprintf_percent) \ + M(snprintf_i) \ + M(snprintf_d) \ + M(snprintf_u) \ + M(snprintf_li) \ + M(snprintf_ld) \ + M(snprintf_lu) \ + M(snprintf_lli) \ + M(snprintf_lld) \ + M(snprintf_llu) \ + M(snprintf_zi) \ + M(snprintf_zd) \ + M(snprintf_zu) \ + M(snprintf_ji) \ + M(snprintf_jd) \ + M(snprintf_ju) \ + M(snprintf_x) \ + M(snprintf_X) \ + M(snprintf_lx) \ + M(snprintf_lX) \ + M(snprintf_llx) \ + M(snprintf_llX) \ + M(snprintf_p) \ + M(snprintf_zero_padding) \ + M(snprintf_space_padding) \ + M(inc_snprintf) \ + M(inc_snprintf_none_remaining) \ + M(inc_vsnprintf) \ + M(logger_null_logger) \ + M(logger_handler) \ + M(logger_no_handler) \ + M(logger_handler_no_func) \ + M(logger_get_level) \ + M(logger_set_level) \ + M(logger_empty) \ + M(logger_message) \ + M(logger_none_level) \ + M(logger_level_too_high) \ + M(logger_pid) \ + M(logger_tid) \ + M(logger_level) \ + M(logger_level_with_padding) \ + M(logger_epoch) \ + M(logger_pretty_timestamp) \ + M(logger_hour) \ + M(logger_minute) \ + M(logger_second) \ + M(logger_file) \ + M(logger_func) \ + M(logger_line) \ + M(logger_user_data) \ + M(logger_no_format) \ + M(logger_invalid_format) \ + M(logger_percent) \ + M(logger_raw) \ + M(logger_vraw) \ + M(logger_perror) \ + M(logger_pwarning) \ + M(logger_pcritical) \ + M(logger_assert) \ + M(logger_fd_handler) \ + M(logger_fd_handler_cloexec) + +#define DECL_TEST(func) void test_##func(void); +#define ADD_TEST(func) scrGroupAddTest(group, #func, test_##func, 0, 0); + +APPLY_MACRO(DECL_TEST) + +int +main() +{ + scrGroup *group; + + scrInit(); + + group = scrGroupCreate(NULL, NULL); + APPLY_MACRO(ADD_TEST) + + return scrRun(NULL, NULL); +} From c19e77fab46d39f2d7f656fbb86fa5f679a63819 Mon Sep 17 00:00:00 2001 From: Daniel Walker Date: Sat, 18 Mar 2023 23:52:48 -0400 Subject: [PATCH 2/6] changed the README from rst to md --- .clang-format | 2 +- README.md | 308 +++++++++++++++++++++++++++++++++++++ README.rst | 264 ------------------------------- include/vasq/config.h | 7 - include/vasq/logger.h | 58 +++---- tests/test_safe_snprintf.c | 10 ++ tests/tests.c | 1 + 7 files changed, 344 insertions(+), 306 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/.clang-format b/.clang-format index cfc4ffa..f3cf7ae 100644 --- a/.clang-format +++ b/.clang-format @@ -18,7 +18,7 @@ BraceWrapping: IndentBraces: false BreakBeforeBraces: Custom BreakBeforeTernaryOperators: false -ColumnLimit: 109 +ColumnLimit: 110 DerivePointerAlignment: false IncludeBlocks: Preserve IndentCaseLabels: false diff --git a/README.md b/README.md new file mode 100644 index 0000000..39b0836 --- /dev/null +++ b/README.md @@ -0,0 +1,308 @@ +Overview +======== + +The Vanilla Squad library provides access to various utilities: + +* Signal-safe snprintf +* Logging +* Placeholders + +Signal-safe snprintf +==================== + +`vasqSafeSnprintf` and `vasqSafeVsnprintf` are used in the same way as `snprintf` and `vsnprintf`, respectively. If either the destination or format string are `NULL`, the format string is invalid, or the size of the destination is zero, they return -1. Otherwise, they return the number of characters actually written to the destination (NOT counting the terminator). If a -1 is not returned, then a terminator is guaranteed to be written to the destination. + +In addition, there are + +```c +ssize_t +vasqIncSnprintf(char **output, size_t *capacity, const char *format, ...); + +ssize_t +vasqIncVsnprintf(char **output, size_t *capacity, const char *format, va_list args); +``` + +They function similarly to `vasqSafeSnprintf` and `vasqSafeVsnprintf` except that they take pointers to the destination as well as the size of the destination. Upon success, they adjust the destination and size so that subsequent calls to these functions will pick up where the previous call left off. To be clear, if the size is 1, then no characters will be written beyond the null terminator and the size will be unchanged. + +The % tokens recognized by these functions are + +- `%%` +- `%i` +- `%d` +- `%u` +- `%li` +- `%ld` +- `%lu` +- `%lli` +- `%lld` +- `%llu` +- `%zi` +- `%zd` +- `%zu` +- `%ji` +- `%jd` +- `%ju` +- `%x` +- `%X` +- `%lx` +- `%lX` +- `%llx` +- `%llX` +- `%p` +- `%s` +- `%.*`s +- `%n` + +In addition, zero-padding and minimum-length specification can be added to any integer type. E.g., + +```c +vasqSafeSnprintf(buffer, size, "%04i", 5); // "0005" +vasqSafeSnprintf(buffer, size, "%2x", 10); // " a" +``` + +Logging +======= + +Handlers +-------- + +Every logger need a handler: + +```c +typedef void +vasqHandlerFunc(void *user, const char *text, size_t size); + +typedef void +vasqHandlerCleanup(void *user); + +typedef struct vasqHandler { + vasqHandlerFunc *func; // Called whenever log messages are generated. + vasqHandlerCleanup *cleanup; // (Optional) Called when the logger is freed. + void *user; // User-provided data. +} vasqHandler; +``` + +Whenever a log message is generated, the handler's `func` is called with the handler's `user` as the first argument, the message as the second, and the length of the message as the third. `text` will actually be null-terminated but `size` saves you from having to determine it yourself. + +Since you'll often want to write logging messages to a file descriptor, you can use + +```c +int +vasqFdHandlerCreate( + int fd, // The file descriptor to write to. + unsigned int flags, // Bitwise-or-combined flags. + vasqHandler *handler // A pointer to the handler to be populated. +); +``` + +This function returns 0 if successful. Otherwise, -1 is returned and `errno` is set. + +The descriptor will be duplicated so, if you like, you can close the descriptor after creating the handler. + +At the moment, the only supported flag is + +- `VASQ_LOGGER_FLAG_CLOEXEC`: Set `FD_CLOEXEC` on the new descriptor. + +Loggers +------- + +A logger is created by + +```c +vasqLogger * +vasqLoggerCreate( + vasqLogLevel level, // The maximum log level. + const char *format, // The format of the logging messages. + const vasqHandler *handler, // A pointer to the handler to be used. + const vasqLoggerOptions *options // (Optional) A pointer to a structure containing various options. +); +``` + +This function returns the logger if successful. Otherwise, `NULL` is returned and `errno` is set. + +The available logging levels are + +- `VASQ_LL_NONE` +- `VASQ_LL_ALWAYS` +- `VASQ_LL_CRITICAL` +- `VASQ_LL_ERROR` +- `VASQ_LL_WARNING` +- `VASQ_LL_INFO` +- `VASQ_LL_DEBUG` + +`vasqLoggerOptions` is defined by + +```c +typedef void +vasqDataProcessor(void *user, size_t idx, vasqLogLevel levcel, char **dst, size_t *remaining); + +typedef struct vasqLoggerOptions { + vasqLoggerDataProcessor *processor; // The processor to be used for %x format tokens. + void *user; // A pointer to user data to be passed to the processor. + unsigned int flags; // Bitwise-or-combined flags. +} vasqLoggerOptions; +``` + +If `options` is `NULL` for `vasqLoggerCreate`, then the default options will be used. That is, `processor` and `user` will be `NULL` and `flags` will be 0. + +When the logger encounters a `%x` in the format string, it will call the processor (if it isn't `NULL`) with `user` as the first argument, an index as the second, and the log level as the third. The index will be a 0-up counter of which `%x` in the format string is being handled. The fourth and fifth arguments will be pointers to the destination and remaining size and function as in `vasqIncSnprintf`. The processor is responsible for adjusting these two values and for ensuring that the destination remains null-terminated. To be clear, the size must be decreased by the number of *non-null* characters written. + +At the moment, the only valid flag is + +- `VASQ_LOGGER_FLAG_HEX_DUMP_INFO`: Emit hex dumps at the **INFO** level instead of the default of **DEBUG**. See [Hex dumping](#hex-dumping). + +The format string looks like a `printf` string and accepts the following % tokens: + +- `%M`: The log message. More than one of these in a format string is not allowed. +- `%p`: Process ID. +- `%T`: Thread ID. Only available if compiling for Linux. +- `%L`: Log level. +- `%_`: Space padding that can be used with `%L`. See below for an example of its usage. +- `%u`: Unix epoch time in seconds. +- `%t`: Pretty timestamp. E.g., Sun Feb 14 14:27:19 2021 +- `%h`: Hour as an integer. +- `%m`: Minute as an integer. +- `%s`: Second as an integer. +- `%F`: File name. +- `%f`: Function name. +- `%l`: Line number. +- `%x`: User data. +- `%%`: Literal %. + +Here is an example of creation and use of a logger. + +```c +const char *gnarly = "gnarly", *cool = "cool", *invisible = "invisible"; +vasqHandler handler; +vasqLogger *logger; + +if ( vasqFdHandlerCreate(STDOUT_FILENO, 0, &handler) != 0 ) { + // abort +} + +logger = vasqLoggerCreate(VASQ_LL_INFO, "[%L]%_ %M ...\n", &handler, NULL); +if ( !logger ) { + // abort +} +VASQ_INFO(logger, "This is a %s message", gnarly); +VASQ_CRITICAL(logger, "This is a %s message", cool); +VASQ_DEBUG(logger, "This is an %s message", invisible); +/* + Outputs: + + [INFO] This is a gnarly message ... + [CRITICAL] This is a cool message ... + + Notice how the messages are aligned with each other. This is because of the %_. +*/ +vasqLoggerFree(logger); +``` + +You can also write directly to the handler via + +```c +void +vasqRawLog(const vasqLogger *logger, const char *format, ...); + +void +vasqVRawLog(const vasqLogger *logger, const char *format, va_list args); +``` + +If the logger's level is set to `VASQ_LL_NONE`, then all logging functions, including the raw logging functions, will do nothing. Passing `NULL` as the logger to the logging functions also results in nothing happening (NOT an error). + +Logging messages are emitted in a signal-safe manner. In addition, logging preserves the value of `errno`. + +Hex dumping +----------- + +You can dump binary data via + +```c +const char *sentence = "This is a boring sentence that no one cares about."; +VASQ_HEXDUMP(logger, "Boring sentence", sentence, strlen(sentence)+1); + +/* +Outputs: + + [DEBUG] Boring sentence (51 bytes): + 0000 54 68 69 73 20 69 73 20 61 20 62 6f 72 69 6e 67 This is a boring + 0010 20 73 65 6e 74 65 6e 63 65 20 74 68 61 74 20 6e sentence that n + 0020 6f 20 6f 6e 65 20 63 61 72 65 73 20 61 62 6f 75 o one cares abou + 0030 74 2e 00 +*/ +``` + +You can override the maximum number of bytes displayed in a hex dump by setting the `VASQ_HEXDUMP_SIZE` preprocessor variable. See [vasq/config.h](include/vasq/config.h) for the default value. + +Assertions +---------- + +You can assert that a condition is true via + +```c +VASQ_ASSERT(logger, x > 5); +``` + +If the `DEBUG` preprocessor variable is not defined, then this will resolve to a no-OP. Otherwise, if the condition fails, a message will be emitted at the **CRITICAL** level and `abort()` will be called. + +Compiling out logging +--------------------- + +It may be the case that you'd like to strip logging from your project when compiling for production. You could set your `vasqLogger` pointer to `NULL` or pass `VASQ_LL_NONE` to `vasqLoggerCreate`. However, you'd still have the function call overheads of all of the logging functions. To remove the logging logic completely, you can define the `VASQ_NO_LOGGING` preprocessor variable. This will cause all of thelogging macros as well as `vasqRawLog` and `vasqVRawLog` to resolve to no-OPs. + +Keep in mind that defining `VASQ_NO_LOGGING` will also remove the definitions of logging-related types like `vasqLogger` and `vasqHandler` as well as associated functions like `vasqLoggerCreate`. Therefore, you'll have to `#define` out any those sections of code manually. + +See [vasq/logger.h](include/vasq/logger.h) for the details. + +Placeholders +============ + +[vasq/placeholder.h](include/vasq/placeholder.h) defines a single macro: `PLACEHOLDER()`. If either the `DEBUG` or `VASQ_ALLOW_PLACEHOLDER` preprocessor variables are defined and `VASQ_REJECT_PLACEHOLDER` is not defined, then `PLACEHOLDER()` will resolve to a no-OP. Otherwise, it will resolve to a compiler error. The intended use +case is + +```c +int +unimplemented_function(int arg) +{ + (void)arg; + PLACEHOLDER(); + + return 0; +} +``` + +The idea is that, in production, this section of code would fail to compile thus making sure that you don't forget to implement the function. + +Building Vanilla Squad +====================== + +Shared and static libraries are built using make. Adding `debug=yes` to the make invocation will disable optimization and build the libraries with debugging symbols. + +You can also include Vanilla Squad in a larger project by including make.mk. Before doing so, however, the `VASQ_DIR` variable must be set to the location of the Vanilla Squad directory. You can also tell make where to place the shared and static libraries by defining the `VASQ_LIB_DIR` variable (defaults to `$(VASQ_DIR)`). Similarly, you can define the `VASQ_OBJ_DIR` variable which tells make where to place the object files (defaults to `$(VASQ_DIR`)/source). + +make.mk adds a target to the `CLEAN_TARGETS` variable. This is so that implementing + +```make +clean: $(CLEAN_TARGETS) + ... +``` + +in your project's Makefile will cause Vanilla Squad to be cleaned up as well. + +The `CLEAN_TARGETS` variable should be added to `.PHONY` if you're using GNU make. + +make.mk defines the variables `VASQ_SHARED_LIBRARY` and `VASQ_STATIC_LIBRARY` which contain the paths of the specified libraries. + +Configuration +------------- + +[vasq/config.h](include/vasq/config.h) contains various parameters which can be set prior to compilation. They can also be overridden by preprocessor flags defined in `CFLAGS`. + +Testing +======= + +Testing can be performed through the [Scrutiny framework](https://github.com/nickeldan/scrutiny). After installing at least version 0.4.0 of the framework, you can run tests by + +```sh +make tests +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index 523a8b1..0000000 --- a/README.rst +++ /dev/null @@ -1,264 +0,0 @@ -============= -Vanilla Squad -============= - -:Author: Daniel Walker -:Version: 6.0.8 -:Date: 2023-03-02 - -Overview -======== - -The Vanilla Squad library provides access to various utilities: - -* Signal-safe snprintf -* Logging -* Placeholders - -Signal-safe snprintf -==================== - -**vasqSafeSnprintf** and **vasqSafeVsnprintf** are used in the same way as **snprintf** and **vsnprintf**, -respectively. If either the destination or format string are **NULL**, the format string is invalid, or the -size of the destination is zero, they return -1. Otherwise, they return the number of characters actually -written to the destination (NOT counting the terminator). If a -1 is not returned, then a terminator is -guaranteed to be written to the destination. - -**vasqIncSnprintf** and **vasqIncVsnprintf** function similarly except that they take pointers to the -destination as well as the size of the destination. Upon success, they adjust the destination and size so -that subsequent calls to these functions will pick up where the previous call left off. To be clear, if the -size is 1, then no characters will be written beyond the null terminator and the size will be unchanged. - -The % tokens recognized by these functions are - -* %% -* %i -* %d -* %u -* %li -* %ld -* %lu -* %lli -* %lld -* %llu -* %zi -* %zd -* %zu -* %ji -* %jd -* %ju -* %x -* %X -* %lx -* %lX -* %llx -* %llX -* %p -* %s -* %.*s -* %n - -In addition, zero-padding and minimum-length specification can be added to any integer type. E.g., - -.. code-block:: c - - vasqSafeSnprintf(buffer, size, "%04i", 5); // "0005" - vasqSafeSnprintf(buffer, size, "%2x", 10); // " a" - -Logging -======= - -The provided logging levels (which are of type **vasqLogLevel_t**) are - -* **VASQ_LL_NONE** -* **VASQ_LL_ALWAYS** -* **VASQ_LL_CRITICAL** -* **VASQ_LL_ERROR** -* **VASQ_LL_WARNING** -* **VASQ_LL_INFO** -* **VASQ_LL_DEBUG** - -A logger handle is created by the **vasqLoggerCreate** function. Its signature is - -.. code-block:: c - - int - vasqLoggerCreate( - int fd, // File descriptor for the output. - vasqLogLevel_t level, // The maximum log level. - const char *format, // The format of the logging messages. - const vasqLoggerOptions *options; // Structure containing various options. - vasqLogger **logger, // A pointer to the logger handle to be populated. - ); - -This function returns **VASQ_RET_OK** when successful and an error code otherwise (see -include/vasq/definitions.h for the values). - -**vasqLoggerOptions** is defined by - -.. code-block:: c - - typedef struct vasqLoggerOptions { - vasqLoggerDataProcessor processor; /// The processor to be used for %x format tokens. - void *user; /// A pointer to user data to be passed to the processor. - unsigned int flags; /// Bitwise-or-combined flags. - } vasqLoggerOptions; - -If **options** is **NULL** for **vasqLoggerCreate**, then the default options will be used. That is, -**processor** and **user** will be **NULL** and **flags** will be 0. - -**vasqLoggerDataProcessor** is defined by - - .. code-block:: c - - typedef void (*vasqLoggerDataProcessor)(void*, size_t, vasqLogLevel_t, char**, size_t*); - -When the logger encounters a **%x** in the format string, it will call the processor (if it isn't **NULL**) -with **user** as the first argument, an index as the second, and the log level as the third. The index will -be a 0-up counter of which **%x** in the format string is being handled. The fourth and fifth arguments will -be pointers to the destination and remaining size and function as in **vasqIncSnprintf**. The processor is -responsible for adjusting these two values and for ensuring that the destination remains null-terminated. To -be clear, the size must be decreased by the number of *non-null* characters written. - -The valid flags are: - -* **VASQ_LOGGER_FLAG_DUP**: Instead of using the provided file descriptor, this option causes **dup** to be called. The new descriptor is closed when the logger is freed. -* **VASQ_LOGGER_FLAG_CLOEXEC**: This option causes the **FD_CLOEXEC** flag to be set on the file descriptor. -* **VASQ_LOGGER_FLAG_HEX_DUMP_INFO**: Emit hex dumps at the **INFO** level instead of the default of **DEBUG**. - -The format string looks like a **printf** string and accepts the following % tokens: - -* %M: The log message. More than one of these in a format string is not allowed. -* %p: Process ID. -* %T: Thread ID. Only available if compiling for Linux. -* %L: Log level. -* %_: Space padding that can be used with %L. See below for an example of its usage. -* %u: Unix epoch time in seconds. -* %t: Pretty timestamp. E.g., Sun Feb 14 14:27:19 2021 -* %h: Hour as an integer. -* %m: Minute as an integer. -* %s: Second as an integer. -* %F: File name. -* %f: Function name. -* %l: Line number. -* %x: User data. -* %%: Literal %. - -Here is an example of creation and use of a logger. - -.. code-block:: c - - int ret; - const char *gnarly = "gnarly", *cool = "cool", *invisible = "invisible"; - vasqLogger *logger; - - ret = vasqLoggerCreate(STDOUT_FILENO, VASQ_LL_INFO, "[%L]%_ %M ...\n", NULL, &logger); - if ( ret != VASQ_RET_OK ) { - fprintf(stderr, "vasqLoggerCreate failed: %s\n", vasqErrorString(ret)); - // abort - } - VASQ_INFO(logger, "This is a %s message", gnarly); - VASQ_CRITICAL(logger, "This is a %s message", cool); - VASQ_DEBUG(logger, "This is an %s message", invisible); - /* - Outputs: - - [INFO] This is a gnarly message ... - [CRITICAL] This is a cool message ... - - Notice how the messages are aligned with each other. This is because of the %_. - */ - vasqLoggerFree(logger); - -You can also write directly to the logger's file descriptor via the **vasqRawLog** and **vasqVRawLog** -functions. - -If the logger's level is set to **VASQ_LL_NONE**, then all logging functions, including the raw -logging functions, will do nothing. Passing **NULL** as the logger to the logging functions also results in -nothing happening (NOT an error). - -There are various other functions provided by include/vasq/logger.h, such as a hex dumper (which prints at -the DEBUG level) and a wrapper around **assert**. - -Logging messages are emitted in a signal-safe manner. In addition, logging preserves the value of **errno**. - -Compiling out logging ---------------------- - -It may be the case that you'd like to strip logging from your project when compiling for production. You -could set your **vasqLogger** pointer to **NULL** or pass **VASQ_LL_NONE** to **vasqLoggerCreate**. However, -you'd still have the function call overheads of all of the logging functions. To remove the logging logic -completely, you can define the **VASQ_NO_LOGGING** preprocessor variable. This will cause calls to functions -like **vasqLogStatement** and **vasqHexDump** to be removed from your code at preprocessing time. Calls to -**vasqLoggerCreate** will be replaced by the constant **VASQ_RET_OK**. Furthermore, calls to wrapper -functions like **vasqMalloc** will be "unwrapped" (e.g., **vasqMalloc** will be replaced by **malloc**). -These replacements will propagate to macros defined from these functions (e.g., **VASQ_INFO**). See -vasq/logger.h for the details of the replacements. - -Keep in mind that defining **VASQ_NO_LOGGING** will also remove the definitions of logging-related types like -**vasqLogger** and **vasqLoggerDataProcessor**. Therefore, you'll have to **#define** out any such variables -manually. - -Placeholders -============ - -placeholder.h defines a single macro: **PLACEHOLDER()**. If either the **DEBUG** or -**VASQ_ALLOW_PLACEHOLDER** macros are defined and **VASQ_REJECT_PLACEHOLDER** is not defined, then -**PLACEHOLDER()** will resolve to a no op. Otherwise, it will resolve to a compiler error. The intended use -case is - -.. code-block:: c - - int - some_function(int arg) - { - PLACEHOLDER(); // I don't know how to implement this function yet. - - return 0; - } - -The idea is that, in production, this section of code would fail to compile thus making sure that you don't -forget to implement the function. - -If you're compiling for a C standard earlier than C99, then **PLACEHOLDER()** will resolve to a no op. - -Building Vanilla Squad -====================== - -Shared and static libraries are built using make. Adding "debug=yes" to the make invocation will disable -optimization and build the libraries with debugging symbols. - -You can also include Vanilla Squad in a larger project by including make.mk. Before doing so, however, the -**VASQ_DIR** variable must be set to the location of the Vanilla Squad directory. You can also tell make -where to place the shared and static libraries by defining the **VASQ_LIB_DIR** variable (defaults to -**VASQ_DIR**). Similarly, you can define the **VASQ_OBJ_DIR** variable which tells make where to place the -object files (defaults to **VASQ_DIR**/source). - -make.mk adds a target to the **CLEAN_TARGETS** variable. This is so that implementing - -.. code-block:: make - - clean: $(CLEAN_TARGETS) - ... - -in your project's Makefile will cause Vanilla Squad to be cleaned up as well. - -The **CLEAN_TARGETS** variable should be added to **.PHONY** if you're using GNU make. - -make.mk defines the variables **VASQ_SHARED_LIBRARY** and **VASQ_STATIC_LIBRARY** which contain the paths of -the specified libraries. - -Configuration -------------- - -include/vasq/config.h contains various parameters which can be set prior to compilation. They can also be -overridden by preprocessor flags defined in **CFLAGS**. - -Testing -======= - -Some basic testing of features can be performed by first installing pytest (e.g., via pip) and then running - -.. code-block:: sh - - $ make tests diff --git a/include/vasq/config.h b/include/vasq/config.h index 8f4e21e..89dafbd 100644 --- a/include/vasq/config.h +++ b/include/vasq/config.h @@ -33,13 +33,6 @@ #define VASQ_HEXDUMP_WIDTH 16 #endif -/** - * @brief The log level which displays the creation and exiting of processes. - */ -#ifndef VASQ_LL_PROCESS -#define VASQ_LL_PROCESS VASQ_LL_DEBUG -#endif - /** * @brief Causes the PLACEHOLDER() macro to generate an error when used even if DEBUG or * VASQ_ALLOW_PLACEHOLDER are defined. diff --git a/include/vasq/logger.h b/include/vasq/logger.h index 722541e..31d5ef8 100644 --- a/include/vasq/logger.h +++ b/include/vasq/logger.h @@ -15,6 +15,8 @@ #include "definitions.h" +#ifndef VASQ_NO_LOGGING + /** * @brief Logging levels */ @@ -28,8 +30,6 @@ typedef enum vasqLogLevel { VASQ_LL_DEBUG, } vasqLogLevel; -#ifndef VASQ_NO_LOGGING - #define VASQ_CONTEXT_DECL const char *file_name, const char *function_name, unsigned int line_no #define VASQ_CONTEXT_PARAMS __FILE__, __func__, __LINE__ @@ -292,31 +292,6 @@ vasqHexDump(const vasqLogger *logger, VASQ_CONTEXT_DECL, const char *name, const */ #define VASQ_HEXDUMP(logger, name, data, size) vasqHexDump(logger, VASQ_CONTEXT_PARAMS, name, data, size) -#else // VASQ_NO_LOGGING - -#define vasqLoggerCreate(...) VASQ_RET_OK -#define vasqLoggerFree(logger) NO_OP -#define vasqLoggerLevel(logger) VASQ_LL_NONE -#define vasqSetLoggerLevel(logger, level) NO_OP - -#define vasqLogStatement(...) NO_OP -#define vasqVLogStatement(...) NO_OP -#define VASQ_ALWAYS(...) NO_OP -#define VASQ_CRITICAL(...) NO_OP -#define VASQ_ERROR(...) NO_OP -#define VASQ_WARNING(...) NO_OP -#define VASQ_INFO(...) NO_OP -#define VASQ_DEBUG(...) NO_OP -#define VASQ_PCRITICAL(...) NO_OP -#define VASQ_PERROR(...) NO_OP -#define VASQ_PWARNING(...) NO_OP -#define vasqRawLog(...) NO_OP -#define vasqVRawLog(...) NO_OP -#define vasqHexDump(...) NO_OP -#define VASQ_HEXDUMP(...) NO_OP - -#endif // VASQ_NO_LOGGING - #ifdef DEBUG #ifdef VASQ_TEST_ASSERT @@ -326,15 +301,10 @@ extern bool _vasq_abort_caught; do { \ _vasq_abort_caught = true; \ } while (0) -#define _VASQ_CLEAR_ABORT() \ - do { \ - _vasq_abort_caught = false; \ - } while (0) #else // VASQ_TEST_ABORT -#define _VASQ_ABORT() abort() -#define _VASQ_CLEAR_ABORT() NO_OP +#define _VASQ_ABORT() abort() #endif // VASQ_TEST_ABORT @@ -344,7 +314,6 @@ extern bool _vasq_abort_caught; */ #define VASQ_ASSERT(logger, expr) \ do { \ - _VASQ_CLEAR_ABORT(); \ if (!(expr)) { \ VASQ_CRITICAL(logger, "Assertion failed: %s", #expr); \ _VASQ_ABORT(); \ @@ -357,4 +326,25 @@ extern bool _vasq_abort_caught; #endif // DEBUG +#else // VASQ_NO_LOGGING + +#define vasqLogStatement(...) NO_OP +#define vasqVLogStatement(...) NO_OP +#define VASQ_ALWAYS(...) NO_OP +#define VASQ_CRITICAL(...) NO_OP +#define VASQ_ERROR(...) NO_OP +#define VASQ_WARNING(...) NO_OP +#define VASQ_INFO(...) NO_OP +#define VASQ_DEBUG(...) NO_OP +#define VASQ_PCRITICAL(...) NO_OP +#define VASQ_PERROR(...) NO_OP +#define VASQ_PWARNING(...) NO_OP +#define vasqRawLog(...) NO_OP +#define vasqVRawLog(...) NO_OP +#define vasqHexDump(...) NO_OP +#define VASQ_HEXDUMP(...) NO_OP +#define VASQ_ASSERT(...) NO_OP + +#endif // VASQ_NO_LOGGING + #endif // VANILLA_SQUAD_LOGGER_H diff --git a/tests/test_safe_snprintf.c b/tests/test_safe_snprintf.c index a8b4e81..4a88832 100644 --- a/tests/test_safe_snprintf.c +++ b/tests/test_safe_snprintf.c @@ -278,6 +278,16 @@ test_snprintf_p(void) SCR_ASSERT_STR_EQ(buffer, "0xdeadbeef"); } +void +test_snprintf_n(void) +{ + unsigned int num; + char buffer[10]; + + SCR_ASSERT_EQ(vasqSafeSnprintf(buffer, sizeof(buffer), "Check%n", &num), 5); + SCR_ASSERT_EQ(num, 5); +} + void test_snprintf_zero_padding(void) { diff --git a/tests/tests.c b/tests/tests.c index 97000d4..985838a 100644 --- a/tests/tests.c +++ b/tests/tests.c @@ -28,6 +28,7 @@ M(snprintf_llx) \ M(snprintf_llX) \ M(snprintf_p) \ + M(snprintf_n) \ M(snprintf_zero_padding) \ M(snprintf_space_padding) \ M(inc_snprintf) \ From 7f6f12a0ba00d76bacf2a5b0761c4c935ba93808 Mon Sep 17 00:00:00 2001 From: Daniel Walker Date: Sun, 19 Mar 2023 20:04:27 -0400 Subject: [PATCH 3/6] handlers now take the log level as an argument --- README.md | 36 +++++++++++++++++++++--------------- include/vasq/logger.h | 3 ++- source/logger.c | 10 ++++++---- tests/test_logger.c | 28 ++++++++++++++++++++++++---- 4 files changed, 53 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 39b0836..2998d9b 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,20 @@ vasqSafeSnprintf(buffer, size, "%2x", 10); // " a" Logging ======= +The available logging levels are + +```c +typedef enum vasqLogLevel { + VASQ_LL_NONE = -1, + VASQ_LL_ALWAYS, + VASQ_LL_CRITICAL, + VASQ_LL_ERROR, + VASQ_LL_WARNING, + VASQ_LL_INFO, + VASQ_LL_DEBUG, +} vasqLogLevel; +``` + Handlers -------- @@ -70,7 +84,7 @@ Every logger need a handler: ```c typedef void -vasqHandlerFunc(void *user, const char *text, size_t size); +vasqHandlerFunc(void *user, vasqLogLevel level, const char *text, size_t size); typedef void vasqHandlerCleanup(void *user); @@ -82,7 +96,7 @@ typedef struct vasqHandler { } vasqHandler; ``` -Whenever a log message is generated, the handler's `func` is called with the handler's `user` as the first argument, the message as the second, and the length of the message as the third. `text` will actually be null-terminated but `size` saves you from having to determine it yourself. +Whenever a log message is generated, the handler's `func` is called with the handler's `user` as the first argument, the log level as the second, the message as the third, and the length of the message as the fourth. `text` will actually be null-terminated but `size` saves you from having to determine it yourself. Since you'll often want to write logging messages to a file descriptor, you can use @@ -120,21 +134,11 @@ vasqLoggerCreate( This function returns the logger if successful. Otherwise, `NULL` is returned and `errno` is set. -The available logging levels are - -- `VASQ_LL_NONE` -- `VASQ_LL_ALWAYS` -- `VASQ_LL_CRITICAL` -- `VASQ_LL_ERROR` -- `VASQ_LL_WARNING` -- `VASQ_LL_INFO` -- `VASQ_LL_DEBUG` - `vasqLoggerOptions` is defined by ```c typedef void -vasqDataProcessor(void *user, size_t idx, vasqLogLevel levcel, char **dst, size_t *remaining); +vasqDataProcessor(void *user, size_t idx, vasqLogLevel level, char **dst, size_t *remaining); typedef struct vasqLoggerOptions { vasqLoggerDataProcessor *processor; // The processor to be used for %x format tokens. @@ -208,9 +212,11 @@ void vasqVRawLog(const vasqLogger *logger, const char *format, va_list args); ``` +When performing raw logging, a level of `VASQ_LL_NONE` will be passed to the handler's function. + If the logger's level is set to `VASQ_LL_NONE`, then all logging functions, including the raw logging functions, will do nothing. Passing `NULL` as the logger to the logging functions also results in nothing happening (NOT an error). -Logging messages are emitted in a signal-safe manner. In addition, logging preserves the value of `errno`. +Logging preserves the value of `errno`. Hex dumping ----------- @@ -228,7 +234,7 @@ Outputs: 0000 54 68 69 73 20 69 73 20 61 20 62 6f 72 69 6e 67 This is a boring 0010 20 73 65 6e 74 65 6e 63 65 20 74 68 61 74 20 6e sentence that n 0020 6f 20 6f 6e 65 20 63 61 72 65 73 20 61 62 6f 75 o one cares abou - 0030 74 2e 00 + 0030 74 2e 00 t.. */ ``` diff --git a/include/vasq/logger.h b/include/vasq/logger.h index 31d5ef8..bbb4aa6 100644 --- a/include/vasq/logger.h +++ b/include/vasq/logger.h @@ -59,11 +59,12 @@ typedef struct vasqLogger vasqLogger; * @brief Function type outputting log messages. * * @param user User-provided data. + * @param level The level of the message. * @param text The message to be printed. * @param size The number of non-null characters in the message. */ typedef void -vasqHandlerFunc(void *user, const char *text, size_t size); +vasqHandlerFunc(void *user, vasqLogLevel level, const char *text, size_t size); /** * @brief Function type for cleaning up a handler. diff --git a/source/logger.c b/source/logger.c index 06eb279..98d717b 100644 --- a/source/logger.c +++ b/source/logger.c @@ -214,10 +214,12 @@ logToBuffer(const vasqLogger *logger, vasqLogLevel level, VASQ_CONTEXT_DECL, cha } static void -writeToFd(void *user, const char *text, size_t size) +writeToFd(void *user, vasqLogLevel level, const char *text, size_t size) { int fd = (intptr_t)user; + (void)level; + if (write(fd, text, size) < 0) { NO_OP; } @@ -369,7 +371,7 @@ vasqVLogStatement(const vasqLogger *logger, vasqLogLevel level, VASQ_CONTEXT_DEC remote_errno = errno; vlogToBuffer(logger, level, file_name, function_name, line_no, &dst, &remaining, format, args); - logger->handler.func(logger->handler.user, output, dst - output); + logger->handler.func(logger->handler.user, level, output, dst - output); errno = remote_errno; } @@ -396,7 +398,7 @@ vasqVRawLog(const vasqLogger *logger, const char *format, va_list args) remote_errno = errno; written = vasqSafeVsnprintf(output, sizeof(output), format, args); - logger->handler.func(logger->handler.user, output, written); + logger->handler.func(logger->handler.user, VASQ_LL_NONE, output, written); errno = remote_errno; } @@ -457,7 +459,7 @@ vasqHexDump(const vasqLogger *logger, VASQ_CONTEXT_DECL, const char *name, const (size - actual_dump_size == 1) ? "" : "s"); } - logger->handler.func(logger->handler.user, output, dst - output); + logger->handler.func(logger->handler.user, dump_level, output, dst - output); errno = remote_errno; #undef NUM_HEXDUMP_LINES diff --git a/tests/test_logger.c b/tests/test_logger.c index fa2c743..fdab4ab 100644 --- a/tests/test_logger.c +++ b/tests/test_logger.c @@ -26,10 +26,12 @@ test_logger_null_logger(void) } static void -handler_func(void *user, const char *text, size_t size) +handler_func(void *user, vasqLogLevel level, const char *text, size_t size) { int *num_ptr = user; + SCR_ASSERT_EQ(level, VASQ_LL_INFO); + SCR_ASSERT_STR_EQ(text, "Check"); SCR_ASSERT_EQ(size, 5); @@ -75,10 +77,12 @@ test_logger_handler_no_func(void) } static void -write_to_ctx(void *user, const char *text, size_t size) +write_to_ctx(void *user, vasqLogLevel level, const char *text, size_t size) { struct test_ctx *ctx = user; + (void)level; + memset(ctx, 0, sizeof(*ctx)); size = MIN(size, sizeof(ctx->buffer) - 1); memcpy(ctx->buffer, text, size); @@ -510,13 +514,29 @@ test_logger_percent(void) vasqLoggerFree(logger); } +static void +raw_handler(void *user, vasqLogLevel level, const char *text, size_t size) +{ + SCR_ASSERT_EQ(level, VASQ_LL_NONE); + + write_to_ctx(user, level, text, size); +} + +static vasqLogger * +create_raw_logger(struct test_ctx *ctx) +{ + vasqHandler handler = {.func = raw_handler, .user = ctx}; + + return vasqLoggerCreate(VASQ_LL_INFO, "%L: %M", &handler, NULL); +} + void test_logger_raw(void) { struct test_ctx ctx; vasqLogger *logger; - SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%L: %M", NULL), NULL); + SCR_ASSERT_PTR_NEQ(logger = create_raw_logger(&ctx), NULL); vasqRawLog(logger, "Check: %i", 5); SCR_ASSERT_STR_EQ(ctx.buffer, "Check: 5"); @@ -539,7 +559,7 @@ test_logger_vraw(void) struct test_ctx ctx; vasqLogger *logger; - SCR_ASSERT_PTR_NEQ(logger = create_logger(&ctx, VASQ_LL_INFO, "%L: %M", NULL), NULL); + SCR_ASSERT_PTR_NEQ(logger = create_raw_logger(&ctx), NULL); do_vraw(logger, "Check: %i", 5); SCR_ASSERT_STR_EQ(ctx.buffer, "Check: 5"); From 553efcea987e6f1d3ecd97215c88c52b25ad2070 Mon Sep 17 00:00:00 2001 From: Daniel Walker Date: Sun, 19 Mar 2023 22:59:47 -0400 Subject: [PATCH 4/6] added doxygen-generated files --- Doxyfile | 2658 +++++++++++++++++ docs/annotated.html | 82 + docs/bc_s.png | Bin 0 -> 676 bytes docs/bdwn.png | Bin 0 -> 147 bytes docs/classes.html | 82 + docs/closed.png | Bin 0 -> 132 bytes docs/config_8h_source.html | 111 + docs/definitions_8h_source.html | 116 + .../dir_d44c64559bbebec7f509842c48db8b23.html | 84 + .../dir_f3074b12e0bf97819355b918cee2d36c.html | 93 + docs/doc.png | Bin 0 -> 746 bytes docs/doxygen.css | 1793 +++++++++++ docs/doxygen.svg | 26 + docs/dynsections.js | 121 + docs/files.html | 87 + docs/folderclosed.png | Bin 0 -> 616 bytes docs/folderopen.png | Bin 0 -> 597 bytes docs/functions.html | 90 + docs/functions_vars.html | 90 + docs/globals.html | 187 ++ docs/globals_defs.html | 104 + docs/globals_enum.html | 77 + docs/globals_eval.html | 95 + docs/globals_func.html | 116 + docs/globals_type.html | 92 + docs/graph_legend.dot | 23 + docs/graph_legend.html | 136 + docs/index.html | 332 ++ docs/jquery.js | 35 + docs/logger_8h.html | 868 ++++++ docs/logger_8h__incl.dot | 21 + docs/logger_8h_source.html | 295 ++ docs/menu.js | 51 + docs/menudata.js | 42 + docs/nav_f.png | Bin 0 -> 153 bytes docs/nav_g.png | Bin 0 -> 95 bytes docs/nav_h.png | Bin 0 -> 98 bytes docs/open.png | Bin 0 -> 123 bytes docs/placeholder_8h.html | 95 + docs/placeholder_8h__incl.dot | 11 + docs/placeholder_8h_source.html | 111 + docs/safe__snprintf_8h.html | 221 ++ docs/safe__snprintf_8h__incl.dot | 13 + docs/safe__snprintf_8h_source.html | 106 + docs/search/all_0.html | 37 + docs/search/all_0.js | 4 + docs/search/all_1.html | 37 + docs/search/all_1.js | 5 + docs/search/all_2.html | 37 + docs/search/all_2.js | 4 + docs/search/all_3.html | 37 + docs/search/all_3.js | 4 + docs/search/all_4.html | 37 + docs/search/all_4.js | 5 + docs/search/all_5.html | 37 + docs/search/all_5.js | 4 + docs/search/all_6.html | 37 + docs/search/all_6.js | 4 + docs/search/all_7.html | 37 + docs/search/all_7.js | 41 + docs/search/classes_0.html | 37 + docs/search/classes_0.js | 5 + docs/search/close.svg | 31 + docs/search/defines_0.html | 37 + docs/search/defines_0.js | 13 + docs/search/enums_0.html | 37 + docs/search/enums_0.js | 4 + docs/search/enumvalues_0.html | 37 + docs/search/enumvalues_0.js | 10 + docs/search/files_0.html | 37 + docs/search/files_0.js | 4 + docs/search/files_1.html | 37 + docs/search/files_1.js | 4 + docs/search/files_2.html | 37 + docs/search/files_2.js | 4 + docs/search/functions_0.html | 37 + docs/search/functions_0.js | 17 + docs/search/mag_sel.svg | 74 + docs/search/nomatches.html | 13 + docs/search/pages_0.html | 37 + docs/search/pages_0.js | 4 + docs/search/search.css | 257 ++ docs/search/search.js | 816 +++++ docs/search/search_l.png | Bin 0 -> 567 bytes docs/search/search_m.png | Bin 0 -> 158 bytes docs/search/search_r.png | Bin 0 -> 553 bytes docs/search/searchdata.js | 42 + docs/search/typedefs_0.html | 37 + docs/search/typedefs_0.js | 9 + docs/search/variables_0.html | 37 + docs/search/variables_0.js | 4 + docs/search/variables_1.html | 37 + docs/search/variables_1.js | 5 + docs/search/variables_2.html | 37 + docs/search/variables_2.js | 4 + docs/search/variables_3.html | 37 + docs/search/variables_3.js | 4 + docs/splitbar.png | Bin 0 -> 314 bytes docs/structvasqLoggerHandler.html | 144 + docs/structvasqLoggerOptions.html | 145 + docs/sync_off.png | Bin 0 -> 853 bytes docs/sync_on.png | Bin 0 -> 845 bytes docs/tab_a.png | Bin 0 -> 142 bytes docs/tab_b.png | Bin 0 -> 169 bytes docs/tab_h.png | Bin 0 -> 177 bytes docs/tab_s.png | Bin 0 -> 184 bytes docs/tabs.css | 1 + include/vasq/config.h | 34 +- include/vasq/definitions.h | 8 - include/vasq/logger.h | 47 +- source/logger.c | 24 +- 111 files changed, 11009 insertions(+), 67 deletions(-) create mode 100644 Doxyfile create mode 100644 docs/annotated.html create mode 100644 docs/bc_s.png create mode 100644 docs/bdwn.png create mode 100644 docs/classes.html create mode 100644 docs/closed.png create mode 100644 docs/config_8h_source.html create mode 100644 docs/definitions_8h_source.html create mode 100644 docs/dir_d44c64559bbebec7f509842c48db8b23.html create mode 100644 docs/dir_f3074b12e0bf97819355b918cee2d36c.html create mode 100644 docs/doc.png create mode 100644 docs/doxygen.css create mode 100644 docs/doxygen.svg create mode 100644 docs/dynsections.js create mode 100644 docs/files.html create mode 100644 docs/folderclosed.png create mode 100644 docs/folderopen.png create mode 100644 docs/functions.html create mode 100644 docs/functions_vars.html create mode 100644 docs/globals.html create mode 100644 docs/globals_defs.html create mode 100644 docs/globals_enum.html create mode 100644 docs/globals_eval.html create mode 100644 docs/globals_func.html create mode 100644 docs/globals_type.html create mode 100644 docs/graph_legend.dot create mode 100644 docs/graph_legend.html create mode 100644 docs/index.html create mode 100644 docs/jquery.js create mode 100644 docs/logger_8h.html create mode 100644 docs/logger_8h__incl.dot create mode 100644 docs/logger_8h_source.html create mode 100644 docs/menu.js create mode 100644 docs/menudata.js create mode 100644 docs/nav_f.png create mode 100644 docs/nav_g.png create mode 100644 docs/nav_h.png create mode 100644 docs/open.png create mode 100644 docs/placeholder_8h.html create mode 100644 docs/placeholder_8h__incl.dot create mode 100644 docs/placeholder_8h_source.html create mode 100644 docs/safe__snprintf_8h.html create mode 100644 docs/safe__snprintf_8h__incl.dot create mode 100644 docs/safe__snprintf_8h_source.html create mode 100644 docs/search/all_0.html create mode 100644 docs/search/all_0.js create mode 100644 docs/search/all_1.html create mode 100644 docs/search/all_1.js create mode 100644 docs/search/all_2.html create mode 100644 docs/search/all_2.js create mode 100644 docs/search/all_3.html create mode 100644 docs/search/all_3.js create mode 100644 docs/search/all_4.html create mode 100644 docs/search/all_4.js create mode 100644 docs/search/all_5.html create mode 100644 docs/search/all_5.js create mode 100644 docs/search/all_6.html create mode 100644 docs/search/all_6.js create mode 100644 docs/search/all_7.html create mode 100644 docs/search/all_7.js create mode 100644 docs/search/classes_0.html create mode 100644 docs/search/classes_0.js create mode 100644 docs/search/close.svg create mode 100644 docs/search/defines_0.html create mode 100644 docs/search/defines_0.js create mode 100644 docs/search/enums_0.html create mode 100644 docs/search/enums_0.js create mode 100644 docs/search/enumvalues_0.html create mode 100644 docs/search/enumvalues_0.js create mode 100644 docs/search/files_0.html create mode 100644 docs/search/files_0.js create mode 100644 docs/search/files_1.html create mode 100644 docs/search/files_1.js create mode 100644 docs/search/files_2.html create mode 100644 docs/search/files_2.js create mode 100644 docs/search/functions_0.html create mode 100644 docs/search/functions_0.js create mode 100644 docs/search/mag_sel.svg create mode 100644 docs/search/nomatches.html create mode 100644 docs/search/pages_0.html create mode 100644 docs/search/pages_0.js create mode 100644 docs/search/search.css create mode 100644 docs/search/search.js create mode 100644 docs/search/search_l.png create mode 100644 docs/search/search_m.png create mode 100644 docs/search/search_r.png create mode 100644 docs/search/searchdata.js create mode 100644 docs/search/typedefs_0.html create mode 100644 docs/search/typedefs_0.js create mode 100644 docs/search/variables_0.html create mode 100644 docs/search/variables_0.js create mode 100644 docs/search/variables_1.html create mode 100644 docs/search/variables_1.js create mode 100644 docs/search/variables_2.html create mode 100644 docs/search/variables_2.js create mode 100644 docs/search/variables_3.html create mode 100644 docs/search/variables_3.js create mode 100644 docs/splitbar.png create mode 100644 docs/structvasqLoggerHandler.html create mode 100644 docs/structvasqLoggerOptions.html create mode 100644 docs/sync_off.png create mode 100644 docs/sync_on.png create mode 100644 docs/tab_a.png create mode 100644 docs/tab_b.png create mode 100644 docs/tab_h.png create mode 100644 docs/tab_s.png create mode 100644 docs/tabs.css diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..c54235d --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2658 @@ +# Doxyfile 1.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Vanilla Squad" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = "7.0.0" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Library containing various C utilities such as logging" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 0 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = README.md include/vasq + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to +# YES then doxygen will add the directory of each input to the include path. +# The default value is: YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = . + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: +# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /