env_vars.cpp File Reference

#include <build_version.h>
#include <env_vars.h>
#include <settings/environment.h>
#include <map>
#include <wx/regex.h>
#include <wx/translation.h>
#include <wx/utils.h>

Go to the source code of this file.

Macros
#define	DEP(var)   wxString::Format( _( "Deprecated version of %s." ), var )

Typedefs
using	STRING_MAP = std::map< wxString, wxString >

Functions
const wxRegEx	versionedEnvVarRegex (wxS("KICAD[0-9]+_[A-Z0-9_]+(_DIR)?"))
static void	initialiseEnvVarHelp (STRING_MAP &aMap)

Variables
static const ENV_VAR::ENV_VAR_LIST	predefinedEnvVars
	List of pre-defined environment variables.

Macro Definition Documentation

DEP

#define DEP

(

var

)

wxString::Format( _( "Deprecated version of %s." ), var )

Typedef Documentation

STRING_MAP

using STRING_MAP = std::map<wxString, wxString>

Definition at line 30 of file env_vars.cpp.

Function Documentation

initialiseEnvVarHelp()

static void initialiseEnvVarHelp ( STRING_MAP &  aMap )

static

Definition at line 103 of file env_vars.cpp.

References _, DEP, and ENV_VAR::GetVersionedEnvVarName().

Referenced by ENV_VAR::LookUpEnvVarHelp().

versionedEnvVarRegex()

const wxRegEx versionedEnvVarRegex

(

wxS("KICAD[0-9]+_[A-Z0-9_]+(_DIR)?")

)

Referenced by ENV_VAR::IsEnvVarImmutable(), and COMMON_SETTINGS::MigrateFromLegacy().

Variable Documentation

predefinedEnvVars

const ENV_VAR::ENV_VAR_LIST predefinedEnvVars

static

Initial value:

= {
    wxS( "KIPRJMOD" ),
    ENV_VAR::GetVersionedEnvVarName( wxS( "SYMBOL_DIR" ) ),
    ENV_VAR::GetVersionedEnvVarName( wxS( "3DMODEL_DIR" ) ),
    ENV_VAR::GetVersionedEnvVarName( wxS( "FOOTPRINT_DIR" ) ),
    ENV_VAR::GetVersionedEnvVarName( wxS( "TEMPLATE_DIR" ) ),
    wxS( "KICAD_USER_TEMPLATE_DIR" ),
    wxS( "KICAD_PTEMPLATES" ),
    ENV_VAR::GetVersionedEnvVarName( wxS( "3RD_PARTY" ) ),
}

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).

Definition at line 38 of file env_vars.cpp.

Referenced by ENV_VAR::GetPredefinedEnvVars(), and ENV_VAR::IsEnvVarImmutable().