v2/util_thread.h

   1 /*----------------------------------------------------------------------------
   2     ChucK Concurrent, On-the-fly Audio Programming Language
   3       Compiler and Virtual Machine
   4
   5     Copyright (c) 2004 Ge Wang and Perry R. Cook.  All rights reserved.
   6       http://chuck.cs.princeton.edu/
   7       http://soundlab.cs.princeton.edu/
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17     GNU General Public License for more details.
  18
  19     You should have received a copy of the GNU General Public License
  20     along with this program; if not, write to the Free Software
  21     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22     U.S.A.
  23 -----------------------------------------------------------------------------*/
  24
  25 //-----------------------------------------------------------------------------
  26 // name: util_thread.h
  27 // desc: ...
  28 //
  29 // authors: Ge Wang (gewang@cs.princeton.edu)
  30 //          Perry R. Cook (prc@cs.princeton.edu)
  31 // based on STK's Thread
  32 //          Perry R. Cook + Gary Scavone
  33 // date: autumn 2004
  34 //-----------------------------------------------------------------------------
  35 #ifndef __UTIL_THREAD_H__
  36 #define __UTIL_THREAD_H__
  37
  38
  39 #include "chuck_def.h"
  40
  41
  42 #if ( defined(__PLATFORM_MACOSX__) || defined(__PLATFORM_LINUX__) || defined(__WINDOWS_PTHREAD__) )
  43   #include <pthread.h>
  44   #define THREAD_TYPE
  45   typedef pthread_t THREAD_HANDLE;
  46   typedef void * THREAD_RETURN;
  47   typedef void * (*THREAD_FUNCTION)(void *);
  48   typedef pthread_mutex_t MUTEX;
  49   #define CHUCK_THREAD pthread_t
  50 #elif defined(__PLATFORM_WIN32__)
  51   #include <windows.h>
  52   #include <process.h>
  53   #define THREAD_TYPE __stdcall
  54   typedef unsigned long THREAD_HANDLE;
  55   typedef unsigned THREAD_RETURN;
  56   typedef unsigned (__stdcall *THREAD_FUNCTION)(void *);
  57   typedef CRITICAL_SECTION MUTEX;
  58   #define CHUCK_THREAD HANDLE
  59 #endif
  60
  61
  62
  63
  64 //-----------------------------------------------------------------------------
  65 // name: struct XThread
  66 // desc: ...
  67 //-----------------------------------------------------------------------------
  68 struct XThread
  69 {
  70 public:
  71     XThread();
  72     ~XThread();
  73
  74 public:
  75     // begin execution of the thread routine
  76     // the thread routine can be passed an argument via ptr
  77     bool start( THREAD_FUNCTION routine, void * ptr = NULL );
  78
  79     // wait the specified number of milliseconds for the thread to terminate
  80     bool wait( long milliseconds = -1 );
  81
  82 public:
  83     // test for a thread cancellation request.
  84     static void test( );
  85
  86     // clear
  87     void clear() { thread = 0; }
  88
  89 protected:
  90     THREAD_HANDLE thread;
  91 };
  92
  93
  94
  95
  96 //-----------------------------------------------------------------------------
  97 // name: struct XMutex
  98 // desc: ...
  99 //-----------------------------------------------------------------------------
 100 struct XMutex
 101 {
 102 public:
 103     XMutex();
 104     ~XMutex();
 105
 106 public:
 107     void acquire( );
 108     void release(void);
 109
 110 protected:
 111     MUTEX mutex;
 112 };
 113
 114
 115
 116
 117 #endif