env_vars.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 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 ENV_VARS_H
#define ENV_VARS_H
 
#include <kicommon.h>
#include <wx/string.h>
#include <wx/arrstr.h>
#include <map>
#include <vector>
#include <optional>
 
class ENV_VAR_ITEM;
 
namespace ENV_VAR
{
    KICOMMON_API bool IsEnvVarImmutable( const wxString& aEnvVar );
 
    KICOMMON_API const std::vector<wxString>& GetPredefinedEnvVars();
 
    KICOMMON_API void GetEnvVarAutocompleteTokens( wxArrayString* aVars );
 
    KICOMMON_API wxString GetVersionedEnvVarName( const wxString& aBaseName );
 
    KICOMMON_API std::optional<wxString>
                 GetVersionedEnvVarValue( const std::map<wxString, ENV_VAR_ITEM>& aMap,
                                          const wxString&                         aBaseName );
 
    KICOMMON_API wxString LookUpEnvVarHelp( const wxString& aEnvVar );
 
    template <typename VAL_TYPE>
    KICOMMON_API std::optional<VAL_TYPE> GetEnvVar( const wxString& aEnvVarName );
 
    template<>
    KICOMMON_API std::optional<wxString> GetEnvVar( const wxString& aEnvVarName );
 
    template <>
    KICOMMON_API std::optional<double> GetEnvVar( const wxString& aEnvVarName );
};
 
#endif /* ENV_VARS_H */