env_var_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <optional>
 
#include <wx/string.h>
 
#include <settings/environment.h>
 
 
namespace KI_TEST
{
class SCOPED_PROCESS_ENV_VAR
{
public:
    SCOPED_PROCESS_ENV_VAR( const wxString& aName, const std::optional<wxString>& aValue );
    ~SCOPED_PROCESS_ENV_VAR();
 
    // No copying, or the destructor will restore multiple times.
    SCOPED_PROCESS_ENV_VAR( const SCOPED_PROCESS_ENV_VAR& ) = delete;
    SCOPED_PROCESS_ENV_VAR& operator=( const SCOPED_PROCESS_ENV_VAR& ) = delete;

    void SetValue( const wxString& aValue );

    std::optional<wxString> GetValue() const;

    void ClearValue();
 
private:
    wxString                m_name;
    std::optional<wxString> m_oldValue;
};
 

class SCOPED_PGM_ENV_VAR
{
public:
    SCOPED_PGM_ENV_VAR( const wxString& aName, const std::optional<wxString>& aValue );
    ~SCOPED_PGM_ENV_VAR();
 
    // No copying, or the destructor will restore multiple times.
    SCOPED_PGM_ENV_VAR( const SCOPED_PGM_ENV_VAR& ) = delete;
    SCOPED_PGM_ENV_VAR& operator=( const SCOPED_PGM_ENV_VAR& ) = delete;

    ENV_VAR_ITEM&       GetItem();
    const ENV_VAR_ITEM& GetItem() const;

    void ClearItem() { m_pgmEnvVars.erase( m_name ); }
 
private:
    ENV_VAR_MAP&                m_pgmEnvVars;
    wxString                    m_name;
    std::optional<ENV_VAR_ITEM> m_oldValue;
};
 
} // namespace KI_TEST