Introduce SimulatorBuilder
[gromacs.git] / src / gromacs / onlinehelp / tests / mock_helptopic.h
blob5151087245773a3514028fa216eb1143ee28e911
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2014,2015,2018, 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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
36 * \brief
37 * Declares mock implementation of gmx::IHelpTopic.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \inlibraryapi
41 * \ingroup module_onlinehelp
43 #ifndef GMX_ONLINEHELP_TESTS_MOCK_HELPTOPIC_H
44 #define GMX_ONLINEHELP_TESTS_MOCK_HELPTOPIC_H
46 #include <gmock/gmock.h>
48 #include "gromacs/onlinehelp/helptopic.h"
49 #include "gromacs/onlinehelp/helpwritercontext.h"
51 namespace gmx
53 namespace test
56 class MockHelpTopic : public AbstractCompositeHelpTopic
58 public:
59 static MockHelpTopic &addSubTopic(
60 gmx::AbstractCompositeHelpTopic *parent,
61 const char *name, const char *title, const char *text);
63 MockHelpTopic(const char *name, const char *title, const char *text);
64 ~MockHelpTopic() override;
66 const char *name() const override;
67 const char *title() const override;
69 MOCK_CONST_METHOD1(writeHelp, void(const HelpWriterContext &context));
71 MockHelpTopic &addSubTopic(const char *name, const char *title,
72 const char *text);
73 using AbstractCompositeHelpTopic::addSubTopic;
75 /*! \brief
76 * Calls base class writeHelp() method.
78 * This provides the possibility for the mock to do the actual help
79 * writing.
81 void writeHelpBase(const HelpWriterContext &context)
83 AbstractCompositeHelpTopic::writeHelp(context);
86 private:
87 std::string helpText() const override;
89 const char *name_;
90 const char *title_;
91 const char *text_;
94 } // namespace test
95 } // namespace gmx
97 #endif