src/gromacs/commandline/cmdlineparser.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \file
  32  * \brief
  33  * Declares gmx::CommandLineParser.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inpublicapi
  37  * \ingroup module_commandline
  38  */
  39 #ifndef GMX_COMMANDLINE_CMDLINEPARSER_H
  40 #define GMX_COMMANDLINE_CMDLINEPARSER_H
  41
  42 #include <string>
  43 #include <vector>
  44
  45 #include "../utility/common.h"
  46
  47 namespace gmx
  48 {
  49
  50 class Options;
  51
  52 /*! \brief
  53  * Implements command-line parsing for Options objects.
  54  *
  55  * Typical usage (without error checking):
  56  * \code
  57 gmx::Options options("name", "description");
  58 // Fill up options
  59
  60 gmx::CommandLineParser(&options).parse(&argc, argv);
  61 options.finish();
  62  * \endcode
  63  *
  64  * \inpublicapi
  65  * \ingroup module_commandline
  66  */
  67 class CommandLineParser
  68 {
  69     public:
  70         /*! \brief
  71          * Creates a command-line parser that sets values for options.
  72          *
  73          * \param[in] options  Options object whose options should be set.
  74          * \throws  std::bad_alloc if out of memory.
  75          */
  76         CommandLineParser(Options *options);
  77         ~CommandLineParser();
  78
  79         /*! \brief
  80          * Parses the command line.
  81          *
  82          * \throws  std::bad_alloc if out of memory.
  83          * \throws  InvalidInputError if any errors were detected in the input.
  84          *
  85          * All command-line arguments are parsed, and an aggregate exception
  86          * with all the detected errors is thrown in the end.
  87          *
  88          * Currently, the input parameters are not modified, but this may
  89          * change if/when support for parsing only part of the options is
  90          * implemented.
  91          */
  92         void parse(int *argc, char *argv[]);
  93         /*! \brief
  94          * Parses the command line from a std::vector.
  95          *
  96          * \param[in] commandLine  Array of command-line strings.
  97          * \throws  std::bad_alloc if out of memory.
  98          * \throws  InvalidInputError if any errors were detected in the input.
  99          *
 100          * \p commandLine should relate to the standard \c argv array
 101          * one-to-one.
 102          *
 103          * This method is provided for convenience for cases where the command
 104          * line needs to be stored before parsing.
 105          *
 106          * Currently, the input parameters are not modified, but this may
 107          * change if/when support for parsing only part of the options is
 108          * implemented.
 109          *
 110          * \see parse(int *, char *[])
 111          */
 112         void parse(std::vector<std::string> *commandLine);
 113
 114     private:
 115         class Impl;
 116
 117         PrivateImplPointer<Impl> impl_;
 118 };
 119
 120 } // namespace gmx
 121
 122 #endif