Environment.h 3.9 KB
Newer Older
fogal1's avatar
fogal1 committed
1 2
/*****************************************************************************
*
bonnell's avatar
bonnell committed
3
* Copyright (c) 2000 - 2015, Lawrence Livermore National Security, LLC
fogal1's avatar
fogal1 committed
4
* Produced at the Lawrence Livermore National Laboratory
brugger's avatar
 
brugger committed
5
* LLNL-CODE-442911
fogal1's avatar
fogal1 committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
* All rights reserved.
*
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
* SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
* CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
* LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
* OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/

// ************************************************************************* //
//                              Environment.h                                //
// ************************************************************************* //
#ifndef ENV_H
#define ENV_H
44
#include <misc_exports.h>
fogal1's avatar
fogal1 committed
45 46 47

#include <string>

fogal1's avatar
fogal1 committed
48 49
namespace Environment
{
fogal1's avatar
fogal1 committed
50
    // ***********************************************************************
fogal1's avatar
fogal1 committed
51 52 53 54 55 56
    //  Function: Environment::get
    //
    //  Purpose:  Obtains a value from the environment.
    //
    //  Programmer: Tom Fogal
    //
fogal1's avatar
fogal1 committed
57
    // ***********************************************************************
58
    std::string MISC_API get(const char *);
fogal1's avatar
fogal1 committed
59

fogal1's avatar
fogal1 committed
60
    // ***********************************************************************
fogal1's avatar
fogal1 committed
61 62 63 64 65 66
    //  Function: Environment::get
    //
    //  Purpose: Predicate to determine whether a variable is defined.
    //
    //  Programmer: Tom Fogal
    //
fogal1's avatar
fogal1 committed
67
    // ***********************************************************************
68
    bool MISC_API exists(const char *);
fogal1's avatar
fogal1 committed
69

fogal1's avatar
fogal1 committed
70
    // ***********************************************************************
fogal1's avatar
fogal1 committed
71 72 73 74 75 76 77
    //  Function: Environment::set
    //
    //  Purpose: Sets a value in the enviroment.  Avoid using putenv, since it
    //           requires static memory.
    //
    //  Programmer: Tom Fogal
    //
fogal1's avatar
fogal1 committed
78
    // ***********************************************************************
79
    void MISC_API set(const char *k, const char *v);
fogal1's avatar
fogal1 committed
80

fogal1's avatar
fogal1 committed
81
    // ***********************************************************************
fogal1's avatar
fogal1 committed
82 83 84 85 86 87
    //  Function: Environment::unset
    //
    //  Purpose: Removes a variable definition from the environment.
    //
    //  Programmer: Tom Fogal
    //
fogal1's avatar
fogal1 committed
88
    // ***********************************************************************
89
    void MISC_API unset(const char *);
fogal1's avatar
fogal1 committed
90 91
};
#endif