• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2     SDL - Simple DirectMedia Layer
3     Copyright (C) 1997-2006 Sam Lantinga
4 
5     This library is free software; you can redistribute it and/or
6     modify it under the terms of the GNU Lesser General Public
7     License as published by the Free Software Foundation; either
8     version 2.1 of the License, or (at your option) any later version.
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
13     Lesser General Public License for more details.
14 
15     You should have received a copy of the GNU Lesser General Public
16     License along with this library; if not, write to the Free Software
17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18 
19     Sam Lantinga
20     slouken@libsdl.org
21 */
22 
23 /* This is a general header that includes C language support */
24 
25 #ifndef _SDL_stdinc_h
26 #define _SDL_stdinc_h
27 
28 #include "SDL_config.h"
29 
30 
31 #ifdef HAVE_SYS_TYPES_H
32 #include <sys/types.h>
33 #endif
34 #ifdef HAVE_STDIO_H
35 #include <stdio.h>
36 #endif
37 #if defined(STDC_HEADERS)
38 # include <stdlib.h>
39 # include <stddef.h>
40 # include <stdarg.h>
41 #else
42 # if defined(HAVE_STDLIB_H)
43 #  include <stdlib.h>
44 # elif defined(HAVE_MALLOC_H)
45 #  include <malloc.h>
46 # endif
47 # if defined(HAVE_STDDEF_H)
48 #  include <stddef.h>
49 # endif
50 # if defined(HAVE_STDARG_H)
51 #  include <stdarg.h>
52 # endif
53 #endif
54 #ifdef HAVE_STRING_H
55 # if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
56 #  include <memory.h>
57 # endif
58 # include <string.h>
59 #endif
60 #ifdef HAVE_STRINGS_H
61 # include <strings.h>
62 #endif
63 #if defined(HAVE_INTTYPES_H)
64 # include <inttypes.h>
65 #elif defined(HAVE_STDINT_H)
66 # include <stdint.h>
67 #endif
68 #ifdef HAVE_CTYPE_H
69 # include <ctype.h>
70 #endif
71 #ifdef HAVE_ICONV_H
72 # include <iconv.h>
73 #endif
74 
75 /* The number of elements in an array */
76 #define SDL_arraysize(array)	(sizeof(array)/sizeof(array[0]))
77 #define SDL_TABLESIZE(table)	SDL_arraysize(table)
78 
79 /* Basic data types */
80 typedef enum SDL_bool {
81 	SDL_FALSE = 0,
82 	SDL_TRUE  = 1
83 } SDL_bool;
84 
85 typedef int8_t		Sint8;
86 typedef uint8_t		Uint8;
87 typedef int16_t		Sint16;
88 typedef uint16_t	Uint16;
89 typedef int32_t		Sint32;
90 typedef uint32_t	Uint32;
91 
92 #ifdef SDL_HAS_64BIT_TYPE
93 typedef int64_t		Sint64;
94 #ifndef SYMBIAN32_GCCE
95 typedef uint64_t	Uint64;
96 #endif
97 #else
98 /* This is really just a hack to prevent the compiler from complaining */
99 typedef struct {
100 	Uint32 hi;
101 	Uint32 lo;
102 } Uint64, Sint64;
103 #endif
104 
105 /* Make sure the types really have the right sizes */
106 #define SDL_COMPILE_TIME_ASSERT(name, x)               \
107        typedef int SDL_dummy_ ## name[(x) * 2 - 1]
108 
109 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
110 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
111 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
112 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
113 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
114 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
115 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
116 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
117 
118 /* Check to make sure enums are the size of ints, for structure packing.
119    For both Watcom C/C++ and Borland C/C++ the compiler option that makes
120    enums having the size of an int must be enabled.
121    This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
122 */
123 /* Enable enums always int in CodeWarrior (for MPW use "-enum int") */
124 #ifdef __MWERKS__
125 #pragma enumsalwaysint on
126 #endif
127 
128 typedef enum {
129 	DUMMY_ENUM_VALUE
130 } SDL_DUMMY_ENUM;
131 
132 #ifndef __NDS__
133 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
134 #endif
135 
136 
137 #include "begin_code.h"
138 /* Set up for C function definitions, even when using C++ */
139 #ifdef __cplusplus
140 extern "C" {
141 #endif
142 
143 #ifdef HAVE_MALLOC
144 #define SDL_malloc	malloc
145 #else
146 extern DECLSPEC void * SDLCALL SDL_malloc(size_t size);
147 #endif
148 
149 #ifdef HAVE_CALLOC
150 #define SDL_calloc	calloc
151 #else
152 extern DECLSPEC void * SDLCALL SDL_calloc(size_t nmemb, size_t size);
153 #endif
154 
155 #ifdef HAVE_REALLOC
156 #define SDL_realloc	realloc
157 #else
158 extern DECLSPEC void * SDLCALL SDL_realloc(void *mem, size_t size);
159 #endif
160 
161 #ifdef HAVE_FREE
162 #define SDL_free	free
163 #else
164 extern DECLSPEC void SDLCALL SDL_free(void *mem);
165 #endif
166 
167 #if defined(HAVE_ALLOCA) && !defined(alloca)
168 # if defined(HAVE_ALLOCA_H)
169 #  include <alloca.h>
170 # elif defined(__GNUC__)
171 #  define alloca __builtin_alloca
172 # elif defined(_MSC_VER)
173 #  include <malloc.h>
174 #  define alloca _alloca
175 # elif defined(__WATCOMC__)
176 #  include <malloc.h>
177 # elif defined(__DMC__)
178 #  include <stdlib.h>
179 # elif defined(__AIX__)
180   #pragma alloca
181 # elif defined(__MRC__)
182    void *alloca (unsigned);
183 # else
184    char *alloca ();
185 # endif
186 #endif
187 #ifdef HAVE_ALLOCA
188 #define SDL_stack_alloc(type, count)    (type*)alloca(sizeof(type)*(count))
189 #define SDL_stack_free(data)
190 #else
191 #define SDL_stack_alloc(type, count)    (type*)SDL_malloc(sizeof(type)*(count))
192 #define SDL_stack_free(data)            SDL_free(data)
193 #endif
194 
195 #ifdef HAVE_GETENV
196 #define SDL_getenv	getenv
197 #else
198 extern DECLSPEC char * SDLCALL SDL_getenv(const char *name);
199 #endif
200 
201 #ifdef HAVE_PUTENV
202 #define SDL_putenv	putenv
203 #else
204 extern DECLSPEC int SDLCALL SDL_putenv(const char *variable);
205 #endif
206 
207 #ifdef HAVE_QSORT
208 #define SDL_qsort	qsort
209 #else
210 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size,
211            int (*compare)(const void *, const void *));
212 #endif
213 
214 #ifdef HAVE_ABS
215 #define SDL_abs		abs
216 #else
217 #define SDL_abs(X)	((X) < 0 ? -(X) : (X))
218 #endif
219 
220 #define SDL_min(x, y)	(((x) < (y)) ? (x) : (y))
221 #define SDL_max(x, y)	(((x) > (y)) ? (x) : (y))
222 
223 #ifdef HAVE_CTYPE_H
224 #define SDL_isdigit(X)  isdigit(X)
225 #define SDL_isspace(X)  isspace(X)
226 #define SDL_toupper(X)  toupper(X)
227 #define SDL_tolower(X)  tolower(X)
228 #else
229 #define SDL_isdigit(X)  (((X) >= '0') && ((X) <= '9'))
230 #define SDL_isspace(X)  (((X) == ' ') || ((X) == '\t') || ((X) == '\r') || ((X) == '\n'))
231 #define SDL_toupper(X)  (((X) >= 'a') && ((X) <= 'z') ? ('A'+((X)-'a')) : (X))
232 #define SDL_tolower(X)  (((X) >= 'A') && ((X) <= 'Z') ? ('a'+((X)-'A')) : (X))
233 #endif
234 
235 #ifdef HAVE_MEMSET
236 #define SDL_memset      memset
237 #else
238 extern DECLSPEC void * SDLCALL SDL_memset(void *dst, int c, size_t len);
239 #endif
240 
241 #if defined(__GNUC__) && defined(i386)
242 #define SDL_memset4(dst, val, len)				\
243 do {								\
244 	int u0, u1, u2;						\
245 	__asm__ __volatile__ (					\
246 		"cld\n\t"					\
247 		"rep ; stosl\n\t"				\
248 		: "=&D" (u0), "=&a" (u1), "=&c" (u2)		\
249 		: "0" (dst), "1" (val), "2" ((Uint32)(len))	\
250 		: "memory" );					\
251 } while(0)
252 #endif
253 #ifndef SDL_memset4
254 #define SDL_memset4(dst, val, len)		\
255 do {						\
256 	unsigned _count = (len);		\
257 	unsigned _n = (_count + 3) / 4;		\
258 	Uint32 *_p = (Uint32 *)(dst);		\
259 	Uint32 _val = (val);			\
260         switch (_count % 4) {			\
261         case 0: do {    *_p++ = _val;		\
262         case 3:         *_p++ = _val;		\
263         case 2:         *_p++ = _val;		\
264         case 1:         *_p++ = _val;		\
265 		} while ( --_n );		\
266 	}					\
267 } while(0)
268 #endif
269 
270 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
271 #if defined(__MACH__) && defined(__APPLE__)
272 #define SDL_memcpy(dst, src, len) memcpy(dst, src, len)
273 #elif defined(__GNUC__) && defined(i386)
274 #define SDL_memcpy(dst, src, len)					  \
275 do {									  \
276 	int u0, u1, u2;						  	  \
277 	__asm__ __volatile__ (						  \
278 		"cld\n\t"						  \
279 		"rep ; movsl\n\t"					  \
280 		"testb $2,%b4\n\t"					  \
281 		"je 1f\n\t"						  \
282 		"movsw\n"						  \
283 		"1:\ttestb $1,%b4\n\t"					  \
284 		"je 2f\n\t"						  \
285 		"movsb\n"						  \
286 		"2:"							  \
287 		: "=&c" (u0), "=&D" (u1), "=&S" (u2)			  \
288 		: "0" ((unsigned)(len)/4), "q" (len), "1" (dst),"2" (src) \
289 		: "memory" );						  \
290 } while(0)
291 #endif
292 #ifndef SDL_memcpy
293 #ifdef HAVE_MEMCPY
294 #define SDL_memcpy      memcpy
295 #elif defined(HAVE_BCOPY)
296 #define SDL_memcpy(d, s, n)	bcopy((s), (d), (n))
297 #else
298 extern DECLSPEC void * SDLCALL SDL_memcpy(void *dst, const void *src, size_t len);
299 #endif
300 #endif
301 
302 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
303 #if defined(__MACH__) && defined(__APPLE__)
304 #define SDL_memcpy4(dst, src, len) memcpy(dst, src, (len)*4)
305 #elif defined(__GNUC__) && defined(i386)
306 #define SDL_memcpy4(dst, src, len)				\
307 do {								\
308 	int ecx, edi, esi;					\
309 	__asm__ __volatile__ (					\
310 		"cld\n\t"					\
311 		"rep ; movsl"					\
312 		: "=&c" (ecx), "=&D" (edi), "=&S" (esi)		\
313 		: "0" ((unsigned)(len)), "1" (dst), "2" (src)	\
314 		: "memory" );					\
315 } while(0)
316 #endif
317 #ifndef SDL_memcpy4
318 #define SDL_memcpy4(dst, src, len)	SDL_memcpy(dst, src, (len) << 2)
319 #endif
320 
321 #if defined(__GNUC__) && defined(i386)
322 #define SDL_revcpy(dst, src, len)			\
323 do {							\
324 	int u0, u1, u2;					\
325 	char *dstp = (char *)(dst);			\
326 	char *srcp = (char *)(src);			\
327 	int n = (len);					\
328 	if ( n >= 4 ) {					\
329 	__asm__ __volatile__ (				\
330 		"std\n\t"				\
331 		"rep ; movsl\n\t"			\
332 		: "=&c" (u0), "=&D" (u1), "=&S" (u2)	\
333 		: "0" (n >> 2),				\
334 		  "1" (dstp+(n-4)), "2" (srcp+(n-4))	\
335 		: "memory" );				\
336 	}						\
337 	switch (n & 3) {				\
338 		case 3: dstp[2] = srcp[2];		\
339 		case 2: dstp[1] = srcp[1];		\
340 		case 1: dstp[0] = srcp[0];		\
341 			break;				\
342 		default:				\
343 			break;				\
344 	}						\
345 } while(0)
346 #endif
347 #ifndef SDL_revcpy
348 extern DECLSPEC void * SDLCALL SDL_revcpy(void *dst, const void *src, size_t len);
349 #endif
350 
351 #ifdef HAVE_MEMMOVE
352 #define SDL_memmove     memmove
353 #elif defined(HAVE_BCOPY)
354 #define SDL_memmove(d, s, n)	bcopy((s), (d), (n))
355 #else
356 #define SDL_memmove(dst, src, len)			\
357 do {							\
358 	if ( dst < src ) {				\
359 		SDL_memcpy(dst, src, len);		\
360 	} else {					\
361 		SDL_revcpy(dst, src, len);		\
362 	}						\
363 } while(0)
364 #endif
365 
366 #ifdef HAVE_MEMCMP
367 #define SDL_memcmp      memcmp
368 #else
369 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
370 #endif
371 
372 #ifdef HAVE_STRLEN
373 #define SDL_strlen      strlen
374 #else
375 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *string);
376 #endif
377 
378 #ifdef HAVE_STRLCPY
379 #define SDL_strlcpy     strlcpy
380 #else
381 extern DECLSPEC size_t SDLCALL SDL_strlcpy(char *dst, const char *src, size_t maxlen);
382 #endif
383 
384 #ifdef HAVE_STRLCAT
385 #define SDL_strlcat    strlcat
386 #else
387 extern DECLSPEC size_t SDLCALL SDL_strlcat(char *dst, const char *src, size_t maxlen);
388 #endif
389 
390 #ifdef HAVE_STRDUP
391 #define SDL_strdup     strdup
392 #else
393 extern DECLSPEC char * SDLCALL SDL_strdup(const char *string);
394 #endif
395 
396 #ifdef HAVE__STRREV
397 #define SDL_strrev      _strrev
398 #else
399 extern DECLSPEC char * SDLCALL SDL_strrev(char *string);
400 #endif
401 
402 #ifdef HAVE__STRUPR
403 #define SDL_strupr      _strupr
404 #else
405 extern DECLSPEC char * SDLCALL SDL_strupr(char *string);
406 #endif
407 
408 #ifdef HAVE__STRLWR
409 #define SDL_strlwr      _strlwr
410 #else
411 extern DECLSPEC char * SDLCALL SDL_strlwr(char *string);
412 #endif
413 
414 #ifdef HAVE_STRCHR
415 #define SDL_strchr      strchr
416 #elif defined(HAVE_INDEX)
417 #define SDL_strchr      index
418 #else
419 extern DECLSPEC char * SDLCALL SDL_strchr(const char *string, int c);
420 #endif
421 
422 #ifdef HAVE_STRRCHR
423 #define SDL_strrchr     strrchr
424 #elif defined(HAVE_RINDEX)
425 #define SDL_strrchr     rindex
426 #else
427 extern DECLSPEC char * SDLCALL SDL_strrchr(const char *string, int c);
428 #endif
429 
430 #ifdef HAVE_STRSTR
431 #define SDL_strstr      strstr
432 #else
433 extern DECLSPEC char * SDLCALL SDL_strstr(const char *haystack, const char *needle);
434 #endif
435 
436 #ifdef HAVE_ITOA
437 #define SDL_itoa        itoa
438 #else
439 #define SDL_itoa(value, string, radix)	SDL_ltoa((long)value, string, radix)
440 #endif
441 
442 #ifdef HAVE__LTOA
443 #define SDL_ltoa        _ltoa
444 #else
445 extern DECLSPEC char * SDLCALL SDL_ltoa(long value, char *string, int radix);
446 #endif
447 
448 #ifdef HAVE__UITOA
449 #define SDL_uitoa       _uitoa
450 #else
451 #define SDL_uitoa(value, string, radix)	SDL_ultoa((long)value, string, radix)
452 #endif
453 
454 #ifdef HAVE__ULTOA
455 #define SDL_ultoa       _ultoa
456 #else
457 extern DECLSPEC char * SDLCALL SDL_ultoa(unsigned long value, char *string, int radix);
458 #endif
459 
460 #ifdef HAVE_STRTOL
461 #define SDL_strtol      strtol
462 #else
463 extern DECLSPEC long SDLCALL SDL_strtol(const char *string, char **endp, int base);
464 #endif
465 
466 #ifdef HAVE_STRTOUL
467 #define SDL_strtoul      strtoul
468 #else
469 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *string, char **endp, int base);
470 #endif
471 
472 #ifdef SDL_HAS_64BIT_TYPE
473 
474 #ifdef HAVE__I64TOA
475 #define SDL_lltoa       _i64toa
476 #else
477 extern DECLSPEC char* SDLCALL SDL_lltoa(Sint64 value, char *string, int radix);
478 #endif
479 
480 #ifdef HAVE__UI64TOA
481 #define SDL_ulltoa      _ui64toa
482 #else
483 extern DECLSPEC char* SDLCALL SDL_ulltoa(Uint64 value, char *string, int radix);
484 #endif
485 
486 #ifdef HAVE_STRTOLL
487 #define SDL_strtoll     strtoll
488 #else
489 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *string, char **endp, int base);
490 #endif
491 
492 #ifdef HAVE_STRTOULL
493 #define SDL_strtoull     strtoull
494 #else
495 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *string, char **endp, int base);
496 #endif
497 
498 #endif /* SDL_HAS_64BIT_TYPE */
499 
500 #ifdef HAVE_STRTOD
501 #define SDL_strtod      strtod
502 #else
503 extern DECLSPEC double SDLCALL SDL_strtod(const char *string, char **endp);
504 #endif
505 
506 #ifdef HAVE_ATOI
507 #define SDL_atoi        atoi
508 #else
509 #define SDL_atoi(X)     SDL_strtol(X, NULL, 0)
510 #endif
511 
512 #ifdef HAVE_ATOF
513 #define SDL_atof        atof
514 #else
515 #define SDL_atof(X)     SDL_strtod(X, NULL)
516 #endif
517 
518 #ifdef HAVE_STRCMP
519 #define SDL_strcmp      strcmp
520 #else
521 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
522 #endif
523 
524 #ifdef HAVE_STRNCMP
525 #define SDL_strncmp     strncmp
526 #else
527 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
528 #endif
529 
530 #ifdef HAVE_STRCASECMP
531 #define SDL_strcasecmp  strcasecmp
532 #elif defined(HAVE__STRICMP)
533 #define SDL_strcasecmp  _stricmp
534 #else
535 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
536 #endif
537 
538 #ifdef HAVE_STRNCASECMP
539 #define SDL_strncasecmp strncasecmp
540 #elif defined(HAVE__STRNICMP)
541 #define SDL_strncasecmp _strnicmp
542 #else
543 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t maxlen);
544 #endif
545 
546 #ifdef HAVE_SSCANF
547 #define SDL_sscanf      sscanf
548 #else
549 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, const char *fmt, ...);
550 #endif
551 
552 #ifdef HAVE_SNPRINTF
553 #define SDL_snprintf    snprintf
554 #else
555 extern DECLSPEC int SDLCALL SDL_snprintf(char *text, size_t maxlen, const char *fmt, ...);
556 #endif
557 
558 #ifdef HAVE_VSNPRINTF
559 #define SDL_vsnprintf   vsnprintf
560 #else
561 extern DECLSPEC int SDLCALL SDL_vsnprintf(char *text, size_t maxlen, const char *fmt, va_list ap);
562 #endif
563 
564 /* The SDL implementation of iconv() returns these error codes */
565 #define SDL_ICONV_ERROR		(size_t)-1
566 #define SDL_ICONV_E2BIG		(size_t)-2
567 #define SDL_ICONV_EILSEQ	(size_t)-3
568 #define SDL_ICONV_EINVAL	(size_t)-4
569 
570 #ifdef HAVE_ICONV
571 #define SDL_iconv_t     iconv_t
572 #define SDL_iconv_open  iconv_open
573 #define SDL_iconv_close iconv_close
574 #else
575 typedef struct _SDL_iconv_t *SDL_iconv_t;
576 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode, const char *fromcode);
577 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
578 #endif
579 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
580 /* This function converts a string between encodings in one pass, returning a
581    string that must be freed with SDL_free() or NULL on error.
582 */
583 extern DECLSPEC char * SDLCALL SDL_iconv_string(const char *tocode, const char *fromcode, const char *inbuf, size_t inbytesleft);
584 #define SDL_iconv_utf8_locale(S)	SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
585 #define SDL_iconv_utf8_ucs2(S)		(Uint16 *)SDL_iconv_string("UCS-2", "UTF-8", S, SDL_strlen(S)+1)
586 #define SDL_iconv_utf8_ucs4(S)		(Uint32 *)SDL_iconv_string("UCS-4", "UTF-8", S, SDL_strlen(S)+1)
587 
588 /* Ends C function definitions when using C++ */
589 #ifdef __cplusplus
590 }
591 #endif
592 #include "close_code.h"
593 
594 #endif /* _SDL_stdinc_h */
595