src/kernel/fflibutil.h

   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  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _fflibutil_h
  37 #define _fflibutil_h
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include <config.h>
  41 #endif
  42
  43 #include <stdio.h>
  44 #include "visibility.h"
  45 #include "typedefs.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 extern const char *fflib_forcefield_dir_ext();
  52 /* Returns the name of the force field directory extension */
  53
  54 extern const char *fflib_forcefield_itp();
  55 /* Returns the name of the main forcefield itp file */
  56
  57 extern const char *fflib_forcefield_doc();
  58 /* Returns the name of the forcefield documentation file */
  59
  60 extern void fflib_filename_base(const char *filename,char *filebase,int maxlen);
  61 /* Return the base file name of filename in base,
  62  * i.e. remove path and extension, if present.
  63  * base should be at least of size maxlen.
  64  */
  65
  66 GMX_LIBGMXPREPROCESS_EXPORT
  67 extern int fflib_search_file_end(const char *ffdir,
  68                                  const char *file_end,
  69                                  gmx_bool bFatalError,
  70                                  char ***filenames);
  71 /* Search for files ending on file_end in the force field directory fflib.
  72  * fflib should be in the GROMACS lib.path.
  73  * Return the number of files and the file names in filenames.
  74  */
  75
  76 extern int fflib_search_file_in_dirend(const char *filename,const char *dirend,
  77                                        char ***dirnames);
  78 /* Search for files with name filename in subdirectories with names
  79  * ending on dirend.
  80  * Return the number of files and the directory names in dirnames.
  81  */
  82 GMX_LIBGMXPREPROCESS_EXPORT
  83 extern gmx_bool fflib_fexist(const char *file);
  84 /* Check if a file exists in the force field library */
  85
  86 GMX_LIBGMXPREPROCESS_EXPORT
  87 extern FILE *fflib_open(const char *file);
  88 /* Open force field library file "file" for reading.
  89  * "file" should contain the whole path to the force field library,
  90  * either absolute or relative to the current dir.
  91  */
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif
  96
  97 #endif  /* _fflibutil_h */