include/SDL_thread.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 11 Sep 2011 22:31:53 -0400
branchSDL-1.2
changeset 5897 90faab009401
parent 5892 eca95aaa02a2
child 5899 1f0b95cc4b85
permissions -rw-r--r--
More Cygwin compiler warnings...
     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 /** @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 #elif defined(__CYGWIN__) && !defined(__MINGW32__)
    72 typedef unsigned long (__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 #else
    77 typedef uintptr_t (__cdecl *pfnSDL_CurrentBeginThread) (void *, unsigned,
    78         unsigned (__stdcall *func)(void *), void *arg, 
    79         unsigned, unsigned *threadID);
    80 typedef void (__cdecl *pfnSDL_CurrentEndThread)(unsigned code);
    81 #endif
    82 
    83 extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data, pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentEndThread pfnEndThread);
    84 
    85 #ifdef __OS2__
    86 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthread, _endthread)
    87 #elif defined(_WIN32_WCE)
    88 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
    89 #else
    90 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
    91 #endif
    92 #else
    93 extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data);
    94 #endif
    95 
    96 /** Get the 32-bit thread identifier for the current thread */
    97 extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
    98 
    99 /** Get the 32-bit thread identifier for the specified thread,
   100  *  equivalent to SDL_ThreadID() if the specified thread is NULL.
   101  */
   102 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread *thread);
   103 
   104 /** Wait for a thread to finish.
   105  *  The return code for the thread function is placed in the area
   106  *  pointed to by 'status', if 'status' is not NULL.
   107  */
   108 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status);
   109 
   110 /** Forcefully kill a thread without worrying about its state */
   111 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread *thread);
   112 
   113 
   114 /* Ends C function definitions when using C++ */
   115 #ifdef __cplusplus
   116 }
   117 #endif
   118 #include "close_code.h"
   119 
   120 #endif /* _SDL_thread_h */