src/gromacs/commandline/cmdlinemodule.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 /*! \file
  36  * \brief
  37  * Declares gmx::CommandLineModuleInterface.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEMODULE_H
  44 #define GMX_COMMANDLINE_CMDLINEMODULE_H
  45
  46 namespace gmx
  47 {
  48
  49 class CommandLineHelpContext;
  50
  51 /*! \brief
  52  * Module that can be run from command line using CommandLineModuleManager.
  53  *
  54  * \see CommandLineModuleManager
  55  *
  56  * \inpublicapi
  57  * \ingroup module_commandline
  58  */
  59 class CommandLineModuleInterface
  60 {
  61     public:
  62         virtual ~CommandLineModuleInterface() {}
  63
  64         //! Returns the name of the module.
  65         virtual const char *name() const = 0;
  66         //! Returns a one-line description of the module.
  67         virtual const char *shortDescription() const = 0;
  68
  69         /*! \brief
  70          * Runs the module with the given arguments.
  71          *
  72          * \param[in] argc  Number of elements in \p argv.
  73          * \param[in] argv  Command-line arguments.
  74          * \throws   unspecified  May throw exceptions to indicate errors.
  75          * \returns  Exit code for the program.
  76          * \retval   0 on successful termination.
  77          *
  78          * \p argv[0] is the name of the module, i.e., the arguments are as if
  79          * the module was run as a standalone executable.
  80          */
  81         virtual int run(int argc, char *argv[]) = 0;
  82         /*! \brief
  83          * Prints help for the module.
  84          *
  85          * \param[in] context  Context object for writing the help.
  86          * \throws    std::bad_alloc if out of memory.
  87          * \throws    FileIOError on any I/O error.
  88          *
  89          * Note that for MPI-enabled builds, this is called only on the master
  90          * rank.
  91          */
  92         virtual void writeHelp(const CommandLineHelpContext &context) const = 0;
  93 };
  94
  95 } // namespace gmx
  96
  97 #endif