a12a8a71bb
The goal is to solve confusion of the "All rights reserved" for licensing
code under an open-source license.
The phrase "All rights reserved" comes from a historical convention that
required this phrase for the copyright protection to apply. This convention
is no longer relevant.
However, even though the phrase has no meaning in establishing the copyright
it has not lost meaning in terms of licensing.
This change makes it so code under the Blender Foundation copyright does
not use "all rights reserved". This is also how the GPL license itself
states how to apply it to the source code:
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software ...
This change does not change copyright notice in cases when the copyright
is dual (BF and an author), or just an author of the code. It also does
mot change copyright which is inherited from NaN Holding BV as it needs
some further investigation about what is the proper way to handle it.
69 lines
2.1 KiB
C
69 lines
2.1 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2010 Blender Foundation */
|
|
|
|
/** \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 *filename);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|