2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2010,2014, by the GROMACS development team, led by
7 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 * and including many others, as listed in the AUTHORS file in the
9 * top-level source directory and at http://www.gromacs.org.
11 * GROMACS is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the License, or (at your option) any later version.
16 * GROMACS is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with GROMACS; if not, see
23 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * If you want to redistribute modifications to GROMACS, please
27 * consider that scientific software is very special. Version
28 * control is crucial - bugs must be traceable. We will be happy to
29 * consider code for inclusion in the official distribution, but
30 * derived work must not be called official GROMACS. Details are found
31 * in the README & COPYING files - if they are missing, get the
32 * official version at http://www.gromacs.org.
34 * To help us fund GROMACS development, we humbly ask that you cite
35 * the research papers on the package. Check out http://www.gromacs.org.
37 #ifndef GMX_FILEIO_STRDB_H
38 #define GMX_FILEIO_STRDB_H
42 #include "../utility/basedefinitions.h"
48 gmx_bool get_a_line(FILE *fp, char line[], int n);
49 /* Read a line of at most n characters form *fp to line.
50 * Comment ';...' and leading spaces are removed, empty lines are skipped.
51 * Return FALSE when eof.
54 gmx_bool get_header(char line[], char header[]);
55 /* Read a header between '[' and ']' from line to header.
56 * Returns FALSE no header is found.
59 int fget_lines(FILE *in, char ***strings);
60 /* Read an array of lines from file in. strings should be
61 * the address of an array of strings (to be malloced by this routine)
62 * return the number of strings.
64 int get_lines(const char *db, char ***strings);
65 /* Open file db, or if non-existant file $GMXLIB/db and read strings
66 * return the number of strings.
69 int search_str(int nstr, char **str, char *key);
70 /* Search an array of strings for key, return the index if found
74 int get_strings(const char *db, char ***strings);
75 /* Read an array of strings from file db or $GMXLIB/db. strings should be
76 * the address of an array of strings (to be malloced by this routine)
77 * return the number of strings.
79 int get_file(const char *db, char ***strings);
80 /* Read an array of strings from file db or $GMXLIB/db. strings should be
81 * the address of an array of strings (to be malloced by this routine)
82 * Does not need number of lines as first line in the file.
83 * return the number of strings.