GDAL
cpl_port.h
Go to the documentation of this file.
1/******************************************************************************
2 * $Id: cpl_port.h c55171b249f96a1cfa0e54f83dfa872c722e493c 2018-05-12 13:46:40 -0700 Lucian Plesea $
3 *
4 * Project: CPL - Common Portability Library
5 * Author: Frank Warmerdam, warmerdam@pobox.com
6 * Purpose: Include file providing low level portability services for CPL.
7 * This should be the first include file for any CPL based code.
8 *
9 ******************************************************************************
10 * Copyright (c) 1998, 2005, Frank Warmerdam <warmerdam@pobox.com>
11 * Copyright (c) 2008-2013, Even Rouault <even dot rouault at mines-paris dot org>
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining a
14 * copy of this software and associated documentation files (the "Software"),
15 * to deal in the Software without restriction, including without limitation
16 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 * and/or sell copies of the Software, and to permit persons to whom the
18 * Software is furnished to do so, subject to the following conditions:
19 *
20 * The above copyright notice and this permission notice shall be included
21 * in all copies or substantial portions of the Software.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 * DEALINGS IN THE SOFTWARE.
30 ****************************************************************************/
31
32#ifndef CPL_BASE_H_INCLUDED
33#define CPL_BASE_H_INCLUDED
34
42/* ==================================================================== */
43/* We will use WIN32 as a standard windows define. */
44/* ==================================================================== */
45#if defined(_WIN32) && !defined(WIN32)
46# define WIN32
47#endif
48
49#if defined(_WINDOWS) && !defined(WIN32)
50# define WIN32
51#endif
52
53/* -------------------------------------------------------------------- */
54/* The following apparently allow you to use strcpy() and other */
55/* functions judged "unsafe" by microsoft in VS 8 (2005). */
56/* -------------------------------------------------------------------- */
57#ifdef _MSC_VER
58# ifndef _CRT_SECURE_NO_DEPRECATE
59# define _CRT_SECURE_NO_DEPRECATE
60# endif
61# ifndef _CRT_NONSTDC_NO_DEPRECATE
62# define _CRT_NONSTDC_NO_DEPRECATE
63# endif
64#endif
65
66#include "cpl_config.h"
67
68/* ==================================================================== */
69/* A few sanity checks, mainly to detect problems that sometimes */
70/* arise with bad configured cross-compilation. */
71/* ==================================================================== */
72
73#if !defined(SIZEOF_INT) || SIZEOF_INT != 4
74#error "Unexpected value for SIZEOF_INT"
75#endif
76
77#if !defined(SIZEOF_UNSIGNED_LONG) || (SIZEOF_UNSIGNED_LONG != 4 && SIZEOF_UNSIGNED_LONG != 8)
78#error "Unexpected value for SIZEOF_UNSIGNED_LONG"
79#endif
80
81#if !defined(SIZEOF_VOIDP) || (SIZEOF_VOIDP != 4 && SIZEOF_VOIDP != 8)
82#error "Unexpected value for SIZEOF_VOIDP"
83#endif
84
85/* ==================================================================== */
86/* This will disable most WIN32 stuff in a Cygnus build which */
87/* defines unix to 1. */
88/* ==================================================================== */
89
90#ifdef unix
91# undef WIN32
92#endif
93
95#if defined(VSI_NEED_LARGEFILE64_SOURCE) && !defined(_LARGEFILE64_SOURCE)
96# define _LARGEFILE64_SOURCE 1
97#endif
98
99/* ==================================================================== */
100/* If iconv() is available use extended recoding module. */
101/* Stub implementation is always compiled in, because it works */
102/* faster than iconv() for encodings it supports. */
103/* ==================================================================== */
104
105#if defined(HAVE_ICONV)
106# define CPL_RECODE_ICONV
107#endif
108
109#define CPL_RECODE_STUB
112/* ==================================================================== */
113/* MinGW stuff */
114/* ==================================================================== */
115
116/* We need __MSVCRT_VERSION__ >= 0x0700 to have "_aligned_malloc" */
117/* Latest versions of mingw32 define it, but with older ones, */
118/* we need to define it manually */
119#if defined(__MINGW32__)
120#ifndef __MSVCRT_VERSION__
121#define __MSVCRT_VERSION__ 0x0700
122#endif
123#endif
124
125/* Needed for std=c11 on Solaris to have strcasecmp() */
126#if defined(GDAL_COMPILATION) && defined(__sun__) && (__STDC_VERSION__ + 0) >= 201112L && (_XOPEN_SOURCE + 0) < 600
127#ifdef _XOPEN_SOURCE
128#undef _XOPEN_SOURCE
129#endif
130#define _XOPEN_SOURCE 600
131#endif
132
133/* ==================================================================== */
134/* Standard include files. */
135/* ==================================================================== */
136
137#include <stdio.h>
138#include <stdlib.h>
139#include <math.h>
140#include <stdarg.h>
141#include <string.h>
142#include <ctype.h>
143#include <limits.h>
144
145#include <time.h>
146
147#if defined(HAVE_ERRNO_H)
148# include <errno.h>
149#endif
150
151#ifdef HAVE_LOCALE_H
152# include <locale.h>
153#endif
154
155#ifdef HAVE_DIRECT_H
156# include <direct.h>
157#endif
158
159#if !defined(WIN32)
160# include <strings.h>
161#endif
162
163#if defined(HAVE_LIBDBMALLOC) && defined(HAVE_DBMALLOC_H) && defined(DEBUG)
164# define DBMALLOC
165# include <dbmalloc.h>
166#endif
167
168#if !defined(DBMALLOC) && defined(HAVE_DMALLOC_H)
169# define USE_DMALLOC
170# include <dmalloc.h>
171#endif
172
173/* ==================================================================== */
174/* Base portability stuff ... this stuff may need to be */
175/* modified for new platforms. */
176/* ==================================================================== */
177
178/* -------------------------------------------------------------------- */
179/* Which versions of C++ are available. */
180/* -------------------------------------------------------------------- */
181
182/* MSVC fails to define a decent value of __cplusplus. Try to target VS2015*/
183/* as a minimum */
184
185#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
186# if !(__cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1900))
187# error Must have C++11 or newer.
188# endif
189# if __cplusplus >= 201402L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)
190# define HAVE_CXX14 1
191# endif
192# if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
193# define HAVE_CXX17 1
194# endif
195#endif /* __cplusplus */
196
197/*---------------------------------------------------------------------
198 * types for 16 and 32 bits integers, etc...
199 *--------------------------------------------------------------------*/
200#if UINT_MAX == 65535
201typedef long GInt32;
202typedef unsigned long GUInt32;
203#else
205typedef int GInt32;
207typedef unsigned int GUInt32;
208#endif
209
211typedef short GInt16;
213typedef unsigned short GUInt16;
215typedef unsigned char GByte;
216/* hack for PDF driver and poppler >= 0.15.0 that defines incompatible "typedef bool GBool" */
217/* in include/poppler/goo/gtypes.h */
218#ifndef CPL_GBOOL_DEFINED
220#define CPL_GBOOL_DEFINED
223typedef int GBool;
224#endif
225
227#ifdef __cplusplus
228#define CPL_STATIC_CAST(type, expr) static_cast<type>(expr)
229#define CPL_REINTERPRET_CAST(type, expr) reinterpret_cast<type>(expr)
230#else
231#define CPL_STATIC_CAST(type, expr) ((type)(expr))
232#define CPL_REINTERPRET_CAST(type, expr) ((type)(expr))
233#endif
236/* -------------------------------------------------------------------- */
237/* 64bit support */
238/* -------------------------------------------------------------------- */
239
240#if defined(WIN32) && defined(_MSC_VER)
241#define VSI_LARGE_API_SUPPORTED
242#endif
243
244#if HAVE_LONG_LONG
245
248typedef long long GIntBig;
251typedef unsigned long long GUIntBig;
252
254#define GINTBIG_MIN (CPL_STATIC_CAST(GIntBig, 0x80000000) << 32)
256#define GINTBIG_MAX ((CPL_STATIC_CAST(GIntBig, 0x7FFFFFFF) << 32) | 0xFFFFFFFFU)
258#define GUINTBIG_MAX ((CPL_STATIC_CAST(GUIntBig, 0xFFFFFFFFU) << 32) | 0xFFFFFFFFU)
259
261#define CPL_HAS_GINT64 1
264/* Note: we might want to use instead int64_t / uint64_t if they are available */
265
267typedef GIntBig GInt64;
269typedef GUIntBig GUInt64;
270
272#define GINT64_MIN GINTBIG_MIN
274#define GINT64_MAX GINTBIG_MAX
276#define GUINT64_MAX GUINTBIG_MAX
277
278#else
279
280#error "64bit integer support required"
281
282#endif
283
284#if SIZEOF_VOIDP == 8
286typedef GIntBig GPtrDiff_t;
287#else
289typedef int GPtrDiff_t;
290#endif
291
292#ifdef GDAL_COMPILATION
293#if HAVE_UINTPTR_T
294#include <stdint.h>
295typedef uintptr_t GUIntptr_t;
296#elif SIZEOF_VOIDP == 8
297typedef GUIntBig GUIntptr_t;
298#else
299typedef unsigned int GUIntptr_t;
300#endif
301
302#define CPL_IS_ALIGNED(ptr, quant) ((CPL_REINTERPRET_CAST(GUIntptr_t, CPL_STATIC_CAST(const void*, ptr)) % (quant)) == 0)
303
304#endif
305
306#if defined(__MSVCRT__) || (defined(WIN32) && defined(_MSC_VER))
307 #define CPL_FRMT_GB_WITHOUT_PREFIX "I64"
308#elif HAVE_LONG_LONG
310 #define CPL_FRMT_GB_WITHOUT_PREFIX "ll"
311#else
312 #define CPL_FRMT_GB_WITHOUT_PREFIX "l"
313#endif
314
316#define CPL_FRMT_GIB "%" CPL_FRMT_GB_WITHOUT_PREFIX "d"
318#define CPL_FRMT_GUIB "%" CPL_FRMT_GB_WITHOUT_PREFIX "u"
319
321#define GUINTBIG_TO_DOUBLE(x) CPL_STATIC_CAST(double, x)
325#ifdef COMPAT_WITH_ICC_CONVERSION_CHECK
326#define CPL_INT64_FITS_ON_INT32(x) ((x) >= INT_MIN && (x) <= INT_MAX)
327#else
328#define CPL_INT64_FITS_ON_INT32(x) (CPL_STATIC_CAST(GIntBig, CPL_STATIC_CAST(int, x)) == (x))
329#endif
332/* ==================================================================== */
333/* Other standard services. */
334/* ==================================================================== */
335#ifdef __cplusplus
337# define CPL_C_START extern "C" {
339# define CPL_C_END }
340#else
341# define CPL_C_START
342# define CPL_C_END
343#endif
344
345#ifndef CPL_DLL
346#if defined(_MSC_VER) && !defined(CPL_DISABLE_DLL)
347# define CPL_DLL __declspec(dllexport)
348#else
349# if defined(USE_GCC_VISIBILITY_FLAG)
350# define CPL_DLL __attribute__ ((visibility("default")))
351# else
352# define CPL_DLL
353# endif
354#endif
355#endif
356
358/* Should optional (normally private) interfaces be exported? */
359#ifdef CPL_OPTIONAL_APIS
360# define CPL_ODLL CPL_DLL
361#else
362# define CPL_ODLL
363#endif
366#ifndef CPL_STDCALL
367#if defined(_MSC_VER) && !defined(CPL_DISABLE_STDCALL)
368# define CPL_STDCALL __stdcall
369#else
370# define CPL_STDCALL
371#endif
372#endif
373
375#ifdef _MSC_VER
376# define FORCE_CDECL __cdecl
377#else
378# define FORCE_CDECL
379#endif
383/* TODO : support for other compilers needed */
384#if (defined(__GNUC__) && !defined(__NO_INLINE__)) || defined(_MSC_VER)
385#define HAS_CPL_INLINE 1
386#define CPL_INLINE __inline
387#elif defined(__SUNPRO_CC)
388#define HAS_CPL_INLINE 1
389#define CPL_INLINE inline
390#else
391#define CPL_INLINE
392#endif
395#ifndef MAX
397# define MIN(a,b) (((a)<(b)) ? (a) : (b))
399# define MAX(a,b) (((a)>(b)) ? (a) : (b))
400#endif
401
402#ifndef ABS
404# define ABS(x) (((x)<0) ? (-1*(x)) : (x))
405#endif
406
407#ifndef M_PI
409# define M_PI 3.14159265358979323846
410/* 3.1415926535897932384626433832795 */
411#endif
412
413/* -------------------------------------------------------------------- */
414/* Macro to test equality of two floating point values. */
415/* We use fabs() function instead of ABS() macro to avoid side */
416/* effects. */
417/* -------------------------------------------------------------------- */
419#ifndef CPLIsEqual
420# define CPLIsEqual(x,y) (fabs((x) - (y)) < 0.0000000000001)
421#endif
424/* -------------------------------------------------------------------- */
425/* Provide macros for case insensitive string comparisons. */
426/* -------------------------------------------------------------------- */
427#ifndef EQUAL
428
429#if defined(AFL_FRIENDLY) && defined(__GNUC__)
430
431static inline int CPL_afl_friendly_memcmp(const void* ptr1, const void* ptr2, size_t len)
432 __attribute__((always_inline));
433
434static inline int CPL_afl_friendly_memcmp(const void* ptr1, const void* ptr2, size_t len)
435{
436 const unsigned char* bptr1 = (const unsigned char*)ptr1;
437 const unsigned char* bptr2 = (const unsigned char*)ptr2;
438 while( len-- )
439 {
440 unsigned char b1 = *(bptr1++);
441 unsigned char b2 = *(bptr2++);
442 if( b1 != b2 ) return b1 - b2;
443 }
444 return 0;
445}
446
447static inline int CPL_afl_friendly_strcmp(const char* ptr1, const char* ptr2)
448 __attribute__((always_inline));
449
450static inline int CPL_afl_friendly_strcmp(const char* ptr1, const char* ptr2)
451{
452 const unsigned char* usptr1 = (const unsigned char*)ptr1;
453 const unsigned char* usptr2 = (const unsigned char*)ptr2;
454 while( 1 )
455 {
456 unsigned char ch1 = *(usptr1++);
457 unsigned char ch2 = *(usptr2++);
458 if( ch1 == 0 || ch1 != ch2 ) return ch1 - ch2;
459 }
460}
461
462static inline int CPL_afl_friendly_strncmp(const char* ptr1, const char* ptr2, size_t len)
463 __attribute__((always_inline));
464
465static inline int CPL_afl_friendly_strncmp(const char* ptr1, const char* ptr2, size_t len)
466{
467 const unsigned char* usptr1 = (const unsigned char*)ptr1;
468 const unsigned char* usptr2 = (const unsigned char*)ptr2;
469 while( len -- )
470 {
471 unsigned char ch1 = *(usptr1++);
472 unsigned char ch2 = *(usptr2++);
473 if( ch1 == 0 || ch1 != ch2 ) return ch1 - ch2;
474 }
475 return 0;
476}
477
478static inline int CPL_afl_friendly_strcasecmp(const char* ptr1, const char* ptr2)
479 __attribute__((always_inline));
480
481static inline int CPL_afl_friendly_strcasecmp(const char* ptr1, const char* ptr2)
482{
483 const unsigned char* usptr1 = (const unsigned char*)ptr1;
484 const unsigned char* usptr2 = (const unsigned char*)ptr2;
485 while( 1 )
486 {
487 unsigned char ch1 = *(usptr1++);
488 unsigned char ch2 = *(usptr2++);
489 ch1 = (unsigned char)toupper(ch1);
490 ch2 = (unsigned char)toupper(ch2);
491 if( ch1 == 0 || ch1 != ch2 ) return ch1 - ch2;
492 }
493}
494
495static inline int CPL_afl_friendly_strncasecmp(const char* ptr1, const char* ptr2, size_t len)
496 __attribute__((always_inline));
497
498static inline int CPL_afl_friendly_strncasecmp(const char* ptr1, const char* ptr2, size_t len)
499{
500 const unsigned char* usptr1 = (const unsigned char*)ptr1;
501 const unsigned char* usptr2 = (const unsigned char*)ptr2;
502 while( len-- )
503 {
504 unsigned char ch1 = *(usptr1++);
505 unsigned char ch2 = *(usptr2++);
506 ch1 = (unsigned char)toupper(ch1);
507 ch2 = (unsigned char)toupper(ch2);
508 if( ch1 == 0 || ch1 != ch2 ) return ch1 - ch2;
509 }
510 return 0;
511}
512
513static inline char* CPL_afl_friendly_strstr(const char* haystack, const char* needle)
514 __attribute__((always_inline));
515
516static inline char* CPL_afl_friendly_strstr(const char* haystack, const char* needle)
517{
518 const char* ptr_haystack = haystack;
519 while( 1 )
520 {
521 const char* ptr_haystack2 = ptr_haystack;
522 const char* ptr_needle = needle;
523 while( 1 )
524 {
525 char ch1 = *(ptr_haystack2++);
526 char ch2 = *(ptr_needle++);
527 if( ch2 == 0 )
528 return (char*)ptr_haystack;
529 if( ch1 != ch2 )
530 break;
531 }
532 if( *ptr_haystack == 0 )
533 return NULL;
534 ptr_haystack ++;
535 }
536}
537
538#undef strcmp
539#undef strncmp
540#define memcmp CPL_afl_friendly_memcmp
541#define strcmp CPL_afl_friendly_strcmp
542#define strncmp CPL_afl_friendly_strncmp
543#define strcasecmp CPL_afl_friendly_strcasecmp
544#define strncasecmp CPL_afl_friendly_strncasecmp
545#define strstr CPL_afl_friendly_strstr
546
547#endif /* defined(AFL_FRIENDLY) && defined(__GNUC__) */
548
549# if defined(WIN32)
550# define STRCASECMP(a,b) (stricmp(a,b))
551# define STRNCASECMP(a,b,n) (strnicmp(a,b,n))
552# else
554# define STRCASECMP(a,b) (strcasecmp(a,b))
556# define STRNCASECMP(a,b,n) (strncasecmp(a,b,n))
557# endif
559# define EQUALN(a,b,n) (STRNCASECMP(a,b,n)==0)
561# define EQUAL(a,b) (STRCASECMP(a,b)==0)
562#endif
563
564/*---------------------------------------------------------------------
565 * Does a string "a" start with string "b". Search is case-sensitive or,
566 * with CI, it is a case-insensitive comparison.
567 *--------------------------------------------------------------------- */
568#ifndef STARTS_WITH_CI
570#define STARTS_WITH(a,b) (strncmp(a,b,strlen(b)) == 0)
572#define STARTS_WITH_CI(a,b) EQUALN(a,b,strlen(b))
573#endif
574
576#ifndef CPL_THREADLOCAL
577# define CPL_THREADLOCAL
578#endif
581/* -------------------------------------------------------------------- */
582/* Handle isnan() and isinf(). Note that isinf() and isnan() */
583/* are supposed to be macros according to C99, defined in math.h */
584/* Some systems (i.e. Tru64) don't have isinf() at all, so if */
585/* the macro is not defined we just assume nothing is infinite. */
586/* This may mean we have no real CPLIsInf() on systems with isinf()*/
587/* function but no corresponding macro, but I can live with */
588/* that since it isn't that important a test. */
589/* -------------------------------------------------------------------- */
590#ifdef _MSC_VER
591# include <float.h>
592# define CPLIsNan(x) _isnan(x)
593# define CPLIsInf(x) (!_isnan(x) && !_finite(x))
594# define CPLIsFinite(x) _finite(x)
595#elif defined(__GNUC__) && ( __GNUC__ > 4 || ( __GNUC__ == 4 && __GNUC_MINOR__ >= 4 ) )
596/* When including <cmath> in C++11 the isnan() macro is undefined, so that */
597/* std::isnan() can work (#6489). This is a GCC specific workaround for now. */
598# define CPLIsNan(x) __builtin_isnan(x)
599# define CPLIsInf(x) __builtin_isinf(x)
600# define CPLIsFinite(x) __builtin_isfinite(x)
601#elif defined(__cplusplus) && defined(HAVE_STD_IS_NAN) && HAVE_STD_IS_NAN
602extern "C++" {
603#ifndef DOXYGEN_SKIP
604#include <cmath>
605#endif
606static inline int CPLIsNan(float f) { return std::isnan(f); }
607static inline int CPLIsNan(double f) { return std::isnan(f); }
608static inline int CPLIsInf(float f) { return std::isinf(f); }
609static inline int CPLIsInf(double f) { return std::isinf(f); }
610static inline int CPLIsFinite(float f) { return std::isfinite(f); }
611static inline int CPLIsFinite(double f) { return std::isfinite(f); }
612}
613#else
615#if defined(__cplusplus) && defined(__GNUC__) && defined(__linux) && !defined(__ANDROID__) && !defined(CPL_SUPRESS_CPLUSPLUS)
616/* so to not get warning about conversion from double to float with */
617/* gcc -Wfloat-conversion when using isnan()/isinf() macros */
618extern "C++" {
619static inline int CPLIsNan(float f) { return __isnanf(f); }
620static inline int CPLIsNan(double f) { return __isnan(f); }
621static inline int CPLIsInf(float f) { return __isinff(f); }
622static inline int CPLIsInf(double f) { return __isinf(f); }
623static inline int CPLIsFinite(float f) { return !__isnanf(f) && !__isinff(f); }
624static inline int CPLIsFinite(double f) { return !__isnan(f) && !__isinf(f); }
625}
626#else
627# define CPLIsNan(x) isnan(x)
628# if defined(isinf) || defined(__FreeBSD__)
630# define CPLIsInf(x) isinf(x)
632# define CPLIsFinite(x) (!isnan(x) && !isinf(x))
633# elif defined(__sun__)
634# include <ieeefp.h>
635# define CPLIsInf(x) (!finite(x) && !isnan(x))
636# define CPLIsFinite(x) finite(x)
637# else
638# define CPLIsInf(x) (0)
639# define CPLIsFinite(x) (!isnan(x))
640# endif
641#endif
642#endif
643
645/*---------------------------------------------------------------------
646 * CPL_LSB and CPL_MSB
647 * Only one of these 2 macros should be defined and specifies the byte
648 * ordering for the current platform.
649 * This should be defined in the Makefile, but if it is not then
650 * the default is CPL_LSB (Intel ordering, LSB first).
651 *--------------------------------------------------------------------*/
652#if defined(WORDS_BIGENDIAN) && !defined(CPL_MSB) && !defined(CPL_LSB)
653# define CPL_MSB
654#endif
655
656#if ! ( defined(CPL_LSB) || defined(CPL_MSB) )
657#define CPL_LSB
658#endif
659
660#if defined(CPL_LSB)
661# define CPL_IS_LSB 1
662#else
663# define CPL_IS_LSB 0
664#endif
667#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
668
670extern "C++" {
671
672template <bool b> struct CPLStaticAssert {};
673template<> struct CPLStaticAssert<true>
674{
675 static void my_function() {}
676};
677
678} /* extern "C++" */
679
680#define CPL_STATIC_ASSERT(x) CPLStaticAssert<x>::my_function()
681#define CPL_STATIC_ASSERT_IF_AVAILABLE(x) CPL_STATIC_ASSERT(x)
682
683#else /* __cplusplus */
684
685#define CPL_STATIC_ASSERT_IF_AVAILABLE(x)
686
687#endif /* __cplusplus */
690/*---------------------------------------------------------------------
691 * Little endian <==> big endian byte swap macros.
692 *--------------------------------------------------------------------*/
693
695#define CPL_SWAP16(x) CPL_STATIC_CAST(GUInt16, (CPL_STATIC_CAST(GUInt16, x) << 8) | (CPL_STATIC_CAST(GUInt16, x) >> 8) )
696
697#if defined(HAVE_GCC_BSWAP) && (defined(__i386__) || defined(__x86_64__))
698/* Could potentially be extended to other architectures but must be checked */
699/* that the intrinsic is indeed efficient */
700/* GCC (at least 4.6 or above) need that include */
701#include <x86intrin.h>
703#define CPL_SWAP32(x) CPL_STATIC_CAST(GUInt32, __builtin_bswap32(CPL_STATIC_CAST(GUInt32, x)))
705#define CPL_SWAP64(x) CPL_STATIC_CAST(GUInt64, __builtin_bswap64(CPL_STATIC_CAST(GUInt64, x)))
706#elif defined(_MSC_VER)
707#define CPL_SWAP32(x) CPL_STATIC_CAST(GUInt32, _byteswap_ulong(CPL_STATIC_CAST(GUInt32, x)))
708#define CPL_SWAP64(x) CPL_STATIC_CAST(GUInt64, _byteswap_uint64(CPL_STATIC_CAST(GUInt64, x)))
709#else
711#define CPL_SWAP32(x) \
712 CPL_STATIC_CAST(GUInt32, \
713 ((CPL_STATIC_CAST(GUInt32, x) & 0x000000ffU) << 24) | \
714 ((CPL_STATIC_CAST(GUInt32, x) & 0x0000ff00U) << 8) | \
715 ((CPL_STATIC_CAST(GUInt32, x) & 0x00ff0000U) >> 8) | \
716 ((CPL_STATIC_CAST(GUInt32, x) & 0xff000000U) >> 24) )
717
719#define CPL_SWAP64(x) \
720 ((CPL_STATIC_CAST(GUInt64, CPL_SWAP32(CPL_STATIC_CAST(GUInt32, x))) << 32) | \
721 (CPL_STATIC_CAST(GUInt64, CPL_SWAP32(CPL_STATIC_CAST(GUInt32, CPL_STATIC_CAST(GUInt64, x) >> 32)))))
722
723#endif
724
726#define CPL_SWAP16PTR(x) \
727{ \
728 GByte byTemp, *_pabyDataT = CPL_REINTERPRET_CAST(GByte*, x); \
729 CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 2); \
730 \
731 byTemp = _pabyDataT[0]; \
732 _pabyDataT[0] = _pabyDataT[1]; \
733 _pabyDataT[1] = byTemp; \
734}
735
736#if defined(MAKE_SANITIZE_HAPPY) || !(defined(__i386__) || defined(__x86_64__) || defined(_M_IX86) || defined(_M_X64))
737
739#define CPL_SWAP32PTR(x) \
740{ \
741 GByte byTemp, *_pabyDataT = CPL_REINTERPRET_CAST(GByte*, x); \
742 CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 4); \
743 \
744 byTemp = _pabyDataT[0]; \
745 _pabyDataT[0] = _pabyDataT[3]; \
746 _pabyDataT[3] = byTemp; \
747 byTemp = _pabyDataT[1]; \
748 _pabyDataT[1] = _pabyDataT[2]; \
749 _pabyDataT[2] = byTemp; \
750}
751
753#define CPL_SWAP64PTR(x) \
754{ \
755 GByte byTemp, *_pabyDataT = CPL_REINTERPRET_CAST(GByte*, x); \
756 CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 8); \
757 \
758 byTemp = _pabyDataT[0]; \
759 _pabyDataT[0] = _pabyDataT[7]; \
760 _pabyDataT[7] = byTemp; \
761 byTemp = _pabyDataT[1]; \
762 _pabyDataT[1] = _pabyDataT[6]; \
763 _pabyDataT[6] = byTemp; \
764 byTemp = _pabyDataT[2]; \
765 _pabyDataT[2] = _pabyDataT[5]; \
766 _pabyDataT[5] = byTemp; \
767 byTemp = _pabyDataT[3]; \
768 _pabyDataT[3] = _pabyDataT[4]; \
769 _pabyDataT[4] = byTemp; \
770}
771
772#else
773
775#define CPL_SWAP32PTR(x) \
776{ \
777 GUInt32 _n32; \
778 void* _lx = x; \
779 memcpy(&_n32, _lx, 4); \
780 CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 4); \
781 _n32 = CPL_SWAP32(_n32); \
782 memcpy(_lx, &_n32, 4); \
783}
784
786#define CPL_SWAP64PTR(x) \
787{ \
788 GUInt64 _n64; \
789 void* _lx = x; \
790 memcpy(&_n64, _lx, 8); \
791 CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 8); \
792 _n64 = CPL_SWAP64(_n64); \
793 memcpy(_lx, &_n64, 8); \
794}
795
796#endif
797
799#define CPL_SWAPDOUBLE(p) CPL_SWAP64PTR(p)
800
801#ifdef CPL_MSB
802# define CPL_MSBWORD16(x) (x)
803# define CPL_LSBWORD16(x) CPL_SWAP16(x)
804# define CPL_MSBWORD32(x) (x)
805# define CPL_LSBWORD32(x) CPL_SWAP32(x)
806# define CPL_MSBPTR16(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 2)
807# define CPL_LSBPTR16(x) CPL_SWAP16PTR(x)
808# define CPL_MSBPTR32(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 4)
809# define CPL_LSBPTR32(x) CPL_SWAP32PTR(x)
810# define CPL_MSBPTR64(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 8)
811# define CPL_LSBPTR64(x) CPL_SWAP64PTR(x)
812#else
814# define CPL_LSBWORD16(x) (x)
816# define CPL_MSBWORD16(x) CPL_SWAP16(x)
818# define CPL_LSBWORD32(x) (x)
820# define CPL_MSBWORD32(x) CPL_SWAP32(x)
822# define CPL_LSBPTR16(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 2)
824# define CPL_MSBPTR16(x) CPL_SWAP16PTR(x)
826# define CPL_LSBPTR32(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 4)
828# define CPL_MSBPTR32(x) CPL_SWAP32PTR(x)
830# define CPL_LSBPTR64(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 8)
832# define CPL_MSBPTR64(x) CPL_SWAP64PTR(x)
833#endif
834
838#define CPL_LSBINT16PTR(x) ((*CPL_REINTERPRET_CAST(const GByte*, x)) | (*((CPL_REINTERPRET_CAST(const GByte*, x))+1) << 8))
839
843#define CPL_LSBINT32PTR(x) ((*CPL_REINTERPRET_CAST(const GByte*, x)) | (*((CPL_REINTERPRET_CAST(const GByte*, x))+1) << 8) | \
844 (*((CPL_REINTERPRET_CAST(const GByte*, x))+2) << 16) | (*((CPL_REINTERPRET_CAST(const GByte*, x))+3) << 24))
845
847#define CPL_LSBSINT16PTR(x) CPL_STATIC_CAST(GInt16,CPL_LSBINT16PTR(x))
848
850#define CPL_LSBUINT16PTR(x) CPL_STATIC_CAST(GUInt16, CPL_LSBINT16PTR(x))
851
853#define CPL_LSBSINT32PTR(x) CPL_STATIC_CAST(GInt32, CPL_LSBINT32PTR(x))
854
856#define CPL_LSBUINT32PTR(x) CPL_STATIC_CAST(GUInt32, CPL_LSBINT32PTR(x))
857
859/* Utility macro to explicitly mark intentionally unreferenced parameters. */
860#ifndef UNREFERENCED_PARAM
861# ifdef UNREFERENCED_PARAMETER /* May be defined by Windows API */
862# define UNREFERENCED_PARAM(param) UNREFERENCED_PARAMETER(param)
863# else
864# define UNREFERENCED_PARAM(param) ((void)param)
865# endif /* UNREFERENCED_PARAMETER */
866#endif /* UNREFERENCED_PARAM */
869/***********************************************************************
870 * Define CPL_CVSID() macro. It can be disabled during a build by
871 * defining DISABLE_CVSID in the compiler options.
872 *
873 * The cvsid_aw() function is just there to prevent reports of cpl_cvsid()
874 * being unused.
875 */
876
878#ifndef DISABLE_CVSID
879#if defined(__GNUC__) && __GNUC__ >= 4
880# define CPL_CVSID(string) static const char cpl_cvsid[] __attribute__((used)) = string;
881#else
882# define CPL_CVSID(string) static const char cpl_cvsid[] = string; \
883static const char *cvsid_aw() { return( cvsid_aw() ? NULL : cpl_cvsid ); }
884#endif
885#else
886# define CPL_CVSID(string)
887#endif
890/* We exclude mingw64 4.6 which seems to be broken regarding this */
891#if defined(__GNUC__) && __GNUC__ >= 4 && !defined(DOXYGEN_SKIP) && !(defined(__MINGW64__) && __GNUC__ == 4 && __GNUC_MINOR__ == 6)
893# define CPL_NULL_TERMINATED __attribute__((__sentinel__))
894#else
896# define CPL_NULL_TERMINATED
897#endif
898
899#if defined(__GNUC__) && __GNUC__ >= 3 && !defined(DOXYGEN_SKIP)
901#define CPL_PRINT_FUNC_FORMAT( format_idx, arg_idx ) __attribute__((__format__ (__printf__, format_idx, arg_idx)))
903#define CPL_SCAN_FUNC_FORMAT( format_idx, arg_idx ) __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
904#else
906#define CPL_PRINT_FUNC_FORMAT( format_idx, arg_idx )
908#define CPL_SCAN_FUNC_FORMAT( format_idx, arg_idx )
909#endif
910
911#if defined(_MSC_VER) && (defined(GDAL_COMPILATION) || defined(CPL_ENABLE_MSVC_ANNOTATIONS))
912#include <sal.h>
915# define CPL_FORMAT_STRING(arg) _Printf_format_string_ arg
918# define CPL_SCANF_FORMAT_STRING(arg) _Scanf_format_string_ arg
919#else
921# define CPL_FORMAT_STRING(arg) arg
923# define CPL_SCANF_FORMAT_STRING(arg) arg
924#endif /* defined(_MSC_VER) && defined(GDAL_COMPILATION) */
925
926#if defined(__GNUC__) && __GNUC__ >= 4 && !defined(DOXYGEN_SKIP)
928#define CPL_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
929#else
931#define CPL_WARN_UNUSED_RESULT
932#endif
933
934#if defined(__GNUC__) && __GNUC__ >= 4
936# define CPL_UNUSED __attribute((__unused__))
937#else
938/* TODO: add cases for other compilers */
940# define CPL_UNUSED
941#endif
942
943#if defined(__GNUC__) && __GNUC__ >= 3 && !defined(DOXYGEN_SKIP)
945#define CPL_NO_RETURN __attribute__((noreturn))
946#else
948#define CPL_NO_RETURN
949#endif
950
952/* Clang __has_attribute */
953#ifndef __has_attribute
954 #define __has_attribute(x) 0 // Compatibility with non-clang compilers.
955#endif
956
959#if ((defined(__GNUC__) && (__GNUC__ >= 5 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 9))) || __has_attribute(returns_nonnull)) && !defined(DOXYGEN_SKIP) && !defined(__INTEL_COMPILER)
961# define CPL_RETURNS_NONNULL __attribute__((returns_nonnull))
962#else
964# define CPL_RETURNS_NONNULL
965#endif
966
967#if defined(__GNUC__) && __GNUC__ >= 4 && !defined(DOXYGEN_SKIP)
969#define CPL_RESTRICT __restrict__
970#else
972#define CPL_RESTRICT
973#endif
974
975#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
976
979# define CPL_OVERRIDE override
980
982# define CPL_FINAL final
983
989# define CPL_DISALLOW_COPY_ASSIGN(ClassName) \
990 ClassName( const ClassName & ) = delete; \
991 ClassName &operator=( const ClassName & ) = delete;
992
993#endif /* __cplusplus */
994
995#if !defined(DOXYGEN_SKIP)
996#if defined(__has_extension)
997 #if __has_extension(attribute_deprecated_with_message)
998 /* Clang extension */
999 #define CPL_WARN_DEPRECATED(x) __attribute__ ((deprecated(x)))
1000 #else
1001 #define CPL_WARN_DEPRECATED(x)
1002 #endif
1003#elif defined(__GNUC__)
1004 #define CPL_WARN_DEPRECATED(x) __attribute__ ((deprecated))
1005#else
1006 #define CPL_WARN_DEPRECATED(x)
1007#endif
1008#endif
1009
1010#if !defined(_MSC_VER) && !defined(__APPLE__) && !defined(_FORTIFY_SOURCE)
1011CPL_C_START
1012# if defined(GDAL_COMPILATION) && defined(WARN_STANDARD_PRINTF)
1013int vsnprintf(char *str, size_t size, const char* fmt, va_list args)
1014 CPL_WARN_DEPRECATED("Use CPLvsnprintf() instead");
1015int snprintf(char *str, size_t size, const char* fmt, ...)
1016 CPL_PRINT_FUNC_FORMAT(3,4)
1017 CPL_WARN_DEPRECATED("Use CPLsnprintf() instead");
1018int sprintf(char *str, const char* fmt, ...)
1019 CPL_PRINT_FUNC_FORMAT(2, 3)
1020 CPL_WARN_DEPRECATED("Use CPLsnprintf() instead");
1021# elif defined(GDAL_COMPILATION) && !defined(DONT_DEPRECATE_SPRINTF)
1022int sprintf(char *str, const char* fmt, ...)
1023 CPL_PRINT_FUNC_FORMAT(2, 3)
1024 CPL_WARN_DEPRECATED("Use snprintf() or CPLsnprintf() instead");
1025# endif /* defined(GDAL_COMPILATION) && defined(WARN_STANDARD_PRINTF) */
1026CPL_C_END
1027#endif /* !defined(_MSC_VER) && !defined(__APPLE__) */
1028
1029#if defined(MAKE_SANITIZE_HAPPY) || !(defined(__i386__) || defined(__x86_64__) || defined(_M_IX86) || defined(_M_X64))
1031#define CPL_CPU_REQUIRES_ALIGNED_ACCESS
1033#endif
1034
1035#if defined(__cplusplus)
1037#define CPL_ARRAYSIZE(array) \
1038 ((sizeof(array) / sizeof(*(array))) / \
1039 static_cast<size_t>(!(sizeof(array) % sizeof(*(array)))))
1040
1041extern "C++" {
1042template<class T> static void CPL_IGNORE_RET_VAL(T) {}
1043inline static bool CPL_TO_BOOL(int x) { return x != 0; }
1044} /* extern "C++" */
1045
1046#endif /* __cplusplus */
1047
1048#if (((__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)) || (defined(__clang__) && __clang_major__ >= 3)) && !defined(_MSC_VER))
1049#define HAVE_GCC_DIAGNOSTIC_PUSH
1050#endif
1051
1052#if ((__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 2)) && !defined(_MSC_VER))
1053#define HAVE_GCC_SYSTEM_HEADER
1054#endif
1055
1056#if ((defined(__clang__) && (__clang_major__ > 3 || (__clang_major__ == 3 && __clang_minor__ >=7))) || __GNUC__ >= 7)
1058# define CPL_FALLTHROUGH [[clang::fallthrough]];
1059#else
1061# define CPL_FALLTHROUGH
1062#endif
1063
1065// Define DEBUG_BOOL to compile in "MSVC mode", ie error out when
1066// a integer is assigned to a bool
1067// WARNING: use only at compilation time, since it is know to not work
1068// at runtime for unknown reasons (crash in MongoDB driver for example)
1069#if defined(__cplusplus) && defined(DEBUG_BOOL) && !defined(DO_NOT_USE_DEBUG_BOOL) && !defined(CPL_SUPRESS_CPLUSPLUS)
1070extern "C++" {
1071class MSVCPedanticBool
1072{
1073
1074 friend bool operator== (const bool& one, const MSVCPedanticBool& other);
1075 friend bool operator!= (const bool& one, const MSVCPedanticBool& other);
1076
1077 bool b;
1078 MSVCPedanticBool(int bIn);
1079
1080 public:
1081 /* b not initialized on purpose in default ctor to flag use. */
1082 /* cppcheck-suppress uninitMemberVar */
1083 MSVCPedanticBool() {}
1084 MSVCPedanticBool(bool bIn) : b(bIn) {}
1085 MSVCPedanticBool(const MSVCPedanticBool& other) : b(other.b) {}
1086
1087 MSVCPedanticBool& operator= (const MSVCPedanticBool& other) { b = other.b; return *this; }
1088 MSVCPedanticBool& operator&= (const MSVCPedanticBool& other) { b &= other.b; return *this; }
1089 MSVCPedanticBool& operator|= (const MSVCPedanticBool& other) { b |= other.b; return *this; }
1090
1091 bool operator== (const bool& other) const { return b == other; }
1092 bool operator!= (const bool& other) const { return b != other; }
1093 bool operator< (const bool& other) const { return b < other; }
1094 bool operator== (const MSVCPedanticBool& other) const { return b == other.b; }
1095 bool operator!= (const MSVCPedanticBool& other) const { return b != other.b; }
1096 bool operator< (const MSVCPedanticBool& other) const { return b < other.b; }
1097
1098 bool operator! () const { return !b; }
1099 operator bool() const { return b; }
1100 operator int() const { return b; }
1101 operator GIntBig() const { return b; }
1102};
1103
1104inline bool operator== (const bool& one, const MSVCPedanticBool& other) { return one == other.b; }
1105inline bool operator!= (const bool& one, const MSVCPedanticBool& other) { return one != other.b; }
1106
1107/* We must include all C++ stuff before to avoid issues with templates that use bool */
1108#include <vector>
1109#include <map>
1110#include <set>
1111#include <string>
1112#include <cstddef>
1113#include <limits>
1114#include <sstream>
1115#include <fstream>
1116#include <algorithm>
1117#include <functional>
1118#include <memory>
1119#include <queue>
1120#include <mutex>
1121#include <unordered_map>
1122#include <thread>
1123#include <unordered_set>
1124#include <complex>
1125#include <iomanip>
1126
1127} /* extern C++ */
1128
1129#undef FALSE
1130#define FALSE false
1131#undef TRUE
1132#define TRUE true
1133
1134/* In the very few cases we really need a "simple" type, fallback to bool */
1135#define EMULATED_BOOL int
1136
1137/* Use our class instead of bool */
1138#define bool MSVCPedanticBool
1139
1140/* "volatile bool" with the below substitution doesn't really work. */
1141/* Just for the sake of the debug, we don't really need volatile */
1142#define VOLATILE_BOOL bool
1143
1144#else /* defined(__cplusplus) && defined(DEBUG_BOOL) */
1145
1146#ifndef FALSE
1147# define FALSE 0
1148#endif
1149
1150#ifndef TRUE
1151# define TRUE 1
1152#endif
1153
1154#define EMULATED_BOOL bool
1155#define VOLATILE_BOOL volatile bool
1156
1157#endif /* defined(__cplusplus) && defined(DEBUG_BOOL) */
1158
1159#if __clang_major__ >= 4 || (__clang_major__ == 3 && __clang_minor__ >= 8)
1160#define CPL_NOSANITIZE_UNSIGNED_INT_OVERFLOW __attribute__((no_sanitize("unsigned-integer-overflow")))
1161#else
1162#define CPL_NOSANITIZE_UNSIGNED_INT_OVERFLOW
1163#endif
1167#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
1168#define CPL_NULLPTR nullptr
1169#else
1170#define CPL_NULLPTR NULL
1171#endif
1174/* This typedef is for C functions that take char** as argument, but */
1175/* with the semantics of a const list. In C, char** is not implicitly cast to */
1176/* const char* const*, contrary to C++. So when seen for C++, it is OK */
1177/* to expose the prototyes as const char* const*, but for C we keep the */
1178/* historical definition to avoid warnings. */
1179#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS) && !defined(DOXYGEN_SKIP)
1182typedef const char* const* CSLConstList;
1183#else
1186typedef char** CSLConstList;
1187#endif
1188
1189#endif /* ndef CPL_BASE_H_INCLUDED */
GPtrDiff_t
int GPtrDiff_t
Integer type large enough to hold the difference between 2 addresses.
Definition: cpl_port.h:289
GUIntBig
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:251
GInt16
short GInt16
Int16 type.
Definition: cpl_port.h:211
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
GInt64
GIntBig GInt64
Signed 64 bit integer type.
Definition: cpl_port.h:267
GBool
int GBool
Type for boolean values (alias to int)
Definition: cpl_port.h:223
GUInt32
unsigned int GUInt32
Unsigned int32 type.
Definition: cpl_port.h:207
CPL_PRINT_FUNC_FORMAT
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:906
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1186
GUInt64
GUIntBig GUInt64
Unsigned 64 bit integer type.
Definition: cpl_port.h:269
GUInt16
unsigned short GUInt16
Unsigned int16 type.
Definition: cpl_port.h:213
GByte
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
GInt32
int GInt32
Int32 type.
Definition: cpl_port.h:205
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
CPLsnprintf
int CPLsnprintf(char *str, size_t size, const char *fmt,...)
snprintf() wrapper that is not sensitive to LC_NUMERIC settings.
Definition: cpl_string.cpp:1337
Generated for GDAL by doxygen 1.9.4.