KiCad PCB EDA Suite
env_vars.cpp File Reference
#include <env_vars.h>
#include <map>
#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

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

Function Documentation

◆ initialiseEnvVarHelp()

static void initialiseEnvVarHelp ( STRING_MAP aMap)
static

Definition at line 66 of file env_vars.cpp.

67 {
68  // Set up dynamically, as we want to be able to use _() translations,
69  // which can't be done statically
70  aMap["KICAD6_FOOTPRINT_DIR"] =
71  _( "The base path of locally installed system "
72  "footprint libraries (.pretty folders).");
73  aMap["KICAD6_3DMODEL_DIR"] =
74  _( "The base path of system footprint 3D shapes (.3Dshapes folders).");
75  aMap["KICAD6_SYMBOL_DIR"] =
76  _( "The base path of the locally installed symbol libraries.");
77  aMap["KICAD6_TEMPLATE_DIR"] =
78  _( "A directory containing project templates installed with KiCad.");
79  aMap["KICAD_USER_TEMPLATE_DIR"] =
80  _( "Optional. Can be defined if you want to create your own project "
81  "templates folder.");
82  aMap["KICAD6_3RD_PARTY"] =
83  _( "A directory containing 3rd party plugins, libraries and other "
84  "downloadable content.");
85  aMap["KIPRJMOD"] =
86  _("Internally defined by KiCad (cannot be edited) and is set "
87  "to the absolute path of the currently loaded project file. This environment "
88  "variable can be used to define files and paths relative to the currently loaded "
89  "project. For instance, ${KIPRJMOD}/libs/footprints.pretty can be defined as a "
90  "folder containing a project specific footprint library named footprints.pretty." );
91  aMap["KICAD6_SCRIPTING_DIR"] =
92  _( "A directory containing system-wide scripts installed with KiCad" );
93  aMap["KICAD6_USER_SCRIPTING_DIR"] =
94  _( "A directory containing user-specific scripts installed with KiCad" );
95 
96  // Deprecated vars
97  aMap["KICAD_PTEMPLATES"] =
98  _( "Deprecated version of KICAD_TEMPLATE_DIR.");
99  aMap["KISYS3DMOD"] =
100  _( "Deprecated version of KICAD6_3DMODEL_DIR." );
101  aMap["KISYSMOD"] =
102  _( "Deprecated version of KICAD6_FOOTPRINT_DIR." );
103  aMap["KICAD_SYMBOL_DIR"] =
104  _( "Deprecated version of KICAD_SYMBOL_DIR.");
105 }
#define _(s)

References _.

Referenced by ENV_VAR::LookUpEnvVarHelp().

Variable Documentation

◆ predefinedEnvVars

const ENV_VAR::ENV_VAR_LIST predefinedEnvVars
static
Initial value:
= {
"KIPRJMOD",
"KICAD6_SYMBOL_DIR",
"KICAD6_3DMODEL_DIR",
"KICAD6_FOOTPRINT_DIR",
"KICAD6_TEMPLATE_DIR",
"KICAD_USER_TEMPLATE_DIR",
"KICAD_PTEMPLATES",
"KICAD6_3RD_PARTY",
}

Definition at line 36 of file env_vars.cpp.

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