2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * directory and at http://www.gromacs.org.
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.
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.
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.
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.
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.
37 * Declares gmx::CommandLineParser.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_commandline
43 #ifndef GMX_COMMANDLINE_CMDLINEPARSER_H
44 #define GMX_COMMANDLINE_CMDLINEPARSER_H
49 #include "../utility/common.h"
57 * Implements command-line parsing for Options objects.
59 * Typical usage (without error checking):
61 gmx::Options options("name", "description");
64 gmx::CommandLineParser(&options).parse(&argc, argv);
69 * \ingroup module_commandline
71 class CommandLineParser
75 * Creates a command-line parser that sets values for options.
77 * \param[in] options Options object whose options should be set.
78 * \throws std::bad_alloc if out of memory.
80 CommandLineParser(Options *options);
84 * Makes the parser skip unknown options and keep them in \c argv.
86 * \param[in] bEnabled Whether to skip and keep unknown options.
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.
94 * The default is false: unknown options result in exceptions and
95 * \c argc and \c argv are not modified.
99 CommandLineParser &skipUnknown(bool bEnabled);
102 * Parses the command line.
104 * \throws std::bad_alloc if out of memory.
105 * \throws InvalidInputError if any errors were detected in the input.
107 * All command-line arguments are parsed, and an aggregate exception
108 * with all the detected errors is thrown in the end.
110 * If skipUnknown() is false, the input parameters are not modified.
111 * If skipUnknown() is true, recognized options and their values are
112 * removed from the argument list. \c argv[0] is never modified.
114 void parse(int *argc, char *argv[]);
119 PrivateImplPointer<Impl> impl_;