src/gromacs/utility/fileredirector.h

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