ENV_VAR Namespace Reference

Typedefs
using	ENV_VAR_LIST = std::vector< wxString >

Functions
bool	IsEnvVarImmutable (const wxString &aEnvVar)
	Determine if an environment variable is "predefined", i.e. More...
const ENV_VAR_LIST &	GetPredefinedEnvVars ()
	Get the list of pre-defined environment variables. More...
wxString	LookUpEnvVarHelp (const wxString &aEnvVar)
	Look up long-form help text for a given environment variable. More...
template<typename VAL_TYPE >
std::optional< VAL_TYPE >	GetEnvVar (const wxString &aEnvVarName)
	Get an environment variable as a specific type, if set correctly. More...
template<>
std::optional< wxString >	GetEnvVar (const wxString &aEnvVarName)
	Get a string environment variable, if it is set. More...
template<>
std::optional< double >	GetEnvVar (const wxString &aEnvVarName)
	Get a double from an environment variable, if set. More...

Typedef Documentation

ENV_VAR_LIST

using ENV_VAR::ENV_VAR_LIST = typedef std::vector<wxString>

Definition at line 34 of file env_vars.h.

Function Documentation

GetEnvVar() [1/3]

template<typename VAL_TYPE >

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 120 of file env_vars.cpp.

GetEnvVar() [3/3]

template<>

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.

GetPredefinedEnvVars()

const ENV_VAR::ENV_VAR_LIST & ENV_VAR::GetPredefinedEnvVars

(

)

Get the list of pre-defined environment variables.

Definition at line 60 of file env_vars.cpp.

References predefinedEnvVars.

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

IsEnvVarImmutable()

bool ENV_VAR::IsEnvVarImmutable

(

const wxString &

aEnvVar

)

Determine if an environment variable is "predefined", i.e.

if the name of the variable is special to KiCad, and isn't just a user-specified substitution name.

Parameters

aEnvVar

the variable to check

Returns

true if predefined

Definition at line 48 of file env_vars.cpp.

References predefinedEnvVars.

Referenced by DIALOG_CONFIGURE_PATHS::AppendEnvVar(), and DIALOG_CONFIGURE_PATHS::OnRemoveEnvVar().

LookUpEnvVarHelp()

wxString ENV_VAR::LookUpEnvVarHelp

(

const wxString &

aEnvVar

)

Look up long-form help text for a given environment variable.

This is intended for use in more verbose help resources (as opposed to tooltip text)

Parameters

aEnvVar

The variable to look up

Returns

A string with help for that variable. Empty if no help available for this variable.

Definition at line 108 of file env_vars.cpp.

References initialiseEnvVarHelp().

Referenced by DIALOG_CONFIGURE_PATHS::OnHelp().