include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 21 Feb 2006 08:46:50 +0000
changeset 1402 d910939febfa
parent 1358 c71e05b4dc2e
child 1442 e3242177fe4a
permissions -rw-r--r--
Use consistent identifiers for the various platforms we support.
Make sure every source file includes SDL_config.h, so the proper system
headers are chosen.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 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 /* Header for the SDL thread management routines 
    27 
    28 	These are independent of the other SDL routines.
    29 */
    30 
    31 #include "SDL_stdinc.h"
    32 #include "SDL_error.h"
    33 
    34 /* Thread synchronization primitives */
    35 #include "SDL_mutex.h"
    36 
    37 #include "begin_code.h"
    38 /* Set up for C function definitions, even when using C++ */
    39 #ifdef __cplusplus
    40 extern "C" {
    41 #endif
    42 
    43 /* The SDL thread structure, defined in SDL_thread.c */
    44 struct SDL_Thread;
    45 typedef struct SDL_Thread SDL_Thread;
    46 
    47 /* Create a thread */
    48 #if defined(__WIN32__) || defined(__OS2__)
    49 /*
    50    We compile SDL into a DLL on OS/2. This means, that it's the DLL which
    51    creates a new thread for the calling process with the SDL_CreateThread()
    52    API. There is a problem with this, that only the RTL of the SDL.DLL will
    53    be initialized for those threads, and not the RTL of the calling application!
    54    To solve this, we make a little hack here.
    55    We'll always use the caller's _beginthread() and _endthread() APIs to
    56    start a new thread. This way, if it's the SDL.DLL which uses this API,
    57    then the RTL of SDL.DLL will be used to create the new thread, and if it's
    58    the application, then the RTL of the application will be used.
    59    So, in short:
    60    Always use the _beginthread() and _endthread() of the calling runtime library!
    61 */
    62 #include <process.h> // This has _beginthread() and _endthread() defined!
    63 #ifdef __EMX__
    64 #include <stdlib.h> // This has _beginthread() and _endthread() defined, if -Zmt flag is used!
    65 #endif
    66 
    67 #ifdef __OS2__
    68 typedef int (__cdecl *pfnSDL_CurrentBeginThread)(void (*func)(void *), void *, unsigned, void *arg); 
    69 typedef void (__cdecl *pfnSDL_CurrentEndThread)(void);
    70 #else
    71 #ifdef __GNUC__
    72 #include <stdint.h>
    73 #endif
    74 typedef uintptr_t (__cdecl *pfnSDL_CurrentBeginThread) (void *, unsigned,
    75         unsigned (__stdcall *func)(void *), void *arg, 
    76         unsigned, unsigned *threadID);
    77 typedef void (__cdecl *pfnSDL_CurrentEndThread)(unsigned code);
    78 #endif
    79 
    80 extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (*fn)(void *), void *data, pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentEndThread pfnEndThread);
    81 
    82 #ifdef __OS2__
    83 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthread, _endthread)
    84 #elif defined(_WIN32_WCE)
    85 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
    86 #else
    87 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
    88 #endif
    89 #else
    90 extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data);
    91 #endif
    92 
    93 /* Get the 32-bit thread identifier for the current thread */
    94 extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
    95 
    96 /* Get the 32-bit thread identifier for the specified thread,
    97    equivalent to SDL_ThreadID() if the specified thread is NULL.
    98  */
    99 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread *thread);
   100 
   101 /* Wait for a thread to finish.
   102    The return code for the thread function is placed in the area
   103    pointed to by 'status', if 'status' is not NULL.
   104  */
   105 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status);
   106 
   107 /* Forcefully kill a thread without worrying about its state */
   108 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread *thread);
   109 
   110 
   111 /* Ends C function definitions when using C++ */
   112 #ifdef __cplusplus
   113 }
   114 #endif
   115 #include "close_code.h"
   116 
   117 #endif /* _SDL_thread_h */