ucx/ucx.h

Tue, 06 Aug 2013 10:22:03 +0200

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Tue, 06 Aug 2013 10:22:03 +0200
changeset 131
fc3af16818a3
parent 127
5418bda21896
child 132
c7d7e4eeb76b
permissions
-rw-r--r--

fixed some warnings when compiling with the sun C++ Compiler

universe@103 1 /*
universe@103 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
olaf@5 3 *
universe@103 4 * Copyright 2013 Olaf Wintermann. All rights reserved.
universe@103 5 *
universe@103 6 * Redistribution and use in source and binary forms, with or without
universe@103 7 * modification, are permitted provided that the following conditions are met:
universe@103 8 *
universe@103 9 * 1. Redistributions of source code must retain the above copyright
universe@103 10 * notice, this list of conditions and the following disclaimer.
universe@103 11 *
universe@103 12 * 2. Redistributions in binary form must reproduce the above copyright
universe@103 13 * notice, this list of conditions and the following disclaimer in the
universe@103 14 * documentation and/or other materials provided with the distribution.
universe@103 15 *
universe@103 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@103 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@103 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@103 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@103 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@103 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@103 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@103 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@103 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@103 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@103 26 * POSSIBILITY OF SUCH DAMAGE.
olaf@5 27 */
universe@114 28 /**
universe@114 29 * Main UCX Header providing most common definitions.
universe@114 30 *
universe@114 31 * @file ucx.h
universe@115 32 * @author Mike Becker
universe@114 33 * @author Olaf Wintermann
universe@114 34 */
olaf@5 35
olaf@5 36 #ifndef UCX_H
olaf@5 37 #define UCX_H
olaf@5 38
olaf@5 39 #include <stdlib.h>
olaf@5 40
universe@127 41 #ifdef _WIN32
universe@127 42 #ifndef __ssize_t_defined
universe@127 43 #include <BaseTsd.h>
universe@127 44 typedef SSIZE_T ssize_t;
universe@127 45 #define __ssize_t_defined
universe@127 46 #endif /* __ssize_t_defined */
universe@127 47 #else /* !_WIN32 */
universe@127 48 #include <sys/types.h>
universe@127 49 #endif /* _WIN32 */
universe@127 50
olaf@5 51 #ifdef __cplusplus
universe@65 52 #ifndef _Bool
universe@65 53 #define _Bool bool
universe@69 54 #define restrict
universe@65 55 #endif
olaf@131 56 #define UCX_EXTERN extern "C"
olaf@5 57 extern "C" {
olaf@131 58 #else
olaf@131 59 #define UCX_EXTERN
olaf@5 60 #endif
olaf@5 61
universe@114 62 /**
universe@114 63 * Function pointer to a compare function.
universe@114 64 *
universe@114 65 * The compare function shall take three arguments: the two values that shall be
universe@114 66 * compared and optional additional data.
universe@114 67 * The function shall then return -1 if the first argument is less than the
universe@114 68 * second argument, 1 if the first argument is greater than the second argument
universe@114 69 * and 0 if both arguments are equal. If the third argument is
universe@114 70 * <code>NULL</code>, it shall be ignored.
universe@114 71 */
universe@18 72 typedef int(*cmp_func)(void*,void*,void*);
universe@18 73
universe@114 74 /**
universe@114 75 * Function pointer to a copy function.
universe@114 76 *
universe@114 77 * The copy function shall create a copy of the first argument and may use
universe@114 78 * additional data provided by the second argument. If the second argument is
universe@114 79 * <code>NULL</code>, it shall be ignored.
universe@114 80
universe@114 81 * <b>Attention:</b> if pointers returned by functions of this type may be
universe@114 82 * passed to <code>free()</code> depends on the implementation of the
universe@114 83 * respective <code>copy_func</code>.
universe@114 84 */
universe@18 85 typedef void*(*copy_func)(void*,void*);
universe@18 86
universe@114 87 /**
universe@114 88 * Function pointer to a write function.
universe@114 89 *
universe@114 90 * The signature of the write function shall be compatible to the signature
universe@114 91 * of standard <code>fwrite</code>, though it may use arbitrary data types for
universe@114 92 * source and destination.
universe@114 93 *
universe@114 94 * The arguments shall contain (in ascending order): a pointer to the source,
universe@116 95 * the length of one element, the element count and a pointer to the
universe@116 96 * destination.
universe@114 97 */
olaf@76 98 typedef size_t(*write_func)(const void*, size_t, size_t, void*);
olaf@76 99
universe@114 100 /**
universe@114 101 * Function pointer to a read function.
universe@114 102 *
universe@114 103 * The signature of the read function shall be compatible to the signature
universe@114 104 * of standard <code>fread</code>, though it may use arbitrary data types for
universe@114 105 * source and destination.
universe@114 106 *
universe@114 107 * The arguments shall contain (in ascending order): a pointer to the
universe@116 108 * destination, the length of one element, the element count and a pointer to
universe@116 109 * the source.
universe@114 110 */
olaf@76 111 typedef size_t(*read_func)(void*, size_t, size_t, void*);
olaf@76 112
olaf@5 113 #ifdef __cplusplus
olaf@5 114 }
olaf@5 115 #endif
olaf@5 116
olaf@5 117 #endif /* UCX_H */
olaf@5 118

mercurial