src/gromacs/options/optionsvisitor.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2012,2014,2015,2016 by the GROMACS development team.
   5  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Implements classes in optionsvisitor.h.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_options
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "optionsvisitor.h"
  46
  47 #include "gromacs/options/abstractoptionstorage.h"
  48 #include "gromacs/options/options.h"
  49 #include "gromacs/options/optionsection.h"
  50
  51 #include "options_impl.h"
  52
  53 namespace gmx
  54 {
  55
  56 namespace
  57 {
  58
  59 //! Helper function to call visitOptions() and handle correct indirection.
  60 void visitOption(OptionsVisitor* visitor, OptionInfo& optionInfo) //NOLINT(google-runtime-references)
  61 {
  62     visitor->visitOption(optionInfo);
  63 }
  64 //! Helper function to call visitOptions() and handle correct indirection.
  65 void visitOption(OptionsModifyingVisitor* visitor, OptionInfo& optionInfo) //NOLINT(google-runtime-references)
  66 {
  67     visitor->visitOption(&optionInfo);
  68 }
  69
  70 //! Helper function to recursively visit all options in a group.
  71 template<class VisitorType>
  72 void acceptOptionsGroup(const internal::OptionSectionImpl::Group& group, VisitorType* visitor)
  73 {
  74     for (const auto& option : group.options_)
  75     {
  76         visitOption(visitor, option->optionInfo());
  77     }
  78     for (const auto& subgroup : group.subgroups_)
  79     {
  80         acceptOptionsGroup(subgroup, visitor);
  81     }
  82 }
  83
  84 } // namespace
  85
  86 /********************************************************************
  87  * OptionsIterator
  88  */
  89
  90 OptionsIterator::OptionsIterator(const Options& options) : section_(options.rootSection().section())
  91 {
  92 }
  93
  94 OptionsIterator::OptionsIterator(const OptionSectionInfo& section) : section_(section.section()) {}
  95
  96 void OptionsIterator::acceptSections(OptionsVisitor* visitor) const
  97 {
  98     for (const auto& section : section_.subsections_)
  99     {
 100         visitor->visitSection(section->info());
 101     }
 102 }
 103
 104 void OptionsIterator::acceptOptions(OptionsVisitor* visitor) const
 105 {
 106     acceptOptionsGroup(section_.rootGroup_, visitor);
 107 }
 108
 109 /********************************************************************
 110  * OptionsModifyingIterator
 111  */
 112
 113 OptionsModifyingIterator::OptionsModifyingIterator(Options* options) :
 114     section_(options->rootSection().section())
 115 {
 116 }
 117
 118 OptionsModifyingIterator::OptionsModifyingIterator(OptionSectionInfo* section) :
 119     section_(section->section())
 120 {
 121 }
 122
 123 void OptionsModifyingIterator::acceptSections(OptionsModifyingVisitor* visitor) const
 124 {
 125     for (auto& section : section_.subsections_)
 126     {
 127         visitor->visitSection(&section->info());
 128     }
 129 }
 130
 131 void OptionsModifyingIterator::acceptOptions(OptionsModifyingVisitor* visitor) const
 132 {
 133     acceptOptionsGroup(section_.rootGroup_, visitor);
 134 }
 135
 136 } // namespace gmx