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.

{
 // Set up dynamically, as we want to be able to use _() translations,
 // which can't be done statically
 aMap[wxS( "KICAD7_FOOTPRINT_DIR" )] =
 _( "The base path of locally installed system "
 "footprint libraries (.pretty folders).");
 aMap[wxS( "KICAD7_3DMODEL_DIR" )] =
 _( "The base path of system footprint 3D shapes (.3Dshapes folders).");
 aMap[wxS( "KICAD7_SYMBOL_DIR" )] =
 _( "The base path of the locally installed symbol libraries.");
 aMap[wxS( "KICAD7_TEMPLATE_DIR" )] =
 _( "A directory containing project templates installed with KiCad.");
 aMap[wxS( "KICAD_USER_TEMPLATE_DIR" )] =
 _( "Optional. Can be defined if you want to create your own project "
 "templates folder.");
 aMap[wxS( "KICAD7_3RD_PARTY" )] =
 _( "A directory containing 3rd party plugins, libraries and other "
 "downloadable content.");
 aMap[wxS( "KIPRJMOD" )] =
 _("Internally defined by KiCad (cannot be edited) and is set "
 "to the absolute path of the currently loaded project file. This environment "
 "variable can be used to define files and paths relative to the currently loaded "
 "project. For instance, ${KIPRJMOD}/libs/footprints.pretty can be defined as a "
 "folder containing a project specific footprint library named footprints.pretty." );
 aMap[wxS( "KICAD7_SCRIPTING_DIR" )] =
 _( "A directory containing system-wide scripts installed with KiCad" );
 aMap[wxS( "KICAD7_USER_SCRIPTING_DIR" )] =
 _( "A directory containing user-specific scripts installed with KiCad" );
 
 // Deprecated vars
 aMap[wxS( "KICAD_PTEMPLATES" )] =
 _( "Deprecated version of KICAD_TEMPLATE_DIR.");
 aMap[wxS( "KISYS3DMOD" )] =
 _( "Deprecated version of KICAD7_3DMODEL_DIR." );
 aMap[wxS( "KISYSMOD" )] =
 _( "Deprecated version of KICAD7_FOOTPRINT_DIR." );
 aMap[wxS( "KICAD_SYMBOL_DIR" )] =
 _( "Deprecated version of KICAD_SYMBOL_DIR.");
}

References _.

Referenced by ENV_VAR::LookUpEnvVarHelp().

Variable Documentation

predefinedEnvVars

const ENV_VAR::ENV_VAR_LIST predefinedEnvVars

static

Initial value:

= {
 wxS( "KIPRJMOD" ),
 wxS( "KICAD7_SYMBOL_DIR" ),
 wxS( "KICAD7_3DMODEL_DIR" ),
 wxS( "KICAD7_FOOTPRINT_DIR" ),
 wxS( "KICAD7_TEMPLATE_DIR" ),
 wxS( "KICAD_USER_TEMPLATE_DIR" ),
 wxS( "KICAD_PTEMPLATES" ),
 wxS( "KICAD7_3RD_PARTY" ),
}

Definition at line 36 of file env_vars.cpp.

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