ucx: src/cx/collection.h@b0ebb3d88407

     1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

     3  *

     4  * Copyright 2023 Mike Becker, Olaf Wintermann All rights reserved.

     5  *

     6  * Redistribution and use in source and binary forms, with or without

     7  * modification, are permitted provided that the following conditions are met:

     8  *

     9  *   1. Redistributions of source code must retain the above copyright

    10  *      notice, this list of conditions and the following disclaimer.

    11  *

    12  *   2. Redistributions in binary form must reproduce the above copyright

    13  *      notice, this list of conditions and the following disclaimer in the

    14  *      documentation and/or other materials provided with the distribution.

    15  *

    16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

    19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE

    20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

    21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

    23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

    24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

    25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

    26  * POSSIBILITY OF SUCH DAMAGE.

    27  */

    28 /**

    29  * \file collection.h

    30  * \brief Common definitions for various collection implementations.

    31  * \author Mike Becker

    32  * \author Olaf Wintermann

    33  * \copyright 2-Clause BSD License

    34  */

    36 #ifndef UCX_COLLECTION_H

    37 #define UCX_COLLECTION_H

    39 #include "allocator.h"

    40 #include "iterator.h"

    42 #ifdef __cplusplus

    43 extern "C" {

    44 #endif

    46 /**

    47  * Special constant used for creating collections that are storing pointers.

    48  */

    49 #define CX_STORE_POINTERS 0

    51 #ifndef CX_COMPARE_FUNC_DEFINED

    52 #define CX_COMPARE_FUNC_DEFINED

    53 /**

    54  * A comparator function comparing two collection elements.

    55  */

    56 typedef int(*cx_compare_func)(

    57         void const *left,

    58         void const *right

    59 );

    60 #endif // CX_COMPARE_FUNC_DEFINED

    62 /**

    63  * Use this macro to declare common members for a collection structure.

    64  */

    65 #define CX_COLLECTION_MEMBERS \

    66     /** \

    67      * The allocator to use. \

    68      */ \

    69     CxAllocator const *allocator; \

    70     /** \

    71      * The comparator function for the elements. \

    72      */ \

    73     cx_compare_func cmpfunc; \

    74     /** \

    75      * The size of each element. \

    76      */ \

    77     size_t item_size; \

    78     /** \

    79      * The number of currently stored elements. \

    80      */ \

    81     size_t size; \

    82     /** \

    83      * An optional simple destructor for the collection's elements. \

    84      * \

    85      * @attention Read the documentation of the particular collection implementation \

    86      * whether this destructor shall only destroy the contents or also free the memory. \

    87      */ \

    88     cx_destructor_func simple_destructor; \

    89     /** \

    90      * An optional advanced destructor for the collection's elements. \

    91      * \

    92      * @attention Read the documentation of the particular collection implementation \

    93      * whether this destructor shall only destroy the contents or also free the memory. \

    94      */ \

    95     cx_destructor_func2 advanced_destructor; \

    96     /** \

    97      * The pointer to additional data that is passed to the advanced destructor. \

    98      */ \

    99     void *destructor_data; \

   100     /** \

   101      * Indicates if this instance of a collection is supposed to store pointers \

   102      * instead of copies of the actual objects. \

   103      */ \

   104     bool store_pointer;

   106 /**

   107  * Invokes the simple destructor function for a specific element.

   108  *

   109  * Usually only used by collection implementations. There should be no need

   110  * to invoke this macro manually.

   111  *

   112  * @param c the collection

   113  * @param e the element

   114  */

   115 #define cx_invoke_simple_destructor(c, e) \

   116     (c)->simple_destructor((c)->store_pointer ? (*((void **) (e))) : (e))

   118 /**

   119  * Invokes the advanced destructor function for a specific element.

   120  *

   121  * Usually only used by collection implementations. There should be no need

   122  * to invoke this macro manually.

   123  *

   124  * @param c the collection

   125  * @param e the element

   126  */

   127 #define cx_invoke_advanced_destructor(c, e) \

   128     (c)->advanced_destructor((c)->destructor_data, \

   129     (c)->store_pointer ? (*((void **) (e))) : (e))

   132 /**

   133  * Invokes all available destructor functions for a specific element.

   134  *

   135  * Usually only used by collection implementations. There should be no need

   136  * to invoke this macro manually.

   137  *

   138  * @param c the collection

   139  * @param e the element

   140  */

   141 #define cx_invoke_destructor(c, e) \

   142     if ((c)->simple_destructor) cx_invoke_simple_destructor(c,e); \

   143     if ((c)->advanced_destructor) cx_invoke_advanced_destructor(c,e)

   145 #ifdef __cplusplus

   146 } // extern "C"

   147 #endif

   149 #endif // UCX_COLLECTION_H

Mercurial > hg > ucx / file revision