src/gromacs/version.h.cmakein

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \file
  36  * \brief
  37  * Version information for software that links to \Gromacs.
  38  *
  39  * \if libapi
  40  * This include file will be configured by CMake and contains version
  41  * information.  It is not used by \Gromacs, but intended for software that
  42  * links to \Gromacs.
  43  * The values come from the main CMakeLists.txt.
  44  * \endif
  45  *
  46  * This file exists from 4.6 onward, and can be included as
  47  * `<gromacs/version.h>`.  In 4.6, it is also included by
  48  * `<gromacs/typedefs.h>, but that header has already moved in 5.0.
  49  *
  50  * This header defines two values, the \Gromacs version, and the API version.
  51  * The versions are in numerical form, where, for example, version
  52  * 4.6.1 would be 40601.
  53  *
  54  * The API version is defined in ::GMX_API_VERSION, and denotes the
  55  * version of the programmer interface, i.e. the installed header files
  56  * and compatible library.
  57  *
  58  * Programs written against the \Gromacs library can use this file
  59  * to provide some backward compatibility even though parts of the API
  60  * change.  For example:
  61  * \code
  62    #include <gromacs/version.h>
  63    #if (GMX_API_VERSION < 50000)
  64        .... <do pre-5.0 stuff>
  65    #else
  66        .... <do post-5.0 stuff>
  67    #endif
  68    \endcode
  69  * where version.h is included directly. For code that must be compatible
  70  * between 4.5 and 4.6, an interim solution is to include typedefs.h, which
  71  * includes this file:
  72  * \code
  73    #include <gromacs/typedefs.h>
  74    #if !defined(GMX_API_VERSION) || (GMX_API_VERSION < 40600)
  75        ....  <do 4.5 specific stuff>
  76    #elif (GMX_API_VERSION < 40700)
  77        ....  <do 4.6 specific stuff>
  78    #endif
  79    \endcode
  80  *
  81  * \inpublicapi
  82  */
  83 #ifndef GMX_VERSION_H
  84 #define GMX_VERSION_H
  85
  86 /*! \brief
  87  * API version of this set of \Gromacs headers.
  88  *
  89  * If there are multiple versions of \Gromacs that work with the same set of
  90  * headers, then this version is not updated between the versions, even though
  91  * ::GMX_VERSION is.
  92  * For 4.6 and 5.0 (and likely for some time in the future as well), this
  93  * tracks the exact \Gromacs version.
  94  */
  95 #define GMX_API_VERSION @GMX_API_VERSION@
  96
  97 /*! \brief
  98  * Exact \Gromacs version of this set of headers.
  99  *
 100  * This specifies the version number of the actual \Gromacs library that
 101  * installed these headers.
 102  */
 103 #define GMX_VERSION @GMX_VERSION_NUMERIC@
 104
 105 #endif