src/gromacs/utility/filestream.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 implementations for textstream.h interfaces for file input/output.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_FILESTREAM_H
  44 #define GMX_UTILITY_FILESTREAM_H
  45
  46 #include <cstdio>
  47
  48 #include <string>
  49
  50 #include "gromacs/utility/classhelpers.h"
  51 #include "gromacs/utility/textstream.h"
  52
  53 namespace gmx
  54 {
  55
  56 namespace internal
  57 {
  58 class FileStreamImpl;
  59 }
  60
  61 /*! \libinternal \brief
  62  * Text input stream implementation for reading from `stdin`.
  63  *
  64  * Implementations for the TextInputStream methods throw FileIOError on any
  65  * I/O error.
  66  *
  67  * \inlibraryapi
  68  * \ingroup module_utility
  69  */
  70 class StandardInputStream : public TextInputStream
  71 {
  72     public:
  73         /*! \brief
  74          * Returns whether `stdin` is an interactive terminal.
  75          *
  76          * Only works on Unix, otherwise always returns true.
  77          *
  78          * Does not throw.
  79          */
  80         bool isInteractive() const;
  81
  82         // From TextInputStream
  83         virtual bool readLine(std::string *line);
  84         virtual void close() {}
  85
  86         /*! \brief
  87          * Returns a stream for accessing `stdin`.
  88          *
  89          * Does not throw.
  90          */
  91         static StandardInputStream &instance();
  92 };
  93
  94 /*! \libinternal \brief
  95  * Text input stream implementation for reading from a file.
  96  *
  97  * Implementations for the TextInputStream methods throw FileIOError on any
  98  * I/O error.
  99  *
 100  * \inlibraryapi
 101  * \ingroup module_utility
 102  */
 103 class TextInputFile : public TextInputStream
 104 {
 105     public:
 106         /*! \brief
 107          * Opens a file and returns a `FILE` handle.
 108          *
 109          * \param[in] filename  Path of the file to open.
 110          * \throws    FileIOError on any I/O error.
 111          *
 112          * Instead of returning `NULL` on errors, throws an exception with
 113          * additional details (including the file name and `errno`).
 114          */
 115         static FILE *openRawHandle(const char *filename);
 116         //! \copydoc openRawHandle(const char *, const char *)
 117         static FILE *openRawHandle(const std::string &filename);
 118
 119         /*! \brief
 120          * Opens a text file as a stream.
 121          *
 122          * \param[in]  filename  Path to the file to open.
 123          * \throws     std::bad_alloc if out of memory.
 124          * \throws     FileIOError on any I/O error.
 125          */
 126         explicit TextInputFile(const std::string &filename);
 127         /*! \brief
 128          * Initializes file object from an existing file handle.
 129          *
 130          * \param[in]  fp     File handle to use.
 131          * \throws     std::bad_alloc if out of memory.
 132          *
 133          * The caller is responsible of closing the file; close() does nothing
 134          * for an object constructed this way.
 135          */
 136         explicit TextInputFile(FILE *fp);
 137         virtual ~TextInputFile();
 138
 139         /*! \brief
 140          * Returns a raw handle to the input file.
 141          *
 142          * This is provided for interoperability with older C-like code.
 143          */
 144         FILE *handle();
 145
 146         // From TextInputStream
 147         virtual bool readLine(std::string *line);
 148         virtual void close();
 149
 150     private:
 151         PrivateImplPointer<internal::FileStreamImpl> impl_;
 152 };
 153
 154 /*! \libinternal \brief
 155  * Text output stream implementation for writing to a file.
 156  *
 157  * Implementations for the TextOutputStream methods throw FileIOError on any
 158  * I/O error.
 159  *
 160  * \inlibraryapi
 161  * \ingroup module_utility
 162  */
 163 class TextOutputFile : public TextOutputStream
 164 {
 165     public:
 166         //! \copydoc TextInputFile::TextInputFile(const std::string &)
 167         explicit TextOutputFile(const std::string &filename);
 168         //! \copydoc TextInputFile::TextInputFile(FILE *)
 169         explicit TextOutputFile(FILE *fp);
 170         virtual ~TextOutputFile();
 171
 172         // From TextOutputStream
 173         virtual void write(const char *text);
 174         virtual void close();
 175
 176         /*! \brief
 177          * Returns a stream for accessing `stdout`.
 178          *
 179          * \throws    std::bad_alloc if out of memory (only on first call).
 180          */
 181         static TextOutputFile &standardOutput();
 182         /*! \brief
 183          * Returns a stream for accessing `stderr`.
 184          *
 185          * \throws    std::bad_alloc if out of memory (only on first call).
 186          */
 187         static TextOutputFile &standardError();
 188
 189     private:
 190         PrivateImplPointer<internal::FileStreamImpl> impl_;
 191 };
 192
 193 } // namespace gmx
 194
 195 #endif