1 /***************************************************************************
2 * Copyright (C) 2005-2018 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #ifndef EVENTMANAGER_H
22 #define EVENTMANAGER_H
31 class EventManager : public QObject
34 Q_FLAGS(EventFlag EventFlags)
39 enum RegistrationMode {
53 Self = 0x01, ///< Self-generated (user input) event
54 Fake = 0x08, ///< Ignore this in CoreSessionEventProcessor
55 Netsplit = 0x10, ///< Netsplit join/part, ignore on display
57 Silent = 0x40, ///< Don't generate a MessageEvent
60 Q_DECLARE_FLAGS(EventFlags, EventFlag)
65 /* These values make sense! Don't change without knowing what you do! */
68 GenericEvent = 0x00000000,
70 // for event group handlers (handleIrcEvent() will handle all IrcEvent* enums)
71 // event groups are specified by bits 20-24
72 EventGroupMask = 0x00ff0000,
74 NetworkEvent = 0x00010000,
85 IrcServerEvent = 0x00020000,
89 IrcEvent = 0x00030000,
104 IrcEventError, /// ERROR message from server
106 IrcEventRawPrivmsg, ///< Undecoded privmsg (still needs CTCP parsing)
107 IrcEventRawNotice, ///< Undecoded notice (still needs CTCP parsing)
108 IrcEventUnknown, ///< Unknown non-numeric cmd
110 IrcEventNumeric = 0x00031000, /* needs 1000 (0x03e8) consecutive free values! */
111 IrcEventNumericMask = 0x00000fff, /* for checking if an event is numeric */
113 MessageEvent = 0x00040000, ///< Stringified event suitable for converting to Message
115 CtcpEvent = 0x00050000,
118 KeyEvent = 0x00060000
121 EventManager(QObject *parent = 0);
123 static EventType eventTypeByName(const QString &name);
124 static EventType eventGroupByName(const QString &name);
125 static QString enumName(EventType type);
126 static QString enumName(int type); // for sanity tests
128 Event *createEvent(const QVariantMap &map);
131 void registerObject(QObject *object, Priority priority = NormalPriority,
132 const QString &methodPrefix = "process",
133 const QString &filterPrefix = "filter");
134 void registerEventHandler(EventType event, QObject *object, const char *slot,
135 Priority priority = NormalPriority, bool isFilter = false);
136 void registerEventHandler(QList<EventType> events, QObject *object, const char *slot,
137 Priority priority = NormalPriority, bool isFilter = false);
139 void registerEventFilter(EventType event, QObject *object, const char *slot);
140 void registerEventFilter(QList<EventType> events, QObject *object, const char *slot);
142 //! Send an event to the registered handlers
144 The EventManager takes ownership of the event and will delete it once it's processed.
145 @param event The event to be dispatched
147 void postEvent(Event *event);
150 virtual Network *networkById(NetworkId id) const = 0;
151 virtual void customEvent(QEvent *event);
159 explicit Handler(QObject *obj = 0, int method = 0, Priority prio = NormalPriority)
162 methodIndex = method;
167 typedef QHash<uint, QList<Handler> > HandlerHash;
169 inline const HandlerHash ®isteredHandlers() const { return _registeredHandlers; }
170 inline HandlerHash ®isteredHandlers() { return _registeredHandlers; }
172 inline const HandlerHash ®isteredFilters() const { return _registeredFilters; }
173 inline HandlerHash ®isteredFilters() { return _registeredFilters; }
175 //! Add handlers to an existing sorted (by priority) handler list
176 void insertHandlers(const QList<Handler> &newHandlers, QList<Handler> &existing, bool checkDupes = false);
177 //! Add filters to an existing filter hash
178 void insertFilters(const QList<Handler> &newFilters, QHash<QObject *, Handler> &existing);
180 int findEventType(const QString &methodSignature, const QString &methodPrefix) const;
182 void processEvent(Event *event);
183 void dispatchEvent(Event *event);
185 //! @return the EventType enum
186 static QMetaEnum eventEnum();
188 HandlerHash _registeredHandlers;
189 HandlerHash _registeredFilters;
190 QList<Event *> _eventQueue;
191 static QMetaEnum _enum;
195 Q_DECLARE_OPERATORS_FOR_FLAGS(EventManager::EventFlags);