include/SDL_config_minimal.h
author David Ludwig <dludwig@pobox.com>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 8149 681eb46b8ac4
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@1603
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@1603
     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@1603
     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@1603
    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@1603
    20
*/
slouken@1603
    21
slouken@1603
    22
#ifndef _SDL_config_minimal_h
slouken@1603
    23
#define _SDL_config_minimal_h
slouken@1608
    24
slouken@1608
    25
#include "SDL_platform.h"
slouken@1603
    26
slouken@3407
    27
/**
slouken@3407
    28
 *  \file SDL_config_minimal.h
slouken@7191
    29
 *
slouken@3407
    30
 *  This is the minimal configuration that can be used to build SDL.
slouken@3407
    31
 */
slouken@1603
    32
slouken@7307
    33
#define HAVE_STDARG_H   1
slouken@7307
    34
#define HAVE_STDDEF_H   1
slouken@1603
    35
slouken@7307
    36
/* Most everything except Visual Studio 2008 and earlier has stdint.h now */
slouken@7307
    37
#if defined(_MSC_VER) && (_MSC_VER < 1600)
slouken@7307
    38
/* Here are some reasonable defaults */
slouken@5481
    39
typedef unsigned int size_t;
slouken@1603
    40
typedef signed char int8_t;
slouken@1603
    41
typedef unsigned char uint8_t;
slouken@1603
    42
typedef signed short int16_t;
slouken@1603
    43
typedef unsigned short uint16_t;
slouken@1603
    44
typedef signed int int32_t;
slouken@1603
    45
typedef unsigned int uint32_t;
slouken@5481
    46
typedef signed long long int64_t;
slouken@5481
    47
typedef unsigned long long uint64_t;
slouken@1603
    48
typedef unsigned long uintptr_t;
slouken@7307
    49
#else
slouken@7307
    50
#define HAVE_STDINT_H 1
slouken@7307
    51
#endif /* Visual Studio 2008 */
slouken@1603
    52
slouken@5481
    53
#ifdef __GNUC__
slouken@5481
    54
#define HAVE_GCC_SYNC_LOCK_TEST_AND_SET 1
slouken@5481
    55
#endif
slouken@5481
    56
slouken@1603
    57
/* Enable the dummy audio driver (src/audio/dummy/\*.c) */
slouken@7191
    58
#define SDL_AUDIO_DRIVER_DUMMY  1
slouken@1603
    59
slouken@1603
    60
/* Enable the stub joystick driver (src/joystick/dummy/\*.c) */
slouken@7191
    61
#define SDL_JOYSTICK_DISABLED   1
slouken@1603
    62
slouken@2713
    63
/* Enable the stub haptic driver (src/haptic/dummy/\*.c) */
slouken@7191
    64
#define SDL_HAPTIC_DISABLED 1
slouken@2713
    65
slouken@1603
    66
/* Enable the stub shared object loader (src/loadso/dummy/\*.c) */
slouken@7191
    67
#define SDL_LOADSO_DISABLED 1
slouken@1603
    68
slouken@1603
    69
/* Enable the stub thread support (src/thread/generic/\*.c) */
slouken@7191
    70
#define SDL_THREADS_DISABLED    1
slouken@1603
    71
slouken@1603
    72
/* Enable the stub timer support (src/timer/dummy/\*.c) */
slouken@7191
    73
#define SDL_TIMERS_DISABLED 1
slouken@1603
    74
slouken@1603
    75
/* Enable the dummy video driver (src/video/dummy/\*.c) */
slouken@7191
    76
#define SDL_VIDEO_DRIVER_DUMMY  1
slouken@1603
    77
icculus@7667
    78
/* Enable the dummy filesystem driver (src/filesystem/dummy/\*.c) */
icculus@7667
    79
#define SDL_FILESYSTEM_DUMMY  1
icculus@7667
    80
slouken@1603
    81
#endif /* _SDL_config_minimal_h */