/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \libinternal \file
* \brief
* Declares common string formatting routines for online help.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \inlibraryapi
- * \ingroup module_utility
+ * \ingroup module_onlinehelp
*/
#ifndef GMX_ONLINEHELP_HELPFORMAT_H
#define GMX_ONLINEHELP_HELPFORMAT_H
#include <string>
-#include "../utility/common.h"
+#include "gromacs/utility/common.h"
namespace gmx
{
class File;
-
-/*! \cond libapi */
-/*! \libinternal \brief
- * Make the string uppercase.
- *
- * \param[in] text Input text.
- * \returns \p text with all characters transformed to uppercase.
- * \throws std::bad_alloc if out of memory.
- *
- * \inlibraryapi
- */
-std::string toUpperCase(const std::string &text);
-
-/*! \libinternal \brief
- * Substitute markup used in help text for console output.
- *
- * \param[in] text Text to substitute.
- * \returns \p text with markup substituted.
- * \throws std::bad_alloc if out of memory.
- *
- * \inlibraryapi
- */
-std::string substituteMarkupForConsole(const std::string &text);
-/*! \libinternal \brief
- * Format a help text block for console output.
- *
- * \param file File to write the formatted text to.
- * \param[in] text Text to format.
- * \throws std::bad_alloc if out of memory.
- * \throws FileIOError on any I/O error.
- *
- * Calls substituteMarkupForConsole(), and also wraps the lines to 78
- * characters.
- *
- * \inlibraryapi
- */
-void writeHelpTextForConsole(File *file, const std::string &text);
-//! \endcond
+class HelpWriterContext;
/*! \libinternal \brief
* Formats rows of a table for text output.
*
* Typical usage:
* \code
-gmx::TextTableFormatter formatter;
-formatter.addColumn("Name", 10, false);
-formatter.addColumn("Type", 10, false);
-formatter.addColumn("Description", 50, true);
-
-formatter.clear();
-formatter.addColumnLine(0, "name");
-formatter.addColumnLine(1, "type");
-formatter.addColumnLine(2, "Description for name");
-printf("%s", formatter.formatRow().c_str());
-
-formatter.clear();
-formatter.addColumnLine(0, "averylongname");
-formatter.addColumnLine(1, "type");
-formatter.setColumnFirstLineOffset(1, 1);
-formatter.addColumnLine(2, "Description for name");
-printf("%s", formatter.formatRow().c_str());
-
-// format other rows by repeating the above code
+ gmx::TextTableFormatter formatter;
+ formatter.addColumn("Name", 10, false);
+ formatter.addColumn("Type", 10, false);
+ formatter.addColumn("Description", 50, true);
+
+ formatter.clear();
+ formatter.addColumnLine(0, "name");
+ formatter.addColumnLine(1, "type");
+ formatter.addColumnLine(2, "Description for name");
+ printf("%s", formatter.formatRow().c_str());
+
+ formatter.clear();
+ formatter.addColumnLine(0, "averylongname");
+ formatter.addColumnLine(1, "type");
+ formatter.setColumnFirstLineOffset(1, 1);
+ formatter.addColumnLine(2, "Description for name");
+ printf("%s", formatter.formatRow().c_str());
+
+ // format other rows by repeating the above code
* \endcode
*
* Methods in this class may throw std::bad_alloc if out of memory.
* Does not throw.
*/
void setFirstColumnIndent(int indent);
+ /*! \brief
+ * Enables folding the last column to separate lines if it overflows.
+ *
+ * \param[in] indent Number of spaces to use for indenting the lines.
+ *
+ * If called with `indent >= 0`, the last column for each row is
+ * treated specially: if it contains more lines than the other columns,
+ * and if the text would fit more compactly as separate lines after the
+ * row, then the whole last column is written after the row with the
+ * given \p indent. The column text then spans the whole space
+ * reserved for the table, making long text fit into a smaller amount
+ * of vertical space.
+ * If not called, the last column is not treates specially.
+ *
+ * Does not throw.
+ */
+ void setFoldLastColumnToNextLine(int indent);
/*! \brief
* Whether formatRow() has been successfully called.
* fits the column.
*/
void addColumnLine(int index, const std::string &text);
+ /*! \brief
+ * Adds text containing help markup to be printed in a column.
+ *
+ * \param[in] index Zero-based column index.
+ * \param[in] context Context to use for markup processing.
+ * \param[in] text Text to add.
+ *
+ * Works as addColumnLine(), except that it uses
+ * HelpWriterContext::substituteMarkupAndWrapToVector() to process
+ * markup in the input text instead of just wrapping it as plain text.
+ */
+ void addColumnHelpTextBlock(int index, const HelpWriterContext &context,
+ const std::string &text);
/*! \brief
* Sets the first line to which text is printed for a column.
*
*/
std::string formatRow();
- /*! \brief
- * Returns the last line on which column \p index has text.
- *
- * \param[in] index Zero-based column index.
- * \returns Last line index (zero-based) on which \p index has text.
- *
- * The return value is the sum of the number of lines added with
- * addColumnLine() (taking into account possible wrapping) and the line
- * offset set with setColumnFirstLineOffset().
- *
- * Does not throw.
- */
- int lastColumnLine(int index) const;
-
private:
class Impl;
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff