src/gromacs/options/filenameoptionmanager.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, 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 gmx::FileNameOptionManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #include "filenameoptionmanager.h"
  43
  44 #include <string>
  45
  46 #include "gromacs/options/basicoptions.h"
  47 #include "gromacs/options/filenameoption.h"
  48 #include "gromacs/options/options.h"
  49 #include "gromacs/options/optionsvisitor.h"
  50
  51 namespace gmx
  52 {
  53
  54 /********************************************************************
  55  * FileNameOptionManager::Impl
  56  */
  57
  58 /*! \internal \brief
  59  * Private implemention class for FileNameOptionManager.
  60  *
  61  * \ingroup module_options
  62  */
  63 class FileNameOptionManager::Impl
  64 {
  65     public:
  66         //! Global default file name, if set.
  67         std::string     defaultFileName_;
  68 };
  69
  70 /********************************************************************
  71  * FileNameOptionManager
  72  */
  73
  74 FileNameOptionManager::FileNameOptionManager()
  75     : impl_(new Impl())
  76 {
  77 }
  78
  79 FileNameOptionManager::~FileNameOptionManager()
  80 {
  81 }
  82
  83 void FileNameOptionManager::addDefaultFileNameOption(
  84         Options *options, const char *name)
  85 {
  86     options->addOption(
  87             StringOption(name).store(&impl_->defaultFileName_)
  88                 .description("Set the default filename for all file options"));
  89 }
  90
  91 const std::string &FileNameOptionManager::defaultFileName() const
  92 {
  93     return impl_->defaultFileName_;
  94 }
  95
  96 /********************************************************************
  97  * Global functions
  98  */
  99
 100 namespace
 101 {
 102
 103 /*! \internal \brief
 104  * Visitor that sets the manager for each file name option.
 105  *
 106  * \ingroup module_options
 107  */
 108 class FileNameOptionManagerSetter : public OptionsModifyingVisitor
 109 {
 110     public:
 111         //! Construct a visitor that sets given manager.
 112         explicit FileNameOptionManagerSetter(FileNameOptionManager *manager)
 113             : manager_(manager)
 114         {
 115         }
 116
 117         void visitSubSection(Options *section)
 118         {
 119             OptionsModifyingIterator iterator(section);
 120             iterator.acceptSubSections(this);
 121             iterator.acceptOptions(this);
 122         }
 123
 124         void visitOption(OptionInfo *option)
 125         {
 126             FileNameOptionInfo *fileOption
 127                 = option->toType<FileNameOptionInfo>();
 128             if (fileOption != NULL)
 129             {
 130                 fileOption->setManager(manager_);
 131             }
 132         }
 133
 134     private:
 135         FileNameOptionManager *manager_;
 136 };
 137
 138 }   // namespace
 139
 140 void setManagerForFileNameOptions(Options               *options,
 141                                   FileNameOptionManager *manager)
 142 {
 143     FileNameOptionManagerSetter(manager).visitSubSection(options);
 144 }
 145
 146 } // namespace gmx