|
Blender V5.3
|
#include <GHOST_ISystemPaths.hh>
Inherited by GHOST_SystemPaths.
Public Member Functions | |
| virtual const char * | getSystemDir (int version, const char *versionstr) const =0 |
| virtual const char * | getSystemLibsDir (int, const char *) const |
| virtual const char * | getUserDir (int version, const char *versionstr) const =0 |
| virtual std::optional< std::string > | getUserSpecialDir (GHOST_TUserSpecialDirTypes type) const =0 |
| virtual const char * | getBinaryDir () const =0 |
| virtual void | addToSystemRecentFiles (const char *filepath) const =0 |
Static Public Member Functions | |
| static GHOST_TSuccess | create () |
| static GHOST_TSuccess | dispose () |
| static GHOST_ISystemPaths * | get () |
Protected Member Functions | |
| GHOST_ISystemPaths () | |
| virtual | ~GHOST_ISystemPaths ()=default |
Definition at line 16 of file GHOST_ISystemPaths.hh.
|
inlineprotected |
Constructor. Protected default constructor to force use of static createSystem member.
Definition at line 41 of file GHOST_ISystemPaths.hh.
Referenced by addToSystemRecentFiles(), and get().
|
protectedvirtualdefault |
Destructor. Protected default constructor to force use of static dispose member.
|
pure virtual |
Add the file to the operating system most recently used files
Implemented in GHOST_SystemPaths, GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.
References GHOST_ISystemPaths().
Referenced by blender::wm_history_file_update().
|
static |
Creates the one and only system.
Definition at line 27 of file GHOST_ISystemPaths.cc.
References GHOST_kFailure, GHOST_kSuccess, GHOST_SystemPathsCocoa::GHOST_SystemPathsCocoa(), GHOST_SystemPathsUnix::GHOST_SystemPathsUnix(), and GHOST_SystemPathsWin32::GHOST_SystemPathsWin32().
Referenced by get().
|
static |
Disposes the one and only system.
Definition at line 48 of file GHOST_ISystemPaths.cc.
References GHOST_kFailure, and GHOST_kSuccess.
Referenced by blender::BKE_appdir_exit(), and blender::gpu::GPUTest::TearDownTestSuite().
|
static |
Returns a pointer to the one and only system.
Definition at line 61 of file GHOST_ISystemPaths.cc.
References create(), and GHOST_ISystemPaths().
Referenced by blender::BKE_appdir_folder_caches(), blender::BKE_appdir_folder_documents(), blender::get_path_system_ex(), blender::get_path_system_libs_ex(), blender::get_path_user_ex(), and blender::wm_history_file_update().
|
pure virtual |
Determine the directory of the current binary
Implemented in GHOST_SystemPaths, GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.
|
pure virtual |
Determine the base directory in which shared resources are located. It will first try to use "unpack and run" path, then look for properly installed path, including versioning.
Implemented in GHOST_SystemPaths, GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.
Referenced by blender::get_path_system_ex().
|
inlinevirtual |
The base directory where architecture-dependent files are located, mirroring getSystemDir under the install lib tree (eg /usr/lib/blender/).
For portable builds this function always returns null, for specific details see CMake's BLENDER_INSTALL_LIBDIR define for when this is/isn't used and why.
Reimplemented in GHOST_SystemPathsUnix.
Definition at line 67 of file GHOST_ISystemPaths.hh.
Referenced by blender::get_path_system_libs_ex().
|
pure virtual |
Determine the base directory in which user configuration is stored, including versioning. If needed, it will create the base directory.
Implemented in GHOST_SystemPaths, GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.
Referenced by blender::get_path_user_ex().
|
pure virtual |
Determine a special ("well known") and easy to reach user directory.
Implemented in GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.
Referenced by blender::BKE_appdir_folder_caches(), and blender::BKE_appdir_folder_documents().