6de85a0cc0
When we had to get special user directories, we'd usually do it in varying, rather ad-hoc ways. It would be done with a bunch of `#ifdef`s for the different operating systems. Also, some of the used Win32 functions were legacy ones and the API docs recommend using newer ones. Further, seems `BKE_appdir_folder_default()` used `XDG_DOCUMENTS_DIR` wrong. It's not supposed to be an environment variable but a value inside a config file. This adds the platform dependent logic to Ghost, so we can abstract it away nicely using the `GHOST_ISystemPaths` interface. Getting the desktop directory for example can now easily be done with: `GHOST_getUserSpecialDir(GHOST_kUserSpecialDirDesktop).` For now I added the logic for desktop, documents, downloads, videos, images and music directories, even though we only use the Documents one. We can extend/ change this as needed, it's easy to do now. On Windows and macOS, it uses pretty much the same way to access the directories as elsewhere already. On Linux, it uses the `xdg-user-dir` command that seems to be available by default on most Linux systems. No functional changes. The new queries are not actually used yet. Differential Revision: https://developer.blender.org/D9800 Reviewed by: Brecht Van Lommel
79 lines
2.4 KiB
C
79 lines
2.4 KiB
C
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2010 by Blender Foundation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \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/).
|
|
*/
|
|
extern const GHOST_TUns8 *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 ~).
|
|
*/
|
|
extern const GHOST_TUns8 *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 GHOST_TUns8 *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 GHOST_TUns8 *GHOST_getBinaryDir(void);
|
|
|
|
/**
|
|
* Add the file to the operating system most recently used files
|
|
*/
|
|
extern void GHOST_addToSystemRecentFiles(const char *filename);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|