src/kernel/fflibutil.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _fflibutil_h
  40 #define _fflibutil_h
  41
  42 #ifdef HAVE_CONFIG_H
  43 #include <config.h>
  44 #endif
  45
  46 #include <stdio.h>
  47 #include "visibility.h"
  48 #include "typedefs.h"
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 extern const char *fflib_forcefield_dir_ext();
  55 /* Returns the name of the force field directory extension */
  56
  57 extern const char *fflib_forcefield_itp();
  58 /* Returns the name of the main forcefield itp file */
  59
  60 extern const char *fflib_forcefield_doc();
  61 /* Returns the name of the forcefield documentation file */
  62
  63 extern void fflib_filename_base(const char *filename,char *filebase,int maxlen);
  64 /* Return the base file name of filename in base,
  65  * i.e. remove path and extension, if present.
  66  * base should be at least of size maxlen.
  67  */
  68
  69 GMX_LIBGMXPREPROCESS_EXPORT
  70 extern int fflib_search_file_end(const char *ffdir,
  71                                  const char *file_end,
  72                                  gmx_bool bFatalError,
  73                                  char ***filenames);
  74 /* Search for files ending on file_end in the force field directory fflib.
  75  * fflib should be in the GROMACS lib.path.
  76  * Return the number of files and the file names in filenames.
  77  */
  78
  79 extern int fflib_search_file_in_dirend(const char *filename,const char *dirend,
  80                                        char ***dirnames);
  81 /* Search for files with name filename in subdirectories with names
  82  * ending on dirend.
  83  * Return the number of files and the directory names in dirnames.
  84  */
  85 GMX_LIBGMXPREPROCESS_EXPORT
  86 extern gmx_bool fflib_fexist(const char *file);
  87 /* Check if a file exists in the force field library */
  88
  89 GMX_LIBGMXPREPROCESS_EXPORT
  90 extern FILE *fflib_open(const char *file);
  91 /* Open force field library file "file" for reading.
  92  * "file" should contain the whole path to the force field library,
  93  * either absolute or relative to the current dir.
  94  */
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif
  99
 100 #endif  /* _fflibutil_h */