src/gromacs/onlinehelp/helpwritercontext.h

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