2011-02-22 23:40:06 +00:00
|
|
|
/*
|
2011-01-05 14:00:14 +00:00
|
|
|
* 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
|
2018-06-04 16:47:57 +00:00
|
|
|
* of the License, or (at your option) any later version.
|
2011-01-05 14:00:14 +00:00
|
|
|
*
|
|
|
|
* 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) 2009 Blender Foundation.
|
|
|
|
* All rights reserved.
|
|
|
|
*/
|
2011-02-25 11:28:33 +00:00
|
|
|
|
2019-02-17 21:08:12 +00:00
|
|
|
/** \file
|
|
|
|
* \ingroup GHOST
|
2011-02-25 11:28:33 +00:00
|
|
|
*/
|
|
|
|
|
2012-02-17 18:59:41 +00:00
|
|
|
#pragma once
|
2011-01-05 14:00:14 +00:00
|
|
|
|
|
|
|
#include "GHOST_Types.h"
|
|
|
|
|
|
|
|
class GHOST_ISystemPaths {
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Creates the one and only system.
|
2012-09-06 02:10:09 +00:00
|
|
|
* \return An indication of success.
|
2011-01-05 14:00:14 +00:00
|
|
|
*/
|
|
|
|
static GHOST_TSuccess create();
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-01-05 14:00:14 +00:00
|
|
|
/**
|
|
|
|
* Disposes the one and only system.
|
2012-09-06 02:10:09 +00:00
|
|
|
* \return An indication of success.
|
2011-01-05 14:00:14 +00:00
|
|
|
*/
|
|
|
|
static GHOST_TSuccess dispose();
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-01-05 14:00:14 +00:00
|
|
|
/**
|
|
|
|
* Returns a pointer to the one and only system (nil if it hasn't been created).
|
2012-09-06 02:10:09 +00:00
|
|
|
* \return A pointer to the system.
|
2011-01-05 14:00:14 +00:00
|
|
|
*/
|
2012-05-19 09:23:08 +00:00
|
|
|
static GHOST_ISystemPaths *get();
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-01-05 14:00:14 +00:00
|
|
|
protected:
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
* Protected default constructor to force use of static createSystem member.
|
|
|
|
*/
|
2012-05-19 09:23:08 +00:00
|
|
|
GHOST_ISystemPaths()
|
|
|
|
{
|
|
|
|
}
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-01-05 14:00:14 +00:00
|
|
|
/**
|
|
|
|
* Destructor.
|
|
|
|
* Protected default constructor to force use of static dispose member.
|
|
|
|
*/
|
2012-05-19 09:23:08 +00:00
|
|
|
virtual ~GHOST_ISystemPaths()
|
|
|
|
{
|
|
|
|
}
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-01-05 14:00:14 +00:00
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Determine the base dir in which shared resources are located. It will first try to use
|
2012-05-25 12:08:29 +00:00
|
|
|
* "unpack and run" path, then look for properly installed path, including versioning.
|
2012-09-06 02:10:09 +00:00
|
|
|
* \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
|
2011-01-05 14:00:14 +00:00
|
|
|
*/
|
2012-05-25 12:08:29 +00:00
|
|
|
virtual const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const = 0;
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-01-05 14:00:14 +00:00
|
|
|
/**
|
2012-05-25 12:08:29 +00:00
|
|
|
* Determine the base dir in which user configuration is stored, including versioning.
|
2011-01-05 14:00:14 +00:00
|
|
|
* If needed, it will create the base directory.
|
2012-09-06 02:10:09 +00:00
|
|
|
* \return Unsigned char string pointing to user dir (eg ~/.blender/).
|
2011-01-05 14:00:14 +00:00
|
|
|
*/
|
2012-05-25 12:08:29 +00:00
|
|
|
virtual const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const = 0;
|
2019-04-17 04:17:24 +00:00
|
|
|
|
Ghost: Support queries for special user directories (desktop, documents, etc.)
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
2020-12-11 14:36:29 +00:00
|
|
|
/**
|
|
|
|
* Determine a special ("well known") and easy to reach user directory.
|
|
|
|
* \return Unsigned char string pointing to user dir (eg `~/Documents/`).
|
|
|
|
*/
|
|
|
|
virtual const GHOST_TUns8 *getUserSpecialDir(GHOST_TUserSpecialDirTypes type) const = 0;
|
|
|
|
|
2011-01-05 14:00:14 +00:00
|
|
|
/**
|
2012-05-19 09:23:08 +00:00
|
|
|
* Determine the directory of the current binary
|
2012-09-06 02:10:09 +00:00
|
|
|
* \return Unsigned char string pointing to the binary dir
|
2012-05-19 09:23:08 +00:00
|
|
|
*/
|
|
|
|
virtual const GHOST_TUns8 *getBinaryDir() const = 0;
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-11-11 13:09:14 +00:00
|
|
|
/**
|
|
|
|
* Add the file to the operating system most recently used files
|
|
|
|
*/
|
2012-05-19 09:23:08 +00:00
|
|
|
virtual void addToSystemRecentFiles(const char *filename) const = 0;
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-01-05 14:00:14 +00:00
|
|
|
private:
|
|
|
|
/** The one and only system paths*/
|
2012-05-19 09:23:08 +00:00
|
|
|
static GHOST_ISystemPaths *m_systemPaths;
|
2012-06-25 10:35:24 +00:00
|
|
|
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ISystemPaths")
|
|
|
|
#endif
|
2011-01-05 14:00:14 +00:00
|
|
|
};
|