ucx: ucx/ucx.h@311cac04d079

     1 /*

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

     3  *

     4  * Copyright 2013 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  * Main UCX Header providing most common definitions.

    30  *

    31  * @file   ucx.h

    32  * @author Mike Becker

    33  * @author Olaf Wintermann

    34  */

    36 #ifndef UCX_H

    37 #define	UCX_H

    39 #include <stdlib.h>

    41 #ifdef	__cplusplus

    42 #ifndef _Bool

    43 #define _Bool bool

    44 #define restrict

    45 #endif

    46 extern "C" {

    47 #endif

    49 /**

    50  * Function pointer to a compare function.

    51  *

    52  * The compare function shall take three arguments: the two values that shall be

    53  * compared and optional additional data.

    54  * The function shall then return -1 if the first argument is less than the

    55  * second argument, 1 if the first argument is greater than the second argument

    56  * and 0 if both arguments are equal. If the third argument is

    57  * <code>NULL</code>, it shall be ignored.

    58  */

    59 typedef int(*cmp_func)(void*,void*,void*);

    61 /**

    62  * Function pointer to a copy function.

    63  *

    64  * The copy function shall create a copy of the first argument and may use

    65  * additional data provided by the second argument. If the second argument is

    66  * <code>NULL</code>, it shall be ignored.

    68  * <b>Attention:</b> if pointers returned by functions of this type may be

    69  * passed to <code>free()</code> depends on the implementation of the

    70  * respective <code>copy_func</code>.

    71  */

    72 typedef void*(*copy_func)(void*,void*);

    74 /**

    75  * Function pointer to a write function.

    76  *

    77  * The signature of the write function shall be compatible to the signature

    78  * of standard <code>fwrite</code>, though it may use arbitrary data types for

    79  * source and destination.

    80  *

    81  * The arguments shall contain (in ascending order): a pointer to the source,

    82  * the length of one element, the element count and a pointer to the

    83  * destination.

    84  */

    85 typedef size_t(*write_func)(const void*, size_t, size_t, void*);

    87 /**

    88  * Function pointer to a read function.

    89  *

    90  * The signature of the read function shall be compatible to the signature

    91  * of standard <code>fread</code>, though it may use arbitrary data types for

    92  * source and destination.

    93  *

    94  * The arguments shall contain (in ascending order): a pointer to the

    95  * destination, the length of one element, the element count and a pointer to

    96  * the source.

    97  */

    98 typedef size_t(*read_func)(void*, size_t, size_t, void*);

   100 #ifdef	__cplusplus

   101 }

   102 #endif

   104 #endif	/* UCX_H */

Mercurial > hg > ucx / file revision