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,2015,2019,2021, 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 <memory>
  47 #include <string>
  48 #include <vector>
  49
  50 #include "gromacs/commandline/cmdlinemodule.h"
  51 #include "gromacs/commandline/cmdlinemodulemanager.h"
  52 #include "gromacs/options/options.h"
  53 #include "gromacs/utility/binaryinformation.h"
  54 #include "gromacs/utility/classhelpers.h"
  55 #include "gromacs/utility/gmxassert.h"
  56
  57 namespace gmx
  58 {
  59
  60 //! \addtogroup module_commandline
  61 //! \{
  62
  63 //! Container type for mapping module names to module objects.
  64 typedef std::map<std::string, CommandLineModulePointer> CommandLineModuleMap;
  65
  66 /*! \internal
  67  * \brief
  68  * Internal data for a CommandLineModuleManager module group.
  69  *
  70  * This class contains the state of a module group.  CommandLineModuleGroup
  71  * provides the public interface to construct/alter the state, and
  72  * CommandLineModuleManager and its associated classes use it for help output.
  73  */
  74 class CommandLineModuleGroupData
  75 {
  76 public:
  77     /*! \brief
  78      * Shorthand for a list of modules contained in the group.
  79      *
  80      * The first element in the contained pair contains the tag
  81      * (gmx-something) of the module, and the second element contains the
  82      * description.  The second element is never NULL.
  83      */
  84     typedef std::vector<std::pair<std::string, const char*>> ModuleList;
  85
  86     /*! \brief
  87      * Constructs an empty module group.
  88      *
  89      * \param[in] modules     List of all modules
  90      *     (used for checking and default descriptions).
  91      * \param[in] binaryName  Name of the binary containing the modules.
  92      * \param[in] title       Title of the group.
  93      *
  94      * Does not throw.
  95      */
  96     CommandLineModuleGroupData(const CommandLineModuleMap& modules, const char* binaryName, const char* title) :
  97         allModules_(modules), binaryName_(binaryName), title_(title)
  98     {
  99     }
 100
 101     //! Returns the title for the group.
 102     const char* title() const { return title_; }
 103     //! Returns the list of modules in the group.
 104     const ModuleList& modules() const { return modules_; }
 105
 106     /*! \brief
 107      * Adds a module to the group.
 108      *
 109      * \param[in] name        Name of the module.
 110      * \param[in] description Description of the module in this group.
 111      * \throws    std::bad_alloc if out of memory.
 112      *
 113      * If \p description is NULL, the description returned by the module is
 114      * used.
 115      */
 116     void addModule(const char* name, const char* description);
 117
 118 private:
 119     const CommandLineModuleMap& allModules_;
 120     const char*                 binaryName_;
 121     const char*                 title_;
 122     ModuleList                  modules_;
 123
 124     GMX_DISALLOW_COPY_AND_ASSIGN(CommandLineModuleGroupData);
 125 };
 126
 127 //! Smart pointer type for managing a CommandLineModuleGroup.
 128 typedef std::unique_ptr<CommandLineModuleGroupData> CommandLineModuleGroupDataPointer;
 129 //! Container type for keeping a list of module groups.
 130 typedef std::vector<CommandLineModuleGroupDataPointer> CommandLineModuleGroupList;
 131
 132 /*! \internal
 133  * \brief
 134  * Encapsulates some handling of common options to the wrapper binary.
 135  */
 136 class CommandLineCommonOptionsHolder
 137 {
 138 public:
 139     CommandLineCommonOptionsHolder();
 140     ~CommandLineCommonOptionsHolder();
 141
 142     //! Initializes the common options.
 143     void initOptions();
 144     /*! \brief
 145      * Finishes option parsing.
 146      *
 147      * \returns `false` if the wrapper binary should quit without executing
 148      *     any module.
 149      */
 150     bool finishOptions();
 151
 152     //! Adjust defaults based on module settings.
 153     void adjustFromSettings(const CommandLineModuleSettings& settings);
 154
 155     //! Returns the internal Options object.
 156     Options* options() { return &options_; }
 157     //! Returns the settings for printing startup information.
 158     const BinaryInformationSettings& binaryInfoSettings() const { return binaryInfoSettings_; }
 159
 160     /*! \brief
 161      * Returns `true` if common options are set such that the wrapper
 162      * binary should quit, without running the actual module.
 163      */
 164     bool shouldIgnoreActualModule() const { return bHelp_ || bVersion_; }
 165     //! Returns whether common options specify showing help.
 166     bool shouldShowHelp() const { return bHelp_; }
 167     //! Returns whether common options specify showing hidden options in help.
 168     bool shouldShowHidden() const { return bHidden_; }
 169     //! Returns whether common options specify quiet execution.
 170     bool shouldBeQuiet() const { return bQuiet_ && !bVersion_; }
 171     //! Returns whether backups should be made.
 172     bool shouldBackup() const { return bBackup_; }
 173
 174     //! Returns the nice level.
 175     int niceLevel() const { return niceLevel_; }
 176     //! Returns whether floating-point exception should be enabled
 177     bool enableFPExceptions() const { return bFpexcept_; }
 178     //! Returns the debug level.
 179     int debugLevel() const { return debugLevel_; }
 180
 181     //! Returns the file to which startup information should be printed.
 182     FILE* startupInfoFile() const { return (bVersion_ ? stdout : stderr); }
 183
 184 private:
 185     Options options_;
 186     //! Settings for what to write in the startup header.
 187     BinaryInformationSettings binaryInfoSettings_;
 188     bool                      bHelp_;
 189     bool                      bHidden_;
 190     bool                      bQuiet_;
 191     bool                      bVersion_;
 192     bool                      bCopyright_;
 193     int                       niceLevel_;
 194     bool                      bNiceSet_;
 195     bool                      bBackup_;
 196     bool                      bFpexcept_;
 197     int                       debugLevel_;
 198
 199     GMX_DISALLOW_COPY_AND_ASSIGN(CommandLineCommonOptionsHolder);
 200 };
 201
 202 //! \}
 203
 204 } // namespace gmx
 205
 206 #endif