src/testutils/testoptions.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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  * Functions for accessing test command-line options.
  38  *
  39  * Functions in this header allow accessing command-line options passed to the
  40  * test executable from tests.  This can be used to, e.g., enable additional
  41  * output for debugging purposes.
  42  *
  43  * \author Teemu Murtola <teemu.murtola@gmail.com>
  44  * \inlibraryapi
  45  * \ingroup module_testutils
  46  */
  47 #ifndef GMX_TESTUTILS_TESTOPTIONS_H
  48 #define GMX_TESTUTILS_TESTOPTIONS_H
  49
  50 namespace gmx
  51 {
  52
  53 class Options;
  54
  55 namespace test
  56 {
  57
  58 /*! \libinternal \brief
  59  * Initializes the test utilities library.
  60  *
  61  * Does not throw.  Terminates the program with a non-zero error code if an
  62  * error occurs.
  63  *
  64  * This function is automatically called by test_main_gtest.cpp and
  65  * test_main_gmock.cpp.
  66  */
  67 void initTestUtils(const char *dataPath, int *argc, char *argv[]);
  68 /*! \libinternal \brief
  69  * Parses given options from the command line.
  70  *
  71  * \param[in] options  Definition of options to parse.
  72  * \throws  std::bad_alloc if out of memory.
  73  * \throws  TestException if an error occurs in the parsing.
  74  *
  75  * This can be used from test or test fixture setup functions to initialize
  76  * local variables.  Although this means that the parameters are potentially
  77  * parsed multiple times, the performance impact should not be significant.
  78  *
  79  * \inlibraryapi
  80  */
  81 void parseTestOptions(Options *options);
  82
  83 } // namespace test
  84 } // namespace gmx
  85
  86 #endif