src/gromacs/version.h.cmakein

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012 by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 #ifndef _gmx_version_h
  36 #define _gmx_version_h
  37
  38 /* This include file will be configured by CMake and contains version
  39    information, primarily for software that links to Gromacs.
  40
  41    This file exists from 4.6 onward. In 4.6, it is #included in
  42    include/typedefs.h, but that is not guaranteed to be the case in later
  43    versions.
  44
  45    The versions are in numerical form, where, for example, version
  46    4.6.1 would be 40601.
  47    The values come from the main CMakeLists.txt.
  48
  49    This header defines two values, the Gromacs version, and the API version.
  50
  51    The API version is defined in GMX_API_VERSION, and denotes the
  52    version of the programmer interface, i.e. the installed header files
  53    and compatible library.
  54
  55    programs written against the gromacs library can use this file
  56    to provide some backward compatibility even though parts of the API
  57    change. For example:
  58
  59 #include <gromacs/version.h>
  60 #if (GMX_API_VERSION < 50000)
  61     .... <do pre-5.0 stuff>
  62 #else
  63     .... <do post-5.0 stuff>
  64 #endif
  65
  66     where version.h is included directly. For code that must be compatible
  67     between 4.5 and 4.6, an interim solution is to include typedefs.h, which
  68     includes this file:
  69
  70 #include <gromacs/typedefs.h>
  71 #if !defined(GMX_API_VERSION) || (GMX_API_VERSION < 40600)
  72     ....  <do 4.5 specific stuff>
  73 #elif (GMX_API_VERSION < 40700)
  74     ....  <do 4.6 specific stuff>
  75 #endif
  76
  77    */
  78 #define GMX_API_VERSION @API_VERSION@
  79
  80
  81 /* GMX_VERSION contains the version number of the actual Gromacs library
  82    and the Gromacs programs, in numerical format.
  83
  84    As of 4.6, the Gromacs and API versions are the same, but this is not
  85    guaranteed to be the case in the future. */
  86 #define GMX_VERSION @NUM_VERSION@
  87
  88 #endif /* _gmx_version_h */
  89