include/SDL_power.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).
     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_power_h
    23 #define _SDL_power_h
    24 
    25 /**
    26  *  \file SDL_power.h
    27  *
    28  *  Header for the SDL power management routines.
    29  */
    30 
    31 #include "SDL_stdinc.h"
    32 
    33 #include "begin_code.h"
    34 /* Set up for C function definitions, even when using C++ */
    35 #ifdef __cplusplus
    36 extern "C" {
    37 #endif
    38 
    39 /**
    40  *  \brief The basic state for the system's power supply.
    41  */
    42 typedef enum
    43 {
    44     SDL_POWERSTATE_UNKNOWN,      /**< cannot determine power status */
    45     SDL_POWERSTATE_ON_BATTERY,   /**< Not plugged in, running on the battery */
    46     SDL_POWERSTATE_NO_BATTERY,   /**< Plugged in, no battery available */
    47     SDL_POWERSTATE_CHARGING,     /**< Plugged in, charging battery */
    48     SDL_POWERSTATE_CHARGED       /**< Plugged in, battery charged */
    49 } SDL_PowerState;
    50 
    51 
    52 /**
    53  *  \brief Get the current power supply details.
    54  *
    55  *  \param secs Seconds of battery life left. You can pass a NULL here if
    56  *              you don't care. Will return -1 if we can't determine a
    57  *              value, or we're not running on a battery.
    58  *
    59  *  \param pct Percentage of battery life left, between 0 and 100. You can
    60  *             pass a NULL here if you don't care. Will return -1 if we
    61  *             can't determine a value, or we're not running on a battery.
    62  *
    63  *  \return The state of the battery (if any).
    64  */
    65 extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct);
    66 
    67 /* Ends C function definitions when using C++ */
    68 #ifdef __cplusplus
    69 }
    70 #endif
    71 #include "close_code.h"
    72 
    73 #endif /* _SDL_power_h */
    74 
    75 /* vi: set ts=4 sw=4 expandtab: */