ucx: src/cx/collection.h@475335643af4

increase version number to 3.1

remove per-file version information
from Doxygen output

     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 /**

    52  * A comparator function comparing two collection elements.

    53  */

    54 typedef int(*cx_compare_func)(

    55         void const *left,

    56         void const *right

    57 );

    59 /**

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

    61  */

    62 #define CX_COLLECTION_MEMBERS \

    63     /** \

    64      * The allocator to use. \

    65      */ \

    66     CxAllocator const *allocator; \

    67     /** \

    68      * The comparator function for the elements. \

    69      */ \

    70     cx_compare_func cmpfunc; \

    71     /** \

    72      * The size of each element. \

    73      */ \

    74     size_t item_size; \

    75     /** \

    76      * The number of currently stored elements. \

    77      */ \

    78     size_t size; \

    79     /** \

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

    81      * \

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

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

    84      */ \

    85     cx_destructor_func simple_destructor; \

    86     /** \

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

    88      * \

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

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

    91      */ \

    92     cx_destructor_func2 advanced_destructor; \

    93     /** \

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

    95      */ \

    96     void *destructor_data; \

    97     /** \

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

    99      * instead of copies of the actual objects. \

   100      */ \

   101     bool store_pointer;

   103 /**

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

   105  *

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

   107  * to invoke this macro manually.

   108  *

   109  * @param c the collection

   110  * @param e the element

   111  */

   112 #define cx_invoke_simple_destructor(c, e) \

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

   115 /**

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

   117  *

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

   119  * to invoke this macro manually.

   120  *

   121  * @param c the collection

   122  * @param e the element

   123  */

   124 #define cx_invoke_advanced_destructor(c, e) \

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

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

   129 /**

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

   131  *

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

   133  * to invoke this macro manually.

   134  *

   135  * @param c the collection

   136  * @param e the element

   137  */

   138 #define cx_invoke_destructor(c, e) \

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

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

   142 #ifdef __cplusplus

   143 } // extern "C"

   144 #endif

   146 #endif // UCX_COLLECTION_H

Mercurial > hg > ucx / file revision