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/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 = NULL;
  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(File *file, HelpOutputFormat format, const HelpLinks *links)
  78             : writerContext_(file, format, links), moduleDisplayName_("gmx"),
  79               completionWriter_(NULL), bHidden_(false)
  80         {
  81         }
  82         //! Creates an implementation class from a low-level context.
  83         explicit Impl(const HelpWriterContext &writerContext)
  84             : writerContext_(writerContext),
  85               completionWriter_(NULL), bHidden_(false)
  86         {
  87         }
  88
  89         //! Wrapped lower-level context.
  90         HelpWriterContext      writerContext_;
  91         //! Display name for the module for which help is written.
  92         std::string            moduleDisplayName_;
  93         //! Shell completion writer (`NULL` if not doing completions).
  94         ShellCompletionWriter *completionWriter_;
  95         //! Whether hidden options should be shown in help output.
  96         bool                   bHidden_;
  97 };
  98
  99 CommandLineHelpContext::CommandLineHelpContext(
 100         File *file, HelpOutputFormat format, const HelpLinks *links)
 101     : impl_(new Impl(file, format, links))
 102 {
 103 }
 104
 105 CommandLineHelpContext::CommandLineHelpContext(
 106         const HelpWriterContext &writerContext)
 107     : impl_(new Impl(writerContext))
 108 {
 109 }
 110
 111 CommandLineHelpContext::CommandLineHelpContext(
 112         ShellCompletionWriter *writer)
 113     : impl_(new Impl(writer->outputFile(), eHelpOutputFormat_Other, NULL))
 114 {
 115     impl_->completionWriter_ = writer;
 116 }
 117
 118 CommandLineHelpContext::CommandLineHelpContext(
 119         const CommandLineHelpContext &other)
 120     : impl_(new Impl(*other.impl_))
 121 {
 122 }
 123
 124 CommandLineHelpContext::~CommandLineHelpContext()
 125 {
 126 }
 127
 128 void CommandLineHelpContext::setModuleDisplayName(const std::string &name)
 129 {
 130     impl_->writerContext_.setReplacement("[THISMODULE]", "[TT]" + name + "[tt]");
 131     impl_->moduleDisplayName_ = name;
 132 }
 133
 134 void CommandLineHelpContext::setShowHidden(bool bHidden)
 135 {
 136     impl_->bHidden_ = bHidden;
 137 }
 138
 139 const HelpWriterContext &CommandLineHelpContext::writerContext() const
 140 {
 141     return impl_->writerContext_;
 142 }
 143
 144 const char *CommandLineHelpContext::moduleDisplayName() const
 145 {
 146     return impl_->moduleDisplayName_.c_str();
 147 }
 148
 149 bool CommandLineHelpContext::showHidden() const
 150 {
 151     return impl_->bHidden_;
 152 }
 153
 154 bool CommandLineHelpContext::isCompletionExport() const
 155 {
 156     return impl_->completionWriter_ != NULL;
 157 }
 158
 159 ShellCompletionWriter &CommandLineHelpContext::shellCompletionWriter() const
 160 {
 161     GMX_RELEASE_ASSERT(isCompletionExport(),
 162                        "Invalid call when not writing shell completions");
 163     return *impl_->completionWriter_;
 164 }
 165
 166 /********************************************************************
 167  * GlobalCommandLineHelpContext
 168  */
 169
 170 // static
 171 const CommandLineHelpContext *GlobalCommandLineHelpContext::get()
 172 {
 173     return g_globalContext;
 174 }
 175
 176 GlobalCommandLineHelpContext::GlobalCommandLineHelpContext(
 177         const CommandLineHelpContext &context)
 178 {
 179     GMX_RELEASE_ASSERT(g_globalContext == NULL,
 180                        "Global context set more than once");
 181     g_globalContext = &context;
 182 }
 183
 184 GlobalCommandLineHelpContext::~GlobalCommandLineHelpContext()
 185 {
 186     g_globalContext = NULL;
 187 }
 188
 189 } // namespace gmx