src/gromacs/commandline/cmdlinehelpwriter.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \file
  32  * \brief
  33  * Declares gmx::CommandLineHelpWriter.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inpublicapi
  37  * \ingroup module_commandline
  38  */
  39 #ifndef GMX_COMMANDLINE_CMDLINEHELPWRITER_H
  40 #define GMX_COMMANDLINE_CMDLINEHELPWRITER_H
  41
  42 #include "../utility/common.h"
  43
  44 namespace gmx
  45 {
  46
  47 class HelpWriterContext;
  48 class Options;
  49
  50 /*! \brief
  51  * Writes help information for Options in ascii format.
  52  *
  53  * \inpublicapi
  54  * \ingroup module_commandline
  55  */
  56 class CommandLineHelpWriter
  57 {
  58     public:
  59         /*! \brief
  60          * Creates an object that writer ascii-formatted help for Options.
  61          *
  62          * \param[in] options  Options for which help should be printed.
  63          */
  64         explicit CommandLineHelpWriter(const Options &options);
  65         ~CommandLineHelpWriter();
  66
  67         /*! \brief
  68          * Sets whether hidden options are shown in the help.
  69          */
  70         CommandLineHelpWriter &setShowHidden(bool bShow);
  71         /*! \brief
  72          * Sets whether long descriptions for sections are shown in the help.
  73          */
  74         CommandLineHelpWriter &setShowDescriptions(bool bShow);
  75         /*! \brief
  76          * Sets time unit to show in descriptions.
  77          *
  78          * \param[in] timeUnit  Time unit to show in descriptions.
  79          * \throws    std::bad_alloc if out of memory.
  80          *
  81          * For each time parameter, any "%t" in the description is replaced
  82          * with \p timeunit.
  83          * If not called, uses a default "ps".
  84          */
  85         CommandLineHelpWriter &setTimeUnitString(const char *timeUnit);
  86
  87         /*! \brief
  88          * Writes the help.
  89          *
  90          * \param[in] context  Context object for writing the help.
  91          * \throws    std::bad_alloc if out of memory.
  92          * \throws    FileIOError on any I/O error.
  93          */
  94         void writeHelp(const HelpWriterContext &context);
  95
  96     private:
  97         class Impl;
  98
  99         PrivateImplPointer<Impl> impl_;
 100 };
 101
 102 } // namespace gmx
 103
 104 #endif