src/gromacs/commandline/cmdlineparser.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014 by the GROMACS development team.
   5  * Copyright (c) 2016,2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \file
  37  * \brief
  38  * Declares gmx::CommandLineParser.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \inpublicapi
  42  * \ingroup module_commandline
  43  */
  44 #ifndef GMX_COMMANDLINE_CMDLINEPARSER_H
  45 #define GMX_COMMANDLINE_CMDLINEPARSER_H
  46
  47 #include <string>
  48 #include <vector>
  49
  50 #include "gromacs/utility/classhelpers.h"
  51
  52 namespace gmx
  53 {
  54
  55 class Options;
  56
  57 /*! \brief
  58  * Implements command-line parsing for Options objects.
  59  *
  60  * Typical usage (without error checking):
  61  * \code
  62    gmx::Options options("name", "description");
  63    // Fill up options
  64
  65    gmx::CommandLineParser(&options).parse(&argc, argv);
  66    options.finish();
  67  * \endcode
  68  *
  69  * \inpublicapi
  70  * \ingroup module_commandline
  71  */
  72 class CommandLineParser
  73 {
  74 public:
  75     /*! \brief
  76      * Creates a command-line parser that sets values for options.
  77      *
  78      * \param[in] options  Options object whose options should be set.
  79      * \throws  std::bad_alloc if out of memory.
  80      */
  81     explicit CommandLineParser(Options* options);
  82     ~CommandLineParser();
  83
  84     /*! \brief
  85      * Makes the parser skip unknown options and keep them in \c argv.
  86      *
  87      * \param[in] bEnabled  Whether to skip and keep unknown options.
  88      * \returns   *this
  89      *
  90      * Setting this option to true has dual effect: unknown options are
  91      * silently skipped, and all recognized options are removed from
  92      * \c argc and \c argv in parse().  These effects should be easy to
  93      * separate into different flags if there is need for it.
  94      *
  95      * The default is false: unknown options result in exceptions and
  96      * \c argc and \c argv are not modified.
  97      *
  98      * Does not throw.
  99      */
 100     CommandLineParser& skipUnknown(bool bEnabled);
 101
 102     /*! \brief
 103      * Makes the parser accept positional arguments
 104      *
 105      * \param[in] bEnabled  Whether to skip and keep positional arguments.
 106      * \returns   *this
 107      *
 108      * Arguments that are not options (ie. no leading hyphen), and
 109      * which come before all options are acceptable if this has
 110      * been enabled. If so, these arguments are left in \c argc
 111      * and \c argv in parse().
 112      *
 113      * The default is false: unknown leading arguments result in
 114      * exceptions and \c argc and \c argv are not modified.
 115      *
 116      * Does not throw.
 117      */
 118     CommandLineParser& allowPositionalArguments(bool bEnabled);
 119
 120     /*! \brief
 121      * Parses the command line.
 122      *
 123      * \throws  std::bad_alloc if out of memory.
 124      * \throws  InvalidInputError if any errors were detected in the input.
 125      *
 126      * All command-line arguments are parsed, and an aggregate
 127      * exception with all the detected errors (including unknown
 128      * options, where applicable) is thrown in the end.
 129      *
 130      * If skipUnknown() was not called, or last called with a
 131      * false value, the input arguments are not modified. If
 132      * skipUnknown() was last called with a true value, only
 133      * unknown options will be retained in \c argc and \c argv.
 134      *
 135      * All positional arguments are retained in the argument list,
 136      * but such arguments must precede all options.
 137      *
 138      * \c argv[0] is never modified.
 139      *
 140      */
 141     void parse(int* argc, char* argv[]);
 142
 143 private:
 144     class Impl;
 145
 146     PrivateImplPointer<Impl> impl_;
 147 };
 148
 149 } // namespace gmx
 150
 151 #endif