Coin Logo http://www.sim.no
http://www.coin3d.org

SbBasic.h
00001 /**************************************************************************\
00002  *
00003  *  This file is part of the Coin 3D visualization library.
00004  *  Copyright (C) 1998-2007 by Systems in Motion.  All rights reserved.
00005  *
00006  *  This library is free software; you can redistribute it and/or
00007  *  modify it under the terms of the GNU General Public License
00008  *  ("GPL") version 2 as published by the Free Software Foundation.
00009  *  See the file LICENSE.GPL at the root directory of this source
00010  *  distribution for additional information about the GNU GPL.
00011  *
00012  *  For using Coin with software that can not be combined with the GNU
00013  *  GPL, and for taking advantage of the additional benefits of our
00014  *  support services, please contact Systems in Motion about acquiring
00015  *  a Coin Professional Edition License.
00016  *
00017  *  See http://www.coin3d.org/ for more information.
00018  *
00019  *  Systems in Motion, Postboks 1283, Pirsenteret, 7462 Trondheim, NORWAY.
00020  *  http://www.sim.no/  sales@sim.no  coin-support@coin3d.org
00021  *
00022 \**************************************************************************/
00023 
00024 #ifndef COIN_SBBASIC_H
00025 #define COIN_SBBASIC_H
00026 
00027 /* *********************************************************************** */
00028 
00029 #include <Inventor/C/basic.h>
00030 #ifndef NDEBUG
00031 #include <Inventor/C/errors/debugerror.h>
00032 #endif // !NDEBUG
00033 
00034 /* *********************************************************************** */
00035 /* Trap people trying to use Inventor headers while compiling C source code.
00036  * (we get support mail about this from time to time)
00037  */
00038 #ifndef __cplusplus
00039 #error You are not compiling C++ - maybe your source file is named <file>.c
00040 #endif
00041 
00042 /* *********************************************************************** */
00043 /* Include these for Open Inventor compatibility reasons (they are not
00044  * actually used in Coin.)
00045  */
00046 #define SoEXTENDER
00047 #define SoINTERNAL
00048 
00049 /* *********************************************************************** */
00050 
00051 /* Some useful inline template functions:
00052  *   SbAbs(Val)              - returns absolute value
00053  *   SbMin(Val1, Val2)       - returns minimum value
00054  *   SbMax(Val1, Val2)       - returns maximum value
00055  *   SbClamp(Val, Min, Max)  - returns clamped value
00056  *   SbSwap(Val1, Val2)      - swaps the two values (no return value)
00057  *   SbSqr(val)              - returns (val)²
00058  */
00059 
00060 template <class Type>
00061 inline Type SbAbs( Type Val ) {
00062   return (Val < 0) ? 0 - Val : Val;
00063 }
00064 
00065 template <class Type>
00066 inline Type SbMax( const Type A, const Type B ) {
00067   return (A < B) ? B : A;
00068 }
00069 
00070 template <class Type>
00071 inline Type SbMin( const Type A, const Type B ) {
00072   return (A < B) ? A : B;
00073 }
00074 
00075 template <class Type>
00076 inline Type SbClamp( const Type Val, const Type Min, const Type Max ) {
00077   return (Val < Min) ? Min : (Val > Max) ? Max : Val;
00078 }
00079 
00080 template <class Type>
00081 inline void SbSwap( Type & A, Type & B ) {
00082   Type T; T = A; A = B; B = T;
00083 }
00084 
00085 template <class Type>
00086 inline Type SbSqr(const Type val) {
00087   return val * val;
00088 }
00089 
00090 /* *********************************************************************** */
00091 
00092 template <typename Type>
00093 inline void SbDividerChk(const char * funcname, Type divider) {
00094 #ifndef NDEBUG
00095   if (!(divider != static_cast<Type>(0)))
00096     cc_debugerror_post(funcname, "divide by zero error.", divider);
00097 #endif // !NDEBUG
00098 }
00099 
00100 /* *********************************************************************** */
00101 
00102 /* COMPILER BUG WORKAROUND:
00103 
00104    We've had reports that Sun CC v4.0 is (likely) buggy, and doesn't
00105    allow a statement like
00106 
00107      SoType SoNode::classTypeId = SoType::badType();
00108 
00109    As a hack we can however get around this by instead writing it as
00110 
00111      SoType SoNode::classTypeId;
00112 
00113    ..as the SoType variable will then be initialized to bitpattern
00114    0x0000, which equals SoType::badType(). We can *however* not do
00115    this for the Intel C/C++ compiler, as that does *not* init to the
00116    0x0000 bitpattern (which may be a separate bug -- I haven't read
00117    the C++ spec closely enough to decide whether that relied on
00118    unspecified behavior or not).
00119 
00120    The latest version of the Intel compiler has been tested to still
00121    have this problem, so I've decided to re-install the old code, but
00122    in this form:
00123 
00124      SoType SoNode::classTypeId STATIC_SOTYPE_INIT;
00125 
00126    ..so it is easy to revert if somebody complains that the code
00127    reversal breaks their old Sun CC 4.0 compiler -- see the #define of
00128    STATIC_SOTYPE_INIT below.
00129 
00130    If that happens, we should work with the reporter, having access to
00131    the buggy compiler, to make a configure check which sets the
00132    SUN_CC_4_0_SOTYPE_INIT_BUG #define in include/Inventor/C/basic.h.in.
00133 
00134    (Note that the Sun CC compiler has moved on, and a later version
00135    we've tested, 5.4, does not have the bug.)
00136 
00137    20050105 mortene.
00138 */
00139 
00140 #define SUN_CC_4_0_SOTYPE_INIT_BUG 0 /* assume compiler is ok for now */
00141 
00142 #if SUN_CC_4_0_SOTYPE_INIT_BUG
00143 #define STATIC_SOTYPE_INIT
00144 #else
00145 #define STATIC_SOTYPE_INIT = SoType::badType()
00146 #endif
00147 
00148 /* *********************************************************************** */
00149 
00150 #endif /* !COIN_SBBASIC_H */

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Sun Feb 12 2012 for Coin by Doxygen. 1.7.4