qa: Resolve Qt deprecation warnings - default-construct QFlags
[quassel.git] / src / client / treemodel.h
index 27360ba..3c6ce91 100644 (file)
@@ -1,11 +1,11 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by The Quassel Team                             *
+ *   Copyright (C) 2005-2020 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   (at your option) version 3.                                           *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef _TREEMODEL_H_
-#define _TREEMODEL_H_
+#pragma once
 
+#include "client-export.h"
+
+#include <QAbstractItemModel>
+#include <QLinkedList>  // needed for debug
 #include <QList>
+#include <QStringList>
 #include <QVariant>
-#include <QHash>
-#include <QAbstractItemModel>
 
 /*****************************************
  *  general item used in the Tree Model
  *****************************************/
-class TreeItem : public QObject {
-  Q_OBJECT
-  Q_PROPERTY(uint id READ id)
-  
+class CLIENT_EXPORT AbstractTreeItem : public QObject
+{
+    Q_OBJECT
+
 public:
-  TreeItem(const QList<QVariant> &data, TreeItem *parent = 0);
-  TreeItem(TreeItem *parent = 0);
-  virtual ~TreeItem();
-  
-  void appendChild(TreeItem *child);
-  void removeChild(int row);
-                   
-  virtual uint id() const;
-  TreeItem *child(int row) const;
-  TreeItem *childById(const uint &) const;
-  int childCount() const;
-  int columnCount() const;
-  virtual QVariant data(int column, int role) const;
-  int row() const;
-  TreeItem *parent();
-    
+    enum TreeItemFlag
+    {
+        NoTreeItemFlag = 0x00,
+        DeleteOnLastChildRemoved = 0x01
+    };
+    Q_DECLARE_FLAGS(TreeItemFlags, TreeItemFlag)
+
+    AbstractTreeItem(AbstractTreeItem* parent = nullptr);
+
+    bool newChild(AbstractTreeItem* child);
+    bool newChilds(const QList<AbstractTreeItem*>& items);
+
+    bool removeChild(int row);
+    inline bool removeChild(AbstractTreeItem* child) { return removeChild(child->row()); }
+    void removeAllChilds();
+
+    bool reParent(AbstractTreeItem* newParent);
+
+    AbstractTreeItem* child(int row) const;
+
+    int childCount(int column = 0) const;
+
+    virtual int columnCount() const = 0;
+
+    virtual QVariant data(int column, int role) const = 0;
+    virtual bool setData(int column, const QVariant& value, int role) = 0;
+
+    virtual inline Qt::ItemFlags flags() const { return _flags; }
+    virtual inline void setFlags(Qt::ItemFlags flags) { _flags = flags; }
+
+    inline AbstractTreeItem::TreeItemFlags treeItemFlags() const { return _treeItemFlags; }
+    inline void setTreeItemFlags(AbstractTreeItem::TreeItemFlags flags) { _treeItemFlags = flags; }
+    int row() const;
+    inline AbstractTreeItem* parent() const { return qobject_cast<AbstractTreeItem*>(QObject::parent()); }
+
+    void dumpChildList();
+
+signals:
+    void dataChanged(int column = -1);
+
+    void beginAppendChilds(int firstRow, int lastRow);
+    void endAppendChilds();
+
+    void beginRemoveChilds(int firstRow, int lastRow);
+    void endRemoveChilds();
+
 protected:
-  QList<TreeItem *> childItems;
-  QHash<uint, TreeItem *> childHash; // uint to be compatible to qHash functions
-  TreeItem *parentItem;
-  QList<QVariant> itemData;
+    void customEvent(QEvent* event) override;
+
+private:
+    QList<AbstractTreeItem*> _childItems;
+    Qt::ItemFlags _flags{};
+    TreeItemFlags _treeItemFlags{};
+
+    void removeChildLater(AbstractTreeItem* child);
+    inline void checkForDeletion()
+    {
+        if (treeItemFlags() & DeleteOnLastChildRemoved && childCount() == 0)
+            parent()->removeChildLater(this);
+    }
 };
 
+/*****************************************
+ * SimpleTreeItem
+ *****************************************/
+class CLIENT_EXPORT SimpleTreeItem : public AbstractTreeItem
+{
+    Q_OBJECT
+
+public:
+    SimpleTreeItem(QList<QVariant> data, AbstractTreeItem* parent = nullptr);
+
+    QVariant data(int column, int role) const override;
+    bool setData(int column, const QVariant& value, int role) override;
+
+    int columnCount() const override;
+
+private:
+    QList<QVariant> _itemData;
+};
+
+/*****************************************
+ * PropertyMapItem
+ *****************************************/
+class CLIENT_EXPORT PropertyMapItem : public AbstractTreeItem
+{
+    Q_OBJECT
+
+public:
+    PropertyMapItem(AbstractTreeItem* parent = nullptr);
+
+    virtual QStringList propertyOrder() const = 0;
+
+    QVariant data(int column, int role) const override;
+    bool setData(int column, const QVariant& value, int role) override;
+
+    virtual QString toolTip(int column) const { Q_UNUSED(column) return QString(); }
+    int columnCount() const override;
+};
 
 /*****************************************
  * TreeModel
  *****************************************/
-class TreeModel : public QAbstractItemModel {
-  Q_OBJECT
-  
+class CLIENT_EXPORT TreeModel : public QAbstractItemModel
+{
+    Q_OBJECT
+
 public:
-  TreeModel(const QList<QVariant> &, QObject *parent = 0);
-  virtual ~TreeModel();
-  
-  QVariant data(const QModelIndex &index, int role) const;
-  virtual Qt::ItemFlags flags(const QModelIndex &index) const;
-  QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
-  QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
-  QModelIndex indexById(uint id, const QModelIndex &parent = QModelIndex()) const;
-  QModelIndex parent(const QModelIndex &index) const;
-  int rowCount(const QModelIndex &parent = QModelIndex()) const;
-  int columnCount(const QModelIndex &parent = QModelIndex()) const;
-
-  virtual void clear();
+    enum myRoles
+    {
+        SortRole = Qt::UserRole,
+        UserRole
+    };
+
+    TreeModel(const QList<QVariant>&, QObject* parent = nullptr);
+    ~TreeModel() override;
+
+    AbstractTreeItem* root() const;
+
+    QVariant data(const QModelIndex& index, int role) const override;
+    bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
+
+    Qt::ItemFlags flags(const QModelIndex& index) const override;
+    QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
+
+    QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;
+    QModelIndex indexByItem(AbstractTreeItem* item) const;
+
+    QModelIndex parent(const QModelIndex& index) const override;
+
+    int rowCount(const QModelIndex& parent = QModelIndex()) const override;
+    int columnCount(const QModelIndex& parent = QModelIndex()) const override;
+
+    virtual void clear();
+
+private slots:
+    void itemDataChanged(int column = -1);
+
+    void beginAppendChilds(int firstRow, int lastRow);
+    void endAppendChilds();
+
+    void beginRemoveChilds(int firstRow, int lastRow);
+    void endRemoveChilds();
 
 protected:
-  bool removeRow(int row, const QModelIndex &parent = QModelIndex());
-  bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex());
+    AbstractTreeItem* rootItem;
 
-  TreeItem *rootItem;
-};
+private:
+    void connectItem(AbstractTreeItem* item);
+
+    struct ChildStatus
+    {
+        QModelIndex parent;
+        int childCount;
+        int start;
+        int end;
+        inline ChildStatus(QModelIndex parent_, int cc_, int s_, int e_)
+            : parent(parent_)
+            , childCount(cc_)
+            , start(s_)
+            , end(e_){};
+    };
+    ChildStatus _childStatus;
+    int _aboutToRemoveOrInsert;
 
-#endif
+private slots:
+    void debug_rowsAboutToBeInserted(const QModelIndex& parent, int start, int end);
+    void debug_rowsAboutToBeRemoved(const QModelIndex& parent, int start, int end);
+    void debug_rowsInserted(const QModelIndex& parent, int start, int end);
+    void debug_rowsRemoved(const QModelIndex& parent, int start, int end);
+    void debug_dataChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight);
+};