Mercurial > sdl-ios-xcode
annotate include/SDL_thread.h @ 3311:0679e03ef8fa
Fixed bug #704
Dennis 2009-02-20 15:36:49 PST
When trying to run a parallel build, gcc will not be able to find SDL_revision.h
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sat, 26 Sep 2009 09:44:52 +0000 |
| parents | a67a961e2171 |
| children | d3baf5ac4e37 |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
| 2859 | 3 Copyright (C) 1997-2009 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:
1190
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:
1190
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:
1190
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:
1190
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:
1190
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:
1190
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 23 #ifndef _SDL_thread_h | |
| 24 #define _SDL_thread_h | |
| 25 | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
26 /** |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
27 * \file SDL_thread.h |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
28 * |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
29 * Header for the SDL thread management routines |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
30 */ |
| 0 | 31 |
|
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
32 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
33 #include "SDL_error.h" |
| 0 | 34 |
| 35 /* Thread synchronization primitives */ | |
| 36 #include "SDL_mutex.h" | |
| 37 | |
| 38 #include "begin_code.h" | |
| 39 /* Set up for C function definitions, even when using C++ */ | |
| 40 #ifdef __cplusplus | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
41 /* *INDENT-OFF* */ |
| 0 | 42 extern "C" { |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
43 /* *INDENT-ON* */ |
| 0 | 44 #endif |
| 45 | |
| 46 /* The SDL thread structure, defined in SDL_thread.c */ | |
| 47 struct SDL_Thread; | |
| 48 typedef struct SDL_Thread SDL_Thread; | |
| 49 | |
| 50 /* Create a thread */ | |
|
3269
a67a961e2171
Removed outdated OS/2 support
Sam Lantinga <slouken@libsdl.org>
parents:
2859
diff
changeset
|
51 #if defined(__WIN32__) && !defined(HAVE_LIBC) |
| 1190 | 52 /* |
|
3269
a67a961e2171
Removed outdated OS/2 support
Sam Lantinga <slouken@libsdl.org>
parents:
2859
diff
changeset
|
53 We compile SDL into a DLL. This means, that it's the DLL which |
| 1190 | 54 creates a new thread for the calling process with the SDL_CreateThread() |
| 55 API. There is a problem with this, that only the RTL of the SDL.DLL will | |
| 56 be initialized for those threads, and not the RTL of the calling application! | |
| 57 To solve this, we make a little hack here. | |
| 58 We'll always use the caller's _beginthread() and _endthread() APIs to | |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
59 start a new thread. This way, if it's the SDL.DLL which uses this API, |
| 1190 | 60 then the RTL of SDL.DLL will be used to create the new thread, and if it's |
| 61 the application, then the RTL of the application will be used. | |
| 62 So, in short: | |
| 63 Always use the _beginthread() and _endthread() of the calling runtime library! | |
| 64 */ | |
|
1471
9fb0eee04dd9
Enabled libc support on Win32, so we don't break binary compatibility in 1.2
Sam Lantinga <slouken@libsdl.org>
parents:
1470
diff
changeset
|
65 #define SDL_PASSED_BEGINTHREAD_ENDTHREAD |
|
1465
8dfa9a6d69a5
Updated WinCE support by Dmitry (with some tweaks)
Sam Lantinga <slouken@libsdl.org>
parents:
1442
diff
changeset
|
66 #ifndef _WIN32_WCE |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
67 #include <process.h> /* This has _beginthread() and _endthread() defined! */ |
| 1190 | 68 #endif |
| 69 | |
|
3269
a67a961e2171
Removed outdated OS/2 support
Sam Lantinga <slouken@libsdl.org>
parents:
2859
diff
changeset
|
70 #ifdef __GNUC__ |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
71 typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
72 unsigned |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
73 (__stdcall * |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
74 func) (void *), |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
75 void *arg, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
76 unsigned, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
77 unsigned |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
78 *threadID); |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
79 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code); |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
80 #else |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
81 typedef uintptr_t(__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
82 unsigned (__stdcall * |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
83 func) (void |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
84 *), |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
85 void *arg, unsigned, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
86 unsigned *threadID); |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
87 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code); |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
88 #endif |
| 1190 | 89 |
| 2060 | 90 extern DECLSPEC SDL_Thread *SDLCALL |
| 91 SDL_CreateThread(int (SDLCALL * f) (void *), void *data, | |
| 92 pfnSDL_CurrentBeginThread pfnBeginThread, | |
| 93 pfnSDL_CurrentEndThread pfnEndThread); | |
| 1190 | 94 |
|
3269
a67a961e2171
Removed outdated OS/2 support
Sam Lantinga <slouken@libsdl.org>
parents:
2859
diff
changeset
|
95 #if defined(_WIN32_WCE) |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
96 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL) |
|
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
97 #else |
|
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
98 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex) |
|
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
99 #endif |
| 1190 | 100 #else |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
101 extern DECLSPEC SDL_Thread *SDLCALL |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
102 SDL_CreateThread(int (SDLCALL * fn) (void *), void *data); |
| 1190 | 103 #endif |
| 0 | 104 |
| 105 /* Get the 32-bit thread identifier for the current thread */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
106 extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void); |
| 0 | 107 |
| 108 /* Get the 32-bit thread identifier for the specified thread, | |
| 109 equivalent to SDL_ThreadID() if the specified thread is NULL. | |
| 110 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
111 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread * thread); |
| 0 | 112 |
| 113 /* Wait for a thread to finish. | |
| 114 The return code for the thread function is placed in the area | |
| 115 pointed to by 'status', if 'status' is not NULL. | |
| 116 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
117 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status); |
| 0 | 118 |
| 2779 | 119 /* This function is here for binary compatibility with legacy apps, but |
| 120 in SDL 1.3 and later, it's a no-op. You cannot forcibly kill a thread | |
| 121 in a safe manner on many platforms. You should instead find a way to | |
| 122 alert your thread that it is time to terminate, and then have it gracefully | |
| 123 exit on its own. Do not ever call this function! | |
| 124 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
125 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread); |
| 0 | 126 |
| 127 | |
| 128 /* Ends C function definitions when using C++ */ | |
| 129 #ifdef __cplusplus | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
130 /* *INDENT-OFF* */ |
| 0 | 131 } |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
132 /* *INDENT-ON* */ |
| 0 | 133 #endif |
| 134 #include "close_code.h" | |
| 135 | |
| 136 #endif /* _SDL_thread_h */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
137 |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1850
diff
changeset
|
138 /* vi: set ts=4 sw=4 expandtab: */ |