src/gromacs/utility/strdb.cpp

   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) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source 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 #include "gmxpre.h"
  39
  40 #include "strdb.h"
  41
  42 #include <cstdio>
  43 #include <cstdlib>
  44 #include <cstring>
  45
  46 #include "gromacs/utility/cstringutil.h"
  47 #include "gromacs/utility/fatalerror.h"
  48 #include "gromacs/utility/futil.h"
  49 #include "gromacs/utility/smalloc.h"
  50
  51 gmx_bool get_a_line(FILE* fp, char line[], int n)
  52 {
  53     char* line0 = nullptr;
  54     char* dum   = nullptr;
  55
  56     snew(line0, n + 1);
  57
  58     do
  59     {
  60         if (!fgets(line0, n + 1, fp))
  61         {
  62             sfree(line0);
  63             return FALSE;
  64         }
  65         dum = std::strchr(line0, '\n');
  66         if (dum)
  67         {
  68             dum[0] = '\0';
  69         }
  70         else if (static_cast<int>(std::strlen(line0)) == n)
  71         {
  72             fprintf(stderr,
  73                     "Warning: line length exceeds buffer length (%d), data might be corrupted\n",
  74                     n);
  75             line0[n - 1] = '\0';
  76         }
  77         else
  78         {
  79             fprintf(stderr, "Warning: file does not end with a newline, last line:\n%s\n", line0);
  80         }
  81         dum = std::strchr(line0, ';');
  82         if (dum)
  83         {
  84             dum[0] = '\0';
  85         }
  86         std::strncpy(line, line0, n);
  87         dum = line0;
  88         ltrim(dum);
  89     } while (dum[0] == '\0');
  90
  91     sfree(line0);
  92     return TRUE;
  93 }
  94
  95 gmx_bool get_header(char line[], char* header)
  96 {
  97     std::string temp  = line;
  98     auto        index = temp.find('[');
  99     if (index == std::string::npos)
 100     {
 101         return FALSE;
 102     }
 103     temp[index] = ' ';
 104     index       = temp.find(']', index);
 105     if (index == std::string::npos)
 106     {
 107         gmx_fatal(FARGS, "header is not terminated on line:\n'%s'\n", line);
 108         return FALSE;
 109     }
 110     temp.resize(index);
 111     return sscanf(temp.c_str(), "%s%*s", header) == 1;
 112 }
 113
 114 int search_str(int nstr, char** str, char* key)
 115 {
 116     /* Linear search */
 117     for (int i = 0; (i < nstr); i++)
 118     {
 119         if (gmx_strcasecmp(str[i], key) == 0)
 120         {
 121             return i;
 122         }
 123     }
 124
 125     return -1;
 126 }
 127
 128 static int fget_lines(FILE* in, const char* db, char*** strings)
 129 {
 130     char** ptr = nullptr;
 131     char   buf[STRLEN];
 132     int    nstr = 0;
 133
 134     char* pret = fgets(buf, STRLEN, in);
 135     if (pret == nullptr || sscanf(buf, "%d", &nstr) != 1)
 136     {
 137         gmx_warning("File is empty");
 138         gmx_ffclose(in);
 139
 140         return 0;
 141     }
 142     snew(ptr, nstr);
 143     for (int i = 0; (i < nstr); i++)
 144     {
 145         if (fgets2(buf, STRLEN, in) == nullptr)
 146         {
 147             /* i+1 because index starts from 0, line numbering from 1 and
 148              * additional +1 since first line in the file is used for the line
 149              * count */
 150             gmx_fatal(FARGS, "Cannot read string from buffer (file %s, line %d)", db, i + 2);
 151         }
 152         ptr[i] = gmx_strdup(buf);
 153     }
 154
 155     (*strings) = ptr;
 156
 157     return nstr;
 158 }
 159
 160 int get_lines(const char* db, char*** strings)
 161 {
 162     gmx::FilePtr in = gmx::openLibraryFile(db);
 163     return fget_lines(in.get(), db, strings);
 164 }