ucx: src/cx/collection.h@35bcb3216c0d

     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"

    41 #include "compare.h"

    43 #ifdef __cplusplus

    44 extern "C" {

    45 #endif

    47 /**

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

    49  */

    50 #define CX_STORE_POINTERS 0

    52 /**

    53  * Base attributes of a collection.

    54  */

    55 struct cx_collection_s {

    56     /**

    57      * The allocator to use.

    58      */

    59     CxAllocator const *allocator;

    60     /**

    61      * The comparator function for the elements.

    62      */

    63     cx_compare_func cmpfunc;

    64     /**

    65      * The size of each element.

    66      */

    67     size_t elem_size;

    68     /**

    69      * The number of currently stored elements.

    70      */

    71     size_t size;

    72     /**

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

    74      *

    75      * @attention Read the documentation of the particular collection implementation

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

    77      */

    78     cx_destructor_func simple_destructor;

    79     /**

    80      * An optional advanced 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_func2 advanced_destructor;

    86     /**

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

    88      */

    89     void *destructor_data;

    90     /**

    91      * Indicates if this list is supposed to store pointers

    92      * instead of copies of the actual objects.

    93      */

    94     bool store_pointer;

    95 };

    97 /**

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

    99  */

   100 #define CX_COLLECTION_BASE struct cx_collection_s base

   102 /**

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

   104  *

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

   106  * to invoke this macro manually.

   107  *

   108  * @param c the collection

   109  * @param e the element

   110  */

   111 #define cx_invoke_simple_destructor(c, e) \

   112     (c)->base.simple_destructor((c)->base.store_pointer ? (*((void **) (e))) : (e))

   114 /**

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

   116  *

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

   118  * to invoke this macro manually.

   119  *

   120  * @param c the collection

   121  * @param e the element

   122  */

   123 #define cx_invoke_advanced_destructor(c, e) \

   124     (c)->base.advanced_destructor((c)->base.destructor_data, \

   125     (c)->base.store_pointer ? (*((void **) (e))) : (e))

   128 /**

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

   130  *

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

   132  * to invoke this macro manually.

   133  *

   134  * @param c the collection

   135  * @param e the element

   136  */

   137 #define cx_invoke_destructor(c, e) \

   138     if ((c)->base.simple_destructor) cx_invoke_simple_destructor(c,e); \

   139     if ((c)->base.advanced_destructor) cx_invoke_advanced_destructor(c,e)

   141 #ifdef __cplusplus

   142 } // extern "C"

   143 #endif

   145 #endif // UCX_COLLECTION_H

Mercurial > hg > ucx / file revision