include/strdb.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 _strdb_h
  40 #define _strdb_h
  41
  42 #include "visibility.h"
  43 #include "typedefs.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 GMX_LIBGMX_EXPORT
  50 gmx_bool get_a_line(FILE *fp, char line[], int n);
  51 /* Read a line of at most n characters form *fp to line.
  52  * Comment ';...' and leading spaces are removed, empty lines are skipped.
  53  * Return FALSE when eof.
  54  */
  55
  56 GMX_LIBGMX_EXPORT
  57 gmx_bool get_header(char line[], char header[]);
  58 /* Read a header between '[' and ']' from line to header.
  59  * Returns FALSE no header is found.
  60  */
  61
  62 int fget_lines(FILE *in, char ***strings);
  63 /* Read an array of lines from file in. strings should be
  64  * the address of an array of strings (to be malloced by this routine)
  65  * return the number of strings.
  66  */
  67 GMX_LIBGMX_EXPORT
  68 int get_lines(const char *db, char ***strings);
  69 /* Open file db, or if non-existant file $GMXLIB/db and read strings
  70  * return the number of strings.
  71  */
  72
  73 GMX_LIBGMX_EXPORT
  74 int search_str(int nstr, char **str, char *key);
  75 /* Search an array of strings for key, return the index if found
  76  * -1 if not found.
  77  */
  78
  79 GMX_LIBGMX_EXPORT
  80 int get_strings(const char *db, char ***strings);
  81 /* Read an array of strings from file db or $GMXLIB/db. strings should be
  82  * the address of an array of strings (to be malloced by this routine)
  83  * return the number of strings.
  84  */
  85 GMX_LIBGMX_EXPORT
  86 int get_file(const char *db, char ***strings);
  87 /* Read an array of strings from file db or $GMXLIB/db. strings should be
  88  * the address of an array of strings (to be malloced by this routine)
  89  * Does not need number of lines as first line in the file.
  90  * return the number of strings.
  91  */
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif
  96
  97
  98 #endif  /* _strdb_h */