192 lines
6.0 KiB
C
192 lines
6.0 KiB
C
|
/**
|
||
|
|
* \file lwprintf_opt.h
|
||
|
|
* \brief LwPRINTF options
|
||
|
|
*/
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Copyright (c) 2024 Tilen MAJERLE
|
||
|
|
*
|
||
|
|
* Permission is hereby granted, free of charge, to any person
|
||
|
|
* obtaining a copy of this software and associated documentation
|
||
|
|
* files (the "Software"), to deal in the Software without restriction,
|
||
|
|
* including without limitation the rights to use, copy, modify, merge,
|
||
|
|
* publish, distribute, sublicense, and/or sell copies of the Software,
|
||
|
|
* and to permit persons to whom the Software is furnished to do so,
|
||
|
|
* subject to the following conditions:
|
||
|
|
*
|
||
|
|
* The above copyright notice and this permission notice shall be
|
||
|
|
* included in all copies or substantial portions of the Software.
|
||
|
|
*
|
||
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
|
||
|
|
* AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
||
|
|
*
|
||
|
|
* This file is part of LwPRINTF - Lightweight stdio manager library.
|
||
|
|
*
|
||
|
|
* Author: Tilen MAJERLE <tilen@majerle.eu>
|
||
|
|
* Version: v1.0.5
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_OPT_HDR_H
|
||
|
|
#define LWPRINTF_OPT_HDR_H
|
||
|
|
|
||
|
|
/* Uncomment to ignore user options (or set macro in compiler flags) */
|
||
|
|
/* #define LWPRINTF_IGNORE_USER_OPTS */
|
||
|
|
|
||
|
|
/* Include application options */
|
||
|
|
#ifndef LWPRINTF_IGNORE_USER_OPTS
|
||
|
|
#include "lwprintf_opts.h"
|
||
|
|
#endif /* LWPRINTF_IGNORE_USER_OPTS */
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif /* __cplusplus */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \defgroup LWPRINTF_OPT Configuration
|
||
|
|
* \brief LwPRINTF options
|
||
|
|
* \{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` operating system support in the library
|
||
|
|
*
|
||
|
|
* \note When `LWPRINTF_CFG_OS` is enabled, user must implement functions in \ref LWPRINTF_SYS group.
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_OS
|
||
|
|
#define LWPRINTF_CFG_OS 0
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Mutex handle type
|
||
|
|
*
|
||
|
|
* \note This value must be set in case \ref LWPRINTF_CFG_OS is set to `1`.
|
||
|
|
* If data type is not known to compiler, include header file with
|
||
|
|
* definition before you define handle type
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_OS_MUTEX_HANDLE
|
||
|
|
#define LWPRINTF_CFG_OS_MUTEX_HANDLE void*
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` manual mutex lock.
|
||
|
|
*
|
||
|
|
* When this feature is enabled, together with \ref LWPRINTF_CFG_OS, behavior is as following:
|
||
|
|
* - System mutex is kept created during init phase
|
||
|
|
* - Calls to direct printing functions are not thread-safe by default anymore
|
||
|
|
* - Calls to sprintf (buffer functions) are kept thread-safe
|
||
|
|
* - User must manually call \ref lwprintf_protect or \ref lwprintf_protect_ex functions to protect direct printing operation
|
||
|
|
* - User must manually call \ref lwprintf_unprotect or \ref lwprintf_unprotect_ex functions to exit protected area
|
||
|
|
*
|
||
|
|
* \note If you prefer to completely disable locking mechanism with this library,
|
||
|
|
* turn off \ref LWPRINTF_CFG_OS and fully manually handle mutual exclusion for non-reentrant functions
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_OS_MANUAL_PROTECT
|
||
|
|
#define LWPRINTF_CFG_OS_MANUAL_PROTECT 0
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` support for `long long int` type, signed or unsigned.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_SUPPORT_LONG_LONG
|
||
|
|
#define LWPRINTF_CFG_SUPPORT_LONG_LONG 1
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` support for any specifier accepting any kind of integer types.
|
||
|
|
* This is enabling `%d, %b, %u, %o, %i, %x` specifiers
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_SUPPORT_TYPE_INT
|
||
|
|
#define LWPRINTF_CFG_SUPPORT_TYPE_INT 1
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` support `%p` pointer print type
|
||
|
|
*
|
||
|
|
* When enabled, architecture must support `uintptr_t` type, normally available with C11 standard
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_SUPPORT_TYPE_POINTER
|
||
|
|
#define LWPRINTF_CFG_SUPPORT_TYPE_POINTER 1
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` support `%f` float type
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_SUPPORT_TYPE_FLOAT
|
||
|
|
#define LWPRINTF_CFG_SUPPORT_TYPE_FLOAT 1
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` support for `%e` engineering output type for float numbers
|
||
|
|
*
|
||
|
|
* \note \ref LWPRINTF_CFG_SUPPORT_TYPE_FLOAT has to be enabled to use this feature
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_SUPPORT_TYPE_ENGINEERING
|
||
|
|
#define LWPRINTF_CFG_SUPPORT_TYPE_ENGINEERING 1
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` support for `%s` for string output
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_SUPPORT_TYPE_STRING
|
||
|
|
#define LWPRINTF_CFG_SUPPORT_TYPE_STRING 1
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` support for `%k` for hex byte array output
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_SUPPORT_TYPE_BYTE_ARRAY
|
||
|
|
#define LWPRINTF_CFG_SUPPORT_TYPE_BYTE_ARRAY 1
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Specifies default number of precision for floating number
|
||
|
|
*
|
||
|
|
* Represents number of digits to be used after comma if no precision
|
||
|
|
* is set with specifier itself
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_FLOAT_DEFAULT_PRECISION
|
||
|
|
#define LWPRINTF_CFG_FLOAT_DEFAULT_PRECISION 6
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` optional short names for LwPRINTF API functions.
|
||
|
|
*
|
||
|
|
* It adds functions for default instance: `lwprintf`, `lwsnprintf` and others
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_ENABLE_SHORTNAMES
|
||
|
|
#define LWPRINTF_CFG_ENABLE_SHORTNAMES 1
|
||
|
|
#endif /* LWPRINTF_CFG_ENABLE_SHORTNAMES */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Enables `1` or disables `0` C standard API names
|
||
|
|
*
|
||
|
|
* Disabled by default not to interfere with compiler implementation.
|
||
|
|
* Application may need to remove standard C STDIO library from linkage
|
||
|
|
* to be able to properly compile LwPRINTF with this option enabled
|
||
|
|
*/
|
||
|
|
#ifndef LWPRINTF_CFG_ENABLE_STD_NAMES
|
||
|
|
#define LWPRINTF_CFG_ENABLE_STD_NAMES 0
|
||
|
|
#endif /* LWPRINTF_CFG_ENABLE_SHORTNAMES */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \}
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif /* __cplusplus */
|
||
|
|
|
||
|
|
#endif /* LWPRINTF_OPT_HDR_H */
|