2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 * Declares implementation types for gmx::CommandLineModuleManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_commandline
42 #ifndef GMX_COMMANDLINE_CMDLINEMODULEMANAGER_IMPL_H
43 #define GMX_COMMANDLINE_CMDLINEMODULEMANAGER_IMPL_H
49 #include "cmdlinemodule.h"
50 #include "cmdlinemodulemanager.h"
52 #include "gromacs/legacyheaders/copyrite.h"
53 #include "gromacs/options/options.h"
54 #include "gromacs/utility/common.h"
55 #include "gromacs/utility/gmxassert.h"
56 #include "gromacs/utility/uniqueptr.h"
61 //! \addtogroup module_commandline
64 //! Container type for mapping module names to module objects.
65 typedef std::map<std::string, CommandLineModulePointer> CommandLineModuleMap;
69 * Internal data for a CommandLineModuleManager module group.
71 * This class contains the state of a module group. CommandLineModuleGroup
72 * provides the public interface to construct/alter the state, and
73 * CommandLineModuleManager and its associated classes use it for help output.
75 class CommandLineModuleGroupData
79 * Shorthand for a list of modules contained in the group.
81 * The first element in the contained pair contains the tag
82 * (gmx-something) of the module, and the second element contains the
83 * description. The second element is never NULL.
85 typedef std::vector<std::pair<std::string, const char *> > ModuleList;
88 * Constructs an empty module group.
90 * \param[in] modules List of all modules
91 * (used for checking and default descriptions).
92 * \param[in] binaryName Name of the binary containing the modules.
93 * \param[in] title Title of the group.
97 CommandLineModuleGroupData(const CommandLineModuleMap &modules,
98 const char *binaryName,
100 : allModules_(modules), binaryName_(binaryName), title_(title)
104 //! Returns the title for the group.
105 const char *title() const { return title_; }
106 //! Returns the list of modules in the group.
107 const ModuleList &modules() const { return modules_; }
110 * Adds a module to the group.
112 * \param[in] name Name of the module.
113 * \param[in] description Description of the module in this group.
114 * \throws std::bad_alloc if out of memory.
116 * If \p description is NULL, the description returned by the module is
119 void addModule(const char *name, const char *description);
122 const CommandLineModuleMap &allModules_;
123 const char *binaryName_;
127 GMX_DISALLOW_COPY_AND_ASSIGN(CommandLineModuleGroupData);
130 //! Smart pointer type for managing a CommandLineModuleGroup.
131 typedef gmx_unique_ptr<CommandLineModuleGroupData>::type
132 CommandLineModuleGroupDataPointer;
133 //! Container type for keeping a list of module groups.
134 typedef std::vector<CommandLineModuleGroupDataPointer>
135 CommandLineModuleGroupList;
139 * Encapsulates some handling of common options to the wrapper binary.
141 class CommandLineCommonOptionsHolder
144 CommandLineCommonOptionsHolder();
145 ~CommandLineCommonOptionsHolder();
147 //! Initializes the common options.
150 * Finishes option parsing.
152 * \returns `false` if the wrapper binary should quit without executing
155 bool finishOptions();
157 //! Returns the internal Options object.
158 Options *options() { return &options_; }
159 //! Returns the settings for printing startup information.
160 const BinaryInformationSettings &binaryInfoSettings() const
162 return binaryInfoSettings_;
166 * Returns `true` if common options are set such that the wrapper
167 * binary should quit, without running the actual module.
169 bool shouldIgnoreActualModule() const
171 return bHelp_ || bVersion_;
173 //! Returns whether common options specify showing help.
174 bool shouldShowHelp() const { return bHelp_; }
175 //! Returns whether common options specify showing hidden options in help.
176 bool shouldShowHidden() const { return bHidden_; }
177 //! Returns whether common options specify quiet execution.
178 bool shouldBeQuiet() const
180 return bQuiet_ && !bVersion_;
183 //! Returns the file to which startup information should be printed.
184 FILE *startupInfoFile() const { return (bVersion_ ? stdout : stderr); }
188 //! Settings for what to write in the startup header.
189 BinaryInformationSettings binaryInfoSettings_;
196 GMX_DISALLOW_COPY_AND_ASSIGN(CommandLineCommonOptionsHolder);