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