src/gromacs/utility/textreader.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015, 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 gmx::TextReader.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_TEXTREADER_H
  44 #define GMX_UTILITY_TEXTREADER_H
  45
  46 #include <string>
  47
  48 #include "gromacs/utility/classhelpers.h"
  49 #include "gromacs/utility/textstream.h"
  50
  51 namespace gmx
  52 {
  53
  54 /*! \libinternal \brief
  55  * Reads text from a TextInputStream.
  56  *
  57  * This class provides more formatted reading capabilities than reading raw
  58  * lines from the stream (and a natural place to implement more such
  59  * capabilities).
  60  *
  61  * All methods that read from the stream can throw any exceptions that the
  62  * underlying stream throws.
  63  *
  64  * \inlibraryapi
  65  * \ingroup module_utility
  66  */
  67 class TextReader
  68 {
  69     public:
  70         /*! \brief
  71          * Creates a reader that reads from specified file.
  72          *
  73          * \param[in]  filename  Path to the file to open.
  74          * \throws     std::bad_alloc if out of memory.
  75          * \throws     FileIOError on any I/O error.
  76          *
  77          * This constructor is provided for convenience for reading directly
  78          * from a file, without the need to construct multiple objects.
  79          */
  80         explicit TextReader(const std::string &filename);
  81         /*! \brief
  82          * Creates a reader that reads from specified stream.
  83          *
  84          * \param[in]  stream  Stream to read from.
  85          * \throws     std::bad_alloc if out of memory.
  86          *
  87          * The caller is responsible of the lifetime of the stream (should
  88          * remain in existence as long as the reader exists).
  89          *
  90          * This constructor is provided for convenience for cases where the
  91          * stream is not allocated with `new` and/or not managed by a
  92          * boost::shared_ptr (e.g., if the stream is an object on the stack).
  93          */
  94         explicit TextReader(TextInputStream *stream);
  95         /*! \brief
  96          * Creates a reader that reads from specified stream.
  97          *
  98          * \param[in]  stream  Stream to read from.
  99          * \throws     std::bad_alloc if out of memory.
 100          *
 101          * The reader keeps a reference to the stream, so the caller can pass
 102          * in a temporary if necessary.
 103          */
 104         explicit TextReader(const TextInputStreamPointer &stream);
 105         ~TextReader();
 106
 107         /*! \brief
 108          * Reads a single line (including newline) from the stream.
 109          *
 110          * \param[out] line    String to receive the line.
 111          * \returns    `false` if nothing was read because the file ended.
 112          *
 113          * On error or when false is returned, \p line will be empty.
 114          * Newlines will be returned as part of \p line if it was present in
 115          * the stream.
 116          * To loop over all lines in the stream, use:
 117          * \code
 118            std::string line;
 119            while (reader.readLine(&line))
 120            {
 121                // ...
 122            }
 123            \endcode
 124          */
 125         bool readLine(std::string *line);
 126         /*! \brief
 127          * Reads a single line from the stream.
 128          *
 129          * \param[out] line    String to receive the line.
 130          * \returns    false if nothing was read because the file ended.
 131          *
 132          * On error or when false is returned, \p line will be empty.
 133          * Works as readLine(), except that trailing whitespace will be removed
 134          * from \p line.
 135          *
 136          * \see readLine()
 137          */
 138         bool readLineTrimmed(std::string *line);
 139
 140         /*! \brief
 141          * Closes the underlying stream.
 142          */
 143         void close();
 144
 145     private:
 146         class Impl;
 147
 148         PrivateImplPointer<Impl> impl_;
 149 };
 150
 151 } // namespace gmx
 152
 153 #endif