include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 19 Sep 2009 06:43:45 +0000
changeset 3269 a67a961e2171
parent 2859 99210400e8b9
child 3407 d3baf5ac4e37
permissions -rw-r--r--
Removed outdated OS/2 support
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@2859
     3
    Copyright (C) 1997-2009 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@1895
    26
/**
slouken@1895
    27
 * \file SDL_thread.h
slouken@1895
    28
 *
slouken@1895
    29
 * Header for the SDL thread management routines 
slouken@1895
    30
 */
slouken@0
    31
slouken@1356
    32
#include "SDL_stdinc.h"
slouken@1358
    33
#include "SDL_error.h"
slouken@0
    34
slouken@0
    35
/* Thread synchronization primitives */
slouken@0
    36
#include "SDL_mutex.h"
slouken@0
    37
slouken@0
    38
#include "begin_code.h"
slouken@0
    39
/* Set up for C function definitions, even when using C++ */
slouken@0
    40
#ifdef __cplusplus
slouken@1895
    41
/* *INDENT-OFF* */
slouken@0
    42
extern "C" {
slouken@1895
    43
/* *INDENT-ON* */
slouken@0
    44
#endif
slouken@0
    45
slouken@0
    46
/* The SDL thread structure, defined in SDL_thread.c */
slouken@0
    47
struct SDL_Thread;
slouken@0
    48
typedef struct SDL_Thread SDL_Thread;
slouken@0
    49
slouken@0
    50
/* Create a thread */
slouken@3269
    51
#if defined(__WIN32__) && !defined(HAVE_LIBC)
icculus@1190
    52
/*
slouken@3269
    53
   We compile SDL into a DLL. This means, that it's the DLL which
icculus@1190
    54
   creates a new thread for the calling process with the SDL_CreateThread()
icculus@1190
    55
   API. There is a problem with this, that only the RTL of the SDL.DLL will
icculus@1190
    56
   be initialized for those threads, and not the RTL of the calling application!
icculus@1190
    57
   To solve this, we make a little hack here.
icculus@1190
    58
   We'll always use the caller's _beginthread() and _endthread() APIs to
slouken@1330
    59
   start a new thread. This way, if it's the SDL.DLL which uses this API,
icculus@1190
    60
   then the RTL of SDL.DLL will be used to create the new thread, and if it's
icculus@1190
    61
   the application, then the RTL of the application will be used.
icculus@1190
    62
   So, in short:
icculus@1190
    63
   Always use the _beginthread() and _endthread() of the calling runtime library!
icculus@1190
    64
*/
slouken@1471
    65
#define SDL_PASSED_BEGINTHREAD_ENDTHREAD
slouken@1465
    66
#ifndef _WIN32_WCE
slouken@1895
    67
#include <process.h>            /* This has _beginthread() and _endthread() defined! */
icculus@1190
    68
#endif
icculus@1190
    69
slouken@3269
    70
#ifdef __GNUC__
slouken@1895
    71
typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
slouken@1895
    72
                                                             unsigned
slouken@1895
    73
                                                             (__stdcall *
slouken@1895
    74
                                                              func) (void *),
slouken@1895
    75
                                                             void *arg,
slouken@1895
    76
                                                             unsigned,
slouken@1895
    77
                                                             unsigned
slouken@1895
    78
                                                             *threadID);
slouken@1895
    79
typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
slouken@1330
    80
#else
slouken@1895
    81
typedef uintptr_t(__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
slouken@1895
    82
                                                        unsigned (__stdcall *
slouken@1895
    83
                                                                  func) (void
slouken@1895
    84
                                                                         *),
slouken@1895
    85
                                                        void *arg, unsigned,
slouken@1895
    86
                                                        unsigned *threadID);
slouken@1895
    87
typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
slouken@1330
    88
#endif
icculus@1190
    89
slouken@2060
    90
extern DECLSPEC SDL_Thread *SDLCALL
slouken@2060
    91
SDL_CreateThread(int (SDLCALL * f) (void *), void *data,
slouken@2060
    92
                 pfnSDL_CurrentBeginThread pfnBeginThread,
slouken@2060
    93
                 pfnSDL_CurrentEndThread pfnEndThread);
icculus@1190
    94
slouken@3269
    95
#if defined(_WIN32_WCE)
slouken@1330
    96
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
slouken@1330
    97
#else
slouken@1330
    98
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
slouken@1330
    99
#endif
icculus@1190
   100
#else
slouken@1895
   101
extern DECLSPEC SDL_Thread *SDLCALL
slouken@1895
   102
SDL_CreateThread(int (SDLCALL * fn) (void *), void *data);
icculus@1190
   103
#endif
slouken@0
   104
slouken@0
   105
/* Get the 32-bit thread identifier for the current thread */
slouken@337
   106
extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
slouken@0
   107
slouken@0
   108
/* Get the 32-bit thread identifier for the specified thread,
slouken@0
   109
   equivalent to SDL_ThreadID() if the specified thread is NULL.
slouken@0
   110
 */
slouken@1895
   111
extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread * thread);
slouken@0
   112
slouken@0
   113
/* Wait for a thread to finish.
slouken@0
   114
   The return code for the thread function is placed in the area
slouken@0
   115
   pointed to by 'status', if 'status' is not NULL.
slouken@0
   116
 */
slouken@1895
   117
extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
slouken@0
   118
slouken@2779
   119
/* This function is here for binary compatibility with legacy apps, but
slouken@2779
   120
   in SDL 1.3 and later, it's a no-op. You cannot forcibly kill a thread
slouken@2779
   121
   in a safe manner on many platforms. You should instead find a way to
slouken@2779
   122
   alert your thread that it is time to terminate, and then have it gracefully
slouken@2779
   123
   exit on its own. Do not ever call this function!
slouken@2779
   124
 */
slouken@1895
   125
extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);
slouken@0
   126
slouken@0
   127
slouken@0
   128
/* Ends C function definitions when using C++ */
slouken@0
   129
#ifdef __cplusplus
slouken@1895
   130
/* *INDENT-OFF* */
slouken@0
   131
}
slouken@1895
   132
/* *INDENT-ON* */
slouken@0
   133
#endif
slouken@0
   134
#include "close_code.h"
slouken@0
   135
slouken@0
   136
#endif /* _SDL_thread_h */
slouken@1895
   137
slouken@1895
   138
/* vi: set ts=4 sw=4 expandtab: */