kicad/common/env_vars.cpp

150 lines
4.5 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2018-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/>.
*/
#include <env_vars.h>
#include <map>
2020-10-24 00:50:09 +00:00
#include <wx/translation.h>
#include <wx/utils.h>
using STRING_MAP = std::map<wxString, wxString>;
/*
* List of pre-defined environment variables
*
* TODO - Instead of defining these values here,
* extract them from elsewhere in the program
* (where they are originally defined)
*/
2021-06-22 00:35:11 +00:00
static const ENV_VAR::ENV_VAR_LIST predefinedEnvVars = {
2023-01-17 12:42:30 +00:00
wxS( "KIPRJMOD" ),
2023-01-22 18:38:02 +00:00
wxS( "KICAD7_SYMBOL_DIR" ),
wxS( "KICAD7_3DMODEL_DIR" ),
wxS( "KICAD7_FOOTPRINT_DIR" ),
wxS( "KICAD7_TEMPLATE_DIR" ),
2023-01-17 12:42:30 +00:00
wxS( "KICAD_USER_TEMPLATE_DIR" ),
wxS( "KICAD_PTEMPLATES" ),
2023-01-22 18:38:02 +00:00
wxS( "KICAD7_3RD_PARTY" ),
};
2021-06-22 00:35:11 +00:00
bool ENV_VAR::IsEnvVarImmutable( const wxString& aEnvVar )
{
2022-07-29 21:02:35 +00:00
for( const wxString& s : predefinedEnvVars )
{
if( s == aEnvVar )
return true;
}
return false;
}
2021-06-22 00:35:11 +00:00
const ENV_VAR::ENV_VAR_LIST& ENV_VAR::GetPredefinedEnvVars()
{
2021-06-22 00:35:11 +00:00
return predefinedEnvVars;
}
2021-06-22 00:35:11 +00:00
static void initialiseEnvVarHelp( STRING_MAP& aMap )
{
// Set up dynamically, as we want to be able to use _() translations,
// which can't be done statically
2023-01-22 18:38:02 +00:00
aMap[wxS( "KICAD7_FOOTPRINT_DIR" )] =
_( "The base path of locally installed system "
"footprint libraries (.pretty folders).");
2023-01-22 18:38:02 +00:00
aMap[wxS( "KICAD7_3DMODEL_DIR" )] =
_( "The base path of system footprint 3D shapes (.3Dshapes folders).");
2023-01-22 18:38:02 +00:00
aMap[wxS( "KICAD7_SYMBOL_DIR" )] =
_( "The base path of the locally installed symbol libraries.");
2023-01-22 18:38:02 +00:00
aMap[wxS( "KICAD7_TEMPLATE_DIR" )] =
_( "A directory containing project templates installed with KiCad.");
2023-01-17 12:42:30 +00:00
aMap[wxS( "KICAD_USER_TEMPLATE_DIR" )] =
_( "Optional. Can be defined if you want to create your own project "
"templates folder.");
2023-01-22 18:38:02 +00:00
aMap[wxS( "KICAD7_3RD_PARTY" )] =
2020-12-08 18:39:45 +00:00
_( "A directory containing 3rd party plugins, libraries and other "
"downloadable content.");
2023-01-17 12:42:30 +00:00
aMap[wxS( "KIPRJMOD" )] =
_("Internally defined by KiCad (cannot be edited) and is set "
"to the absolute path of the currently loaded project file. This environment "
"variable can be used to define files and paths relative to the currently loaded "
"project. For instance, ${KIPRJMOD}/libs/footprints.pretty can be defined as a "
"folder containing a project specific footprint library named footprints.pretty." );
2023-01-22 18:38:02 +00:00
aMap[wxS( "KICAD7_SCRIPTING_DIR" )] =
_( "A directory containing system-wide scripts installed with KiCad" );
2023-01-22 18:38:02 +00:00
aMap[wxS( "KICAD7_USER_SCRIPTING_DIR" )] =
_( "A directory containing user-specific scripts installed with KiCad" );
// Deprecated vars
2023-01-17 12:42:30 +00:00
aMap[wxS( "KICAD_PTEMPLATES" )] =
_( "Deprecated version of KICAD_TEMPLATE_DIR.");
2023-01-17 12:42:30 +00:00
aMap[wxS( "KISYS3DMOD" )] =
2023-01-22 18:38:02 +00:00
_( "Deprecated version of KICAD7_3DMODEL_DIR." );
2023-01-17 12:42:30 +00:00
aMap[wxS( "KISYSMOD" )] =
2023-01-22 18:38:02 +00:00
_( "Deprecated version of KICAD7_FOOTPRINT_DIR." );
2023-01-17 12:42:30 +00:00
aMap[wxS( "KICAD_SYMBOL_DIR" )] =
_( "Deprecated version of KICAD_SYMBOL_DIR.");
}
2021-06-22 00:35:11 +00:00
wxString ENV_VAR::LookUpEnvVarHelp( const wxString& aEnvVar )
{
2021-06-22 00:35:11 +00:00
static STRING_MAP envVarHelpText;
2021-06-22 00:35:11 +00:00
if( envVarHelpText.size() == 0 )
initialiseEnvVarHelp( envVarHelpText );
2021-06-22 00:35:11 +00:00
return envVarHelpText[ aEnvVar ];
}
template<>
std::optional<double> ENV_VAR::GetEnvVar( const wxString& aEnvVarName )
{
wxString env;
if( wxGetEnv( aEnvVarName, &env ) )
{
double value;
if( env.ToDouble( &value ) )
2021-07-06 17:32:34 +00:00
return value;
}
return std::nullopt;
}
template<>
std::optional<wxString> ENV_VAR::GetEnvVar( const wxString& aEnvVarName )
{
std::optional<wxString> optValue;
wxString env;
if( wxGetEnv( aEnvVarName, &env ) )
{
2021-06-22 00:35:11 +00:00
optValue = env;
}
2021-06-22 00:35:11 +00:00
return optValue;
}