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