src/gromacs/commandline/cmdlinemodulemanager-impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,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  * Declares implementation types for gmx::CommandLineModuleManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_commandline
  41  */
  42 #ifndef GMX_COMMANDLINE_CMDLINEMODULEMANAGER_IMPL_H
  43 #define GMX_COMMANDLINE_CMDLINEMODULEMANAGER_IMPL_H
  44
  45 #include <map>
  46 #include <string>
  47 #include <vector>
  48
  49 #include "cmdlinemodule.h"
  50 #include "cmdlinemodulemanager.h"
  51
  52 #include "gromacs/utility/common.h"
  53 #include "gromacs/utility/gmxassert.h"
  54 #include "gromacs/utility/uniqueptr.h"
  55
  56 namespace gmx
  57 {
  58 //! Container type for mapping module names to module objects.
  59 typedef std::map<std::string, CommandLineModulePointer> CommandLineModuleMap;
  60
  61 /*! \internal
  62  * \brief
  63  * Internal data for a CommandLineModuleManager module group.
  64  *
  65  * This class contains the state of a module group.  CommandLineModuleGroup
  66  * provides the public interface to construct/alter the state, and
  67  * CommandLineModuleManager and its associated classes use it for help output.
  68  *
  69  * \ingroup module_commandline
  70  */
  71 class CommandLineModuleGroupData
  72 {
  73     public:
  74         /*! \brief
  75          * Shorthand for a list of modules contained in the group.
  76          *
  77          * The first element in the contained pair contains the tag
  78          * (gmx-something) of the module, and the second element contains the
  79          * description.  The second element is never NULL.
  80          */
  81         typedef std::vector<std::pair<std::string, const char *> > ModuleList;
  82
  83         /*! \brief
  84          * Constructs an empty module group.
  85          *
  86          * \param[in] modules  List of all modules
  87          *     (used for checking and default descriptions).
  88          * \param[in] title    Title of the group.
  89          *
  90          * Does not throw.
  91          */
  92         CommandLineModuleGroupData(const CommandLineModuleMap &modules,
  93                                    const char                 *title)
  94             : allModules_(modules), title_(title)
  95         {
  96         }
  97
  98         //! Returns the title for the group.
  99         const char *title() const { return title_; }
 100         //! Returns the list of modules in the group.
 101         const ModuleList &modules() const { return modules_; }
 102
 103         /*! \brief
 104          * Adds a module to the group.
 105          *
 106          * \param[in] name        Name of the module.
 107          * \param[in] description Description of the module in this group.
 108          * \throws    std::bad_alloc if out of memory.
 109          *
 110          * If \p description is NULL, the description returned by the module is
 111          * used.
 112          */
 113         void addModule(const char *name, const char *description);
 114
 115     private:
 116         const CommandLineModuleMap &allModules_;
 117         const char                 *title_;
 118         ModuleList                  modules_;
 119
 120         GMX_DISALLOW_COPY_AND_ASSIGN(CommandLineModuleGroupData);
 121 };
 122
 123 //! Smart pointer type for managing a CommandLineModuleGroup.
 124 typedef gmx_unique_ptr<CommandLineModuleGroupData>::type
 125     CommandLineModuleGroupDataPointer;
 126 //! Container type for keeping a list of module groups.
 127 typedef std::vector<CommandLineModuleGroupDataPointer>
 128     CommandLineModuleGroupList;
 129
 130 } // namespace gmx
 131
 132 #endif