include/SDL_thread.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 21 Sep 2009 09:38:10 +0000
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4159 a1b03ba2fcd0
child 5892 eca95aaa02a2
permissions -rw-r--r--
Fixed bug #706

Ken Bull 2009-02-25 13:22:02 PST

Adds Doxygen support for all headers (except config and boilerplate headers) in
the include folder for SDL-1.2 revision 4446.

While in general SDL is quite thoroughly commented, none of these comments are
correctly formatted for Doxygen and are generally inconsistent in their
formatting.
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@4159
     3
    Copyright (C) 1997-2009 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
#ifndef _SDL_thread_h
slouken@0
    24
#define _SDL_thread_h
slouken@0
    25
slouken@4217
    26
/** @file SDL_thread.h
slouken@4217
    27
 *  Header for the SDL thread management routines 
slouken@4217
    28
 *
slouken@4217
    29
 *  @note These are independent of the other SDL routines.
slouken@4217
    30
 */
slouken@0
    31
slouken@1356
    32
#include "SDL_stdinc.h"
slouken@1358
    33
#include "SDL_error.h"
slouken@0
    34
slouken@0
    35
/* Thread synchronization primitives */
slouken@0
    36
#include "SDL_mutex.h"
slouken@0
    37
slouken@0
    38
#include "begin_code.h"
slouken@0
    39
/* Set up for C function definitions, even when using C++ */
slouken@0
    40
#ifdef __cplusplus
slouken@0
    41
extern "C" {
slouken@0
    42
#endif
slouken@0
    43
slouken@4217
    44
/** The SDL thread structure, defined in SDL_thread.c */
slouken@0
    45
struct SDL_Thread;
slouken@0
    46
typedef struct SDL_Thread SDL_Thread;
slouken@0
    47
slouken@4217
    48
/** Create a thread */
icculus@3975
    49
#if ((defined(__WIN32__) && !defined(HAVE_LIBC)) || defined(__OS2__)) &&  !defined(__SYMBIAN32__)
slouken@4217
    50
/**
slouken@4217
    51
 *  We compile SDL into a DLL on OS/2. This means, that it's the DLL which
slouken@4217
    52
 *  creates a new thread for the calling process with the SDL_CreateThread()
slouken@4217
    53
 *  API. There is a problem with this, that only the RTL of the SDL.DLL will
slouken@4217
    54
 *  be initialized for those threads, and not the RTL of the calling application!
slouken@4217
    55
 *  To solve this, we make a little hack here.
slouken@4217
    56
 *  We'll always use the caller's _beginthread() and _endthread() APIs to
slouken@4217
    57
 *  start a new thread. This way, if it's the SDL.DLL which uses this API,
slouken@4217
    58
 *  then the RTL of SDL.DLL will be used to create the new thread, and if it's
slouken@4217
    59
 *  the application, then the RTL of the application will be used.
slouken@4217
    60
 *  So, in short:
slouken@4217
    61
 *  Always use the _beginthread() and _endthread() of the calling runtime library!
slouken@4217
    62
 */
slouken@1471
    63
#define SDL_PASSED_BEGINTHREAD_ENDTHREAD
slouken@1465
    64
#ifndef _WIN32_WCE
slouken@1471
    65
#include <process.h> /* This has _beginthread() and _endthread() defined! */
icculus@1190
    66
#endif
icculus@1190
    67
slouken@1330
    68
#ifdef __OS2__
slouken@1442
    69
typedef int (*pfnSDL_CurrentBeginThread)(void (*func)(void *), void *, unsigned, void *arg); 
slouken@1442
    70
typedef void (*pfnSDL_CurrentEndThread)(void);
slouken@1470
    71
#elif __GNUC__
slouken@1470
    72
typedef unsigned long (__cdecl *pfnSDL_CurrentBeginThread) (void *, unsigned,
slouken@1470
    73
        unsigned (__stdcall *func)(void *), void *arg, 
slouken@1470
    74
        unsigned, unsigned *threadID);
slouken@1470
    75
typedef void (__cdecl *pfnSDL_CurrentEndThread)(unsigned code);
slouken@1330
    76
#else
slouken@1330
    77
typedef uintptr_t (__cdecl *pfnSDL_CurrentBeginThread) (void *, unsigned,
slouken@1330
    78
        unsigned (__stdcall *func)(void *), void *arg, 
slouken@1330
    79
        unsigned, unsigned *threadID);
slouken@1330
    80
typedef void (__cdecl *pfnSDL_CurrentEndThread)(unsigned code);
slouken@1330
    81
#endif
icculus@1190
    82
slouken@1850
    83
extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data, pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentEndThread pfnEndThread);
icculus@1190
    84
slouken@1330
    85
#ifdef __OS2__
slouken@1330
    86
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthread, _endthread)
slouken@1330
    87
#elif defined(_WIN32_WCE)
slouken@1330
    88
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
slouken@1330
    89
#else
slouken@1330
    90
#define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
slouken@1330
    91
#endif
icculus@1190
    92
#else
slouken@930
    93
extern DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (SDLCALL *fn)(void *), void *data);
icculus@1190
    94
#endif
slouken@0
    95
slouken@4217
    96
/** Get the 32-bit thread identifier for the current thread */
slouken@337
    97
extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
slouken@0
    98
slouken@4217
    99
/** Get the 32-bit thread identifier for the specified thread,
slouken@4217
   100
 *  equivalent to SDL_ThreadID() if the specified thread is NULL.
slouken@0
   101
 */
slouken@337
   102
extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread *thread);
slouken@0
   103
slouken@4217
   104
/** Wait for a thread to finish.
slouken@4217
   105
 *  The return code for the thread function is placed in the area
slouken@4217
   106
 *  pointed to by 'status', if 'status' is not NULL.
slouken@0
   107
 */
slouken@337
   108
extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status);
slouken@0
   109
slouken@4217
   110
/** Forcefully kill a thread without worrying about its state */
slouken@337
   111
extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread *thread);
slouken@0
   112
slouken@0
   113
slouken@0
   114
/* Ends C function definitions when using C++ */
slouken@0
   115
#ifdef __cplusplus
slouken@0
   116
}
slouken@0
   117
#endif
slouken@0
   118
#include "close_code.h"
slouken@0
   119
slouken@0
   120
#endif /* _SDL_thread_h */