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 output stream implementation for writing to a file.
  63  *
  64  * Implementations for the TextOutputStream methods throw FileIOError on any
  65  * I/O error.
  66  *
  67  * \inlibraryapi
  68  * \ingroup module_utility
  69  */
  70 class TextOutputFile : public TextOutputStream
  71 {
  72     public:
  73         /*! \brief
  74          * Opens a text file as a stream.
  75          *
  76          * \param[in]  filename  Path to the file to open.
  77          * \throws     std::bad_alloc if out of memory.
  78          * \throws     FileIOError on any I/O error.
  79          */
  80         explicit TextOutputFile(const std::string &filename);
  81         /*! \brief
  82          * Initializes file object from an existing file handle.
  83          *
  84          * \param[in]  fp     File handle to use.
  85          * \throws     std::bad_alloc if out of memory.
  86          *
  87          * The caller is responsible of closing the file; close() does nothing
  88          * for an object constructed this way.
  89          */
  90         explicit TextOutputFile(FILE *fp);
  91         virtual ~TextOutputFile();
  92
  93         // From TextOutputStream
  94         virtual void write(const char *text);
  95         virtual void close();
  96
  97         /*! \brief
  98          * Returns a stream for accessing `stdout`.
  99          *
 100          * \throws    std::bad_alloc if out of memory (only on first call).
 101          */
 102         static TextOutputFile &standardOutput();
 103         /*! \brief
 104          * Returns a stream for accessing `stderr`.
 105          *
 106          * \throws    std::bad_alloc if out of memory (only on first call).
 107          */
 108         static TextOutputFile &standardError();
 109
 110     private:
 111         PrivateImplPointer<internal::FileStreamImpl> impl_;
 112 };
 113
 114 } // namespace gmx
 115
 116 #endif