STLSoft: acestl/acestl.hpp Source File

00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        acestl/acestl.hpp
00003  *
00004  * Purpose:     Root header for the ACESTL libraries. Performs various compiler
00005  *              and platform discriminations, and definitions of types.
00006  *
00007  * Created:     15th September 2004
00008  * Updated:     10th August 2009
00009  *
00010  * Home:        http://stlsoft.org/
00011  *
00012  * Copyright (c) 2004-2009, 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 met:
00017  *
00018  * - Redistributions of source code must retain the above copyright notice, this
00019  *   list of conditions and the following disclaimer.
00020  * - Redistributions in binary form must reproduce the above copyright notice,
00021  *   this list of conditions and the following disclaimer in the documentation
00022  *   and/or other materials provided with the distribution.
00023  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
00024  *   any contributors may be used to endorse or promote products derived from
00025  *   this software without specific prior written permission.
00026  *
00027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00028  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00029  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00030  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00031  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00032  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00033  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00034  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00035  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00036  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00037  * POSSIBILITY OF SUCH DAMAGE.
00038  *
00039  * ////////////////////////////////////////////////////////////////////// */
00040 
00041 
00042 #ifndef ACESTL_INCL_ACESTL_HPP_ACESTL
00043 #define ACESTL_INCL_ACESTL_HPP_ACESTL
00044 
00045 /* File version */
00046 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00047 # define ACESTL_VER_ACESTL_HPP_ACESTL_MAJOR     1
00048 # define ACESTL_VER_ACESTL_HPP_ACESTL_MINOR     7
00049 # define ACESTL_VER_ACESTL_HPP_ACESTL_REVISION  4
00050 # define ACESTL_VER_ACESTL_HPP_ACESTL_EDIT      40
00051 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00052 
00058 /* /////////////////////////////////////////////////////////////////////////
00059  * ACESTL version
00060  *
00061  * The libraries version information is comprised of major, minor and revision
00062  * components.
00063  *
00064  * Each release of the libraries will bear a different version, and that version
00065  * will also have its own symbol: Version 1.0.1 specifies _ACESTL_VER_1_0_1.
00066  */
00067 
00100 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00101 # define _ACESTL_VER_0_9_1     0x00000901  
00102 # define _ACESTL_VER_1_0_1     0x00010001  
00103 # define _ACESTL_VER_1_0_2     0x00010002  
00104 # define _ACESTL_VER_1_0_3     0x00010003  
00105 # define _ACESTL_VER_1_0_4     0x00010004  
00106 # define _ACESTL_VER_1_1_1     0x00010101  
00107 # define _ACESTL_VER_1_1_2     0x00010102  
00108 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00109 
00110 #define _ACESTL_VER_MAJOR      1
00111 #define _ACESTL_VER_MINOR      1
00112 #define _ACESTL_VER_REVISION   2
00113 #define _ACESTL_VER            _ACESTL_VER_1_1_2
00114 
00115 /* /////////////////////////////////////////////////////////////////////////
00116  * Includes
00117  */
00118 
00119 #ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT
00120 # include <stlsoft/stlsoft.h>
00121 #endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */
00122 
00123 #ifndef STLSOFT_INCL_ACE_H_LOG_MSG
00124 # define STLSOFT_INCL_ACE_H_LOG_MSG
00125 # include <ace/Log_Msg.h>
00126 #endif /* !STLSOFT_INCL_ACE_H_LOG_MSG */
00127 #ifndef STLSOFT_INCL_ACE_H_VERSION
00128 # define STLSOFT_INCL_ACE_H_VERSION
00129 # include <ace/Version.h>
00130 #endif /* !STLSOFT_INCL_ACE_H_VERSION */
00131 
00132 /* Intel is super pernickety about conversions, so we need to bring out the union_cast. */
00133 #if defined(STLSOFT_COMPILER_IS_INTEL)
00134 # ifndef STLSOFT_INCL_STLSOFT_CONVERSION_HPP_UNION_CAST
00135 #  include <stlsoft/conversion/union_cast.hpp>
00136 # endif /* !STLSOFT_INCL_STLSOFT_CONVERSION_HPP_UNION_CAST */
00137 #endif /* compiler */
00138 
00139 /* /////////////////////////////////////////////////////////////////////////
00140  * STLSoft version compatibility
00141  */
00142 
00143 #if !defined(_STLSOFT_VER_1_9_1_B41) || \
00144     _STLSOFT_VER < _STLSOFT_VER_1_9_1_B41
00145 # error This version of the ACESTL libraries requires STLSoft version 1.9.1 beta 41, or later
00146 #endif /* _STLSOFT_VER */
00147 
00148 /* /////////////////////////////////////////////////////////////////////////
00149  * ACE version
00150  */
00151 
00158 #define ACESTL_ACE_VERSION  ((ACE_MAJOR_VERSION << 16) | ACE_MINOR_VERSION)
00159 
00160 /* /////////////////////////////////////////////////////////////////////////
00161  * Proper C++ casting
00162  */
00163 
00164 #ifdef __cplusplus
00165 # ifdef ACE_WIN32
00166 #  undef     ACE_INVALID_HANDLE
00167 #  if defined(STLSOFT_COMPILER_IS_INTEL)
00168 #   define    ACE_INVALID_HANDLE            stlsoft_ns_qual(union_cast)<HANDLE>(-1)
00169 #  else /* ? compiler */
00170 #   define    ACE_INVALID_HANDLE            reinterpret_cast<HANDLE>(-1)
00171 #  endif /* compiler */
00172 # endif /* ACE_WIN32 */
00173 #endif /* __cplusplus */
00174 
00175 /* /////////////////////////////////////////////////////////////////////////
00176  * Compiler compatibility
00177  *
00178  * Currently the only compilers supported by the ACESTL libraries are
00179  *
00180  */
00181 
00182 /* /////////////////////////////////////////////////////////////////////////
00183  * Contract Enforcement
00184  *
00185  * The macro acestl_assert provides standard debug-mode assert functionality.
00186  */
00187 
00194 #define ACESTL_ASSERT(expr)                STLSOFT_ASSERT(expr)
00195 
00203 #define ACESTL_MESSAGE_ASSERT(msg, expr)   STLSOFT_MESSAGE_ASSERT(msg, expr)
00204 
00211 #define ACESTL_STATIC_ASSERT(expr)         STLSOFT_STATIC_ASSERT(expr)
00212 
00213 
00214 
00215 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00216 # define acestl_assert(expr)                ACESTL_ASSERT(expr)
00217 # define acestl_message_assert(msg, expr)   ACESTL_MESSAGE_ASSERT(msg, expr)
00218 # define acestl_static_assert(expr)         ACESTL_STATIC_ASSERT(expr)
00219 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00220 
00221 /* /////////////////////////////////////////////////////////////////////////
00222  * Namespace
00223  *
00224  * The ACESTL components are contained within the acestl namespace. This is
00225  * usually an alias for stlsoft::acestl_project,
00226  *
00227  * When compilers support namespaces they are defined by default. They can be
00228  * undefined using a cascasing system, as follows:
00229  *
00230  * If _STLSOFT_NO_NAMESPACES is defined, then _ACESTL_NO_NAMESPACES is defined.
00231  *
00232  * If _ACESTL_NO_NAMESPACES is defined, then _ACESTL_NO_NAMESPACE is defined.
00233  *
00234  * If _ACESTL_NO_NAMESPACE is defined, then the ACESTL constructs are defined
00235  * in the global scope.
00236  *
00237  * If _STLSOFT_NO_NAMESPACES, _ACESTL_NO_NAMESPACES and _ACESTL_NO_NAMESPACE are
00238  * all undefined but the symbol _STLSOFT_NO_NAMESPACE is defined (whence the
00239  * namespace stlsoft does not exist), then the ACESTL constructs are defined
00240  * within the acestl namespace. The definition matrix is as follows:
00241  *
00242  * _STLSOFT_NO_NAMESPACE    _ACESTL_NO_NAMESPACE   acestl definition
00243  * ---------------------    --------------------    -----------------
00244  *  not defined              not defined             = stlsoft::acestl_project
00245  *  not defined              defined                 not defined
00246  *  defined                  not defined             acestl
00247  *  defined                  defined                 not defined
00248  *
00249  *
00250  *
00251  * The macro acestl_ns_qual() macro can be used to refer to elements in the
00252  * ACESTL libraries irrespective of whether they are in the
00253  * stlsoft::acestl_project (or acestl) namespace or in the global namespace.
00254  *
00255  * Furthermore, some compilers do not support the standard library in the std
00256  * namespace, so the acestl_ns_qual_std() macro can be used to refer to elements
00257  * in the ACESTL libraries irrespective of whether they are in the std namespace
00258  * or in the global namespace.
00259  */
00260 
00261 /* No STLSoft namespaces means no ACESTL namespaces */
00262 #ifdef _STLSOFT_NO_NAMESPACES
00263 # define _ACESTL_NO_NAMESPACES
00264 #endif /* _STLSOFT_NO_NAMESPACES */
00265 
00266 /* No ACESTL namespaces means no acestl namespace */
00267 #ifdef _ACESTL_NO_NAMESPACES
00268 # define _ACESTL_NO_NAMESPACE
00269 #endif /* _ACESTL_NO_NAMESPACES */
00270 
00271 #ifndef _ACESTL_NO_NAMESPACE
00272 # if defined(_STLSOFT_NO_NAMESPACE) || \
00273      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00274 /* There is no stlsoft namespace, so must define ::acestl */
00305 namespace acestl
00306 {
00307 # else
00308 /* Define stlsoft::acestl_project */
00309 
00310 namespace stlsoft
00311 {
00312 
00313 namespace acestl_project
00314 {
00315 
00316 # endif /* _STLSOFT_NO_NAMESPACE */
00317 #else
00318 stlsoft_ns_using(move_lhs_from_rhs)
00319 #endif /* !_ACESTL_NO_NAMESPACE */
00320 
00329 #ifndef _ACESTL_NO_NAMESPACE
00330 # define acestl_ns_qual(x)             ::acestl::x
00331 # define acestl_ns_using(x)            using ::acestl::x;
00332 #else /* ? _ACESTL_NO_NAMESPACE */
00333 # define acestl_ns_qual(x)             x
00334 # define acestl_ns_using(x)
00335 #endif /* !_ACESTL_NO_NAMESPACE */
00336 
00345 #ifdef STLSOFT_CF_std_NAMESPACE
00346 # define acestl_ns_qual_std(x)         ::std::x
00347 # define acestl_ns_using_std(x)        using ::std::x;
00348 #else /* ? STLSOFT_CF_std_NAMESPACE */
00349 # define acestl_ns_qual_std(x)         x
00350 # define acestl_ns_using_std(x)
00351 #endif /* !STLSOFT_CF_std_NAMESPACE */
00352 
00353 /* /////////////////////////////////////////////////////////////////////////
00354  * Typedefs
00355  *
00356  * The ACESTL uses a number of typedefs to aid in compiler-independence in the
00357  * libraries' main code.
00358  */
00359 
00360 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00361 
00362 typedef stlsoft_ns_qual(ss_char_a_t)        as_char_a_t;    
00363 typedef stlsoft_ns_qual(ss_char_w_t)        as_char_w_t;    
00364 typedef stlsoft_ns_qual(ss_sint8_t)         as_sint8_t;     
00365 typedef stlsoft_ns_qual(ss_uint8_t)         as_uint8_t;     
00366 typedef stlsoft_ns_qual(ss_int16_t)         as_int16_t;     
00367 typedef stlsoft_ns_qual(ss_sint16_t)        as_sint16_t;    
00368 typedef stlsoft_ns_qual(ss_uint16_t)        as_uint16_t;    
00369 typedef stlsoft_ns_qual(ss_int32_t)         as_int32_t;     
00370 typedef stlsoft_ns_qual(ss_sint32_t)        as_sint32_t;    
00371 typedef stlsoft_ns_qual(ss_uint32_t)        as_uint32_t;    
00372 #ifdef STLSOFT_CF_64BIT_INT_SUPPORT
00373 typedef stlsoft_ns_qual(ss_int64_t)         as_int64_t;     
00374 typedef stlsoft_ns_qual(ss_sint64_t)        as_sint64_t;    
00375 typedef stlsoft_ns_qual(ss_uint64_t)        as_uint64_t;    
00376 #endif /* STLSOFT_CF_64BIT_INT_SUPPORT */
00377 typedef stlsoft_ns_qual(ss_int_t)           as_int_t;       
00378 typedef stlsoft_ns_qual(ss_sint_t)          as_sint_t;      
00379 typedef stlsoft_ns_qual(ss_uint_t)          as_uint_t;      
00380 typedef stlsoft_ns_qual(ss_long_t)          as_long_t;      
00381 typedef stlsoft_ns_qual(ss_bool_t)          as_bool_t;      
00382 typedef stlsoft_ns_qual(ss_size_t)          as_size_t;      
00383 typedef stlsoft_ns_qual(ss_ptrdiff_t)       as_ptrdiff_t;   
00384 typedef stlsoft_ns_qual(ss_streampos_t)     as_streampos_t; 
00385 typedef stlsoft_ns_qual(ss_streamoff_t)     as_streamoff_t; 
00386 
00387 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00388 
00389 #ifndef _ACESTL_NO_NAMESPACE
00390 typedef as_char_a_t         char_a_t;           
00391 typedef as_char_w_t         char_w_t;           
00392 //typedef as_int8_t           int8_t;             //!< 8-bit integer
00393 typedef as_sint8_t          sint8_t;            
00394 typedef as_uint8_t          uint8_t;            
00395 typedef as_int16_t          int16_t;            
00396 typedef as_sint16_t         sint16_t;           
00397 typedef as_uint16_t         uint16_t;           
00398 typedef as_int32_t          int32_t;            
00399 typedef as_sint32_t         sint32_t;           
00400 typedef as_uint32_t         uint32_t;           
00401 # ifdef STLSOFT_CF_64BIT_INT_SUPPORT
00402  typedef as_int64_t         int64_t;            
00403  typedef as_sint64_t        sint64_t;           
00404  typedef as_uint64_t        uint64_t;           
00405 # endif /* STLSOFT_CF_64BIT_INT_SUPPORT */
00406 //typedef as_short_t          short_t;            //!< short integer
00407 typedef as_int_t            int_t;              
00408 typedef as_sint_t           sint_t;             
00409 typedef as_uint_t           uint_t;             
00410 typedef as_long_t           long_t;             
00411 //typedef as_byte_t           byte_t;             //!< Byte
00412 typedef as_bool_t           bool_t;             
00413 # if !defined(STLSOFT_COMPILER_IS_DMC)
00414 typedef as_streampos_t      streampos_t;        
00415 typedef as_streamoff_t      streamoff_t;        
00416 # endif /* compiler */
00417 #endif /* !_ACESTL_NO_NAMESPACE */
00418 
00419 /* /////////////////////////////////////////////////////////////////////////
00420  * Values
00421  *
00422  * Since the boolean type may not be supported natively on all compilers, the
00423  * values of true and false may also not be provided. Hence the values of
00424  * as_true_v and as_false_v are defined, and are used in all code.
00425  */
00426 
00427 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00428 
00429 #define as_true_v       ss_true_v
00430 #define as_false_v      ss_false_v
00431 
00432 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00433 /* /////////////////////////////////////////////////////////////////////////
00434  * Code modification macros
00435  */
00436 
00437 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00438 /* Exception signatures. */
00439 # define acestl_throw_0()                               stlsoft_throw_0()
00440 # define acestl_throw_1(x1)                             stlsoft_throw_1(x1)
00441 # define acestl_throw_2(x1, x2)                         stlsoft_throw_2(x1, x2)
00442 # define acestl_throw_3(x1, x2, x3)                     stlsoft_throw_3(x1, x2, x3)
00443 # define acestl_throw_4(x1, x2, x3, x4)                 stlsoft_throw_4(x1, x2, x3, x4)
00444 # define acestl_throw_5(x1, x2, x3, x4, x5)             stlsoft_throw_5(x1, x2, x3, x4, x5)
00445 # define acestl_throw_6(x1, x2, x3, x4, x5, x6)         stlsoft_throw_6(x1, x2, x3, x4, x5, x6)
00446 # define acestl_throw_7(x1, x2, x3, x4, x5, x6, x7)     stlsoft_throw_7(x1, x2, x3, x4, x5, x6, x7)
00447 # define acestl_throw_8(x1, x2, x3, x4, x5, x6, x7, x8) stlsoft_throw_8(x1, x2, x3, x4, x5, x6, x7, x8)
00448 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00449 
00450 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00451 # define ACESTL_NUM_ELEMENTS(ar)                        STLSOFT_NUM_ELEMENTS(ar)
00452 # define acestl_num_elements(ar)                        ACESTL_NUM_ELEMENTS(ar)
00453 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00454 
00459 #define acestl_destroy_instance(t, _type, p)           STLSOFT_DESTROY_INSTANCE(t, _type, p)
00460 
00465 #define acestl_gen_opaque(_htype)                      STLSOFT_GEN_OPAQUE(_htype)
00466 
00467 /* ////////////////////////////////////////////////////////////////////// */
00468 
00469 #ifndef _ACESTL_NO_NAMESPACE
00470 # if defined(_STLSOFT_NO_NAMESPACE) || \
00471      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00472 } // namespace acestl
00473 # else
00474 } // namespace acestl_project
00475 } // namespace stlsoft
00476 namespace acestl = ::stlsoft::acestl_project;
00477 # endif /* _STLSOFT_NO_NAMESPACE */
00478 #endif /* !_ACESTL_NO_NAMESPACE */
00479 
00480 /* /////////////////////////////////////////////////////////////////////////
00481  * Inclusion
00482  */
00483 
00484 #ifdef STLSOFT_CF_PRAGMA_ONCE_SUPPORT
00485 # pragma once
00486 #endif /* STLSOFT_CF_PRAGMA_ONCE_SUPPORT */
00487 
00488 /* ////////////////////////////////////////////////////////////////////// */
00489 
00490 #endif /* !ACESTL_INCL_ACESTL_HPP_ACESTL */
00491 
00492 /* ///////////////////////////// end of file //////////////////////////// */