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,2016,2018,2019, 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::CommandLineParser.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEPARSER_H
  44 #define GMX_COMMANDLINE_CMDLINEPARSER_H
  45
  46 #include <string>
  47 #include <vector>
  48
  49 #include "gromacs/utility/classhelpers.h"
  50
  51 namespace gmx
  52 {
  53
  54 class Options;
  55
  56 /*! \brief
  57  * Implements command-line parsing for Options objects.
  58  *
  59  * Typical usage (without error checking):
  60  * \code
  61    gmx::Options options("name", "description");
  62    // Fill up options
  63
  64    gmx::CommandLineParser(&options).parse(&argc, argv);
  65    options.finish();
  66  * \endcode
  67  *
  68  * \inpublicapi
  69  * \ingroup module_commandline
  70  */
  71 class CommandLineParser
  72 {
  73 public:
  74     /*! \brief
  75      * Creates a command-line parser that sets values for options.
  76      *
  77      * \param[in] options  Options object whose options should be set.
  78      * \throws  std::bad_alloc if out of memory.
  79      */
  80     explicit CommandLineParser(Options* options);
  81     ~CommandLineParser();
  82
  83     /*! \brief
  84      * Makes the parser skip unknown options and keep them in \c argv.
  85      *
  86      * \param[in] bEnabled  Whether to skip and keep unknown options.
  87      * \returns   *this
  88      *
  89      * Setting this option to true has dual effect: unknown options are
  90      * silently skipped, and all recognized options are removed from
  91      * \c argc and \c argv in parse().  These effects should be easy to
  92      * separate into different flags if there is need for it.
  93      *
  94      * The default is false: unknown options result in exceptions and
  95      * \c argc and \c argv are not modified.
  96      *
  97      * Does not throw.
  98      */
  99     CommandLineParser& skipUnknown(bool bEnabled);
 100
 101     /*! \brief
 102      * Makes the parser accept positional arguments
 103      *
 104      * \param[in] bEnabled  Whether to skip and keep positional arguments.
 105      * \returns   *this
 106      *
 107      * Arguments that are not options (ie. no leading hyphen), and
 108      * which come before all options are acceptable if this has
 109      * been enabled. If so, these arguments are left in \c argc
 110      * and \c argv in parse().
 111      *
 112      * The default is false: unknown leading arguments result in
 113      * exceptions and \c argc and \c argv are not modified.
 114      *
 115      * Does not throw.
 116      */
 117     CommandLineParser& allowPositionalArguments(bool bEnabled);
 118
 119     /*! \brief
 120      * Parses the command line.
 121      *
 122      * \throws  std::bad_alloc if out of memory.
 123      * \throws  InvalidInputError if any errors were detected in the input.
 124      *
 125      * All command-line arguments are parsed, and an aggregate
 126      * exception with all the detected errors (including unknown
 127      * options, where applicable) is thrown in the end.
 128      *
 129      * If skipUnknown() was not called, or last called with a
 130      * false value, the input arguments are not modified. If
 131      * skipUnknown() was last called with a true value, only
 132      * unknown options will be retained in \c argc and \c argv.
 133      *
 134      * All positional arguments are retained in the argument list,
 135      * but such arguments must precede all options.
 136      *
 137      * \c argv[0] is never modified.
 138      *
 139      */
 140     void parse(int* argc, char* argv[]);
 141
 142 private:
 143     class Impl;
 144
 145     PrivateImplPointer<Impl> impl_;
 146 };
 147
 148 } // namespace gmx
 149
 150 #endif