include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 01 Feb 2006 06:32:25 +0000
changeset 1312 c9b51268668f
parent 1190 173c063d4f55
child 1330 450721ad5436
permissions -rw-r--r--
Updated copyright information and removed rcs id lines (problematic in branch merges)
I batch edited these files, so please let me know if I've accidentally removed anybody's
credit here.
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@0
    31
#include "SDL_main.h"
slouken@0
    32
#include "SDL_types.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@1190
    48
#ifdef __OS2__
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
icculus@1190
    56
   start a new thread. This way, it 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
*/
icculus@1190
    62
icculus@1190
    63
#ifdef __WATCOMC__
icculus@1190
    64
#include <process.h> // This has _beginthread() and _endthread() defined!
icculus@1190
    65
#endif
icculus@1190
    66
#ifdef __EMX__
icculus@1190
    67
#include <stdlib.h> // This has _beginthread() and _endthread() defined, if -Zmt flag is used!
icculus@1190
    68
#endif
icculus@1190
    69
icculus@1190
    70
typedef Uint32 SDLCALL (*pfnSDL_CurrentBeginThread)(void (*pfnThreadFn)(void *), Uint32 uiStackSize, void *pParam);
icculus@1190
    71
typedef void   SDLCALL (*pfnSDL_CurrentEndThread)(void);
icculus@1190
    72
icculus@1190
    73
extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread_Core(int (*fn)(void *), void *data, pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentEndThread pfnEndThread);
icculus@1190
    74
icculus@1190
    75
// Disable warnings about unreferenced symbol!
icculus@1190
    76
#pragma disable_message (202)
icculus@1190
    77
static Uint32 SDLCALL SDL_CurrentBeginThread(void (*pfnThreadFn)(void *), Uint32 uiStackSize, void *pParam)
icculus@1190
    78
{
icculus@1190
    79
  return _beginthread(pfnThreadFn, NULL, uiStackSize, pParam);
icculus@1190
    80
}
icculus@1190
    81
icculus@1190
    82
static void   SDLCALL SDL_CurrentEndThread(void)
icculus@1190
    83
{
icculus@1190
    84
  _endthread();
icculus@1190
    85
}
icculus@1190
    86
icculus@1190
    87
#define SDL_CreateThread(fn, data) SDL_CreateThread_Core(fn, data, SDL_CurrentBeginThread, SDL_CurrentEndThread)
icculus@1190
    88
icculus@1190
    89
#else
slouken@930
    90
extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data);
icculus@1190
    91
#endif
slouken@0
    92
slouken@0
    93
/* Get the 32-bit thread identifier for the current thread */
slouken@337
    94
extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
slouken@0
    95
slouken@0
    96
/* Get the 32-bit thread identifier for the specified thread,
slouken@0
    97
   equivalent to SDL_ThreadID() if the specified thread is NULL.
slouken@0
    98
 */
slouken@337
    99
extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread *thread);
slouken@0
   100
slouken@0
   101
/* Wait for a thread to finish.
slouken@0
   102
   The return code for the thread function is placed in the area
slouken@0
   103
   pointed to by 'status', if 'status' is not NULL.
slouken@0
   104
 */
slouken@337
   105
extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status);
slouken@0
   106
slouken@0
   107
/* Forcefully kill a thread without worrying about its state */
slouken@337
   108
extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread *thread);
slouken@0
   109
slouken@0
   110
slouken@0
   111
/* Ends C function definitions when using C++ */
slouken@0
   112
#ifdef __cplusplus
slouken@0
   113
}
slouken@0
   114
#endif
slouken@0
   115
#include "close_code.h"
slouken@0
   116
slouken@0
   117
#endif /* _SDL_thread_h */