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/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"
  57
  58 namespace gmx
  59 {
  60
  61 //! \addtogroup module_commandline
  62 //! \{
  63
  64 //! Container type for mapping module names to module objects.
  65 typedef std::map<std::string, CommandLineModulePointer> CommandLineModuleMap;
  66
  67 /*! \internal
  68  * \brief
  69  * Internal data for a CommandLineModuleManager module group.
  70  *
  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.
  74  */
  75 class CommandLineModuleGroupData
  76 {
  77     public:
  78         /*! \brief
  79          * Shorthand for a list of modules contained in the group.
  80          *
  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.
  84          */
  85         typedef std::vector<std::pair<std::string, const char *> > ModuleList;
  86
  87         /*! \brief
  88          * Constructs an empty module group.
  89          *
  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.
  94          *
  95          * Does not throw.
  96          */
  97         CommandLineModuleGroupData(const CommandLineModuleMap &modules,
  98                                    const char                 *binaryName,
  99                                    const char                 *title)
 100             : allModules_(modules), binaryName_(binaryName), title_(title)
 101         {
 102         }
 103
 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_; }
 108
 109         /*! \brief
 110          * Adds a module to the group.
 111          *
 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.
 115          *
 116          * If \p description is NULL, the description returned by the module is
 117          * used.
 118          */
 119         void addModule(const char *name, const char *description);
 120
 121     private:
 122         const CommandLineModuleMap &allModules_;
 123         const char                 *binaryName_;
 124         const char                 *title_;
 125         ModuleList                  modules_;
 126
 127         GMX_DISALLOW_COPY_AND_ASSIGN(CommandLineModuleGroupData);
 128 };
 129
 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;
 136
 137 /*! \internal
 138  * \brief
 139  * Encapsulates some handling of common options to the wrapper binary.
 140  */
 141 class CommandLineCommonOptionsHolder
 142 {
 143     public:
 144         CommandLineCommonOptionsHolder();
 145         ~CommandLineCommonOptionsHolder();
 146
 147         //! Initializes the common options.
 148         void initOptions();
 149         /*! \brief
 150          * Finishes option parsing.
 151          *
 152          * \returns `false` if the wrapper binary should quit without executing
 153          *     any module.
 154          */
 155         bool finishOptions();
 156
 157         //! Returns the internal Options object.
 158         Options *options() { return &options_; }
 159         //! Returns the settings for printing startup information.
 160         const BinaryInformationSettings &binaryInfoSettings() const
 161         {
 162             return binaryInfoSettings_;
 163         }
 164
 165         /*! \brief
 166          * Returns `true` if common options are set such that the wrapper
 167          * binary should quit, without running the actual module.
 168          */
 169         bool shouldIgnoreActualModule() const
 170         {
 171             return bHelp_ || bVersion_;
 172         }
 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
 179         {
 180             return bQuiet_ && !bVersion_;
 181         }
 182
 183         //! Returns the debug level.
 184         int debugLevel() const { return debugLevel_; }
 185
 186         //! Returns the file to which startup information should be printed.
 187         FILE *startupInfoFile() const { return (bVersion_ ? stdout : stderr); }
 188
 189     private:
 190         Options                      options_;
 191         //! Settings for what to write in the startup header.
 192         BinaryInformationSettings    binaryInfoSettings_;
 193         bool                         bHelp_;
 194         bool                         bHidden_;
 195         bool                         bQuiet_;
 196         bool                         bVersion_;
 197         bool                         bCopyright_;
 198         int                          debugLevel_;
 199
 200         GMX_DISALLOW_COPY_AND_ASSIGN(CommandLineCommonOptionsHolder);
 201 };
 202
 203 //! \}
 204
 205 } // namespace gmx
 206
 207 #endif