f0ebcf90b1d18d90e44fd492035c85531a490407
[pdfium.git] / core / include / fxcrt / fx_system.h
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef CORE_INCLUDE_FXCRT_FX_SYSTEM_H_
8 #define CORE_INCLUDE_FXCRT_FX_SYSTEM_H_
9
10 #include <assert.h>
11 #include <math.h>
12 #include <stdarg.h>
13 #include <stddef.h>
14 #include <stdint.h>
15 #include <stdio.h>
16 #include <stdlib.h>
17 #include <string.h>
18 #include <wchar.h>
19
20 // _FX_OS_ values:
21 #define _FX_WIN32_DESKTOP_      1
22 #define _FX_WIN64_DESKTOP_      2
23 #define _FX_LINUX_DESKTOP_      4
24 #define _FX_MACOSX_             7
25 #define _FX_ANDROID_           12
26
27 // _FXM_PLATFORM_ values;
28 #define _FXM_PLATFORM_WINDOWS_  1  // _FX_WIN32_DESKTOP_ or _FX_WIN64_DESKTOP_.
29 #define _FXM_PLATFORM_LINUX_    2  // _FX_LINUX_DESKTOP_ always.
30 #define _FXM_PLATFORM_APPLE_    3  // _FX_MACOSX_ always.
31 #define _FXM_PLATFORM_ANDROID_  4  // _FX_ANDROID_ always.
32
33 #ifndef _FX_OS_
34 #if defined(__ANDROID__)
35 #define _FX_OS_ _FX_ANDROID_
36 #define _FXM_PLATFORM_ _FXM_PLATFORM_ANDROID_
37 #elif defined(_WIN32)
38 #define _FX_OS_ _FX_WIN32_DESKTOP_
39 #define _FXM_PLATFORM_ _FXM_PLATFORM_WINDOWS_
40 #elif defined(_WIN64)
41 #define _FX_OS_ _FX_WIN64_DESKTOP_
42 #define _FXM_PLATFORM_ _FXM_PLATFORM_WINDOWS_
43 #elif defined(__linux__)
44 #define _FX_OS_ _FX_LINUX_DESKTOP_
45 #define _FXM_PLATFORM_ _FXM_PLATFORM_LINUX_
46 #elif defined(__APPLE__)
47 #define _FX_OS_ _FX_MACOSX_
48 #define _FXM_PLATFORM_ _FXM_PLATFORM_APPLE_
49 #endif
50 #endif  // _FX_OS_
51
52 #if !defined(_FX_OS_) || _FX_OS_ == 0
53 #error Sorry, can not figure out target OS. Please specify _FX_OS_ macro.
54 #endif
55
56 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
57 #define _CRT_SECURE_NO_WARNINGS
58 #include <sal.h>
59 #include <windows.h>
60 #endif
61
62 #if _FXM_PLATFORM_ == _FXM_PLATFORM_APPLE_
63 #include <libkern/OSAtomic.h>
64 #include <Carbon/Carbon.h>
65 #endif
66
67 #ifdef __cplusplus
68 extern "C" {
69 #endif
70 typedef void*                   FX_LPVOID;   // Deprecate, use with void*.
71 typedef void const*             FX_LPCVOID;  // Deprecate, use with const void*.
72 typedef void*                   FX_POSITION; // Keep until fxcrt containers gone
73 typedef signed char             FX_INT8;     // Deprecate, use int8_t.
74 typedef unsigned char           FX_UINT8;    // Deprecate, use uint8_t.
75 typedef unsigned char           FX_BYTE;     // Deprecate, use uint8_t.
76 typedef unsigned char*          FX_LPBYTE;   // Deprecate, use uint8_t*.
77 typedef unsigned char const*    FX_LPCBYTE;  // Deprecate, use const uint8_t*.
78 typedef short                   FX_INT16;    // Deprecate, use int16_t.
79 typedef unsigned short          FX_UINT16;   // Deprecate, use uint16_t.
80 typedef short                   FX_SHORT;    // Deprecate, use int16_t.
81 typedef unsigned short          FX_WORD;     // Keep - "an efficient small type"
82 typedef unsigned short*         FX_LPWORD;   // Deprecate, use FX_WORD*.
83 typedef unsigned short const*   FX_LPCWORD;  // Deprecate, use const FX_WORD*.
84 typedef int                     FX_INT32;    // Deprecate, use int32_t.
85 typedef unsigned int            FX_UINT32;   // Deprecate, use uint32_t.
86 typedef unsigned int            FX_DWORD;    // Keep - "an efficient type"
87 typedef unsigned int*           FX_LPDWORD;  // Deprecate, use FX_DWORD*.
88 typedef int64_t                 FX_INT64;    // Deprecate, use int64_t.
89 typedef uint64_t                FX_UINT64;   // Deprecate, use uint64_t.
90 typedef intptr_t                FX_INTPTR;   // Deprecate, use intptr_t.
91 typedef uintptr_t               FX_UINTPTR;  // Deprecate, use uintptr_t.
92 typedef float                   FX_FLOAT;    // Keep, allow upgrade to doubles.
93 typedef int                     FX_BOOL;     // Sadly not always 0 or 1.
94 typedef char                    FX_CHAR;     // Keep, questionable signedness.
95 typedef char*                   FX_LPSTR;    // Deprecate, use FX_CHAR*.
96 typedef char const*             FX_LPCSTR;   // Deprecate, use const FX_CHAR*.
97 typedef wchar_t                 FX_WCHAR;    // Keep, maybe bad platform wchars.
98 typedef wchar_t*                FX_LPWSTR;   // Deprecate, use FX_WCHAR*.
99 typedef wchar_t const*          FX_LPCWSTR;  // Deprecate, use const FX_WCHAR*.
100
101 // PDFium string sizes are limited to 2^31-1, and the value is signed to
102 // allow -1 as a placeholder for "unknown".
103 // TODO(palmer): it should be a |size_t|, or at least unsigned.
104 typedef int FX_STRSIZE;
105
106 #if defined(DEBUG) && !defined(_DEBUG)
107 #define _DEBUG
108 #endif
109
110 #ifndef TRUE
111 #define TRUE    1
112 #endif
113
114 #ifndef FALSE
115 #define FALSE   0
116 #endif
117
118 #ifndef NULL
119 #define NULL    0
120 #endif
121
122 #define FXSYS_assert assert
123 #ifndef ASSERT
124 #ifdef _DEBUG
125 #define ASSERT FXSYS_assert
126 #else
127 #define ASSERT(a)
128 #endif
129 #endif
130
131 #define FX_MAX(a, b) (((a) > (b)) ? (a) : (b))
132 #define FX_MIN(a, b) (((a) < (b)) ? (a) : (b))
133 #define FX_PI   3.1415926535897932384626433832795f
134
135 // NOTE: prevent use of the return value from snprintf() since some platforms
136 // have different return values (e.g. windows _vsnprintf()), and provide
137 // versions that always NUL-terminate.
138 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_ && _MSC_VER < 1900
139 void FXSYS_snprintf(char *str, size_t size, _Printf_format_string_ const char* fmt, ...);
140 void FXSYS_vsnprintf(char *str, size_t size, const char* fmt, va_list ap);
141 #else
142 #define FXSYS_snprintf  (void) snprintf
143 #define FXSYS_vsnprintf (void) vsnprintf
144 #endif
145
146 #define FXSYS_sprintf   DO_NOT_USE_SPRINTF_DIE_DIE_DIE
147 #define FXSYS_vsprintf  DO_NOT_USE_VSPRINTF_DIE_DIE_DIE
148 #define FXSYS_strchr    strchr
149 #define FXSYS_strncmp   strncmp
150 #define FXSYS_strcmp    strcmp
151 #define FXSYS_strcpy    strcpy
152 #define FXSYS_strncpy   strncpy
153 #define FXSYS_strstr    strstr
154 #define FXSYS_FILE              FILE
155 #define FXSYS_fopen             fopen
156 #define FXSYS_fclose    fclose
157 #define FXSYS_SEEK_END  SEEK_END
158 #define FXSYS_SEEK_SET  SEEK_SET
159 #define FXSYS_fseek             fseek
160 #define FXSYS_ftell             ftell
161 #define FXSYS_fread             fread
162 #define FXSYS_fwrite    fwrite
163 #define FXSYS_fprintf   fprintf
164 #define FXSYS_fflush    fflush
165
166 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
167 #ifdef _NATIVE_WCHAR_T_DEFINED
168 #define FXSYS_wfopen(f, m) _wfopen((const wchar_t*)(f), (const wchar_t*)(m))
169 #else
170 #define FXSYS_wfopen _wfopen
171 #endif
172 #else
173 FXSYS_FILE* FXSYS_wfopen(FX_LPCWSTR filename, FX_LPCWSTR mode);
174 #endif  // _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
175
176 #ifdef __cplusplus
177 } // extern "C"
178 #include "../../../third_party/base/numerics/safe_conversions.h"
179 #define FXSYS_strlen(ptr) pdfium::base::checked_cast<FX_STRSIZE>(strlen(ptr))
180 #define FXSYS_wcslen(ptr) pdfium::base::checked_cast<FX_STRSIZE>(wcslen(ptr))
181 extern "C" {
182 #else
183 #define FXSYS_strlen(ptr) ((FX_STRSIZE)strlen(ptr))
184 #define FXSYS_wcslen(ptr) ((FX_STRSIZE)wcslen(ptr))
185 #endif
186
187 #define FXSYS_wcscmp    wcscmp
188 #define FXSYS_wcschr    wcschr
189 #define FXSYS_wcsstr    wcsstr
190 #define FXSYS_wcsncmp   wcsncmp
191 #define FXSYS_vswprintf vswprintf
192 #define FXSYS_mbstowcs  mbstowcs
193 #define FXSYS_wcstombs  wcstombs
194 #define FXSYS_memcmp    memcmp
195 #define FXSYS_memcpy    memcpy
196 #define FXSYS_memmove   memmove
197 #define FXSYS_memset    memset
198 #define FXSYS_memchr    memchr
199 #define FXSYS_qsort             qsort
200 #define FXSYS_bsearch   bsearch
201
202 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
203 #define FXSYS_GetACP GetACP
204 #define FXSYS_itoa _itoa
205 #define FXSYS_strlwr _strlwr
206 #define FXSYS_strupr _strupr
207 #define FXSYS_stricmp _stricmp
208 #ifdef _NATIVE_WCHAR_T_DEFINED
209 #define FXSYS_wcsicmp(str1, str2) _wcsicmp((wchar_t*)(str1), (wchar_t*)(str2))
210 #define FXSYS_WideCharToMultiByte(p1, p2, p3, p4, p5, p6, p7, p8) WideCharToMultiByte(p1, p2, (const wchar_t*)(p3), p4, p5, p6, p7, p8)
211 #define FXSYS_MultiByteToWideChar(p1, p2, p3, p4, p5, p6) MultiByteToWideChar(p1, p2, p3, p4, (wchar_t*)(p5), p6)
212 #define FXSYS_wcslwr(str) _wcslwr((wchar_t*)(str))
213 #define FXSYS_wcsupr(str) _wcsupr((wchar_t*)(str))
214 #else
215 #define FXSYS_wcsicmp _wcsicmp
216 #define FXSYS_WideCharToMultiByte WideCharToMultiByte
217 #define FXSYS_MultiByteToWideChar MultiByteToWideChar
218 #define FXSYS_wcslwr _wcslwr
219 #define FXSYS_wcsupr _wcsupr
220 #endif
221 #define FXSYS_GetFullPathName GetFullPathName
222 #define FXSYS_GetModuleFileName GetModuleFileName
223 #else
224 int                     FXSYS_GetACP(void);
225 char*           FXSYS_itoa(int value, char* string, int radix);
226 int                     FXSYS_WideCharToMultiByte(FX_DWORD codepage, FX_DWORD dwFlags, const wchar_t* wstr, int wlen,
227                                       char* buf, int buflen, const char* default_str, int* pUseDefault);
228 int                     FXSYS_MultiByteToWideChar(FX_DWORD codepage, FX_DWORD dwFlags, const char* bstr, int blen,
229                                       wchar_t* buf, int buflen);
230 FX_DWORD        FXSYS_GetFullPathName(const char* filename, FX_DWORD buflen, char* buf, char** filepart);
231 FX_DWORD        FXSYS_GetModuleFileName(void* hModule, char* buf, FX_DWORD bufsize);
232 char*           FXSYS_strlwr(char* str);
233 char*           FXSYS_strupr(char* str);
234 int                     FXSYS_stricmp(const char*, const char*);
235 int                     FXSYS_wcsicmp(const wchar_t *string1, const wchar_t *string2);
236 wchar_t*        FXSYS_wcslwr(wchar_t* str);
237 wchar_t*        FXSYS_wcsupr(wchar_t* str);
238 #endif  // _FXM_PLATFORM == _FXM_PLATFORM_WINDOWS_
239
240 #define FXSYS_memcpy32          FXSYS_memcpy
241 #define FXSYS_memcmp32          FXSYS_memcmp
242 #define FXSYS_memset32          FXSYS_memset
243 #define FXSYS_memset8           FXSYS_memset
244 #define FXSYS_memmove32         FXSYS_memmove
245 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
246 #define FXSYS_pow(a, b)         (FX_FLOAT)powf(a, b)
247 #else
248 #define FXSYS_pow(a, b)         (FX_FLOAT)pow(a, b)
249 #endif
250 #define FXSYS_sqrt(a)           (FX_FLOAT)sqrt(a)
251 #define FXSYS_fabs(a)           (FX_FLOAT)fabs(a)
252 #define FXSYS_atan2(a, b)       (FX_FLOAT)atan2(a, b)
253 #define FXSYS_ceil(a)           (FX_FLOAT)ceil(a)
254 #define FXSYS_floor(a)          (FX_FLOAT)floor(a)
255 #define FXSYS_cos(a)            (FX_FLOAT)cos(a)
256 #define FXSYS_acos(a)           (FX_FLOAT)acos(a)
257 #define FXSYS_sin(a)            (FX_FLOAT)sin(a)
258 #define FXSYS_log(a)            (FX_FLOAT)log(a)
259 #define FXSYS_log10(a)          (FX_FLOAT)log10(a)
260 #define FXSYS_fmod(a, b)        (FX_FLOAT)fmod(a, b)
261 #define FXSYS_abs                       abs
262 #define FXDWORD_FROM_LSBFIRST(i)        (i)
263 #define FXDWORD_FROM_MSBFIRST(i)        (((FX_BYTE)(i) << 24) | ((FX_BYTE)((i) >> 8) << 16) | ((FX_BYTE)((i) >> 16) << 8) | (FX_BYTE)((i) >> 24))
264 #define FXDWORD_GET_LSBFIRST(p)         ((((FX_LPBYTE)(p))[3] << 24) | (((FX_LPBYTE)(p))[2] << 16) | (((FX_LPBYTE)(p))[1] << 8) | (((FX_LPBYTE)(p))[0]))
265 #define FXDWORD_GET_MSBFIRST(p) ((((FX_LPBYTE)(p))[0] << 24) | (((FX_LPBYTE)(p))[1] << 16) | (((FX_LPBYTE)(p))[2] << 8) | (((FX_LPBYTE)(p))[3]))
266 #define FXSYS_HIBYTE(word)      ((FX_BYTE)((word) >> 8))
267 #define FXSYS_LOBYTE(word)      ((FX_BYTE)(word))
268 #define FXSYS_HIWORD(dword)     ((FX_WORD)((dword) >> 16))
269 #define FXSYS_LOWORD(dword)     ((FX_WORD)(dword))
270 FX_INT32        FXSYS_atoi(FX_LPCSTR str);
271 FX_INT32        FXSYS_wtoi(FX_LPCWSTR str);
272 FX_INT64        FXSYS_atoi64(FX_LPCSTR str);
273 FX_INT64        FXSYS_wtoi64(FX_LPCWSTR str);
274 FX_LPCSTR       FXSYS_i64toa(FX_INT64 value, FX_LPSTR str, int radix);
275 FX_LPCWSTR      FXSYS_i64tow(FX_INT64 value, FX_LPWSTR str, int radix);
276 int                     FXSYS_round(FX_FLOAT f);
277 #define         FXSYS_Mul(a, b) ((a) * (b))
278 #define         FXSYS_Div(a, b) ((a) / (b))
279 #define         FXSYS_MulDiv(a, b, c) ((a) * (b) / (c))
280 #define         FXSYS_sqrt2(a, b) (FX_FLOAT)FXSYS_sqrt((a)*(a) + (b)*(b))
281 #ifdef __cplusplus
282 };
283 #endif
284
285 // To print a size_t value in a portable way:
286 //   size_t size;
287 //   printf("xyz: %" PRIuS, size);
288 // The "u" in the macro corresponds to %u, and S is for "size".
289
290 #if _FXM_PLATFORM_ != _FXM_PLATFORM_WINDOWS_
291
292 #if (defined(_INTTYPES_H) || defined(_INTTYPES_H_)) && !defined(PRId64)
293 #error "inttypes.h has already been included before this header file, but "
294 #error "without __STDC_FORMAT_MACROS defined."
295 #endif
296
297 #if !defined(__STDC_FORMAT_MACROS)
298 #define __STDC_FORMAT_MACROS
299 #endif
300
301 #include <inttypes.h>
302
303 #if !defined(PRIuS)
304 #define PRIuS "zu"
305 #endif
306
307 #else  // _FXM_PLATFORM_ != _FXM_PLATFORM_WINDOWS_
308
309 #if !defined(PRIuS)
310 #define PRIuS "Iu"
311 #endif
312
313 #endif  // _FXM_PLATFORM_ != _FXM_PLATFORM_WINDOWS_
314
315 // Prevent a function from ever being inlined, typically because we'd
316 // like it to appear in stack traces.
317 #if  _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
318 #define NEVER_INLINE __declspec(noinline)
319 #else  // _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
320 #define NEVER_INLINE __attribute__((__noinline__))
321 #endif  // _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
322
323 #endif  // CORE_INCLUDE_FXCRT_FX_SYSTEM_H_