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 "typedefs.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 extern const char *fflib_forcefield_dir_ext();
  51 /* Returns the name of the force field directory extension */
  52
  53 extern const char *fflib_forcefield_itp();
  54 /* Returns the name of the main forcefield itp file */
  55
  56 extern const char *fflib_forcefield_doc();
  57 /* Returns the name of the forcefield documentation file */
  58
  59 extern void fflib_filename_base(const char *filename,char *filebase,int maxlen);
  60 /* Return the base file name of filename in base,
  61  * i.e. remove path and extension, if present.
  62  * base should be at least of size maxlen.
  63  */
  64
  65 extern int fflib_search_file_end(const char *ffdir,const char *file_end,
  66                                  bool bFatalError,
  67                                  char ***filenames);
  68 /* Search for files ending on file_end in the force field directory fflib.
  69  * fflib should be in the current working directory or the GROMACS lib.path.
  70  * Return the number of files and the file names in filenames.
  71  */
  72
  73 extern int fflib_search_file_in_dirend(const char *filename,const char *dirend,
  74                                        char ***dirnames);
  75 /* Search for files with name filename in subdirectories with names
  76  * ending on dirend.
  77  * Return the number of files and the directory names in dirnames.
  78  */
  79 extern bool fflib_fexist(const char *file);
  80 /* Check if a file exists in the force field library */
  81
  82 extern FILE *fflib_open(const char *file);
  83 /* Open force field library file "file" for reading.
  84  * "file" should contain the whole path to the force field library,
  85  * either absolute or relative to the current dir.
  86  */
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92 #endif  /* _fflibutil_h */