src/gromacs/commandline/cmdlinehelpcontext.cpp

   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 /*! \internal \file
  36  * \brief
  37  * Implements gmx::CommandLineHelpContext.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_commandline
  41  */
  42 #include "cmdlinehelpcontext.h"
  43
  44 #include "gromacs/utility/gmxassert.h"
  45
  46 namespace gmx
  47 {
  48
  49 namespace
  50 {
  51
  52 /*! \brief
  53  * Stores the global context set with GlobalCommandLineHelpContext.
  54  *
  55  * This is not protected by a mutex, since it is only used in command-line
  56  * start-up (i.e., single-threaded context), and is inherently not thread-safe.
  57  *
  58  * \ingroup module_commandline
  59  */
  60 const CommandLineHelpContext *g_globalContext = NULL;
  61
  62 }   // namespace
  63
  64 /*! \internal \brief
  65  * Private implementation class for CommandLineHelpContext.
  66  *
  67  * \ingroup module_commandline
  68  */
  69 class CommandLineHelpContext::Impl
  70 {
  71     public:
  72         //! Creates the implementation class and the low-level context.
  73         Impl(File *file, HelpOutputFormat format, const HelpLinks *links)
  74             : writerContext_(file, format, links), moduleDisplayName_("gmx"),
  75               bHidden_(false)
  76         {
  77         }
  78
  79         //! Wrapped lower-level context.
  80         HelpWriterContext  writerContext_;
  81         //! Display name for the module for which help is written.
  82         std::string        moduleDisplayName_;
  83         //! Whether hidden options should be shown in help output.
  84         bool               bHidden_;
  85 };
  86
  87 CommandLineHelpContext::CommandLineHelpContext(
  88         File *file, HelpOutputFormat format, const HelpLinks *links)
  89     : impl_(new Impl(file, format, links))
  90 {
  91 }
  92
  93 CommandLineHelpContext::~CommandLineHelpContext()
  94 {
  95 }
  96
  97 void CommandLineHelpContext::setModuleDisplayName(const std::string &name)
  98 {
  99     impl_->moduleDisplayName_ = name;
 100 }
 101
 102 void CommandLineHelpContext::setShowHidden(bool bHidden)
 103 {
 104     impl_->bHidden_ = bHidden;
 105 }
 106
 107 const HelpWriterContext &CommandLineHelpContext::writerContext() const
 108 {
 109     return impl_->writerContext_;
 110 }
 111
 112 const char *CommandLineHelpContext::moduleDisplayName() const
 113 {
 114     return impl_->moduleDisplayName_.c_str();
 115 }
 116
 117 bool CommandLineHelpContext::showHidden() const
 118 {
 119     return impl_->bHidden_;
 120 }
 121
 122 /********************************************************************
 123  * GlobalCommandLineHelpContext
 124  */
 125
 126 // static
 127 const CommandLineHelpContext *GlobalCommandLineHelpContext::get()
 128 {
 129     return g_globalContext;
 130 }
 131
 132 GlobalCommandLineHelpContext::GlobalCommandLineHelpContext(
 133         const CommandLineHelpContext &context)
 134 {
 135     GMX_RELEASE_ASSERT(g_globalContext == NULL,
 136                        "Global context set more than once");
 137     g_globalContext = &context;
 138 }
 139
 140 GlobalCommandLineHelpContext::~GlobalCommandLineHelpContext()
 141 {
 142     g_globalContext = NULL;
 143 }
 144
 145 } // namespace gmx