src/gromacs/utility/fileredirector.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::IFileOutputRedirector.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_FILEREDIRECTOR_H
  44 #define GMX_UTILITY_FILEREDIRECTOR_H
  45
  46 #include <string>
  47
  48 #include "gromacs/utility/textstream.h"
  49
  50 namespace gmx
  51 {
  52
  53 /*! \libinternal \brief
  54  * Allows overriding file existence checks from code that supports it.
  55  *
  56  * The calling code should take in this interface and use the methods in it
  57  * all file system operations that need to support this redirection.
  58  *
  59  * This allows tests to override the file existence checks without actually
  60  * using the file system.  See IFileOutputRedirector for notes on
  61  * a typical usage pattern.
  62  *
  63  * With some further refactoring of the File class, this could also support
  64  * redirecting input files from in-memory buffers as well, but for now the
  65  * current capabilities are sufficient.
  66  *
  67  * \inlibraryapi
  68  * \ingroup module_utility
  69  */
  70 class IFileInputRedirector
  71 {
  72     public:
  73         virtual ~IFileInputRedirector();
  74
  75         /*! \brief
  76          * Checks whether the provided path exists (and is a file).
  77          */
  78         virtual bool fileExists(const char *filename) const = 0;
  79
  80         //! Convenience method to check file existence using an std::string path.
  81         bool fileExists(const std::string &filename) const
  82         {
  83             return fileExists(filename.c_str());
  84         }
  85 };
  86
  87 /*! \libinternal \brief
  88  * Allows capturing `stdout` and file output from code that supports it.
  89  *
  90  * The calling code should take in this interface and use the stream objects
  91  * it returns for all output that needs to support this redirection.
  92  *
  93  * Currently, the (nearly) only purpose for this interface is for unit tests to
  94  * capture the file output without duplicating the knowledge of which files are
  95  * actually produced.  The tests can also replace actual files with in-memory
  96  * streams (e.g., a StringOutputStream), and test the output without actually
  97  * accessing the file system and managing actual files.
  98  *
  99  * As the main user for non-default implementation of this interface is tests,
 100  * code using this interface generally uses a pattern where the redirector is
 101  * initialized to defaultFileOutputRedirector(), and a separate setter is
 102  * provided for tests to change the default.  This allows code outside the
 103  * tests (and outside the code actually calling the redirector) to be written
 104  * as if this interface did not exist (i.e., they do not need to pass the
 105  * default instance).
 106  *
 107  * Also, the interface only supports text files, but can be generalized if/when
 108  * there is a need for binary streams (see also TextOutputStream).
 109  *
 110  * \inlibraryapi
 111  * \ingroup module_utility
 112  */
 113 class IFileOutputRedirector
 114 {
 115     public:
 116         virtual ~IFileOutputRedirector();
 117
 118         /*! \brief
 119          * Returns a stream to use for `stdout` output.
 120          */
 121         virtual TextOutputStream &standardOutput() = 0;
 122         /*! \brief
 123          * Returns a stream to use for output to a file at a given path.
 124          *
 125          * \param[in] filename  Requested file name.
 126          */
 127         virtual TextOutputStreamPointer openTextOutputFile(const char *filename) = 0;
 128
 129         //! Convenience method to open a stream using an std::string path.
 130         TextOutputStreamPointer openTextOutputFile(const std::string &filename)
 131         {
 132             return openTextOutputFile(filename.c_str());
 133         }
 134 };
 135
 136 //! \cond libapi
 137 /*! \brief
 138  * Returns default implementation for IFileInputRedirector.
 139  *
 140  * The returned implementation does not redirect anything, but just uses the
 141  * file system normally.
 142  *
 143  * Does not throw.
 144  *
 145  * \ingroup module_utility
 146  */
 147 IFileInputRedirector &defaultFileInputRedirector();
 148 /*! \brief
 149  * Returns default implementation for IFileOutputRedirector.
 150  *
 151  * The returned implementation does not redirect anything, but just opens the
 152  * files at requested locations.
 153  *
 154  * Does not throw.
 155  *
 156  * \ingroup module_utility
 157  */
 158 IFileOutputRedirector &defaultFileOutputRedirector();
 159 //! \endcond
 160
 161 } // namespace gmx
 162
 163 #endif