STLSoft: platformstl/platformstl.h Source File

00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        platformstl/platformstl.h
00003  *
00004  * Purpose:     Root header for the PlatformSTL C/C++ libraries. Performs
00005  *              platform discriminations, and definitions of types.
00006  *
00007  * Created:     20th March 2005
00008  * Updated:     30th January 2010
00009  *
00010  * Home:        http://stlsoft.org/
00011  *
00012  * Copyright (c) 2005-2010, Matthew Wilson and Synesis Software
00013  * All rights reserved.
00014  *
00015  * Redistribution and use in source and binary forms, with or without
00016  * modification, are permitted provided that the following conditions are
00017  * met:
00018  *
00019  * - Redistributions of source code must retain the above copyright notice,
00020  *   this list of conditions and the following disclaimer.
00021  * - Redistributions in binary form must reproduce the above copyright
00022  *   notice, this list of conditions and the following disclaimer in the
00023  *   documentation and/or other materials provided with the distribution.
00024  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the
00025  *   names of any contributors may be used to endorse or promote products
00026  *   derived from this software without specific prior written permission.
00027  *
00028  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00029  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00030  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00031  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00032  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00033  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00034  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00035  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00036  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00037  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00038  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00039  *
00040  * ////////////////////////////////////////////////////////////////////// */
00041 
00042 
00043 #ifndef PLATFORMSTL_INCL_PLATFORMSTL_H_PLATFORMSTL
00044 #define PLATFORMSTL_INCL_PLATFORMSTL_H_PLATFORMSTL
00045 
00046 /* File version */
00047 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00048 # define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_MAJOR    1
00049 # define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_MINOR    13
00050 # define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_REVISION 2
00051 # define PLATFORMSTL_VER_PLATFORMSTL_H_PLATFORMSTL_EDIT     39
00052 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00053 
00061 /* /////////////////////////////////////////////////////////////////////////
00062  * PlatformSTL version
00063  *
00064  * The libraries version information is comprised of major, minor and revision
00065  * components.
00066  *
00067  * The major version is denoted by the _PLATFORMSTL_VER_MAJOR preprocessor symbol.
00068  * A changes to the major version component implies that a dramatic change has
00069  * occurred in the libraries, such that considerable changes to source dependent
00070  * on previous versions would need to be effected.
00071  *
00072  * The minor version is denoted by the _PLATFORMSTL_VER_MINOR preprocessor symbol.
00073  * Changes to the minor version component imply that a significant change has
00074  * occurred to the libraries, either in the addition of new functionality or in
00075  * the destructive change to one or more components such that recomplilation and
00076  * code change may be necessitated.
00077  *
00078  * The revision version is denoted by the _PLATFORMSTL_VER_REVISION preprocessor
00079  * symbol. Changes to the revision version component imply that a bug has been
00080  * fixed. Dependent code should be recompiled in order to pick up the changes.
00081  *
00082  * In addition to the individual version symbols - _PLATFORMSTL_VER_MAJOR,
00083  * _PLATFORMSTL_VER_MINOR and _PLATFORMSTL_VER_REVISION - a composite symbol _PLATFORMSTL_VER
00084  * is defined, where the upper 8 bits are 0, bits 16-23 represent the major
00085  * component,  bits 8-15 represent the minor component, and bits 0-7 represent
00086  * the revision component.
00087  *
00088  * Each release of the libraries will bear a different version, and that version
00089  * will also have its own symbol: Version 1.0.1 specifies _PLATFORMSTL_VER_1_0_1.
00090  *
00091  * Thus the symbol _PLATFORMSTL_VER may be compared meaningfully with a specific
00092  * version symbol, e.g.# if _PLATFORMSTL_VER >= _PLATFORMSTL_VER_1_0_1
00093  */
00094 
00111 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00112 # define _PLATFORMSTL_VER_1_0_1     0x00010001  
00113 # define _PLATFORMSTL_VER_1_1_1     0x00010101  
00114 # define _PLATFORMSTL_VER_1_1_2     0x00010102  
00115 # define _PLATFORMSTL_VER_1_2_1     0x00010201  
00116 # define _PLATFORMSTL_VER_1_3_1     0x00010301  
00117 # define _PLATFORMSTL_VER_1_4_1     0x00010401  
00118 # define _PLATFORMSTL_VER_1_4_2     0x00010402  
00119 # define _PLATFORMSTL_VER_1_5_1     0x00010501  
00120 # define _PLATFORMSTL_VER_1_6_1     0x00010601  
00121 # define _PLATFORMSTL_VER_1_6_2     0x00010602  
00122 # define _PLATFORMSTL_VER_1_7_1     0x00010701  
00123 # define _PLATFORMSTL_VER_1_7_2     0x010702ff  
00124 # define _PLATFORMSTL_VER_1_8_1     0x010801ff  
00125 # define _PLATFORMSTL_VER_1_8_2     0x010802ff  
00126 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00127 
00128 #define _PLATFORMSTL_VER_MAJOR      1
00129 #define _PLATFORMSTL_VER_MINOR      8
00130 #define _PLATFORMSTL_VER_REVISION   2
00131 #define _PLATFORMSTL_VER            _PLATFORMSTL_VER_1_8_2
00132 
00133 /* /////////////////////////////////////////////////////////////////////////
00134  * Includes
00135  */
00136 
00137 #ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT
00138 # include <stlsoft/stlsoft.h>
00139 #endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */
00140 
00141 /* /////////////////////////////////////////////////////////////////////////
00142  * STLSoft version compatibility
00143  */
00144 
00145 #if _STLSOFT_VER < 0x01095bff
00146 # error This version of the PlatformSTL libraries requires STLSoft version 1.9.91, or later. (www.stlsoft.org)
00147 #endif /* STLSoft version */
00148 
00149 /* /////////////////////////////////////////////////////////////////////////
00150  * Operating system identification
00151  */
00152 
00153 #if defined(unix) || \
00154     defined(UNIX) || \
00155     defined(__unix__) || \
00156     defined(__unix)
00157 # define PLATFORMSTL_OS_IS_UNIX
00158 #elif defined(WIN64) || \
00159       defined(_WIN64) || \
00160       defined(__WIN64__)
00161 # define PLATFORMSTL_OS_IS_WIN64
00162 #elif defined(WIN32) || \
00163       defined(_WIN32) || \
00164       defined(__WIN32__)
00165 # define PLATFORMSTL_OS_IS_WIN32
00166 #else /* ? operating system */
00167 # error Operating system not discriminated. Only UNIX, Win32 and Win64 are currently recognised by PlatformSTL
00168 #endif /* operating system */
00169 
00170 #if defined(PLATFORMSTL_OS_IS_WIN32) || \
00171     defined(PLATFORMSTL_OS_IS_WIN64)
00172 # define PLATFORMSTL_OS_IS_WINDOWS
00173 #endif /* PLATFORMSTL_OS_IS_WIN32 || PLATFORMSTL_OS_IS_WIN64 */
00174 
00175 /* /////////////////////////////////////////////////////////////////////////
00176  * Platform-specific includes
00177  */
00178 
00179 #if defined(PLATFORMSTL_OS_IS_UNIX)
00180 # include <unixstl/unixstl.h>
00181 #elif defined(PLATFORMSTL_OS_IS_WINDOWS)
00182 # include <winstl/winstl.h>
00183 #else /* ? operating system */
00184 # error Operating system not discriminated. Only UNIX and Windows are currently recognised by PlatformSTL
00185 #endif /* operating system */
00186 
00187 /* /////////////////////////////////////////////////////////////////////////
00188  * Architecture
00189  */
00190 
00191 #ifdef PLATFORMSTL_ARCH_IS_X86
00192 # undef PLATFORMSTL_ARCH_IS_X86
00193 #endif /* PLATFORMSTL_ARCH_IS_X86 */
00194 #ifdef PLATFORMSTL_ARCH_IS_IA64
00195 # undef PLATFORMSTL_ARCH_IS_IA64
00196 #endif /* PLATFORMSTL_ARCH_IS_IA64 */
00197 #ifdef PLATFORMSTL_ARCH_IS_X64
00198 # undef PLATFORMSTL_ARCH_IS_X64
00199 #endif /* PLATFORMSTL_ARCH_IS_X64 */
00200 
00201 #ifdef PLATFORMSTL_ARCH_IS_INTEL
00202 # undef PLATFORMSTL_ARCH_IS_INTEL
00203 #endif /* PLATFORMSTL_ARCH_IS_INTEL */
00204 #ifdef PLATFORMSTL_ARCH_IS_POWERPC
00205 # undef PLATFORMSTL_ARCH_IS_POWERPC
00206 #endif /* PLATFORMSTL_ARCH_IS_POWERPC */
00207 #ifdef PLATFORMSTL_ARCH_IS_ALPHA
00208 # undef PLATFORMSTL_ARCH_IS_ALPHA
00209 #endif /* PLATFORMSTL_ARCH_IS_ALPHA */
00210 #ifdef PLATFORMSTL_ARCH_IS_HPPA
00211 # undef PLATFORMSTL_ARCH_IS_HPPA
00212 #endif /* PLATFORMSTL_ARCH_IS_HPPA */
00213 #ifdef PLATFORMSTL_ARCH_IS_SPARC
00214 # undef PLATFORMSTL_ARCH_IS_SPARC
00215 #endif /* PLATFORMSTL_ARCH_IS_SPARC */
00216 #ifdef PLATFORMSTL_ARCH_IS_UNKNOWN
00217 # undef PLATFORMSTL_ARCH_IS_UNKNOWN
00218 #endif /* PLATFORMSTL_ARCH_IS_UNKNOWN */
00219 
00220 
00221 #if defined(PLATFORMSTL_OS_IS_UNIX)
00222 # ifdef UNIXSTL_ARCH_IS_X86
00223 #  define PLATFORMSTL_ARCH_IS_X86
00224 # endif /* UNIXSTL_ARCH_IS_X86 */
00225 # ifdef UNIXSTL_ARCH_IS_IA64
00226 #  define PLATFORMSTL_ARCH_IS_IA64
00227 # endif /* UNIXSTL_ARCH_IS_IA64 */
00228 # ifdef UNIXSTL_ARCH_IS_X64
00229 #  define PLATFORMSTL_ARCH_IS_X64
00230 # endif /* UNIXSTL_ARCH_IS_X64 */
00231 # ifdef UNIXSTL_ARCH_IS_INTEL
00232 #  define PLATFORMSTL_ARCH_IS_INTEL
00233 # endif /* UNIXSTL_ARCH_IS_INTEL */
00234 # ifdef UNIXSTL_ARCH_IS_POWERPC
00235 #  define PLATFORMSTL_ARCH_IS_POWERPC
00236 # endif /* UNIXSTL_ARCH_IS_POWERPC */
00237 # ifdef UNIXSTL_ARCH_IS_ALPHA
00238 #  define PLATFORMSTL_ARCH_IS_ALPHA
00239 # endif /* UNIXSTL_ARCH_IS_ALPHA */
00240 # ifdef UNIXSTL_ARCH_IS_HPPA
00241 #  define PLATFORMSTL_ARCH_IS_HPPA
00242 # endif /* UNIXSTL_ARCH_IS_HPPA */
00243 # ifdef UNIXSTL_ARCH_IS_SPARC
00244 #  define PLATFORMSTL_ARCH_IS_SPARC
00245 # endif /* UNIXSTL_ARCH_IS_SPARC */
00246 # ifdef UNIXSTL_ARCH_IS_UNKNOWN
00247 #  define PLATFORMSTL_ARCH_IS_UNKNOWN
00248 # endif /* UNIXSTL_ARCH_IS_UNKNOWN */
00249 #elif defined(PLATFORMSTL_OS_IS_WINDOWS)
00250 # ifdef WINSTL_ARCH_IS_X86
00251 #  define PLATFORMSTL_ARCH_IS_X86
00252 # endif /* WINSTL_ARCH_IS_X86 */
00253 # ifdef WINSTL_ARCH_IS_IA64
00254 #  define PLATFORMSTL_ARCH_IS_IA64
00255 # endif /* WINSTL_ARCH_IS_IA64 */
00256 # ifdef WINSTL_ARCH_IS_X64
00257 #  define PLATFORMSTL_ARCH_IS_X64
00258 # endif /* WINSTL_ARCH_IS_X64 */
00259 #else /* ? operating system */
00260 #endif /* operating system */
00261 
00262 /* /////////////////////////////////////////////////////////////////////////
00263  * Contract Enforcement
00264  *
00265  * The macro winstl_assert provides standard debug-mode assert functionality.
00266  */
00267 
00277 #ifndef PLATFORMSTL_ASSERT
00278 # define PLATFORMSTL_ASSERT(expr)             STLSOFT_ASSERT(expr)
00279 #endif /* !PLATFORMSTL_ASSERT */
00280 
00286 #define PLATFORMSTL_MESSAGE_ASSERT(msg, expr) STLSOFT_MESSAGE_ASSERT(msg, expr)
00287 
00296 #define PLATFORMSTL_STATIC_ASSERT(expr)       STLSOFT_STATIC_ASSERT(expr)
00297 
00298 /* /////////////////////////////////////////////////////////////////////////
00299  * Namespace
00300  *
00301  * The PLATFORMSTL components are contained within the platformstl namespace. This is
00302  * usually an alias for stlsoft::platformstl_project,
00303  *
00304  * Since STLSoft supports the suspension of namespaces for its main and sub-projects
00305  * (except PlatformSTL) PlatformSTL must be able to work when STLSoft and/or
00306  * UNIXSTL and/or WinSTL constructs are defined in the global namespace.
00307  */
00308 
00309 #if defined(__cplusplus)
00310 # if defined(_STLSOFT_NO_NAMESPACES)
00311 #  error PlatformSTL may not be compiled when _STLSOFT_NO_NAMESPACES is defined. Note: it _can_ be compiled in the presence of _STLSOFT_NO_NAMESPACE, or _UNIXSTL_NO_NAMESPACE, or _WINSTL_NO_NAMESPACE
00312 # endif /* _STLSOFT_NO_NAMESPACES */
00313 
00314 # if defined(_PLATFORMSTL_NO_NAMESPACES)
00315 #  error Use of namespaces in PlatformSTL may not be suspended; _PLATFORMSTL_NO_NAMESPACES was detected
00316 # endif /* _PLATFORMSTL_NO_NAMESPACES */
00317 
00318 # if defined(_PLATFORMSTL_NO_NAMESPACE)
00319 #  error Use of namespaces in PlatformSTL may not be suspended; _PLATFORMSTL_NO_NAMESPACE was detected
00320 # endif /* _PLATFORMSTL_NO_NAMESPACE */
00321 #endif /* __cplusplus */
00322 
00323 #if !defined(__cplusplus)
00324  /* Nothing defined in C */
00325 #elif defined(_STLSOFT_NO_NAMESPACE) || \
00326     defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00327 /* There is no stlsoft namespace, so must define ::platformstl */
00358 namespace platformstl
00359 {
00360 #else
00361 /* Define stlsoft::platformstl_project */
00362 
00363 namespace stlsoft
00364 {
00365 
00366 namespace platformstl_project
00367 {
00368 #endif /* _STLSOFT_NO_NAMESPACE */
00369 
00378 #ifndef _STLSOFT_NO_NAMESPACE
00379 # define platformstl_ns_qual(x)         ::platformstl::x
00380 # define platformstl_ns_using(x)        using ::platformstl::x;
00381 #else /* ? _STLSOFT_NO_NAMESPACE */
00382 # define platformstl_ns_qual(x)         x
00383 # define platformstl_ns_using(x)
00384 #endif /* !_STLSOFT_NO_NAMESPACE */
00385 
00394 #ifdef STLSOFT_CF_std_NAMESPACE
00395 # define platformstl_ns_qual_std(x)     ::std::x
00396 # define platformstl_ns_using_std(x)    using ::std::x;
00397 #else /* ? STLSOFT_CF_std_NAMESPACE */
00398 # define platformstl_ns_qual_std(x)     x
00399 # define platformstl_ns_using_std(x)
00400 #endif /* !STLSOFT_CF_std_NAMESPACE */
00401 
00402 /* ////////////////////////////////////////////////////////////////////// */
00403 
00404 #if !defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) && \
00405     defined(__cplusplus)
00406 
00407 # if defined(PLATFORMSTL_OS_IS_UNIX)
00408 typedef unixstl_ns_qual(us_char_a_t)        char_a_t;    
00409 typedef unixstl_ns_qual(us_char_w_t)        char_w_t;    
00410 typedef unixstl_ns_qual(us_sint8_t)         sint8_t;     
00411 typedef unixstl_ns_qual(us_uint8_t)         uint8_t;     
00412 typedef unixstl_ns_qual(us_int16_t)         int16_t;     
00413 typedef unixstl_ns_qual(us_sint16_t)        sint16_t;    
00414 typedef unixstl_ns_qual(us_uint16_t)        uint16_t;    
00415 typedef unixstl_ns_qual(us_int32_t)         int32_t;     
00416 typedef unixstl_ns_qual(us_sint32_t)        sint32_t;    
00417 typedef unixstl_ns_qual(us_uint32_t)        uint32_t;    
00418 #  ifdef STLSOFT_CF_64BIT_INT_SUPPORT
00419 typedef unixstl_ns_qual(us_int64_t)         int64_t;     
00420 typedef unixstl_ns_qual(us_sint64_t)        sint64_t;    
00421 typedef unixstl_ns_qual(us_uint64_t)        uint64_t;    
00422 #  endif /* STLSOFT_CF_64BIT_INT_SUPPORT */
00423 typedef unixstl_ns_qual(us_int_t)           int_t;       
00424 typedef unixstl_ns_qual(us_sint_t)          sint_t;      
00425 typedef unixstl_ns_qual(us_uint_t)          uint_t;      
00426 typedef unixstl_ns_qual(us_long_t)          long_t;      
00427 #ifdef __cplusplus
00428 typedef unixstl_ns_qual(us_bool_t)          bool_t;      
00429 #endif /* __cplusplus */
00430 typedef unixstl_ns_qual(us_streampos_t)     streampos_t; 
00431 typedef unixstl_ns_qual(us_streamoff_t)     streamoff_t; 
00432 # elif defined(PLATFORMSTL_OS_IS_WINDOWS)
00433 typedef winstl_ns_qual(ws_char_a_t)         char_a_t;    
00434 typedef winstl_ns_qual(ws_char_w_t)         char_w_t;    
00435 typedef winstl_ns_qual(ws_sint8_t)          sint8_t;     
00436 typedef winstl_ns_qual(ws_uint8_t)          uint8_t;     
00437 typedef winstl_ns_qual(ws_int16_t)          int16_t;     
00438 typedef winstl_ns_qual(ws_sint16_t)         sint16_t;    
00439 typedef winstl_ns_qual(ws_uint16_t)         uint16_t;    
00440 typedef winstl_ns_qual(ws_int32_t)          int32_t;     
00441 typedef winstl_ns_qual(ws_sint32_t)         sint32_t;    
00442 typedef winstl_ns_qual(ws_uint32_t)         uint32_t;    
00443 #  ifdef STLSOFT_CF_64BIT_INT_SUPPORT
00444 typedef winstl_ns_qual(ws_int64_t)          int64_t;     
00445 typedef winstl_ns_qual(ws_sint64_t)         sint64_t;    
00446 typedef winstl_ns_qual(ws_uint64_t)         uint64_t;    
00447 #  endif /* STLSOFT_CF_64BIT_INT_SUPPORT */
00448 typedef winstl_ns_qual(ws_int_t)            int_t;       
00449 typedef winstl_ns_qual(ws_sint_t)           sint_t;      
00450 typedef winstl_ns_qual(ws_uint_t)           uint_t;      
00451 typedef winstl_ns_qual(ws_long_t)           long_t;      
00452 #ifdef __cplusplus
00453 typedef winstl_ns_qual(ws_bool_t)           bool_t;      
00454 #endif /* __cplusplus */
00455 typedef winstl_ns_qual(ws_streampos_t)      streampos_t; 
00456 typedef winstl_ns_qual(ws_streamoff_t)      streamoff_t; 
00457 # else /* ? operating system */
00458 # error Operating system not discriminated. Only UNIX and Win32 are currently recognised by PlatformSTL
00459 # endif /* operating system */
00460 
00461 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION && __cplusplus */
00462 
00463 /* ////////////////////////////////////////////////////////////////////// */
00464 
00465 #if !defined(__cplusplus)
00466  /* Nothing defined in C */
00467 #elif defined(_STLSOFT_NO_NAMESPACE) || \
00468     defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00469 } /* namespace platformstl */
00470 #else
00471 } /* namespace platformstl_project */
00472 } /* namespace stlsoft */
00473 namespace platformstl = ::stlsoft::platformstl_project;
00474 #endif /* _STLSOFT_NO_NAMESPACE */
00475 
00476 /* /////////////////////////////////////////////////////////////////////////
00477  * Inclusion
00478  */
00479 
00480 #ifdef STLSOFT_CF_PRAGMA_ONCE_SUPPORT
00481 # pragma once
00482 #endif /* STLSOFT_CF_PRAGMA_ONCE_SUPPORT */
00483 
00484 /* ////////////////////////////////////////////////////////////////////// */
00485 
00486 #endif /* !PLATFORMSTL_INCL_PLATFORMSTL_H_PLATFORMSTL */
00487 
00488 /* ///////////////////////////// end of file //////////////////////////// */