include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 31 Dec 2011 09:16:08 -0500
branchSDL-1.2
changeset 6137 4720145f848b
parent 5899 1f0b95cc4b85
child 11544 15a09f7c6ed8
permissions -rw-r--r--
Happy New Year!
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2012 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 /** @file SDL_thread.h
    27  *  Header for the SDL thread management routines 
    28  *
    29  *  @note These are independent of the other SDL 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 extern "C" {
    42 #endif
    43 
    44 /** The SDL thread structure, defined in SDL_thread.c */
    45 struct SDL_Thread;
    46 typedef struct SDL_Thread SDL_Thread;
    47 
    48 /** Create a thread */
    49 #if ((defined(__WIN32__) && !defined(HAVE_LIBC)) || defined(__OS2__)) &&  !defined(__SYMBIAN32__)
    50 /**
    51  *  We compile SDL into a DLL on OS/2. This means, that it's the DLL which
    52  *  creates a new thread for the calling process with the SDL_CreateThread()
    53  *  API. There is a problem with this, that only the RTL of the SDL.DLL will
    54  *  be initialized for those threads, and not the RTL of the calling application!
    55  *  To solve this, we make a little hack here.
    56  *  We'll always use the caller's _beginthread() and _endthread() APIs to
    57  *  start a new thread. This way, if it's the SDL.DLL which uses this API,
    58  *  then the RTL of SDL.DLL will be used to create the new thread, and if it's
    59  *  the application, then the RTL of the application will be used.
    60  *  So, in short:
    61  *  Always use the _beginthread() and _endthread() of the calling runtime library!
    62  */
    63 #define SDL_PASSED_BEGINTHREAD_ENDTHREAD
    64 #ifndef _WIN32_WCE
    65 #include <process.h> /* This has _beginthread() and _endthread() defined! */
    66 #endif
    67 
    68 #ifdef __OS2__
    69 typedef int (*pfnSDL_CurrentBeginThread)(void (*func)(void *), void *, unsigned, void *arg); 
    70 typedef void (*pfnSDL_CurrentEndThread)(void);
    71 #else
    72 typedef uintptr_t (__cdecl *pfnSDL_CurrentBeginThread) (void *, unsigned,
    73         unsigned (__stdcall *func)(void *), void *arg, 
    74         unsigned, unsigned *threadID);
    75 typedef void (__cdecl *pfnSDL_CurrentEndThread)(unsigned code);
    76 #endif
    77 
    78 extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data, pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentEndThread pfnEndThread);
    79 
    80 #ifdef __OS2__
    81 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthread, _endthread)
    82 #elif defined(_WIN32_WCE)
    83 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
    84 #else
    85 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
    86 #endif
    87 #else
    88 extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data);
    89 #endif
    90 
    91 /** Get the 32-bit thread identifier for the current thread */
    92 extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
    93 
    94 /** Get the 32-bit thread identifier for the specified thread,
    95  *  equivalent to SDL_ThreadID() if the specified thread is NULL.
    96  */
    97 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread *thread);
    98 
    99 /** Wait for a thread to finish.
   100  *  The return code for the thread function is placed in the area
   101  *  pointed to by 'status', if 'status' is not NULL.
   102  */
   103 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status);
   104 
   105 /** Forcefully kill a thread without worrying about its state */
   106 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread *thread);
   107 
   108 
   109 /* Ends C function definitions when using C++ */
   110 #ifdef __cplusplus
   111 }
   112 #endif
   113 #include "close_code.h"
   114 
   115 #endif /* _SDL_thread_h */