/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * 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.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \file
* \brief
* Declares gmx::CommandLineParser.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \inpublicapi
* \ingroup module_commandline
*/
#include <string>
#include <vector>
-#include "../utility/common.h"
+#include "gromacs/utility/common.h"
namespace gmx
{
*
* Typical usage (without error checking):
* \code
-gmx::Options options("name", "description");
-// Fill up options
+ gmx::Options options("name", "description");
+ // Fill up options
-gmx::CommandLineParser(&options).parse(&argc, argv);
-options.finish();
+ gmx::CommandLineParser(&options).parse(&argc, argv);
+ options.finish();
* \endcode
*
* \inpublicapi
~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.
*
- * Currently, the input parameters are not modified, but this may
- * change if/when support for parsing only part of the options is
- * implemented.
+ * The default is false: unknown options result in exceptions and
+ * \c argc and \c argv are not modified.
+ *
+ * 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;
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff