2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2015, 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.
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.
37 * Tests for help text formatting.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_onlinehelp
44 #include "gromacs/onlinehelp/helpwritercontext.h"
48 #include <gtest/gtest.h>
50 #include "gromacs/utility/arrayref.h"
51 #include "gromacs/utility/gmxassert.h"
52 #include "gromacs/utility/stringutil.h"
54 #include "testutils/stringtest.h"
59 /********************************************************************
60 * Tests for HelpWriterContext
63 class HelpWriterContextTest : public gmx::test::StringTestBase
66 void testFormatting(const std::string &text,
67 gmx::HelpOutputFormat format,
70 gmx::HelpWriterContext context(NULL, format);
72 = context.substituteMarkupAndWrapToString(settings_, text);
77 case gmx::eHelpOutputFormat_Console:
80 case gmx::eHelpOutputFormat_Rst:
81 id = "reStructuredText";
84 GMX_RELEASE_ASSERT(false, "Help output format testing not implemented");
87 checkText(result, id);
89 void testFormatting(const gmx::ConstArrayRef<const char *> &text)
91 std::string testText = gmx::joinStrings(text, "\n");
92 testFormatting(testText, gmx::eHelpOutputFormat_Console, NULL);
93 testFormatting(testText, gmx::eHelpOutputFormat_Rst, NULL);
96 gmx::TextLineWrapperSettings settings_;
99 TEST_F(HelpWriterContextTest, FormatsParagraphs)
101 const char *const text[] = {
104 "jumps over a lazy dog.[PAR]",
109 settings_.setLineLength(13);
110 testFormatting(text);
113 TEST_F(HelpWriterContextTest, FormatsRstStyleParagraphs)
115 const char *const text[] = {
118 "jumps over a lazy dog.",
124 settings_.setLineLength(13);
125 testFormatting(text);
128 TEST_F(HelpWriterContextTest, CleansUpExtraWhitespace)
130 const char *const text[] = {
134 "jumps over a lazy dog.",
140 settings_.setLineLength(13);
141 testFormatting(text);
144 TEST_F(HelpWriterContextTest, FormatsLiteralText)
146 const char *const text[] = {
147 "Sample paragraph::",
155 testFormatting(text);
158 TEST_F(HelpWriterContextTest, FormatsBulletList)
160 const char *const text[] = {
164 " * second item that",
165 " spans multiple lines",
166 " * third item that has a single long line",
170 // Wrapping to rst with a fixed line length does not currently work
171 // correctly, but it is not used, either.
172 settings_.setLineLength(15);
173 testFormatting(text);