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