source: trunk/yat/utility/version.h.in @ 1487

#ifndef _theplu_yat_utility_version_
#define _theplu_yat_utility_version_ 

// @configure_input@

// $Id: version.h.in 1487 2008-09-10 08:41:36Z jari $

/*
  Copyright (C) 2008 Peter Johansson

  This file is part of the yat library, http://trac.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

///
/// \file utility/version.h
///

/*
  Compile-time version constants 

  \see http://apr.apache.org/versioning.html
*/

/**
   MAJOR version

   No compatibility is guarenteed between MAJOR versions.

   \since New in yat 0.5
 */
#define YAT_MAJOR_VERSION @YAT_MAJOR_VERSION@ 

/**
   MINOR version

   Minor API changes that do not cause binary compatibility problems.
   Reset to 0 when upgrading YAT_MAJOR_VERSION

   \since New in yat 0.5
 */
#define YAT_MINOR_VERSION @YAT_MINOR_VERSION@ 

/**
   PATCH version

   The Patch level never includes API changes, simply bug fixes.
   Reset to 0 when upgrading YAT_MINOR_VERSION

   \since New in yat 0.5
 */
#define YAT_PATCH_VERSION @YAT_PATCH_VERSION@ 

/**
   VERSION

   The version of yat in string format

   \since New in yat 0.5
 */
#define YAT_VERSION "@VERSION@" 

/**
   DEV_BUILD 

   Is set to false in releases

   \since New in yat 0.5
 */
#define YAT_DEV_BUILD @YAT_DEV_BUILD@

/**
   Check at compile time if the version of yat is at least a certain
   level.
   @param major The major version component of the version checked
   for (e.g., the "0" of "0.5.1").
   @param minor The minor version component of the version checked
   for (e.g., the "5" of "0.5.1").
   @param patch The patch level component of the version checked
   for (e.g., the "1" of "0.5.1").

   \since New in yat 0.5
 */
#define YAT_VERSION_AT_LEAST(major,minor,patch)                    \
(((major) < YAT_MAJOR_VERSION) ||                                    \
 ((major) == YAT_MAJOR_VERSION && (minor) < YAT_MINOR_VERSION) || \
 ((major) == YAT_MAJOR_VERSION && (minor) == YAT_MINOR_VERSION &&\
  (patch) <= YAT_PATCH_VERSION))

#include <string>

namespace theplu {
namespace yat {
namespace utility {

  /**
     \return major version number of compiled yat library

   \since New in yat 0.5
   */
  unsigned int major_version(void);

  /**
     \return minor version number of compiled yat library

     \since New in yat 0.5
   */
  unsigned int minor_version(void);

  /**
     \return patch version number of compiled yat library

     \since New in yat 0.5
   */
  unsigned int patch_version(void);

  /**
     \return version number of compiled yat library

     \since New in yat 0.5
   */
  std::string version(void);

}}} // of namespace utility, yat, and theplu

#endif