SDTS_AL
|
00001 /****************************************************************************** 00002 * $Id: cpl_port.h 19887 2010-06-17 22:47:55Z rouault $ 00003 * 00004 * Project: CPL - Common Portability Library 00005 * Author: Frank Warmerdam, warmerdam@pobox.com 00006 * Purpose: Include file providing low level portability services for CPL. 00007 * This should be the first include file for any CPL based code. 00008 * 00009 ****************************************************************************** 00010 * Copyright (c) 1998, 2005, Frank Warmerdam <warmerdam@pobox.com> 00011 * 00012 * Permission is hereby granted, free of charge, to any person obtaining a 00013 * copy of this software and associated documentation files (the "Software"), 00014 * to deal in the Software without restriction, including without limitation 00015 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 00016 * and/or sell copies of the Software, and to permit persons to whom the 00017 * Software is furnished to do so, subject to the following conditions: 00018 * 00019 * The above copyright notice and this permission notice shall be included 00020 * in all copies or substantial portions of the Software. 00021 * 00022 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 00023 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 00024 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 00025 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 00026 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 00027 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 00028 * DEALINGS IN THE SOFTWARE. 00029 ****************************************************************************/ 00030 00031 #ifndef CPL_BASE_H_INCLUDED 00032 #define CPL_BASE_H_INCLUDED 00033 00034 /* Remove annoying warnings Microsoft Visual C++ */ 00035 #if defined(_MSC_VER) 00036 # pragma warning(disable:4251 4275 4786) 00037 #endif 00038 00046 /* ==================================================================== */ 00047 /* We will use macos_pre10 to indicate compilation with MacOS */ 00048 /* versions before MacOS X. */ 00049 /* ==================================================================== */ 00050 #ifdef macintosh 00051 # define macos_pre10 00052 #endif 00053 00054 /* ==================================================================== */ 00055 /* We will use WIN32 as a standard windows define. */ 00056 /* ==================================================================== */ 00057 #if defined(_WIN32) && !defined(WIN32) && !defined(_WIN32_WCE) 00058 # define WIN32 00059 #endif 00060 00061 #if defined(_WINDOWS) && !defined(WIN32) && !defined(_WIN32_WCE) 00062 # define WIN32 00063 #endif 00064 00065 /* ==================================================================== */ 00066 /* We will use WIN32CE as a standard Windows CE (Mobile) define. */ 00067 /* ==================================================================== */ 00068 #if defined(_WIN32_WCE) 00069 # define WIN32CE 00070 #endif 00071 00072 /* -------------------------------------------------------------------- */ 00073 /* The following apparently allow you to use strcpy() and other */ 00074 /* functions judged "unsafe" by microsoft in VS 8 (2005). */ 00075 /* -------------------------------------------------------------------- */ 00076 #ifdef _MSC_VER 00077 # ifndef _CRT_SECURE_NO_DEPRECATE 00078 # define _CRT_SECURE_NO_DEPRECATE 00079 # endif 00080 # ifndef _CRT_NONSTDC_NO_DEPRECATE 00081 # define _CRT_NONSTDC_NO_DEPRECATE 00082 # endif 00083 # ifdef MSVC_USE_VLD 00084 # include <vld.h> 00085 # endif 00086 #endif 00087 00088 #include "cpl_config.h" 00089 00090 /* ==================================================================== */ 00091 /* This will disable most WIN32 stuff in a Cygnus build which */ 00092 /* defines unix to 1. */ 00093 /* ==================================================================== */ 00094 00095 #ifdef unix 00096 # undef WIN32 00097 # undef WIN32CE 00098 #endif 00099 00100 #if defined(VSI_NEED_LARGEFILE64_SOURCE) && !defined(_LARGEFILE64_SOURCE) 00101 # define _LARGEFILE64_SOURCE 1 00102 #endif 00103 00104 /* ==================================================================== */ 00105 /* Standard include files. */ 00106 /* ==================================================================== */ 00107 00108 #include <stdio.h> 00109 #include <stdlib.h> 00110 #include <math.h> 00111 #include <stdarg.h> 00112 #include <string.h> 00113 #include <ctype.h> 00114 #include <limits.h> 00115 00116 #if !defined(WIN32CE) 00117 # include <time.h> 00118 #else 00119 # include <wce_time.h> 00120 # include <wce_errno.h> 00121 #endif 00122 00123 00124 #if defined(HAVE_ERRNO_H) 00125 # include <errno.h> 00126 #endif 00127 00128 #ifdef HAVE_LOCALE_H 00129 # include <locale.h> 00130 #endif 00131 00132 #ifdef HAVE_DIRECT_H 00133 # include <direct.h> 00134 #endif 00135 00136 #ifdef _AIX 00137 # include <strings.h> 00138 #endif 00139 00140 #if defined(HAVE_LIBDBMALLOC) && defined(HAVE_DBMALLOC_H) && defined(DEBUG) 00141 # define DBMALLOC 00142 # include <dbmalloc.h> 00143 #endif 00144 00145 #if !defined(DBMALLOC) && defined(HAVE_DMALLOC_H) 00146 # define USE_DMALLOC 00147 # include <dmalloc.h> 00148 #endif 00149 00150 /* ==================================================================== */ 00151 /* Base portability stuff ... this stuff may need to be */ 00152 /* modified for new platforms. */ 00153 /* ==================================================================== */ 00154 00155 /*--------------------------------------------------------------------- 00156 * types for 16 and 32 bits integers, etc... 00157 *--------------------------------------------------------------------*/ 00158 #if UINT_MAX == 65535 00159 typedef long GInt32; 00160 typedef unsigned long GUInt32; 00161 #else 00162 typedef int GInt32; 00163 typedef unsigned int GUInt32; 00164 #endif 00165 00166 typedef short GInt16; 00167 typedef unsigned short GUInt16; 00168 typedef unsigned char GByte; 00169 typedef int GBool; 00170 00171 /* -------------------------------------------------------------------- */ 00172 /* 64bit support */ 00173 /* -------------------------------------------------------------------- */ 00174 00175 #if defined(WIN32) && defined(_MSC_VER) 00176 00177 #define VSI_LARGE_API_SUPPORTED 00178 typedef __int64 GIntBig; 00179 typedef unsigned __int64 GUIntBig; 00180 00181 #elif HAVE_LONG_LONG 00182 00183 typedef long long GIntBig; 00184 typedef unsigned long long GUIntBig; 00185 00186 #else 00187 00188 typedef long GIntBig; 00189 typedef unsigned long GUIntBig; 00190 00191 #endif 00192 00193 #if defined(__MSVCRT__) || (defined(WIN32) && defined(_MSC_VER)) 00194 #define CPL_FRMT_GB_WITHOUT_PREFIX "I64" 00195 #elif HAVE_LONG_LONG 00196 #define CPL_FRMT_GB_WITHOUT_PREFIX "ll" 00197 #else 00198 #define CPL_FRMT_GB_WITHOUT_PREFIX "l" 00199 #endif 00200 00201 #define CPL_FRMT_GIB "%" CPL_FRMT_GB_WITHOUT_PREFIX "d" 00202 #define CPL_FRMT_GUIB "%" CPL_FRMT_GB_WITHOUT_PREFIX "u" 00203 00204 /* Workaround VC6 bug */ 00205 #if defined(_MSC_VER) && (_MSC_VER <= 1200) 00206 #define GUINTBIG_TO_DOUBLE(x) (double)(GIntBig)(x) 00207 #else 00208 #define GUINTBIG_TO_DOUBLE(x) (double)(x) 00209 #endif 00210 00211 /* ==================================================================== */ 00212 /* Other standard services. */ 00213 /* ==================================================================== */ 00214 #ifdef __cplusplus 00215 # define CPL_C_START extern "C" { 00216 # define CPL_C_END } 00217 #else 00218 # define CPL_C_START 00219 # define CPL_C_END 00220 #endif 00221 00222 #ifndef CPL_DLL 00223 #if defined(_MSC_VER) && !defined(CPL_DISABLE_DLL) 00224 # define CPL_DLL __declspec(dllexport) 00225 #else 00226 # if defined(USE_GCC_VISIBILITY_FLAG) 00227 # define CPL_DLL __attribute__ ((visibility("default"))) 00228 # else 00229 # define CPL_DLL 00230 # endif 00231 #endif 00232 #endif 00233 00234 /* Should optional (normally private) interfaces be exported? */ 00235 #ifdef CPL_OPTIONAL_APIS 00236 # define CPL_ODLL CPL_DLL 00237 #else 00238 # define CPL_ODLL 00239 #endif 00240 00241 #ifndef CPL_STDCALL 00242 #if defined(_MSC_VER) && !defined(CPL_DISABLE_STDCALL) 00243 # define CPL_STDCALL __stdcall 00244 #else 00245 # define CPL_STDCALL 00246 #endif 00247 #endif 00248 00249 #ifdef _MSC_VER 00250 # define FORCE_CDECL __cdecl 00251 #else 00252 # define FORCE_CDECL 00253 #endif 00254 00255 /* TODO : support for other compilers needed */ 00256 #if defined(__GNUC__) || defined(_MSC_VER) 00257 #define HAS_CPL_INLINE 1 00258 #define CPL_INLINE __inline 00259 #elif defined(__SUNPRO_CC) 00260 #define HAS_CPL_INLINE 1 00261 #define CPL_INLINE inline 00262 #else 00263 #define CPL_INLINE 00264 #endif 00265 00266 #ifndef NULL 00267 # define NULL 0 00268 #endif 00269 00270 #ifndef FALSE 00271 # define FALSE 0 00272 #endif 00273 00274 #ifndef TRUE 00275 # define TRUE 1 00276 #endif 00277 00278 #ifndef MAX 00279 # define MIN(a,b) ((a<b) ? a : b) 00280 # define MAX(a,b) ((a>b) ? a : b) 00281 #endif 00282 00283 #ifndef ABS 00284 # define ABS(x) ((x<0) ? (-1*(x)) : x) 00285 #endif 00286 00287 /* -------------------------------------------------------------------- */ 00288 /* Macro to test equality of two floating point values. */ 00289 /* We use fabs() function instead of ABS() macro to avoid side */ 00290 /* effects. */ 00291 /* -------------------------------------------------------------------- */ 00292 #ifndef CPLIsEqual 00293 # define CPLIsEqual(x,y) (fabs((x) - (y)) < 0.0000000000001) 00294 #endif 00295 00296 #ifndef EQUAL 00297 #if defined(WIN32) || defined(WIN32CE) 00298 # define EQUALN(a,b,n) (strnicmp(a,b,n)==0) 00299 # define EQUAL(a,b) (stricmp(a,b)==0) 00300 #else 00301 # define EQUALN(a,b,n) (strncasecmp(a,b,n)==0) 00302 # define EQUAL(a,b) (strcasecmp(a,b)==0) 00303 #endif 00304 #endif 00305 00306 #ifdef macos_pre10 00307 int strcasecmp(char * str1, char * str2); 00308 int strncasecmp(char * str1, char * str2, int len); 00309 char * strdup (char *instr); 00310 #endif 00311 00312 #ifndef CPL_THREADLOCAL 00313 # define CPL_THREADLOCAL 00314 #endif 00315 00316 /* -------------------------------------------------------------------- */ 00317 /* Handle isnan() and isinf(). Note that isinf() and isnan() */ 00318 /* are supposed to be macros according to C99, defined in math.h */ 00319 /* Some systems (ie. Tru64) don't have isinf() at all, so if */ 00320 /* the macro is not defined we just assume nothing is infinite. */ 00321 /* This may mean we have no real CPLIsInf() on systems with isinf()*/ 00322 /* function but no corresponding macro, but I can live with */ 00323 /* that since it isn't that important a test. */ 00324 /* -------------------------------------------------------------------- */ 00325 #ifdef _MSC_VER 00326 # include <float.h> 00327 # define CPLIsNan(x) _isnan(x) 00328 # define CPLIsInf(x) (!_isnan(x) && !_finite(x)) 00329 # define CPLIsFinite(x) _finite(x) 00330 #else 00331 # define CPLIsNan(x) isnan(x) 00332 # ifdef isinf 00333 # define CPLIsInf(x) isinf(x) 00334 # define CPLIsFinite(x) (!isnan(x) && !isinf(x)) 00335 # else 00336 # define CPLIsInf(x) FALSE 00337 # define CPLIsFinite(x) (!isnan(x)) 00338 # endif 00339 #endif 00340 00341 /*--------------------------------------------------------------------- 00342 * CPL_LSB and CPL_MSB 00343 * Only one of these 2 macros should be defined and specifies the byte 00344 * ordering for the current platform. 00345 * This should be defined in the Makefile, but if it is not then 00346 * the default is CPL_LSB (Intel ordering, LSB first). 00347 *--------------------------------------------------------------------*/ 00348 #if defined(WORDS_BIGENDIAN) && !defined(CPL_MSB) && !defined(CPL_LSB) 00349 # define CPL_MSB 00350 #endif 00351 00352 #if ! ( defined(CPL_LSB) || defined(CPL_MSB) ) 00353 #define CPL_LSB 00354 #endif 00355 00356 #if defined(CPL_LSB) 00357 # define CPL_IS_LSB 1 00358 #else 00359 # define CPL_IS_LSB 0 00360 #endif 00361 00362 /*--------------------------------------------------------------------- 00363 * Little endian <==> big endian byte swap macros. 00364 *--------------------------------------------------------------------*/ 00365 00366 #define CPL_SWAP16(x) \ 00367 ((GUInt16)( \ 00368 (((GUInt16)(x) & 0x00ffU) << 8) | \ 00369 (((GUInt16)(x) & 0xff00U) >> 8) )) 00370 00371 #define CPL_SWAP16PTR(x) \ 00372 { \ 00373 GByte byTemp, *_pabyDataT = (GByte *) (x); \ 00374 \ 00375 byTemp = _pabyDataT[0]; \ 00376 _pabyDataT[0] = _pabyDataT[1]; \ 00377 _pabyDataT[1] = byTemp; \ 00378 } 00379 00380 #define CPL_SWAP32(x) \ 00381 ((GUInt32)( \ 00382 (((GUInt32)(x) & (GUInt32)0x000000ffUL) << 24) | \ 00383 (((GUInt32)(x) & (GUInt32)0x0000ff00UL) << 8) | \ 00384 (((GUInt32)(x) & (GUInt32)0x00ff0000UL) >> 8) | \ 00385 (((GUInt32)(x) & (GUInt32)0xff000000UL) >> 24) )) 00386 00387 #define CPL_SWAP32PTR(x) \ 00388 { \ 00389 GByte byTemp, *_pabyDataT = (GByte *) (x); \ 00390 \ 00391 byTemp = _pabyDataT[0]; \ 00392 _pabyDataT[0] = _pabyDataT[3]; \ 00393 _pabyDataT[3] = byTemp; \ 00394 byTemp = _pabyDataT[1]; \ 00395 _pabyDataT[1] = _pabyDataT[2]; \ 00396 _pabyDataT[2] = byTemp; \ 00397 } 00398 00399 #define CPL_SWAP64PTR(x) \ 00400 { \ 00401 GByte byTemp, *_pabyDataT = (GByte *) (x); \ 00402 \ 00403 byTemp = _pabyDataT[0]; \ 00404 _pabyDataT[0] = _pabyDataT[7]; \ 00405 _pabyDataT[7] = byTemp; \ 00406 byTemp = _pabyDataT[1]; \ 00407 _pabyDataT[1] = _pabyDataT[6]; \ 00408 _pabyDataT[6] = byTemp; \ 00409 byTemp = _pabyDataT[2]; \ 00410 _pabyDataT[2] = _pabyDataT[5]; \ 00411 _pabyDataT[5] = byTemp; \ 00412 byTemp = _pabyDataT[3]; \ 00413 _pabyDataT[3] = _pabyDataT[4]; \ 00414 _pabyDataT[4] = byTemp; \ 00415 } 00416 00417 00418 /* Until we have a safe 64 bits integer data type defined, we'll replace 00419 * this version of the CPL_SWAP64() macro with a less efficient one. 00420 */ 00421 /* 00422 #define CPL_SWAP64(x) \ 00423 ((uint64)( \ 00424 (uint64)(((uint64)(x) & (uint64)0x00000000000000ffULL) << 56) | \ 00425 (uint64)(((uint64)(x) & (uint64)0x000000000000ff00ULL) << 40) | \ 00426 (uint64)(((uint64)(x) & (uint64)0x0000000000ff0000ULL) << 24) | \ 00427 (uint64)(((uint64)(x) & (uint64)0x00000000ff000000ULL) << 8) | \ 00428 (uint64)(((uint64)(x) & (uint64)0x000000ff00000000ULL) >> 8) | \ 00429 (uint64)(((uint64)(x) & (uint64)0x0000ff0000000000ULL) >> 24) | \ 00430 (uint64)(((uint64)(x) & (uint64)0x00ff000000000000ULL) >> 40) | \ 00431 (uint64)(((uint64)(x) & (uint64)0xff00000000000000ULL) >> 56) )) 00432 */ 00433 00434 #define CPL_SWAPDOUBLE(p) CPL_SWAP64PTR(p) 00435 00436 #ifdef CPL_MSB 00437 # define CPL_MSBWORD16(x) (x) 00438 # define CPL_LSBWORD16(x) CPL_SWAP16(x) 00439 # define CPL_MSBWORD32(x) (x) 00440 # define CPL_LSBWORD32(x) CPL_SWAP32(x) 00441 # define CPL_MSBPTR16(x) 00442 # define CPL_LSBPTR16(x) CPL_SWAP16PTR(x) 00443 # define CPL_MSBPTR32(x) 00444 # define CPL_LSBPTR32(x) CPL_SWAP32PTR(x) 00445 # define CPL_MSBPTR64(x) 00446 # define CPL_LSBPTR64(x) CPL_SWAP64PTR(x) 00447 #else 00448 # define CPL_LSBWORD16(x) (x) 00449 # define CPL_MSBWORD16(x) CPL_SWAP16(x) 00450 # define CPL_LSBWORD32(x) (x) 00451 # define CPL_MSBWORD32(x) CPL_SWAP32(x) 00452 # define CPL_LSBPTR16(x) 00453 # define CPL_MSBPTR16(x) CPL_SWAP16PTR(x) 00454 # define CPL_LSBPTR32(x) 00455 # define CPL_MSBPTR32(x) CPL_SWAP32PTR(x) 00456 # define CPL_LSBPTR64(x) 00457 # define CPL_MSBPTR64(x) CPL_SWAP64PTR(x) 00458 #endif 00459 00461 #define CPL_LSBINT16PTR(x) ((*(GByte*)(x)) | ((*(GByte*)((x)+1)) << 8)) 00462 00464 #define CPL_LSBINT32PTR(x) ((*(GByte*)(x)) | ((*(GByte*)((x)+1)) << 8) | \ 00465 ((*(GByte*)((x)+2)) << 16) | ((*(GByte*)((x)+3)) << 24)) 00466 00467 00468 /* Utility macro to explicitly mark intentionally unreferenced parameters. */ 00469 #ifndef UNREFERENCED_PARAM 00470 # ifdef UNREFERENCED_PARAMETER /* May be defined by Windows API */ 00471 # define UNREFERENCED_PARAM(param) UNREFERENCED_PARAMETER(param) 00472 # else 00473 # define UNREFERENCED_PARAM(param) ((void)param) 00474 # endif /* UNREFERENCED_PARAMETER */ 00475 #endif /* UNREFERENCED_PARAM */ 00476 00477 /*********************************************************************** 00478 * Define CPL_CVSID() macro. It can be disabled during a build by 00479 * defining DISABLE_CPLID in the compiler options. 00480 * 00481 * The cvsid_aw() function is just there to prevent reports of cpl_cvsid() 00482 * being unused. 00483 */ 00484 00485 #ifndef DISABLE_CVSID 00486 #if defined(__GNUC__) && __GNUC__ >= 4 00487 # define CPL_CVSID(string) static char cpl_cvsid[] __attribute__((used)) = string; 00488 #else 00489 # define CPL_CVSID(string) static char cpl_cvsid[] = string; \ 00490 static char *cvsid_aw() { return( cvsid_aw() ? ((char *) NULL) : cpl_cvsid ); } 00491 #endif 00492 #else 00493 # define CPL_CVSID(string) 00494 #endif 00495 00496 #if defined(__GNUC__) && __GNUC__ >= 3 && !defined(DOXYGEN_SKIP) 00497 #define CPL_PRINT_FUNC_FORMAT( format_idx, arg_idx ) __attribute__((__format__ (__printf__, format_idx, arg_idx))) 00498 #else 00499 #define CPL_PRINT_FUNC_FORMAT( format_idx, arg_idx ) 00500 #endif 00501 00502 #endif /* ndef CPL_BASE_H_INCLUDED */