include/wx/mac/corefoundation/hid.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        hid.h
   3 // Purpose:     DARWIN HID layer for WX
   4 // Author:      Ryan Norton
   5 // Modified by:
   6 // Created:     11/11/2003
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Ryan Norton
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11 // ===========================================================================
  12 // declarations
  13 // ===========================================================================
  14
  15 // ---------------------------------------------------------------------------
  16 // headers
  17 // ---------------------------------------------------------------------------
  18
  19 #ifndef _WX_MACCARBONHID_H_
  20 #define _WX_MACCARBONHID_H_
  21
  22 #include "wx/defs.h"
  23 #include "wx/string.h"
  24
  25 // ---------------------------------------------------------------------------
  26 // definitions
  27 // ---------------------------------------------------------------------------
  28
  29 //Mac OSX only
  30 #ifdef __DARWIN__
  31
  32 #include <IOKit/IOKitLib.h>
  33 #include <IOKit/IOCFPlugIn.h>
  34 #include <IOKit/hid/IOHIDLib.h>
  35 #include <IOKit/hid/IOHIDKeys.h>
  36 #include <Kernel/IOKit/hidsystem/IOHIDUsageTables.h>
  37
  38 //Darn apple - doesn't properly wrap their headers in extern "C"!
  39 //http://www.macosx.com/forums/archive/index.php/t-68069.html
  40 //Needed for codewarrior link error with mach_port_deallocate()
  41 extern "C" {
  42 #include <mach/mach_port.h>
  43 }
  44
  45 #include <mach/mach.h> //this actually includes mach_port.h (see above)
  46
  47 //Utility wrapper around CFArray
  48 class wxCFArray
  49 {
  50 public:
  51         wxCFArray(CFTypeRef pData) : pArray((CFArrayRef) pData) {}
  52         CFTypeRef operator [] (const int& nIndex) {return CFArrayGetValueAtIndex(pArray, nIndex); }
  53         int Count() {return CFArrayGetCount(pArray);}
  54 private:
  55         CFArrayRef pArray;
  56 };
  57
  58 //
  59 //      A wrapper around OS X HID Manager procedures.
  60 //      The tutorial "Working With HID Class Device Interfaces" Is
  61 //      Quite good, as is the sample program associated with it
  62 //  (Depite the author's protests!).
  63 class wxHIDDevice
  64 {
  65 public:
  66         wxHIDDevice() : m_ppDevice(NULL), m_ppQueue(NULL), m_pCookies(NULL) {}
  67         //kHIDPage_GenericDesktop
  68         //kHIDUsage_GD_Joystick,kHIDUsage_GD_Mouse,kHIDUsage_GD_Keyboard
  69         bool Create (int nClass = -1, int nType = -1, int nDev = 1);
  70
  71     static int GetCount(int nClass = -1, int nType = -1);
  72
  73         void AddCookie(CFTypeRef Data, int i);
  74         void AddCookieInQueue(CFTypeRef Data, int i);
  75         void InitCookies(size_t dwSize, bool bQueue = false);
  76
  77         //Must be implemented by derived classes
  78         //builds the cookie array -
  79         //first call InitCookies to initialize the cookie
  80         //array, then AddCookie to add a cookie at a certain point in an array
  81         virtual void BuildCookies(wxCFArray& Array) = 0;
  82
  83         //checks to see whether the cookie at nIndex is active (element value != 0)
  84         bool IsActive(int nIndex);
  85
  86     //checks to see whether the cookie at nIndex exists
  87     bool HasElement(int nIndex);
  88
  89         //closes the device and cleans the queue and cookies
  90         virtual ~wxHIDDevice();
  91
  92 protected:
  93         IOHIDDeviceInterface**  m_ppDevice; //this, essentially
  94         IOHIDQueueInterface**   m_ppQueue;  //queue (if we want one)
  95         IOHIDElementCookie*     m_pCookies; //cookies
  96
  97         wxString                                m_szProductName; //product name
  98         int                                             m_nProductId; //product id
  99         int                                             m_nManufacturerId; //manufacturer id
 100         mach_port_t                     m_pPort;
 101 };
 102
 103 class wxHIDKeyboard : public wxHIDDevice
 104 {
 105 public:
 106         bool Create();
 107         virtual void BuildCookies(wxCFArray& Array);
 108 };
 109
 110 #endif //__DARWIN__
 111
 112 #endif
 113         //WX_MACCARBONHID_H