Mercurial > hg > dbutils / file diff

--- a/ucx/cx/compare.h	Sun Feb 16 17:38:07 2025 +0100
+++ b/ucx/cx/compare.h	Tue Feb 25 21:12:11 2025 +0100
@@ -26,11 +26,11 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * \file compare.h
- * \brief A collection of simple compare functions.
- * \author Mike Becker
- * \author Olaf Wintermann
- * \copyright 2-Clause BSD License
+ * @file compare.h
+ * @brief A collection of simple compare functions.
+ * @author Mike Becker
+ * @author Olaf Wintermann
+ * @copyright 2-Clause BSD License
  */
 
 #ifndef UCX_COMPARE_H
@@ -56,90 +56,117 @@
  */
 cx_attr_nonnull
 cx_attr_nodiscard
-typedef int(*cx_compare_func)(
-        const void *left,
-        const void *right
+cx_attr_export
+typedef int (*cx_compare_func)(
+    const void *left,
+    const void *right
 );
 
 /**
  * Compares two integers of type int.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to integer one
  * @param i2 pointer to integer two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_int(const void *i1, const void *i2);
 
 /**
- * Compares two ints.
+ * Compares two integers of type int.
  *
  * @param i1 integer one
  * @param i2 integer two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_int(int i1, int i2);
 
 /**
  * Compares two integers of type long int.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to long integer one
  * @param i2 pointer to long integer two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_longint(const void *i1, const void *i2);
 
 /**
- * Compares two long ints.
+ * Compares two integers of type long int.
  *
  * @param i1 long integer one
  * @param i2 long integer two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_longint(long int i1, long int i2);
 
 /**
  * Compares two integers of type long long.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to long long one
  * @param i2 pointer to long long two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_longlong(const void *i1, const void *i2);
 
 /**
- * Compares twolong long ints.
+ * Compares two integers of type long long.
  *
  * @param i1 long long int one
  * @param i2 long long int two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_longlong(long long int i1, long long int i2);
 
 /**
  * Compares two integers of type int16_t.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to int16_t one
  * @param i2 pointer to int16_t two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_int16(const void *i1, const void *i2);
 
 /**
@@ -147,22 +174,29 @@
  *
  * @param i1 int16_t one
  * @param i2 int16_t two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_int16(int16_t i1, int16_t i2);
 
 /**
  * Compares two integers of type int32_t.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to int32_t one
  * @param i2 pointer to int32_t two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_int32(const void *i1, const void *i2);
 
 /**
@@ -170,22 +204,29 @@
  *
  * @param i1 int32_t one
  * @param i2 int32_t two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_int32(int32_t i1, int32_t i2);
 
 /**
  * Compares two integers of type int64_t.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to int64_t one
  * @param i2 pointer to int64_t two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_int64(const void *i1, const void *i2);
 
 /**
@@ -193,91 +234,119 @@
  *
  * @param i1 int64_t one
  * @param i2 int64_t two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_int64(int64_t i1, int64_t i2);
 
 /**
  * Compares two integers of type unsigned int.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to unsigned integer one
  * @param i2 pointer to unsigned integer two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_uint(const void *i1, const void *i2);
 
 /**
- * Compares two unsigned ints.
+ * Compares two integers of type unsigned int.
  *
  * @param i1 unsigned integer one
  * @param i2 unsigned integer two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_uint(unsigned int i1, unsigned int i2);
 
 /**
  * Compares two integers of type unsigned long int.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to unsigned long integer one
  * @param i2 pointer to unsigned long integer two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_ulongint(const void *i1, const void *i2);
 
 /**
- * Compares two unsigned long ints.
+ * Compares two integers of type unsigned long int.
  *
  * @param i1 unsigned long integer one
  * @param i2 unsigned long integer two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_ulongint(unsigned long int i1, unsigned long int i2);
 
 /**
  * Compares two integers of type unsigned long long.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to unsigned long long one
  * @param i2 pointer to unsigned long long two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_ulonglong(const void *i1, const void *i2);
 
 /**
- * Compares two unsigned long long ints.
+ * Compares two integers of type unsigned long long.
  *
  * @param i1 unsigned long long one
  * @param i2 unsigned long long two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_ulonglong(unsigned long long int i1, unsigned long long int i2);
 
 /**
  * Compares two integers of type uint16_t.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to uint16_t one
  * @param i2 pointer to uint16_t two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_uint16(const void *i1, const void *i2);
 
 /**
@@ -285,22 +354,29 @@
  *
  * @param i1 uint16_t one
  * @param i2 uint16_t two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_uint16(uint16_t i1, uint16_t i2);
 
 /**
  * Compares two integers of type uint32_t.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to uint32_t one
  * @param i2 pointer to uint32_t two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_uint32(const void *i1, const void *i2);
 
 /**
@@ -308,22 +384,29 @@
  *
  * @param i1 uint32_t one
  * @param i2 uint32_t two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_uint32(uint32_t i1, uint32_t i2);
 
 /**
  * Compares two integers of type uint64_t.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param i1 pointer to uint64_t one
  * @param i2 pointer to uint64_t two
- * @return -1, if *i1 is less than *i2, 0 if both are equal,
- * 1 if *i1 is greater than *i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_uint64(const void *i1, const void *i2);
 
 /**
@@ -331,22 +414,29 @@
  *
  * @param i1 uint64_t one
  * @param i2 uint64_t two
- * @return -1, if i1 is less than i2, 0 if both are equal,
- * 1 if i1 is greater than i2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_uint64(uint64_t i1, uint64_t i2);
 
 /**
  * Compares two real numbers of type float with precision 1e-6f.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param f1 pointer to float one
  * @param f2 pointer to float two
- * @return -1, if *f1 is less than *f2, 0 if both are equal,
- * 1 if *f1 is greater than *f2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_float(const void *f1, const void *f2);
 
 /**
@@ -354,45 +444,59 @@
  *
  * @param f1 float one
  * @param f2 float two
- * @return -1, if f1 is less than f2, 0 if both are equal,
- * 1 if f1 is greater than f2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_float(float f1, float f2);
 
 /**
  * Compares two real numbers of type double with precision 1e-14.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param d1 pointer to double one
  * @param d2 pointer to double two
- * @return -1, if *d1 is less than *d2, 0 if both are equal,
- * 1 if *d1 is greater than *d2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_double(const void *d1, const void *d2);
 
 /**
- * Convenience function
+ * Compares two real numbers of type double with precision 1e-14.
  *
  * @param d1 double one
  * @param d2 double two
- * @return -1, if d1 is less than d2, 0 if both are equal,
- * 1 if d1 is greater than d2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_double(double d1, double d2);
 
 /**
  * Compares the integer representation of two pointers.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param ptr1 pointer to pointer one (const intptr_t*)
  * @param ptr2 pointer to pointer two (const intptr_t*)
- * @return -1 if *ptr1 is less than *ptr2, 0 if both are equal,
- * 1 if *ptr1 is greater than *ptr2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_intptr(const void *ptr1, const void *ptr2);
 
 /**
@@ -400,22 +504,29 @@
  *
  * @param ptr1 pointer one
  * @param ptr2 pointer two
- * @return -1 if ptr1 is less than ptr2, 0 if both are equal,
- * 1 if ptr1 is greater than ptr2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_intptr(intptr_t ptr1, intptr_t ptr2);
 
 /**
  * Compares the unsigned integer representation of two pointers.
  *
+ * @note the parameters deliberately have type @c void* to be
+ * compatible with #cx_compare_func without the need of a cast.
+ *
  * @param ptr1 pointer to pointer one (const uintptr_t*)
  * @param ptr2 pointer to pointer two (const uintptr_t*)
- * @return -1 if *ptr1 is less than *ptr2, 0 if both are equal,
- * 1 if *ptr1 is greater than *ptr2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_uintptr(const void *ptr1, const void *ptr2);
 
 /**
@@ -423,22 +534,26 @@
  *
  * @param ptr1 pointer one
  * @param ptr2 pointer two
- * @return -1 if ptr1 is less than ptr2, 0 if both are equal,
- * 1 if ptr1 is greater than ptr2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nodiscard
+cx_attr_export
 int cx_vcmp_uintptr(uintptr_t ptr1, uintptr_t ptr2);
 
 /**
- * Compares the pointers specified in the arguments without de-referencing.
+ * Compares the pointers specified in the arguments without dereferencing.
  *
  * @param ptr1 pointer one
  * @param ptr2 pointer two
- * @return -1 if ptr1 is less than ptr2, 0 if both are equal,
- * 1 if ptr1 is greater than ptr2
+ * @retval -1 if the left argument is less than the right argument
+ * @retval 0 if both arguments are equal
+ * @retval 1 if the left argument is greater than the right argument
  */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 int cx_cmp_ptr(const void *ptr1, const void *ptr2);
 
 #ifdef __cplusplus