src/gromacs/commandline/cmdlinehelpcontext.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, 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 "gmxpre.h"
  43
  44 #include "cmdlinehelpcontext.h"
  45
  46 #include "gromacs/commandline/shellcompletions.h"
  47 #include "gromacs/utility/gmxassert.h"
  48
  49 namespace gmx
  50 {
  51
  52 namespace
  53 {
  54
  55 /*! \brief
  56  * Stores the global context set with GlobalCommandLineHelpContext.
  57  *
  58  * This is not protected by a mutex, since it is only used in command-line
  59  * start-up (i.e., single-threaded context), and is inherently not thread-safe.
  60  *
  61  * \ingroup module_commandline
  62  */
  63 const CommandLineHelpContext *g_globalContext = NULL;
  64
  65 }   // namespace
  66
  67 /*! \internal \brief
  68  * Private implementation class for CommandLineHelpContext.
  69  *
  70  * \ingroup module_commandline
  71  */
  72 class CommandLineHelpContext::Impl
  73 {
  74     public:
  75         //! Creates the implementation class and the low-level context.
  76         Impl(File *file, HelpOutputFormat format, const HelpLinks *links)
  77             : writerContext_(file, format, links), moduleDisplayName_("gmx"),
  78               completionWriter_(NULL), bHidden_(false)
  79         {
  80         }
  81         //! Creates an implementation class from a low-level context.
  82         explicit Impl(const HelpWriterContext &writerContext)
  83             : writerContext_(writerContext),
  84               completionWriter_(NULL), bHidden_(false)
  85         {
  86         }
  87
  88         //! Wrapped lower-level context.
  89         HelpWriterContext      writerContext_;
  90         //! Display name for the module for which help is written.
  91         std::string            moduleDisplayName_;
  92         //! Shell completion writer (`NULL` if not doing completions).
  93         ShellCompletionWriter *completionWriter_;
  94         //! Whether hidden options should be shown in help output.
  95         bool                   bHidden_;
  96 };
  97
  98 CommandLineHelpContext::CommandLineHelpContext(
  99         File *file, HelpOutputFormat format, const HelpLinks *links)
 100     : impl_(new Impl(file, format, links))
 101 {
 102 }
 103
 104 CommandLineHelpContext::CommandLineHelpContext(
 105         const HelpWriterContext &writerContext)
 106     : impl_(new Impl(writerContext))
 107 {
 108 }
 109
 110 CommandLineHelpContext::CommandLineHelpContext(
 111         ShellCompletionWriter *writer)
 112     : impl_(new Impl(writer->outputFile(), eHelpOutputFormat_Other, NULL))
 113 {
 114     impl_->completionWriter_ = writer;
 115 }
 116
 117 CommandLineHelpContext::CommandLineHelpContext(
 118         const CommandLineHelpContext &other)
 119     : impl_(new Impl(*other.impl_))
 120 {
 121 }
 122
 123 CommandLineHelpContext::~CommandLineHelpContext()
 124 {
 125 }
 126
 127 void CommandLineHelpContext::setModuleDisplayName(const std::string &name)
 128 {
 129     impl_->writerContext_.setReplacement("[THISMODULE]", "[TT]" + name + "[tt]");
 130     impl_->moduleDisplayName_ = name;
 131 }
 132
 133 void CommandLineHelpContext::setShowHidden(bool bHidden)
 134 {
 135     impl_->bHidden_ = bHidden;
 136 }
 137
 138 const HelpWriterContext &CommandLineHelpContext::writerContext() const
 139 {
 140     return impl_->writerContext_;
 141 }
 142
 143 const char *CommandLineHelpContext::moduleDisplayName() const
 144 {
 145     return impl_->moduleDisplayName_.c_str();
 146 }
 147
 148 bool CommandLineHelpContext::showHidden() const
 149 {
 150     return impl_->bHidden_;
 151 }
 152
 153 bool CommandLineHelpContext::isCompletionExport() const
 154 {
 155     return impl_->completionWriter_ != NULL;
 156 }
 157
 158 ShellCompletionWriter &CommandLineHelpContext::shellCompletionWriter() const
 159 {
 160     GMX_RELEASE_ASSERT(isCompletionExport(),
 161                        "Invalid call when not writing shell completions");
 162     return *impl_->completionWriter_;
 163 }
 164
 165 /********************************************************************
 166  * GlobalCommandLineHelpContext
 167  */
 168
 169 // static
 170 const CommandLineHelpContext *GlobalCommandLineHelpContext::get()
 171 {
 172     return g_globalContext;
 173 }
 174
 175 GlobalCommandLineHelpContext::GlobalCommandLineHelpContext(
 176         const CommandLineHelpContext &context)
 177 {
 178     GMX_RELEASE_ASSERT(g_globalContext == NULL,
 179                        "Global context set more than once");
 180     g_globalContext = &context;
 181 }
 182
 183 GlobalCommandLineHelpContext::~GlobalCommandLineHelpContext()
 184 {
 185     g_globalContext = NULL;
 186 }
 187
 188 } // namespace gmx