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