Functions
KICOMMON_API bool	IsEnvVarImmutable (const wxString &aEnvVar)
	Determine if an environment variable is "predefined", i.e.

KICOMMON_API const std::vector< wxString > &	GetPredefinedEnvVars ()
	Get the list of pre-defined environment variables.

KICOMMON_API void	GetEnvVarAutocompleteTokens (wxArrayString *aVars)
	Return autocomplete tokens for environment variables for Scintilla.

KICOMMON_API wxString	GetVersionedEnvVarName (const wxString &aBaseName)
	Construct a versioned environment variable based on this KiCad major version.

KICOMMON_API std::optional< wxString >	GetVersionedEnvVarValue (const std::map< wxString, ENV_VAR_ITEM > &aMap, const wxString &aBaseName)
	Attempt to retrieve the value of a versioned environment variable, such as KICAD8_TEMPLATE_DIR.

KICOMMON_API wxString	LookUpEnvVarHelp (const wxString &aEnvVar)
	Look up long-form help text for a given environment variable.

template<typename VAL_TYPE >
KICOMMON_API std::optional< VAL_TYPE >	GetEnvVar (const wxString &aEnvVarName)
	Get an environment variable as a specific type, if set correctly.

template<>
KICOMMON_API std::optional< wxString >	GetEnvVar (const wxString &aEnvVarName)
	Get a string environment variable, if it is set.

template<>
KICOMMON_API std::optional< double >	GetEnvVar (const wxString &aEnvVarName)
	Get a double from an environment variable, if set.

Function Documentation

◆ GetEnvVar() [1/3]

template<typename VAL_TYPE >

KICOMMON_API std::optional< VAL_TYPE > ENV_VAR::GetEnvVar ( const wxString & aEnvVarName )

Get an environment variable as a specific type, if set correctly.

Parameters

aEnvVarName the name of the environment variable.

Returns: an std::optional containing the value, if set and parseable, otherwise empty.

◆ GetEnvVar() [2/3]

template<>

std::optional< wxString > ENV_VAR::GetEnvVar ( const wxString & aEnvVarName )

Get a string environment variable, if it is set.

Parameters

aEnvVarName the name of the environment variable

Returns: an std::optional containing the value, if set, otherwise empty.

Definition at line 170 of file env_vars.cpp.

◆ GetEnvVar() [3/3]

template<>

KICOMMON_API std::optional< double > ENV_VAR::GetEnvVar ( const wxString & aEnvVarName )

Get a double from an environment variable, if set.

Parameters

aEnvVarName the name of the environment variable

Returns: an std::optional containing the value, if set and parseable as a double, otherwise empty.

◆ GetEnvVarAutocompleteTokens()

void ENV_VAR::GetEnvVarAutocompleteTokens ( wxArrayString * aVars )

Return autocomplete tokens for environment variables for Scintilla.

Definition at line 73 of file env_vars.cpp.

References alg::contains(), and GetPredefinedEnvVars().

Referenced by DIALOG_EXECUTECOMMAND_JOB_SETTINGS::DIALOG_EXECUTECOMMAND_JOB_SETTINGS().

◆ GetPredefinedEnvVars()

const std::vector< wxString > & ENV_VAR::GetPredefinedEnvVars ( )

Get the list of pre-defined environment variables.

Definition at line 67 of file env_vars.cpp.

References predefinedEnvVars.

Referenced by GetEnvVarAutocompleteTokens(), KIwxExpandEnvVars(), and DIALOG_CONFIGURE_PATHS::OnHelp().

◆ GetVersionedEnvVarName()

wxString ENV_VAR::GetVersionedEnvVarName ( const wxString & aBaseName )

Construct a versioned environment variable based on this KiCad major version.

Parameters

aBaseName is the suffix, like TEMPLATE_DIR.

Returns: an environment variable name, like KICAD8_TEMPLATE_DIR.

Definition at line 83 of file env_vars.cpp.

References GetMajorMinorPatchTuple().

Referenced by FILENAME_RESOLVER::addPath(), FILENAME_RESOLVER::GetKicadPaths(), GetVersionedEnvVarValue(), SYMBOL_LIB_TABLE::GlobalPathEnvVariableName(), DESIGN_BLOCK_LIB_TABLE::GlobalPathEnvVariableName(), FP_LIB_TABLE::GlobalPathEnvVariableName(), initialiseEnvVarHelp(), COMMON_SETTINGS::InitializeEnvironment(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), PCM_DESIGN_BLOCK_LIB_TRAVERSER::OnDir(), PCM_FP_LIB_TRAVERSER::OnDir(), PCM_SYM_LIB_TRAVERSER::OnFile(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_DESIGN_BLOCK_LIB_TABLE::populateEnvironReadOnlyTable(), PANEL_FP_LIB_TABLE::populateEnvironReadOnlyTable(), COMMON_SETTINGS::readLegacy3DResolverCfg(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), and FILENAME_RESOLVER::ResolvePath().

◆ GetVersionedEnvVarValue()

std::optional< wxString > ENV_VAR::GetVersionedEnvVarValue	(	const std::map< wxString, ENV_VAR_ITEM > &	aMap,
		const wxString &	aBaseName
	)

Attempt to retrieve the value of a versioned environment variable, such as KICAD8_TEMPLATE_DIR.

If this value exists in the map, it will be returned. If not, the map will be searched for keys matching KICAD*_<aBaseName>, and the first match's value will be returned. If there are no matches, std::nullopt will be returned.

Parameters