src/gromacs/utility/gmx_header_config.h

   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  * 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  * Include file for configuration macros that affect installed headers.
  38  *
  39  * This include file (or rather, one that it includes) will configured by CMake
  40  * and installed with GROMACS header files so that they can refer to a central
  41  * location for \#defines that will be available for builds of projects that
  42  * depend on GROMACS.
  43  *
  44  * The actual defines are in gmx_header_config_gen.h to allow usage of relative
  45  * include paths before installation.
  46  *
  47  * \todo
  48  * It would be better to have the defines here such that they are not generated
  49  * from CMake, but instead detected using \#ifdefs (possible for some of the
  50  * macros currently used).
  51  * Even better would be to not have these defines at all.
  52  *
  53  * \inlibraryapi
  54  * \ingroup module_utility
  55  */
  56 #include "gmx_header_config_gen.h"