src/script_manager.hpp

   1 //  $Id: main.cpp 3275 2006-04-09 00:32:34Z sommer $
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2005 Matthias Braun <matze@braunis.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 //  02111-1307, USA.
  20 #ifndef __SCRIPT_MANAGER_H__
  21 #define __SCRIPT_MANAGER_H__
  22
  23 #include <vector>
  24 #include <list>
  25 #include <squirrel.h>
  26 #include <iostream>
  27 #include "timer.hpp"
  28
  29 class GameObject;
  30
  31 /**
  32  * This class is responsible for managing all running squirrel threads
  33  * (they are cooperative threads or coroutines)
  34  * It keeps a list of suspended scripts and receives wakeup events for them
  35  */
  36 class ScriptManager
  37 {
  38 public:
  39   ScriptManager();
  40   ~ScriptManager();
  41
  42   void update();
  43
  44   /**
  45    * Creates a new thread and registers it with the script manager
  46    * (so it can suspend and register for wakeup events)
  47    */
  48   HSQUIRRELVM create_thread();
  49
  50   HSQUIRRELVM get_global_vm() const
  51   {
  52     return v;
  53   }
  54
  55   enum WakeupEvent {
  56     NO_EVENT,
  57     TIME,
  58     SCREEN_SWITCHED,
  59     WAKEUP_EVENT_COUNT
  60   };
  61
  62   struct WakeupData {
  63     explicit WakeupData() : type(NO_EVENT) {}
  64     explicit WakeupData(WakeupEvent type_) : type(type_) {}
  65
  66     WakeupEvent type;
  67
  68     union {
  69       // GAMEOBJECT_DONE
  70       GameObject* game_object;
  71     };
  72   };
  73
  74   void set_wakeup_event(HSQUIRRELVM vm, WakeupEvent event, float timeout = -1);
  75   void set_wakeup_event(HSQUIRRELVM vm, WakeupData  event, float timeout = -1);
  76   void fire_wakeup_event(WakeupEvent event);
  77   void fire_wakeup_event(WakeupData  event);
  78
  79 private:
  80   class SquirrelVM
  81   {
  82   public:
  83     SquirrelVM(HSQUIRRELVM arg_vm, HSQOBJECT arg_obj);
  84
  85     HSQUIRRELVM vm;
  86     HSQOBJECT   vm_obj;
  87     float       wakeup_time;
  88     WakeupData  waiting_for_events;
  89   };
  90
  91   typedef std::list<SquirrelVM> SquirrelVMs;
  92   SquirrelVMs squirrel_vms;
  93
  94   HSQUIRRELVM v;
  95 };
  96
  97 extern ScriptManager* script_manager;
  98
  99 #endif
 100