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::FileOutputRedirectorInterface.
  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/file.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  * By default, the code can then use defaultFileInputRedirector() in case no
  59  * redirection is needed.
  60  *
  61  * This allows tests to override the file existence checks without actually
  62  * using the file system.
  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 FileInputRedirectorInterface
  72 {
  73     public:
  74         virtual ~FileInputRedirectorInterface();
  75
  76         /*! \brief
  77          * Checks whether the provided path exists (and is a file).
  78          */
  79         virtual bool fileExists(const char *filename) const = 0;
  80
  81         //! Convenience method to check file existence using an std::string path.
  82         bool fileExists(const std::string &filename) const
  83         {
  84             return fileExists(filename.c_str());
  85         }
  86 };
  87
  88 /*! \libinternal \brief
  89  * Allows capturing `stdout` and file output from code that supports it.
  90  *
  91  * The calling code should take in this interface and use the File objects
  92  * it returns for all output that needs to support this redirection.
  93  * By default, the code can then use defaultFileOutputRedirector() in case no
  94  * redirection is needed.
  95  *
  96  * This allows tests to capture the file output without duplicating the
  97  * knowledge of which files are actually produced.  With some further
  98  * refactoring of the File class, this could support capturing the output into
  99  * in-memory buffers as well, but for now the current capabilities are
 100  * sufficient.
 101  *
 102  * \inlibraryapi
 103  * \ingroup module_utility
 104  */
 105 class FileOutputRedirectorInterface
 106 {
 107     public:
 108         virtual ~FileOutputRedirectorInterface();
 109
 110         /*! \brief
 111          * Returns a File object to use for `stdout` output.
 112          */
 113         virtual File &standardOutput() = 0;
 114         /*! \brief
 115          * Returns a File object to use for output to a given file.
 116          *
 117          * \param[in] filename  Requested file name.
 118          */
 119         virtual FileInitializer openFileForWriting(const char *filename) = 0;
 120
 121         //! Convenience method to open a file using an std::string path.
 122         FileInitializer openFileForWriting(const std::string &filename)
 123         {
 124             return openFileForWriting(filename.c_str());
 125         }
 126 };
 127
 128 //! \cond libapi
 129 /*! \brief
 130  * Returns default implementation for FileInputRedirectorInterface.
 131  *
 132  * The returned implementation does not redirect anything, but just uses the
 133  * file system normally.
 134  *
 135  * Does not throw.
 136  *
 137  * \ingroup module_utility
 138  */
 139 FileInputRedirectorInterface &defaultFileInputRedirector();
 140 /*! \brief
 141  * Returns default implementation for FileOutputRedirectorInterface.
 142  *
 143  * The returned implementation does not redirect anything, but just opens the
 144  * files at requested locations.
 145  *
 146  * Does not throw.
 147  *
 148  * \ingroup module_utility
 149  */
 150 FileOutputRedirectorInterface &defaultFileOutputRedirector();
 151 //! \endcond
 152
 153 } // namespace gmx
 154
 155 #endif