forked from OSGeo/gdal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcpl_port.h
1056 lines (913 loc) · 38.5 KB
/
cpl_port.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/******************************************************************************
* $Id$
*
* Project: CPL - Common Portability Library
* Author: Frank Warmerdam, [email protected]
* Purpose: Include file providing low level portability services for CPL.
* This should be the first include file for any CPL based code.
*
******************************************************************************
* Copyright (c) 1998, 2005, Frank Warmerdam <[email protected]>
* Copyright (c) 2008-2013, Even Rouault <even dot rouault at spatialys.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#ifndef CPL_BASE_H_INCLUDED
#define CPL_BASE_H_INCLUDED
/**
* \file cpl_port.h
*
* Core portability definitions for CPL.
*
*/
/* ==================================================================== */
/* We will use WIN32 as a standard windows define. */
/* ==================================================================== */
#if defined(_WIN32) && !defined(WIN32)
# define WIN32
#endif
#if defined(_WINDOWS) && !defined(WIN32)
# define WIN32
#endif
/* -------------------------------------------------------------------- */
/* The following apparently allow you to use strcpy() and other */
/* functions judged "unsafe" by microsoft in VS 8 (2005). */
/* -------------------------------------------------------------------- */
#ifdef _MSC_VER
# ifndef _CRT_SECURE_NO_DEPRECATE
# define _CRT_SECURE_NO_DEPRECATE
# endif
# ifndef _CRT_NONSTDC_NO_DEPRECATE
# define _CRT_NONSTDC_NO_DEPRECATE
# endif
#endif
#include "cpl_config.h"
/* ==================================================================== */
/* A few sanity checks, mainly to detect problems that sometimes */
/* arise with bad configured cross-compilation. */
/* ==================================================================== */
#if !defined(SIZEOF_INT) || SIZEOF_INT != 4
#error "Unexpected value for SIZEOF_INT"
#endif
#if !defined(SIZEOF_UNSIGNED_LONG) || (SIZEOF_UNSIGNED_LONG != 4 && SIZEOF_UNSIGNED_LONG != 8)
#error "Unexpected value for SIZEOF_UNSIGNED_LONG"
#endif
#if !defined(SIZEOF_VOIDP) || (SIZEOF_VOIDP != 4 && SIZEOF_VOIDP != 8)
#error "Unexpected value for SIZEOF_VOIDP"
#endif
/* ==================================================================== */
/* This will disable most WIN32 stuff in a Cygnus build which */
/* defines unix to 1. */
/* ==================================================================== */
#ifdef unix
# undef WIN32
#endif
/*! @cond Doxygen_Suppress */
#if defined(VSI_NEED_LARGEFILE64_SOURCE) && !defined(_LARGEFILE64_SOURCE)
# define _LARGEFILE64_SOURCE 1
#endif
/* ==================================================================== */
/* If iconv() is available use extended recoding module. */
/* Stub implementation is always compiled in, because it works */
/* faster than iconv() for encodings it supports. */
/* ==================================================================== */
#if defined(HAVE_ICONV)
# define CPL_RECODE_ICONV
#endif
#define CPL_RECODE_STUB
/*! @endcond */
/* ==================================================================== */
/* MinGW stuff */
/* ==================================================================== */
/* We need __MSVCRT_VERSION__ >= 0x0700 to have "_aligned_malloc" */
/* Latest versions of mingw32 define it, but with older ones, */
/* we need to define it manually */
#if defined(__MINGW32__)
#ifndef __MSVCRT_VERSION__
#define __MSVCRT_VERSION__ 0x0700
#endif
#endif
/* Needed for std=c11 on Solaris to have strcasecmp() */
#if defined(GDAL_COMPILATION) && defined(__sun__) && (__STDC_VERSION__ + 0) >= 201112L && (_XOPEN_SOURCE + 0) < 600
#ifdef _XOPEN_SOURCE
#undef _XOPEN_SOURCE
#endif
#define _XOPEN_SOURCE 600
#endif
/* ==================================================================== */
/* Standard include files. */
/* ==================================================================== */
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <stdarg.h>
#include <string.h>
#include <ctype.h>
#include <limits.h>
#include <time.h>
#include <errno.h>
#ifdef HAVE_LOCALE_H
# include <locale.h>
#endif
#ifdef HAVE_DIRECT_H
# include <direct.h>
#endif
#if !defined(WIN32)
# include <strings.h>
#endif
/* ==================================================================== */
/* Base portability stuff ... this stuff may need to be */
/* modified for new platforms. */
/* ==================================================================== */
/* -------------------------------------------------------------------- */
/* Which versions of C++ are available. */
/* -------------------------------------------------------------------- */
/* MSVC fails to define a decent value of __cplusplus. Try to target VS2015*/
/* as a minimum */
#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
# if !(__cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1900))
# error Must have C++11 or newer.
# endif
# if __cplusplus >= 201402L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)
# define HAVE_CXX14 1
# endif
# if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
# define HAVE_CXX17 1
# endif
#endif /* __cplusplus */
/*---------------------------------------------------------------------
* types for 16 and 32 bits integers, etc...
*--------------------------------------------------------------------*/
#if UINT_MAX == 65535
typedef long GInt32;
typedef unsigned long GUInt32;
#else
/** Int32 type */
typedef int GInt32;
/** Unsigned int32 type */
typedef unsigned int GUInt32;
#endif
/** Int16 type */
typedef short GInt16;
/** Unsigned int16 type */
typedef unsigned short GUInt16;
/** Unsigned byte type */
typedef unsigned char GByte;
/* hack for PDF driver and poppler >= 0.15.0 that defines incompatible "typedef bool GBool" */
/* in include/poppler/goo/gtypes.h */
#ifndef CPL_GBOOL_DEFINED
/*! @cond Doxygen_Suppress */
#define CPL_GBOOL_DEFINED
/*! @endcond */
/** Type for boolean values (alias to int) */
typedef int GBool;
#endif
/*! @cond Doxygen_Suppress */
#ifdef __cplusplus
#define CPL_STATIC_CAST(type, expr) static_cast<type>(expr)
#define CPL_REINTERPRET_CAST(type, expr) reinterpret_cast<type>(expr)
#else
#define CPL_STATIC_CAST(type, expr) ((type)(expr))
#define CPL_REINTERPRET_CAST(type, expr) ((type)(expr))
#endif
/*! @endcond */
/* -------------------------------------------------------------------- */
/* 64bit support */
/* -------------------------------------------------------------------- */
/** Large signed integer type (generally 64-bit integer type).
* Use GInt64 when exactly 64 bit is needed */
typedef long long GIntBig;
/** Large unsigned integer type (generally 64-bit unsigned integer type).
* Use GUInt64 when exactly 64 bit is needed */
typedef unsigned long long GUIntBig;
/** Minimum GIntBig value */
#define GINTBIG_MIN (CPL_STATIC_CAST(GIntBig, 0x80000000) << 32)
/** Maximum GIntBig value */
#define GINTBIG_MAX ((CPL_STATIC_CAST(GIntBig, 0x7FFFFFFF) << 32) | 0xFFFFFFFFU)
/** Maximum GUIntBig value */
#define GUINTBIG_MAX ((CPL_STATIC_CAST(GUIntBig, 0xFFFFFFFFU) << 32) | 0xFFFFFFFFU)
/*! @cond Doxygen_Suppress */
#define CPL_HAS_GINT64 1
/*! @endcond */
/* Note: we might want to use instead int64_t / uint64_t if they are available */
/** Signed 64 bit integer type */
typedef GIntBig GInt64;
/** Unsigned 64 bit integer type */
typedef GUIntBig GUInt64;
/** Minimum GInt64 value */
#define GINT64_MIN GINTBIG_MIN
/** Maximum GInt64 value */
#define GINT64_MAX GINTBIG_MAX
/** Minimum GUInt64 value */
#define GUINT64_MAX GUINTBIG_MAX
#if SIZEOF_VOIDP == 8
/** Integer type large enough to hold the difference between 2 addresses */
typedef GIntBig GPtrDiff_t;
#else
/** Integer type large enough to hold the difference between 2 addresses */
typedef int GPtrDiff_t;
#endif
#ifdef GDAL_COMPILATION
#include <stdint.h>
typedef uintptr_t GUIntptr_t;
#define CPL_IS_ALIGNED(ptr, quant) ((CPL_REINTERPRET_CAST(GUIntptr_t, CPL_STATIC_CAST(const void*, ptr)) % (quant)) == 0)
#endif
#if (defined(__MSVCRT__) && !(defined(__MINGW64__) && __GNUC__ >= 10)) || (defined(WIN32) && defined(_MSC_VER))
#define CPL_FRMT_GB_WITHOUT_PREFIX "I64"
#else
/** Printf formatting suffix for GIntBig */
#define CPL_FRMT_GB_WITHOUT_PREFIX "ll"
#endif
/** Printf formatting for GIntBig */
#define CPL_FRMT_GIB "%" CPL_FRMT_GB_WITHOUT_PREFIX "d"
/** Printf formatting for GUIntBig */
#define CPL_FRMT_GUIB "%" CPL_FRMT_GB_WITHOUT_PREFIX "u"
/*! @cond Doxygen_Suppress */
#ifdef COMPAT_WITH_ICC_CONVERSION_CHECK
#define CPL_INT64_FITS_ON_INT32(x) ((x) >= INT_MIN && (x) <= INT_MAX)
#else
#define CPL_INT64_FITS_ON_INT32(x) (CPL_STATIC_CAST(GIntBig, CPL_STATIC_CAST(int, x)) == (x))
#endif
/*! @endcond */
/* ==================================================================== */
/* Other standard services. */
/* ==================================================================== */
#ifdef __cplusplus
/** Macro to start a block of C symbols */
# define CPL_C_START extern "C" {
/** Macro to end a block of C symbols */
# define CPL_C_END }
#else
# define CPL_C_START
# define CPL_C_END
#endif
#ifndef CPL_DLL
#if defined(_MSC_VER) && !defined(CPL_DISABLE_DLL)
# ifdef GDAL_COMPILATION
# define CPL_DLL __declspec(dllexport)
# else
# define CPL_DLL
# endif
# define CPL_INTERNAL
#else
# if defined(USE_GCC_VISIBILITY_FLAG)
# define CPL_DLL __attribute__ ((visibility("default")))
# if !defined(__MINGW32__)
# define CPL_INTERNAL __attribute__((visibility("hidden")))
# else
# define CPL_INTERNAL
# endif
# else
# define CPL_DLL
# define CPL_INTERNAL
# endif
#endif
// Marker for unstable API
#define CPL_UNSTABLE_API CPL_DLL
#endif
/*! @cond Doxygen_Suppress */
/* Should optional (normally private) interfaces be exported? */
#ifdef CPL_OPTIONAL_APIS
# define CPL_ODLL CPL_DLL
#else
# define CPL_ODLL
#endif
/*! @endcond */
#ifndef CPL_STDCALL
#if defined(_MSC_VER) && !defined(CPL_DISABLE_STDCALL)
# define CPL_STDCALL __stdcall
#else
# define CPL_STDCALL
#endif
#endif
/*! @cond Doxygen_Suppress */
#ifdef _MSC_VER
# define FORCE_CDECL __cdecl
#else
# define FORCE_CDECL
#endif
/*! @endcond */
/*! @cond Doxygen_Suppress */
/* TODO : support for other compilers needed */
#if (defined(__GNUC__) && !defined(__NO_INLINE__)) || defined(_MSC_VER)
#define HAS_CPL_INLINE 1
#define CPL_INLINE __inline
#elif defined(__SUNPRO_CC)
#define HAS_CPL_INLINE 1
#define CPL_INLINE inline
#else
#define CPL_INLINE
#endif
/*! @endcond*/
#ifndef MAX
/** Macro to compute the minimum of 2 values */
# define MIN(a,b) (((a)<(b)) ? (a) : (b))
/** Macro to compute the maximum of 2 values */
# define MAX(a,b) (((a)>(b)) ? (a) : (b))
#endif
#ifndef ABS
/** Macro to compute the absolute value */
# define ABS(x) (((x)<0) ? (-1*(x)) : (x))
#endif
#ifndef M_PI
/** PI definition */
# define M_PI 3.14159265358979323846
/* 3.1415926535897932384626433832795 */
#endif
/* -------------------------------------------------------------------- */
/* Macro to test equality of two floating point values. */
/* We use fabs() function instead of ABS() macro to avoid side */
/* effects. */
/* -------------------------------------------------------------------- */
/*! @cond Doxygen_Suppress */
#ifndef CPLIsEqual
# define CPLIsEqual(x,y) (fabs((x) - (y)) < 0.0000000000001)
#endif
/*! @endcond */
/* -------------------------------------------------------------------- */
/* Provide macros for case insensitive string comparisons. */
/* -------------------------------------------------------------------- */
#ifndef EQUAL
#if defined(AFL_FRIENDLY) && defined(__GNUC__)
static inline int CPL_afl_friendly_memcmp(const void* ptr1, const void* ptr2, size_t len)
__attribute__((always_inline));
static inline int CPL_afl_friendly_memcmp(const void* ptr1, const void* ptr2, size_t len)
{
const unsigned char* bptr1 = (const unsigned char*)ptr1;
const unsigned char* bptr2 = (const unsigned char*)ptr2;
while( len-- )
{
unsigned char b1 = *(bptr1++);
unsigned char b2 = *(bptr2++);
if( b1 != b2 ) return b1 - b2;
}
return 0;
}
static inline int CPL_afl_friendly_strcmp(const char* ptr1, const char* ptr2)
__attribute__((always_inline));
static inline int CPL_afl_friendly_strcmp(const char* ptr1, const char* ptr2)
{
const unsigned char* usptr1 = (const unsigned char*)ptr1;
const unsigned char* usptr2 = (const unsigned char*)ptr2;
while( 1 )
{
unsigned char ch1 = *(usptr1++);
unsigned char ch2 = *(usptr2++);
if( ch1 == 0 || ch1 != ch2 ) return ch1 - ch2;
}
}
static inline int CPL_afl_friendly_strncmp(const char* ptr1, const char* ptr2, size_t len)
__attribute__((always_inline));
static inline int CPL_afl_friendly_strncmp(const char* ptr1, const char* ptr2, size_t len)
{
const unsigned char* usptr1 = (const unsigned char*)ptr1;
const unsigned char* usptr2 = (const unsigned char*)ptr2;
while( len -- )
{
unsigned char ch1 = *(usptr1++);
unsigned char ch2 = *(usptr2++);
if( ch1 == 0 || ch1 != ch2 ) return ch1 - ch2;
}
return 0;
}
static inline int CPL_afl_friendly_strcasecmp(const char* ptr1, const char* ptr2)
__attribute__((always_inline));
static inline int CPL_afl_friendly_strcasecmp(const char* ptr1, const char* ptr2)
{
const unsigned char* usptr1 = (const unsigned char*)ptr1;
const unsigned char* usptr2 = (const unsigned char*)ptr2;
while( 1 )
{
unsigned char ch1 = *(usptr1++);
unsigned char ch2 = *(usptr2++);
ch1 = (unsigned char)toupper(ch1);
ch2 = (unsigned char)toupper(ch2);
if( ch1 == 0 || ch1 != ch2 ) return ch1 - ch2;
}
}
static inline int CPL_afl_friendly_strncasecmp(const char* ptr1, const char* ptr2, size_t len)
__attribute__((always_inline));
static inline int CPL_afl_friendly_strncasecmp(const char* ptr1, const char* ptr2, size_t len)
{
const unsigned char* usptr1 = (const unsigned char*)ptr1;
const unsigned char* usptr2 = (const unsigned char*)ptr2;
while( len-- )
{
unsigned char ch1 = *(usptr1++);
unsigned char ch2 = *(usptr2++);
ch1 = (unsigned char)toupper(ch1);
ch2 = (unsigned char)toupper(ch2);
if( ch1 == 0 || ch1 != ch2 ) return ch1 - ch2;
}
return 0;
}
static inline char* CPL_afl_friendly_strstr(const char* haystack, const char* needle)
__attribute__((always_inline));
static inline char* CPL_afl_friendly_strstr(const char* haystack, const char* needle)
{
const char* ptr_haystack = haystack;
while( 1 )
{
const char* ptr_haystack2 = ptr_haystack;
const char* ptr_needle = needle;
while( 1 )
{
char ch1 = *(ptr_haystack2++);
char ch2 = *(ptr_needle++);
if( ch2 == 0 )
return (char*)ptr_haystack;
if( ch1 != ch2 )
break;
}
if( *ptr_haystack == 0 )
return NULL;
ptr_haystack ++;
}
}
#undef strcmp
#undef strncmp
#define memcmp CPL_afl_friendly_memcmp
#define strcmp CPL_afl_friendly_strcmp
#define strncmp CPL_afl_friendly_strncmp
#define strcasecmp CPL_afl_friendly_strcasecmp
#define strncasecmp CPL_afl_friendly_strncasecmp
#define strstr CPL_afl_friendly_strstr
#endif /* defined(AFL_FRIENDLY) && defined(__GNUC__) */
# if defined(WIN32)
# define STRCASECMP(a,b) (_stricmp(a,b))
# define STRNCASECMP(a,b,n) (_strnicmp(a,b,n))
# else
/** Alias for strcasecmp() */
# define STRCASECMP(a,b) (strcasecmp(a,b))
/** Alias for strncasecmp() */
# define STRNCASECMP(a,b,n) (strncasecmp(a,b,n))
# endif
/** Alias for strncasecmp() == 0 */
# define EQUALN(a,b,n) (STRNCASECMP(a,b,n)==0)
/** Alias for strcasecmp() == 0 */
# define EQUAL(a,b) (STRCASECMP(a,b)==0)
#endif
/*---------------------------------------------------------------------
* Does a string "a" start with string "b". Search is case-sensitive or,
* with CI, it is a case-insensitive comparison.
*--------------------------------------------------------------------- */
#ifndef STARTS_WITH_CI
/** Returns whether a starts with b */
#define STARTS_WITH(a,b) (strncmp(a,b,strlen(b)) == 0)
/** Returns whether a starts with b (case insensitive comparison) */
#define STARTS_WITH_CI(a,b) EQUALN(a,b,strlen(b))
#endif
/*! @cond Doxygen_Suppress */
#ifndef CPL_THREADLOCAL
# define CPL_THREADLOCAL
#endif
/*! @endcond */
/* -------------------------------------------------------------------- */
/* Handle isnan() and isinf(). Note that isinf() and isnan() */
/* are supposed to be macros according to C99, defined in math.h */
/* Some systems (i.e. Tru64) don't have isinf() at all, so if */
/* the macro is not defined we just assume nothing is infinite. */
/* This may mean we have no real CPLIsInf() on systems with isinf()*/
/* function but no corresponding macro, but I can live with */
/* that since it isn't that important a test. */
/* -------------------------------------------------------------------- */
#ifdef _MSC_VER
# include <float.h>
# define CPLIsNan(x) _isnan(x)
# define CPLIsInf(x) (!_isnan(x) && !_finite(x))
# define CPLIsFinite(x) _finite(x)
#elif defined(__GNUC__) && ( __GNUC__ > 4 || ( __GNUC__ == 4 && __GNUC_MINOR__ >= 4 ) )
/* When including <cmath> in C++11 the isnan() macro is undefined, so that */
/* std::isnan() can work (#6489). This is a GCC specific workaround for now. */
# define CPLIsNan(x) __builtin_isnan(x)
# define CPLIsInf(x) __builtin_isinf(x)
# define CPLIsFinite(x) __builtin_isfinite(x)
#elif defined(__cplusplus) && defined(HAVE_STD_IS_NAN) && HAVE_STD_IS_NAN
extern "C++" {
#ifndef DOXYGEN_SKIP
#include <cmath>
#endif
static inline int CPLIsNan(float f) { return std::isnan(f); }
static inline int CPLIsNan(double f) { return std::isnan(f); }
static inline int CPLIsInf(float f) { return std::isinf(f); }
static inline int CPLIsInf(double f) { return std::isinf(f); }
static inline int CPLIsFinite(float f) { return std::isfinite(f); }
static inline int CPLIsFinite(double f) { return std::isfinite(f); }
}
#else
/** Return whether a floating-pointer number is NaN */
#if defined(__cplusplus) && defined(__GNUC__) && defined(__linux) && !defined(__ANDROID__) && !defined(CPL_SUPRESS_CPLUSPLUS)
/* so to not get warning about conversion from double to float with */
/* gcc -Wfloat-conversion when using isnan()/isinf() macros */
extern "C++" {
static inline int CPLIsNan(float f) { return __isnanf(f); }
static inline int CPLIsNan(double f) { return __isnan(f); }
static inline int CPLIsInf(float f) { return __isinff(f); }
static inline int CPLIsInf(double f) { return __isinf(f); }
static inline int CPLIsFinite(float f) { return !__isnanf(f) && !__isinff(f); }
static inline int CPLIsFinite(double f) { return !__isnan(f) && !__isinf(f); }
}
#else
# define CPLIsNan(x) isnan(x)
# if defined(isinf) || defined(__FreeBSD__)
/** Return whether a floating-pointer number is +/- infinity */
# define CPLIsInf(x) isinf(x)
/** Return whether a floating-pointer number is finite */
# define CPLIsFinite(x) (!isnan(x) && !isinf(x))
# elif defined(__sun__)
# include <ieeefp.h>
# define CPLIsInf(x) (!finite(x) && !isnan(x))
# define CPLIsFinite(x) finite(x)
# else
# define CPLIsInf(x) (0)
# define CPLIsFinite(x) (!isnan(x))
# endif
#endif
#endif
/*! @cond Doxygen_Suppress */
/*---------------------------------------------------------------------
* CPL_LSB and CPL_MSB
* Only one of these 2 macros should be defined and specifies the byte
* ordering for the current platform.
* This should be defined in the Makefile, but if it is not then
* the default is CPL_LSB (Intel ordering, LSB first).
*--------------------------------------------------------------------*/
#if defined(WORDS_BIGENDIAN) && !defined(CPL_MSB) && !defined(CPL_LSB)
# define CPL_MSB
#endif
#if ! ( defined(CPL_LSB) || defined(CPL_MSB) )
#define CPL_LSB
#endif
#if defined(CPL_LSB)
# define CPL_IS_LSB 1
#else
# define CPL_IS_LSB 0
#endif
/*! @endcond */
#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
/*! @cond Doxygen_Suppress */
extern "C++" {
template <bool b> struct CPLStaticAssert {};
template<> struct CPLStaticAssert<true>
{
static void my_function() {}
};
} /* extern "C++" */
#define CPL_STATIC_ASSERT(x) CPLStaticAssert<x>::my_function()
#define CPL_STATIC_ASSERT_IF_AVAILABLE(x) CPL_STATIC_ASSERT(x)
#else /* __cplusplus */
#define CPL_STATIC_ASSERT_IF_AVAILABLE(x)
#endif /* __cplusplus */
/*! @endcond */
/*---------------------------------------------------------------------
* Little endian <==> big endian byte swap macros.
*--------------------------------------------------------------------*/
/** Byte-swap a 16bit unsigned integer */
#define CPL_SWAP16(x) CPL_STATIC_CAST(GUInt16, (CPL_STATIC_CAST(GUInt16, x) << 8) | (CPL_STATIC_CAST(GUInt16, x) >> 8) )
#if defined(HAVE_GCC_BSWAP)
/** Byte-swap a 32bit unsigned integer */
#define CPL_SWAP32(x) CPL_STATIC_CAST(GUInt32, __builtin_bswap32(CPL_STATIC_CAST(GUInt32, x)))
/** Byte-swap a 64bit unsigned integer */
#define CPL_SWAP64(x) CPL_STATIC_CAST(GUInt64, __builtin_bswap64(CPL_STATIC_CAST(GUInt64, x)))
#elif defined(_MSC_VER)
#define CPL_SWAP32(x) CPL_STATIC_CAST(GUInt32, _byteswap_ulong(CPL_STATIC_CAST(GUInt32, x)))
#define CPL_SWAP64(x) CPL_STATIC_CAST(GUInt64, _byteswap_uint64(CPL_STATIC_CAST(GUInt64, x)))
#else
/** Byte-swap a 32bit unsigned integer */
#define CPL_SWAP32(x) \
CPL_STATIC_CAST(GUInt32, \
((CPL_STATIC_CAST(GUInt32, x) & 0x000000ffU) << 24) | \
((CPL_STATIC_CAST(GUInt32, x) & 0x0000ff00U) << 8) | \
((CPL_STATIC_CAST(GUInt32, x) & 0x00ff0000U) >> 8) | \
((CPL_STATIC_CAST(GUInt32, x) & 0xff000000U) >> 24) )
/** Byte-swap a 64bit unsigned integer */
#define CPL_SWAP64(x) \
((CPL_STATIC_CAST(GUInt64, CPL_SWAP32(CPL_STATIC_CAST(GUInt32, x))) << 32) | \
(CPL_STATIC_CAST(GUInt64, CPL_SWAP32(CPL_STATIC_CAST(GUInt32, CPL_STATIC_CAST(GUInt64, x) >> 32)))))
#endif
/** Byte-swap a 16 bit pointer */
#define CPL_SWAP16PTR(x) \
do { \
GUInt16 _n16; \
void* _lx = x; \
memcpy(&_n16, _lx, 2); \
CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 2); \
_n16 = CPL_SWAP16(_n16); \
memcpy(_lx, &_n16, 2); \
} while(0)
/** Byte-swap a 32 bit pointer */
#define CPL_SWAP32PTR(x) \
do { \
GUInt32 _n32; \
void* _lx = x; \
memcpy(&_n32, _lx, 4); \
CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 4); \
_n32 = CPL_SWAP32(_n32); \
memcpy(_lx, &_n32, 4); \
} while(0)
/** Byte-swap a 64 bit pointer */
#define CPL_SWAP64PTR(x) \
do { \
GUInt64 _n64; \
void* _lx = x; \
memcpy(&_n64, _lx, 8); \
CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 8); \
_n64 = CPL_SWAP64(_n64); \
memcpy(_lx, &_n64, 8); \
} while(0)
/** Byte-swap a 64 bit pointer */
#define CPL_SWAPDOUBLE(p) CPL_SWAP64PTR(p)
#ifdef CPL_MSB
# define CPL_MSBWORD16(x) (x)
# define CPL_LSBWORD16(x) CPL_SWAP16(x)
# define CPL_MSBWORD32(x) (x)
# define CPL_LSBWORD32(x) CPL_SWAP32(x)
# define CPL_MSBPTR16(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 2)
# define CPL_LSBPTR16(x) CPL_SWAP16PTR(x)
# define CPL_MSBPTR32(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 4)
# define CPL_LSBPTR32(x) CPL_SWAP32PTR(x)
# define CPL_MSBPTR64(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 8)
# define CPL_LSBPTR64(x) CPL_SWAP64PTR(x)
#else
/** Return a 16bit word from a originally LSB ordered word */
# define CPL_LSBWORD16(x) (x)
/** Return a 16bit word from a originally MSB ordered word */
# define CPL_MSBWORD16(x) CPL_SWAP16(x)
/** Return a 32bit word from a originally LSB ordered word */
# define CPL_LSBWORD32(x) (x)
/** Return a 32bit word from a originally MSB ordered word */
# define CPL_MSBWORD32(x) CPL_SWAP32(x)
/** Byte-swap if necessary a 16bit word at the location pointed from a originally LSB ordered pointer */
# define CPL_LSBPTR16(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 2)
/** Byte-swap if necessary a 16bit word at the location pointed from a originally MSB ordered pointer */
# define CPL_MSBPTR16(x) CPL_SWAP16PTR(x)
/** Byte-swap if necessary a 32bit word at the location pointed from a originally LSB ordered pointer */
# define CPL_LSBPTR32(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 4)
/** Byte-swap if necessary a 32bit word at the location pointed from a originally MSB ordered pointer */
# define CPL_MSBPTR32(x) CPL_SWAP32PTR(x)
/** Byte-swap if necessary a 64bit word at the location pointed from a originally LSB ordered pointer */
# define CPL_LSBPTR64(x) CPL_STATIC_ASSERT_IF_AVAILABLE(sizeof(*(x)) == 1 || sizeof(*(x)) == 8)
/** Byte-swap if necessary a 64bit word at the location pointed from a originally MSB ordered pointer */
# define CPL_MSBPTR64(x) CPL_SWAP64PTR(x)
#endif
/** Return a Int16 from the 2 bytes ordered in LSB order at address x.
* @deprecated Use rather CPL_LSBSINT16PTR or CPL_LSBUINT16PTR for explicit
* signedness. */
#define CPL_LSBINT16PTR(x) ((*CPL_REINTERPRET_CAST(const GByte*, x)) | (*((CPL_REINTERPRET_CAST(const GByte*, x))+1) << 8))
/** Return a Int32 from the 4 bytes ordered in LSB order at address x.
* @deprecated Use rather CPL_LSBSINT32PTR or CPL_LSBUINT32PTR for explicit
* signedness. */
#define CPL_LSBINT32PTR(x) ((*CPL_REINTERPRET_CAST(const GByte*, x)) | (*((CPL_REINTERPRET_CAST(const GByte*, x))+1) << 8) | \
(*((CPL_REINTERPRET_CAST(const GByte*, x))+2) << 16) | (*((CPL_REINTERPRET_CAST(const GByte*, x))+3) << 24))
/** Return a signed Int16 from the 2 bytes ordered in LSB order at address x */
#define CPL_LSBSINT16PTR(x) CPL_STATIC_CAST(GInt16,CPL_LSBINT16PTR(x))
/** Return a unsigned Int16 from the 2 bytes ordered in LSB order at address x */
#define CPL_LSBUINT16PTR(x) CPL_STATIC_CAST(GUInt16, CPL_LSBINT16PTR(x))
/** Return a signed Int32 from the 4 bytes ordered in LSB order at address x */
#define CPL_LSBSINT32PTR(x) CPL_STATIC_CAST(GInt32, CPL_LSBINT32PTR(x))
/** Return a unsigned Int32 from the 4 bytes ordered in LSB order at address x */
#define CPL_LSBUINT32PTR(x) CPL_STATIC_CAST(GUInt32, CPL_LSBINT32PTR(x))
/*! @cond Doxygen_Suppress */
/* Utility macro to explicitly mark intentionally unreferenced parameters. */
#ifndef UNREFERENCED_PARAM
# ifdef UNREFERENCED_PARAMETER /* May be defined by Windows API */
# define UNREFERENCED_PARAM(param) UNREFERENCED_PARAMETER(param)
# else
# define UNREFERENCED_PARAM(param) ((void)param)
# endif /* UNREFERENCED_PARAMETER */
#endif /* UNREFERENCED_PARAM */
/*! @endcond */
/***********************************************************************
* Define CPL_CVSID() macro. It can be disabled during a build by
* defining DISABLE_CVSID in the compiler options.
*
* The cvsid_aw() function is just there to prevent reports of cpl_cvsid()
* being unused.
*/
/*! @cond Doxygen_Suppress */
#ifndef DISABLE_CVSID
#if defined(__GNUC__) && __GNUC__ >= 4
# define CPL_CVSID(string) static const char cpl_cvsid[] __attribute__((used)) = string;
#else
# define CPL_CVSID(string) static const char cpl_cvsid[] = string; \
static const char *cvsid_aw() { return( cvsid_aw() ? NULL : cpl_cvsid ); }
#endif
#else
# define CPL_CVSID(string)
#endif
/*! @endcond */
/* We exclude mingw64 4.6 which seems to be broken regarding this */
#if defined(__GNUC__) && __GNUC__ >= 4 && !defined(DOXYGEN_SKIP) && !(defined(__MINGW64__) && __GNUC__ == 4 && __GNUC_MINOR__ == 6)
/** Null terminated variadic */
# define CPL_NULL_TERMINATED __attribute__((__sentinel__))
#else
/** Null terminated variadic */
# define CPL_NULL_TERMINATED
#endif
#if defined(__GNUC__) && __GNUC__ >= 3 && !defined(DOXYGEN_SKIP)
/** Tag a function to have printf() formatting */
#define CPL_PRINT_FUNC_FORMAT( format_idx, arg_idx ) __attribute__((__format__ (__printf__, format_idx, arg_idx)))
/** Tag a function to have scanf() formatting */
#define CPL_SCAN_FUNC_FORMAT( format_idx, arg_idx ) __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
#else
/** Tag a function to have printf() formatting */
#define CPL_PRINT_FUNC_FORMAT( format_idx, arg_idx )
/** Tag a function to have scanf() formatting */
#define CPL_SCAN_FUNC_FORMAT( format_idx, arg_idx )
#endif
#if defined(_MSC_VER) && (defined(GDAL_COMPILATION) || defined(CPL_ENABLE_MSVC_ANNOTATIONS))
#include <sal.h>
/** Macro into which to wrap the format argument of a printf-like function.
* Only used if ANALYZE=1 is specified to nmake */
# define CPL_FORMAT_STRING(arg) _Printf_format_string_ arg
/** Macro into which to wrap the format argument of a sscanf-like function.
* Only used if ANALYZE=1 is specified to nmake */
# define CPL_SCANF_FORMAT_STRING(arg) _Scanf_format_string_ arg
#else
/** Macro into which to wrap the format argument of a printf-like function */
# define CPL_FORMAT_STRING(arg) arg
/** Macro into which to wrap the format argument of a sscanf-like function. */
# define CPL_SCANF_FORMAT_STRING(arg) arg
#endif /* defined(_MSC_VER) && defined(GDAL_COMPILATION) */
#if defined(__GNUC__) && __GNUC__ >= 4 && !defined(DOXYGEN_SKIP)
/** Qualifier to warn when the return value of a function is not used */
#define CPL_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
#else
/** Qualifier to warn when the return value of a function is not used */
#define CPL_WARN_UNUSED_RESULT
#endif
#if defined(__GNUC__) && __GNUC__ >= 4
/** Qualifier for an argument that is unused */
# define CPL_UNUSED __attribute((__unused__))
#else
/* TODO: add cases for other compilers */
/** Qualifier for an argument that is unused */
# define CPL_UNUSED
#endif
#if defined(__GNUC__) && __GNUC__ >= 3 && !defined(DOXYGEN_SKIP)
/** Qualifier for a function that does not return at all (terminates the process) */
#define CPL_NO_RETURN __attribute__((noreturn))
#else
/** Qualifier for a function that does not return at all (terminates the process) */
#define CPL_NO_RETURN
#endif
/*! @cond Doxygen_Suppress */
/* Clang __has_attribute */
#ifndef __has_attribute
#define __has_attribute(x) 0 // Compatibility with non-clang compilers.
#endif
/*! @endcond */
#if ((defined(__GNUC__) && (__GNUC__ >= 5 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 9))) || __has_attribute(returns_nonnull)) && !defined(DOXYGEN_SKIP) && !defined(__INTEL_COMPILER)
/** Qualifier for a function that does not return NULL */
# define CPL_RETURNS_NONNULL __attribute__((returns_nonnull))
#else
/** Qualifier for a function that does not return NULL */
# define CPL_RETURNS_NONNULL
#endif
#if defined(__GNUC__) && __GNUC__ >= 4 && !defined(DOXYGEN_SKIP)
/** restrict keyword to declare that pointers do not alias */
#define CPL_RESTRICT __restrict__
#else
/** restrict keyword to declare that pointers do not alias */
#define CPL_RESTRICT
#endif
#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
/** To be used in public headers only. For non-public headers or .cpp files,
* use override directly. */
# define CPL_OVERRIDE override
/** C++11 final qualifier */
# define CPL_FINAL final
/** Mark that a class is explicitly recognized as non-final */
# define CPL_NON_FINAL
/** Helper to remove the copy and assignment constructors so that the compiler
will not generate the default versions.
Must be placed in the private section of a class and should be at the end.
*/
# define CPL_DISALLOW_COPY_ASSIGN(ClassName) \
ClassName( const ClassName & ) = delete; \
ClassName &operator=( const ClassName & ) = delete;
#endif /* __cplusplus */
#if !defined(DOXYGEN_SKIP) && !defined(CPL_WARN_DEPRECATED)
#if defined(__has_extension)
#if __has_extension(attribute_deprecated_with_message)
/* Clang extension */
#define CPL_WARN_DEPRECATED(x) __attribute__ ((deprecated(x)))
#else
#define CPL_WARN_DEPRECATED(x)
#endif
#elif defined(__GNUC__)
#define CPL_WARN_DEPRECATED(x) __attribute__ ((deprecated))
#else
#define CPL_WARN_DEPRECATED(x)
#endif
#endif
#if !defined(_MSC_VER) && !defined(__APPLE__) && !defined(_FORTIFY_SOURCE)
CPL_C_START
# if defined(GDAL_COMPILATION) && defined(WARN_STANDARD_PRINTF)
int vsnprintf(char *str, size_t size, const char* fmt, va_list args)
CPL_WARN_DEPRECATED("Use CPLvsnprintf() instead");
int snprintf(char *str, size_t size, const char* fmt, ...)
CPL_PRINT_FUNC_FORMAT(3,4)
CPL_WARN_DEPRECATED("Use CPLsnprintf() instead");
int sprintf(char *str, const char* fmt, ...)
CPL_PRINT_FUNC_FORMAT(2, 3)
CPL_WARN_DEPRECATED("Use CPLsnprintf() instead");
# elif defined(GDAL_COMPILATION) && !defined(DONT_DEPRECATE_SPRINTF)
int sprintf(char *str, const char* fmt, ...)
CPL_PRINT_FUNC_FORMAT(2, 3)
CPL_WARN_DEPRECATED("Use snprintf() or CPLsnprintf() instead");
# endif /* defined(GDAL_COMPILATION) && defined(WARN_STANDARD_PRINTF) */
CPL_C_END
#endif /* !defined(_MSC_VER) && !defined(__APPLE__) */
#if defined(MAKE_SANITIZE_HAPPY) || !(defined(__i386__) || defined(__x86_64__) || defined(_M_IX86) || defined(_M_X64))
/*! @cond Doxygen_Suppress */
#define CPL_CPU_REQUIRES_ALIGNED_ACCESS
/*! @endcond */
#endif
#if defined(__cplusplus)
#ifndef CPPCHECK
/** Returns the size of C style arrays. */
#define CPL_ARRAYSIZE(array) \
((sizeof(array) / sizeof(*(array))) / \
static_cast<size_t>(!(sizeof(array) % sizeof(*(array)))))
#else
/* simplified version for cppcheck */
#define CPL_ARRAYSIZE(array) (sizeof(array) / sizeof(array[0]))
#endif
extern "C++" {
template<class T> static void CPL_IGNORE_RET_VAL(const T&) {}
inline static bool CPL_TO_BOOL(int x) { return x != 0; }
} /* extern "C++" */
#endif /* __cplusplus */
#if (((__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)) || (defined(__clang__) && __clang_major__ >= 3)) && !defined(_MSC_VER))
#define HAVE_GCC_DIAGNOSTIC_PUSH
#endif
#if ((__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 2)) && !defined(_MSC_VER))
#define HAVE_GCC_SYSTEM_HEADER
#endif
#if ((defined(__clang__) && (__clang_major__ > 3 || (__clang_major__ == 3 && __clang_minor__ >=7))) || __GNUC__ >= 7)
/** Macro for fallthrough in a switch case construct */