src/gromacs/commandline/cmdlineinit.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 functions for initializing the \Gromacs library for command line use.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEINIT_H
  44 #define GMX_COMMANDLINE_CMDLINEINIT_H
  45
  46 #ifdef __cplusplus
  47
  48 // Forward declaration of class CommandLineProgramContext is not sufficient for
  49 // MSVC if the return value of initForCommandLine() is ignored(!)
  50 #include "gromacs/commandline/cmdlineprogramcontext.h"
  51
  52 namespace gmx
  53 {
  54
  55 class CommandLineModuleInterface;
  56 class CommandLineOptionsModuleInterface;
  57
  58 /*! \brief
  59  * Initializes the \Gromacs library for command-line use.
  60  *
  61  * \param[in] argc  argc value passed to main().
  62  * \param[in] argv  argv array passed to main().
  63  * \returns   Reference to initialized program context object.
  64  *
  65  * This function is tailored for use in command line applications.
  66  * For other usage, combination of gmx::init() and gmx::setProgramContext()
  67  * provides more flexible initialization alternatives.
  68  * Unlike gmx::init(), calls to this method cannot be nested.
  69  *
  70  * The command line arguments are communicated so that they can be
  71  * parsed on each processor.
  72  * \p argc and \p argv are passed to gmx::init(); see there for additional
  73  * discussion.  This method does not place any additional limitations, but
  74  * generally there should be no need to pass NULL values.
  75  *
  76  * Does not throw. Terminates the program on out-of-memory error.
  77  *
  78  * This method is not thread-safe, since it is intended to be the first method
  79  * called.  See setProgramContext() for additional discussion.
  80  *
  81  * \see gmx::init()
  82  * \see setProgramContext()
  83  * \ingroup module_commandline
  84  */
  85 CommandLineProgramContext &initForCommandLine(int *argc, char ***argv);
  86 /*! \brief
  87  * Deinitializes the \Gromacs library after initForCommandLine().
  88  *
  89  * Calls gmx::finalize() and additionally undoes the work done by
  90  * initForCommandLine().
  91  *
  92  * \see gmx::finalize()
  93  * \ingroup module_commandline
  94  */
  95 void finalizeForCommandLine();
  96 /*! \brief
  97  * Handles an exception and deinitializes after initForCommandLine.
  98  *
  99  * \param[in] ex  Exception that is the cause for terminating the program.
 100  * \returns   Return code to return from main().
 101  *
 102  * This method should be called as the last thing before terminating the
 103  * program because of an exception. See processExceptionAtExit() for details.
 104  * Additionally this method undoes the work done by initForCommandLine.
 105  *
 106  * Does not throw.
 107  */
 108 int processExceptionAtExitForCommandLine(const std::exception &ex);
 109 /*! \brief
 110  * Implements a main() method that runs a single module.
 111  *
 112  * \param argc   \c argc passed to main().
 113  * \param argv   \c argv passed to main().
 114  * \param module Module to run.
 115  *
 116  * This method allows for uniform behavior for binaries that only
 117  * contain a single module without duplicating any of the
 118  * implementation from CommandLineModuleManager (startup headers,
 119  * common options etc.).
 120  *
 121  * The signature assumes that \p module construction does not throw
 122  * (because otherwise the caller would need to duplicate all the
 123  * exception handling code).  It is possible to move the construction
 124  * inside the try/catch in this method using an indirection similar to
 125  * TrajectoryAnalysisCommandLineRunner::runAsMain(), but until that is
 126  * necessary, the current approach leads to simpler code.
 127  *
 128  * Usage:
 129  * \code
 130    int main(int argc, char *argv[])
 131    {
 132        CustomCommandLineModule module;
 133        return gmx::runCommandLineModule(argc, argv, &module);
 134    }
 135    \endcode
 136  *
 137  * Does not throw.  All exceptions are caught and handled internally.
 138  */
 139 int runCommandLineModule(int argc, char *argv[],
 140                          CommandLineModuleInterface *module);
 141 /*! \brief
 142  * Implements a main() method that runs a single module.
 143  *
 144  * \param     argc        \c argc passed to main().
 145  * \param     argv        \c argv passed to main().
 146  * \param[in] name        Name for the module.
 147  * \param[in] description Short description for the module.
 148  * \param     factory Factory method that creates the module to run.
 149  *
 150  * This method allows for uniform behavior for binaries that only
 151  * contain a single module without duplicating any of the
 152  * implementation from CommandLineModuleManager (startup headers,
 153  * common options etc.).
 154  *
 155  * Usage:
 156  * \code
 157    class CustomCommandLineOptionsModule : public CommandLineOptionsModuleInterface
 158    {
 159        // <...>
 160    };
 161
 162    static CommandLineOptionsModuleInterface *create()
 163    {
 164        return new CustomCommandLineOptionsModule();
 165    }
 166
 167    int main(int argc, char *argv[])
 168    {
 169        return gmx::runCommandLineModule(
 170                argc, argv, "mymodule", "short description", &create);
 171    }
 172    \endcode
 173  *
 174  * Does not throw.  All exceptions are caught and handled internally.
 175  */
 176 int runCommandLineModule(int argc, char *argv[],
 177                          const char *name, const char *description,
 178                          CommandLineOptionsModuleInterface *(*factory)());
 179
 180 } // namespace gmx
 181
 182 extern "C"
 183 {
 184 #endif
 185
 186 /*! \brief
 187  * Implements a main() method that runs a given C main function.
 188  *
 189  * \param argc         \c argc passed to main().
 190  * \param argv         \c argv passed to main().
 191  * \param mainFunction The main()-like method to wrap.
 192  *
 193  * This method creates a dummy command line module that does its
 194  * processing by calling \p mainFunction.  It then runs this module as with
 195  * gmx::runCommandLineModule().
 196  * This allows the resulting executable to handle common options and do
 197  * other common actions (e.g., startup headers) without duplicate code
 198  * in the main methods.
 199  *
 200  * \p mainFunction should call parse_common_args() to process its command-line
 201  * arguments.
 202  *
 203  * Usage:
 204  * \code
 205    int my_main(int argc, char *argv[])
 206    {
 207        // <...>
 208    }
 209
 210    int main(int argc, char *argv[])
 211    {
 212        return gmx_run_cmain(argc, argv, &my_main);
 213    }
 214    \endcode
 215  *
 216  * Does not throw.  All exceptions are caught and handled internally.
 217  */
 218 int gmx_run_cmain(int argc, char *argv[], int (*mainFunction)(int, char *[]));
 219
 220 #ifdef __cplusplus
 221 }
 222 #endif
 223
 224 #endif