ucx: ucx/utils.h@7800811078b8

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

    29 /**

    30  * @file utils.h

    31  *

    32  * Common utilities like compare and copy functions.

    33  *

    34  * @author Mike Becker

    35  * @author Olaf Wintermann

    36  */

    38 #ifndef UCX_UTILS_H

    39 #define	UCX_UTILS_H

    41 #ifdef	__cplusplus

    42 extern "C" {

    43 #endif

    45 #include "ucx.h"

    46 #include <string.h>

    48 /**

    49  * Copies a string.

    50  * @param s the string to copy

    51  * @param data omitted

    52  * @return a pointer to a copy of s1 that can be passed to free(void*)

    53  */

    54 void *ucx_strcpy(void *s, void *data);

    56 /**

    57  * Copies a memory area.

    58  * @param m a pointer to the memory area

    59  * @param n a pointer to the size_t containing the size of the memory area

    60  * @return a pointer to a copy of the specified memory area that can

    61  * be passed to free(void*)

    62  */

    63 void *ucx_memcpy(void *m, void *n);

    65 /**

    66  * Wraps the strcmp function.

    67  * @param s1 string one

    68  * @param s2 string two

    69  * @param data omitted

    70  * @return the result of strcmp(s1, s2)

    71  */

    72 int ucx_strcmp(void *s1, void *s2, void *data);

    74 /**

    75  * Wraps the strncmp function.

    76  * @param s1 string one

    77  * @param s2 string two

    78  * @param n a pointer to the size_t containing the third strncmp parameter

    79  * @return the result of strncmp(s1, s2, *n)

    80  */

    81 int ucx_strncmp(void *s1, void *s2, void *n);

    83 /**

    84  * Compares two integers of type int.

    85  * @param i1 pointer to integer one

    86  * @param i2 pointer to integer two

    87  * @param data omitted

    88  * @return -1, if *i1 is less than *i2, 0 if both are equal,

    89  * 1 if *i1 is greater than *i2

    90  */

    92 int ucx_intcmp(void *i1, void *i2, void *data);

    94 /**

    95  * Compares two real numbers of type float.

    96  * @param f1 pointer to float one

    97  * @param f2 pointer to float two

    98  * @param data if provided: a pointer to precision (default: 1e-6f)

    99  * @return -1, if *f1 is less than *f2, 0 if both are equal,

   100  * 1 if *f1 is greater than *f2

   101  */

   103 int ucx_floatcmp(void *f1, void *f2, void *data);

   105 /**

   106  * Compares two real numbers of type double.

   107  * @param d1 pointer to double one

   108  * @param d2 pointer to double two

   109  * @param data if provided: a pointer to precision (default: 1e-14)

   110  * @return -1, if *d1 is less than *d2, 0 if both are equal,

   111  * 1 if *d1 is greater than *d2

   112  */

   114 int ucx_doublecmp(void *d1, void *d2, void *data);

   116 /**

   117  * Compares two pointers.

   118  * @param ptr1 pointer one

   119  * @param ptr2 pointer two

   120  * @param data omitted

   121  * @return -1 if ptr1 is less than ptr2, 0 if both are equal,

   122  * 1 if ptr1 is greater than ptr2

   123  */

   124 int ucx_ptrcmp(void *ptr1, void *ptr2, void *data);

   126 /**

   127  * Compares two memory areas.

   128  * @param ptr1 pointer one

   129  * @param ptr2 pointer two

   130  * @param n a pointer to the size_t containing the third parameter for memcmp

   131  * @return the result of memcmp(ptr1, ptr2, *n)

   132  */

   133 int ucx_memcmp(void *ptr1, void *ptr2, void *n);

   135 #ifdef	__cplusplus

   136 }

   137 #endif

   139 #endif	/* UCX_UTILS_H */

Mercurial > hg > ucx / file revision