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,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.
   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 optionsvisitor.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "optionsvisitor.h"
  45
  46 #include "gromacs/options/abstractoptionstorage.h"
  47 #include "gromacs/options/options.h"
  48 #include "gromacs/options/optionsection.h"
  49
  50 #include "options-impl.h"
  51
  52 namespace gmx
  53 {
  54
  55 namespace
  56 {
  57
  58 //! Helper function to call visitOptions() and handle correct indirection.
  59 void visitOption(OptionsVisitor *visitor, OptionInfo &optionInfo) //NOLINT(google-runtime-references)
  60 {
  61     visitor->visitOption(optionInfo);
  62 }
  63 //! Helper function to call visitOptions() and handle correct indirection.
  64 void visitOption(OptionsModifyingVisitor *visitor, OptionInfo &optionInfo) //NOLINT(google-runtime-references)
  65 {
  66     visitor->visitOption(&optionInfo);
  67 }
  68
  69 //! Helper function to recursively visit all options in a group.
  70 template <class VisitorType>
  71 void acceptOptionsGroup(const internal::OptionSectionImpl::Group &group, VisitorType *visitor)
  72 {
  73     for (const auto &option : group.options_)
  74     {
  75         visitOption(visitor, option->optionInfo());
  76     }
  77     for (const auto &subgroup : group.subgroups_)
  78     {
  79         acceptOptionsGroup(subgroup, visitor);
  80     }
  81 }
  82
  83 }   // namespace
  84
  85 /********************************************************************
  86  * OptionsIterator
  87  */
  88
  89 OptionsIterator::OptionsIterator(const Options &options)
  90     : section_(options.rootSection().section())
  91 {
  92 }
  93
  94 OptionsIterator::OptionsIterator(const OptionSectionInfo &section)
  95     : section_(section.section())
  96 {
  97 }
  98
  99 void OptionsIterator::acceptSections(OptionsVisitor *visitor) const
 100 {
 101     for (const auto &section : section_.subsections_)
 102     {
 103         visitor->visitSection(section->info());
 104     }
 105 }
 106
 107 void OptionsIterator::acceptOptions(OptionsVisitor *visitor) const
 108 {
 109     acceptOptionsGroup(section_.rootGroup_, visitor);
 110 }
 111
 112 /********************************************************************
 113  * OptionsModifyingIterator
 114  */
 115
 116 OptionsModifyingIterator::OptionsModifyingIterator(Options *options)
 117     : section_(options->rootSection().section())
 118 {
 119 }
 120
 121 OptionsModifyingIterator::OptionsModifyingIterator(OptionSectionInfo *section)
 122     : section_(section->section())
 123 {
 124 }
 125
 126 void OptionsModifyingIterator::acceptSections(OptionsModifyingVisitor *visitor) const
 127 {
 128     for (auto &section : section_.subsections_)
 129     {
 130         visitor->visitSection(&section->info());
 131     }
 132 }
 133
 134 void OptionsModifyingIterator::acceptOptions(OptionsModifyingVisitor *visitor) const
 135 {
 136     acceptOptionsGroup(section_.rootGroup_, visitor);
 137 }
 138
 139 } // namespace gmx