Skip to content

Commit

Permalink
OSX: Fix base/pref/config paths on Tiger
Browse files Browse the repository at this point in the history
  • Loading branch information
glebm committed Dec 11, 2024
1 parent e1342ad commit a3a2f82
Show file tree
Hide file tree
Showing 9 changed files with 179 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ end_of_line = crlf
[*.tsv]
trim_trailing_whitespace = false

[*.plist]
end_of_line = lf

[AppRun]
end_of_line = lf

Expand Down
2 changes: 1 addition & 1 deletion Packaging/apple/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<key>NSHumanReadableCopyright</key>
<string>${MACOSX_BUNDLE_COPYRIGHT}</string>
<key>SDL_FILESYSTEM_BASE_DIR_TYPE</key>
<string>parent</string>
<string>resource</string>
<key>NSSupportsAutomaticGraphicsSwitching</key>
<true/>
<key>UIApplicationSupportsIndirectInputEvents</key>
Expand Down
7 changes: 7 additions & 0 deletions Source/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,13 @@ if(USE_SDL1)
target_link_libraries(DevilutionX::SDL INTERFACE
libdevilutionx_sdl2_to_1_2_backports
)
if(APPLE)
enable_language(OBJC)
target_sources(libdevilutionx_sdl2_to_1_2_backports PRIVATE
platform/macos_sdl1/SDL_filesystem.m)
target_link_libraries(libdevilutionx_sdl2_to_1_2_backports PRIVATE
"-framework Foundation")
endif()
endif()

add_devilutionx_object_library(libdevilutionx_codec
Expand Down
2 changes: 1 addition & 1 deletion Source/init.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ std::vector<std::string> GetMPQSearchPaths()
if (paths[0] == paths[1] || (paths.size() == 3 && (paths[0] == paths[2] || paths[1] == paths[2])))
paths.pop_back();

#if defined(__unix__) && !defined(__ANDROID__)
#if (defined(__unix__) || defined(__APPLE__)) && !defined(__ANDROID__)
// `XDG_DATA_HOME` is usually the root path of `paths::PrefPath()`, so we only
// add `XDG_DATA_DIRS`.
const char *xdgDataDirs = std::getenv("XDG_DATA_DIRS");
Expand Down
138 changes: 138 additions & 0 deletions Source/platform/macos_sdl1/SDL_filesystem.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
/*
Simple DirectMedia Layer
Copyright (C) 1997-2024 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
An altered version based on:
https://github.com/libsdl-org/SDL/blob/3c142abcb2b0b0ad7e08b096ea8d9a1a1e1af1ef/src/filesystem/cocoa/SDL_sysfilesystem.m
Modifications:
1. Changes to compile with gcc (@autoreleasepool -> NSAutoreleasePool)
2. Targets SDL-1.2 rather than SDL2 (SDL_InvalidParamError -> SDL_SetError)
*/
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* System dependent filesystem routines */

#include <Foundation/Foundation.h>
#include <sys/stat.h>
#include <sys/types.h>

#include <SDL.h>

char *SDL_GetBasePath(void)
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
NSBundle *bundle = [NSBundle mainBundle];
const char *baseType = [[[bundle infoDictionary] objectForKey:@"SDL_FILESYSTEM_BASE_DIR_TYPE"] UTF8String];
const char *base = NULL;
char *retval = NULL;

if (baseType == NULL) {
baseType = "resource";
}
if (SDL_strcasecmp(baseType, "bundle") == 0) {
base = [[bundle bundlePath] fileSystemRepresentation];
} else if (SDL_strcasecmp(baseType, "parent") == 0) {
base = [[[bundle bundlePath] stringByDeletingLastPathComponent] fileSystemRepresentation];
} else {
/* this returns the exedir for non-bundled and the resourceDir for bundled apps */
base = [[bundle resourcePath] fileSystemRepresentation];
}

if (base) {
const size_t len = SDL_strlen(base) + 2;
retval = (char *)SDL_malloc(len);
if (retval == NULL) {
SDL_OutOfMemory();
} else {
SDL_snprintf(retval, len, "%s/", base);
}
}

[pool drain];
return retval;
}

char *SDL_GetPrefPath(const char *org, const char *app)
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
char *retval = NULL;
NSArray *array;

if (!app) {
SDL_SetError("SDL_GetPrefPath: app argument cannot be null");
return NULL;
}
if (!org) {
org = "";
}

#if !TARGET_OS_TV
array = NSSearchPathForDirectoriesInDomains(NSApplicationSupportDirectory, NSUserDomainMask, YES);
#else
/* tvOS does not have persistent local storage!
* The only place on-device where we can store data is
* a cache directory that the OS can empty at any time.
*
* It's therefore very likely that save data will be erased
* between sessions. If you want your app's save data to
* actually stick around, you'll need to use iCloud storage.
*/
{
static SDL_bool shown = SDL_FALSE;
if (!shown) {
shown = SDL_TRUE;
SDL_LogCritical(SDL_LOG_CATEGORY_SYSTEM, "tvOS does not have persistent local storage! Use iCloud storage if you want your data to persist between sessions.\n");
}
}

array = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
#endif /* !TARGET_OS_TV */

if ([array count] > 0) { /* we only want the first item in the list. */
NSString *str = [array objectAtIndex:0];
const char *base = [str fileSystemRepresentation];
if (base) {
const size_t len = SDL_strlen(base) + SDL_strlen(org) + SDL_strlen(app) + 4;
retval = (char *)SDL_malloc(len);
if (retval == NULL) {
SDL_OutOfMemory();
} else {
char *ptr;
if (*org) {
SDL_snprintf(retval, len, "%s/%s/%s/", base, org, app);
} else {
SDL_snprintf(retval, len, "%s/%s/", base, app);
}
for (ptr = retval + 1; *ptr; ptr++) {
if (*ptr == '/') {
*ptr = '\0';
mkdir(retval, 0700);
*ptr = '/';
}
}
mkdir(retval, 0700);
}
}
}

[pool drain];
return retval;
}

/* vi: set ts=4 sw=4 expandtab: */
21 changes: 21 additions & 0 deletions Source/utils/paths.cpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
#include "utils/paths.h"

#include <optional>
#include <string>
#include <string_view>

#include <SDL.h>

#include "appfat.h"
Expand Down Expand Up @@ -130,6 +134,23 @@ const std::string &AssetsPath()
assetsPath.emplace("D:\\assets\\");
#elif defined(__3DS__) || defined(__SWITCH__)
assetsPath.emplace("romfs:/");
#elif defined(__APPLE__) && defined(USE_SDL1)
// In `Info.plist` we have
//
// <key>SDL_FILESYSTEM_BASE_DIR_TYPE</key>
// <string>resource</string>
//
// This means `SDL_GetBasePath()` returns exedir for non-bundled
// and the `app_dir.app/Resources/` for bundles.
//
// Our built-in resources are directly in the `devilutionx.app/Resources` directory
// and are normally looked up via a relative lookup in `FindAsset`.
// In SDL2, this is implemented by calling `SDL_OpenFPFromBundleOrFallback`
// from `SDL_RWFromFile` but SDL1 doesn't do it, so we set the directory explicitly.
//
// Note that SDL3 reverts to SDL1 behaviour!
// https://github.com/libsdl-org/SDL/blob/962268ca21ed10b9cee31198c22681099293f20a/docs/README-migration.md?plain=1#L1623
assetsPath.emplace(FromSDL(SDL_GetBasePath()));
#else
assetsPath.emplace(FromSDL(SDL_GetBasePath()) + ("assets" DIRECTORY_SEPARATOR_STR));
#endif
Expand Down
1 change: 0 additions & 1 deletion Source/utils/paths.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#pragma once

#include <optional>
#include <string>

namespace devilution {
Expand Down
11 changes: 6 additions & 5 deletions Source/utils/sdl2_to_1_2_backports.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,7 @@ int WIN_SetError(const char *prefix)

} // namespace

char *SDL_GetBasePath(void)
extern "C" char *SDL_GetBasePath(void)
{
// From sdl2-2.0.9/src/filesystem/windows/SDL_sysfilesystem.c

Expand Down Expand Up @@ -611,7 +611,7 @@ char *SDL_GetBasePath(void)
return retval;
}

char *SDL_GetPrefPath(const char *org, const char *app)
extern "C" char *SDL_GetPrefPath(const char *org, const char *app)
{
// From sdl2-2.0.9/src/filesystem/windows/SDL_sysfilesystem.c

Expand Down Expand Up @@ -699,7 +699,8 @@ char *SDL_GetPrefPath(const char *org, const char *app)
return retval;
}

#else
// For Apple, definitions are in Source/platform/macos_sdl1/SDL_filesystem.m
#elif !defined(__APPLE__)

namespace {
#if !defined(__QNXNTO__) && !defined(__amigaos__) && !(defined(WINVER) && WINVER <= 0x0500 && (!defined(_WIN32_WINNT) || _WIN32_WINNT == 0))
Expand Down Expand Up @@ -736,7 +737,7 @@ char *readSymLink(const char *path)
#endif
} // namespace

char *SDL_GetBasePath()
extern "C" char *SDL_GetBasePath()
{
// From sdl2-2.0.9/src/filesystem/unix/SDL_sysfilesystem.c

Expand Down Expand Up @@ -851,7 +852,7 @@ char *SDL_GetBasePath()
return retval;
}

char *SDL_GetPrefPath(const char *org, const char *app)
extern "C" char *SDL_GetPrefPath(const char *org, const char *app)
{
// From sdl2-2.0.9/src/filesystem/unix/SDL_sysfilesystem.c
/*
Expand Down
4 changes: 2 additions & 2 deletions Source/utils/sdl2_to_1_2_backports.h
Original file line number Diff line number Diff line change
Expand Up @@ -322,5 +322,5 @@ int SDL_BlitScaled(SDL_Surface *src, SDL_Rect *srcrect,

Sint64 SDL_RWsize(SDL_RWops *context);

char *SDL_GetBasePath();
char *SDL_GetPrefPath(const char *org, const char *app);
extern "C" char *SDL_GetBasePath();
extern "C" char *SDL_GetPrefPath(const char *org, const char *app);

0 comments on commit a3a2f82

Please sign in to comment.