include/SDL_config_wiz.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@3438
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@3438
     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@3438
     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@3438
    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@3438
    20
*/
slouken@3438
    21
slouken@3438
    22
#ifndef _SDL_config_h
slouken@3438
    23
#define _SDL_config_h
slouken@3438
    24
slouken@3438
    25
/* This is a set of defines to configure the SDL features */
slouken@3438
    26
slouken@3438
    27
/* General platform specific identifiers */
slouken@3438
    28
#include "SDL_platform.h"
slouken@3438
    29
slouken@3438
    30
#define SDL_BYTEORDER 1234
slouken@3438
    31
slouken@3438
    32
#define HAVE_ALLOCA_H 1
slouken@3438
    33
#define HAVE_SYS_TYPES_H 1
slouken@3438
    34
#define HAVE_STDIO_H 1
slouken@3438
    35
#define STDC_HEADERS 1
slouken@3438
    36
#define HAVE_STDLIB_H 1
slouken@3438
    37
#define HAVE_STDARG_H 1
slouken@3438
    38
#define HAVE_MALLOC_H 1
slouken@3438
    39
#define HAVE_MEMORY_H 1
slouken@3438
    40
#define HAVE_STRING_H 1
slouken@3438
    41
#define HAVE_STRINGS_H 1
slouken@3438
    42
#define HAVE_INTTYPES_H 1
slouken@3438
    43
#define HAVE_STDINT_H 1
slouken@3438
    44
#define HAVE_CTYPE_H 1
slouken@3438
    45
#define HAVE_MATH_H 1
slouken@3438
    46
#define HAVE_ICONV_H 1
slouken@3438
    47
#define HAVE_SIGNAL_H 1
slouken@3438
    48
#define HAVE_MALLOC 1
slouken@3438
    49
#define HAVE_CALLOC 1
slouken@3438
    50
#define HAVE_REALLOC 1
slouken@3438
    51
#define HAVE_FREE 1
slouken@3438
    52
#define HAVE_ALLOCA 1
slouken@3438
    53
#define HAVE_GETENV 1
slouken@7191
    54
#define HAVE_SETENV 1
slouken@3438
    55
#define HAVE_PUTENV 1
slouken@3438
    56
#define HAVE_UNSETENV 1
slouken@3438
    57
#define HAVE_QSORT 1
slouken@3438
    58
#define HAVE_ABS 1
slouken@3438
    59
#define HAVE_BCOPY 1
slouken@3438
    60
#define HAVE_MEMSET 1
slouken@3438
    61
#define HAVE_MEMCPY 1
slouken@3438
    62
#define HAVE_MEMMOVE 1
slouken@3438
    63
#define HAVE_STRLEN 1
slouken@3438
    64
#define HAVE_STRDUP 1
slouken@3438
    65
#define HAVE_STRCHR 1
slouken@3438
    66
#define HAVE_STRRCHR 1
slouken@3438
    67
#define HAVE_STRSTR 1
slouken@3438
    68
#define HAVE_STRTOL 1
slouken@3438
    69
#define HAVE_STRTOUL 1
slouken@3438
    70
#define HAVE_STRTOLL 1
slouken@3438
    71
#define HAVE_STRTOULL 1
slouken@3438
    72
#define HAVE_ATOI 1
slouken@3438
    73
#define HAVE_ATOF 1
slouken@3438
    74
#define HAVE_STRCMP 1
slouken@3438
    75
#define HAVE_STRNCMP 1
slouken@3438
    76
#define HAVE_STRCASECMP 1
slouken@3438
    77
#define HAVE_STRNCASECMP 1
icculus@8089
    78
#define HAVE_VSSCANF 1
slouken@3438
    79
#define HAVE_VSNPRINTF 1
slouken@3438
    80
#define HAVE_M_PI 1
slouken@3438
    81
#define HAVE_CEIL 1
slouken@3438
    82
#define HAVE_COPYSIGN 1
slouken@3438
    83
#define HAVE_COS 1
slouken@3438
    84
#define HAVE_COSF 1
slouken@3438
    85
#define HAVE_FABS 1
slouken@3438
    86
#define HAVE_FLOOR 1
slouken@3438
    87
#define HAVE_LOG 1
slouken@3438
    88
#define HAVE_SCALBN 1
slouken@3438
    89
#define HAVE_SIN 1
slouken@3438
    90
#define HAVE_SINF 1
slouken@3438
    91
#define HAVE_SQRT 1
slouken@8840
    92
#define HAVE_SQRTF 1
slouken@8840
    93
#define HAVE_TAN 1
slouken@8840
    94
#define HAVE_TANF 1
slouken@3438
    95
#define HAVE_SIGACTION 1
slouken@3438
    96
#define HAVE_SETJMP 1
slouken@3438
    97
#define HAVE_NANOSLEEP 1
slouken@3438
    98
#define HAVE_POW 1
slouken@3438
    99
slouken@3438
   100
#define SDL_CDROM_DISABLED 1
slouken@3438
   101
#define SDL_AUDIO_DRIVER_DUMMY 1
slouken@3438
   102
#define SDL_AUDIO_DRIVER_OSS 1
slouken@3438
   103
slouken@3438
   104
#define SDL_INPUT_LINUXEV 1
slouken@3438
   105
#define SDL_INPUT_TSLIB 1
slouken@3438
   106
#define SDL_JOYSTICK_LINUX 1
slouken@3438
   107
#define SDL_HAPTIC_LINUX 1
slouken@3438
   108
slouken@3438
   109
#define SDL_LOADSO_DLOPEN 1
slouken@3438
   110
slouken@3438
   111
#define SDL_THREAD_PTHREAD 1
slouken@3438
   112
#define SDL_THREAD_PTHREAD_RECURSIVE_MUTEX_NP 1
slouken@3438
   113
slouken@3438
   114
#define SDL_TIMER_UNIX 1
slouken@3438
   115
slouken@3438
   116
#define SDL_VIDEO_DRIVER_DUMMY 1
slouken@3438
   117
#define SDL_VIDEO_DRIVER_PANDORA 1
slouken@3438
   118
#define SDL_VIDEO_RENDER_OGL_ES 1
slouken@3438
   119
#define SDL_VIDEO_OPENGL_ES 1
slouken@3438
   120
slouken@3438
   121
#endif /* _SDL_config_h */