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 <cstdio>
  43
  44 #include "../utility/common.h"
  45
  46 namespace gmx
  47 {
  48
  49 class Options;
  50
  51 /*! \brief
  52  * Writes help information for Options in ascii format.
  53  *
  54  * \inpublicapi
  55  * \ingroup module_commandline
  56  */
  57 class CommandLineHelpWriter
  58 {
  59     public:
  60         /*! \brief
  61          * Creates an object that writer ascii-formatted help for Options.
  62          *
  63          * \param[in] options  Options for which help should be printed.
  64          */
  65         explicit CommandLineHelpWriter(const Options &options);
  66         ~CommandLineHelpWriter();
  67
  68         /*! \brief
  69          * Sets whether hidden options are shown in the help.
  70          */
  71         CommandLineHelpWriter &setShowHidden(bool bShow);
  72         /*! \brief
  73          * Sets whether long descriptions for sections are shown in the help.
  74          */
  75         CommandLineHelpWriter &setShowDescriptions(bool bShow);
  76
  77         /*! \brief
  78          * Writes the help.
  79          *
  80          * \param[in] fp  File to write the help to.
  81          */
  82         void writeHelp(FILE *fp);
  83
  84     private:
  85         class Impl;
  86
  87         PrivateImplPointer<Impl> impl_;
  88 };
  89
  90 } // namespace gmx
  91
  92 #endif