Thu, 05 Sep 2013 13:55:04 +0200
added README file - TODO: make install
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 /** Major UCX version as integer constant. */
40 #define UCX_VERSION_MAJOR 1
42 /** Minor UCX version as integer constant. */
43 #define UCX_VERSION_MINOR 0
45 /** The UCX version in format [major].[minor] */
46 #define UCX_VERSION UCX_VERSION_MAJOR.UCX_VERSION_MINOR
48 #include <stdlib.h>
50 #ifdef _WIN32
51 #if !(defined __ssize_t_defined || defined _SSIZE_T_)
52 #include <BaseTsd.h>
53 typedef SSIZE_T ssize_t;
54 #define __ssize_t_defined
55 #define _SSIZE_T_
56 #endif /* __ssize_t_defined and _SSIZE_T */
57 #else /* !_WIN32 */
58 #include <sys/types.h>
59 #endif /* _WIN32 */
61 #ifdef __cplusplus
62 #ifndef _Bool
63 #define _Bool bool
64 #define restrict
65 #endif
66 #define UCX_EXTERN extern "C"
67 extern "C" {
68 #else
69 #define UCX_EXTERN
70 #endif
72 /**
73 * Function pointer to a compare function.
74 *
75 * The compare function shall take three arguments: the two values that shall be
76 * compared and optional additional data.
77 * The function shall then return -1 if the first argument is less than the
78 * second argument, 1 if the first argument is greater than the second argument
79 * and 0 if both arguments are equal. If the third argument is
80 * <code>NULL</code>, it shall be ignored.
81 */
82 typedef int(*cmp_func)(void*,void*,void*);
84 /**
85 * Function pointer to a copy function.
86 *
87 * The copy function shall create a copy of the first argument and may use
88 * additional data provided by the second argument. If the second argument is
89 * <code>NULL</code>, it shall be ignored.
91 * <b>Attention:</b> if pointers returned by functions of this type may be
92 * passed to <code>free()</code> depends on the implementation of the
93 * respective <code>copy_func</code>.
94 */
95 typedef void*(*copy_func)(void*,void*);
97 /**
98 * Function pointer to a write function.
99 *
100 * The signature of the write function shall be compatible to the signature
101 * of standard <code>fwrite</code>, though it may use arbitrary data types for
102 * source and destination.
103 *
104 * The arguments shall contain (in ascending order): a pointer to the source,
105 * the length of one element, the element count and a pointer to the
106 * destination.
107 */
108 typedef size_t(*write_func)(const void*, size_t, size_t, void*);
110 /**
111 * Function pointer to a read function.
112 *
113 * The signature of the read function shall be compatible to the signature
114 * of standard <code>fread</code>, though it may use arbitrary data types for
115 * source and destination.
116 *
117 * The arguments shall contain (in ascending order): a pointer to the
118 * destination, the length of one element, the element count and a pointer to
119 * the source.
120 */
121 typedef size_t(*read_func)(void*, size_t, size_t, void*);
123 #ifdef __cplusplus
124 }
125 #endif
127 #endif /* UCX_H */