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 capturing `stdout` and file output from code that supports it.
  55  *
  56  * The calling code should take in this interface and use the File objects
  57  * it returns for all output that needs to support this redirection.
  58  * By default, the code can then use defaultFileOutputRedirector() in case no
  59  * redirection is needed.
  60  *
  61  * This allows tests to capture the file output without duplicating the
  62  * knowledge of which files are actually produced.  With some further
  63  * refactoring of the File class, this could support capturing the output into
  64  * in-memory buffers as well, but for now the current capabilities are
  65  * sufficient.
  66  *
  67  * \inlibraryapi
  68  * \ingroup module_utility
  69  */
  70 class FileOutputRedirectorInterface
  71 {
  72     public:
  73         virtual ~FileOutputRedirectorInterface();
  74
  75         /*! \brief
  76          * Returns a File object to use for `stdout` output.
  77          */
  78         virtual File &standardOutput() = 0;
  79         /*! \brief
  80          * Returns a File object to use for output to a given file.
  81          *
  82          * \param[in] filename  Requested file name.
  83          */
  84         virtual FileInitializer openFileForWriting(const char *filename) = 0;
  85
  86         //! Convenience method to open a file using an std::string path.
  87         FileInitializer openFileForWriting(const std::string &filename)
  88         {
  89             return openFileForWriting(filename.c_str());
  90         }
  91 };
  92
  93 //! \cond libapi
  94 /*! \brief
  95  * Returns default implementation for FileOutputRedirectorInterface.
  96  *
  97  * The returned implementation does not redirect anything, but just opens the
  98  * files at requested locations.
  99  *
 100  * \ingroup module_utility
 101  */
 102 FileOutputRedirectorInterface &defaultFileOutputRedirector();
 103 //! \endcond
 104
 105 } // namespace gmx
 106
 107 #endif