src/gromacs/onlinehelp/helpformat.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2019, 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.
   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 common string formatting routines for online help.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_onlinehelp
  42  */
  43 #ifndef GMX_ONLINEHELP_HELPFORMAT_H
  44 #define GMX_ONLINEHELP_HELPFORMAT_H
  45
  46 #include <string>
  47
  48 #include "gromacs/utility/classhelpers.h"
  49
  50 namespace gmx
  51 {
  52
  53 class HelpWriterContext;
  54
  55 /*! \libinternal \brief
  56  * Formats rows of a table for text output.
  57  *
  58  * This utility class formats tabular data, mainly for console output.
  59  * Each row in the table can take multiple lines, and automatic text wrapping
  60  * is supported.  If text overflows the allocated width, the remaining columns
  61  * on that line become shifted.  To avoid this, it is possible to start the
  62  * output for different columns from different lines (it is the caller's
  63  * responsibility to check that overflows are avoided or are acceptable).
  64  *
  65  * Column definitions are first set with addColumn().
  66  * To format a row, first call clear().  Then call addColumnLine() to add text
  67  * to each column (can be called multiple times on a single column to add
  68  * multiple lines), and possibly setColumnFirstLineOffset() to adjust the line
  69  * from which the column output should start.  Finally, call formatRow() to
  70  * obtain the formatted row.
  71  *
  72  * A header (column titles and a horizontal line) is printed before the first
  73  * line.
  74  *
  75  * Typical usage:
  76  * \code
  77    gmx::TextTableFormatter formatter;
  78    formatter.addColumn("Name", 10, false);
  79    formatter.addColumn("Type", 10, false);
  80    formatter.addColumn("Description", 50, true);
  81
  82    formatter.clear();
  83    formatter.addColumnLine(0, "name");
  84    formatter.addColumnLine(1, "type");
  85    formatter.addColumnLine(2, "Description for name");
  86    printf("%s", formatter.formatRow().c_str());
  87
  88    formatter.clear();
  89    formatter.addColumnLine(0, "averylongname");
  90    formatter.addColumnLine(1, "type");
  91    formatter.setColumnFirstLineOffset(1, 1);
  92    formatter.addColumnLine(2, "Description for name");
  93    printf("%s", formatter.formatRow().c_str());
  94
  95    // format other rows by repeating the above code
  96  * \endcode
  97  *
  98  * Methods in this class may throw std::bad_alloc if out of memory.
  99  * Other exceptions are not thrown.
 100  *
 101  * \inlibraryapi
 102  * \ingroup module_onlinehelp
 103  */
 104 class TextTableFormatter
 105 {
 106 public:
 107     //! Constructs an empty formatter.
 108     TextTableFormatter();
 109     ~TextTableFormatter();
 110
 111     /*! \brief
 112      * Adds a column to the table.
 113      *
 114      * \param[in]  title  Title string for the column (used for header).
 115      * \param[in]  width  Width of the column (must be > 0).
 116      * \param[in]  bWrap  Whether text that exceeds \p width is
 117      *      automatically wrapped.
 118      *
 119      * The length of \p title must not exceed \p width.
 120      */
 121     void addColumn(const char* title, int width, bool bWrap);
 122     /*! \brief
 123      * Sets amount on indentation before the first column.
 124      *
 125      * \param[in]  indent  Number of spaces to use for indenting.
 126      *
 127      * Does not throw.
 128      */
 129     void setFirstColumnIndent(int indent);
 130     /*! \brief
 131      * Enables folding the last column to separate lines if it overflows.
 132      *
 133      * \param[in]  indent  Number of spaces to use for indenting the lines.
 134      *
 135      * If called with `indent >= 0`, the last column for each row is
 136      * treated specially: if it contains more lines than the other columns,
 137      * and if the text would fit more compactly as separate lines after the
 138      * row, then the whole last column is written after the row with the
 139      * given \p indent.  The column text then spans the whole space
 140      * reserved for the table, making long text fit into a smaller amount
 141      * of vertical space.
 142      * If not called, the last column is not treates specially.
 143      *
 144      * Does not throw.
 145      */
 146     void setFoldLastColumnToNextLine(int indent);
 147
 148     /*! \brief
 149      * Whether formatRow() has been successfully called.
 150      *
 151      * This method can be used to determine after-the-fact whether anything
 152      * was written in the table.
 153      *
 154      * Does not throw.
 155      */
 156     bool didOutput() const;
 157
 158     /*! \brief
 159      * Removes all text from all columns and resets the line offsets.
 160      *
 161      * Removes all text added using addColumnLine() and resets line offsets
 162      * set with setColumnFirstLineOffset() to zero.
 163      * Should be called before starting to add data for a row.
 164      *
 165      * Does not throw.
 166      */
 167     void clear();
 168     /*! \brief
 169      * Adds text to be printed in a column.
 170      *
 171      * \param[in]  index     Zero-based column index.
 172      * \param[in]  text      Text to add.
 173      *
 174      * Can be called multiple times.  Additional calls append \p text as
 175      * additional lines.  Any calls with \p text empty have no effect.
 176      * To add an empty line, use "\n" as \p text.
 177      *
 178      * If \p text contains newlines, the text is automatically splitted to
 179      * multiple lines.  The same happens if automatic wrapping is on for
 180      * the column and the text contains lines that are longer than what
 181      * fits the column.
 182      */
 183     void addColumnLine(int index, const std::string& text);
 184     /*! \brief
 185      * Adds text containing help markup to be printed in a column.
 186      *
 187      * \param[in]  index     Zero-based column index.
 188      * \param[in]  context   Context to use for markup processing.
 189      * \param[in]  text      Text to add.
 190      *
 191      * Works as addColumnLine(), except that it uses
 192      * HelpWriterContext::substituteMarkupAndWrapToVector() to process
 193      * markup in the input text instead of just wrapping it as plain text.
 194      */
 195     void addColumnHelpTextBlock(int index, const HelpWriterContext& context, const std::string& text);
 196     /*! \brief
 197      * Sets the first line to which text is printed for a column.
 198      *
 199      * \param[in]  index     Zero-based column index.
 200      * \param[in]  firstLine Zero-based line index from which to start the
 201      *      output.
 202      *
 203      * Can be called if there is no text for column \p index.
 204      * Does not affect the output in this case.
 205      *
 206      * Does not throw.
 207      */
 208     void setColumnFirstLineOffset(int index, int firstLine);
 209     /*! \brief
 210      * Formats the lines for the current row.
 211      *
 212      * \returns  Current row formatted as a single string
 213      *      (contains newlines).
 214      *
 215      * Formats the data as set after the previous clear()/formatRow() using
 216      * addColumnLine() and setColumnFirstLineOffset().
 217      *
 218      * If this is the first line to be formatted, a header is also added to
 219      * the beginning of the returned string if any column has a title.
 220      *
 221      * The return value always terminates with a newline.
 222      *
 223      * Calls clear() on successful return.
 224      */
 225     std::string formatRow();
 226
 227 private:
 228     class Impl;
 229
 230     PrivateImplPointer<Impl> impl_;
 231 };
 232
 233 } // namespace gmx
 234
 235 #endif