include/SDL_config_macosx.h
author David Ludwig <dludwig@pobox.com>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 9080 2e4e71ec140f
child 9619 b94b6d0bff0f
permissions -rw-r--r--
WinRT: bug and data-integrity fixes for SDL_GetPrefPath()

This change does a few things, all with regards to the WinRT implementation of
SDL_GetPrefPath():

1. it fixes a bug whereby SDL_GetPrefPath() did not create the directory it
returned. On other SDL platforms, SDL_GetPrefPath() will create separate
directories for its 'org' and 'app' folders. Without this, attempts to create
files in the pref-path would fail, unless those directories were first created
by the app, or by some other library the app used. This change makes sure
that these directories get created, before SDL_GetPrefPath() returns to its
caller(s).


2. it defaults to having SDL_GetPrefPath() return a WinRT 'Local' folder
on all platforms. Previously, for Windows Store apps, it would have used a
different, 'Roaming' folder. Files in Roaming folders can be automatically,
and synchronized across multiple devices by Windows. This synchronization can
happen while the app runs, with new files being copied into a running app's
pref-path. Unless an app is specifically designed to handle this scenario,
there is a chance that save-data could be overwritten in unwanted or
unexpected ways.

The default is now to use a Local folder, which does not get synchronized, and
which is arguably a bit safer to use. Apps that wish to use Roaming folders
can do so by setting SDL_HINT_WINRT_PREF_PATH_ROOT to "roaming", however it
is recommended that one first read Microsoft's documentation for Roaming
files, a link to which is provided in README-winrt.md.

To preserve older pref-path selection behavior (found in SDL 2.0.3, as well as
many pre-2.0.4 versions of SDL from hg.libsdl.org), which uses a Roaming path
in Windows Store apps, and a Local path in Windows Phone, set
SDL_HINT_WINRT_PREF_PATH_ROOT to "old".

Please note that Roaming paths are not supported on Windows Phone 8.0, due to
limitations in the OS itself. Attempts to use this will fail.
(Windows Phone 8.1 does not have this limitation, however.)


3. It makes SDL_GetPrefPath(), when on Windows Phone 8.0, and when
SDL_HINT_WINRT_PREF_PATH_ROOT is set to "roaming", return NULL, rather than
silently defaulting to a Local path (then switching to a Roaming path if and
when the user upgraded to Windows Phone 8.1).
slouken@1422
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@1422
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@1422
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@1422
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@1422
    20
*/
slouken@1422
    21
slouken@1422
    22
#ifndef _SDL_config_macosx_h
slouken@1422
    23
#define _SDL_config_macosx_h
slouken@1608
    24
slouken@1608
    25
#include "SDL_platform.h"
slouken@1422
    26
icculus@2098
    27
/* This gets us MAC_OS_X_VERSION_MIN_REQUIRED... */
icculus@2098
    28
#include <AvailabilityMacros.h>
icculus@2098
    29
slouken@1422
    30
/* This is a set of defines to configure the SDL features */
slouken@1422
    31
slouken@3400
    32
#ifdef __LP64__
slouken@7191
    33
    #define SIZEOF_VOIDP 8
slouken@3400
    34
#else
slouken@7191
    35
    #define SIZEOF_VOIDP 4
slouken@3400
    36
#endif
slouken@3400
    37
slouken@1422
    38
/* Useful headers */
slouken@7191
    39
#define HAVE_ALLOCA_H       1
slouken@7191
    40
#define HAVE_SYS_TYPES_H    1
slouken@7191
    41
#define HAVE_STDIO_H    1
slouken@7191
    42
#define STDC_HEADERS    1
slouken@7191
    43
#define HAVE_STRING_H   1
slouken@7191
    44
#define HAVE_INTTYPES_H 1
slouken@7191
    45
#define HAVE_STDINT_H   1
slouken@7191
    46
#define HAVE_CTYPE_H    1
slouken@7191
    47
#define HAVE_MATH_H 1
slouken@7191
    48
#define HAVE_SIGNAL_H   1
slouken@1422
    49
slouken@1422
    50
/* C library functions */
slouken@7191
    51
#define HAVE_MALLOC 1
slouken@7191
    52
#define HAVE_CALLOC 1
slouken@7191
    53
#define HAVE_REALLOC    1
slouken@7191
    54
#define HAVE_FREE   1
slouken@7191
    55
#define HAVE_ALLOCA 1
slouken@7191
    56
#define HAVE_GETENV 1
slouken@7191
    57
#define HAVE_SETENV 1
slouken@7191
    58
#define HAVE_PUTENV 1
slouken@7191
    59
#define HAVE_UNSETENV   1
slouken@7191
    60
#define HAVE_QSORT  1
slouken@7191
    61
#define HAVE_ABS    1
slouken@7191
    62
#define HAVE_BCOPY  1
slouken@7191
    63
#define HAVE_MEMSET 1
slouken@7191
    64
#define HAVE_MEMCPY 1
slouken@7191
    65
#define HAVE_MEMMOVE    1
slouken@7191
    66
#define HAVE_MEMCMP 1
slouken@7191
    67
#define HAVE_STRLEN 1
slouken@7191
    68
#define HAVE_STRLCPY    1
slouken@7191
    69
#define HAVE_STRLCAT    1
slouken@7191
    70
#define HAVE_STRDUP 1
slouken@7191
    71
#define HAVE_STRCHR 1
slouken@7191
    72
#define HAVE_STRRCHR    1
slouken@7191
    73
#define HAVE_STRSTR 1
slouken@7191
    74
#define HAVE_STRTOL 1
slouken@7191
    75
#define HAVE_STRTOUL    1
slouken@7191
    76
#define HAVE_STRTOLL    1
slouken@7191
    77
#define HAVE_STRTOULL   1
slouken@7191
    78
#define HAVE_STRTOD 1
slouken@7191
    79
#define HAVE_ATOI   1
slouken@7191
    80
#define HAVE_ATOF   1
slouken@7191
    81
#define HAVE_STRCMP 1
slouken@7191
    82
#define HAVE_STRNCMP    1
slouken@7191
    83
#define HAVE_STRCASECMP 1
slouken@1517
    84
#define HAVE_STRNCASECMP 1
icculus@8089
    85
#define HAVE_VSSCANF 1
slouken@7191
    86
#define HAVE_VSNPRINTF  1
slouken@7191
    87
#define HAVE_CEIL   1
slouken@7191
    88
#define HAVE_COPYSIGN   1
slouken@7191
    89
#define HAVE_COS    1
slouken@7191
    90
#define HAVE_COSF   1
slouken@7191
    91
#define HAVE_FABS   1
slouken@7191
    92
#define HAVE_FLOOR  1
slouken@7191
    93
#define HAVE_LOG    1
slouken@7191
    94
#define HAVE_POW    1
slouken@7191
    95
#define HAVE_SCALBN 1
slouken@7191
    96
#define HAVE_SIN    1
slouken@7191
    97
#define HAVE_SINF   1
slouken@7191
    98
#define HAVE_SQRT   1
slouken@8840
    99
#define HAVE_SQRTF  1
slouken@8840
   100
#define HAVE_TAN    1
slouken@8840
   101
#define HAVE_TANF   1
slouken@7191
   102
#define HAVE_SIGACTION  1
slouken@7191
   103
#define HAVE_SETJMP 1
slouken@7191
   104
#define HAVE_NANOSLEEP  1
slouken@7191
   105
#define HAVE_SYSCONF    1
slouken@3579
   106
#define HAVE_SYSCTLBYNAME 1
aschiffler@4907
   107
#define HAVE_ATAN 1
aschiffler@4907
   108
#define HAVE_ATAN2 1
icculus@8056
   109
#define HAVE_ACOS 1
icculus@8056
   110
#define HAVE_ASIN 1
slouken@1422
   111
slouken@1422
   112
/* Enable various audio drivers */
slouken@7191
   113
#define SDL_AUDIO_DRIVER_COREAUDIO  1
slouken@7191
   114
#define SDL_AUDIO_DRIVER_DISK   1
slouken@7191
   115
#define SDL_AUDIO_DRIVER_DUMMY  1
slouken@1422
   116
slouken@1422
   117
/* Enable various input drivers */
slouken@7191
   118
#define SDL_JOYSTICK_IOKIT  1
slouken@7191
   119
#define SDL_HAPTIC_IOKIT    1
slouken@1422
   120
slouken@1422
   121
/* Enable various shared object loading systems */
slouken@7191
   122
#define SDL_LOADSO_DLOPEN   1
slouken@1422
   123
slouken@1422
   124
/* Enable various threading systems */
slouken@7191
   125
#define SDL_THREAD_PTHREAD  1
slouken@7191
   126
#define SDL_THREAD_PTHREAD_RECURSIVE_MUTEX  1
slouken@1422
   127
slouken@1422
   128
/* Enable various timer systems */
slouken@7191
   129
#define SDL_TIMER_UNIX  1
slouken@1422
   130
slouken@1422
   131
/* Enable various video drivers */
slouken@7191
   132
#define SDL_VIDEO_DRIVER_COCOA  1
slouken@7191
   133
#define SDL_VIDEO_DRIVER_DUMMY  1
slouken@6840
   134
#undef SDL_VIDEO_DRIVER_X11
slouken@3289
   135
#define SDL_VIDEO_DRIVER_X11_DYNAMIC "/usr/X11R6/lib/libX11.6.dylib"
slouken@3289
   136
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XEXT "/usr/X11R6/lib/libXext.6.dylib"
slouken@5408
   137
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XINERAMA "/usr/X11R6/lib/libXinerama.1.dylib"
slouken@6311
   138
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XINPUT2 "/usr/X11R6/lib/libXi.6.dylib"
slouken@3289
   139
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XRANDR "/usr/X11R6/lib/libXrandr.2.dylib"
slouken@5408
   140
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XSS "/usr/X11R6/lib/libXss.1.dylib"
slouken@5408
   141
#define SDL_VIDEO_DRIVER_X11_DYNAMIC_XVIDMODE "/usr/X11R6/lib/libXxf86vm.1.dylib"
slouken@3289
   142
#define SDL_VIDEO_DRIVER_X11_XINERAMA 1
slouken@3289
   143
#define SDL_VIDEO_DRIVER_X11_XRANDR 1
slouken@5408
   144
#define SDL_VIDEO_DRIVER_X11_XSCRNSAVER 1
icculus@4793
   145
#define SDL_VIDEO_DRIVER_X11_XSHAPE 1
slouken@5408
   146
#define SDL_VIDEO_DRIVER_X11_XVIDMODE 1
dimitris@6318
   147
#define SDL_VIDEO_DRIVER_X11_HAS_XKBKEYCODETOKEYSYM 1
slouken@1422
   148
icculus@6391
   149
#ifdef MAC_OS_X_VERSION_10_8
icculus@6391
   150
/*
icculus@6391
   151
 * No matter the versions targeted, this is the 10.8 or later SDK, so you have
icculus@6391
   152
 *  to use the external Xquartz, which is a more modern Xlib. Previous SDKs
icculus@6391
   153
 *  used an older Xlib.
icculus@6391
   154
 */
icculus@6391
   155
#define SDL_VIDEO_DRIVER_X11_XINPUT2 1
icculus@6391
   156
#define SDL_VIDEO_DRIVER_X11_SUPPORTS_GENERIC_EVENTS 1
icculus@6391
   157
#define SDL_VIDEO_DRIVER_X11_CONST_PARAM_XEXTADDDISPLAY 1
icculus@6391
   158
#endif
icculus@6391
   159
slouken@5088
   160
#ifndef SDL_VIDEO_RENDER_OGL
slouken@7191
   161
#define SDL_VIDEO_RENDER_OGL    1
slouken@5088
   162
#endif
slouken@3290
   163
slouken@1422
   164
/* Enable OpenGL support */
slouken@5088
   165
#ifndef SDL_VIDEO_OPENGL
slouken@7191
   166
#define SDL_VIDEO_OPENGL    1
slouken@5088
   167
#endif
slouken@5088
   168
#ifndef SDL_VIDEO_OPENGL_CGL
slouken@7191
   169
#define SDL_VIDEO_OPENGL_CGL    1
slouken@5088
   170
#endif
slouken@5088
   171
#ifndef SDL_VIDEO_OPENGL_GLX
slouken@7191
   172
#define SDL_VIDEO_OPENGL_GLX    1
slouken@5088
   173
#endif
slouken@1422
   174
icculus@3170
   175
/* Enable system power support */
icculus@3170
   176
#define SDL_POWER_MACOSX 1
icculus@3170
   177
icculus@7667
   178
/* enable filesystem support */
icculus@7667
   179
#define SDL_FILESYSTEM_COCOA   1
icculus@7667
   180
slouken@1422
   181
/* Enable assembly routines */
slouken@7191
   182
#define SDL_ASSEMBLY_ROUTINES   1
slouken@5389
   183
#ifdef __ppc__
slouken@7191
   184
#define SDL_ALTIVEC_BLITTERS    1
slouken@5389
   185
#endif
slouken@1422
   186
slouken@1422
   187
#endif /* _SDL_config_macosx_h */