4ac318667b
This change adds a new method to the class that allows checking whether a given class is a subclass of the base class. The new rule states that the private data size of the subclass must be larger than that of the base class.
242 lines
7.9 KiB
C
242 lines
7.9 KiB
C
/**
|
|
* @copyright (c) 2023-2024, MR Development Team
|
|
*
|
|
* @license SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* @date 2023-10-20 MacRsh First version
|
|
*/
|
|
|
|
#ifndef __MR_SERVICE_H__
|
|
#define __MR_SERVICE_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/**
|
|
* @addtogroup Service-Macros
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief This macro function aligns a value upwards.
|
|
*
|
|
* @param _value The value to align.
|
|
* @param _align The alignment.
|
|
*
|
|
* @return The aligned value.
|
|
*/
|
|
#define MR_ALIGN_UP(_value, _align) (((_value) + (_align) - 1) & ~((_align) - 1))
|
|
|
|
/**
|
|
* @brief This macro function aligns a value downwards.
|
|
*
|
|
* @param _value The value to align.
|
|
* @param _align The alignment.
|
|
*
|
|
* @return The aligned value.
|
|
*/
|
|
#define MR_ALIGN_DOWN(_value, _align) ((_value) & ~((_align) - 1))
|
|
|
|
/**
|
|
* @brief This macro function gets the number of elements in an array.
|
|
*
|
|
* @param _array The array.
|
|
*
|
|
* @return The number of elements in the array.
|
|
*
|
|
* @note The array must be an array, not a pointer.
|
|
*/
|
|
#define MR_ARRAY_NUM(_array) (sizeof(_array) / sizeof((_array)[0]))
|
|
|
|
/**
|
|
* @brief This macro function checks if a value is set.
|
|
*
|
|
* @param _value The value to check.
|
|
* @param _mask The mask to check.
|
|
*/
|
|
#define MR_BIT_IS_SET(_value, _mask) (((_value) & (_mask)) == (_mask))
|
|
|
|
/**
|
|
* @brief This macro function sets a value.
|
|
*
|
|
* @param _value The value to set.
|
|
* @param _mask The mask to set.
|
|
*/
|
|
#define MR_BIT_SET(_value, _mask) ((_value) |= (_mask))
|
|
|
|
/**
|
|
* @brief This macro function clears a value.
|
|
*
|
|
* @param _value The value to clear.
|
|
* @param _mask The mask to clear.
|
|
*/
|
|
#define MR_BIT_CLR(_value, _mask) ((_value) &= ~(_mask))
|
|
|
|
/**
|
|
* @brief This macro function gets the maximum of two values.
|
|
*
|
|
* @param _type The type of the value.
|
|
* @param _a The first value.
|
|
* @param _b The second value.
|
|
*
|
|
* @return The maximum of the two values.
|
|
*/
|
|
#define MR_MAX(_type, _a, _b) \
|
|
((_type){(_a)} > (_type){(_b)} ? (_type){(_a)} : (_type){(_b)})
|
|
|
|
/**
|
|
* @brief This macro function gets the minimum of two values.
|
|
*
|
|
* @param _type The type of the value.
|
|
* @param _a The first value.
|
|
* @param _b The second value.
|
|
*
|
|
* @return The minimum of the two values.
|
|
*/
|
|
#define MR_MIN(_type, _a, _b) \
|
|
((_type){(_a)} < (_type){(_b)} ? (_type){(_a)} : (_type){(_b)})
|
|
|
|
/**
|
|
* @brief This macro function ensures that a value is within a specified range.
|
|
*
|
|
* @param _value The value.
|
|
* @param _min The minimum value.
|
|
* @param _max The maximum value.
|
|
*
|
|
* @return The value within the specified range.
|
|
*/
|
|
#define MR_CLAMP(_type, _value, _min, _max) \
|
|
(MR_MAX(_type, MR_MIN(_type, _value, _max), _min))
|
|
|
|
/**
|
|
* @brief This macro function swaps two values.
|
|
*
|
|
* @param _type The type of the value.
|
|
* @param _a The first value.
|
|
* @param _b The second value.
|
|
*/
|
|
#define MR_SWAP(_type, _a, _b) \
|
|
do \
|
|
{ \
|
|
_type __a = (_a); \
|
|
(_a) = (_b); \
|
|
(_b) = __a; \
|
|
} while (0)
|
|
|
|
/**
|
|
* @brief This macro function concatenates two strings.
|
|
*
|
|
* @param _a The first string.
|
|
* @param _b The second string.
|
|
*
|
|
* @return The concatenated string.
|
|
*/
|
|
#define MR_CONCAT(_a, _b) _a##_b
|
|
|
|
/**
|
|
* @brief This macro function converts an integer to a string.
|
|
*
|
|
* @param _a The integer to convert.
|
|
*
|
|
* @return The string representation of the integer.
|
|
*/
|
|
#define MR_STR(_a) #_a
|
|
|
|
/**
|
|
* @brief This macro function gets its structure from its member.
|
|
*
|
|
* @param _ptr The pointer to the structure.
|
|
* @param _type The type of the structure.
|
|
* @param _member The member of the structure.
|
|
*
|
|
* @return A pointer to the structure.
|
|
*/
|
|
#define MR_CONTAINER_OF(_ptr, _type, _member) \
|
|
((_type *)((char *)(_ptr) - (uintptr_t)(&((_type *)0)->_member)))
|
|
|
|
/**
|
|
* @brief This macro function creates a local variable.
|
|
*
|
|
* @param _type The type of the variable.
|
|
* @param ... The arguments.
|
|
*
|
|
* @return A pointer to the variable.
|
|
*
|
|
* @note The variable is local, please use it carefully.
|
|
*/
|
|
#define MR_LOCAL_MAKE(_type, ...) (&((_type){__VA_ARGS__}))
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Log
|
|
* @{
|
|
*/
|
|
|
|
#define MR_LOG_TAG ("null")
|
|
#define __MR_LOG_PRINTF(_tag, _fmt, ...) \
|
|
do \
|
|
{ \
|
|
if (strcmp(_tag, "null") != 0) \
|
|
{ \
|
|
printf(_fmt, ##__VA_ARGS__); \
|
|
} \
|
|
} while (0)
|
|
#ifdef MR_USE_LOG_ERROR
|
|
#define MR_LOG_E(_fmt, ...) \
|
|
__MR_LOG_PRINTF(MR_LOG_TAG, "[E/%s] "_fmt, MR_LOG_TAG, ##__VA_ARGS__) /**< Error log */
|
|
#else
|
|
#define MR_LOG_E(_fmt, ...)
|
|
#endif /* MR_USE_LOG_ERROR */
|
|
#ifdef MR_USE_LOG_WARN
|
|
#define MR_LOG_W(_fmt, ...) \
|
|
__MR_LOG_PRINTF(MR_LOG_TAG, "[W/%s] "_fmt, MR_LOG_TAG, ##__VA_ARGS__) /**< Warning log */
|
|
#else
|
|
#define MR_LOG_W(_fmt, ...)
|
|
#endif /* MR_USE_LOG_WARN */
|
|
#ifdef MR_USE_LOG_INFO
|
|
#define MR_LOG_I(_fmt, ...) \
|
|
__MR_LOG_PRINTF(MR_LOG_TAG, "[I/%s] "_fmt, MR_LOG_TAG, ##__VA_ARGS__) /**< Information log */
|
|
#else
|
|
#define MR_LOG_I(_fmt, ...)
|
|
#endif /* MR_USE_LOG_INFO */
|
|
#ifdef MR_USE_LOG_DEBUG
|
|
#define MR_LOG_D(_fmt, ...) \
|
|
__MR_LOG_PRINTF(MR_LOG_TAG, "[D/%s] "_fmt, MR_LOG_TAG, ##__VA_ARGS__) /**< Debug log */
|
|
#else
|
|
#define MR_LOG_D(_fmt, ...)
|
|
#endif /* MR_USE_LOG_DEBUG */
|
|
#ifdef MR_USE_LOG_ASSERT
|
|
#define MR_ASSERT(_cond) \
|
|
do \
|
|
{ \
|
|
if (!(_cond)) \
|
|
{ \
|
|
__MR_LOG_PRINTF("Assert", "[A/%s] Assertion failed: %s, %s, %d.\r\n", __FUNCTION__, \
|
|
#_cond, __FILE__, __LINE__); \
|
|
while (1); \
|
|
} \
|
|
} while (0)
|
|
#else
|
|
#define MR_ASSERT(_cond)
|
|
#endif /* MR_USE_LOG_ASSERT */
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Interrupt
|
|
* @{
|
|
*/
|
|
|
|
size_t mr_irq_disable(void);
|
|
void mr_irq_enable(size_t mask);
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* __MR_SERVICE_H__ */
|