1183 lines
41 KiB
C++
1183 lines
41 KiB
C++
/******************************************************************************
|
|
* $Id$
|
|
*
|
|
* Project: CPL - Common Portability Library
|
|
* Author: Frank Warmerdam, warmerdam@pobox.com
|
|
* 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 <warmerdam@pobox.com>
|
|
* Copyright (c) 2008-2013, Even Rouault <even dot rouault at spatialys.com>
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
****************************************************************************/
|
|
|
|
#ifndef CPL_BASE_H_INCLUDED
|
|
#define CPL_BASE_H_INCLUDED
|
|
|
|
/**
|
|
* \file cpl_port.h
|
|
*
|
|
* Core portability definitions for CPL.
|
|
*
|
|
*/
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/* 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)
|
|
#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 */
|
|
/* ==================================================================== */
|
|
|
|
/* 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;
|
|
/** Signed int8 type */
|
|
typedef signed char GInt8;
|
|
/* 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
|
|
#include <stddef.h> // ptrdiff_t
|
|
/** Integer type large enough to hold the difference between 2 addresses */
|
|
typedef ptrdiff_t GPtrDiff_t;
|
|
#elif 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 */
|
|
|
|
#ifndef GDAL_COMPILATION
|
|
/*! @cond Doxygen_Suppress */
|
|
/* -------------------------------------------------------------------- */
|
|
/* 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
|
|
/*! @endcond */
|
|
#endif // GDAL_COMPILATION
|
|
|
|
/*! @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(__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
|
|
|
|
/*! @cond Doxygen_Suppress */
|
|
|
|
#ifndef FALSE
|
|
#define FALSE 0
|
|
#endif
|
|
|
|
#ifndef TRUE
|
|
#define TRUE 1
|
|
#endif
|
|
|
|
#if __clang_major__ >= 4 || (__clang_major__ == 3 && __clang_minor__ >= 8)
|
|
#define CPL_NOSANITIZE_UNSIGNED_INT_OVERFLOW \
|
|
__attribute__((no_sanitize("unsigned-integer-overflow")))
|
|
#else
|
|
#define CPL_NOSANITIZE_UNSIGNED_INT_OVERFLOW
|
|
#endif
|
|
|
|
#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS) && \
|
|
defined(GDAL_COMPILATION)
|
|
extern "C++"
|
|
{
|
|
template <class C, class A, class B>
|
|
CPL_NOSANITIZE_UNSIGNED_INT_OVERFLOW inline C CPLUnsanitizedAdd(A a, B b)
|
|
{
|
|
return a + b;
|
|
}
|
|
}
|
|
#endif
|
|
|
|
#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
|
|
#define CPL_NULLPTR nullptr
|
|
#else
|
|
#define CPL_NULLPTR NULL
|
|
#endif
|
|
|
|
#if defined(__cplusplus) && defined(GDAL_COMPILATION)
|
|
extern "C++"
|
|
{
|
|
namespace cpl
|
|
{
|
|
/** Function to indicate that the result of an arithmetic operation
|
|
* does fit on the specified type. Typically used to avoid warnings
|
|
* about potentially overflowing multiplications by static analyzers.
|
|
*/
|
|
template <typename T> inline T fits_on(T t)
|
|
{
|
|
return t;
|
|
}
|
|
|
|
/** Emulates the C++20 .contains() method */
|
|
template <typename C, typename V>
|
|
inline bool contains(const C &container, const V &value)
|
|
{
|
|
return container.find(value) != container.end();
|
|
}
|
|
|
|
} // namespace cpl
|
|
}
|
|
#endif
|
|
|
|
/*! @endcond */
|
|
|
|
/* This typedef is for C functions that take char** as argument, but */
|
|
/* with the semantics of a const list. In C, char** is not implicitly cast to */
|
|
/* const char* const*, contrary to C++. So when seen for C++, it is OK */
|
|
/* to expose the prototypes as const char* const*, but for C we keep the */
|
|
/* historical definition to avoid warnings. */
|
|
#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS) && \
|
|
!defined(DOXYGEN_SKIP)
|
|
/** Type of a constant null-terminated list of nul terminated strings.
|
|
* Seen as char** from C and const char* const* from C++ */
|
|
typedef const char *const *CSLConstList;
|
|
#else
|
|
/** Type of a constant null-terminated list of nul terminated strings.
|
|
* Seen as char** from C and const char* const* from C++ */
|
|
typedef char **CSLConstList;
|
|
#endif
|
|
|
|
#endif /* ndef CPL_BASE_H_INCLUDED */
|