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