2 * This file is part of the GROMACS molecular simulation package.
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.
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
49 #include "../utility/common.h"
55 class TextLineWrapperSettings;
58 //! \libinternal Output format for help writing.
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.
68 /*! \libinternal \brief
69 * Hyperlink data for writing out help.
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.
76 * \ingroup module_onlinehelp
81 //! Initializes an empty links collection.
88 * \param[in] linkName Name of the link in input text.
89 * \param[in] targetName Hyperlink target.
91 * Any occurrence of \p linkName in the text passed to markup
92 * substitution methods in HelpWriterContext is made into a hyperlink
93 * to \p targetName if the markup format supports that.
95 void addLink(const std::string &linkName,
96 const std::string &targetName);
101 PrivateImplPointer<Impl> impl_;
103 //! Allows the context to use the links.
104 friend class HelpWriterContext;
107 /*! \libinternal \brief
108 * Context information for writing out help.
110 * The purpose of this class is to pass information about the output format to
111 * methods that write help, and to abstract away most of the details of
112 * different output formats.
113 * Additionally, it can keep other context information, although it currently
114 * does not. Such additional context information would be useful for
115 * formatting links/references to other help topics.
117 * TODO: This class will need additional work as part of Redmine issue #969.
120 * \ingroup module_onlinehelp
122 class HelpWriterContext
126 * Initializes a context with the given output file and format.
128 * \throws std::bad_alloc if out of memory.
130 HelpWriterContext(File *file, HelpOutputFormat format);
131 ~HelpWriterContext();
133 //! Sets the links to use in this context.
134 void setLinks(const HelpLinks &links);
137 * Returns the active output format.
141 HelpOutputFormat outputFormat() const;
143 * Returns the raw output file for writing the help.
145 * Using this file directly should be avoided, as it requires one to
146 * have different code for each output format.
147 * Using other methods in this class should be preferred.
151 File &outputFile() const;
154 * Substitutes markup used in help text and wraps lines.
156 * \param[in] settings Line wrapper settings.
157 * \param[in] text Text to substitute.
158 * \returns \p text with markup substituted and wrapped.
159 * \throws std::bad_alloc if out of memory.
161 * \see TextLineWrapper::wrapToString()
164 substituteMarkupAndWrapToString(const TextLineWrapperSettings &settings,
165 const std::string &text) const;
167 * Substitutes markup used in help text and wraps lines.
169 * \param[in] settings Line wrapper settings.
170 * \param[in] text Text to substitute.
171 * \returns \p text with markup substituted and wrapped as a list of
173 * \throws std::bad_alloc if out of memory.
175 * \see TextLineWrapper::wrapToVector()
177 std::vector<std::string>
178 substituteMarkupAndWrapToVector(const TextLineWrapperSettings &settings,
179 const std::string &text) const;
181 * Writes a title for the current help topic.
183 * \param[in] title Title to write.
184 * \throws std::bad_alloc if out of memory.
185 * \throws FileIOError on any I/O error.
187 void writeTitle(const std::string &title) const;
189 * Writes a formatted text block into the output.
191 * \param[in] text Text to format.
192 * \throws std::bad_alloc if out of memory.
193 * \throws FileIOError on any I/O error.
195 * Convenience function that calls substituteMarkupAndWrapToString()
196 * and writes the result directly to the output file.
198 void writeTextBlock(const std::string &text) const;
200 * Writes a formatted text block into the output.
202 * \param[in] settings Line wrapper settings.
203 * \param[in] text Text to format.
204 * \throws std::bad_alloc if out of memory.
205 * \throws FileIOError on any I/O error.
207 * Convenience function that calls substituteMarkupAndWrapToString()
208 * and writes the result directly to the output file.
210 void writeTextBlock(const TextLineWrapperSettings &settings,
211 const std::string &text) const;
216 PrivateImplPointer<Impl> impl_;