include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 08 Dec 2008 00:27:32 +0000
changeset 2859 99210400e8b9
parent 2779 4436464c4f51
child 3269 a67a961e2171
permissions -rw-r--r--
Updated copyright date
     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)) || defined(__OS2__)
    52 /*
    53    We compile SDL into a DLL on OS/2. 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 __OS2__
    71 typedef int (*pfnSDL_CurrentBeginThread) (void (*func) (void *), void *,
    72                                           unsigned, void *arg);
    73 typedef void (*pfnSDL_CurrentEndThread) (void);
    74 #elif __GNUC__
    75 typedef unsigned long (__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
    76                                                              unsigned
    77                                                              (__stdcall *
    78                                                               func) (void *),
    79                                                              void *arg,
    80                                                              unsigned,
    81                                                              unsigned
    82                                                              *threadID);
    83 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
    84 #else
    85 typedef uintptr_t(__cdecl * pfnSDL_CurrentBeginThread) (void *, unsigned,
    86                                                         unsigned (__stdcall *
    87                                                                   func) (void
    88                                                                          *),
    89                                                         void *arg, unsigned,
    90                                                         unsigned *threadID);
    91 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
    92 #endif
    93 
    94 extern DECLSPEC SDL_Thread *SDLCALL
    95 SDL_CreateThread(int (SDLCALL * f) (void *), void *data,
    96                  pfnSDL_CurrentBeginThread pfnBeginThread,
    97                  pfnSDL_CurrentEndThread pfnEndThread);
    98 
    99 #ifdef __OS2__
   100 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthread, _endthread)
   101 #elif defined(_WIN32_WCE)
   102 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
   103 #else
   104 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
   105 #endif
   106 #else
   107 extern DECLSPEC SDL_Thread *SDLCALL
   108 SDL_CreateThread(int (SDLCALL * fn) (void *), void *data);
   109 #endif
   110 
   111 /* Get the 32-bit thread identifier for the current thread */
   112 extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
   113 
   114 /* Get the 32-bit thread identifier for the specified thread,
   115    equivalent to SDL_ThreadID() if the specified thread is NULL.
   116  */
   117 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread * thread);
   118 
   119 /* Wait for a thread to finish.
   120    The return code for the thread function is placed in the area
   121    pointed to by 'status', if 'status' is not NULL.
   122  */
   123 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
   124 
   125 /* This function is here for binary compatibility with legacy apps, but
   126    in SDL 1.3 and later, it's a no-op. You cannot forcibly kill a thread
   127    in a safe manner on many platforms. You should instead find a way to
   128    alert your thread that it is time to terminate, and then have it gracefully
   129    exit on its own. Do not ever call this function!
   130  */
   131 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);
   132 
   133 
   134 /* Ends C function definitions when using C++ */
   135 #ifdef __cplusplus
   136 /* *INDENT-OFF* */
   137 }
   138 /* *INDENT-ON* */
   139 #endif
   140 #include "close_code.h"
   141 
   142 #endif /* _SDL_thread_h */
   143 
   144 /* vi: set ts=4 sw=4 expandtab: */