include/SDL_config_psp.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).
     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_psp_h
    23 #define _SDL_config_psp_h
    24 
    25 #include "SDL_platform.h"
    26 
    27 
    28 
    29 #ifdef __GNUC__
    30 #define HAVE_GCC_SYNC_LOCK_TEST_AND_SET 1
    31 #endif
    32 
    33 #define HAVE_GCC_ATOMICS    1
    34 
    35 #define HAVE_ALLOCA_H       1
    36 #define HAVE_SYS_TYPES_H    1
    37 #define HAVE_STDIO_H    1
    38 #define STDC_HEADERS    1
    39 #define HAVE_STRING_H   1
    40 #define HAVE_INTTYPES_H 1
    41 #define HAVE_STDINT_H   1
    42 #define HAVE_CTYPE_H    1
    43 #define HAVE_MATH_H 1
    44 #define HAVE_SIGNAL_H   1
    45 
    46 /* C library functions */
    47 #define HAVE_MALLOC 1
    48 #define HAVE_CALLOC 1
    49 #define HAVE_REALLOC    1
    50 #define HAVE_FREE   1
    51 #define HAVE_ALLOCA 1
    52 #define HAVE_GETENV 1
    53 #define HAVE_SETENV 1
    54 #define HAVE_PUTENV 1
    55 #define HAVE_SETENV 1
    56 #define HAVE_UNSETENV   1
    57 #define HAVE_QSORT  1
    58 #define HAVE_ABS    1
    59 #define HAVE_BCOPY  1
    60 #define HAVE_MEMSET 1
    61 #define HAVE_MEMCPY 1
    62 #define HAVE_MEMMOVE    1
    63 #define HAVE_MEMCMP 1
    64 #define HAVE_STRLEN 1
    65 #define HAVE_STRLCPY    1
    66 #define HAVE_STRLCAT    1
    67 #define HAVE_STRDUP 1
    68 #define HAVE_STRCHR 1
    69 #define HAVE_STRRCHR    1
    70 #define HAVE_STRSTR 1
    71 #define HAVE_STRTOL 1
    72 #define HAVE_STRTOUL    1
    73 #define HAVE_STRTOLL    1
    74 #define HAVE_STRTOULL   1
    75 #define HAVE_STRTOD 1
    76 #define HAVE_ATOI   1
    77 #define HAVE_ATOF   1
    78 #define HAVE_STRCMP 1
    79 #define HAVE_STRNCMP    1
    80 #define HAVE_STRCASECMP 1
    81 #define HAVE_STRNCASECMP 1
    82 #define HAVE_VSSCANF 1
    83 #define HAVE_VSNPRINTF  1
    84 #define HAVE_M_PI   1
    85 #define HAVE_ATAN   1
    86 #define HAVE_ATAN2  1
    87 #define HAVE_ACOS  1
    88 #define HAVE_ASIN  1
    89 #define HAVE_CEIL   1
    90 #define HAVE_COPYSIGN   1
    91 #define HAVE_COS    1
    92 #define HAVE_COSF   1
    93 #define HAVE_FABS   1
    94 #define HAVE_FLOOR  1
    95 #define HAVE_LOG    1
    96 #define HAVE_POW    1
    97 #define HAVE_SCALBN 1
    98 #define HAVE_SIN    1
    99 #define HAVE_SINF   1
   100 #define HAVE_SQRT   1
   101 #define HAVE_SQRTF  1
   102 #define HAVE_TAN    1
   103 #define HAVE_TANF   1
   104 #define HAVE_SETJMP 1
   105 #define HAVE_NANOSLEEP  1
   106 /* #define HAVE_SYSCONF  1 */
   107 /* #define HAVE_SIGACTION    1 */
   108 
   109 
   110 /* PSP isn't that sophisticated */
   111 #define LACKS_SYS_MMAN_H 1
   112 
   113 /* Enable the stub thread support (src/thread/psp/\*.c) */
   114 #define SDL_THREAD_PSP  1
   115 
   116 /* Enable the stub timer support (src/timer/psp/\*.c) */
   117 #define SDL_TIMERS_PSP  1
   118 
   119 /* Enable the stub joystick driver (src/joystick/psp/\*.c) */
   120 #define SDL_JOYSTICK_PSP        1
   121 
   122 /* Enable the stub audio driver (src/audio/psp/\*.c) */
   123 #define SDL_AUDIO_DRIVER_PSP    1
   124 
   125 /* PSP video dirver */
   126 #define SDL_VIDEO_DRIVER_PSP   1
   127 
   128 /* PSP render dirver */
   129 #define SDL_VIDEO_RENDER_PSP   1
   130 
   131 #define SDL_POWER_PSP          1
   132 
   133 /* !!! FIXME: what does PSP do for filesystem stuff? */
   134 #define SDL_FILESYSTEM_DUMMY   1
   135 
   136 /* PSP doesn't have haptic device (src/haptic/dummy/\*.c) */
   137 #define SDL_HAPTIC_DISABLED    1
   138 
   139 /* PSP can't load shared object (src/loadso/dummy/\*.c) */
   140 #define SDL_LOADSO_DISABLED    1
   141 
   142 
   143 #endif /* _SDL_config_psp_h */