/*
* This file is part of the GROMACS molecular simulation package.
*
- * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
- * David van der Spoel, Berk Hess, Erik Lindahl, and including many
- * others, as listed in the AUTHORS file in the top-level source
- * directory and at http://www.gromacs.org.
+ * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
* GROMACS is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
#include <string>
#include <vector>
-#include "../utility/common.h"
+#include "gromacs/utility/common.h"
namespace gmx
{
~CommandLineParser();
/*! \brief
- * Parses the command line.
+ * Makes the parser skip unknown options and keep them in \c argv.
*
- * \throws std::bad_alloc if out of memory.
- * \throws InvalidInputError if any errors were detected in the input.
+ * \param[in] bEnabled Whether to skip and keep unknown options.
+ * \returns *this
*
- * All command-line arguments are parsed, and an aggregate exception
- * with all the detected errors is thrown in the end.
+ * Setting this option to true has dual effect: unknown options are
+ * silently skipped, and all recognized options are removed from
+ * \c argc and \c argv in parse(). These effects should be easy to
+ * separate into different flags if there is need for it.
+ *
+ * The default is false: unknown options result in exceptions and
+ * \c argc and \c argv are not modified.
*
- * Currently, the input parameters are not modified, but this may
- * change if/when support for parsing only part of the options is
- * implemented.
+ * Does not throw.
*/
- void parse(int *argc, char *argv[]);
+ CommandLineParser &skipUnknown(bool bEnabled);
+
/*! \brief
- * Parses the command line from a std::vector.
+ * Parses the command line.
*
- * \param[in] commandLine Array of command-line strings.
* \throws std::bad_alloc if out of memory.
* \throws InvalidInputError if any errors were detected in the input.
*
- * \p commandLine should relate to the standard \c argv array
- * one-to-one.
- *
- * This method is provided for convenience for cases where the command
- * line needs to be stored before parsing.
- *
- * Currently, the input parameters are not modified, but this may
- * change if/when support for parsing only part of the options is
- * implemented.
+ * All command-line arguments are parsed, and an aggregate exception
+ * with all the detected errors is thrown in the end.
*
- * \see parse(int *, char *[])
+ * If skipUnknown() is false, the input parameters are not modified.
+ * If skipUnknown() is true, recognized options and their values are
+ * removed from the argument list. \c argv[0] is never modified.
*/
- void parse(std::vector<std::string> *commandLine);
+ void parse(int *argc, char *argv[]);
private:
class Impl;