src/gromacs/onlinehelp/helpwritercontext.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013, 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 "../utility/common.h"
  50
  51 namespace gmx
  52 {
  53
  54 class File;
  55 class TextLineWrapperSettings;
  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_Man,      //!< Man page.
  63     eHelpOutputFormat_Html,     //!< Html output for online manual.
  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,
 105                      const std::string &targetName,
 106                      const std::string &displayName);
 107
 108     private:
 109         class Impl;
 110
 111         PrivateImplPointer<Impl> impl_;
 112
 113         //! Allows the context to use the links.
 114         friend class HelpWriterContext;
 115 };
 116
 117 /*! \libinternal \brief
 118  * Context information for writing out help.
 119  *
 120  * The purpose of this class is to pass information about the output format to
 121  * methods that write help, and to abstract away most of the details of
 122  * different output formats.
 123  *
 124  * The state of a context object (excluding the fact that the output file is
 125  * written to) does not change after initial construction of the object.
 126  * Copying creates a context object that shares state with the source.
 127  *
 128  * TODO: This class will need additional work as part of Redmine issue #969.
 129  *
 130  * \inlibraryapi
 131  * \ingroup module_onlinehelp
 132  */
 133 class HelpWriterContext
 134 {
 135     public:
 136         /*! \brief
 137          * Initializes a context with the given output file and format.
 138          *
 139          * \throws std::bad_alloc if out of memory.
 140          */
 141         HelpWriterContext(File *file, HelpOutputFormat format);
 142         /*! \brief
 143          * Initializes a context with the given output file, format and links.
 144          *
 145          * \throws std::bad_alloc if out of memory.
 146          *
 147          * A reference to \p links is stored until the HelpWriterContext
 148          * is destructed.  The caller is responsible for ensuring that the
 149          * links object remains valid long enough.
 150          */
 151         HelpWriterContext(File *file, HelpOutputFormat format,
 152                           const HelpLinks *links);
 153         //! Creates a copy of the context.
 154         HelpWriterContext(const HelpWriterContext &other);
 155         ~HelpWriterContext();
 156
 157         /*! \brief
 158          * Adds a string replacement for markup subsitution.
 159          *
 160          * \param[in] search   Text to replace in input.
 161          * \param[in] replace  Text that each occurrence of \p search is
 162          *     replaced with.
 163          * \throws std::bad_alloc if out of memory.
 164          *
 165          * \todo
 166          * Improve semantics if the same \p search item is set multiple
 167          * times.
 168          */
 169         void setReplacement(const std::string &search,
 170                             const std::string &replace);
 171
 172         /*! \brief
 173          * Returns the active output format.
 174          *
 175          * Does not throw.
 176          */
 177         HelpOutputFormat outputFormat() const;
 178         /*! \brief
 179          * Returns the raw output file for writing the help.
 180          *
 181          * Using this file directly should be avoided, as it requires one to
 182          * have different code for each output format.
 183          * Using other methods in this class should be preferred.
 184          *
 185          * Does not throw.
 186          */
 187         File &outputFile() const;
 188
 189         /*! \brief
 190          * Substitutes markup used in help text and wraps lines.
 191          *
 192          * \param[in] settings Line wrapper settings.
 193          * \param[in] text     Text to substitute.
 194          * \returns   \p text with markup substituted and wrapped.
 195          * \throws    std::bad_alloc if out of memory.
 196          *
 197          * \see TextLineWrapper::wrapToString()
 198          */
 199         std::string
 200         substituteMarkupAndWrapToString(const TextLineWrapperSettings &settings,
 201                                         const std::string             &text) const;
 202         /*! \brief
 203          * Substitutes markup used in help text and wraps lines.
 204          *
 205          * \param[in] settings Line wrapper settings.
 206          * \param[in] text     Text to substitute.
 207          * \returns   \p text with markup substituted and wrapped as a list of
 208          *      lines.
 209          * \throws    std::bad_alloc if out of memory.
 210          *
 211          * \see TextLineWrapper::wrapToVector()
 212          */
 213         std::vector<std::string>
 214         substituteMarkupAndWrapToVector(const TextLineWrapperSettings &settings,
 215                                         const std::string             &text) const;
 216         /*! \brief
 217          * Writes a title for the current help topic.
 218          *
 219          * \param[in] title  Title to write.
 220          * \throws    std::bad_alloc if out of memory.
 221          * \throws    FileIOError on any I/O error.
 222          */
 223         void writeTitle(const std::string &title) const;
 224         /*! \brief
 225          * Writes a formatted text block into the output.
 226          *
 227          * \param[in] text  Text to format.
 228          * \throws    std::bad_alloc if out of memory.
 229          * \throws    FileIOError on any I/O error.
 230          *
 231          * Convenience function that calls substituteMarkupAndWrapToString()
 232          * and writes the result directly to the output file.
 233          */
 234         void writeTextBlock(const std::string &text) const;
 235         /*! \brief
 236          * Writes a formatted text block into the output.
 237          *
 238          * \param[in] settings Line wrapper settings.
 239          * \param[in] text     Text to format.
 240          * \throws    std::bad_alloc if out of memory.
 241          * \throws    FileIOError on any I/O error.
 242          *
 243          * Convenience function that calls substituteMarkupAndWrapToString()
 244          * and writes the result directly to the output file.
 245          */
 246         void writeTextBlock(const TextLineWrapperSettings &settings,
 247                             const std::string             &text) const;
 248
 249     private:
 250         class Impl;
 251
 252         /*! \brief
 253          * Constructs a context object with the given implementation class.
 254          *
 255          * \param[in] impl  Implementation object.
 256          *
 257          * Does not throw.
 258          */
 259         explicit HelpWriterContext(Impl *impl);
 260
 261         PrivateImplPointer<Impl> impl_;
 262
 263         GMX_DISALLOW_ASSIGN(HelpWriterContext);
 264 };
 265
 266 } // namespace gmx
 267
 268 #endif