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
144 lines
4.0 KiB
C++
144 lines
4.0 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) 2011 Blender Foundation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup GHOST
|
|
*/
|
|
|
|
#include "GHOST_SystemPathsWin32.h"
|
|
#include "GHOST_Debug.h"
|
|
|
|
#ifndef _WIN32_IE
|
|
# define _WIN32_IE 0x0501
|
|
#endif
|
|
#include "utfconv.h"
|
|
#include <shlobj.h>
|
|
|
|
GHOST_SystemPathsWin32::GHOST_SystemPathsWin32()
|
|
{
|
|
}
|
|
|
|
GHOST_SystemPathsWin32::~GHOST_SystemPathsWin32()
|
|
{
|
|
}
|
|
|
|
const GHOST_TUns8 *GHOST_SystemPathsWin32::getSystemDir(int, const char *versionstr) const
|
|
{
|
|
/* 1 utf-16 might translante into 3 utf-8. 2 utf-16 translates into 4 utf-8*/
|
|
static char knownpath[MAX_PATH * 3 + 128] = {0};
|
|
PWSTR knownpath_16 = NULL;
|
|
|
|
HRESULT hResult = SHGetKnownFolderPath(
|
|
FOLDERID_ProgramData, KF_FLAG_DEFAULT, NULL, &knownpath_16);
|
|
|
|
if (hResult == S_OK) {
|
|
conv_utf_16_to_8(knownpath_16, knownpath, MAX_PATH * 3);
|
|
CoTaskMemFree(knownpath_16);
|
|
strcat(knownpath, "\\Blender Foundation\\Blender\\");
|
|
strcat(knownpath, versionstr);
|
|
return (GHOST_TUns8 *)knownpath;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
const GHOST_TUns8 *GHOST_SystemPathsWin32::getUserDir(int, const char *versionstr) const
|
|
{
|
|
static char knownpath[MAX_PATH * 3 + 128] = {0};
|
|
PWSTR knownpath_16 = NULL;
|
|
|
|
HRESULT hResult = SHGetKnownFolderPath(
|
|
FOLDERID_RoamingAppData, KF_FLAG_DEFAULT, NULL, &knownpath_16);
|
|
|
|
if (hResult == S_OK) {
|
|
conv_utf_16_to_8(knownpath_16, knownpath, MAX_PATH * 3);
|
|
CoTaskMemFree(knownpath_16);
|
|
strcat(knownpath, "\\Blender Foundation\\Blender\\");
|
|
strcat(knownpath, versionstr);
|
|
return (GHOST_TUns8 *)knownpath;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
const GHOST_TUns8 *GHOST_SystemPathsWin32::getUserSpecialDir(GHOST_TUserSpecialDirTypes type) const
|
|
{
|
|
GUID folderid;
|
|
|
|
switch (type) {
|
|
case GHOST_kUserSpecialDirDesktop:
|
|
folderid = FOLDERID_Desktop;
|
|
break;
|
|
case GHOST_kUserSpecialDirDocuments:
|
|
folderid = FOLDERID_Documents;
|
|
break;
|
|
case GHOST_kUserSpecialDirDownloads:
|
|
folderid = FOLDERID_Downloads;
|
|
break;
|
|
case GHOST_kUserSpecialDirMusic:
|
|
folderid = FOLDERID_Music;
|
|
break;
|
|
case GHOST_kUserSpecialDirPictures:
|
|
folderid = FOLDERID_Pictures;
|
|
break;
|
|
case GHOST_kUserSpecialDirVideos:
|
|
folderid = FOLDERID_Videos;
|
|
break;
|
|
default:
|
|
GHOST_ASSERT(
|
|
false,
|
|
"GHOST_SystemPathsWin32::getUserSpecialDir(): Invalid enum value for type parameter");
|
|
return NULL;
|
|
}
|
|
|
|
static char knownpath[MAX_PATH * 3] = {0};
|
|
PWSTR knownpath_16 = NULL;
|
|
HRESULT hResult = SHGetKnownFolderPath(folderid, KF_FLAG_DEFAULT, NULL, &knownpath_16);
|
|
|
|
if (hResult == S_OK) {
|
|
conv_utf_16_to_8(knownpath_16, knownpath, MAX_PATH * 3);
|
|
CoTaskMemFree(knownpath_16);
|
|
return (GHOST_TUns8 *)knownpath;
|
|
}
|
|
|
|
CoTaskMemFree(knownpath_16);
|
|
return NULL;
|
|
}
|
|
|
|
const GHOST_TUns8 *GHOST_SystemPathsWin32::getBinaryDir() const
|
|
{
|
|
static char fullname[MAX_PATH * 3] = {0};
|
|
wchar_t fullname_16[MAX_PATH * 3];
|
|
|
|
if (GetModuleFileNameW(0, fullname_16, MAX_PATH)) {
|
|
conv_utf_16_to_8(fullname_16, fullname, MAX_PATH * 3);
|
|
return (GHOST_TUns8 *)fullname;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
void GHOST_SystemPathsWin32::addToSystemRecentFiles(const char *filename) const
|
|
{
|
|
/* SHARD_PATH resolves to SHARD_PATHA for non-UNICODE build */
|
|
UTF16_ENCODE(filename);
|
|
SHAddToRecentDocs(SHARD_PATHW, filename_16);
|
|
UTF16_UN_ENCODE(filename);
|
|
}
|