src/event.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program 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
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef EVENT_HEADER
  21 #define EVENT_HEADER
  22
  23 class MtEvent
  24 {
  25 public:
  26         virtual ~MtEvent(){};
  27         //virtual MtEvent* clone(){ return new IEvent; }
  28         virtual const char* getType() const = 0;
  29
  30         MtEvent* checkIs(const std::string &type)
  31         {
  32                 if(type == getType())
  33                         return this;
  34                 return NULL;
  35         }
  36 };
  37
  38 // An event with no parameters and customizable name
  39 class SimpleTriggerEvent: public MtEvent
  40 {
  41         const char *type;
  42 public:
  43         SimpleTriggerEvent(const char *type):
  44                 type(type)
  45         {}
  46         const char* getType() const
  47         {return type;}
  48 };
  49
  50 class MtEventReceiver
  51 {
  52 public:
  53         virtual ~MtEventReceiver(){};
  54         virtual void onEvent(MtEvent *e) = 0;
  55 };
  56
  57 typedef void (*event_receive_func)(MtEvent *e, void *data);
  58
  59 class MtEventManager
  60 {
  61 public:
  62         virtual ~MtEventManager(){};
  63         virtual void put(MtEvent *e) = 0;
  64         virtual void reg(const char *type, event_receive_func f, void *data) = 0;
  65         // If data==NULL, every occurence of f is deregistered.
  66         virtual void dereg(const char *type, event_receive_func f, void *data) = 0;
  67         virtual void reg(MtEventReceiver *r, const char *type) = 0;
  68         virtual void dereg(MtEventReceiver *r, const char *type) = 0;
  69 };
  70
  71 #endif
  72