Public API Reference

iutil/event.h

Go to the documentation of this file.

/*
    Event system related interfaces
    Written by Andrew Zabolotny <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IUTIL_EVENT_H__
#define __CS_IUTIL_EVENT_H__

#include "cssysdef.h"

#include "csutil/scf_interface.h"
#include "csutil/csunicode.h"
#include "csutil/ref.h"
#include "iutil/eventnames.h"
#include "iutil/evdefs.h"



#define CS_MAX_MOUSE_COUNT      4
#define CS_MAX_MOUSE_AXES       8
#define CS_MAX_MOUSE_BUTTONS    10
#define CS_MAX_JOYSTICK_COUNT   16
#define CS_MAX_JOYSTICK_BUTTONS 10
#define CS_MAX_JOYSTICK_AXES    8
/* Architecturally, AXES can go as high as 32 (limited by the uint32 change mask). */

struct iEventHandler;
struct iEvent;

struct iEventAttributeIterator : public virtual iBase
{
  SCF_INTERFACE(iEventAttributeIterator, 3,0,0);
  virtual bool HasNext() = 0;
  virtual const char* Next() = 0;
  virtual void Reset() = 0;
};


// Event data structs. Defined outside of iEvent to allow SWIG to
// handle the nested structs and union. Does not break any code.

struct csKeyEventData
{
  csKeyEventType eventType;
  utf32_char codeRaw;
  utf32_char codeCooked;
  csKeyModifiers modifiers;
  bool autoRepeat;
  csKeyCharType charType;
};


struct csMouseEventData
{
  int x;
  int y;
  int32 axes[CS_MAX_MOUSE_AXES];
  uint numAxes;
  uint Button;
  uint32 Modifiers;
};

struct csJoystickEventData
{
  uint number;
  int32 axes[CS_MAX_JOYSTICK_AXES];
  uint numAxes;
  uint32 axesChanged;
  uint Button;
  uint32 Modifiers;
};

struct csCommandEventData
{
  uint Code;
  intptr_t Info;
};

enum csEventError
{
  csEventErrNone,
  csEventErrLossy,
  csEventErrNotFound,

  csEventErrMismatchInt,
  csEventErrMismatchUInt,
  csEventErrMismatchFloat,
  csEventErrMismatchBuffer,
  csEventErrMismatchEvent,
  csEventErrMismatchIBase,

  csEventErrUhOhUnknown
};

enum csEventAttributeType
{
  csEventAttrUnknown,
  csEventAttrInt,
  csEventAttrUInt,
  csEventAttrFloat,
  csEventAttrDatabuffer,
  csEventAttrEvent,
  csEventAttriBase
};

struct iEvent : public virtual iBase
{
  SCF_INTERFACE(iEvent, 2,0,0);
  csEventID Name;
  virtual const csEventID GetName() = 0;
  csTicks Time;                 
  bool Broadcast;


  virtual bool Add (const char *name, int8 v) = 0;
  virtual bool Add (const char *name, uint8 v) = 0;
  virtual bool Add (const char *name, int16 v) = 0;
  virtual bool Add (const char *name, uint16 v) = 0;
  virtual bool Add (const char *name, int32 v) = 0;
  virtual bool Add (const char *name, uint32 v) = 0;
  virtual bool Add (const char *name, int64 v) = 0;
  virtual bool Add (const char *name, uint64 v) = 0;
  virtual bool Add (const char *name, float v) = 0;
  virtual bool Add (const char *name, double v) = 0;
  virtual bool Add (const char *name, const char *v) = 0;
  virtual bool Add (const char *name, const void *v, size_t size) = 0;
  virtual bool Add (const char *name, bool v) = 0;
  virtual bool Add (const char *name, iEvent* v) = 0;
  virtual bool Add (const char *name, iBase* v) = 0;


  virtual csEventError Retrieve (const char *name, int8 &v) const = 0;
  virtual csEventError Retrieve (const char *name, uint8 &v) const = 0;
  virtual csEventError Retrieve (const char *name, int16 &v) const = 0;
  virtual csEventError Retrieve (const char *name, uint16 &v) const = 0;
  virtual csEventError Retrieve (const char *name, int32 &v) const = 0;
  virtual csEventError Retrieve (const char *name, uint32 &v) const = 0;
  virtual csEventError Retrieve (const char *name, int64 &v) const = 0;
  virtual csEventError Retrieve (const char *name, uint64 &v) const = 0;
  virtual csEventError Retrieve (const char *name, float &v) const = 0;
  virtual csEventError Retrieve (const char *name, double &v) const = 0;
  virtual csEventError Retrieve (const char *name, const char *&v) const = 0;
  virtual csEventError Retrieve (const char *name, const void *&v, 
    size_t& size) const = 0;
  virtual csEventError Retrieve (const char *name, bool &v) const = 0;
  virtual csEventError Retrieve (const char *name, csRef<iEvent> &v) const = 0;
  virtual csEventError Retrieve (const char *name, csRef<iBase> &v) const = 0;

  virtual bool AttributeExists (const char* name) = 0;
  virtual csEventAttributeType GetAttributeType (const char* name) = 0;

  virtual bool Remove (const char *name) = 0;
  virtual bool RemoveAll() = 0;

  virtual csRef<iEventAttributeIterator> GetAttributeIterator() = 0;
};

struct iEventPlug : public virtual iBase
{
  SCF_INTERFACE(iEventPlug, 2,0,0);
  virtual unsigned GetPotentiallyConflictingEvents () = 0;

  virtual unsigned QueryEventPriority (unsigned iType) = 0;

  virtual void EnableEvents (unsigned /*iType*/, bool /*iEnable*/) {}
};

struct iEventOutlet : public virtual iBase
{
  SCF_INTERFACE(iEventOutlet, 2,0,0);
  virtual csPtr<iEvent> CreateEvent () = 0;

  virtual void Post (iEvent*) = 0;

  virtual void Key (utf32_char codeRaw, utf32_char codeCooked, bool iDown,
      bool autorep = false) = 0;

  virtual void Mouse (int iButton, bool iDown, int x, int y) = 0;

  virtual void Joystick(uint iNumber, int iButton, bool iDown, 
    const int32 *axes, uint numAxes) = 0;

  virtual void Broadcast (csEventID iName, intptr_t iInfo = 0) = 0;

  virtual void ImmediateBroadcast (csEventID iName, intptr_t iInfo) = 0;
};


struct iEventCord : public virtual iBase
{
  SCF_INTERFACE(iEventCord, 2,0,0);
  virtual int Insert (iEventHandler*, int priority) = 0;

  virtual void Remove (iEventHandler*) = 0;

  virtual bool GetPass () const = 0;

  virtual void SetPass (bool) = 0;

  virtual csEventID GetName() const = 0;
};

#endif // __CS_IUTIL_EVENT_H__

---