ucx: comparison src/cx/common.h

-:8a35119d1f01
+:bcbf6bf582fa
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 /**
-* \file common.h
+* @file common.h
 *
-* \brief Common definitions and feature checks.
+* @brief Common definitions and feature checks.
 *
-* \author Mike Becker
+* @author Mike Becker
-* \author Olaf Wintermann
+* @author Olaf Wintermann
-* \copyright 2-Clause BSD License
+* @copyright 2-Clause BSD License
 *
-* \mainpage UAP Common Extensions
+* @mainpage UAP Common Extensions
 * Library with common and useful functions, macros and data structures.
 * <p>
 * Latest available source:<br>
 * <a href="https://sourceforge.net/projects/ucx/files/">https://sourceforge.net/projects/ucx/files/</a>
 * </p>
 // ---------------------------------------------------------------------------
 //       Architecture Detection
 // ---------------------------------------------------------------------------
+#ifndef INTPTR_MAX
+#error Missing INTPTR_MAX definition
+#endif
 #if INTPTR_MAX == INT64_MAX
 /**
 * The address width in bits on this platform.
 */
 #define CX_WORDSIZE 64
 //       Missing Defines
 // ---------------------------------------------------------------------------
 #ifndef SSIZE_MAX // not defined in glibc since C23 and MSVC
 #if CX_WORDSIZE == 64
+/**
+* The maximum representable value in ssize_t.
+*/
 #define SSIZE_MAX 0x7fffffffffffffffll
 #else
 #define SSIZE_MAX 0x7fffffffl
 #endif
 #endif
 #define cx_attr_malloc __attribute__((__malloc__))
 #ifndef __clang__
 /**
 * The pointer returned by the attributed function is supposed to be freed
-* by \p freefunc.
+* by @p freefunc.
 *
 * @param freefunc the function that shall be used to free the memory
-* @param freefunc_arg the index of the pointer argument in \p freefunc
+* @param freefunc_arg the index of the pointer argument in @p freefunc
 */
 #define cx_attr_dealloc(freefunc, freefunc_arg) \
 __attribute__((__malloc__(freefunc, freefunc_arg)))
 #else
 /**
 #define cx_attr_allocsize(...) __attribute__((__alloc_size__(__VA_ARGS__)))
 #ifdef __clang__
 /**
-* No support for \c null_terminated_string_arg in clang or GCC below 14.
+* No support for @c null_terminated_string_arg in clang or GCC below 14.
 */
 #define cx_attr_cstr_arg(idx)
 /**
 * No support for access attribute in clang.
 */
 */
 #define cx_attr_access(mode, ...) __attribute__((__access__(mode, __VA_ARGS__)))
 #endif // __GNUC__ < 10
 #if __GNUC__ < 14
 /**
-* No support for \c null_terminated_string_arg in clang or GCC below 14.
+* No support for @c null_terminated_string_arg in clang or GCC below 14.
 */
 #define cx_attr_cstr_arg(idx)
 #else
 /**
 * The specified argument is expected to be a zero-terminated string.
 typedef size_t (*cx_write_func)(
 const void *,
 size_t,
 size_t,
 void *
-) cx_attr_nonnull;
+);
 /**
 * Function pointer compatible with fread-like functions.
 */
 typedef size_t (*cx_read_func)(
 void *,
 size_t,
 size_t,
 void *
-) cx_attr_nonnull;
+);
 // ---------------------------------------------------------------------------
 //       Utility macros
 // ---------------------------------------------------------------------------
 //       szmul implementation
 // ---------------------------------------------------------------------------
 #if (__GNUC__ >= 5 || defined(__clang__)) && !defined(CX_NO_SZMUL_BUILTIN)
 #define CX_SZMUL_BUILTIN
+#define cx_szmul(a, b, result) __builtin_mul_overflow(a, b, result)
-/**
+#else // no GNUC or clang bultin
-* Alias for \c __builtin_mul_overflow.
+/**
-*
 * Performs a multiplication of size_t values and checks for overflow.
+*
+* @param a (@c size_t) first operand
+* @param b (@c size_t) second operand
+* @param result (@c size_t*) a pointer to a variable, where the result should
+* be stored
+* @retval zero success
+* @retval non-zero the multiplication would overflow
+*/
+#define cx_szmul(a, b, result) cx_szmul_impl(a, b, result)
+/**
+* Implementation of cx_szmul() when no compiler builtin is available.
+*
+* Do not use in application code.
 *
 * @param a first operand
 * @param b second operand
-* @param result a pointer to a size_t, where the result should
+* @param result a pointer to a variable, where the result should
 * be stored
-* @return zero, if no overflow occurred and the result is correct, non-zero
+* @retval zero success
-* otherwise
+* @retval non-zero the multiplication would overflow
-*/
-#define cx_szmul(a, b, result) __builtin_mul_overflow(a, b, result)
-#else // no GNUC or clang bultin
-/**
-* Performs a multiplication of size_t values and checks for overflow.
-*
-* @param a first operand
-* @param b second operand
-* @param result a pointer to a size_t, where the result should
-* be stored
-* @return zero, if no overflow occurred and the result is correct, non-zero
-* otherwise
-*/
-#define cx_szmul(a, b, result) cx_szmul_impl(a, b, result)
-/**
-* Performs a multiplication of size_t values and checks for overflow.
-*
-* This is a custom implementation in case there is no compiler builtin
-* available.
-*
-* @param a first operand
-* @param b second operand
-* @param result a pointer to a size_t where the result should be stored
-* @return zero, if no overflow occurred and the result is correct, non-zero
-* otherwise
 */
 #if __cplusplus
 extern "C"
 #endif
 int cx_szmul_impl(size_t a, size_t b, size_t *result);
 #endif // cx_szmul
 // ---------------------------------------------------------------------------
 //       Fixes for MSVC incompatibilities

Mercurial > hg > ucx / file comparison

comparison: src/cx/common.h

src/cx/common.h