src/gromacs/utility/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  * Copyright (c) 2010,2014,2015,2019, 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.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  25  *
  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.
  33  *
  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.
  36  */
  37 /*! \libinternal \file
  38  * \brief
  39  * Declares C functions for reading files with a list of strings.
  40  *
  41  * \inlibraryapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_STRDB_H
  45 #define GMX_UTILITY_STRDB_H
  46
  47 #include <cstdio>
  48
  49 #include "gromacs/utility/basedefinitions.h"
  50
  51 /*! \brief
  52  * Reads a line of at most n characters from *fp to line.
  53  *
  54  * Comment ';...' and leading spaces are removed, empty lines are skipped.
  55  * Return FALSE when eof.
  56  */
  57 gmx_bool get_a_line(FILE* fp, char line[], int n);
  58
  59 /*! \brief
  60  * Read a header between '[' and ']' from line to header.
  61  *
  62  * Returns FALSE if no header is found.
  63  */
  64 gmx_bool get_header(char line[], char header[]);
  65
  66 /*! \brief
  67  * Opens file db, or if non-existant file $GMXLIB/db and read strings.
  68  *
  69  * First line in the file needs to specify the number of strings following.
  70  * Returns the number of strings.
  71  */
  72 int get_lines(const char* db, char*** strings);
  73
  74 /*! \brief
  75  * Searches an array of strings for key, return the index if found.
  76  *
  77  * Returns -1 if not found.
  78  */
  79 int search_str(int nstr, char** str, char* key);
  80
  81 #endif