include/settings/environment.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 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 3 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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_ENVIRONMENT_H
#define KICAD_ENVIRONMENT_H
 
#include <map>
#include <wx/string.h>
 
class ENV_VAR_ITEM
{
public:
    ENV_VAR_ITEM( const wxString& aValue = wxEmptyString, bool aIsDefinedExternally = false ) :
            m_value( aValue ),
            m_isBuiltin( true ),
            m_isDefinedExternally( aIsDefinedExternally ),
            m_isDefinedInSettings( false )
    {
    }
 
    ENV_VAR_ITEM( const wxString& aKey, const wxString& aValue,
                  const wxString& aDefaultValue = wxEmptyString ) :
            m_key( aKey ),
            m_value( aValue ),
            m_defaultValue( aDefaultValue ),
            m_isBuiltin( true ),
            m_isDefinedExternally( false ),
            m_isDefinedInSettings( false )
    {
    }
 
    ~ENV_VAR_ITEM() throw() {}    // tell SWIG no exception
 
    bool GetDefinedExternally() const { return m_isDefinedExternally; }
    void SetDefinedExternally( bool aIsDefinedExternally = true )
    {
        m_isDefinedExternally = aIsDefinedExternally;
    }
 
    bool GetDefinedInSettings() const { return m_isDefinedInSettings; }
    void SetDefinedInSettings( bool aDefined = true ) { m_isDefinedInSettings = aDefined; }
 
    wxString GetKey() const { return m_key; }
 
    const wxString& GetValue() const { return m_value; }
    void SetValue( const wxString& aValue ) { m_value = aValue; }
 
    wxString GetDefault() const { return m_defaultValue; }
 
    wxString GetSettingsValue() const { return m_settingsValue; }
    void SetSettingsValue( const wxString& aValue ) { m_settingsValue = aValue; }
 
    bool GetBuiltin() const { return m_isBuiltin; }
 
    bool IsDefault() const
    {
        return m_isBuiltin && m_value == m_defaultValue;
    }
 
private:
    wxString m_key;
 
    wxString m_value;
 
    wxString m_defaultValue;
 
    wxString m_settingsValue;
 
    bool m_isBuiltin;
 
    bool m_isDefinedExternally;
 
    bool m_isDefinedInSettings;
};
 
typedef std::map<wxString, ENV_VAR_ITEM>                 ENV_VAR_MAP;
typedef std::map<wxString, ENV_VAR_ITEM>::iterator       ENV_VAR_MAP_ITER;
typedef std::map<wxString, ENV_VAR_ITEM>::const_iterator ENV_VAR_MAP_CITER;
 
#endif // KICAD_ENVIRONMENT_H