1 /***************************************************************************
2 * Copyright (C) 2005-2010 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
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 General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 #ifndef EVENTMANAGER_H
22 #define EVENTMANAGER_H
28 class EventManager : public QObject {
30 Q_FLAGS(EventFlag EventFlags)
35 enum RegistrationMode {
50 Silent = 0x40, ///< Don't generate a MessageEvent
53 Q_DECLARE_FLAGS(EventFlags, EventFlag)
58 /* These values make sense! Don't change without knowing what you do! */
61 GenericEvent = 0x00000000,
63 // for event group handlers (handleIrcEvent() will handle all IrcEvent* enums)
64 // event groups are specified by bits 20-24
65 EventGroupMask = 0x00ff0000,
67 NetworkEvent = 0x00010000,
76 IrcServerEvent = 0x00020000,
80 IrcEvent = 0x00030000,
95 IrcEventRawPrivmsg, ///< Undecoded privmsg (still needs CTCP parsing)
96 IrcEventRawNotice, ///< Undecoded notice (still needs CTCP parsing)
97 IrcEventUnknown, ///< Unknown non-numeric cmd
99 IrcEventNumeric = 0x00031000, /* needs 1000 (0x03e8) consecutive free values! */
100 IrcEventNumericMask = 0x00000fff, /* for checking if an event is numeric */
102 MessageEvent = 0x00040000, ///< Stringified event suitable for converting to Message
105 EventManager(QObject *parent = 0);
106 virtual ~EventManager();
108 EventType eventTypeByName(const QString &name) const;
109 EventType eventGroupByName(const QString &name) const;
110 QString enumName(EventType type) const;
113 void registerObject(QObject *object, Priority priority = NormalPriority,
114 const QString &methodPrefix = "process",
115 const QString &filterPrefix = "filter");
116 void registerEventHandler(EventType event, QObject *object, const char *slot,
117 Priority priority = NormalPriority, bool isFilter = false);
118 void registerEventHandler(QList<EventType> events, QObject *object, const char *slot,
119 Priority priority = NormalPriority, bool isFilter = false);
121 void registerEventFilter(EventType event, QObject *object, const char *slot);
122 void registerEventFilter(QList<EventType> events, QObject *object, const char *slot);
124 //! Send an event to the registered handlers
126 The EventManager takes ownership of the event and will delete it once it's processed.
127 NOTE: This method is not threadsafe!
128 @param event The event to be dispatched
130 void sendEvent(Event *event);
133 virtual void customEvent(QEvent *event);
141 explicit Handler(QObject *obj = 0, int method = 0, Priority prio = NormalPriority) {
143 methodIndex = method;
148 typedef QHash<uint, QList<Handler> > HandlerHash;
150 inline const HandlerHash ®isteredHandlers() const { return _registeredHandlers; }
151 inline HandlerHash ®isteredHandlers() { return _registeredHandlers; }
153 inline const HandlerHash ®isteredFilters() const { return _registeredFilters; }
154 inline HandlerHash ®isteredFilters() { return _registeredFilters; }
156 //! Add handlers to an existing sorted (by priority) handler list
157 void insertHandlers(const QList<Handler> &newHandlers, QList<Handler> &existing);
158 //! Add filters to an existing filter hash
159 void insertFilters(const QList<Handler> &newFilters, QHash<QObject *, Handler> &existing);
161 int findEventType(const QString &methodSignature, const QString &methodPrefix) const;
163 void processEvents();
164 void dispatchEvent(Event *event);
166 //! @return the EventType enum
167 QMetaEnum eventEnum() const;
169 HandlerHash _registeredHandlers;
170 HandlerHash _registeredFilters;
171 mutable QMetaEnum _enum;
173 QList<Event *> _eventQueue;
176 Q_DECLARE_OPERATORS_FOR_FLAGS(EventManager::EventFlags);