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