src/gromacs/onlinehelp/helpwritercontext.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2019,2021, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::HelpWriterContext.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_onlinehelp
  42  */
  43 #ifndef GMX_ONLINEHELP_HELPWRITERCONTEXT_H
  44 #define GMX_ONLINEHELP_HELPWRITERCONTEXT_H
  45
  46 #include <memory>
  47 #include <string>
  48 #include <vector>
  49
  50 #include "gromacs/utility/classhelpers.h"
  51
  52 namespace gmx
  53 {
  54
  55 class TextLineWrapperSettings;
  56 class TextWriter;
  57
  58 /*! \cond libapi */
  59 //! \libinternal Output format for help writing.
  60 enum HelpOutputFormat
  61 {
  62     eHelpOutputFormat_Console, //!< Plain text directly on the console.
  63     eHelpOutputFormat_Rst,     //!< reStructuredText for online manual and man pages.
  64     eHelpOutputFormat_Other,   //!< Used for extensions in other modules.
  65     eHelpOutputFormat_NR       //!< Used for the number of output formats.
  66 };
  67 //! \endcond
  68
  69 /*! \libinternal \brief
  70  * Hyperlink data for writing out help.
  71  *
  72  * This class is separate from HelpWriterContext to allow constructing the list
  73  * of links once and reusing them across multiple help writer contexts.
  74  * This is used when exporting all the help from the wrapper binary to avoid
  75  * repeatedly constructing the same data structure for each help item.
  76  *
  77  * While the links are in principle independent of the output format, the
  78  * constructor takes the output format to be able to preformat the links,
  79  * avoiding repeated processing during markup substitution.  Could be hidden
  80  * behind the scenes in HelpWriterContext, but that would complicate the
  81  * implementation.
  82  *
  83  * \ingroup module_onlinehelp
  84  */
  85 class HelpLinks
  86 {
  87 public:
  88     /*! \brief
  89      * Initializes an empty links collection for the given output format.
  90      */
  91     explicit HelpLinks(HelpOutputFormat format);
  92     ~HelpLinks();
  93
  94     /*! \brief
  95      * Adds a link.
  96      *
  97      * \param[in] linkName     Name of the link in input text.
  98      * \param[in] targetName   Hyperlink target.
  99      * \param[in] displayName  Text to show as the link.
 100      *
 101      * Any occurrence of \p linkName in the text passed to markup
 102      * substitution methods in HelpWriterContext is made into a hyperlink
 103      * to \p targetName if the markup format supports that.
 104      */
 105     void addLink(const std::string& linkName, const std::string& targetName, const std::string& displayName);
 106
 107 private:
 108     class Impl;
 109
 110     std::unique_ptr<Impl> impl_;
 111
 112     //! Allows the context to use the links.
 113     friend class HelpWriterContext;
 114 };
 115
 116 /*! \libinternal \brief
 117  * Context information for writing out help.
 118  *
 119  * The purpose of this class is to pass information about the output format to
 120  * methods that write help, and to abstract away most of the details of
 121  * different output formats.
 122  *
 123  * The state of a context object (excluding the fact that the output file is
 124  * written to) does not change after initial construction of the object.
 125  * Copying creates a context objects that share state with the source.
 126  *
 127  * \inlibraryapi
 128  * \ingroup module_onlinehelp
 129  */
 130 class HelpWriterContext
 131 {
 132 public:
 133     /*! \brief
 134      * Initializes a context with the given output writer and format.
 135      *
 136      * \throws std::bad_alloc if out of memory.
 137      */
 138     HelpWriterContext(TextWriter* writer, HelpOutputFormat format);
 139     /*! \brief
 140      * Initializes a context with the given output writer, format and links.
 141      *
 142      * \throws std::bad_alloc if out of memory.
 143      *
 144      * A reference to \p links is stored until the HelpWriterContext
 145      * is destructed.  The caller is responsible for ensuring that the
 146      * links object remains valid long enough.
 147      */
 148     HelpWriterContext(TextWriter* writer, HelpOutputFormat format, const HelpLinks* links);
 149     //! Creates a copy of the context.
 150     HelpWriterContext(const HelpWriterContext& other);
 151     ~HelpWriterContext();
 152
 153     /*! \brief
 154      * Adds a string replacement for markup subsitution.
 155      *
 156      * \param[in] search   Text to replace in input.
 157      * \param[in] replace  Text that each occurrence of \p search is
 158      *     replaced with.
 159      * \throws std::bad_alloc if out of memory.
 160      *
 161      * \todo
 162      * Improve semantics if the same \p search item is set multiple
 163      * times.
 164      */
 165     void setReplacement(const std::string& search, const std::string& replace);
 166
 167     /*! \brief
 168      * Returns the active output format.
 169      *
 170      * Does not throw.
 171      */
 172     HelpOutputFormat outputFormat() const;
 173     /*! \brief
 174      * Returns the raw writer for writing the help.
 175      *
 176      * Using this writer directly should be avoided, as it requires one to
 177      * have different code for each output format.
 178      * Using other methods in this class should be preferred.
 179      *
 180      * Does not throw.
 181      */
 182     TextWriter& outputFile() const;
 183
 184     /*! \brief
 185      * Creates a subsection in the output help.
 186      *
 187      * \param[in] title  Title for the subsection.
 188      * \throws    std::bad_alloc if out of memory.
 189      * \throws    FileIOError on any I/O error.
 190      *
 191      * Writes \p title using writeTitle() and makes any further
 192      * writeTitle() calls write headings one level deeper.
 193      *
 194      * Typical use for writing a subsection is to create a copy of the
 195      * context for the parent section, and then call enterSubSection() on
 196      * the copy.
 197      * The whole subsection should be written out using the returned
 198      * context before calling any further methods in the parent context.
 199      *
 200      * This method is only necessary if the subsection will contain further
 201      * subsections.  If there is only one level of subsections, it is
 202      * possible to use writeTitle() directly.
 203      */
 204     void enterSubSection(const std::string& title);
 205
 206     /*! \brief
 207      * Substitutes markup used in help text and wraps lines.
 208      *
 209      * \param[in] settings Line wrapper settings.
 210      * \param[in] text     Text to substitute.
 211      * \returns   \p text with markup substituted and wrapped.
 212      * \throws    std::bad_alloc if out of memory.
 213      *
 214      * \see TextLineWrapper::wrapToString()
 215      */
 216     std::string substituteMarkupAndWrapToString(const TextLineWrapperSettings& settings,
 217                                                 const std::string&             text) const;
 218     /*! \brief
 219      * Substitutes markup used in help text and wraps lines.
 220      *
 221      * \param[in] settings Line wrapper settings.
 222      * \param[in] text     Text to substitute.
 223      * \returns   \p text with markup substituted and wrapped as a list of
 224      *      lines.
 225      * \throws    std::bad_alloc if out of memory.
 226      *
 227      * \see TextLineWrapper::wrapToVector()
 228      */
 229     std::vector<std::string> substituteMarkupAndWrapToVector(const TextLineWrapperSettings& settings,
 230                                                              const std::string& text) const;
 231     /*! \brief
 232      * Writes a title for the current help topic.
 233      *
 234      * \param[in] title  Title to write.
 235      * \throws    std::bad_alloc if out of memory.
 236      * \throws    FileIOError on any I/O error.
 237      */
 238     void writeTitle(const std::string& title) const;
 239     /*! \brief
 240      * Writes a formatted text block into the output.
 241      *
 242      * \param[in] text  Text to format.
 243      * \throws    std::bad_alloc if out of memory.
 244      * \throws    FileIOError on any I/O error.
 245      *
 246      * Convenience function that calls substituteMarkupAndWrapToString()
 247      * and writes the result directly to the output file.
 248      */
 249     void writeTextBlock(const std::string& text) const;
 250     /*! \brief
 251      * Ensures a paragraph break (empty line) in the output.
 252      *
 253      * Calls at the beginning and end of output do not produce extra empty
 254      * lines, and consencutive calls only result in a single empty line.
 255      * This allows calling the method before and after all output that
 256      * needs to appear separated as empty lines.
 257      */
 258     void paragraphBreak() const;
 259     /*! \brief
 260      * Starts writing a list of options.
 261      *
 262      * Prints any necessary headers for a list of options formatted with
 263      * writeOptionItem().
 264      */
 265     void writeOptionListStart() const;
 266     /*! \brief
 267      * Writes an entry for a single option into the output.
 268      *
 269      * \param[in] name  Name of the option.
 270      * \param[in] value        Placeholder for option value.
 271      * \param[in] defaultValue Default value for the option.
 272      * \param[in] info         Additional (brief) info/attributes for the
 273      *      option.
 274      * \param[in] description  Full description of the option.
 275      */
 276     void writeOptionItem(const std::string& name,
 277                          const std::string& value,
 278                          const std::string& defaultValue,
 279                          const std::string& info,
 280                          const std::string& description) const;
 281     /*! \brief
 282      * Finishes writing a list of options.
 283      *
 284      * Prints any necessary footers for a list of options formatted with
 285      * writeOptionItem().
 286      */
 287     void writeOptionListEnd() const;
 288
 289 private:
 290     class Impl;
 291
 292     /*! \brief
 293      * Constructs a context object with the given implementation class.
 294      *
 295      * \param[in] impl  Implementation object.
 296      *
 297      * Does not throw.
 298      */
 299     explicit HelpWriterContext(Impl* impl);
 300
 301     std::unique_ptr<Impl> impl_;
 302
 303     GMX_DISALLOW_ASSIGN(HelpWriterContext);
 304 };
 305
 306 } // namespace gmx
 307
 308 #endif