src/gromacs/utility/stringstream.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2017,2018, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares implementations for textstream.h interfaces for input/output to
  38  * in-memory strings.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \inlibraryapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_STRINGSTREAM_H
  45 #define GMX_UTILITY_STRINGSTREAM_H
  46
  47 #include <string>
  48 #include <vector>
  49
  50 #include "gromacs/utility/textstream.h"
  51
  52 namespace gmx
  53 {
  54
  55 /*! \libinternal \brief
  56  * Text output stream implementation for writing to an in-memory string.
  57  *
  58  * Implementations for the TextOutputStream methods throw std::bad_alloc if
  59  * reallocation of the string fails.
  60  *
  61  * \inlibraryapi
  62  * \ingroup module_utility
  63  */
  64 class StringOutputStream : public TextOutputStream
  65 {
  66     public:
  67         //! Returns the text written to the stream so far.
  68         const std::string &toString() const { return str_; }
  69
  70         // From TextOutputStream
  71         void write(const char *text) override;
  72         void close() override;
  73
  74     private:
  75         std::string str_;
  76 };
  77
  78 template<typename T> class ArrayRef;
  79
  80 /*! \libinternal \brief
  81  * Helper class to convert static string data to a stream.
  82  *
  83  * Provides a text input stream that returns lines from a string
  84  */
  85 class StringInputStream : public TextInputStream
  86 {
  87     public:
  88         /*! \brief
  89          * Constructor that stores input lines in a string.
  90          *
  91          * The string is internally but no processing is done.
  92          *
  93          * \param[in] input String to be served by the stream.
  94          */
  95         explicit StringInputStream(const std::string &input);
  96         /*! \brief
  97          * Constructor that stores input lines in a string.
  98          *
  99          * The vector of strings is stored as a string separated by newline.
 100          *
 101          * \param[in] input String to be served by the stream.
 102          */
 103         explicit StringInputStream(const std::vector<std::string> &input);
 104         /*! \brief
 105          * Constructor that stores input lines in a string.
 106          *
 107          * The array of char * is stored as a string separated by newline.
 108          *
 109          * \param[in] input Array of char * to be served by the stream.
 110          */
 111         explicit StringInputStream(ArrayRef<const char *const> const &input);
 112
 113         // From TextInputStream
 114         bool readLine(std::string *line) override;
 115         void close() override {}
 116     private:
 117         std::string input_;
 118         size_t      pos_;
 119 };
 120
 121 } // namespace gmx
 122
 123 #endif