EventManager: fiddled with time events. Made it possible to register for time events before a world is loaded. Also added some files I forgot to add to the previous commit.

2012-12-14 23:29:28 -05:00 · 2012-12-14 23:29:28 -05:00 · 155a4d044c
parent cf619a519e
commit 155a4d044c
3 changed files with 276 additions and 0 deletions
--- a/library/include/modules/EventManager.h
+++ b/library/include/modules/EventManager.h
@ -0,0 +1,51 @@
+#pragma once
+#ifndef EVENT_MANAGER_H_INCLUDED
+#define EVENT_MANAGER_H_INCLUDED
+
+#include "Core.h"
+#include "Export.h"
+#include "ColorText.h"
+#include "PluginManager.h"
+#include "Console.h"
+
+namespace DFHack {
+    namespace EventManager {
+        namespace EventType {
+            enum EventType {
+                NONE,
+                TICK,
+                TICK_TILE,
+                JOB_INITIATED,
+                JOB_COMPLETED,
+                LIFE,
+                CREATURE,
+                ITEM,
+                TILE,
+                EVENT_MAX=TILE
+            };
+        }
+
+        struct EventHandler {
+            void (*eventHandler)(color_ostream&, void*); //called when the event happens
+
+            EventHandler(void (*eventHandlerIn)(color_ostream&, void*)): eventHandler(eventHandlerIn) {
+            }
+
+            bool operator==(EventHandler& handle) const {
+                return eventHandler == handle.eventHandler;
+            }
+            bool operator!=(EventHandler& handle) const {
+                return !( *this == handle);
+            }
+        };
+        
+        DFHACK_EXPORT void registerListener(EventType::EventType e, EventHandler handler, Plugin* plugin);
+        DFHACK_EXPORT void registerTick(EventHandler handler, int32_t when, Plugin* plugin);
+        DFHACK_EXPORT void unregister(EventType::EventType e, EventHandler handler, Plugin* plugin);
+        DFHACK_EXPORT void unregisterAll(Plugin* plugin);
+        void manageEvents(color_ostream& out);
+        void onStateChange(color_ostream& out, state_change_event event);
+    }
+}
+
+#endif
--- a/library/modules/EventManager.cpp
+++ b/library/modules/EventManager.cpp
@ -0,0 +1,216 @@
+#include "Core.h"
+#include "modules/EventManager.h"
+#include "modules/Job.h"
+#include "modules/World.h"
+
+#include "df/job.h"
+#include "df/global_objects.h"
+#include "df/job_list_link.h"
+#include "df/world.h"
+
+//#include <list>
+#include <map>
+//#include <vector>
+using namespace std;
+using namespace DFHack;
+using namespace EventManager;
+
+/*
+ * TODO:
+ *  error checking
+ **/
+
+//map<uint32_t, vector<DFHack::EventManager::EventHandler> > tickQueue;
+multimap<uint32_t, EventHandler> tickQueue;
+
+multimap<Plugin*, EventHandler> handlers[EventType::EVENT_MAX];
+
+const uint32_t ticksPerYear = 403200;
+
+void DFHack::EventManager::registerListener(EventType::EventType e, EventHandler handler, Plugin* plugin) {
+    handlers[e].insert(pair<Plugin*, EventHandler>(plugin, handler));
+}
+
+void DFHack::EventManager::registerTick(EventHandler handler, int32_t when, Plugin* plugin) {
+    uint32_t tick = DFHack::World::ReadCurrentYear()*ticksPerYear
+        + DFHack::World::ReadCurrentTick();
+    if ( !Core::getInstance().isWorldLoaded() ) {
+        tick = 0;
+    }
+    
+    tickQueue.insert(pair<uint32_t, EventHandler>(tick+(uint32_t)when, handler));
+    handlers[EventType::TICK].insert(pair<Plugin*,EventHandler>(plugin,handler));
+    return;
+}
+
+void DFHack::EventManager::unregister(EventType::EventType e, EventHandler handler, Plugin* plugin) {
+    for ( multimap<Plugin*, EventHandler>::iterator i = handlers[e].find(plugin); i != handlers[e].end(); i++ ) {
+        if ( (*i).first != plugin )
+            break;
+        EventHandler handle = (*i).second;
+        if ( handle == handler ) {
+            handlers[e].erase(i);
+            break;
+        }
+    }
+    return;
+}
+
+void DFHack::EventManager::unregisterAll(Plugin* plugin) {
+    for ( auto i = handlers[EventType::TICK].find(plugin); i != handlers[EventType::TICK].end(); i++ ) {
+        if ( (*i).first != plugin )
+            break;
+        
+        //shenanigans to avoid concurrent modification
+        EventHandler getRidOf = (*i).second;
+        bool didSomething;
+        do {
+            didSomething = false;
+            for ( auto j = tickQueue.begin(); j != tickQueue.end(); j++ ) {
+                EventHandler candidate = (*j).second;
+                if ( getRidOf != candidate )
+                    continue;
+                tickQueue.erase(j);
+                didSomething = true;
+                break;
+            }
+        } while(didSomething);
+    }
+    for ( size_t a = 0; a < (size_t)EventType::EVENT_MAX; a++ ) {
+        handlers[a].erase(plugin);
+    }
+    return;
+}
+
+static void manageTickEvent(color_ostream& out);
+static void manageJobInitiatedEvent(color_ostream& out);
+static void manageJobCompletedEvent(color_ostream& out);
+
+uint32_t lastTick = 0;
+int32_t lastJobId = -1;
+static map<int32_t, df::job*> prevJobs;
+
+void DFHack::EventManager::onStateChange(color_ostream& out, state_change_event event) {
+    if ( event == DFHack::SC_MAP_UNLOADED ) {
+        lastTick = 0;
+        lastJobId = -1;
+        for ( auto i = prevJobs.begin(); i != prevJobs.end(); i++ ) {
+            Job::deleteJobStruct((*i).second);
+        }
+        prevJobs.clear();
+        tickQueue.clear();
+    } else if ( event == DFHack::SC_MAP_LOADED ) {
+        uint32_t tick = DFHack::World::ReadCurrentYear()*ticksPerYear
+            + DFHack::World::ReadCurrentTick();
+        multimap<uint32_t,EventHandler> newTickQueue;
+        for ( auto i = tickQueue.begin(); i != tickQueue.end(); i++ ) {
+            newTickQueue.insert(pair<uint32_t,EventHandler>(tick + (*i).first, (*i).second));
+        }
+        tickQueue.clear();
+
+        tickQueue.insert(newTickQueue.begin(), newTickQueue.end());
+    }
+}
+
+void DFHack::EventManager::manageEvents(color_ostream& out) {
+    if ( !Core::getInstance().isWorldLoaded() ) {
+        return;
+    }
+    uint32_t tick = DFHack::World::ReadCurrentYear()*ticksPerYear
+        + DFHack::World::ReadCurrentTick();
+    if ( tick <= lastTick )
+        return;
+    lastTick = tick;
+    
+    manageTickEvent(out);
+    manageJobInitiatedEvent(out);
+    manageJobCompletedEvent(out);
+    
+    return;
+}
+
+static void manageTickEvent(color_ostream& out) {
+    uint32_t tick = DFHack::World::ReadCurrentYear()*ticksPerYear
+        + DFHack::World::ReadCurrentTick();
+    while ( !tickQueue.empty() ) {
+        if ( tick < (*tickQueue.begin()).first )
+            break;
+        EventHandler handle = (*tickQueue.begin()).second;
+        tickQueue.erase(tickQueue.begin());
+        handle.eventHandler(out, (void*)tick);
+    }
+    
+}
+
+static void manageJobInitiatedEvent(color_ostream& out) {
+    if ( handlers[EventType::JOB_INITIATED].empty() )
+        return;
+    
+    if ( lastJobId == -1 ) {
+        lastJobId = *df::global::job_next_id - 1;
+        return;
+    }
+
+    if ( lastJobId+1 == *df::global::job_next_id ) {
+        return; //no new jobs
+    }
+    
+    for ( df::job_list_link* link = &df::global::world->job_list; link != NULL; link = link->next ) {
+        if ( link->item == NULL )
+            continue;
+        if ( link->item->id <= lastJobId )
+            continue;
+        for ( multimap<Plugin*, EventHandler>::iterator i = handlers[EventType::JOB_INITIATED].begin(); i != handlers[EventType::JOB_INITIATED].end(); i++ ) {
+            (*i).second.eventHandler(out, (void*)link->item);
+        }
+    }
+
+    lastJobId = *df::global::job_next_id - 1;
+}
+
+
+static void manageJobCompletedEvent(color_ostream& out) {
+    if ( handlers[EventType::JOB_COMPLETED].empty() ) {
+        return;
+    }
+    
+    map<int32_t, df::job*> nowJobs;
+    for ( df::job_list_link* link = &df::global::world->job_list; link != NULL; link = link->next ) {
+        if ( link->item == NULL )
+            continue;
+        nowJobs[link->item->id] = link->item;
+    }
+
+    for ( map<int32_t, df::job*>::iterator i = prevJobs.begin(); i != prevJobs.end(); i++ ) {
+        if ( nowJobs.find((*i).first) != nowJobs.end() )
+            continue;
+
+        //recently finished or cancelled job!
+        for ( multimap<Plugin*, EventHandler>::iterator j = handlers[EventType::JOB_COMPLETED].begin(); j != handlers[EventType::JOB_COMPLETED].end(); j++ ) {
+            (*j).second.eventHandler(out, (void*)(*i).second);
+        }
+    }
+
+    //erase old jobs, copy over possibly altered jobs
+    for ( map<int32_t, df::job*>::iterator i = prevJobs.begin(); i != prevJobs.end(); i++ ) {
+        Job::deleteJobStruct((*i).second);
+    }
+    prevJobs.clear();
+    
+    //create new jobs
+    for ( map<int32_t, df::job*>::iterator j = nowJobs.begin(); j != nowJobs.end(); j++ ) {
+        /*map<int32_t, df::job*>::iterator i = prevJobs.find((*j).first);
+        if ( i != prevJobs.end() ) {
+            continue;
+        }*/
+
+        df::job* newJob = Job::cloneJobStruct((*j).second, true);
+        prevJobs[newJob->id] = newJob;
+    }
+
+    /*//get rid of old pointers to deallocated jobs
+    for ( size_t a = 0; a < toDelete.size(); a++ ) {
+        prevJobs.erase(a);
+    }*/
+}
+
--- a/plugins/eventExample.cpp
+++ b/plugins/eventExample.cpp
@ -12,14 +12,20 @@ DFHACK_PLUGIN("eventExample");

 void jobInitiated(color_ostream& out, void* job);
 void jobCompleted(color_ostream& out, void* job);
+void timePassed(color_ostream& out, void* ptr);

 DFhackCExport command_result plugin_init(color_ostream &out, std::vector<PluginCommand> &commands) {
    EventManager::EventHandler initiateHandler(jobInitiated);
    EventManager::EventHandler completeHandler(jobCompleted);
+    EventManager::EventHandler timeHandler(timePassed);
    Plugin* me = Core::getInstance().getPluginManager()->getPluginByName("eventExample");

    EventManager::registerListener(EventManager::EventType::JOB_INITIATED, initiateHandler, me);
    EventManager::registerListener(EventManager::EventType::JOB_COMPLETED, completeHandler, me);
+    EventManager::registerTick(timeHandler, 1, me);
+    EventManager::registerTick(timeHandler, 2, me);
+    EventManager::registerTick(timeHandler, 4, me);
+    EventManager::registerTick(timeHandler, 8, me);
    
    return CR_OK;
 }
@ -32,3 +38,6 @@ void jobCompleted(color_ostream& out, void* job) {
    out.print("Job completed! 0x%X\n", job);
 }

+void timePassed(color_ostream& out, void* ptr) {
+    out.print("Time: %d\n", (int32_t)(ptr));
+}