Clean up CPDF_AnnotList.
[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_POSITION;       // Keep until fxcrt containers gone
71 typedef unsigned short FX_WORD;  // Keep - "an efficient small type"
72 typedef unsigned int FX_DWORD;   // Keep - "an efficient type"
73 typedef float FX_FLOAT;          // Keep, allow upgrade to doubles.
74 typedef int FX_BOOL;             // Keep, sadly not always 0 or 1.
75 typedef char FX_CHAR;            // Keep, questionable signedness.
76 typedef wchar_t FX_WCHAR;        // Keep, maybe bad platform wchars.
77
78 // PDFium string sizes are limited to 2^31-1, and the value is signed to
79 // allow -1 as a placeholder for "unknown".
80 // TODO(palmer): it should be a |size_t|, or at least unsigned.
81 typedef int FX_STRSIZE;
82
83 #if defined(DEBUG) && !defined(_DEBUG)
84 #define _DEBUG
85 #endif
86
87 #ifndef TRUE
88 #define TRUE 1
89 #endif
90
91 #ifndef FALSE
92 #define FALSE 0
93 #endif
94
95 #ifdef __cplusplus
96 static_assert(TRUE == true, "true_needs_to_be_true");
97 static_assert(FALSE == false, "false_needs_to_be_false");
98 #endif
99
100 #ifndef NULL
101 #define NULL 0
102 #endif
103
104 #define FXSYS_assert assert
105 #ifndef ASSERT
106 #ifdef _DEBUG
107 #define ASSERT FXSYS_assert
108 #else
109 #define ASSERT(a)
110 #endif
111 #endif
112
113 #define FX_MAX(a, b) (((a) > (b)) ? (a) : (b))
114 #define FX_MIN(a, b) (((a) < (b)) ? (a) : (b))
115 #define FX_PI 3.1415926535897932384626433832795f
116
117 // NOTE: prevent use of the return value from snprintf() since some platforms
118 // have different return values (e.g. windows _vsnprintf()), and provide
119 // versions that always NUL-terminate.
120 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_ && _MSC_VER < 1900
121 void FXSYS_snprintf(char* str,
122                     size_t size,
123                     _Printf_format_string_ const char* fmt,
124                     ...);
125 void FXSYS_vsnprintf(char* str, size_t size, const char* fmt, va_list ap);
126 #else
127 #define FXSYS_snprintf (void) snprintf
128 #define FXSYS_vsnprintf (void) vsnprintf
129 #endif
130
131 #define FXSYS_sprintf DO_NOT_USE_SPRINTF_DIE_DIE_DIE
132 #define FXSYS_vsprintf DO_NOT_USE_VSPRINTF_DIE_DIE_DIE
133 #define FXSYS_strchr strchr
134 #define FXSYS_strncmp strncmp
135 #define FXSYS_strcmp strcmp
136 #define FXSYS_strcpy strcpy
137 #define FXSYS_strncpy strncpy
138 #define FXSYS_strstr strstr
139 #define FXSYS_FILE FILE
140 #define FXSYS_fopen fopen
141 #define FXSYS_fclose fclose
142 #define FXSYS_SEEK_END SEEK_END
143 #define FXSYS_SEEK_SET SEEK_SET
144 #define FXSYS_fseek fseek
145 #define FXSYS_ftell ftell
146 #define FXSYS_fread fread
147 #define FXSYS_fwrite fwrite
148 #define FXSYS_fprintf fprintf
149 #define FXSYS_fflush fflush
150
151 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
152 #ifdef _NATIVE_WCHAR_T_DEFINED
153 #define FXSYS_wfopen(f, m) _wfopen((const wchar_t*)(f), (const wchar_t*)(m))
154 #else
155 #define FXSYS_wfopen _wfopen
156 #endif
157 #else
158 FXSYS_FILE* FXSYS_wfopen(const FX_WCHAR* filename, const FX_WCHAR* mode);
159 #endif  // _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
160
161 #ifdef __cplusplus
162 }  // extern "C"
163 #include "../../../third_party/base/numerics/safe_conversions.h"
164 #define FXSYS_strlen(ptr) pdfium::base::checked_cast<FX_STRSIZE>(strlen(ptr))
165 #define FXSYS_wcslen(ptr) pdfium::base::checked_cast<FX_STRSIZE>(wcslen(ptr))
166 extern "C" {
167 #else
168 #define FXSYS_strlen(ptr) ((FX_STRSIZE)strlen(ptr))
169 #define FXSYS_wcslen(ptr) ((FX_STRSIZE)wcslen(ptr))
170 #endif
171
172 #define FXSYS_wcscmp wcscmp
173 #define FXSYS_wcschr wcschr
174 #define FXSYS_wcsstr wcsstr
175 #define FXSYS_wcsncmp wcsncmp
176 #define FXSYS_vswprintf vswprintf
177 #define FXSYS_mbstowcs mbstowcs
178 #define FXSYS_wcstombs wcstombs
179 #define FXSYS_memcmp memcmp
180 #define FXSYS_memcpy memcpy
181 #define FXSYS_memmove memmove
182 #define FXSYS_memset memset
183 #define FXSYS_memchr memchr
184 #define FXSYS_qsort qsort
185 #define FXSYS_bsearch bsearch
186
187 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
188 #define FXSYS_GetACP GetACP
189 #define FXSYS_itoa _itoa
190 #define FXSYS_strlwr _strlwr
191 #define FXSYS_strupr _strupr
192 #define FXSYS_stricmp _stricmp
193 #ifdef _NATIVE_WCHAR_T_DEFINED
194 #define FXSYS_wcsicmp(str1, str2) _wcsicmp((wchar_t*)(str1), (wchar_t*)(str2))
195 #define FXSYS_WideCharToMultiByte(p1, p2, p3, p4, p5, p6, p7, p8) \
196   WideCharToMultiByte(p1, p2, (const wchar_t*)(p3), p4, p5, p6, p7, p8)
197 #define FXSYS_MultiByteToWideChar(p1, p2, p3, p4, p5, p6) \
198   MultiByteToWideChar(p1, p2, p3, p4, (wchar_t*)(p5), p6)
199 #define FXSYS_wcslwr(str) _wcslwr((wchar_t*)(str))
200 #define FXSYS_wcsupr(str) _wcsupr((wchar_t*)(str))
201 #else
202 #define FXSYS_wcsicmp _wcsicmp
203 #define FXSYS_WideCharToMultiByte WideCharToMultiByte
204 #define FXSYS_MultiByteToWideChar MultiByteToWideChar
205 #define FXSYS_wcslwr _wcslwr
206 #define FXSYS_wcsupr _wcsupr
207 #endif
208 #define FXSYS_GetFullPathName GetFullPathName
209 #define FXSYS_GetModuleFileName GetModuleFileName
210 #else
211 int FXSYS_GetACP(void);
212 char* FXSYS_itoa(int value, char* string, int radix);
213 int FXSYS_WideCharToMultiByte(FX_DWORD codepage,
214                               FX_DWORD dwFlags,
215                               const wchar_t* wstr,
216                               int wlen,
217                               char* buf,
218                               int buflen,
219                               const char* default_str,
220                               int* pUseDefault);
221 int FXSYS_MultiByteToWideChar(FX_DWORD codepage,
222                               FX_DWORD dwFlags,
223                               const char* bstr,
224                               int blen,
225                               wchar_t* buf,
226                               int buflen);
227 FX_DWORD FXSYS_GetFullPathName(const char* filename,
228                                FX_DWORD buflen,
229                                char* buf,
230                                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 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
241 #define FXSYS_pow(a, b) (FX_FLOAT) powf(a, b)
242 #else
243 #define FXSYS_pow(a, b) (FX_FLOAT) pow(a, b)
244 #endif
245 #define FXSYS_sqrt(a) (FX_FLOAT) sqrt(a)
246 #define FXSYS_fabs(a) (FX_FLOAT) fabs(a)
247 #define FXSYS_atan2(a, b) (FX_FLOAT) atan2(a, b)
248 #define FXSYS_ceil(a) (FX_FLOAT) ceil(a)
249 #define FXSYS_floor(a) (FX_FLOAT) floor(a)
250 #define FXSYS_cos(a) (FX_FLOAT) cos(a)
251 #define FXSYS_acos(a) (FX_FLOAT) acos(a)
252 #define FXSYS_sin(a) (FX_FLOAT) sin(a)
253 #define FXSYS_log(a) (FX_FLOAT) log(a)
254 #define FXSYS_log10(a) (FX_FLOAT) log10(a)
255 #define FXSYS_fmod(a, b) (FX_FLOAT) fmod(a, b)
256 #define FXSYS_abs abs
257 #define FXDWORD_FROM_LSBFIRST(i) (i)
258 #define FXDWORD_FROM_MSBFIRST(i)                        \
259   (((uint8_t)(i) << 24) | ((uint8_t)((i) >> 8) << 16) | \
260    ((uint8_t)((i) >> 16) << 8) | (uint8_t)((i) >> 24))
261 #define FXDWORD_GET_LSBFIRST(p)                              \
262   ((((uint8_t*)(p))[3] << 24) | (((uint8_t*)(p))[2] << 16) | \
263    (((uint8_t*)(p))[1] << 8) | (((uint8_t*)(p))[0]))
264 #define FXDWORD_GET_MSBFIRST(p)                              \
265   ((((uint8_t*)(p))[0] << 24) | (((uint8_t*)(p))[1] << 16) | \
266    (((uint8_t*)(p))[2] << 8) | (((uint8_t*)(p))[3]))
267 #define FXSYS_HIBYTE(word) ((uint8_t)((word) >> 8))
268 #define FXSYS_LOBYTE(word) ((uint8_t)(word))
269 #define FXSYS_HIWORD(dword) ((FX_WORD)((dword) >> 16))
270 #define FXSYS_LOWORD(dword) ((FX_WORD)(dword))
271 int32_t FXSYS_atoi(const FX_CHAR* str);
272 int32_t FXSYS_wtoi(const FX_WCHAR* str);
273 int64_t FXSYS_atoi64(const FX_CHAR* str);
274 int64_t FXSYS_wtoi64(const FX_WCHAR* str);
275 const FX_CHAR* FXSYS_i64toa(int64_t value, FX_CHAR* 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_