src/testutils/xvgtest.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 function to add the content of an xvg file to a checker.
  38  *
  39  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \inlibraryapi
  42  * \ingroup module_testutils
  43  */
  44 #ifndef GMX_TESTUTILS_XVGTESTS_H
  45 #define GMX_TESTUTILS_XVGTESTS_H
  46
  47 #include <string>
  48
  49 #include "testutils/testasserts.h"
  50 #include "testutils/textblockmatchers.h"
  51
  52 namespace gmx
  53 {
  54
  55 class TextInputStream;
  56
  57 namespace test
  58 {
  59
  60 class TestReferenceChecker;
  61
  62 struct XvgMatchSettings
  63 {
  64     XvgMatchSettings() : tolerance(defaultRealTolerance()), testData(true)
  65     {
  66     }
  67
  68     FloatingPointTolerance  tolerance;
  69     bool                    testData;
  70 };
  71
  72 /*! \brief
  73  * Adds content of xvg file to TestReferenceChecker object.
  74  *
  75  * \param[in] input       Stream that provides the xvg content.
  76  * \param[in,out] checker Checker to use.
  77  * \param[in] settings    Settings to use for matching.
  78  *
  79  * Parses an xvg file from the input stream, and checks the contents against
  80  * reference data.  \p settings can be used to customize the matching.
  81  * Only a single data set is supported (but multiple columns work).
  82  * A subset of xmgrace formatting is also checked; static content that is
  83  * nearly always the same is skipped.
  84  *
  85  * \see XvgMatch
  86  */
  87 void checkXvgFile(TextInputStream        *input,
  88                   TestReferenceChecker   *checker,
  89                   const XvgMatchSettings &settings);
  90
  91 /*! \libinternal \brief
  92  * Match the contents as an xvg file.
  93  *
  94  * \see checkXvgFile()
  95  *
  96  * \inlibraryapi
  97  * \ingroup module_testutils
  98  */
  99 class XvgMatch : public ITextBlockMatcherSettings
 100 {
 101     public:
 102         //! Sets the tolerance for matching data point values.
 103         XvgMatch &tolerance(const FloatingPointTolerance &tolerance)
 104         {
 105             settings_.tolerance = tolerance;
 106             return *this;
 107         }
 108         /*! \brief
 109          * Sets whether the actual data is checked.
 110          *
 111          * If set to `false`, only the legends are checked.  Use this if the
 112          * data is already tested using different means.
 113          */
 114         XvgMatch &testData(bool test)
 115         {
 116             settings_.testData = test;
 117             return *this;
 118         }
 119
 120         virtual TextBlockMatcherPointer createMatcher() const;
 121
 122     private:
 123         XvgMatchSettings  settings_;
 124 };
 125
 126 } // namespace test
 127
 128 } // namespace gmx
 129
 130 #endif