src/gromacs/options/options.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,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 gmx::Options.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "options.h"
  45
  46 #include "gromacs/options/abstractoption.h"
  47 #include "gromacs/options/abstractoptionstorage.h"
  48 #include "gromacs/utility/arrayref.h"
  49 #include "gromacs/utility/exceptions.h"
  50 #include "gromacs/utility/gmxassert.h"
  51 #include "gromacs/utility/stringutil.h"
  52
  53 #include "options-impl.h"
  54
  55 namespace gmx
  56 {
  57
  58 /********************************************************************
  59  * IOptionManager
  60  */
  61
  62 IOptionManager::~IOptionManager()
  63 {
  64 }
  65
  66 /********************************************************************
  67  * Options::Impl
  68  */
  69
  70 Options::Impl::Impl(const char *name, const char *title)
  71     : name_(name != NULL ? name : ""), title_(title != NULL ? title : ""),
  72       parent_(NULL)
  73 {
  74 }
  75
  76 Options::Impl::~Impl()
  77 {
  78 }
  79
  80 Options *Options::Impl::findSubSection(const char *name) const
  81 {
  82     SubSectionList::const_iterator i;
  83     for (i = subSections_.begin(); i != subSections_.end(); ++i)
  84     {
  85         if ((*i)->name() == name)
  86         {
  87             return *i;
  88         }
  89     }
  90     return NULL;
  91 }
  92
  93 AbstractOptionStorage *Options::Impl::findOption(const char *name) const
  94 {
  95     OptionList::const_iterator i;
  96     for (i = options_.begin(); i != options_.end(); ++i)
  97     {
  98         if ((*i)->name() == name)
  99         {
 100             return i->get();
 101         }
 102     }
 103     return NULL;
 104 }
 105
 106 void Options::Impl::startSource()
 107 {
 108     OptionList::const_iterator i;
 109     for (i = options_.begin(); i != options_.end(); ++i)
 110     {
 111         AbstractOptionStorage &option = **i;
 112         option.startSource();
 113     }
 114     SubSectionList::const_iterator j;
 115     for (j = subSections_.begin(); j != subSections_.end(); ++j)
 116     {
 117         Options &section = **j;
 118         section.impl_->startSource();
 119     }
 120 }
 121
 122 /********************************************************************
 123  * Options
 124  */
 125
 126 Options::Options(const char *name, const char *title)
 127     : impl_(new Impl(name, title))
 128 {
 129 }
 130
 131 Options::~Options()
 132 {
 133 }
 134
 135 const std::string &Options::name() const
 136 {
 137     return impl_->name_;
 138 }
 139
 140 const std::string &Options::title() const
 141 {
 142     return impl_->title_;
 143 }
 144
 145 const std::string &Options::description() const
 146 {
 147     return impl_->description_;
 148 }
 149
 150 void Options::setDescription(const std::string &desc)
 151 {
 152     impl_->description_ = desc;
 153 }
 154
 155 void Options::setDescription(const ConstArrayRef<const char *> &descArray)
 156 {
 157     impl_->description_ = joinStrings(descArray, "\n");
 158 }
 159
 160 void Options::addManager(IOptionManager *manager)
 161 {
 162     GMX_RELEASE_ASSERT(impl_->parent_ == NULL,
 163                        "Can only add a manager in a top-level Options object");
 164     // This ensures that all options see the same set of managers.
 165     GMX_RELEASE_ASSERT(impl_->options_.empty(),
 166                        "Can only add a manager before options");
 167     // This check could be relaxed if we instead checked that the subsections
 168     // do not have options.
 169     GMX_RELEASE_ASSERT(impl_->subSections_.empty(),
 170                        "Can only add a manager before subsections");
 171     impl_->managers_.add(manager);
 172 }
 173
 174 void Options::addSubSection(Options *section)
 175 {
 176     // This is required, because managers are used from the root Options
 177     // object, so they are only seen after the subsection has been added.
 178     GMX_RELEASE_ASSERT(section->impl_->options_.empty(),
 179                        "Can only add a subsection before it has any options");
 180     GMX_RELEASE_ASSERT(section->impl_->managers_.empty(),
 181                        "Can only have managers in a top-level Options object");
 182     // Make sure that section is not already inserted somewhere.
 183     GMX_RELEASE_ASSERT(section->impl_->parent_ == NULL,
 184                        "Cannot add as subsection twice");
 185     // Make sure that there are no duplicate sections.
 186     GMX_RELEASE_ASSERT(impl_->findSubSection(section->name().c_str()) == NULL,
 187                        "Duplicate subsection name");
 188     impl_->subSections_.push_back(section);
 189     section->impl_->parent_ = this;
 190 }
 191
 192 OptionInfo *Options::addOption(const AbstractOption &settings)
 193 {
 194     Options::Impl *root = impl_.get();
 195     while (root->parent_ != NULL)
 196     {
 197         root = root->parent_->impl_.get();
 198     }
 199     Impl::AbstractOptionStoragePointer option(settings.createStorage(root->managers_));
 200     if (impl_->findOption(option->name().c_str()) != NULL)
 201     {
 202         GMX_THROW(APIError("Duplicate option: " + option->name()));
 203     }
 204     impl_->options_.push_back(move(option));
 205     return &impl_->options_.back()->optionInfo();
 206 }
 207
 208 bool Options::isSet(const char *name) const
 209 {
 210     AbstractOptionStorage *option = impl_->findOption(name);
 211     return (option != NULL ? option->isSet() : false);
 212 }
 213
 214 void Options::finish()
 215 {
 216     // TODO: Consider how to customize these error messages based on context.
 217     ExceptionInitializer             errors("Invalid input values");
 218     Impl::OptionList::const_iterator i;
 219     for (i = impl_->options_.begin(); i != impl_->options_.end(); ++i)
 220     {
 221         AbstractOptionStorage &option = **i;
 222         try
 223         {
 224             option.finish();
 225         }
 226         catch (UserInputError &ex)
 227         {
 228             ex.prependContext("In option " + option.name());
 229             errors.addCurrentExceptionAsNested();
 230         }
 231     }
 232     Impl::SubSectionList::const_iterator j;
 233     for (j = impl_->subSections_.begin(); j != impl_->subSections_.end(); ++j)
 234     {
 235         Options &section = **j;
 236         try
 237         {
 238             section.finish();
 239         }
 240         catch (const UserInputError &)
 241         {
 242             errors.addCurrentExceptionAsNested();
 243         }
 244     }
 245     if (errors.hasNestedExceptions())
 246     {
 247         // TODO: This exception type may not always be appropriate.
 248         GMX_THROW(InvalidInputError(errors));
 249     }
 250 }
 251
 252 } // namespace gmx