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

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

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

static wxString	GetUserPlugins3DPath ()
	Gets the user path for 3d viewer plugin. More...

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

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

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

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

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

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

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

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

static wxString	GetStockPlugins3DPath ()
	Gets the stock (install) 3d viewer pluginspath. More...

static wxString	GetUserCachePath ()
	Gets the stock (install) 3d viewer pluginspath. More...

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

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

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

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

Detailed Description

Helper class to centralize the paths used throughout kicad.

Definition at line 26 of file paths.h.

Constructor & Destructor Documentation

◆ PATHS()

PATHS::PATHS ( )

inlineprivate

Definition at line 137 of file paths.h.

137 {}

Member Function Documentation

◆ EnsurePathExists()

bool PATHS::EnsurePathExists ( const wxString & aPath )

static

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

Definition at line 259 of file paths.cpp.

 {
     wxFileName path( aPath );
     if( !path.Normalize() )
     {
         return false;
     }
 
     if( !wxFileName::DirExists( aPath ) )
     {
         if( !wxFileName::Mkdir( aPath, wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
         {
             return false;
         }
     }
 
     return true;
 }

References path.

Referenced by EnsureUserPathsExist().

◆ EnsureUserPathsExist()

void PATHS::EnsureUserPathsExist ( )

static

Ensures/creates user default paths.

Definition at line 279 of file paths.cpp.

 {
     EnsurePathExists( GetUserPluginsPath() );
     EnsurePathExists( GetUserPlugins3DPath() );
     EnsurePathExists( GetUserScriptingPath() );
     EnsurePathExists( GetUserTemplatesPath() );
     EnsurePathExists( GetDefaultUserProjectsPath() );
     EnsurePathExists( GetDefaultUserSymbolsPath() );
     EnsurePathExists( GetDefaultUserFootprintsPath() );
     EnsurePathExists( GetDefaultUser3DModelsPath() );
 }

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

Referenced by SETTINGS_MANAGER::SETTINGS_MANAGER().

◆ GetDefaultUser3DModelsPath()

wxString PATHS::GetDefaultUser3DModelsPath ( )

static

Gets the default path we point users to create projects.

Definition at line 119 of file paths.cpp.

 {
     wxFileName tmp;
     getUserDocumentPath( tmp );
 
     tmp.AppendDir( "3dmodels" );
 
     return tmp.GetPath();
 }

References getUserDocumentPath().

Referenced by EnsureUserPathsExist().

◆ GetDefaultUserFootprintsPath()

wxString PATHS::GetDefaultUserFootprintsPath ( )

static

Gets the default path we point users to create projects.

Definition at line 108 of file paths.cpp.

 {
     wxFileName tmp;
     getUserDocumentPath( tmp );
 
     tmp.AppendDir( "footprints" );
 
     return tmp.GetPath();
 }

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 130 of file paths.cpp.

 {
     wxFileName tmp;
     getUserDocumentPath( tmp );
 
     tmp.AppendDir( "projects" );
 
     return tmp.GetPath();
 }

References getUserDocumentPath().

Referenced by AskLoadBoardFileName(), PCB_EDIT_FRAME::doAutoSave(), EDA_BASE_FRAME::EDA_BASE_FRAME(), EnsureUserPathsExist(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_GENDRILL::OnGenReportFile(), PROJECT_TREE_PANE::onOpenDirectory(), PROJECT_TREE_PANE::ReCreateTreePrj(), and SCH_EDIT_FRAME::SaveEEFile().

◆ GetDefaultUserSymbolsPath()

wxString PATHS::GetDefaultUserSymbolsPath ( )

static

Gets the default path we point users to create projects.

Definition at line 97 of file paths.cpp.

 {
     wxFileName tmp;
     getUserDocumentPath( tmp );
 
     tmp.AppendDir( "symbols" );
 
     return tmp.GetPath();
 }

References getUserDocumentPath().

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), EnsureUserPathsExist(), 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 243 of file paths.cpp.

 {
     wxString path;
 
 #if defined( __WXMAC__ )
     path = GetOSXKicadDataDir();
 #elif defined( __WXMSW__ )
     path = Pgm().GetExecutablePath() + "../share/doc/kicad";
 #else
     path = wxString::FromUTF8Unchecked( KICAD_DOCS );
 #endif
 
     return path;
 }

References path, and Pgm().

Referenced by SearchHelpFileFullPath().

◆ 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 141 of file paths.cpp.

 {
     wxString path;
 
     if( aRespectRunFromBuildDir && wxGetEnv( wxT( "KICAD_RUN_FROM_BUILD_DIR" ), nullptr ) )
     {
         // Allow debugging from build dir by placing relevant files/folders in the build root
         path = Pgm().GetExecutablePath() + wxT( ".." );
     }
     else
     {
 #if defined( __WXMAC__ )
         path = GetOSXKicadDataDir();
 #elif defined( __WXMSW__ )
         path = Pgm().GetExecutablePath() + wxT( "../share/kicad" );
 #else
         path = wxString::FromUTF8Unchecked( KICAD_DATA );
 #endif
     }
 
     return path;
 }

References path, and Pgm().

Referenced by BITMAP_STORE::BITMAP_STORE(), GetBitmapStore(), GetStockEDALibraryPath(), GetStockPluginsPath(), and GetStockScriptingPath().

◆ 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 165 of file paths.cpp.

 {
     wxString path;
 
 #if defined( __WXMAC__ )
     path = GetOSXKicadMachineDataDir();
 #elif defined( __WXMSW__ )
     path = GetStockDataPath( false );
 #else
     path = wxString::FromUTF8Unchecked( KICAD_LIBRARY_DATA );
 #endif
 
     return path;
 }

References GetStockDataPath(), and path.

Referenced by PGM_BASE::InitPgm(), and SystemDirsAppend().

◆ GetStockPlugins3DPath()

wxString PATHS::GetStockPlugins3DPath ( )

static

Gets the stock (install) 3d viewer pluginspath.

Definition at line 207 of file paths.cpp.

 {
     wxFileName fn;
 
 #ifdef __WXGTK__
     // KICAD_PLUGINDIR = CMAKE_INSTALL_FULL_LIBDIR path is the absolute path
     // corresponding to the install path used for constructing KICAD_USER_PLUGIN
     wxString tfname = wxString::FromUTF8Unchecked( KICAD_PLUGINDIR );
     fn.Assign( tfname, "" );
     fn.AppendDir( wxT( "kicad" ) );
     fn.AppendDir( wxT( "plugins" ) );
 #elif defined( __WXMAC__ )
     fn.Assign( wxStandardPaths::Get().GetPluginsDir(), wxEmptyString );
 #else
     fn.AssignDir( Pgm().GetExecutablePath() );
     fn.AppendDir( wxT( "plugins" ) );
 #endif
 
     fn.AppendDir( "3d" );
 
     return fn.GetPathWithSep();
 }

References Pgm().

Referenced by S3D_PLUGIN_MANAGER::loadPlugins().

◆ GetStockPluginsPath()

wxString PATHS::GetStockPluginsPath ( )

static

Gets the stock (install) plugins path.

Definition at line 191 of file paths.cpp.

 {
     wxFileName fn;
 
 #if defined( __WXMSW__ )
     fn.AssignDir( Pgm().GetExecutablePath() );
     fn.AppendDir( wxT( "scripting" ) );
 #else
     fn.AssignDir( PATHS::GetStockDataPath( false ) );
 #endif
     fn.AppendDir( wxT( "plugins" ) );
 
     return fn.GetPathWithSep();
 }

References GetStockDataPath(), and Pgm().

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

◆ GetStockScriptingPath()

wxString PATHS::GetStockScriptingPath ( )

static

Gets the stock (install) scripting path.

Definition at line 181 of file paths.cpp.

 {
     wxString path;
 
     path = GetStockDataPath() + wxT( "/scripting" );
 
     return path;
 }

References GetStockDataPath(), and path.

Referenced by PyScriptingPath().

◆ GetUserCachePath()

wxString PATHS::GetUserCachePath ( )

static

Gets the stock (install) 3d viewer pluginspath.

Definition at line 231 of file paths.cpp.

 {
     wxFileName tmp;
 
     tmp.AssignDir( KIPLATFORM::ENV::GetUserCachePath() );
     tmp.AppendDir( KICAD_PATH_STR );
     tmp.AppendDir( SETTINGS_MANAGER::GetSettingsVersion() );
 
     return tmp.GetPathWithSep();
 }

References SETTINGS_MANAGER::GetSettingsVersion(), KIPLATFORM::ENV::GetUserCachePath(), and KICAD_PATH_STR.

Referenced by 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 39 of file paths.cpp.

 {
     wxString envPath;
 
     if( wxGetEnv( wxT( "KICAD_DOCUMENTS_HOME" ), &envPath ) )
         aPath.AssignDir( envPath );
     else
         aPath.AssignDir( KIPLATFORM::ENV::GetDocumentsPath() );
 
     aPath.AppendDir( KICAD_PATH_STR );
     aPath.AppendDir( SETTINGS_MANAGER::GetSettingsVersion() );
 }

References KIPLATFORM::ENV::GetDocumentsPath(), SETTINGS_MANAGER::GetSettingsVersion(), and KICAD_PATH_STR.

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

◆ GetUserPlugins3DPath()

wxString PATHS::GetUserPlugins3DPath ( )

static

Gets the user path for 3d viewer plugin.

Definition at line 64 of file paths.cpp.

 {
     wxFileName tmp;
 
     tmp.AssignDir( PATHS::GetUserPluginsPath() );
     tmp.AppendDir( "3d" );
 
     return tmp.GetPath();
 }

References GetUserPluginsPath().

Referenced by EnsureUserPathsExist(), and S3D_PLUGIN_MANAGER::loadPlugins().

◆ GetUserPluginsPath()

wxString PATHS::GetUserPluginsPath ( )

static

Gets the user path for plugins.

Definition at line 53 of file paths.cpp.

 {
     wxFileName tmp;
     getUserDocumentPath( tmp );
 
     tmp.AppendDir( "plugins" );
 
     return tmp.GetPath();
 }

References getUserDocumentPath().

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

◆ GetUserScriptingPath()

wxString PATHS::GetUserScriptingPath ( )

static

Gets the user path for python scripts.

Definition at line 75 of file paths.cpp.

 {
     wxFileName tmp;
     getUserDocumentPath( tmp );
 
     tmp.AppendDir( "scripting" );
 
     return tmp.GetPath();
 }

References getUserDocumentPath().

Referenced by EnsureUserPathsExist(), and PyScriptingPath().

◆ GetUserTemplatesPath()

wxString PATHS::GetUserTemplatesPath ( )

static

Gets the user path for custom templates.

Definition at line 86 of file paths.cpp.

 {
     wxFileName tmp;
     getUserDocumentPath( tmp );
 
     tmp.AppendDir( "template" );
 
     return tmp.GetPathWithSep();
 }

References getUserDocumentPath().

Referenced by EnsureUserPathsExist(), PL_EDITOR_FRAME::Files_io(), PGM_BASE::InitPgm(), 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

◆ EnsurePathExists()

◆ EnsureUserPathsExist()

◆ GetDefaultUser3DModelsPath()

◆ GetDefaultUserFootprintsPath()

◆ GetDefaultUserProjectsPath()

◆ GetDefaultUserSymbolsPath()

◆ GetDocumentationPath()

◆ GetStockDataPath()

◆ GetStockEDALibraryPath()

◆ GetStockPlugins3DPath()

◆ GetStockPluginsPath()

◆ GetStockScriptingPath()

◆ GetUserCachePath()

◆ getUserDocumentPath()

◆ GetUserPlugins3DPath()

◆ GetUserPluginsPath()

◆ GetUserScriptingPath()

◆ GetUserTemplatesPath()