nanocoat/include/sjme/comparator.h

   1 /* -*- Mode: C; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // -------------------------------------------------------------------------*/
   9
  10 /**
  11  * Compares values.
  12  *
  13  * @since 2024/01/03
  14  */
  15
  16 #ifndef SQUIRRELJME_COMPARATOR_H
  17 #define SQUIRRELJME_COMPARATOR_H
  18
  19 #include "sjme/stdTypes.h"
  20 #include "sjme/tokenUtils.h"
  21
  22 /* Anti-C++. */
  23 #ifdef __cplusplus
  24         #ifndef SJME_CXX_IS_EXTERNED
  25                 #define SJME_CXX_IS_EXTERNED
  26                 #define SJME_CXX_SQUIRRELJME_COMPARATOR_H
  27 extern "C" {
  28         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  29 #endif     /* #ifdef __cplusplus */
  30
  31 /*--------------------------------------------------------------------------*/
  32
  33 /**
  34  * A generic comparator.
  35  *
  36  * @param a The first item.
  37  * @param b The second item.
  38  * @param elementSize The size of each element.
  39  * @return The resultant comparison, will be zero, negative, or positive.
  40  * @since 2024/01/03
  41  */
  42 typedef sjme_jint (*sjme_comparator)(sjme_cpointer a, sjme_cpointer b,
  43         int elementSize);
  44
  45 /**
  46  * Determines the name of a given comparator.
  47  *
  48  * @param type The type to use.
  49  * @param numPointerStars The number of pointer stars used.
  50  * @since 2024/01/03
  51  */
  52 #define SJME_COMPARATOR(type, numPointerStars) \
  53         SJME_TOKEN_PASTE_PP(sjme_comparator_, SJME_TOKEN_PASTE_PP(type, \
  54         SJME_TOKEN_SINGLE(SJME_TOKEN_STARS_C##numPointerStars)))
  55
  56 /**
  57  * Determines the name of a given comparator.
  58  *
  59  * @param type The type to use.
  60  * @param numPointerStars The number of pointer stars used.
  61  * @since 2024/01/03
  62  */
  63 #define SJME_COMPARATOR_INSENSITIVE(type, numPointerStars) \
  64         SJME_TOKEN_PASTE_PP(sjme_comparator_insensitive_, \
  65         SJME_TOKEN_PASTE_PP(type, \
  66         SJME_TOKEN_SINGLE(SJME_TOKEN_STARS_C##numPointerStars)))
  67
  68 /**
  69  * Defines a generic comparator, using a simple subtraction.
  70  *
  71  * @param type The type to compare.
  72  * @param numPointerStars The number of pointer stars.
  73  * @since 2024/01/03
  74  */
  75 #define SJME_COMPARATOR_GENERIC(type, numPointerStars) \
  76         static sjme_inline sjme_attrArtificial sjme_jint \
  77                 SJME_COMPARATOR(type, numPointerStars)( \
  78                 sjme_cpointer a, sjme_cpointer b, int elementSize) \
  79         { \
  80                 return (sjme_jint)(*((const type*)b) - *((const type*)a)); \
  81         }
  82
  83 /** Generic @c sjme_jbyte comparator. */
  84 SJME_COMPARATOR_GENERIC(sjme_jbyte, 0)
  85
  86 /** Generic @c sjme_jubyte comparator. */
  87 SJME_COMPARATOR_GENERIC(sjme_jubyte, 0)
  88
  89 /** Generic @c sjme_jshort comparator. */
  90 SJME_COMPARATOR_GENERIC(sjme_jshort, 0)
  91
  92 /** Generic @c sjme_jchar comparator. */
  93 SJME_COMPARATOR_GENERIC(sjme_jchar, 0)
  94
  95 /** Generic @c sjme_jint comparator. */
  96 SJME_COMPARATOR_GENERIC(sjme_jint, 0)
  97
  98 /** Generic @c sjme_juint comparator. */
  99 SJME_COMPARATOR_GENERIC(sjme_juint, 0)
 100
 101 /** Generic @c sjme_cchar comparator. */
 102 SJME_COMPARATOR_GENERIC(sjme_cchar, 0)
 103
 104 /**
 105  * Compares two @c sjme_lpcstr .
 106  *
 107  * @param a The first item.
 108  * @param b The second item.
 109  * @param elementSize The size of each element.
 110  * @return The resultant comparison, will be zero, negative, or positive.
 111  * @since 2024/01/03
 112  */
 113 sjme_jint SJME_COMPARATOR(sjme_lpcstr, 0)(sjme_cpointer a, sjme_cpointer b,
 114         int elementSize);
 115
 116 /**
 117  * Compares two @c sjme_lpcstr without regards to case.
 118  *
 119  * @param a The first item.
 120  * @param b The second item.
 121  * @param elementSize The size of each element.
 122  * @return The resultant comparison, will be zero, negative, or positive.
 123  * @since 2024/01/03
 124  */
 125 sjme_jint SJME_COMPARATOR_INSENSITIVE(sjme_lpcstr, 0)(
 126         sjme_cpointer a, sjme_cpointer b, int elementSize);
 127
 128 /*--------------------------------------------------------------------------*/
 129
 130 /* Anti-C++. */
 131 #ifdef __cplusplus
 132         #ifdef SJME_CXX_SQUIRRELJME_COMPARATOR_H
 133 }
 134                 #undef SJME_CXX_SQUIRRELJME_COMPARATOR_H
 135                 #undef SJME_CXX_IS_EXTERNED
 136         #endif /* #ifdef SJME_CXX_SQUIRRELJME_COMPARATOR_H */
 137 #endif     /* #ifdef __cplusplus */
 138
 139 #endif /* SQUIRRELJME_COMPARATOR_H */