src/testutils/setenv.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, 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 /*! \libinternal \file
  36  * \brief
  37  * Helper functions to have identical behavior of setenv and unsetenv
  38  * on Unix and Windows systems.
  39  *
  40  * \author Pascal Merz <pascal.merz@me.com>
  41  * \inlibraryapi
  42  * \ingroup module_testutils
  43  */
  44
  45 #include "config.h"
  46
  47 #include <cstdlib>
  48
  49 #ifndef GMX_TESTUTILS_SETENV_H
  50 #    define GMX_TESTUTILS_SETENV_H
  51
  52 namespace gmx
  53 {
  54 namespace test
  55 {
  56 //! Workaround to make setenv work on Windows
  57 inline int gmxSetenv(const char* name, const char* value, int overwrite)
  58 {
  59 #    if GMX_NATIVE_WINDOWS
  60     if (!overwrite)
  61     {
  62         size_t size  = 0;
  63         int    error = getenv_s(&size, nullptr, 0, name);
  64         if (error != 0 || size != 0)
  65         {
  66             return error;
  67         }
  68     }
  69     return _putenv_s(name, value);
  70 #    else
  71     return setenv(name, value, overwrite);
  72 #    endif
  73 }
  74
  75 //! Workaround to make unsetenv work on Windows
  76 inline int gmxUnsetenv(const char* name)
  77 {
  78 #    if GMX_NATIVE_WINDOWS
  79     return _putenv_s(name, "");
  80 #    else
  81     return unsetenv(name);
  82 #    endif
  83 }
  84 } // namespace test
  85 } // namespace gmx
  86
  87 #endif // GMX_TESTUTILS_SETENV_H