include/version.h.cmakein

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2012, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  *
  31  * And Hey:
  32  * Gromacs Runs On Most of All Computer Systems
  33  */
  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