src/gromacs/onlinehelp/helpwritercontext.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, 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
  48 #include "../utility/common.h"
  49
  50 namespace gmx
  51 {
  52
  53 class File;
  54
  55 /*! \cond libapi */
  56 //! \libinternal Output format for help writing.
  57 enum HelpOutputFormat
  58 {
  59     eHelpOutputFormat_Console,  //!< Plain text directly on the console.
  60     eHelpOutputFormat_Man,      //!< Man page.
  61     eHelpOutputFormat_Html,     //!< Html output for online manual.
  62     eHelpOutputFormat_NR        //!< Used for the number of output formats.
  63 };
  64 //! \endcond
  65
  66 /*! \libinternal \brief
  67  * Context information for writing out help.
  68  *
  69  * The purpose of this class is to pass information about the output format to
  70  * methods that write help, and to abstract away most of the details of
  71  * different output formats.
  72  * Additionally, it can keep other context information, although it currently
  73  * does not.  Such additional context information would be useful for
  74  * formatting links/references to other help topics.
  75  *
  76  * TODO: This class will need additional work as part of Redmine issue #969.
  77  *
  78  * \inlibraryapi
  79  * \ingroup module_onlinehelp
  80  */
  81 class HelpWriterContext
  82 {
  83     public:
  84         /*! \brief
  85          * Initializes a context with the given output file and format.
  86          *
  87          * \throws std::bad_alloc if out of memory.
  88          */
  89         HelpWriterContext(File *file, HelpOutputFormat format);
  90         ~HelpWriterContext();
  91
  92         /*! \brief
  93          * Returns the active output format.
  94          *
  95          * Does not throw.
  96          */
  97         HelpOutputFormat outputFormat() const;
  98         /*! \brief
  99          * Returns the raw output file for writing the help.
 100          *
 101          * Using this file directly should be avoided, as it requires one to
 102          * have different code for each output format.
 103          * Using other methods in this class should be preferred.
 104          *
 105          * Does not throw.
 106          */
 107         File &outputFile() const;
 108
 109         /*! \brief
 110          * Substitutes markup used in help text.
 111          *
 112          * \param[in] text  Text to substitute.
 113          * \returns   \p text with markup substituted.
 114          * \throws    std::bad_alloc if out of memory.
 115          */
 116         std::string substituteMarkup(const std::string &text) const;
 117         /*! \brief
 118          * Writes a title for the current help topic.
 119          *
 120          * \param[in] title  Title to write.
 121          * \throws    std::bad_alloc if out of memory.
 122          * \throws    FileIOError on any I/O error.
 123          */
 124         void writeTitle(const std::string &title) const;
 125         /*! \brief
 126          * Writes a formatted text block into the output.
 127          *
 128          * \param[in] text  Text to format.
 129          * \throws    std::bad_alloc if out of memory.
 130          * \throws    FileIOError on any I/O error.
 131          *
 132          * In addition to substituteMarkup(), also does line wrapping for
 133          * console output.
 134          *
 135          * TODO: This function and substituteMarkup() should work more
 136          * similarly.
 137          */
 138         void writeTextBlock(const std::string &text) const;
 139
 140     private:
 141         class Impl;
 142
 143         PrivateImplPointer<Impl> impl_;
 144 };
 145
 146 } // namespace gmx
 147
 148 #endif