src/gromacs/commandline/cmdlinehelpwriter.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source 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 CommandLineHelpContext;
  52 class Options;
  53
  54 template <typename T> class ConstArrayRef;
  55
  56 /*! \brief
  57  * Writes help information for Options in ascii format.
  58  *
  59  * \inpublicapi
  60  * \ingroup module_commandline
  61  */
  62 class CommandLineHelpWriter
  63 {
  64     public:
  65         /*! \brief
  66          * Creates an object that writer ascii-formatted help for Options.
  67          *
  68          * \param[in] options  Options for which help should be printed.
  69          */
  70         explicit CommandLineHelpWriter(const Options &options);
  71         ~CommandLineHelpWriter();
  72
  73         /*! \brief
  74          * Sets whether long descriptions for sections are shown in the help.
  75          */
  76         CommandLineHelpWriter &setShowDescriptions(bool bShow);
  77         /*! \brief
  78          * Sets time unit to show in descriptions.
  79          *
  80          * \param[in] timeUnit  Time unit to show in descriptions.
  81          * \throws    std::bad_alloc if out of memory.
  82          *
  83          * For each time parameter, any "%t" in the description is replaced
  84          * with \p timeunit.
  85          * If not called, uses a default "ps".
  86          */
  87         CommandLineHelpWriter &setTimeUnitString(const char *timeUnit);
  88
  89         /*! \brief
  90          * Sets the list of known bugs/limitations.
  91          *
  92          * \param[in] bugs  Array of bugs/limitations.
  93          *
  94          * Each entry in the input array identifies a separate issue.
  95          * The array passed should remain valid for the lifetime of the writer
  96          * object.
  97          */
  98         CommandLineHelpWriter &
  99         setKnownIssues(const ConstArrayRef<const char *> &bugs);
 100
 101         /*! \brief
 102          * Writes the help.
 103          *
 104          * \param[in] context  Context object for writing the help.
 105          * \throws    std::bad_alloc if out of memory.
 106          * \throws    FileIOError on any I/O error.
 107          */
 108         void writeHelp(const CommandLineHelpContext &context);
 109
 110     private:
 111         class Impl;
 112
 113         PrivateImplPointer<Impl> impl_;
 114 };
 115
 116 } // namespace gmx
 117
 118 #endif