Cleanup: rename BKE_appdir_folder_id_version, improve doc-strings
Rename BKE_appdir_folder_id_version to BKE_appdir_resource_path_id_with_version because BKE_appdir_folder_id and BKE_appdir_folder_id_version didn't accept compatible arguments. Also add notes to GHOST_getSystemDir & GHOST_getUserDir that BKE_appdir_resource_path_id(..) should be used instead (in most cases).
This commit is contained in:
parent
bf4926b30c
commit
6b76381e0a
Notes:
blender-bot
2023-02-14 08:42:53 +01:00
Referenced by commit1a485a3aa6
, Fix error in6b76381e0a
Referenced by issue #101606, Regression: Keyboard shortcuts and mouse events are not detected
|
@ -30,13 +30,19 @@ extern GHOST_TSuccess GHOST_DisposeSystemPaths(void);
|
|||
/**
|
||||
* Determine the base dir in which shared resources are located. It will first try to use
|
||||
* "unpack and run" path, then look for properly installed path, including versioning.
|
||||
* \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
|
||||
* \return Unsigned char string pointing to system dir (eg `/usr/share/blender/`).
|
||||
*
|
||||
* \note typically: `BKE_appdir_resource_path_id(BLENDER_RESOURCE_PATH_SYSTEM, false)` should be
|
||||
* used instead of this function directly as it ensures environment variable overrides are used.
|
||||
*/
|
||||
extern const char *GHOST_getSystemDir(int version, const char *versionstr);
|
||||
|
||||
/**
|
||||
* Determine the base dir in which user configuration is stored, including versioning.
|
||||
* \return Unsigned char string pointing to user dir (eg ~).
|
||||
*
|
||||
* \note typically: `BKE_appdir_resource_path_id(BLENDER_RESOURCE_PATH_USER, false)` should be
|
||||
* used instead of this function directly as it ensures environment variable overrides are used.
|
||||
*/
|
||||
extern const char *GHOST_getUserDir(int version, const char *versionstr);
|
||||
|
||||
|
|
|
@ -90,7 +90,10 @@ const char *BKE_appdir_folder_id_user_notest(int folder_id,
|
|||
* Returns the path of the top-level version-specific local, user or system directory.
|
||||
* If check_is_dir, then the result will be NULL if the directory doesn't exist.
|
||||
*/
|
||||
const char *BKE_appdir_folder_id_version(int folder_id, int version, bool check_is_dir);
|
||||
const char *BKE_appdir_resource_path_id_with_version(int folder_id,
|
||||
bool check_is_dir,
|
||||
int version);
|
||||
const char *BKE_appdir_resource_path_id(int folder_id, bool check_is_dir);
|
||||
|
||||
/**
|
||||
* Check if this is an install with user files kept together
|
||||
|
|
|
@ -760,9 +760,9 @@ const char *BKE_appdir_folder_id_create(const int folder_id, const char *subfold
|
|||
return path;
|
||||
}
|
||||
|
||||
const char *BKE_appdir_folder_id_version(const int folder_id,
|
||||
const int version,
|
||||
const bool check_is_dir)
|
||||
const char *BKE_appdir_resource_path_id_with_version(const int folder_id,
|
||||
const bool check_is_dir,
|
||||
const int version)
|
||||
{
|
||||
static char path[FILE_MAX] = "";
|
||||
bool ok;
|
||||
|
@ -785,6 +785,11 @@ const char *BKE_appdir_folder_id_version(const int folder_id,
|
|||
return ok ? path : NULL;
|
||||
}
|
||||
|
||||
const char *BKE_appdir_resource_path_id(const int folder_id, const bool check_is_dir)
|
||||
{
|
||||
return BKE_appdir_resource_path_id_with_version(folder_id, check_is_dir, BLENDER_VERSION);
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
|
|
|
@ -322,7 +322,7 @@ static PyObject *bpy_resource_path(PyObject *UNUSED(self), PyObject *args, PyObj
|
|||
return NULL;
|
||||
}
|
||||
|
||||
path = BKE_appdir_folder_id_version(type.value_found, (major * 100) + minor, false);
|
||||
path = BKE_appdir_resource_path_id_with_version(type.value_found, (major * 100) + minor, false);
|
||||
|
||||
return PyC_UnicodeFromByte(path ? path : "");
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue