src/gromacs/utility/fileredirector.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2018,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 /*! \internal \file
  36  * \brief
  37  * Implements classes and functions from fileredirector.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "fileredirector.h"
  45
  46 #include "gromacs/utility/filestream.h"
  47 #include "gromacs/utility/path.h"
  48
  49 namespace gmx
  50 {
  51
  52 IFileInputRedirector::~IFileInputRedirector() {}
  53
  54 IFileOutputRedirector::~IFileOutputRedirector() {}
  55
  56 namespace
  57 {
  58
  59 /*! \internal
  60  * \brief
  61  * Implements the redirector returned by defaultFileInputRedirector().
  62  *
  63  * Does not redirect anything, but uses the file system as requested.
  64  *
  65  * \ingroup module_utility
  66  */
  67 class DefaultInputRedirector : public IFileInputRedirector
  68 {
  69 public:
  70     bool fileExists(const char* filename, File::NotFoundHandler onNotFound) const override
  71     {
  72         return File::exists(filename, onNotFound);
  73     }
  74 };
  75
  76 /*! \internal
  77  * \brief
  78  * Implements the redirector returned by defaultFileOutputRedirector().
  79  *
  80  * Does not redirect anything, but instead opens the files exactly as
  81  * requested.
  82  *
  83  * \ingroup module_utility
  84  */
  85 class DefaultOutputRedirector : public IFileOutputRedirector
  86 {
  87 public:
  88     TextOutputStream&       standardOutput() override { return TextOutputFile::standardOutput(); }
  89     TextOutputStreamPointer openTextOutputFile(const char* filename) override
  90     {
  91         return TextOutputStreamPointer(new TextOutputFile(filename));
  92     }
  93 };
  94
  95 } // namespace
  96
  97 //! \cond libapi
  98 IFileInputRedirector& defaultFileInputRedirector()
  99 {
 100     static DefaultInputRedirector instance;
 101     return instance;
 102 }
 103
 104 IFileOutputRedirector& defaultFileOutputRedirector()
 105 {
 106     static DefaultOutputRedirector instance;
 107     return instance;
 108 }
 109 //! \endcond
 110
 111 } // namespace gmx