src/gromacs/options/options-impl.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Declares private implementation class for gmx::Options.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_options
  37  */
  38 #ifndef GMX_OPTIONS_OPTIONS_IMPL_H
  39 #define GMX_OPTIONS_OPTIONS_IMPL_H
  40
  41 #include <string>
  42 #include <vector>
  43
  44 #include "gromacs/utility/uniqueptr.h"
  45
  46 #include "options.h"
  47
  48 namespace gmx
  49 {
  50
  51 class AbstractOptionStorage;
  52
  53 /*! \internal \brief
  54  * Private implementation class for Options.
  55  *
  56  * Note that in addition to Options, the OptionsAssigner and OptionsIterator
  57  * classes also directly access this class.
  58  *
  59  * \ingroup module_options
  60  */
  61 class Options::Impl
  62 {
  63     public:
  64         //! Shorthand for a smart pointer to an option storage object.
  65         typedef gmx_unique_ptr<AbstractOptionStorage>::type OptionPointer;
  66         //! Convenience type for list of sections.
  67         typedef std::vector<Options *> SubSectionList;
  68         //! Convenience type for list of options.
  69         typedef std::vector<OptionPointer> OptionList;
  70
  71         //! Sets the name and title.
  72         Impl(const char *name, const char *title);
  73         ~Impl();
  74
  75         /*! \brief
  76          * Finds a subsection by name.
  77          *
  78          * \param[in] name  Name to search for.
  79          * \returns Pointer to the found subsection, or NULL if not found.
  80          *
  81          * Does not throw.
  82          */
  83         Options *findSubSection(const char *name) const;
  84         /*! \brief
  85          * Finds an option by name.
  86          *
  87          * \param[in] name  Name to search for.
  88          * \returns Pointer to the found option, or NULL if not found.
  89          *
  90          * Does not throw.
  91          */
  92         AbstractOptionStorage *findOption(const char *name) const;
  93
  94         /*! \brief
  95          * Calls AbstractOptionStorage::startSource() for all options,
  96          * including subsections.
  97          *
  98          * Does not throw.
  99          */
 100         void startSource();
 101
 102         //! Name for the Options object.
 103         std::string             _name;
 104         //! Description title for the Options object.
 105         std::string             _title;
 106         //! Full description for the Options object.
 107         std::string             _description;
 108         /*! \brief
 109          * List of subsections, in insertion order.
 110          *
 111          * This container contains only references to external objects; memory
 112          * management is performed elsewhere.
 113          */
 114         SubSectionList          _subSections;
 115         /*! \brief
 116          * List of options, in insertion order.
 117          *
 118          * All objects in this container are owned by this object, and are
 119          * freed in the destructor.
 120          */
 121         OptionList              _options;
 122         //! Options object that contains this object as a subsection, or NULL.
 123         Options                *_parent;
 124 };
 125
 126 } // namespace gmx
 127
 128 #endif