always include <string.h> (we do this in various other header files,
[openssl.git] / e_os2.h
1 /* e_os2.h */
2 /* ====================================================================
3  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * 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
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    openssl-core@openssl.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This product includes cryptographic software written by Eric Young
51  * (eay@cryptsoft.com).  This product includes software written by Tim
52  * Hudson (tjh@cryptsoft.com).
53  *
54  */
55
56 #include <openssl/opensslconf.h>
57
58 #ifndef HEADER_E_OS2_H
59 #define HEADER_E_OS2_H
60
61 #ifdef  __cplusplus
62 extern "C" {
63 #endif
64
65 /******************************************************************************
66  * Detect operating systems.  This probably needs completing.
67  * The result is that at least one OPENSSL_SYS_os macro should be defined.
68  * However, if none is defined, Unix is assumed.
69  **/
70
71 #define OPENSSL_SYS_UNIX
72
73 /* ----------------------- Macintosh, before MacOS X ----------------------- */
74 #if defined(__MWERKS__) && defined(macintosh) || defined(OPENSSL_SYSNAME_MAC)
75 # undef OPENSSL_SYS_UNIX
76 # define OPENSSL_SYS_MACINTOSH_CLASSIC
77 #endif
78
79 /* ---------------------- Microsoft operating systems ---------------------- */
80
81 /* The 16 bit environments are pretty straightforward */
82 #if defined(OPENSSL_SYSNAME_WIN16) || defined(OPENSSL_SYSNAME_MSDOS)
83 # undef OPENSSL_SYS_UNIX
84 # define OPENSSL_SYS_MSDOS
85 #endif
86 #if defined(OPENSSL_SYSNAME_WIN16)
87 # undef OPENSSL_SYS_UNIX
88 # define OPENSSL_SYS_WIN16
89 #endif
90
91 /* For 32 bit environment, there seems to be the CygWin environment and then
92    all the others that try to do the same thing Microsoft does... */
93 #if defined(OPENSSL_SYSNAME_UWIN)
94 # undef OPENSSL_SYS_UNIX
95 # define OPENSSL_SYS_WIN32_UWIN
96 #else
97 # if defined(__CYGWIN32__) || defined(OPENSSL_SYSNAME_CYGWIN32)
98 #  undef OPENSSL_SYS_UNIX
99 #  define OPENSSL_SYS_WIN32_CYGWIN
100 # else
101 #  if defined(_WIN32) || defined(OPENSSL_SYSNAME_WIN32)
102 #   undef OPENSSL_SYS_UNIX
103 #   define OPENSSL_SYS_WIN32
104 #  endif
105 #  if defined(OPENSSL_SYSNAME_WINNT)
106 #   undef OPENSSL_SYS_UNIX
107 #   define OPENSSL_SYS_WINNT
108 #  endif
109 # endif
110 #endif
111
112 /* Anything that tries to look like Microsoft is "Windows" */
113 #if defined(OPENSSL_SYS_WIN16) || defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINNT)
114 # undef OPENSSL_SYS_UNIX
115 # define OPENSSL_SYS_WINDOWS
116 # ifndef OPENSSL_SYS_MSDOS
117 #  define OPENSSL_SYS_MSDOS
118 # endif
119 #endif
120
121 /* DLL settings.  This part is a bit tough, because it's up to the application
122    implementor how he or she will link the application, so it requires some
123    macro to be used. */
124 #ifdef OPENSSL_SYS_WINDOWS
125 # ifndef OPENSSL_OPT_WINDLL
126 #  if defined(_WINDLL) /* This is used when building OpenSSL to indicate that
127                           DLL linkage should be used */
128 #   define OPENSSL_OPT_WINDLL
129 #  endif
130 # endif
131 #endif
132
133 /* -------------------------------- OpenVMS -------------------------------- */
134 #if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYSNAME_VMS)
135 # undef OPENSSL_SYS_UNIX
136 # define OPENSSL_SYS_VMS
137 # if defined(__DECC)
138 #  define OPENSSL_SYS_VMS_DECC
139 # elif defined(__DECCXX)
140 #  define OPENSSL_SYS_VMS_DECC
141 #  define OPENSSL_SYS_VMS_DECCXX
142 # else
143 #  define OPENSSL_SYS_VMS_NODECC
144 # endif
145 #endif
146
147 /* --------------------------------- OS/2 ---------------------------------- */
148 #if defined(__EMX__) || defined(__OS2__)
149 # undef OPENSSL_SYS_UNIX
150 # define OPENSSL_SYS_OS2
151 #endif
152
153 /* --------------------------------- Unix ---------------------------------- */
154 #ifdef OPENSSL_SYS_UNIX
155 # if defined(linux) || defined(__linux__) || defined(OPENSSL_SYSNAME_LINUX)
156 #  define OPENSSL_SYS_LINUX
157 # endif
158 # ifdef OPENSSL_SYSNAME_MPE
159 #  define OPENSSL_SYS_MPE
160 # endif
161 # ifdef OPENSSL_SYSNAME_SNI
162 #  define OPENSSL_SYS_SNI
163 # endif
164 # ifdef OPENSSL_SYSNAME_ULTRASPARC
165 #  define OPENSSL_SYS_ULTRASPARC
166 # endif
167 # ifdef OPENSSL_SYSNAME_NEWS4
168 #  define OPENSSL_SYS_NEWS4
169 # endif
170 # ifdef OPENSSL_SYSNAME_MACOSX
171 #  define OPENSSL_SYS_MACOSX
172 # endif
173 # if defined(_CRAY) || defined(OPENSSL_SYSNAME_CRAY)
174 #  define OPENSSL_SYS_CRAY
175 # endif
176 # if defined(_AIX) || defined(OPENSSL_SYSNAME_AIX)
177 #  define OPENSSL_SYS_AIX
178 # endif
179 #endif
180
181 /**
182  * That's it for OS-specific stuff
183  *****************************************************************************/
184
185
186 /* Specials for I/O an exit */
187 #ifdef OPENSSL_SYS_MSDOS
188 # define OPENSSL_UNISTD_IO <io.h>
189 # define OPENSSL_DECLARE_EXIT extern void exit(int);
190 #else
191 # define OPENSSL_UNISTD_IO OPENSSL_UNISTD
192 # define OPENSSL_DECLARE_EXIT /* declared in unistd.h */
193 #endif
194
195 /* Definitions of OPENSSL_GLOBAL and OPENSSL_EXTERN, to define and declare
196    certain global symbols that, with some compilers under VMS, have to be
197    defined and declared explicitely with globaldef and globalref.
198    Definitions of OPENSSL_EXPORT and OPENSSL_IMPORT, to define and declare
199    DLL exports and imports for compilers under Win32.  These are a little
200    more complicated to use.  Basically, for any library that exports some
201    global variables, the following code must be present in the header file
202    that declares them, before OPENSSL_EXTERN is used:
203
204    #ifdef SOME_BUILD_FLAG_MACRO
205    # undef OPENSSL_EXTERN
206    # define OPENSSL_EXTERN OPENSSL_EXPORT
207    #endif
208
209    The default is to have OPENSSL_EXPORT, OPENSSL_IMPORT and OPENSSL_GLOBAL
210    have some generally sensible values, and for OPENSSL_EXTERN to have the
211    value OPENSSL_IMPORT.
212 */
213
214 #if defined(OPENSSL_SYS_VMS_NODECC)
215 # define OPENSSL_EXPORT globalref
216 # define OPENSSL_IMPORT globalref
217 # define OPENSSL_GLOBAL globaldef
218 #elif defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL)
219 # define OPENSSL_EXPORT extern _declspec(dllexport)
220 # define OPENSSL_IMPORT extern _declspec(dllimport)
221 # define OPENSSL_GLOBAL
222 #else
223 # define OPENSSL_EXPORT extern
224 # define OPENSSL_IMPORT extern
225 # define OPENSSL_GLOBAL
226 #endif
227 #define OPENSSL_EXTERN OPENSSL_IMPORT
228
229 /* Macros to allow global variables to be reached through function calls when
230    required (if a shared library version requvres it, for example.
231    The way it's done allows definitions like this:
232
233         // in foobar.c
234         OPENSSL_IMPLEMENT_GLOBAL(int,foobar) = 0;
235         // in foobar.h
236         OPENSSL_DECLARE_GLOBAL(int,foobar);
237         #define foobar OPENSSL_GLOBAL_REF(foobar)
238 */
239 #ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION
240 # define OPENSSL_IMPLEMENT_GLOBAL(type,name) static type _hide_##name; \
241         type *_shadow_##name(void) { return &_hide_##name; } \
242         static type _hide_##name
243 # define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void)
244 # define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name()))
245 #else
246 # define OPENSSL_IMPLEMENT_GLOBAL(type,name) OPENSSL_GLOBAL type _shadow_##name
247 # define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name
248 # define OPENSSL_GLOBAL_REF(name) _shadow_##name
249 #endif
250
251 #ifdef  __cplusplus
252 }
253 #endif
254 #endif