AbstractTableModel.h

#ifndef AbstractTableModel_H
#define AbstractTableModel_H
 
/* SPDX-License-Identifier: CC0-1.0 */
 
 
#include <QException>
#include <QExplicitlySharedDataPointer>
#include <QObject>
#include <QtConcurrent>
 
// can't forward declare the InternalPointerType or InterestingItems enums
#include "AbstractTreeItem.h"
#include "AbstractTreeModel.h"
 
 
class QAtomicInt;
template< typename T > class QFutureWatcher;
class QTimer;
template< typename T > class QList;
 
 
namespace Isis {
  class AbstractTableDelegate;
  class AbstractTreeModel;
  class BusyLeafItem;
  class TableColumn;
  class TableColumnList;
 
  class AbstractTableModel : public QObject {
      class LessThanFunctor;
 
      Q_OBJECT
 
    public:
      enum Warning {
        None = 0,
        SortingDisabled,
        SortingTableSizeLimitReached
      };
 
      AbstractTableModel(AbstractTreeModel *, AbstractTableDelegate *);
      virtual ~AbstractTableModel();
 
      virtual QList< AbstractTreeItem * > getItems(int, int) = 0;
      virtual QList< AbstractTreeItem * > getItems(AbstractTreeItem *,
          AbstractTreeItem *) = 0;
      virtual QList< AbstractTreeItem * > getSelectedItems() = 0;
      virtual int getVisibleRowCount() const = 0;
      virtual QString getWarningMessage(AbstractTreeItem const *,
          TableColumn const *, QString valueToSave) const = 0;
      virtual int indexOfVisibleItem(AbstractTreeItem const *item) const = 0;
 
      virtual bool isSorting() const;
      virtual bool isFiltering() const;
      virtual bool sortingIsEnabled() const;
      virtual void setSortingEnabled(bool);
      virtual int sortLimit() const;
      virtual void setSortLimit(int);
      virtual bool sortingOn() const;
      virtual TableColumnList *getColumns();
      virtual const AbstractTableDelegate *getDelegate() const;
 
 
    public slots:
      virtual void setGlobalSelection(bool selected) = 0;
      virtual void applyFilter();
      virtual void sort();
      virtual void reverseOrder(TableColumn *);
      virtual void updateSort();
      virtual void rebuildSort();
 
 
    signals:
      void modelModified();
      void filterProgressChanged(int);
      void rebuildProgressChanged(int);
      void sortProgressChanged(int);
      void filterProgressRangeChanged(int, int);
      void rebuildProgressRangeChanged(int, int);
      void sortProgressRangeChanged(int, int);
      void filterCountsChanged(int visibleRows, int totalRows);
      void treeSelectionChanged(QList<AbstractTreeItem *>);
      void tableSelectionChanged(QList<AbstractTreeItem *>);
 
      void userWarning(AbstractTableModel::Warning);
 
    protected:
      virtual TableColumnList *createColumns() = 0;
      AbstractTreeModel *getDataModel();
      const AbstractTreeModel *getDataModel() const;
      virtual QList< AbstractTreeItem * > getSortedItems(int, int,
          AbstractTreeModel::InterestingItems);
      virtual QList< AbstractTreeItem * > getSortedItems(
        AbstractTreeItem *, AbstractTreeItem *,
        AbstractTreeModel::InterestingItems);
      void handleTreeSelectionChanged(
        QList< AbstractTreeItem * > newlySelectedItems,
        AbstractTreeItem::InternalPointerType);
 
 
    private: // disable copying of this class (these are not implemented)
      AbstractTableModel(AbstractTableModel const &);
      AbstractTableModel &operator=(AbstractTableModel const &);
 
 
    private slots:
      void cancelSort();
      void itemsLost();
      void sortStatusUpdated();
      void sortFinished();
 
 
    private:
      QList< AbstractTreeItem * > doSort(QList< AbstractTreeItem * >);
      void nullify();
      void setSorting(bool sorting);
 
 
    private:
      AbstractTreeModel *m_dataModel;
      AbstractTableDelegate *m_delegate;
      QList< AbstractTreeItem * > * m_sortedItems;
      BusyLeafItem *m_busyItem;
      TableColumnList *m_columns;
      QTimer *m_sortStatusPoller;
      LessThanFunctor *m_lessThanFunctor;
 
      bool m_sortingEnabled;
      int m_sortLimit;
      bool m_sorting;
      QFutureWatcher< QList< AbstractTreeItem * > > * m_sortingWatcher;
 
      static const int SORT_UPDATE_FREQUENCY = 50;  // in milliseconds
 
 
    private:
      class LessThanFunctorData;
 
      class LessThanFunctor : public std::function <bool(AbstractTreeItem *const &, AbstractTreeItem *const &)> {
        public:
          LessThanFunctor(TableColumn const *someColumn);
          LessThanFunctor(LessThanFunctor const &);
          ~LessThanFunctor();
 
          int getCompareCount() const;
          void interrupt();
          bool interrupted();
          void reset();
 
          bool operator()(AbstractTreeItem *const &,
              AbstractTreeItem *const &);
          LessThanFunctor &operator=(LessThanFunctor const &);
 
 
        private:
          TableColumn const *m_column;
          QExplicitlySharedDataPointer<LessThanFunctorData> m_sharedData;
      };
 
      class LessThanFunctorData : public QSharedData {
        public:
          LessThanFunctorData();
          LessThanFunctorData(LessThanFunctorData const &);
          ~LessThanFunctorData();
 
          int getCompareCount() const;
          void incrementCompareCount();
 
          void setInterrupted(bool);
          bool interrupted();
 
 
        private:
          QAtomicInt m_compareCount;
          QAtomicInt m_interruptFlag;
      };
 
 
      class SortingCanceledException : public QException {
        public:
          void raise() const { throw *this; }
          QException *clone() const {
            return new SortingCanceledException(*this);
          }
      };
  };
}
 
#endif