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.
   5  * Copyright (c) 2015,2017,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \file
  37  * \brief
  38  * Declares gmx::CommandLineHelpWriter.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \inpublicapi
  42  * \ingroup module_commandline
  43  */
  44 #ifndef GMX_COMMANDLINE_CMDLINEHELPWRITER_H
  45 #define GMX_COMMANDLINE_CMDLINEHELPWRITER_H
  46
  47 #include <string>
  48
  49 #include "gromacs/utility/classhelpers.h"
  50
  51 namespace gmx
  52 {
  53
  54 class CommandLineHelpContext;
  55 class Options;
  56
  57 template<typename T>
  58 class ArrayRef;
  59
  60 /*! \brief
  61  * Writes help information for Options.
  62  *
  63  * \inpublicapi
  64  * \ingroup module_commandline
  65  */
  66 class CommandLineHelpWriter
  67 {
  68 public:
  69     /*! \brief
  70      * Creates an object that writer ascii-formatted help for Options.
  71      *
  72      * \param[in] options  Options for which help should be printed.
  73      */
  74     explicit CommandLineHelpWriter(const Options& options);
  75     ~CommandLineHelpWriter();
  76
  77     /*! \brief
  78      * Sets the help text to print as description.
  79      *
  80      * \param[in] help  Help text to show.
  81      * \throws    std::bad_alloc if out of memory.
  82      *
  83      * If `help` is empty, or this method is not called, only a list of
  84      * options is printed.
  85      * Formatting for the help text is described on \ref page_onlinehelp.
  86      */
  87     CommandLineHelpWriter& setHelpText(const std::string& help);
  88     //! \copydoc setHelpText(const std::string &)
  89     CommandLineHelpWriter& setHelpText(const ArrayRef<const char* const>& help);
  90     /*! \brief
  91      * Sets the list of known bugs/limitations.
  92      *
  93      * \param[in] bugs  Array of bugs/limitations.
  94      *
  95      * Each entry in the input array identifies a separate issue.
  96      * The array passed should remain valid for the lifetime of the writer
  97      * object.
  98      */
  99     CommandLineHelpWriter& 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