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