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  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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  * Context information for writing out help.
  70  *
  71  * The purpose of this class is to pass information about the output format to
  72  * methods that write help, and to abstract away most of the details of
  73  * different output formats.
  74  * Additionally, it can keep other context information, although it currently
  75  * does not.  Such additional context information would be useful for
  76  * formatting links/references to other help topics.
  77  *
  78  * TODO: This class will need additional work as part of Redmine issue #969.
  79  *
  80  * \inlibraryapi
  81  * \ingroup module_onlinehelp
  82  */
  83 class HelpWriterContext
  84 {
  85     public:
  86         /*! \brief
  87          * Initializes a context with the given output file and format.
  88          *
  89          * \throws std::bad_alloc if out of memory.
  90          */
  91         HelpWriterContext(File *file, HelpOutputFormat format);
  92         ~HelpWriterContext();
  93
  94         /*! \brief
  95          * Returns the active output format.
  96          *
  97          * Does not throw.
  98          */
  99         HelpOutputFormat outputFormat() const;
 100         /*! \brief
 101          * Returns the raw output file for writing the help.
 102          *
 103          * Using this file directly should be avoided, as it requires one to
 104          * have different code for each output format.
 105          * Using other methods in this class should be preferred.
 106          *
 107          * Does not throw.
 108          */
 109         File &outputFile() const;
 110
 111         /*! \brief
 112          * Substitutes markup used in help text and wraps lines.
 113          *
 114          * \param[in] settings Line wrapper settings.
 115          * \param[in] text     Text to substitute.
 116          * \returns   \p text with markup substituted and wrapped.
 117          * \throws    std::bad_alloc if out of memory.
 118          *
 119          * \see TextLineWrapper::wrapToString()
 120          */
 121         std::string
 122         substituteMarkupAndWrapToString(const TextLineWrapperSettings &settings,
 123                                         const std::string             &text) const;
 124         /*! \brief
 125          * Substitutes markup used in help text and wraps lines.
 126          *
 127          * \param[in] settings Line wrapper settings.
 128          * \param[in] text     Text to substitute.
 129          * \returns   \p text with markup substituted and wrapped as a list of
 130          *      lines.
 131          * \throws    std::bad_alloc if out of memory.
 132          *
 133          * \see TextLineWrapper::wrapToVector()
 134          */
 135         std::vector<std::string>
 136         substituteMarkupAndWrapToVector(const TextLineWrapperSettings &settings,
 137                                         const std::string             &text) const;
 138         /*! \brief
 139          * Writes a title for the current help topic.
 140          *
 141          * \param[in] title  Title to write.
 142          * \throws    std::bad_alloc if out of memory.
 143          * \throws    FileIOError on any I/O error.
 144          */
 145         void writeTitle(const std::string &title) const;
 146         /*! \brief
 147          * Writes a formatted text block into the output.
 148          *
 149          * \param[in] text  Text to format.
 150          * \throws    std::bad_alloc if out of memory.
 151          * \throws    FileIOError on any I/O error.
 152          *
 153          * Convenience function that calls substituteMarkupAndWrapToString()
 154          * and writes the result directly to the output file.
 155          */
 156         void writeTextBlock(const std::string &text) const;
 157         /*! \brief
 158          * Writes a formatted text block into the output.
 159          *
 160          * \param[in] settings Line wrapper settings.
 161          * \param[in] text     Text to format.
 162          * \throws    std::bad_alloc if out of memory.
 163          * \throws    FileIOError on any I/O error.
 164          *
 165          * Convenience function that calls substituteMarkupAndWrapToString()
 166          * and writes the result directly to the output file.
 167          */
 168         void writeTextBlock(const TextLineWrapperSettings &settings,
 169                             const std::string             &text) const;
 170
 171     private:
 172         class Impl;
 173
 174         PrivateImplPointer<Impl> impl_;
 175 };
 176
 177 } // namespace gmx
 178
 179 #endif