src/gromacs/onlinehelp/tests/mock_helptopic.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015,2017,2019,2021, 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 in mock_helptopic.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_onlinehelp
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "mock_helptopic.h"
  45
  46 #include <gmock/gmock.h>
  47 #include <gtest/gtest.h>
  48
  49 #include "gromacs/utility/stringutil.h"
  50
  51 namespace gmx
  52 {
  53 namespace test
  54 {
  55
  56 /********************************************************************
  57  * MockHelpTopic
  58  */
  59
  60 // static
  61 MockHelpTopic& MockHelpTopic::addSubTopic(gmx::AbstractCompositeHelpTopic* parent,
  62                                           const char*                      name,
  63                                           const char*                      title,
  64                                           const char*                      text)
  65 {
  66     MockHelpTopic* topic = new MockHelpTopic(name, title, text);
  67     parent->addSubTopic(gmx::HelpTopicPointer(topic));
  68     return *topic;
  69 }
  70
  71 MockHelpTopic::MockHelpTopic(const char* name, const char* title, const char* text) :
  72     name_(name), title_(title), text_(text != nullptr ? text : "")
  73 {
  74     if (!isNullOrEmpty(text))
  75     {
  76         using ::testing::_;
  77         using ::testing::Invoke;
  78         ON_CALL(*this, writeHelp(_)).WillByDefault(Invoke(this, &MockHelpTopic::writeHelpBase));
  79     }
  80 }
  81
  82 MockHelpTopic::~MockHelpTopic() {}
  83
  84 const char* MockHelpTopic::name() const
  85 {
  86     return name_;
  87 }
  88
  89 const char* MockHelpTopic::title() const
  90 {
  91     return title_;
  92 }
  93
  94 std::string MockHelpTopic::helpText() const
  95 {
  96     return text_;
  97 }
  98
  99 MockHelpTopic& MockHelpTopic::addSubTopic(const char* name, const char* title, const char* text)
 100 {
 101     return addSubTopic(this, name, title, text);
 102 }
 103
 104 } // namespace test
 105 } // namespace gmx