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, 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
  49 #include "options-impl.h"
  50
  51 namespace gmx
  52 {
  53
  54 using internal::OptionsImpl;
  55
  56 namespace
  57 {
  58
  59 //! Helper function to call visitOptions() and handle correct indirection.
  60 void visitOption(OptionsVisitor *visitor, OptionInfo &optionInfo)
  61 {
  62     visitor->visitOption(optionInfo);
  63 }
  64 //! Helper function to call visitOptions() and handle correct indirection.
  65 void visitOption(OptionsModifyingVisitor *visitor, OptionInfo &optionInfo)
  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 OptionsImpl::Group &group, VisitorType *visitor)
  73 {
  74     OptionsImpl::Group::OptionList::const_iterator option;
  75     for (option = group.options_.begin(); option != group.options_.end(); ++option)
  76     {
  77         visitOption(visitor, (*option)->optionInfo());
  78     }
  79     OptionsImpl::Group::SubgroupList::const_iterator subgroup;
  80     for (subgroup = group.subgroups_.begin(); subgroup != group.subgroups_.end(); ++subgroup)
  81     {
  82         acceptOptionsGroup(*subgroup, visitor);
  83     }
  84 }
  85
  86 }   // namespace
  87
  88 /********************************************************************
  89  * OptionsIterator
  90  */
  91
  92 OptionsIterator::OptionsIterator(const Options &options)
  93     : options_(options)
  94 {
  95 }
  96
  97 void OptionsIterator::acceptSubSections(OptionsVisitor *visitor) const
  98 {
  99     const OptionsImpl::SubSectionList          &subSectionList =
 100         options_.impl_->subSections_;
 101     OptionsImpl::SubSectionList::const_iterator i;
 102     for (i = subSectionList.begin(); i != subSectionList.end(); ++i)
 103     {
 104         visitor->visitSubSection(*(*i));
 105     }
 106 }
 107
 108 void OptionsIterator::acceptOptions(OptionsVisitor *visitor) const
 109 {
 110     acceptOptionsGroup(options_.impl_->rootGroup_, visitor);
 111 }
 112
 113 /********************************************************************
 114  * OptionsModifyingIterator
 115  */
 116
 117 OptionsModifyingIterator::OptionsModifyingIterator(Options *options)
 118     : options_(*options)
 119 {
 120 }
 121
 122 void OptionsModifyingIterator::acceptSubSections(OptionsModifyingVisitor *visitor) const
 123 {
 124     const OptionsImpl::SubSectionList          &subSectionList =
 125         options_.impl_->subSections_;
 126     OptionsImpl::SubSectionList::const_iterator i;
 127     for (i = subSectionList.begin(); i != subSectionList.end(); ++i)
 128     {
 129         visitor->visitSubSection(*i);
 130     }
 131 }
 132
 133 void OptionsModifyingIterator::acceptOptions(OptionsModifyingVisitor *visitor) const
 134 {
 135     acceptOptionsGroup(options_.impl_->rootGroup_, visitor);
 136 }
 137
 138 } // namespace gmx