include/SDL_thread.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 24 Jun 2007 18:26:35 +0000
branchSDL-1.2
changeset 3975 e85e65aec22f
parent 1850 d5d3a6fe05a1
child 4159 a1b03ba2fcd0
permissions -rw-r--r--
Added S60 port.
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@1312
     3
    Copyright (C) 1997-2006 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
#ifndef _SDL_thread_h
slouken@0
    24
#define _SDL_thread_h
slouken@0
    25
slouken@0
    26
/* Header for the SDL thread management routines 
slouken@0
    27
slouken@0
    28
	These are independent of the other SDL routines.
slouken@0
    29
*/
slouken@0
    30
slouken@1356
    31
#include "SDL_stdinc.h"
slouken@1358
    32
#include "SDL_error.h"
slouken@0
    33
slouken@0
    34
/* Thread synchronization primitives */
slouken@0
    35
#include "SDL_mutex.h"
slouken@0
    36
slouken@0
    37
#include "begin_code.h"
slouken@0
    38
/* Set up for C function definitions, even when using C++ */
slouken@0
    39
#ifdef __cplusplus
slouken@0
    40
extern "C" {
slouken@0
    41
#endif
slouken@0
    42
slouken@0
    43
/* The SDL thread structure, defined in SDL_thread.c */
slouken@0
    44
struct SDL_Thread;
slouken@0
    45
typedef struct SDL_Thread SDL_Thread;
slouken@0
    46
slouken@0
    47
/* Create a thread */
icculus@3975
    48
#if ((defined(__WIN32__) && !defined(HAVE_LIBC)) || defined(__OS2__)) &&  !defined(__SYMBIAN32__)
icculus@1190
    49
/*
icculus@1190
    50
   We compile SDL into a DLL on OS/2. This means, that it's the DLL which
icculus@1190
    51
   creates a new thread for the calling process with the SDL_CreateThread()
icculus@1190
    52
   API. There is a problem with this, that only the RTL of the SDL.DLL will
icculus@1190
    53
   be initialized for those threads, and not the RTL of the calling application!
icculus@1190
    54
   To solve this, we make a little hack here.
icculus@1190
    55
   We'll always use the caller's _beginthread() and _endthread() APIs to
slouken@1330
    56
   start a new thread. This way, if it's the SDL.DLL which uses this API,
icculus@1190
    57
   then the RTL of SDL.DLL will be used to create the new thread, and if it's
icculus@1190
    58
   the application, then the RTL of the application will be used.
icculus@1190
    59
   So, in short:
icculus@1190
    60
   Always use the _beginthread() and _endthread() of the calling runtime library!
icculus@1190
    61
*/
slouken@1471
    62
#define SDL_PASSED_BEGINTHREAD_ENDTHREAD
slouken@1465
    63
#ifndef _WIN32_WCE
slouken@1471
    64
#include <process.h> /* This has _beginthread() and _endthread() defined! */
icculus@1190
    65
#endif
icculus@1190
    66
slouken@1330
    67
#ifdef __OS2__
slouken@1442
    68
typedef int (*pfnSDL_CurrentBeginThread)(void (*func)(void *), void *, unsigned, void *arg); 
slouken@1442
    69
typedef void (*pfnSDL_CurrentEndThread)(void);
slouken@1470
    70
#elif __GNUC__
slouken@1470
    71
typedef unsigned long (__cdecl *pfnSDL_CurrentBeginThread) (void *, unsigned,
slouken@1470
    72
        unsigned (__stdcall *func)(void *), void *arg, 
slouken@1470
    73
        unsigned, unsigned *threadID);
slouken@1470
    74
typedef void (__cdecl *pfnSDL_CurrentEndThread)(unsigned code);
slouken@1330
    75
#else
slouken@1330
    76
typedef uintptr_t (__cdecl *pfnSDL_CurrentBeginThread) (void *, unsigned,
slouken@1330
    77
        unsigned (__stdcall *func)(void *), void *arg, 
slouken@1330
    78
        unsigned, unsigned *threadID);
slouken@1330
    79
typedef void (__cdecl *pfnSDL_CurrentEndThread)(unsigned code);
slouken@1330
    80
#endif
icculus@1190
    81
slouken@1850
    82
extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data, pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentEndThread pfnEndThread);
icculus@1190
    83
slouken@1330
    84
#ifdef __OS2__
slouken@1330
    85
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthread, _endthread)
slouken@1330
    86
#elif defined(_WIN32_WCE)
slouken@1330
    87
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
slouken@1330
    88
#else
slouken@1330
    89
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
slouken@1330
    90
#endif
icculus@1190
    91
#else
slouken@930
    92
extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data);
icculus@1190
    93
#endif
slouken@0
    94
slouken@0
    95
/* Get the 32-bit thread identifier for the current thread */
slouken@337
    96
extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
slouken@0
    97
slouken@0
    98
/* Get the 32-bit thread identifier for the specified thread,
slouken@0
    99
   equivalent to SDL_ThreadID() if the specified thread is NULL.
slouken@0
   100
 */
slouken@337
   101
extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread *thread);
slouken@0
   102
slouken@0
   103
/* Wait for a thread to finish.
slouken@0
   104
   The return code for the thread function is placed in the area
slouken@0
   105
   pointed to by 'status', if 'status' is not NULL.
slouken@0
   106
 */
slouken@337
   107
extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status);
slouken@0
   108
slouken@0
   109
/* Forcefully kill a thread without worrying about its state */
slouken@337
   110
extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread *thread);
slouken@0
   111
slouken@0
   112
slouken@0
   113
/* Ends C function definitions when using C++ */
slouken@0
   114
#ifdef __cplusplus
slouken@0
   115
}
slouken@0
   116
#endif
slouken@0
   117
#include "close_code.h"
slouken@0
   118
slouken@0
   119
#endif /* _SDL_thread_h */