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
26
27
28
29
30
/**
* \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
50
#endif
/* The SDL thread structure, defined in SDL_thread.c */
struct SDL_Thread;
typedef struct SDL_Thread SDL_Thread;
/* Create a thread */
51
#if defined(__WIN32__) && !defined(HAVE_LIBC)
52
/*
53
We compile SDL into a DLL. This means, that it's the DLL which
54
55
56
57
58
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
59
start a new thread. This way, if it's the SDL.DLL which uses this API,
60
61
62
63
64
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!
*/
65
#define SDL_PASSED_BEGINTHREAD_ENDTHREAD
66
#ifndef _WIN32_WCE
67
#include <process.h> /* This has _beginthread() and _endthread() defined! */
68
69
#endif
70
#ifdef __GNUC__
71
72
73
74
75
76
77
78
79
typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
unsigned
(__stdcall *
func) (void *),
void *arg,
unsigned,
unsigned
*threadID);
typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
81
82
83
84
85
86
87
typedef uintptr_t(__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
extern DECLSPEC SDL_Thread *SDLCALL
SDL_CreateThread(int (SDLCALL * f) (void *), void *data,
pfnSDL_CurrentBeginThread pfnBeginThread,
pfnSDL_CurrentEndThread pfnEndThread);
95
#if defined(_WIN32_WCE)
96
97
98
99
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
#else
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
#endif
100
#else
101
102
extern DECLSPEC SDL_Thread *SDLCALL
SDL_CreateThread(int (SDLCALL * fn) (void *), void *data);
103
#endif
104
105
/* Get the 32-bit thread identifier for the current thread */
106
extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
107
108
109
110
/* Get the 32-bit thread identifier for the specified thread,
equivalent to SDL_ThreadID() if the specified thread is NULL.
*/
111
extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread * thread);
112
113
114
115
116
/* Wait for a thread to finish.
The return code for the thread function is placed in the area
pointed to by 'status', if 'status' is not NULL.
*/
117
extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
119
120
121
122
123
124
/* 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!
*/
125
extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);
126
127
128
129
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
130
/* *INDENT-OFF* */
131
}
132
/* *INDENT-ON* */
133
134
135
136
#endif
#include "close_code.h"
#endif /* _SDL_thread_h */
137
138
/* vi: set ts=4 sw=4 expandtab: */