src/gromacs/commandline/cmdlinehelpcontext.cpp

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