src/gromacs/utility/textreader.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2017,2019, 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 gmx::TextReader.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "textreader.h"
  45
  46 #include "gromacs/utility/filestream.h"
  47 #include "gromacs/utility/nodelete.h"
  48 #include "gromacs/utility/textstream.h"
  49
  50 namespace gmx
  51 {
  52
  53 // static
  54 std::string TextReader::readFileToString(const char* filename)
  55 {
  56     TextReader  reader(filename);
  57     std::string result(reader.readAll());
  58     reader.close();
  59     return result;
  60 }
  61
  62 // static
  63 std::string TextReader::readFileToString(const std::string& filename)
  64 {
  65     return readFileToString(filename.c_str());
  66 }
  67
  68 //! Implementation class
  69 class TextReader::Impl
  70 {
  71 public:
  72     //! Constructor.
  73     explicit Impl(const TextInputStreamPointer& stream) :
  74         stream_(stream),
  75         trimLeadingWhiteSpace_(false),
  76         trimTrailingWhiteSpace_(false),
  77         trimTrailingComment_(false),
  78         commentChar_(0)
  79     {
  80     }
  81
  82     //! Stream used by this reader.
  83     TextInputStreamPointer stream_;
  84     //! Whether leading whitespace should be removed.
  85     bool trimLeadingWhiteSpace_;
  86     //! Whether trailing whitespace should be removed.
  87     bool trimTrailingWhiteSpace_;
  88     //! Whether a trailing comment should be removed.
  89     bool trimTrailingComment_;
  90     /*! \brief Character that denotes the start of a comment on a line.
  91      *
  92      * Zero until TextReader::setTrimTrailingComment is called to
  93      * activate such trimming with a given character. */
  94     char commentChar_;
  95 };
  96
  97 TextReader::TextReader(const std::string& filename) :
  98     impl_(new Impl(TextInputStreamPointer(new TextInputFile(filename))))
  99 {
 100 }
 101
 102 TextReader::TextReader(TextInputStream* stream) :
 103     impl_(new Impl(TextInputStreamPointer(stream, no_delete<TextInputStream>())))
 104 {
 105 }
 106
 107 TextReader::TextReader(const TextInputStreamPointer& stream) : impl_(new Impl(stream)) {}
 108
 109 TextReader::~TextReader() {}
 110
 111 bool TextReader::readLine(std::string* linePtr)
 112 {
 113     if (!impl_->stream_->readLine(linePtr))
 114     {
 115         return false;
 116     }
 117     auto&      line              = *linePtr;
 118     const char whiteSpaceChars[] = " \t\r\n";
 119     if (impl_->trimLeadingWhiteSpace_)
 120     {
 121         const size_t endPos = line.find_first_not_of(whiteSpaceChars);
 122         if (endPos == std::string::npos)
 123         {
 124             line.resize(0);
 125         }
 126         else
 127         {
 128             line = line.substr(endPos, std::string::npos);
 129         }
 130     }
 131     if (impl_->trimTrailingComment_)
 132     {
 133         auto commentPos = line.find(impl_->commentChar_);
 134         if (commentPos != std::string::npos)
 135         {
 136             line.resize(commentPos);
 137         }
 138     }
 139     if (impl_->trimTrailingWhiteSpace_)
 140     {
 141         const size_t endPos = line.find_last_not_of(whiteSpaceChars);
 142         if (endPos == std::string::npos)
 143         {
 144             line.resize(0);
 145         }
 146         else
 147         {
 148             line.resize(endPos + 1);
 149         }
 150     }
 151     return true;
 152 }
 153
 154 void TextReader::setTrimLeadingWhiteSpace(bool doTrimming)
 155 {
 156     impl_->trimLeadingWhiteSpace_ = doTrimming;
 157 }
 158
 159 void TextReader::setTrimTrailingWhiteSpace(bool doTrimming)
 160 {
 161     impl_->trimTrailingWhiteSpace_ = doTrimming;
 162 }
 163
 164 void TextReader::setTrimTrailingComment(bool doTrimming, char commentChar)
 165 {
 166     impl_->trimTrailingComment_ = doTrimming;
 167     if (impl_->trimTrailingComment_)
 168     {
 169         impl_->commentChar_ = commentChar;
 170     }
 171 }
 172
 173 std::string TextReader::readAll()
 174 {
 175     std::string result;
 176     std::string line;
 177     while (readLine(&line))
 178     {
 179         result.append(line);
 180     }
 181     return result;
 182 }
 183
 184 void TextReader::close()
 185 {
 186     impl_->stream_->close();
 187 }
 188
 189 } // namespace gmx