src/gromacs/utility/filestream.h

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