include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 29 May 2006 04:04:35 +0000
branchSDL-1.3
changeset 1668 4da1ee79c9af
parent 1662 782fd950bd46
permissions -rw-r--r--
more tweaking indent options
     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 /**
    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 SDL_CreateThread(int (*fn) (void *),
    95                                                      void *data,
    96                                                      pfnSDL_CurrentBeginThread
    97                                                      pfnBeginThread,
    98                                                      pfnSDL_CurrentEndThread
    99                                                      pfnEndThread);
   100 
   101 #ifdef __OS2__
   102 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthread, _endthread)
   103 #elif defined(_WIN32_WCE)
   104 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
   105 #else
   106 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
   107 #endif
   108 #else
   109 extern DECLSPEC SDL_Thread *SDLCALL
   110 SDL_CreateThread(int (SDLCALL * fn) (void *), void *data);
   111 #endif
   112 
   113 /* Get the 32-bit thread identifier for the current thread */
   114 extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
   115 
   116 /* Get the 32-bit thread identifier for the specified thread,
   117    equivalent to SDL_ThreadID() if the specified thread is NULL.
   118  */
   119 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread * thread);
   120 
   121 /* Wait for a thread to finish.
   122    The return code for the thread function is placed in the area
   123    pointed to by 'status', if 'status' is not NULL.
   124  */
   125 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
   126 
   127 /* Forcefully kill a thread without worrying about its state */
   128 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);
   129 
   130 
   131 /* Ends C function definitions when using C++ */
   132 #ifdef __cplusplus
   133 /* *INDENT-OFF* */
   134 }
   135 /* *INDENT-ON* */
   136 #endif
   137 #include "close_code.h"
   138 
   139 #endif /* _SDL_thread_h */
   140 
   141 /* vi: set ts=4 sw=4 expandtab: */