src/gromacs/commandline/cmdlinehelpcontext.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013, 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 gmx::CommandLineHelpContext.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEHELPCONTEXT_H
  44 #define GMX_COMMANDLINE_CMDLINEHELPCONTEXT_H
  45
  46 #include "../onlinehelp/helpwritercontext.h"
  47 #include "../utility/common.h"
  48
  49 namespace gmx
  50 {
  51
  52 /*! \libinternal \brief
  53  * Context information for writing out command-line help.
  54  *
  55  * This class wraps a HelpWriterContext, extending it with information specific
  56  * for command-line help export.  This way, code using only the routines in the
  57  * onlinehelp module is not exposed to extra features of the command-line help
  58  * export.
  59  *
  60  * Copying a context works like with HelpWriterContext: the output file and
  61  * most state is shared.  However, setModuleDisplayName() and setShowHidden()
  62  * can be set independently for the child context.  Defaults for these options
  63  * are inherited from the parent.
  64  *
  65  * \ingroup module_commandline
  66  */
  67 class CommandLineHelpContext
  68 {
  69     public:
  70         /*! \brief
  71          * Creates the context.
  72          *
  73          * Wraps the constructor of HelpWriterContext.
  74          */
  75         CommandLineHelpContext(File *file, HelpOutputFormat format,
  76                                const HelpLinks *links);
  77         //! Creates a copy of the context.
  78         explicit CommandLineHelpContext(const CommandLineHelpContext &other);
  79         ~CommandLineHelpContext();
  80
  81         /*! \brief
  82          * Sets a display name for the module for which help is being written.
  83          *
  84          * \throws std::bad_alloc if out of memory.
  85          */
  86         void setModuleDisplayName(const std::string &name);
  87         //! Sets whether hidden options should be shown in help output.
  88         void setShowHidden(bool bHidden);
  89
  90         //! Returns the lower-level context for writing the help.
  91         const HelpWriterContext &writerContext() const;
  92         /*! \brief
  93          * Returns a display name for the module for which help is being written.
  94          *
  95          * Does not throw.
  96          */
  97         const char *moduleDisplayName() const;
  98         //! Returns whether hidden options should be shown in help output.
  99         bool showHidden() const;
 100
 101     private:
 102         class Impl;
 103
 104         PrivateImplPointer<Impl> impl_;
 105
 106         GMX_DISALLOW_ASSIGN(CommandLineHelpContext);
 107 };
 108
 109 /*! \libinternal \brief
 110  * Helper for passing CommandLineHelpContext into parse_common_args().
 111  *
 112  * This class provides a mechanism to set and retrieve a global
 113  * CommandLineHelpContext object.  It is used to pass this object into
 114  * parse_common_args() from CommandLineModuleManager::runAsMainCMain() through
 115  * the main() function that is not aware of the wrapper binary mechanism.
 116  * It is not thread-safe because in this limited use case, it is always called
 117  * from a single-threaded context.
 118  *
 119  * \inlibraryapi
 120  * \ingroup module_onlinehelp
 121  */
 122 class GlobalCommandLineHelpContext
 123 {
 124     public:
 125         //! Returns the global context, or NULL if not set.
 126         static const CommandLineHelpContext *get();
 127
 128         /*! \brief
 129          * Sets the global context for the scope.
 130          *
 131          * The global context is cleared when this object goes out of scope.
 132          *
 133          * It is an error to have more than one GlobalCommandLineHelpContext
 134          * object in existence at the same time.
 135          */
 136         explicit GlobalCommandLineHelpContext(const CommandLineHelpContext &context);
 137         //! Clears the global context.
 138         ~GlobalCommandLineHelpContext();
 139 };
 140
 141 } // namespace gmx
 142
 143 #endif