2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2014,2015, 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.
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.
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.
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.
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.
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.
36 #ifndef GMX_GMXPREPROCESS_FFLIBUTIL_H
37 #define GMX_GMXPREPROCESS_FFLIBUTIL_H
43 #include "gromacs/utility/basedefinitions.h"
44 #include "gromacs/utility/datafilefinder.h"
47 * Enumerates forcefields in the data directories.
49 std::vector
<gmx::DataFileInfo
> fflib_enumerate_forcefields();
51 const char *fflib_forcefield_dir_ext();
52 /* Returns the name of the force field directory extension */
54 const char *fflib_forcefield_itp();
55 /* Returns the name of the main forcefield itp file */
57 const char *fflib_forcefield_doc();
58 /* Returns the name of the forcefield documentation file */
60 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.
66 int fflib_search_file_end(const char *ffdir
,
70 /* Search for files ending on file_end in the force field directory fflib.
71 * fflib should be in the GROMACS lib.path.
72 * Return the number of files and the file names in filenames.
75 gmx_bool
fflib_fexist(const char *file
);
76 /* Check if a file exists in the force field library */
78 FILE *fflib_open(const char *file
);
79 /* Open force field library file "file" for reading.
80 * "file" should contain the whole path to the force field library,
81 * either absolute or relative to the current dir.