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,2015,2017,2019, 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 <string>
  47
  48 #include "gromacs/utility/classhelpers.h"
  49
  50 namespace gmx
  51 {
  52
  53 class CommandLineHelpContext;
  54 class Options;
  55
  56 template <typename T> class ArrayRef;
  57
  58 /*! \brief
  59  * Writes help information for Options.
  60  *
  61  * \inpublicapi
  62  * \ingroup module_commandline
  63  */
  64 class CommandLineHelpWriter
  65 {
  66     public:
  67         /*! \brief
  68          * Creates an object that writer ascii-formatted help for Options.
  69          *
  70          * \param[in] options  Options for which help should be printed.
  71          */
  72         explicit CommandLineHelpWriter(const Options &options);
  73         ~CommandLineHelpWriter();
  74
  75         /*! \brief
  76          * Sets the help text to print as description.
  77          *
  78          * \param[in] help  Help text to show.
  79          * \throws    std::bad_alloc if out of memory.
  80          *
  81          * If `help` is empty, or this method is not called, only a list of
  82          * options is printed.
  83          * Formatting for the help text is described on \ref page_onlinehelp.
  84          */
  85         CommandLineHelpWriter &setHelpText(const std::string &help);
  86         //! \copydoc setHelpText(const std::string &)
  87         CommandLineHelpWriter &
  88         setHelpText(const ArrayRef<const char *const> &help);
  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 ArrayRef<const char *const> &bugs);
 100
 101         /*! \brief
 102          * Sets text for known bugs.
 103          *
 104          * \param[in] bug  Text for bugs to show.
 105          * \throws    std::bad_alloc if out of memory.
 106          *
 107          * Formatting for the text is described on \ref page_onlinehelp.
 108          */
 109         CommandLineHelpWriter &setKnownIssues(ArrayRef<const std::string> bug);
 110
 111         /*! \brief
 112          * Writes the help.
 113          *
 114          * \param[in] context  Context object for writing the help.
 115          * \throws    std::bad_alloc if out of memory.
 116          * \throws    FileIOError on any I/O error.
 117          */
 118         void writeHelp(const CommandLineHelpContext &context);
 119
 120     private:
 121         class Impl;
 122
 123         PrivateImplPointer<Impl> impl_;
 124 };
 125
 126 } // namespace gmx
 127
 128 #endif