Merged changes from branches/supertux-milestone2-grumbel/ to trunk/supertux/
[supertux.git] / src / scripting / time_scheduler.hpp
1 //  SuperTux
2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
3 //
4 //  This program is free software: you can redistribute it and/or modify
5 //  it under the terms of the GNU General Public License as published by
6 //  the Free Software Foundation, either version 3 of the License, or
7 //  (at your option) any later version.
8 //
9 //  This program is distributed in the hope that it will be useful,
10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 //  GNU General Public License for more details.
13 //
14 //  You should have received a copy of the GNU General Public License
15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17 #ifndef HEADER_SUPERTUX_SCRIPTING_TIME_SCHEDULER_HPP
18 #define HEADER_SUPERTUX_SCRIPTING_TIME_SCHEDULER_HPP
19
20 #include <vector>
21
22 namespace Scripting {
23
24 /**
25  * This class keeps a list of squirrel threads that are scheduled for a certain
26  * time. (the typical result of a wait() command in a squirrel script)
27  */
28 class TimeScheduler
29 {
30 public:
31   TimeScheduler();
32   virtual ~TimeScheduler();
33
34   void update(float time);
35   void schedule_thread(HSQUIRRELVM vm, float time);
36
37   static TimeScheduler* instance;
38
39 private:
40   struct ScheduleEntry {
41     /// weak reference to the squirrel vm object
42     HSQOBJECT thread_ref;
43     /// time when the thread should be woken up
44     float wakeup_time;
45
46     bool operator<(const ScheduleEntry& other) const
47     {
48       // we need the smallest value on top
49       return wakeup_time > other.wakeup_time;
50     }
51   };
52
53   typedef std::vector<ScheduleEntry> ScheduleHeap;
54   ScheduleHeap schedule;
55 };
56
57 }
58
59 #endif
60
61 /* EOF */