src/gromacs/utility/programcontext.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::IProgramContext and related methods.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "programcontext.h"
  45
  46 #include <cstddef>
  47
  48 namespace gmx
  49 {
  50
  51 namespace
  52 {
  53
  54 //! \addtogroup module_utility
  55 //! \{
  56
  57 /*! \brief
  58  * Default implementation of IProgramContext.
  59  *
  60  * This implementation is used if nothing has been set with
  61  * setProgramContext().
  62  *
  63  * Since it is constructed using a global initializer, it should not throw.
  64  */
  65 class DefaultProgramContext : public IProgramContext
  66 {
  67     public:
  68         DefaultProgramContext() {}
  69
  70         const char *programName() const override { return "GROMACS"; }
  71         const char *displayName() const override { return "GROMACS"; }
  72         const char *fullBinaryPath() const override { return ""; }
  73         InstallationPrefixInfo installationPrefix() const override
  74         {
  75             return InstallationPrefixInfo("", false);
  76         }
  77         const char *commandLine() const override { return ""; }
  78 };
  79
  80 //! Global program info; stores the object set with setProgramContext().
  81 const IProgramContext         *g_programContext;
  82 //! Default program context if nothing is set.
  83 const DefaultProgramContext    g_defaultContext;
  84
  85 //! \}
  86
  87 }   // namespace
  88
  89 const IProgramContext &getProgramContext()
  90 {
  91     if (g_programContext != nullptr)
  92     {
  93         return *g_programContext;
  94     }
  95     return g_defaultContext;
  96 }
  97
  98 void setProgramContext(const IProgramContext *programContext)
  99 {
 100     g_programContext = programContext;
 101 }
 102
 103 } // namespace gmx