Version.h

Go to the documentation of this file.

// GMTL is (C) Copyright 2001-2010 by Allen Bierbaum
// Distributed under the GNU Lesser General Public License 2.1 with an
// addendum covering inlined code. (See accompanying files LICENSE and
// LICENSE.addendum or http://www.gnu.org/copyleft/lesser.txt)

#ifndef _GMTL_VERSION_H_
#define _GMTL_VERSION_H_

// The major/minor/patch version (up to 3 digits each).
#define GMTL_VERSION_MAJOR    0
#define GMTL_VERSION_MINOR    6
#define GMTL_VERSION_PATCH    1

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// To update the version number, do not modify anything below this line!!!!
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------


//--------------------------------------------------------------------------
// Define the helper macros
//--------------------------------------------------------------------------

// These helper macros are used build up the GMTL_VERSION macro
#define GMTL_GLUE(a,b)        a ## b
#define GMTL_XGLUE(a,b)       GMTL_GLUE(a,b)

// These helper macros are used to stringify a given macro
#define GMTL_STR(s)           # s
#define GMTL_XSTR(s)          GMTL_STR(s)

// These helper macros are used to build up the GMTL_VERSION_STRING macro.
#define GMTL_DOT(a,b)         a ## . ## b
#define GMTL_XDOT(a,b)        GMTL_DOT(a,b)

// These helpr macros are used to facilitate a zero left fill
#define GMTL_ZEROFILL(a)      0 ## a
#define GMTL_XZEROFILL(a)     GMTL_ZEROFILL(a)

// Fix up the major version by doing a zero left fill
#if GMTL_VERSION_MAJOR < 10
#  define GMTL_VERSION_MAJOR_FILLED \
               GMTL_XZEROFILL(GMTL_XZEROFILL(GMTL_VERSION_MAJOR))
#elif GMTL_VERSION_MAJOR < 100
#  define GMTL_VERSION_MAJOR_FILLED GMTL_XZEROFILL(GMTL_VERSION_MAJOR)
#else
#  define GMTL_VERSION_MAJOR_FILLED GMTL_VERSION_MAJOR
#endif

// Fix up the minor version by doing a zero left fill
#if GMTL_VERSION_MINOR < 10
#  define GMTL_VERSION_MINOR_FILLED \
               GMTL_XZEROFILL(GMTL_XZEROFILL(GMTL_VERSION_MINOR))
#elif GMTL_VERSION_MINOR < 100
#  define GMTL_VERSION_MINOR_FILLED GMTL_XZEROFILL(GMTL_VERSION_MINOR)
#else
#  define GMTL_VERSION_MINOR_FILLED GMTL_VERSION_MINOR
#endif

// Fix up the patch version by doing a zero left fill
#if GMTL_VERSION_PATCH < 10
#  define GMTL_VERSION_PATCH_FILLED \
               GMTL_XZEROFILL(GMTL_XZEROFILL(GMTL_VERSION_PATCH))
#elif GMTL_VERSION_PATCH < 100
#  define GMTL_VERSION_PATCH_FILLED GMTL_XZEROFILL(GMTL_VERSION_PATCH)
#else
#  define GMTL_VERSION_PATCH_FILLED GMTL_VERSION_PATCH
#endif

//--------------------------------------------------------------------------
// Define the GMTL_VERSION and GMTL_VERSION_STRING macros
//--------------------------------------------------------------------------

// Build up the GMTL_VERSION macro by pasting the individual parts together
#define GMTL_VERSION \
   GMTL_XGLUE( \
      GMTL_XGLUE(GMTL_VERSION_MAJOR_FILLED, GMTL_VERSION_MINOR_FILLED), \
      GMTL_VERSION_PATCH_FILLED \
   )

// Create the GMTL_VERSION_STRING macro
#define GMTL_VERSION_STRING \
   GMTL_XDOT( \
      GMTL_XDOT(GMTL_VERSION_MAJOR, GMTL_VERSION_MINOR), \
      GMTL_VERSION_PATCH \
   )

//--------------------------------------------------------------------------
// Declare a version string constant that can be used at runtime.
//--------------------------------------------------------------------------
namespace gmtl
{
   inline const char* getVersion()
   {
      return GMTL_XSTR(GMTL_VERSION_STRING);
   }
} // end namespace gmtl

//--------------------------------------------------------------------------
// Cleanup after ourselves and undef all internal macros.
//--------------------------------------------------------------------------

// Undef the all helper macros
#undef GMTL_XGLUE
#undef GMTL_GLUE
#undef GMTL_XSTR
#undef GMTL_STR
#undef GMTL_ZEROFILL
#undef GMTL_XZEROFILL
#undef GMTL_XDOT
#undef GMTL_DOT

// Undef the GMTL_VERSION_STRING temporary macro
#undef GMTL_VERSION_STRING

// Undef the XXX_FILLED temporary macros
#undef GMTL_VERSION_MAJOR_FILLED
#undef GMTL_VERSION_MINOR_FILLED
#undef GMTL_VERSION_PATCH_FILLED

// Undef the macro for each version part
#undef GMTL_VERSION_MAJOR
#undef GMTL_VERSION_MINOR
#undef GMTL_VERSION_PATCH

#endif