This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_thread.h
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2009 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
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
23
24
25
*/
#ifndef _SDL_thread_h
#define _SDL_thread_h
27
28
29
* \file SDL_thread.h
*
* Header for the SDL thread management routines.
32
#include "SDL_stdinc.h"
33
#include "SDL_error.h"
34
35
36
37
38
39
40
/* Thread synchronization primitives */
#include "SDL_mutex.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
41
/* *INDENT-OFF* */
42
extern "C" {
43
/* *INDENT-ON* */
44
45
46
47
48
49
#endif
/* The SDL thread structure, defined in SDL_thread.c */
struct SDL_Thread;
typedef struct SDL_Thread SDL_Thread;
50
51
52
/* The SDL thread ID */
typedef unsigned long SDL_threadID;
53
#if defined(__WIN32__) && !defined(HAVE_LIBC)
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/**
* \file SDL_thread.h
*
* We compile SDL into a DLL. This means, that it's the DLL which
* creates a new thread for the calling process with the SDL_CreateThread()
* API. There is a problem with this, that only the RTL of the SDL.DLL will
* be initialized for those threads, and not the RTL of the calling
* application!
*
* To solve this, we make a little hack here.
*
* We'll always use the caller's _beginthread() and _endthread() APIs to
* start a new thread. This way, if it's the SDL.DLL which uses this API,
* then the RTL of SDL.DLL will be used to create the new thread, and if it's
* the application, then the RTL of the application will be used.
*
* So, in short:
* Always use the _beginthread() and _endthread() of the calling runtime
* library!
*/
74
#define SDL_PASSED_BEGINTHREAD_ENDTHREAD
75
#ifndef _WIN32_WCE
76
#include <process.h> /* This has _beginthread() and _endthread() defined! */
77
78
#endif
79
#ifdef __GNUC__
80
81
82
83
84
85
86
87
88
typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
unsigned
(__stdcall *
func) (void *),
void *arg,
unsigned,
unsigned
*threadID);
typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
90
91
92
93
94
95
96
typedef uintptr_t(__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
unsigned (__stdcall *
func) (void
*),
void *arg, unsigned,
unsigned *threadID);
typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
99
100
101
/**
* Create a thread.
*/
102
103
104
105
extern DECLSPEC SDL_Thread *SDLCALL
SDL_CreateThread(int (SDLCALL * f) (void *), void *data,
pfnSDL_CurrentBeginThread pfnBeginThread,
pfnSDL_CurrentEndThread pfnEndThread);
106
107
#if defined(_WIN32_WCE)
108
109
110
111
/**
* Create a thread.
*/
112
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
115
116
117
118
/**
* Create a thread.
*/
119
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
122
#else
123
124
125
126
/**
* Create a thread.
*/
127
128
extern DECLSPEC SDL_Thread *SDLCALL
SDL_CreateThread(int (SDLCALL * fn) (void *), void *data);
130
#endif
132
/**
133
* Get the thread identifier for the current thread.
134
*/
135
extern DECLSPEC SDL_threadID SDLCALL SDL_ThreadID(void);
137
/**
138
* Get the thread identifier for the specified thread.
139
140
*
* Equivalent to SDL_ThreadID() if the specified thread is NULL.
141
*/
142
extern DECLSPEC SDL_threadID SDLCALL SDL_GetThreadID(SDL_Thread * thread);
144
145
146
147
148
/**
* Wait for a thread to finish.
*
* The return code for the thread function is placed in the area
* pointed to by \c status, if \c status is not NULL.
149
*/
150
extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
152
153
154
155
156
157
158
/**
* \deprecated This function is here for binary compatibility with legacy apps,
* but in SDL 1.3 and later, it's a no-op.
*
* You cannot forcibly kill a thread in a safe manner on many platforms. You
* should instead find a way to alert your thread that it is time to terminate,
* and then have it gracefully exit on its own. Do not ever call this function!
159
*/
160
extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);
161
162
163
164
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
165
/* *INDENT-OFF* */
166
}
167
/* *INDENT-ON* */
168
169
170
171
#endif
#include "close_code.h"
#endif /* _SDL_thread_h */
172
173
/* vi: set ts=4 sw=4 expandtab: */