src/gromacs/commandline/cmdlinehelpcontext.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015,2018,2019,2021, 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 <memory>
  47 #include <string>
  48
  49 #include "gromacs/onlinehelp/helpwritercontext.h"
  50 #include "gromacs/utility/classhelpers.h"
  51
  52 namespace gmx
  53 {
  54
  55 class ShellCompletionWriter;
  56
  57 /*! \libinternal \brief
  58  * Context information for writing out command-line help.
  59  *
  60  * This class wraps a HelpWriterContext, extending it with information specific
  61  * for command-line help export.  This way, code using only the routines in the
  62  * onlinehelp module is not exposed to extra features of the command-line help
  63  * export.
  64  *
  65  * Copying a context works like with HelpWriterContext: the output file and
  66  * most state is shared.  However, setModuleDisplayName() and setShowHidden()
  67  * can be set independently for the child context.  Defaults for these options
  68  * are inherited from the parent.
  69  *
  70  * \ingroup module_commandline
  71  */
  72 class CommandLineHelpContext
  73 {
  74 public:
  75     /*! \brief
  76      * Creates a context for help export.
  77      *
  78      * Wraps the constructor of HelpWriterContext.
  79      */
  80     CommandLineHelpContext(TextWriter*        writer,
  81                            HelpOutputFormat   format,
  82                            const HelpLinks*   links,
  83                            const std::string& programName);
  84     //! Creates a context for a particular HelpWriterContext.
  85     explicit CommandLineHelpContext(const HelpWriterContext& writerContext);
  86     /*! \brief
  87      * Creates a context for shell completion.
  88      */
  89     explicit CommandLineHelpContext(ShellCompletionWriter* writer);
  90     //! Creates a copy of the context.
  91     explicit CommandLineHelpContext(const CommandLineHelpContext& other);
  92     //! Moves the context.
  93     CommandLineHelpContext(CommandLineHelpContext&& other) noexcept;
  94     //! Move-assigns the context.
  95     CommandLineHelpContext& operator=(CommandLineHelpContext&& other) noexcept;
  96     ~CommandLineHelpContext();
  97
  98     /*! \brief
  99      * Sets a display name for the module for which help is being written.
 100      *
 101      * \throws std::bad_alloc if out of memory.
 102      */
 103     void setModuleDisplayName(const std::string& name);
 104     //! Sets whether hidden options should be shown in help output.
 105     void setShowHidden(bool bHidden);
 106     //! \copydoc HelpWriterContext::enterSubSection()
 107     void enterSubSection(const std::string& title);
 108
 109     //! Returns the lower-level context for writing the help.
 110     const HelpWriterContext& writerContext() const;
 111     /*! \brief
 112      * Returns a display name for the module for which help is being written.
 113      *
 114      * Does not throw.
 115      */
 116     const char* moduleDisplayName() const;
 117     //! Returns whether hidden options should be shown in help output.
 118     bool showHidden() const;
 119     //! Returns whether this context is for exporting shell completions.
 120     bool isCompletionExport() const;
 121     /*! \brief
 122      * Returns the shell completion writer for this context.
 123      *
 124      * Can only be called if isCompletionExport() returns `true`.
 125      */
 126     ShellCompletionWriter& shellCompletionWriter() const;
 127
 128 private:
 129     class Impl;
 130
 131     std::unique_ptr<Impl> impl_;
 132
 133     GMX_DISALLOW_ASSIGN(CommandLineHelpContext);
 134 };
 135
 136 /*! \libinternal \brief
 137  * Helper for passing CommandLineHelpContext into parse_common_args().
 138  *
 139  * This class provides a mechanism to set and retrieve a global
 140  * CommandLineHelpContext object.  It is used to pass this object into
 141  * parse_common_args() from CommandLineModuleManager::runAsMainCMain() through
 142  * the main() function that is not aware of the wrapper binary mechanism.
 143  * It is not thread-safe because in this limited use case, it is always called
 144  * from a single-threaded context.
 145  *
 146  * \inlibraryapi
 147  * \ingroup module_onlinehelp
 148  */
 149 class GlobalCommandLineHelpContext
 150 {
 151 public:
 152     //! Returns the global context, or NULL if not set.
 153     static const CommandLineHelpContext* get();
 154
 155     /*! \brief
 156      * Sets the global context for the scope.
 157      *
 158      * The global context is cleared when this object goes out of scope.
 159      *
 160      * It is an error to have more than one GlobalCommandLineHelpContext
 161      * object in existence at the same time.
 162      */
 163     explicit GlobalCommandLineHelpContext(const CommandLineHelpContext& context);
 164     //! Clears the global context.
 165     ~GlobalCommandLineHelpContext();
 166 };
 167
 168 } // namespace gmx
 169
 170 #endif