src/common/event.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 #ifndef EVENT_H
  22 #define EVENT_H
  23
  24 #include <QDateTime>
  25 #include <QDebug>
  26
  27 #include "eventmanager.h"
  28
  29 class Network;
  30
  31 class Event
  32 {
  33 public:
  34     explicit Event(EventManager::EventType type = EventManager::Invalid);
  35     virtual ~Event() {}
  36
  37     inline EventManager::EventType type() const { return _type; }
  38
  39     inline void setFlag(EventManager::EventFlag flag) { _flags |= flag; }
  40     inline void setFlags(EventManager::EventFlags flags) { _flags = flags; }
  41     inline bool testFlag(EventManager::EventFlag flag) { return _flags.testFlag(flag); }
  42     inline EventManager::EventFlags flags() const { return _flags; }
  43
  44     inline bool isValid() const { return _valid; }
  45     inline void stop() { setFlag(EventManager::Stopped); }
  46     inline bool isStopped() { return _flags.testFlag(EventManager::Stopped); }
  47
  48     inline void setTimestamp(const QDateTime &time) { _timestamp = time; }
  49     inline QDateTime timestamp() const { return _timestamp; }
  50
  51     //inline void setData(const QVariant &data) { _data = data; }
  52     //inline QVariant data() const { return _data; }
  53
  54     // call EventManager::createEvent(map) instead!
  55     static Event *fromVariantMap(QVariantMap &map, Network *network);
  56     QVariantMap toVariantMap() const;
  57
  58 protected:
  59     virtual inline QString className() const { return "Event"; }
  60     virtual inline void debugInfo(QDebug &dbg) const { Q_UNUSED(dbg); }
  61
  62     explicit Event(EventManager::EventType type, QVariantMap &map);
  63
  64     // must only use primitive types: string, int, double, list, hash
  65     // we want to convert this to JSON in the future!
  66     virtual void toVariantMap(QVariantMap &map) const;
  67
  68     inline void setValid(bool valid) { _valid = valid; }
  69
  70 private:
  71     EventManager::EventType _type;
  72     EventManager::EventFlags _flags;
  73     QDateTime _timestamp;
  74     //QVariant _data;
  75     bool _valid;
  76
  77     friend QDebug operator<<(QDebug dbg, Event *e);
  78 };
  79
  80
  81 QDebug operator<<(QDebug dbg, Event *e);
  82
  83 /*******/
  84
  85 #endif