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