src/gromacs/commandline/cmdlinehelpwriter.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012, 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.
   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::CommandLineHelpWriter.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEHELPWRITER_H
  44 #define GMX_COMMANDLINE_CMDLINEHELPWRITER_H
  45
  46 #include "../utility/common.h"
  47
  48 namespace gmx
  49 {
  50
  51 class HelpWriterContext;
  52 class Options;
  53
  54 /*! \brief
  55  * Writes help information for Options in ascii format.
  56  *
  57  * \inpublicapi
  58  * \ingroup module_commandline
  59  */
  60 class CommandLineHelpWriter
  61 {
  62     public:
  63         /*! \brief
  64          * Creates an object that writer ascii-formatted help for Options.
  65          *
  66          * \param[in] options  Options for which help should be printed.
  67          */
  68         explicit CommandLineHelpWriter(const Options &options);
  69         ~CommandLineHelpWriter();
  70
  71         /*! \brief
  72          * Sets whether hidden options are shown in the help.
  73          */
  74         CommandLineHelpWriter &setShowHidden(bool bShow);
  75         /*! \brief
  76          * Sets whether long descriptions for sections are shown in the help.
  77          */
  78         CommandLineHelpWriter &setShowDescriptions(bool bShow);
  79         /*! \brief
  80          * Sets time unit to show in descriptions.
  81          *
  82          * \param[in] timeUnit  Time unit to show in descriptions.
  83          * \throws    std::bad_alloc if out of memory.
  84          *
  85          * For each time parameter, any "%t" in the description is replaced
  86          * with \p timeunit.
  87          * If not called, uses a default "ps".
  88          */
  89         CommandLineHelpWriter &setTimeUnitString(const char *timeUnit);
  90
  91         /*! \brief
  92          * Writes the help.
  93          *
  94          * \param[in] context  Context object for writing the help.
  95          * \throws    std::bad_alloc if out of memory.
  96          * \throws    FileIOError on any I/O error.
  97          */
  98         void writeHelp(const HelpWriterContext &context);
  99
 100     private:
 101         class Impl;
 102
 103         PrivateImplPointer<Impl> impl_;
 104 };
 105
 106 } // namespace gmx
 107
 108 #endif