KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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.

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
 

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 _, and ENV_VAR::GetVersionedEnvVarName().

Referenced by ENV_VAR::LookUpEnvVarHelp().

◆ versionedEnvVarRegex()

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

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" ) ),
}
KICOMMON_API wxString GetVersionedEnvVarName(const wxString &aBaseName)
Constructs a versioned environment variable based on this KiCad major version.
Definition: env_vars.cpp:74

Definition at line 39 of file env_vars.cpp.

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