SDL  2.0
SDL_power.c
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 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 #include "../SDL_internal.h"
22 #include "SDL_power.h"
23 #include "SDL_syspower.h"
24 
25 /*
26  * Returns SDL_TRUE if we have a definitive answer.
27  * SDL_FALSE to try next implementation.
28  */
29 typedef SDL_bool
30  (*SDL_GetPowerInfo_Impl) (SDL_PowerState * state, int *seconds,
31  int *percent);
32 
33 #ifndef SDL_POWER_DISABLED
34 #ifdef SDL_POWER_HARDWIRED
35 /* This is for things that _never_ have a battery */
36 static SDL_bool
37 SDL_GetPowerInfo_Hardwired(SDL_PowerState * state, int *seconds, int *percent)
38 {
39  *seconds = -1;
40  *percent = -1;
41  *state = SDL_POWERSTATE_NO_BATTERY;
42  return SDL_TRUE;
43 }
44 #endif
45 
46 static SDL_GetPowerInfo_Impl implementations[] = {
47 #ifdef SDL_POWER_LINUX /* in order of preference. More than could work. */
48  SDL_GetPowerInfo_Linux_org_freedesktop_upower,
49  SDL_GetPowerInfo_Linux_sys_class_power_supply,
50  SDL_GetPowerInfo_Linux_proc_acpi,
51  SDL_GetPowerInfo_Linux_proc_apm,
52 #endif
53 #ifdef SDL_POWER_WINDOWS /* handles Win32, Win64, PocketPC. */
54  SDL_GetPowerInfo_Windows,
55 #endif
56 #ifdef SDL_POWER_UIKIT /* handles iPhone/iPad/etc */
57  SDL_GetPowerInfo_UIKit,
58 #endif
59 #ifdef SDL_POWER_MACOSX /* handles Mac OS X, Darwin. */
60  SDL_GetPowerInfo_MacOSX,
61 #endif
62 #ifdef SDL_POWER_HAIKU /* with BeOS euc.jp apm driver. Does this work on Haiku? */
63  SDL_GetPowerInfo_Haiku,
64 #endif
65 #ifdef SDL_POWER_ANDROID /* handles Android. */
66  SDL_GetPowerInfo_Android,
67 #endif
68 #ifdef SDL_POWER_PSP /* handles PSP. */
69  SDL_GetPowerInfo_PSP,
70 #endif
71 #ifdef SDL_POWER_WINRT /* handles WinRT */
72  SDL_GetPowerInfo_WinRT,
73 #endif
74 #ifdef SDL_POWER_EMSCRIPTEN /* handles Emscripten */
75  SDL_GetPowerInfo_Emscripten,
76 #endif
77 
78 #ifdef SDL_POWER_HARDWIRED
79  SDL_GetPowerInfo_Hardwired,
80 #endif
81 };
82 #endif
83 
84 SDL_PowerState
85 SDL_GetPowerInfo(int *seconds, int *percent)
86 {
87 #ifndef SDL_POWER_DISABLED
88  const int total = sizeof(implementations) / sizeof(implementations[0]);
89  SDL_PowerState retval = SDL_POWERSTATE_UNKNOWN;
90  int i;
91 #endif
92 
93  int _seconds, _percent;
94  /* Make these never NULL for platform-specific implementations. */
95  if (seconds == NULL) {
96  seconds = &_seconds;
97  }
98  if (percent == NULL) {
99  percent = &_percent;
100  }
101 
102 #ifndef SDL_POWER_DISABLED
103  for (i = 0; i < total; i++) {
104  if (implementations[i](&retval, seconds, percent)) {
105  return retval;
106  }
107  }
108 #endif
109 
110  /* nothing was definitive. */
111  *seconds = -1;
112  *percent = -1;
113  return SDL_POWERSTATE_UNKNOWN;
114 }
115 
116 /* vi: set ts=4 sw=4 expandtab: */