src/gromacs/utility/strconvert.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2018,2019,2021, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements functions in strconvert.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "strconvert.h"
  45
  46 #include <cerrno>
  47 #include <cstdlib>
  48
  49 #include <limits>
  50 #include <string>
  51
  52 #include "gromacs/utility/cstringutil.h"
  53 #include "gromacs/utility/exceptions.h"
  54
  55 namespace gmx
  56 {
  57
  58 //! \cond libapi
  59
  60 bool boolFromString(const char* value)
  61 {
  62     if (gmx_strcasecmp(value, "1") == 0 || gmx_strcasecmp(value, "yes") == 0
  63         || gmx_strcasecmp(value, "true") == 0)
  64     {
  65         return true;
  66     }
  67     if (gmx_strcasecmp(value, "0") == 0 || gmx_strcasecmp(value, "no") == 0
  68         || gmx_strcasecmp(value, "false") == 0)
  69     {
  70         return false;
  71     }
  72     GMX_THROW(InvalidInputError("Invalid value: '" + std::string(value)
  73                                 + "'; supported values are: 1, 0, yes, no, true, false"));
  74 }
  75
  76 int intFromString(const char* str)
  77 {
  78     errno                 = 0;
  79     char*          endptr = nullptr;
  80     const long int value  = std::strtol(str, &endptr, 10);
  81     if (errno == ERANGE || value < std::numeric_limits<int>::min()
  82         || value > std::numeric_limits<int>::max())
  83     {
  84         GMX_THROW(InvalidInputError("Invalid value: '" + std::string(str)
  85                                     + "'; it causes an integer overflow"));
  86     }
  87     if (str[0] == '\0' || *endptr != '\0')
  88     {
  89         GMX_THROW(InvalidInputError("Invalid value: '" + std::string(str) + "'; expected an integer"));
  90     }
  91     return value;
  92 }
  93
  94 int64_t int64FromString(const char* str)
  95 {
  96     errno                = 0;
  97     char*         endptr = nullptr;
  98     const int64_t value  = str_to_int64_t(str, &endptr);
  99     if (errno == ERANGE)
 100     {
 101         GMX_THROW(InvalidInputError("Invalid value: '" + std::string(str)
 102                                     + "'; it causes an integer overflow"));
 103     }
 104     if (str[0] == '\0' || *endptr != '\0')
 105     {
 106         GMX_THROW(InvalidInputError("Invalid value: '" + std::string(str) + "'; expected an integer"));
 107     }
 108     return value;
 109 }
 110
 111 float floatFromString(const char* str)
 112 {
 113     errno               = 0;
 114     char*        endptr = nullptr;
 115     const double value  = std::strtod(str, &endptr);
 116     if (errno == ERANGE || value < -std::numeric_limits<float>::max()
 117         || value > std::numeric_limits<float>::max())
 118     {
 119         GMX_THROW(InvalidInputError("Invalid value: '" + std::string(str)
 120                                     + "'; it causes an overflow/underflow"));
 121     }
 122     if (str[0] == '\0' || *endptr != '\0')
 123     {
 124         GMX_THROW(InvalidInputError("Invalid value: '" + std::string(str) + "'; expected a number"));
 125     }
 126     return value;
 127 }
 128
 129 double doubleFromString(const char* str)
 130 {
 131     errno               = 0;
 132     char*        endptr = nullptr;
 133     const double value  = std::strtod(str, &endptr);
 134     if (errno == ERANGE)
 135     {
 136         GMX_THROW(InvalidInputError("Invalid value: '" + std::string(str)
 137                                     + "'; it causes an overflow/underflow"));
 138     }
 139     if (str[0] == '\0' || *endptr != '\0')
 140     {
 141         GMX_THROW(InvalidInputError("Invalid value: '" + std::string(str) + "'; expected a number"));
 142     }
 143     return value;
 144 }
 145
 146 //! \endcond
 147
 148 } // namespace gmx