gls_types.h

Go to the documentation of this file.

/*! \file gls_types.h

\brief  This header defines the basic types used by 
        the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/
#ifndef _GLS_TYPES_H
#define _GLS_TYPES_H

#include "gls_include.h"
#include <limits.h>
#include <float.h>
#include <math.h>
#include "gls_gl.h"
#include "gls_assert.h"

/** define GLS_NULL pointer value */
#define GLS_NULL    ( 0 )

/** 8-bit character */
typedef char            GlsChar;
/** largest value that can fit in a GlsChar */
#define GLSCHAR_MAX     ( CHAR_MAX )
/** smallest value that can fit in a GlsChar */
#define GLSCHAR_MIN     ( CHAR_MIN )

/** 8-bit unsigned character */
typedef unsigned char   GlsUChar;
/** largest value that can be stored in a GlsUChar */
#define GLSUCHAR_MAX    ( UCHAR_MAX )

/** 32-bit signed integer */
typedef int             GlsInt32;
/** largest value that can be stored in a GlsInt32 */
#define GLSINT32_MAX    ( INT_MAX )
/** smallest value that can be stored in a GlsInt32 */
#define GLSINT32_MIN    ( INT_MIN )

/** 32-bit unsigned integer */
typedef unsigned int   GlsUInt32;
/** largest value that can be stored in a GlsUInt32 */
#define GLSUINT32_MAX   ( UINT_MAX )

/** 32-bit single precision floating point */
typedef float               GlsFloat32;
/** largest value that can be stored in a GlsFloat32 */
#define GLSFLOAT32_MAX      ( FLT_MAX )
/** smallest value that can be stored in a GlsFloat32 */
#define GLSFLOAT32_MIN      ( FLT_MIN )
/** smallest GlsFloat32 value such that ( 1.0 + GLSFLOAT32_EPSILON != 1.0 ) */
#define GLSFLOAT32_EPSILON  ( FLT_EPSILON )

/** 64-bit double precision floating point */
typedef double              GlsFloat64;
/** largest value that can be stored in a GlsFloat64 */
#define GLSFLOAT64_MAX      ( DBL_MAX )
/** smallest value that can be stored in a GlsFloat64 */
#define GLSFLOAT64_MIN      ( DBL_MIN )
/** smallest GlsFloat64 value such that ( 1.0 + GLSFLOAT64_EPSILON != 1.0 ) */
#define GLSFLOAT64_EPSILON  ( DBL_EPSILON )

/** boolean value */
typedef bool           GlsBool;

/** true value for a GlsBool */
#define GLS_TRUE       ( true  )
/** false value for a GlsBool */
#define GLS_FALSE      ( false )

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/** Determine if the given floating point value is valid ( GLS_DEBUG only )
  * \param f floating point value in question
  * \return GLS_TRUE if float is valid else GLS_FALSE
  * \pre none
  * \post none
  */
inline GlsBool GlsFloatIsValid( const GlsFloat64 f )
{
    #if defined( GLS_LINUX_TEST )
        return( !isnan( f ) && isfinite( f ) );
    #else
        #if !defined( GLS_VXWORKS )
            return( _finite( f ) != 0 );
        #else
            return GLS_TRUE;
        #endif
    #endif
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/** Assert that the basic library types have the proper sizes and values at runtime ( GLS_DEBUG only )
  * \pre none
  * \post none
  */
inline void GlsTypesAssertValid( void )
{
    // check sizes
    GlsAssert( sizeof( GlsChar    ) == 1u );
    GlsAssert( sizeof( GlsUChar   ) == 1u );
    GlsAssert( sizeof( GlsInt32   ) == 4u );
    GlsAssert( sizeof( GlsUInt32  ) == 4u );
    GlsAssert( sizeof( GlsFloat32 ) == 4u );
    GlsAssert( sizeof( GlsFloat64 ) == 8u );

    // assumes that GLS_TRUE is always "true" and GLS_FALSE is always "false"
    GlsAssert( GLS_TRUE  == true  );
    GlsAssert( GLS_FALSE == false );

    // ensure that floats line up with GL floats
    GlsAssert( sizeof( GlsFloat32 ) == sizeof( GLfloat  ) );
    GlsAssert( sizeof( GlsFloat64 ) == sizeof( GLdouble ) );
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG

#endif // _GLS_TYPES_H