e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
70 lines
2.1 KiB
C++
70 lines
2.1 KiB
C++
/* SPDX-FileCopyrightText: 2010 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup GHOST
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "GHOST_Types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
GHOST_DECLARE_HANDLE(GHOST_SystemPathsHandle);
|
|
|
|
/**
|
|
* Creates the one and only instance of the system path access.
|
|
* \return An indication of success.
|
|
*/
|
|
extern GHOST_TSuccess GHOST_CreateSystemPaths(void);
|
|
|
|
/**
|
|
* Disposes the one and only system.
|
|
* \return An indication of success.
|
|
*/
|
|
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/`).
|
|
*
|
|
* \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);
|
|
|
|
/**
|
|
* Determine a special ("well known") and easy to reach user directory.
|
|
* \return Unsigned char string pointing to user dir (eg `~/Documents/`).
|
|
*/
|
|
extern const char *GHOST_getUserSpecialDir(GHOST_TUserSpecialDirTypes type);
|
|
|
|
/**
|
|
* Determine the dir in which the binary file is found.
|
|
* \return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
|
|
*/
|
|
extern const char *GHOST_getBinaryDir(void);
|
|
|
|
/**
|
|
* Add the file to the operating system most recently used files
|
|
*/
|
|
extern void GHOST_addToSystemRecentFiles(const char *filepath);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|