2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
37 * Declares gmx::HelpWriterContext.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_onlinehelp
43 #ifndef GMX_ONLINEHELP_HELPWRITERCONTEXT_H
44 #define GMX_ONLINEHELP_HELPWRITERCONTEXT_H
48 #include "../utility/common.h"
56 //! \libinternal Output format for help writing.
59 eHelpOutputFormat_Console, //!< Plain text directly on the console.
60 eHelpOutputFormat_NR //!< Used for the number of output formats.
64 /*! \libinternal \brief
65 * Context information for writing out help.
67 * The purpose of this class is to pass information about the output format to
68 * methods that write help, and to abstract away most of the details of
69 * different output formats.
70 * Additionally, it can keep other context information, although it currently
71 * does not. Such additional context information would be useful for
72 * formatting links/references to other help topics.
74 * TODO: This class will need additional work as part of Redmine issue #969.
77 * \ingroup module_onlinehelp
79 class HelpWriterContext
83 * Initializes a context with the given output file and format.
85 * \throws std::bad_alloc if out of memory.
87 HelpWriterContext(File *file, HelpOutputFormat format);
91 * Returns the active output format.
95 HelpOutputFormat outputFormat() const;
97 * Returns the raw output file for writing the help.
99 * Using this file directly should be avoided, as it requires one to
100 * have different code for each output format.
101 * Using other methods in this class should be preferred.
105 File &outputFile() const;
108 * Substitutes markup used in help text.
110 * \param[in] text Text to substitute.
111 * \returns \p text with markup substituted.
112 * \throws std::bad_alloc if out of memory.
114 std::string substituteMarkup(const std::string &text) const;
116 * Writes a title for the current help topic.
118 * \param[in] title Title to write.
119 * \throws std::bad_alloc if out of memory.
120 * \throws FileIOError on any I/O error.
122 void writeTitle(const std::string &title) const;
124 * Writes a formatted text block into the output.
126 * \param[in] text Text to format.
127 * \throws std::bad_alloc if out of memory.
128 * \throws FileIOError on any I/O error.
130 * In addition to substituteMarkup(), also does line wrapping for
133 * TODO: This function and substituteMarkup() should work more
136 void writeTextBlock(const std::string &text) const;
141 PrivateImplPointer<Impl> impl_;