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.
   5  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Implements gmx::IProgramContext and related methods.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_utility
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "programcontext.h"
  46
  47 #include <cstddef>
  48
  49 namespace gmx
  50 {
  51
  52 namespace
  53 {
  54
  55 //! \addtogroup module_utility
  56 //! \{
  57
  58 /*! \brief
  59  * Default implementation of IProgramContext.
  60  *
  61  * This implementation is used if nothing has been set with
  62  * setProgramContext().
  63  *
  64  * Since it is constructed using a global initializer, it should not throw.
  65  */
  66 class DefaultProgramContext : public IProgramContext
  67 {
  68 public:
  69     DefaultProgramContext() {}
  70
  71     const char*            programName() const override { return "GROMACS"; }
  72     const char*            displayName() const override { return "GROMACS"; }
  73     const char*            fullBinaryPath() const override { return ""; }
  74     InstallationPrefixInfo installationPrefix() const override
  75     {
  76         return InstallationPrefixInfo("", false);
  77     }
  78     const char* commandLine() const override { return ""; }
  79 };
  80
  81 //! Global program info; stores the object set with setProgramContext().
  82 // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
  83 const IProgramContext* g_programContext;
  84 //! Default program context if nothing is set.
  85 const DefaultProgramContext g_defaultContext;
  86
  87 //! \}
  88
  89 } // namespace
  90
  91 const IProgramContext& getProgramContext()
  92 {
  93     if (g_programContext != nullptr)
  94     {
  95         return *g_programContext;
  96     }
  97     return g_defaultContext;
  98 }
  99
 100 void setProgramContext(const IProgramContext* programContext)
 101 {
 102     g_programContext = programContext;
 103 }
 104
 105 } // namespace gmx