Helper class to centralize the paths used throughout kicad. More...

#include <paths.h>

Static Public Member Functions
static wxString	GetUserScriptingPath ()
	Gets the user path for python scripts.

static wxString	GetUserTemplatesPath ()
	Gets the user path for custom templates.

static wxString	GetUserPluginsPath ()
	Gets the user path for plugins.

static wxString	GetDefaultUserProjectsPath ()
	Gets the default path we point users to create projects.

static wxString	GetDefaultUserSymbolsPath ()
	Gets the default path we point users to create projects.

static wxString	GetDefaultUserFootprintsPath ()
	Gets the default path we point users to create projects.

static wxString	GetDefaultUserDesignBlocksPath ()
	Gets the default path we point users to create projects.

static wxString	GetDefaultUser3DModelsPath ()
	Gets the default path we point users to create projects.

static wxString	GetStockDataPath (bool aRespectRunFromBuildDir=true)
	Gets the stock (install) data path, which is the base path for things like scripting, etc.

static wxString	GetStockEDALibraryPath ()
	Gets the stock (install) EDA library data path, which is the base path for templates, schematic symbols, footprints, and 3D models.

static wxString	GetDefault3rdPartyPath ()
	Gets the default path for PCM packages.

static wxString	GetStockSymbolsPath ()
	Gets the stock (install) symbols path.

static wxString	GetStockFootprintsPath ()
	Gets the stock (install) footprints path.

static wxString	GetStockDesignBlocksPath ()
	Gets the stock (install) footprints path.

static wxString	GetStock3dmodelsPath ()
	Gets the stock (install) 3dmodels path.

static wxString	GetStockScriptingPath ()
	Gets the stock (install) scripting path.

static wxString	GetStockPluginsPath ()
	Gets the stock (install) plugins path.

static wxString	GetStockPlugins3DPath ()
	Gets the stock (install) 3d viewer plugins path.

static wxString	GetStockDemosPath ()
	Gets the stock (install) demos path.

static wxString	GetStockTemplatesPath ()
	Gets the stock (install) templates path.

static wxString	GetLocaleDataPath ()
	Gets the locales translation data path.

static wxString	GetUserCachePath ()
	Gets the stock (install) 3d viewer plugins path.

static wxString	GetDocumentationPath ()
	Gets the documentation path, which is the base path for help files.

static wxString	GetInstanceCheckerPath ()
	Gets the path used for wxSingleInstanceChecker lock files.

static wxString	GetLogsPath ()
	Gets a path to use for user-visible log files.

static bool	EnsurePathExists (const wxString &aPath, bool aPathToFile=false)
	Attempts to create a given path if it does not exist.

static void	EnsureUserPathsExist ()
	Ensures/creates user default paths.

static wxString	GetUserSettingsPath ()
	Return the user configuration path used to store KiCad's configuration files.

static wxString	CalculateUserSettingsPath (bool aIncludeVer=true, bool aUseEnv=true)
	Determines the base path for user settings files.

static const wxString &	GetExecutablePath ()

Private Member Functions
	PATHS ()

Static Private Member Functions
static void	getUserDocumentPath (wxFileName &aPath)
	Gets the user path for the current kicad version which acts as the root for other user paths.

Detailed Description

Helper class to centralize the paths used throughout kicad.

Definition at line 36 of file paths.h.

Constructor & Destructor Documentation

◆ PATHS()

PATHS::PATHS ( )

inlineprivate

Definition at line 238 of file paths.h.

Member Function Documentation

◆ CalculateUserSettingsPath()

wxString PATHS::CalculateUserSettingsPath	(	bool	aIncludeVer = `true`,
		bool	aUseEnv = `true`
	)

static

Determines the base path for user settings files.

The configuration path order of precedence is determined by the following criteria:

The value of the KICAD_CONFIG_HOME environment variable
The value of the XDG_CONFIG_HOME environment variable.
The result of the call to wxStandardPaths::GetUserConfigDir() with ".config" appended as required on Linux builds.

Parameters

aIncludeVer	will append the current KiCad version if true (default)
aUseEnv	will prefer the base path found in the KICAD_CONFIG_DIR if found (default)

Returns: A string containing the config path for Kicad

Definition at line 593 of file paths.cpp.

References GetMajorMinorVersion(), KIPLATFORM::ENV::GetUserConfigPath(), and TO_STR.

Referenced by SETTINGS_MANAGER::GetPreviousVersionPaths(), and GetUserSettingsPath().

◆ EnsurePathExists()

bool PATHS::EnsurePathExists	(	const wxString &	aPath,
		bool	aPathToFile = `false`
	)

static

Attempts to create a given path if it does not exist.

Definition at line 467 of file paths.cpp.

References path.

◆ EnsureUserPathsExist()

void PATHS::EnsureUserPathsExist ( )

static

Ensures/creates user default paths.

Definition at line 494 of file paths.cpp.

References EnsurePathExists(), GetDefault3rdPartyPath(), GetDefaultUser3DModelsPath(), GetDefaultUserFootprintsPath(), GetDefaultUserProjectsPath(), GetDefaultUserSymbolsPath(), GetUserCachePath(), GetUserPluginsPath(), GetUserScriptingPath(), and GetUserTemplatesPath().

Referenced by PGM_BASE::InitPgm().

◆ GetDefault3rdPartyPath()

wxString PATHS::GetDefault3rdPartyPath ( )

static

Gets the default path for PCM packages.

Definition at line 132 of file paths.cpp.

References getUserDocumentPath().

Referenced by EnsureUserPathsExist(), COMMON_SETTINGS::InitializeEnvironment(), SETTINGS_MANAGER::loadAllColorSettings(), PLUGIN_CONTENT_MANAGER::ReadEnvVar(), and API_PLUGIN_MANAGER::ReloadPlugins().

◆ GetDefaultUser3DModelsPath()

wxString PATHS::GetDefaultUser3DModelsPath ( )

static

Gets the default path we point users to create projects.

Definition at line 121 of file paths.cpp.

References getUserDocumentPath().

Referenced by EnsureUserPathsExist().

◆ GetDefaultUserDesignBlocksPath()

wxString PATHS::GetDefaultUserDesignBlocksPath ( )

static

Gets the default path we point users to create projects.

Definition at line 110 of file paths.cpp.

References getUserDocumentPath().

Referenced by SCH_EDIT_FRAME::AddDesignBlockLibrary(), SCH_EDIT_FRAME::createNewDesignBlockLibrary(), and PANEL_DESIGN_BLOCK_LIB_TABLE::PANEL_DESIGN_BLOCK_LIB_TABLE().

◆ GetDefaultUserFootprintsPath()

wxString PATHS::GetDefaultUserFootprintsPath ( )

static

Gets the default path we point users to create projects.

Definition at line 99 of file paths.cpp.

References getUserDocumentPath().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), PCB_BASE_EDIT_FRAME::createNewLibrary(), EnsureUserPathsExist(), and PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE().

◆ GetDefaultUserProjectsPath()

wxString PATHS::GetDefaultUserProjectsPath ( )

static

Gets the default path we point users to create projects.

Definition at line 143 of file paths.cpp.

References getUserDocumentPath().

Referenced by AskLoadBoardFileName(), EDA_BASE_FRAME::commonInit(), PCB_EDIT_FRAME::doAutoSave(), EnsureUserPathsExist(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_GENDRILL::onGenReportFile(), PROJECT_TREE_PANE::onOpenDirectory(), PROJECT_TREE_PANE::ReCreateTreePrj(), SCH_EDIT_FRAME::SaveProject(), and ROUTER_TOOL::saveRouterDebugLog().

◆ GetDefaultUserSymbolsPath()

wxString PATHS::GetDefaultUserSymbolsPath ( )

static

Gets the default path we point users to create projects.

Definition at line 88 of file paths.cpp.

References getUserDocumentPath().

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), EnsureUserPathsExist(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), and PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE().

◆ GetDocumentationPath()

wxString PATHS::GetDocumentationPath ( )

static

Gets the documentation path, which is the base path for help files.

Definition at line 430 of file paths.cpp.

References path.

Referenced by SearchHelpFileFullPath().

◆ GetExecutablePath()

const wxString & PATHS::GetExecutablePath ( )

static

Definition at line 619 of file paths.cpp.

References WX_FILENAME::ResolvePossibleSymlinks(), UNIX_STRING_DIR_SEP, and WIN_STRING_DIR_SEP.

Referenced by getBuildDirectoryRoot(), PGM_BASE::GetExecutablePath(), GetStockPlugins3DPath(), and GetStockPluginsPath().

◆ GetInstanceCheckerPath()

wxString PATHS::GetInstanceCheckerPath ( )

static

Gets the path used for wxSingleInstanceChecker lock files.

Definition at line 446 of file paths.cpp.

References path.

Referenced by PGM_BASE::InitPgm().

◆ GetLocaleDataPath()

wxString PATHS::GetLocaleDataPath ( )

static

Gets the locales translation data path.

Definition at line 322 of file paths.cpp.

References GetStockDataPath(), and path.

Referenced by PGM_BASE::SetLanguagePath().

◆ GetLogsPath()

wxString PATHS::GetLogsPath ( )

static

Gets a path to use for user-visible log files.

Definition at line 456 of file paths.cpp.

References getUserDocumentPath().

Referenced by KICAD_API_SERVER::Start().

◆ GetStock3dmodelsPath()

wxString PATHS::GetStock3dmodelsPath ( )

static

Gets the stock (install) 3dmodels path.

Definition at line 292 of file paths.cpp.

References GetStockEDALibraryPath(), and path.

◆ GetStockDataPath()

wxString PATHS::GetStockDataPath ( bool aRespectRunFromBuildDir = true )

static

Gets the stock (install) data path, which is the base path for things like scripting, etc.

Definition at line 196 of file paths.cpp.

References getBuildDirectoryRoot(), and path.

Referenced by API_PLUGIN_MANAGER::API_PLUGIN_MANAGER(), BITMAP_STORE::BITMAP_STORE(), GetBitmapStore(), GetLocaleDataPath(), GetStockDemosPath(), GetStockEDALibraryPath(), GetStockPluginsPath(), GetStockScriptingPath(), SETTINGS_MANAGER::loadAllColorSettings(), and PLUGIN_CONTENT_MANAGER::PLUGIN_CONTENT_MANAGER().

◆ GetStockDemosPath()

wxString PATHS::GetStockDemosPath ( )

static

Gets the stock (install) demos path.

Definition at line 398 of file paths.cpp.

References GetStockDataPath().

Referenced by KICAD_MANAGER_FRAME::doReCreateMenuBar(), and KICAD_MANAGER_CONTROL::OpenDemoProject().

◆ GetStockDesignBlocksPath()

wxString PATHS::GetStockDesignBlocksPath ( )

static

Gets the stock (install) footprints path.

Definition at line 282 of file paths.cpp.

References GetStockEDALibraryPath(), and path.

◆ GetStockEDALibraryPath()

wxString PATHS::GetStockEDALibraryPath ( )

static

Gets the stock (install) EDA library data path, which is the base path for templates, schematic symbols, footprints, and 3D models.

Definition at line 246 of file paths.cpp.

References GetStockDataPath(), and path.

Referenced by GetStock3dmodelsPath(), GetStockDesignBlocksPath(), GetStockFootprintsPath(), GetStockSymbolsPath(), GetStockTemplatesPath(), COMMON_SETTINGS::InitializeEnvironment(), and SystemDirsAppend().

◆ GetStockFootprintsPath()

wxString PATHS::GetStockFootprintsPath ( )

static

Gets the stock (install) footprints path.

Definition at line 272 of file paths.cpp.

References GetStockEDALibraryPath(), and path.

◆ GetStockPlugins3DPath()

wxString PATHS::GetStockPlugins3DPath ( )

static

Gets the stock (install) 3d viewer plugins path.

Definition at line 348 of file paths.cpp.

References GetExecutablePath().

Referenced by S3D_PLUGIN_MANAGER::loadPlugins().

◆ GetStockPluginsPath()

wxString PATHS::GetStockPluginsPath ( )

static

Gets the stock (install) plugins path.

Definition at line 332 of file paths.cpp.

References GetExecutablePath(), and GetStockDataPath().

Referenced by BOM_GENERATOR_HANDLER::FindFilePath(), DIALOG_BOM::pluginInit(), and API_PLUGIN_MANAGER::ReloadPlugins().

◆ GetStockScriptingPath()

wxString PATHS::GetStockScriptingPath ( )

static

Gets the stock (install) scripting path.

Definition at line 302 of file paths.cpp.

References GetStockDataPath(), and path.

◆ GetStockSymbolsPath()

wxString PATHS::GetStockSymbolsPath ( )

static

Gets the stock (install) symbols path.

Definition at line 262 of file paths.cpp.

References GetStockEDALibraryPath(), and path.

◆ GetStockTemplatesPath()

wxString PATHS::GetStockTemplatesPath ( )

static

Gets the stock (install) templates path.

Definition at line 312 of file paths.cpp.

References GetStockEDALibraryPath(), and path.

Referenced by COMMON_SETTINGS::InitializeEnvironment().

◆ GetUserCachePath()

wxString PATHS::GetUserCachePath ( )

static

Gets the stock (install) 3d viewer plugins path.

Definition at line 409 of file paths.cpp.

References GetMajorMinorVersion(), KIPLATFORM::ENV::GetUserCachePath(), and KICAD_PATH_STR.

Referenced by PLUGIN_CONTENT_MANAGER::CacheRepository(), PLUGIN_CONTENT_MANAGER::DiscardRepositoryCache(), PCM_TASK_MANAGER::DownloadAndInstall(), EnsureUserPathsExist(), PLUGIN_CONTENT_MANAGER::GetRepositoryPackageBitmaps(), EMBEDDED_FILES::GetTemporaryFileName(), NOTIFICATIONS_MANAGER::NOTIFICATIONS_MANAGER(), NETLIST_EXPORTER_SPICE::readModel(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), and S3D_CACHE::Set3DConfigDir().

◆ getUserDocumentPath()

void PATHS::getUserDocumentPath ( wxFileName & aPath )

staticprivate

Gets the user path for the current kicad version which acts as the root for other user paths.

Parameters

aPath Variable to receive the path

Definition at line 41 of file paths.cpp.

References KIPLATFORM::ENV::GetDocumentsPath(), GetMajorMinorVersion(), and KICAD_PATH_STR.

Referenced by GetDefault3rdPartyPath(), GetDefaultUser3DModelsPath(), GetDefaultUserDesignBlocksPath(), GetDefaultUserFootprintsPath(), GetDefaultUserProjectsPath(), GetDefaultUserSymbolsPath(), GetLogsPath(), GetUserPluginsPath(), GetUserScriptingPath(), and GetUserTemplatesPath().

◆ GetUserPluginsPath()

wxString PATHS::GetUserPluginsPath ( )

static

Gets the user path for plugins.

Definition at line 55 of file paths.cpp.

References getUserDocumentPath().

Referenced by DIALOG_BOM::chooseGenerator(), EnsureUserPathsExist(), BOM_GENERATOR_HANDLER::FindFilePath(), DIALOG_BOM::pluginInit(), and API_PLUGIN_MANAGER::ReloadPlugins().

◆ GetUserScriptingPath()

wxString PATHS::GetUserScriptingPath ( )

static

Gets the user path for python scripts.

Definition at line 66 of file paths.cpp.

References getUserDocumentPath().

Referenced by EnsureUserPathsExist().

◆ GetUserSettingsPath()

wxString PATHS::GetUserSettingsPath ( )

static

Return the user configuration path used to store KiCad's configuration files.

See also: calculateUserSettingsPath

NOTE: The path is cached at startup, it will never change during program lifetime!

Returns: A string containing the config path for Kicad

Definition at line 582 of file paths.cpp.

References CalculateUserSettingsPath().

Referenced by PROJECT_PCB::Get3DCacheManager(), getAdvancedCfgFilename(), SETTINGS_MANAGER::GetColorSettingsPath(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), DESIGN_BLOCK_LIB_TABLE::GetGlobalTableFileName(), FP_LIB_TABLE::GetGlobalTableFileName(), SETTINGS_MANAGER::GetPathForSettingsFile(), SETTINGS_MANAGER::GetUserSettingsPath(), API_HANDLER_COMMON::handleGetPluginSettingsPath(), SETTINGS_MANAGER::MigrateIfNeeded(), COMMON_SETTINGS::migrateSchema2to3(), PAGED_DIALOG::onOpenPreferencesButton(), PLUGIN_CONTENT_MANAGER::PLUGIN_CONTENT_MANAGER(), ReadHotKeyConfig(), ReadLegacyHotkeyConfigFile(), PLUGIN_CONTENT_MANAGER::SaveInstalledPackages(), and WriteHotKeyConfig().

◆ GetUserTemplatesPath()

wxString PATHS::GetUserTemplatesPath ( )

static

Gets the user path for custom templates.

Definition at line 77 of file paths.cpp.

References getUserDocumentPath().

Referenced by EnsureUserPathsExist(), PL_EDITOR_FRAME::Files_io(), COMMON_SETTINGS::InitializeEnvironment(), and PGM_KICAD::OnPgmInit().

The documentation for this class was generated from the following files:

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PATHS()

Member Function Documentation

◆ CalculateUserSettingsPath()

◆ EnsurePathExists()

◆ EnsureUserPathsExist()

◆ GetDefault3rdPartyPath()

◆ GetDefaultUser3DModelsPath()

◆ GetDefaultUserDesignBlocksPath()

◆ GetDefaultUserFootprintsPath()

◆ GetDefaultUserProjectsPath()

◆ GetDefaultUserSymbolsPath()

◆ GetDocumentationPath()

◆ GetExecutablePath()

◆ GetInstanceCheckerPath()

◆ GetLocaleDataPath()

◆ GetLogsPath()

◆ GetStock3dmodelsPath()

◆ GetStockDataPath()

◆ GetStockDemosPath()

◆ GetStockDesignBlocksPath()

◆ GetStockEDALibraryPath()

◆ GetStockFootprintsPath()

◆ GetStockPlugins3DPath()

◆ GetStockPluginsPath()

◆ GetStockScriptingPath()

◆ GetStockSymbolsPath()

◆ GetStockTemplatesPath()

◆ GetUserCachePath()

◆ getUserDocumentPath()

◆ GetUserPluginsPath()

◆ GetUserScriptingPath()

◆ GetUserSettingsPath()

◆ GetUserTemplatesPath()