Mercurial > sdl-ios-xcode
annotate src/SDL_error.c @ 4139:568c9b3c0167 SDL-1.2
* Added configure option --enable-screensaver, to allow enabling the screensaver by default.
* Use XResetScreenSaver() instead of disabling screensaver entirely.
Full discussion summary from Erik on the SDL mailing list:
Current behaviour
=================
SDL changes the user's display power management settings without
permission from the user and without telling the user.
The interface that it uses to do so is DPMSDisable/DPMSEnable, which
should only ever be used by configuration utilities like KControl, never
by normal application programs, let alone by the libraries that they
use. Using an interface that is not at all intended for what SDL tries
to achieve means that it will not work as it should. Firstly, the power
management is completely disabled during the whole lifetime of the SDL
program, not only when it should be. Secondly, it makes SDL
non-reentrant, meaning that things will break when multiple SDL programs
are clients of the same X server simultaneously. Thirdly, no cleanup
mechanism ensures that the setting is restored if the client does not do
that (for example if it crashes).
In addition to that, this interface is broken on xorg,
[http://bugs.freedesktop.org/show_bug.cgi?id=13962], so what SDL tries
to do does not work at all on that implementation of the X Window
System. (The reason that the DPMSEnable works in KControl is that it
calls DPMSSetTimeout immediately after,
[http://websvn.kde.org/tags/KDE/3.5.9/kdebase/kcontrol/energy/energy.cpp?annotate=774532#l343]).
The problems that the current behaviour causes
==============================================
1. Information leak. When the user is away, someone might see what the
user has on the display when the user counts on the screensaver
preventing this. This does not even require physical access to the
workstation, it is enough to see it from a distance.
2. Draining battery. An SDL program that runs on a laptop will quickly
drain the battery while the user is away. The system will soon shut down
and require recharging before being usable again, while it should in
fact have consumed very little energy if the user's settings would have
been obeyed.
3. Wasting energy. Even if battery issues are not considered, energy as
such is wasted.
4. Display wear. The display may be worn out.
The problems that the current behaviour tries to solve
======================================================
1. Preventing screensaver while playing movies.
Many SDL applications are media players. They have reasons to prevent
screensavers from being activated while a movie is being played. When a
user clicks on the play button it can be interpreted as saying "play
this movie, but do not turn off the display while playing it, because I
will watch it even though I do not interact with the system".
2. Preventing screensaver when some input bypasses X.
Sometimes SDL uses input from another source than the X server, so
that the X server is bypassed. This obviously breaks the screensaver
handling. SDL tries to work around that.
3. Preventing screensaver when all input bypasses X.
There is something called Direct Graphics Access mode, where a
program takes control of both the display and the input devices from the
X server. This obviously means that the X server can not handle the
screensaver alone, since screensaver handling depends on input handling.
SDL does not do what it should to help the X server to handle the
screensaver. Nor does SDL take care of screeensaver handling itself. SDL
simply disables the screensaver completely.
How the problems should be solved
=================================
The correct way for an application program to prevent the screensaver
under X is to call XResetScreenSaver. This was recently discovered and
implemented by the mplayer developers,
[http://svn.mplayerhq.hu/mplayer?view=rev&revision=25637]. SDL needs to
wrap this in an API call (SDL_ResetScreenSaver) and implement it for the
other video targets (if they do not have a corresponding call, SDL
should do what it takes on that particular target, for example sending
fake key events).
1. When a movie is played, the player should reset the screensaver when
the animation is advanced to a new frame. The same applies to anything
similar, like slideshows.
2. When the X server is handling input, it must handle all input
(keyboards, mice, gamepads, ...). This is necessary, not only to be able
to handle the screensaver, but also so that it can send the events to
the correct (the currently active) client. If there is an input device
that the X server can not handle for some reason (such as lack of Plug
and Play capability), the program that handles the device as a
workaround must simulate what would happen if the X server would have
handled the device, by calling XResetScreenSaver when input is received
from the device.
3. When the X server is not handling the input, it depends on the
program that does to call XResetScreenSaver whenever an input event
occurs. Alternatively the program must handle the screensaver countdown
internally and call XActivateScreenSaver.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 29 Feb 2008 13:55:44 +0000 |
parents | 845bcffc0dd8 |
children | c121d94672cb a1b03ba2fcd0 |
rev | line source |
---|---|
0 | 1 /* |
2 SDL - Simple DirectMedia Layer | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
3 Copyright (C) 1997-2006 Sam Lantinga |
0 | 4 |
5 This library is free software; you can redistribute it and/or | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
0 | 7 License as published by the Free Software Foundation; either |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
0 | 9 |
10 This library is distributed in the hope that it will be useful, | |
11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
13 Lesser General Public License for more details. |
0 | 14 |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
0 | 18 |
19 Sam Lantinga | |
252
e8157fcb3114
Updated the source with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
1
diff
changeset
|
20 slouken@libsdl.org |
0 | 21 */ |
1402
d910939febfa
Use consistent identifiers for the various platforms we support.
Sam Lantinga <slouken@libsdl.org>
parents:
1379
diff
changeset
|
22 #include "SDL_config.h" |
0 | 23 |
24 /* Simple error handling in SDL */ | |
25 | |
26 #include "SDL_error.h" | |
27 #include "SDL_error_c.h" | |
28 | |
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
29 /* Routine to get the thread-specific error variable */ |
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
30 #if SDL_THREADS_DISABLED |
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
31 /* The SDL_arraysize(The ),default (non-thread-safe) global error variable */ |
0 | 32 static SDL_error SDL_global_error; |
33 #define SDL_GetErrBuf() (&SDL_global_error) | |
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
34 #else |
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
35 extern SDL_error *SDL_GetErrBuf(void); |
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
36 #endif /* SDL_THREADS_DISABLED */ |
0 | 37 |
38 #define SDL_ERRBUFIZE 1024 | |
39 | |
40 /* Private functions */ | |
41 | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
42 static const char *SDL_LookupString(const char *key) |
0 | 43 { |
44 /* FIXME: Add code to lookup key in language string hash-table */ | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
45 return key; |
0 | 46 } |
47 | |
48 /* Public functions */ | |
49 | |
50 void SDL_SetError (const char *fmt, ...) | |
51 { | |
52 va_list ap; | |
53 SDL_error *error; | |
54 | |
55 /* Copy in the key, mark error as valid */ | |
56 error = SDL_GetErrBuf(); | |
57 error->error = 1; | |
1379
c0a74f199ecf
Use only safe string functions
Sam Lantinga <slouken@libsdl.org>
parents:
1361
diff
changeset
|
58 SDL_strlcpy((char *)error->key, fmt, sizeof(error->key)); |
0 | 59 |
60 va_start(ap, fmt); | |
61 error->argc = 0; | |
62 while ( *fmt ) { | |
63 if ( *fmt++ == '%' ) { | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
64 while ( *fmt == '.' || (*fmt >= '0' && *fmt <= '9') ) { |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
65 ++fmt; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
66 } |
0 | 67 switch (*fmt++) { |
68 case 0: /* Malformed format string.. */ | |
69 --fmt; | |
70 break; | |
71 case 'c': | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
72 case 'i': |
0 | 73 case 'd': |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
74 case 'u': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
75 case 'o': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
76 case 'x': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
77 case 'X': |
0 | 78 error->args[error->argc++].value_i = |
79 va_arg(ap, int); | |
80 break; | |
81 case 'f': | |
82 error->args[error->argc++].value_f = | |
83 va_arg(ap, double); | |
84 break; | |
85 case 'p': | |
86 error->args[error->argc++].value_ptr = | |
87 va_arg(ap, void *); | |
88 break; | |
89 case 's': | |
90 { | |
1612
97d0966f4bf7
Fixed some ultra-pedantic gcc warnings
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
91 int i = error->argc; |
97d0966f4bf7
Fixed some ultra-pedantic gcc warnings
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
92 const char *str = va_arg(ap, const char *); |
1172
f69f4d25fb20
Don't crash if a NULL is passed for a "%s" parameter to SDL_SetError(),
Ryan C. Gordon <icculus@icculus.org>
parents:
769
diff
changeset
|
93 if (str == NULL) |
f69f4d25fb20
Don't crash if a NULL is passed for a "%s" parameter to SDL_SetError(),
Ryan C. Gordon <icculus@icculus.org>
parents:
769
diff
changeset
|
94 str = "(null)"; |
1612
97d0966f4bf7
Fixed some ultra-pedantic gcc warnings
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
95 SDL_strlcpy((char *)error->args[i].buf, str, ERR_MAX_STRLEN); |
0 | 96 error->argc++; |
97 } | |
98 break; | |
99 default: | |
100 break; | |
101 } | |
102 if ( error->argc >= ERR_MAX_ARGS ) { | |
103 break; | |
104 } | |
105 } | |
106 } | |
107 va_end(ap); | |
108 | |
109 /* If we are in debug mode, print out an error message */ | |
110 #ifdef DEBUG_ERROR | |
111 fprintf(stderr, "SDL_SetError: %s\n", SDL_GetError()); | |
112 #endif | |
113 } | |
114 | |
115 /* This function has a bit more overhead than most error functions | |
116 so that it supports internationalization and thread-safe errors. | |
117 */ | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
118 char *SDL_GetErrorMsg(char *errstr, unsigned int maxlen) |
0 | 119 { |
120 SDL_error *error; | |
121 | |
122 /* Clear the error string */ | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
123 *errstr = '\0'; --maxlen; |
0 | 124 |
125 /* Get the thread-safe error, and print it out */ | |
126 error = SDL_GetErrBuf(); | |
127 if ( error->error ) { | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
128 const char *fmt; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
129 char *msg = errstr; |
0 | 130 int len; |
131 int argi; | |
132 | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
133 fmt = SDL_LookupString(error->key); |
0 | 134 argi = 0; |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
135 while ( *fmt && (maxlen > 0) ) { |
0 | 136 if ( *fmt == '%' ) { |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
137 char tmp[32], *spot = tmp; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
138 *spot++ = *fmt++; |
1847
845bcffc0dd8
Updated RPM spec file with License keyword
Sam Lantinga <slouken@libsdl.org>
parents:
1824
diff
changeset
|
139 while ( (*fmt == '.' || (*fmt >= '0' && *fmt <= '9')) && spot < (tmp+SDL_arraysize(tmp)-2) ) { |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
140 *spot++ = *fmt++; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
141 } |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
142 *spot++ = *fmt++; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
143 *spot++ = '\0'; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
144 switch (spot[-2]) { |
0 | 145 case '%': |
146 *msg++ = '%'; | |
147 maxlen -= 1; | |
148 break; | |
149 case 'c': | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
150 case 'i': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
151 case 'd': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
152 case 'u': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
153 case 'o': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
154 case 'x': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
155 case 'X': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
156 len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_i); |
0 | 157 msg += len; |
158 maxlen -= len; | |
159 break; | |
160 case 'f': | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
161 len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_f); |
0 | 162 msg += len; |
163 maxlen -= len; | |
164 break; | |
165 case 'p': | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
166 len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_ptr); |
0 | 167 msg += len; |
168 maxlen -= len; | |
169 break; | |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
170 case 's': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
171 len = SDL_snprintf(msg, maxlen, tmp, SDL_LookupString(error->args[argi++].buf)); |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
172 msg += len; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
173 maxlen -= len; |
0 | 174 break; |
175 } | |
176 } else { | |
177 *msg++ = *fmt++; | |
178 maxlen -= 1; | |
179 } | |
180 } | |
181 *msg = 0; /* NULL terminate the string */ | |
182 } | |
183 return(errstr); | |
184 } | |
185 | |
186 /* Available for backwards compatibility */ | |
187 char *SDL_GetError (void) | |
188 { | |
189 static char errmsg[SDL_ERRBUFIZE]; | |
190 | |
1824
e25445333ccf
Fixed signed/unsigned issues
Sam Lantinga <slouken@libsdl.org>
parents:
1818
diff
changeset
|
191 return((char *)SDL_GetErrorMsg(errmsg, SDL_ERRBUFIZE)); |
0 | 192 } |
193 | |
194 void SDL_ClearError(void) | |
195 { | |
196 SDL_error *error; | |
197 | |
198 error = SDL_GetErrBuf(); | |
199 error->error = 0; | |
200 } | |
201 | |
202 /* Very common errors go here */ | |
203 void SDL_Error(SDL_errorcode code) | |
204 { | |
205 switch (code) { | |
206 case SDL_ENOMEM: | |
207 SDL_SetError("Out of memory"); | |
208 break; | |
209 case SDL_EFREAD: | |
210 SDL_SetError("Error reading from datastream"); | |
211 break; | |
212 case SDL_EFWRITE: | |
213 SDL_SetError("Error writing to datastream"); | |
214 break; | |
215 case SDL_EFSEEK: | |
216 SDL_SetError("Error seeking in datastream"); | |
217 break; | |
218 default: | |
219 SDL_SetError("Unknown SDL error"); | |
220 break; | |
221 } | |
222 } | |
223 | |
224 #ifdef TEST_ERROR | |
225 int main(int argc, char *argv[]) | |
226 { | |
227 char buffer[BUFSIZ+1]; | |
228 | |
229 SDL_SetError("Hi there!"); | |
230 printf("Error 1: %s\n", SDL_GetError()); | |
231 SDL_ClearError(); | |
1336
3692456e7b0f
Use SDL_ prefixed versions of C library functions.
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
232 SDL_memset(buffer, '1', BUFSIZ); |
0 | 233 buffer[BUFSIZ] = 0; |
234 SDL_SetError("This is the error: %s (%f)", buffer, 1.0); | |
235 printf("Error 2: %s\n", SDL_GetError()); | |
236 exit(0); | |
237 } | |
238 #endif |