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
     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     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 #ifndef _SDL_thread_h
    24 #define _SDL_thread_h
    25 
    26 /**
    27  * \file SDL_thread.h
    28  *
    29  * Header for the SDL thread management routines 
    30  */
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_error.h"
    34 
    35 /* Thread synchronization primitives */
    36 #include "SDL_mutex.h"
    37 
    38 #include "begin_code.h"
    39 /* Set up for C function definitions, even when using C++ */
    40 #ifdef __cplusplus
    41 /* *INDENT-OFF* */
    42 extern "C" {
    43 /* *INDENT-ON* */
    44 #endif
    45 
    46 /* The SDL thread structure, defined in SDL_thread.c */
    47 struct SDL_Thread;
    48 typedef struct SDL_Thread SDL_Thread;
    49 
    50 /* 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    creates a new thread for the calling process with the SDL_CreateThread()
    55    API. There is a problem with this, that only the RTL of the SDL.DLL will
    56    be initialized for those threads, and not the RTL of the calling application!
    57    To solve this, we make a little hack here.
    58    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    then the RTL of SDL.DLL will be used to create the new thread, and if it's
    61    the application, then the RTL of the application will be used.
    62    So, in short:
    63    Always use the _beginthread() and _endthread() of the calling runtime library!
    64 */
    65 #define SDL_PASSED_BEGINTHREAD_ENDTHREAD
    66 #ifndef _WIN32_WCE
    67 #include <process.h>            /* This has _beginthread() and _endthread() defined! */
    68 #endif
    69 
    70 #ifdef __GNUC__
    71 typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
    72                                                              unsigned
    73                                                              (__stdcall *
    74                                                               func) (void *),
    75                                                              void *arg,
    76                                                              unsigned,
    77                                                              unsigned
    78                                                              *threadID);
    79 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
    80 #else
    81 typedef uintptr_t(__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
    82                                                         unsigned (__stdcall *
    83                                                                   func) (void
    84                                                                          *),
    85                                                         void *arg, unsigned,
    86                                                         unsigned *threadID);
    87 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
    88 #endif
    89 
    90 extern DECLSPEC SDL_Thread *SDLCALL
    91 SDL_CreateThread(int (SDLCALL * f) (void *), void *data,
    92                  pfnSDL_CurrentBeginThread pfnBeginThread,
    93                  pfnSDL_CurrentEndThread pfnEndThread);
    94 
    95 #if defined(_WIN32_WCE)
    96 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
    97 #else
    98 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
    99 #endif
   100 #else
   101 extern DECLSPEC SDL_Thread *SDLCALL
   102 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 /* Get the 32-bit thread identifier for the specified thread,
   109    equivalent to SDL_ThreadID() if the specified thread is NULL.
   110  */
   111 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread * thread);
   112 
   113 /* Wait for a thread to finish.
   114    The return code for the thread function is placed in the area
   115    pointed to by 'status', if 'status' is not NULL.
   116  */
   117 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
   118 
   119 /* This function is here for binary compatibility with legacy apps, but
   120    in SDL 1.3 and later, it's a no-op. You cannot forcibly kill a thread
   121    in a safe manner on many platforms. You should instead find a way to
   122    alert your thread that it is time to terminate, and then have it gracefully
   123    exit on its own. Do not ever call this function!
   124  */
   125 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);
   126 
   127 
   128 /* Ends C function definitions when using C++ */
   129 #ifdef __cplusplus
   130 /* *INDENT-OFF* */
   131 }
   132 /* *INDENT-ON* */
   133 #endif
   134 #include "close_code.h"
   135 
   136 #endif /* _SDL_thread_h */
   137 
   138 /* vi: set ts=4 sw=4 expandtab: */