1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2021 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 /**
30 * \file common.h
31 *
32 * \brief Common definitions and feature checks.
33 *
34 * \author Mike Becker
35 * \author Olaf Wintermann
36 * \copyright 2-Clause BSD License
37 *
38 * \mainpage UAP Common Extensions
39 * Library with common and useful functions, macros and data structures.
40 * <p>
41 * Latest available source:<br>
42 * <a href="https://sourceforge.net/projects/ucx/files/">https://sourceforge.net/projects/ucx/files/</a>
43 * </p>
44 *
45 * <p>
46 * Repositories:<br>
47 * <a href="https://sourceforge.net/p/ucx/code">https://sourceforge.net/p/ucx/code</a>
48 * - or -
49 * <a href="https://develop.uap-core.de/hg/ucx">https://develop.uap-core.de/hg/ucx</a>
50 * </p>
51 *
52 * <h2>LICENCE</h2>
53 *
54 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
55 *
56 * Redistribution and use in source and binary forms, with or without
57 * modification, are permitted provided that the following conditions are met:
58 *
59 * 1. Redistributions of source code must retain the above copyright
60 * notice, this list of conditions and the following disclaimer.
61 *
62 * 2. Redistributions in binary form must reproduce the above copyright
63 * notice, this list of conditions and the following disclaimer in the
64 * documentation and/or other materials provided with the distribution.
65 *
66 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
67 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
68 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
69 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
70 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
71 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
72 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
73 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
74 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
75 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
76 * POSSIBILITY OF SUCH DAMAGE.
77 */
78
79 #ifndef UCX_COMMON_H
80 #define UCX_COMMON_H
81
82 /** Major UCX version as integer constant. */
83 #define UCX_VERSION_MAJOR 3
84
85 /** Minor UCX version as integer constant. */
86 #define UCX_VERSION_MINOR 1
87
88 /** Version constant which ensures to increase monotonically. */
89 #define UCX_VERSION (((UCX_VERSION_MAJOR)<<16)|UCX_VERSION_MINOR)
90
91 // Common Includes
92
93 #include <stdlib.h>
94 #include <stddef.h>
95 #include <stdbool.h>
96 #include <stdint.h>
97 #include <sys/types.h>
98
99 #ifndef UCX_TEST_H
100 /**
101 * Function pointer compatible with fwrite-like functions.
102 */
103 typedef size_t (*cx_write_func)(
104 const void *,
105 size_t,
106 size_t,
107 void *
108 );
109 #endif // UCX_TEST_H
110
111 /**
112 * Function pointer compatible with fread-like functions.
113 */
114 typedef size_t (*cx_read_func)(
115 void *,
116 size_t,
117 size_t,
118 void *
119 );
120
121
122 // Compiler specific stuff
123
124 #ifndef __GNUC__
125 /**
126 * Removes GNU C attributes where they are not supported.
127 */
128 #define __attribute__(x)
129 #endif
130
131 #ifdef _MSC_VER
132
133 // fix missing ssize_t definition
134 #include <BaseTsd.h>
135 typedef SSIZE_T ssize_t;
136
137 // fix missing _Thread_local support
138 #define _Thread_local __declspec(thread)
139
140 #endif
141
142 #endif // UCX_COMMON_H
143