include/SDL_config.h.in
author David Ludwig <dludwig@pobox.com>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 9164 494876610c49
child 9278 8900afb78a19
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).
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 #ifndef _SDL_config_h
    23 #define _SDL_config_h
    24 
    25 /**
    26  *  \file SDL_config.h.in
    27  *
    28  *  This is a set of defines to configure the SDL features
    29  */
    30 
    31 /* General platform specific identifiers */
    32 #include "SDL_platform.h"
    33 
    34 /* Make sure that this isn't included by Visual C++ */
    35 #ifdef _MSC_VER
    36 #error You should run hg revert SDL_config.h 
    37 #endif
    38 
    39 /* C language features */
    40 #undef const
    41 #undef inline
    42 #undef volatile
    43 
    44 /* C datatypes */
    45 #ifdef __LP64__
    46 #define SIZEOF_VOIDP 8
    47 #else
    48 #define SIZEOF_VOIDP 4
    49 #endif
    50 #undef HAVE_GCC_ATOMICS
    51 #undef HAVE_GCC_SYNC_LOCK_TEST_AND_SET
    52 
    53 #undef HAVE_DDRAW_H
    54 #undef HAVE_DINPUT_H
    55 #undef HAVE_DSOUND_H
    56 #undef HAVE_DXGI_H
    57 #undef HAVE_XINPUT_H
    58 
    59 /* Comment this if you want to build without any C library requirements */
    60 #undef HAVE_LIBC
    61 #if HAVE_LIBC
    62 
    63 /* Useful headers */
    64 #undef HAVE_ALLOCA_H
    65 #undef HAVE_SYS_TYPES_H
    66 #undef HAVE_STDIO_H
    67 #undef STDC_HEADERS
    68 #undef HAVE_STDLIB_H
    69 #undef HAVE_STDARG_H
    70 #undef HAVE_MALLOC_H
    71 #undef HAVE_MEMORY_H
    72 #undef HAVE_STRING_H
    73 #undef HAVE_STRINGS_H
    74 #undef HAVE_INTTYPES_H
    75 #undef HAVE_STDINT_H
    76 #undef HAVE_CTYPE_H
    77 #undef HAVE_MATH_H
    78 #undef HAVE_ICONV_H
    79 #undef HAVE_SIGNAL_H
    80 #undef HAVE_ALTIVEC_H
    81 #undef HAVE_PTHREAD_NP_H
    82 #undef HAVE_LIBUDEV_H
    83 #undef HAVE_DBUS_DBUS_H
    84 #undef HAVE_IBUS_IBUS_H
    85 
    86 /* C library functions */
    87 #undef HAVE_MALLOC
    88 #undef HAVE_CALLOC
    89 #undef HAVE_REALLOC
    90 #undef HAVE_FREE
    91 #undef HAVE_ALLOCA
    92 #ifndef __WIN32__ /* Don't use C runtime versions of these on Windows */
    93 #undef HAVE_GETENV
    94 #undef HAVE_SETENV
    95 #undef HAVE_PUTENV
    96 #undef HAVE_UNSETENV
    97 #endif
    98 #undef HAVE_QSORT
    99 #undef HAVE_ABS
   100 #undef HAVE_BCOPY
   101 #undef HAVE_MEMSET
   102 #undef HAVE_MEMCPY
   103 #undef HAVE_MEMMOVE
   104 #undef HAVE_MEMCMP
   105 #undef HAVE_STRLEN
   106 #undef HAVE_STRLCPY
   107 #undef HAVE_STRLCAT
   108 #undef HAVE_STRDUP
   109 #undef HAVE__STRREV
   110 #undef HAVE__STRUPR
   111 #undef HAVE__STRLWR
   112 #undef HAVE_INDEX
   113 #undef HAVE_RINDEX
   114 #undef HAVE_STRCHR
   115 #undef HAVE_STRRCHR
   116 #undef HAVE_STRSTR
   117 #undef HAVE_ITOA
   118 #undef HAVE__LTOA
   119 #undef HAVE__UITOA
   120 #undef HAVE__ULTOA
   121 #undef HAVE_STRTOL
   122 #undef HAVE_STRTOUL
   123 #undef HAVE__I64TOA
   124 #undef HAVE__UI64TOA
   125 #undef HAVE_STRTOLL
   126 #undef HAVE_STRTOULL
   127 #undef HAVE_STRTOD
   128 #undef HAVE_ATOI
   129 #undef HAVE_ATOF
   130 #undef HAVE_STRCMP
   131 #undef HAVE_STRNCMP
   132 #undef HAVE__STRICMP
   133 #undef HAVE_STRCASECMP
   134 #undef HAVE__STRNICMP
   135 #undef HAVE_STRNCASECMP
   136 #undef HAVE_SSCANF
   137 #undef HAVE_VSSCANF
   138 #undef HAVE_SNPRINTF
   139 #undef HAVE_VSNPRINTF
   140 #undef HAVE_M_PI
   141 #undef HAVE_ATAN
   142 #undef HAVE_ATAN2
   143 #undef HAVE_ACOS
   144 #undef HAVE_ASIN
   145 #undef HAVE_CEIL
   146 #undef HAVE_COPYSIGN
   147 #undef HAVE_COS
   148 #undef HAVE_COSF
   149 #undef HAVE_FABS
   150 #undef HAVE_FLOOR
   151 #undef HAVE_LOG
   152 #undef HAVE_POW
   153 #undef HAVE_SCALBN
   154 #undef HAVE_SIN
   155 #undef HAVE_SINF
   156 #undef HAVE_SQRT
   157 #undef HAVE_SQRTF
   158 #undef HAVE_TAN
   159 #undef HAVE_TANF
   160 #undef HAVE_FSEEKO
   161 #undef HAVE_FSEEKO64
   162 #undef HAVE_SIGACTION
   163 #undef HAVE_SA_SIGACTION
   164 #undef HAVE_SETJMP
   165 #undef HAVE_NANOSLEEP
   166 #undef HAVE_SYSCONF
   167 #undef HAVE_SYSCTLBYNAME
   168 #undef HAVE_CLOCK_GETTIME
   169 #undef HAVE_GETPAGESIZE
   170 #undef HAVE_MPROTECT
   171 #undef HAVE_ICONV
   172 #undef HAVE_PTHREAD_SETNAME_NP
   173 #undef HAVE_PTHREAD_SET_NAME_NP
   174 #undef HAVE_SEM_TIMEDWAIT
   175 
   176 #else
   177 #define HAVE_STDARG_H   1
   178 #define HAVE_STDDEF_H   1
   179 #define HAVE_STDINT_H   1
   180 #endif /* HAVE_LIBC */
   181 
   182 /* SDL internal assertion support */
   183 #undef SDL_DEFAULT_ASSERT_LEVEL
   184 
   185 /* Allow disabling of core subsystems */
   186 #undef SDL_ATOMIC_DISABLED
   187 #undef SDL_AUDIO_DISABLED
   188 #undef SDL_CPUINFO_DISABLED
   189 #undef SDL_EVENTS_DISABLED
   190 #undef SDL_FILE_DISABLED
   191 #undef SDL_JOYSTICK_DISABLED
   192 #undef SDL_HAPTIC_DISABLED
   193 #undef SDL_LOADSO_DISABLED
   194 #undef SDL_RENDER_DISABLED
   195 #undef SDL_THREADS_DISABLED
   196 #undef SDL_TIMERS_DISABLED
   197 #undef SDL_VIDEO_DISABLED
   198 #undef SDL_POWER_DISABLED
   199 #undef SDL_FILESYSTEM_DISABLED
   200 
   201 /* Enable various audio drivers */
   202 #undef SDL_AUDIO_DRIVER_ALSA
   203 #undef SDL_AUDIO_DRIVER_ALSA_DYNAMIC
   204 #undef SDL_AUDIO_DRIVER_ARTS
   205 #undef SDL_AUDIO_DRIVER_ARTS_DYNAMIC
   206 #undef SDL_AUDIO_DRIVER_PULSEAUDIO
   207 #undef SDL_AUDIO_DRIVER_PULSEAUDIO_DYNAMIC
   208 #undef SDL_AUDIO_DRIVER_HAIKU
   209 #undef SDL_AUDIO_DRIVER_BSD
   210 #undef SDL_AUDIO_DRIVER_COREAUDIO
   211 #undef SDL_AUDIO_DRIVER_DISK
   212 #undef SDL_AUDIO_DRIVER_DUMMY
   213 #undef SDL_AUDIO_DRIVER_ANDROID
   214 #undef SDL_AUDIO_DRIVER_XAUDIO2
   215 #undef SDL_AUDIO_DRIVER_DSOUND
   216 #undef SDL_AUDIO_DRIVER_ESD
   217 #undef SDL_AUDIO_DRIVER_ESD_DYNAMIC
   218 #undef SDL_AUDIO_DRIVER_NACL
   219 #undef SDL_AUDIO_DRIVER_NAS
   220 #undef SDL_AUDIO_DRIVER_NAS_DYNAMIC
   221 #undef SDL_AUDIO_DRIVER_SNDIO
   222 #undef SDL_AUDIO_DRIVER_SNDIO_DYNAMIC
   223 #undef SDL_AUDIO_DRIVER_OSS
   224 #undef SDL_AUDIO_DRIVER_OSS_SOUNDCARD_H
   225 #undef SDL_AUDIO_DRIVER_PAUDIO
   226 #undef SDL_AUDIO_DRIVER_QSA
   227 #undef SDL_AUDIO_DRIVER_SUNAUDIO
   228 #undef SDL_AUDIO_DRIVER_WINMM
   229 #undef SDL_AUDIO_DRIVER_FUSIONSOUND
   230 #undef SDL_AUDIO_DRIVER_FUSIONSOUND_DYNAMIC
   231 
   232 /* Enable various input drivers */
   233 #undef SDL_INPUT_LINUXEV
   234 #undef SDL_INPUT_LINUXKD
   235 #undef SDL_INPUT_TSLIB
   236 #undef SDL_JOYSTICK_HAIKU
   237 #undef SDL_JOYSTICK_DINPUT
   238 #undef SDL_JOYSTICK_XINPUT
   239 #undef SDL_JOYSTICK_DUMMY
   240 #undef SDL_JOYSTICK_IOKIT
   241 #undef SDL_JOYSTICK_LINUX
   242 #undef SDL_JOYSTICK_ANDROID
   243 #undef SDL_JOYSTICK_WINMM
   244 #undef SDL_JOYSTICK_USBHID
   245 #undef SDL_JOYSTICK_USBHID_MACHINE_JOYSTICK_H
   246 #undef SDL_HAPTIC_DUMMY
   247 #undef SDL_HAPTIC_LINUX
   248 #undef SDL_HAPTIC_IOKIT
   249 #undef SDL_HAPTIC_DINPUT
   250 #undef SDL_HAPTIC_XINPUT
   251 
   252 /* Enable various shared object loading systems */
   253 #undef SDL_LOADSO_HAIKU
   254 #undef SDL_LOADSO_DLOPEN
   255 #undef SDL_LOADSO_DUMMY
   256 #undef SDL_LOADSO_LDG
   257 #undef SDL_LOADSO_WINDOWS
   258 
   259 /* Enable various threading systems */
   260 #undef SDL_THREAD_PTHREAD
   261 #undef SDL_THREAD_PTHREAD_RECURSIVE_MUTEX
   262 #undef SDL_THREAD_PTHREAD_RECURSIVE_MUTEX_NP
   263 #undef SDL_THREAD_WINDOWS
   264 
   265 /* Enable various timer systems */
   266 #undef SDL_TIMER_HAIKU
   267 #undef SDL_TIMER_DUMMY
   268 #undef SDL_TIMER_UNIX
   269 #undef SDL_TIMER_WINDOWS
   270 
   271 /* Enable various video drivers */
   272 #undef SDL_VIDEO_DRIVER_HAIKU
   273 #undef SDL_VIDEO_DRIVER_COCOA
   274 #undef SDL_VIDEO_DRIVER_DIRECTFB
   275 #undef SDL_VIDEO_DRIVER_DIRECTFB_DYNAMIC
   276 #undef SDL_VIDEO_DRIVER_DUMMY
   277 #undef SDL_VIDEO_DRIVER_WINDOWS
   278 #undef SDL_VIDEO_DRIVER_WAYLAND
   279 #undef SDL_VIDEO_DRIVER_WAYLAND_QT_TOUCH
   280 #undef SDL_VIDEO_DRIVER_WAYLAND_DYNAMIC
   281 #undef SDL_VIDEO_DRIVER_WAYLAND_DYNAMIC_EGL
   282 #undef SDL_VIDEO_DRIVER_WAYLAND_DYNAMIC_CURSOR
   283 #undef SDL_VIDEO_DRIVER_WAYLAND_DYNAMIC_XKBCOMMON
   284 #undef SDL_VIDEO_DRIVER_MIR
   285 #undef SDL_VIDEO_DRIVER_MIR_DYNAMIC
   286 #undef SDL_VIDEO_DRIVER_MIR_DYNAMIC_XKBCOMMON
   287 #undef SDL_VIDEO_DRIVER_X11
   288 #undef SDL_VIDEO_DRIVER_RPI
   289 #undef SDL_VIDEO_DRIVER_ANDROID
   290 #undef SDL_VIDEO_DRIVER_X11_DYNAMIC
   291 #undef SDL_VIDEO_DRIVER_X11_DYNAMIC_XEXT
   292 #undef SDL_VIDEO_DRIVER_X11_DYNAMIC_XCURSOR
   293 #undef SDL_VIDEO_DRIVER_X11_DYNAMIC_XINERAMA
   294 #undef SDL_VIDEO_DRIVER_X11_DYNAMIC_XINPUT2
   295 #undef SDL_VIDEO_DRIVER_X11_DYNAMIC_XRANDR
   296 #undef SDL_VIDEO_DRIVER_X11_DYNAMIC_XSS
   297 #undef SDL_VIDEO_DRIVER_X11_DYNAMIC_XVIDMODE
   298 #undef SDL_VIDEO_DRIVER_X11_XCURSOR
   299 #undef SDL_VIDEO_DRIVER_X11_XINERAMA
   300 #undef SDL_VIDEO_DRIVER_X11_XINPUT2
   301 #undef SDL_VIDEO_DRIVER_X11_XINPUT2_SUPPORTS_MULTITOUCH
   302 #undef SDL_VIDEO_DRIVER_X11_XRANDR
   303 #undef SDL_VIDEO_DRIVER_X11_XSCRNSAVER
   304 #undef SDL_VIDEO_DRIVER_X11_XSHAPE
   305 #undef SDL_VIDEO_DRIVER_X11_XVIDMODE
   306 #undef SDL_VIDEO_DRIVER_X11_SUPPORTS_GENERIC_EVENTS
   307 #undef SDL_VIDEO_DRIVER_X11_CONST_PARAM_XDATA32
   308 #undef SDL_VIDEO_DRIVER_X11_CONST_PARAM_XEXTADDDISPLAY
   309 #undef SDL_VIDEO_DRIVER_X11_HAS_XKBKEYCODETOKEYSYM
   310 #undef SDL_VIDEO_DRIVER_NACL
   311 #undef SDL_VIDEO_DRIVER_VIVANTE
   312 #undef SDL_VIDEO_DRIVER_VIVANTE_VDK
   313 
   314 #undef SDL_VIDEO_RENDER_D3D
   315 #undef SDL_VIDEO_RENDER_D3D11
   316 #undef SDL_VIDEO_RENDER_OGL
   317 #undef SDL_VIDEO_RENDER_OGL_ES
   318 #undef SDL_VIDEO_RENDER_OGL_ES2
   319 #undef SDL_VIDEO_RENDER_DIRECTFB
   320 
   321 /* Enable OpenGL support */
   322 #undef SDL_VIDEO_OPENGL
   323 #undef SDL_VIDEO_OPENGL_ES
   324 #undef SDL_VIDEO_OPENGL_ES2
   325 #undef SDL_VIDEO_OPENGL_BGL
   326 #undef SDL_VIDEO_OPENGL_CGL
   327 #undef SDL_VIDEO_OPENGL_EGL
   328 #undef SDL_VIDEO_OPENGL_GLX
   329 #undef SDL_VIDEO_OPENGL_WGL
   330 #undef SDL_VIDEO_OPENGL_OSMESA
   331 #undef SDL_VIDEO_OPENGL_OSMESA_DYNAMIC
   332 
   333 /* Enable system power support */
   334 #undef SDL_POWER_LINUX
   335 #undef SDL_POWER_WINDOWS
   336 #undef SDL_POWER_MACOSX
   337 #undef SDL_POWER_HAIKU
   338 #undef SDL_POWER_ANDROID
   339 #undef SDL_POWER_HARDWIRED
   340 
   341 /* Enable system filesystem support */
   342 #undef SDL_FILESYSTEM_HAIKU
   343 #undef SDL_FILESYSTEM_COCOA
   344 #undef SDL_FILESYSTEM_DUMMY
   345 #undef SDL_FILESYSTEM_UNIX
   346 #undef SDL_FILESYSTEM_WINDOWS
   347 #undef SDL_FILESYSTEM_NACL
   348 
   349 /* Enable assembly routines */
   350 #undef SDL_ASSEMBLY_ROUTINES
   351 #undef SDL_ALTIVEC_BLITTERS
   352 
   353 #endif /* _SDL_config_h */