src/testutils/stdiohelper.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2017,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::test::StdioTestHelper.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS_STDIOHELPER_H
  44 #define GMX_TESTUTILS_STDIOHELPER_H
  45
  46 #include "gromacs/utility/classhelpers.h"
  47
  48 namespace gmx
  49 {
  50 namespace test
  51 {
  52
  53 class TestFileManager;
  54
  55 /*! \libinternal \brief
  56  * Helper class for tests where code reads directly from `stdin`.
  57  *
  58  * Any method in this class may throw std::bad_alloc if out of memory.
  59  *
  60  * \inlibraryapi
  61  * \ingroup module_testutils
  62  */
  63 class StdioTestHelper
  64 {
  65 public:
  66     //! Creates a helper using the given file manager.
  67     explicit StdioTestHelper(TestFileManager* fileManager) : fileManager_(*fileManager) {}
  68
  69     /*! \brief Accepts a string as input, writes it to a temporary
  70      * file and then reopens stdin to read the contents of that
  71      * string.
  72      *
  73      * \throws FileIOError  when the freopen() fails
  74      */
  75     void redirectStringToStdin(const char* theString);
  76
  77 private:
  78     TestFileManager& fileManager_;
  79
  80     GMX_DISALLOW_COPY_AND_ASSIGN(StdioTestHelper);
  81 };
  82
  83 } // namespace test
  84 } // namespace gmx
  85
  86 #endif