Make the EventType meta enum and related accessors static
[quassel.git] / src / common / eventmanager.cpp
index 9664864..03e891f 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2010 by the Quassel Project                        *
+ *   Copyright (C) 2005-2012 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 #include <QDebug>
 
 #include "event.h"
-
-EventManager::EventManager(QObject *parent) : QObject(parent) {
-
-}
-
-EventManager::~EventManager() {
-  // pending events won't be delivered anymore, but we do need to delete them
-  qDeleteAll(_eventQueue);
+#include "ircevent.h"
+
+// ============================================================
+//  QueuedEvent
+// ============================================================
+class QueuedQuasselEvent : public QEvent {
+public:
+  QueuedQuasselEvent(Event *event)
+    : QEvent(QEvent::User), event(event) {}
+  Event *event;
+};
+
+// ============================================================
+//  EventManager
+// ============================================================
+EventManager::EventManager(QObject *parent)
+  : QObject(parent) {
 }
 
-QMetaEnum EventManager::eventEnum() const {
+QMetaEnum EventManager::eventEnum() {
   if(!_enum.isValid()) {
-    int eventEnumIndex = metaObject()->indexOfEnumerator("EventType");
+    int eventEnumIndex = staticMetaObject.indexOfEnumerator("EventType");
     Q_ASSERT(eventEnumIndex >= 0);
-    _enum = metaObject()->enumerator(eventEnumIndex);
+    _enum = staticMetaObject.enumerator(eventEnumIndex);
     Q_ASSERT(_enum.isValid());
   }
   return _enum;
 }
 
-EventManager::EventType EventManager::eventTypeByName(const QString &name) const {
+EventManager::EventType EventManager::eventTypeByName(const QString &name) {
   int val = eventEnum().keyToValue(name.toLatin1());
   return (val == -1) ? Invalid : static_cast<EventType>(val);
 }
 
-EventManager::EventType EventManager::eventGroupByName(const QString &name) const {
+EventManager::EventType EventManager::eventGroupByName(const QString &name) {
   EventType type = eventTypeByName(name);
   return type == Invalid? Invalid : static_cast<EventType>(type & EventGroupMask);
 }
 
-QString EventManager::enumName(EventType type) const {
+QString EventManager::enumName(EventType type) {
+  return eventEnum().valueToKey(type);
+}
+
+QString EventManager::enumName(int type) {
   return eventEnum().valueToKey(type);
 }
 
@@ -73,32 +86,72 @@ QString EventManager::enumName(EventType type) const {
    with the actual class. Possibly (optionally) using rtti...
 */
 
-void EventManager::registerObject(QObject *object, Priority priority, const QString &methodPrefix) {
-  for(int i = object->metaObject()->methodOffset(); i < object->metaObject()->methodCount(); i++) {
-    QString methodSignature(object->metaObject()->method(i).signature());
+int EventManager::findEventType(const QString &methodSignature_, const QString &methodPrefix) const {
+  if(!methodSignature_.startsWith(methodPrefix))
+    return -1;
 
-    if(!methodSignature.startsWith(methodPrefix))
-      continue;
+  QString methodSignature = methodSignature_;
 
-    methodSignature = methodSignature.section('(',0,0);  // chop the attribute list
-    methodSignature = methodSignature.mid(methodPrefix.length()); // strip prefix
+  methodSignature = methodSignature.section('(',0,0);  // chop the attribute list
+  methodSignature = methodSignature.mid(methodPrefix.length()); // strip prefix
 
-    int eventType = eventEnum().keyToValue(methodSignature.toAscii());
-    if(eventType < 0) {
-      qWarning() << Q_FUNC_INFO << QString("Could not find EventType %1").arg(methodSignature);
-      continue;
+  int eventType = -1;
+
+  // special handling for numeric IrcEvents: IrcEvent042 gets mapped to IrcEventNumeric + 42
+  if(methodSignature.length() == 8+3 && methodSignature.startsWith("IrcEvent")) {
+    int num = methodSignature.right(3).toUInt();
+    if(num > 0) {
+      QString numericSig = methodSignature.left(methodSignature.length() - 3) + "Numeric";
+      eventType = eventEnum().keyToValue(numericSig.toAscii());
+      if(eventType < 0) {
+        qWarning() << Q_FUNC_INFO << "Could not find EventType" << numericSig << "for handling" << methodSignature;
+        return -1;
+      }
+      eventType += num;
     }
-    Handler handler(object, i, priority);
-    registeredHandlers()[static_cast<EventType>(eventType)].append(handler);
-    qDebug() << "Registered event handler for" << methodSignature << "in" << object;
   }
+
+  if(eventType < 0)
+    eventType = eventEnum().keyToValue(methodSignature.toAscii());
+  if(eventType < 0) {
+    qWarning() << Q_FUNC_INFO << "Could not find EventType" << methodSignature;
+    return -1;
+  }
+  return eventType;
+}
+
+void EventManager::registerObject(QObject *object, Priority priority, const QString &methodPrefix, const QString &filterPrefix) {
+  for(int i = object->metaObject()->methodOffset(); i < object->metaObject()->methodCount(); i++) {
+    QString methodSignature(object->metaObject()->method(i).signature());
+
+    int eventType = findEventType(methodSignature, methodPrefix);
+    if(eventType > 0) {
+      Handler handler(object, i, priority);
+      registeredHandlers()[eventType].append(handler);
+      //qDebug() << "Registered event handler for" << methodSignature << "in" << object;
+    }
+    eventType = findEventType(methodSignature, filterPrefix);
+    if(eventType > 0) {
+      Handler handler(object, i, priority);
+      registeredFilters()[eventType].append(handler);
+      //qDebug() << "Registered event filterer for" << methodSignature << "in" << object;
+    }
+  }
+}
+
+void EventManager::registerEventFilter(EventType event, QObject *object, const char *slot) {
+  registerEventHandler(QList<EventType>() << event, object, slot, NormalPriority, true);
 }
 
-void EventManager::registerEventHandler(EventType event, QObject *object, const char *slot, Priority priority) {
-  registerEventHandler(QList<EventType>() << event, object, slot, priority);
+void EventManager::registerEventFilter(QList<EventType> events, QObject *object, const char *slot) {
+  registerEventHandler(events, object, slot, NormalPriority, true);
 }
 
-void EventManager::registerEventHandler(QList<EventType> events, QObject *object, const char *slot, Priority priority) {
+void EventManager::registerEventHandler(EventType event, QObject *object, const char *slot, Priority priority, bool isFilter) {
+  registerEventHandler(QList<EventType>() << event, object, slot, priority, isFilter);
+}
+
+void EventManager::registerEventHandler(QList<EventType> events, QObject *object, const char *slot, Priority priority, bool isFilter) {
   int methodIndex = object->metaObject()->indexOfMethod(slot);
   if(methodIndex < 0) {
     qWarning() << Q_FUNC_INFO << QString("Slot %1 not found in object %2").arg(slot).arg(object->objectName());
@@ -106,34 +159,45 @@ void EventManager::registerEventHandler(QList<EventType> events, QObject *object
   }
   Handler handler(object, methodIndex, priority);
   foreach(EventType event, events) {
-    registeredHandlers()[event].append(handler);
-    qDebug() << "Registered event handler for" << event << "in" << object;
+    if(isFilter) {
+      registeredFilters()[event].append(handler);
+      qDebug() << "Registered event filter for" << event << "in" << object;
+    } else {
+      registeredHandlers()[event].append(handler);
+      qDebug() << "Registered event handler for" << event << "in" << object;
+    }
   }
 }
 
-// not threadsafe! if we should want that, we need to add a mutexed queue somewhere in this general area.
-void EventManager::sendEvent(Event *event) {
-  // qDebug() << "Sending" << event;
-  _eventQueue.append(event);
-  if(_eventQueue.count() == 1) // we're not currently processing another event
-    processEvents();
+void EventManager::postEvent(Event *event) {
+  if(sender() && sender()->thread() != this->thread()) {
+    QueuedQuasselEvent *queuedEvent = new QueuedQuasselEvent(event);
+    QCoreApplication::postEvent(this, queuedEvent);
+  } else {
+    if(_eventQueue.isEmpty())
+      // we're currently not processing events
+      processEvent(event);
+    else
+      _eventQueue.append(event);
+  }
 }
 
 void EventManager::customEvent(QEvent *event) {
   if(event->type() == QEvent::User) {
-    processEvents();
+    QueuedQuasselEvent *queuedEvent = static_cast<QueuedQuasselEvent *>(event);
+    processEvent(queuedEvent->event);
     event->accept();
   }
 }
 
-void EventManager::processEvents() {
-  // we only process one event at a time for now, and let Qt's own event processing come in between
-  if(_eventQueue.isEmpty())
-    return;
-  dispatchEvent(_eventQueue.first());
-  _eventQueue.removeFirst();
-  if(_eventQueue.count())
-    QCoreApplication::postEvent(this, new QEvent(QEvent::User));
+void EventManager::processEvent(Event *event) {
+  Q_ASSERT(_eventQueue.isEmpty());
+  dispatchEvent(event);
+  // dispatching the event might cause new events to be generated. we process those afterwards.
+  while(!_eventQueue.isEmpty()) {
+    dispatchEvent(_eventQueue.first());
+    _eventQueue.removeFirst();
+  }
 }
 
 void EventManager::dispatchEvent(Event *event) {
@@ -143,42 +207,97 @@ void EventManager::dispatchEvent(Event *event) {
 
   // build a list sorted by priorities that contains all eligible handlers
   QList<Handler> handlers;
-  EventType type = event->type();
-  insertHandlers(registeredHandlers().value(type), handlers);
+  QHash<QObject *, Handler> filters;
+  QSet<QObject *> ignored;
+  uint type = event->type();
+
+  bool checkDupes = false;
+
+  // special handling for numeric IrcEvents
+  if((type & ~IrcEventNumericMask) == IrcEventNumeric) {
+    ::IrcEventNumeric *numEvent = static_cast< ::IrcEventNumeric *>(event);
+    if(!numEvent)
+      qWarning() << "Invalid event type for IrcEventNumeric!";
+    else {
+      int num = numEvent->number();
+      if(num > 0) {
+        insertHandlers(registeredHandlers().value(type + num), handlers, false);
+        insertFilters(registeredFilters().value(type + num), filters);
+        checkDupes = true;
+      }
+    }
+  }
+
+  // exact type
+  insertHandlers(registeredHandlers().value(type), handlers, checkDupes);
+  insertFilters(registeredFilters().value(type), filters);
 
   // check if we have a generic handler for the event group
-  if((type & EventGroupMask) != type)
-    insertHandlers(registeredHandlers().value(type & EventGroupMask), handlers);
+  if((type & EventGroupMask) != type) {
+    insertHandlers(registeredHandlers().value(type & EventGroupMask), handlers, true);
+    insertFilters(registeredFilters().value(type & EventGroupMask), filters);
+  }
 
   // now dispatch the event
-  QList<Handler>::const_iterator it = handlers.begin();
-  while(it != handlers.end()) {
+  QList<Handler>::const_iterator it;
+  for(it = handlers.begin(); it != handlers.end() && !event->isStopped(); ++it) {
+    QObject *obj = it->object;
 
-    // TODO: check event flags here!
+    if(ignored.contains(obj)) // object has filtered the event
+      continue;
 
-    void *param[] = {0, Q_ARG(Event *, event).data() };
-    it->object->qt_metacall(QMetaObject::InvokeMetaMethod, it->methodIndex, param);
+    if(filters.contains(obj)) { // we have a filter, so let's check if we want to deliver the event
+      Handler filter = filters.value(obj);
+      bool result = false;
+      void *param[] = {Q_RETURN_ARG(bool, result).data(), Q_ARG(Event *, event).data() };
+      obj->qt_metacall(QMetaObject::InvokeMetaMethod, filter.methodIndex, param);
+      if(!result) {
+        ignored.insert(obj);
+        continue; // mmmh, event filter told us to not accept
+      }
+    }
 
-    ++it;
+    // finally, deliverance!
+    void *param[] = {0, Q_ARG(Event *, event).data() };
+    obj->qt_metacall(QMetaObject::InvokeMetaMethod, it->methodIndex, param);
   }
 
-  // finally, delete it
+  // that's it
   delete event;
 }
 
-void EventManager::insertHandlers(const QList<Handler> &newHandlers, QList<Handler> &existing) {
-  foreach(Handler handler, newHandlers) {
+void EventManager::insertHandlers(const QList<Handler> &newHandlers, QList<Handler> &existing, bool checkDupes) {
+  foreach(const Handler &handler, newHandlers) {
     if(existing.isEmpty())
       existing.append(handler);
     else {
-      // need to insert it at the proper position
+      // need to insert it at the proper position, but only if we don't yet have a handler for this event and object!
+      bool insert = true;
+      QList<Handler>::iterator insertpos = existing.end();
       QList<Handler>::iterator it = existing.begin();
       while(it != existing.end()) {
-        if(handler.priority > it->priority)
+        if(checkDupes && handler.object == it->object) {
+          insert = false;
           break;
+        }
+        if(insertpos == existing.end() && handler.priority > it->priority)
+          insertpos = it;
+
         ++it;
       }
-      existing.insert(it, handler);
+      if(insert)
+        existing.insert(it, handler);
     }
   }
 }
+
+// priority is ignored, and only the first (should be most specialized) filter is being used
+// fun things could happen if you used the registerEventFilter() methods in the wrong order though
+void EventManager::insertFilters(const QList<Handler> &newFilters, QHash<QObject *, Handler> &existing) {
+  foreach(const Handler &filter, newFilters) {
+    if(!existing.contains(filter.object))
+      existing[filter.object] = filter;
+  }
+}
+
+QMetaEnum EventManager::_enum;