pilotclient/src/blackgui/models/listmodelbase.h

/* Copyright (C) 2013
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
 * including this file, may be copied, modified, propagated, or distributed except according to the terms
 * contained in the LICENSE file.
 */

//! \file

#ifndef BLACKGUI_LISTMODELBASE_H
#define BLACKGUI_LISTMODELBASE_H

#include "blackgui/models/listmodelbasenontemplate.h"
//#include "blackgui/models/columns.h"
#include "blackgui/models/modelfilter.h"
#include "blackgui/models/selectionmodel.h"
//#include "blackgui/dropbase.h"
//#include "blackgui/blackguiexport.h"
//#include "blackmisc/digestsignal.h"
//#include "blackmisc/variant.h"

#include <QJsonDocument>
#include <QJsonObject>
#include <QModelIndex>
#include <QModelIndexList>
#include <QString>
#include <QVariant>
#include <QVector>
#include <memory>

class QMimeData;
class QModelIndex;

namespace BlackMisc { class CWorker; }
namespace BlackGui
{
    namespace Models
    {
        //! List model
        template <typename T, bool UseCompare = false>
        class CListModelBase : public CListModelBaseNonTemplate
        {
        public:
            //! Container type
            using ContainerType = T;

            //! Container element type
            using ObjectType = typename T::value_type;

            //! Destructor
            virtual ~CListModelBase() {}

            //! \name Functions from QStandardItemModel
            //! @{
            virtual QVariant data(const QModelIndex &index, int role) const override;
            virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) final override;
            virtual QMimeData *mimeData(const QModelIndexList &indexes) const final override;
            virtual void sort(int column, Qt::SortOrder order) final override;
            virtual int rowCount(const QModelIndex &parentIndex = QModelIndex()) const final override;
            virtual bool canDropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const final override;
            virtual bool dropMimeData(const QMimeData *mimeData, Qt::DropAction action, int row, int column, const QModelIndex &parent) final override;
            //! @}

            //! \name Functions from CListModelBaseNonTemplate
            //! @{
            virtual QJsonObject toJson(bool selectedOnly = false) const override;
            virtual QString toJsonString(QJsonDocument::JsonFormat format = QJsonDocument::Indented, bool selectedOnly = false) const override;
            virtual bool isOrderable() const override;
            //! @}

            //! Valid index (in range)
            virtual bool isValidIndex(const QModelIndex &index) const;

            //! Used container data
            const ContainerType &container() const;

            //! Used container data
            const ContainerType &containerFiltered() const;

            //! Full container or cached filtered container as approproiate
            const ContainerType &containerOrFilteredContainer(bool *filtered = nullptr) const;

            //! Simple set of data in container, using class is responsible for firing signals etc.
            //! \sa sendDataChanged
            bool setInContainer(const QModelIndex &index, const ObjectType &obj);

            //! Update by new container
            //! \return int size after update
            //! \remarks a sorting is performed only if a valid sort column is set
            virtual int update(const ContainerType &container, bool sort = true);

            //! Asynchronous update
            virtual BlackMisc::CWorker *updateAsync(const ContainerType &container, bool sort = true);

            //! Update by new container
            virtual void updateContainerMaybeAsync(const ContainerType &container, bool sort = true);

            //! Update single element
            virtual void update(const QModelIndex &index, const ObjectType &object);

            //! Update single element
            virtual void update(int rowIndex, const ObjectType &object);

            //! Move items to position, normally called from dropMimeData
            //! \sa dropMimeData
            virtual void moveItems(const ContainerType &items, int position);

            //! Object at row position
            virtual const ObjectType &at(const QModelIndex &index) const;

            //! Sort by given sort order \sa getSortColumn() \sa getSortOrder()
            void sort();

            //! Truncate to given number
            void truncate(int maxNumber, bool forceSort = false);

            //! Sort container by given column / order. This is used by sort() but als
            //! for asynchronous updates in the views
            //! \param container used list
            //! \param column    column inder
            //! \param order     sort order (ascending / descending)
            //! \threadsafe under normal conditions thread safe as long as the column metadata are not changed
            ContainerType sortContainerByColumn(const ContainerType &container, int column, Qt::SortOrder order) const;

            //! Similar to ContainerType::push_back
            virtual void push_back(const ObjectType &object);

            //! Similar to ContainerType::push_back
            virtual void push_back(const ContainerType &container);

            //! Similar to ContainerType::insert here inserts at first position
            virtual void insert(const ObjectType &object);

            //! Similar to ContainerType::insert here inserts at first position
            virtual void insert(const ContainerType &container);

            //! Remove object
            virtual void remove(const ObjectType &object);

            //! \copydoc BlackMisc::CContainerBase::removeIf
            template <class K0, class V0, class... KeysValues>
            int removeIf(K0 k0, V0 v0, KeysValues... keysValues)
            {
                int c = m_container.removeIf(BlackMisc::Predicates::MemberEqual(k0, v0, keysValues...));
                if (c > 0) { this->emitModelDataChanged();}
                this->updateFilteredContainer();
                return c;
            }

            //! Clear the list
            virtual void clear();

            //! Empty?
            virtual bool isEmpty() const;

            //! Filter available
            bool hasFilter() const;

            //! Remove filter
            void removeFilter();

            //! Set the filter
            void takeFilterOwnership(std::unique_ptr<IModelFilter<ContainerType> > &filter);

            //! Set the selection model
            void setSelectionModel(BlackGui::Models::ISelectionModel<ContainerType> *selectionModel) { m_selectionModel = selectionModel; }

        protected:
            //! Constructor
            CListModelBase(const QString &translationContext, QObject *parent = nullptr);

            //! \name Base class overrides
            //! @{
            virtual void onDataChanged(const QModelIndex &topLeft, const QModelIndex &bottomLeft, const QVector<int> &roles) override;
            virtual void onChangedDigest() override;
            //! @}

            //! Update filtered container
            void updateFilteredContainer();

            //! Model changed
            void emitModelDataChanged();

            ContainerType m_container;         //!< used container
            ContainerType m_containerFiltered; //!< cache for filtered container data
            std::unique_ptr<IModelFilter<ContainerType> > m_filter;     //!< used filter
            ISelectionModel<ContainerType> *m_selectionModel = nullptr; //!< selection model
        };

        namespace Private
        {
            //! Sort with compare function
            template<class ObjectType>
            bool compareForModelSort(const ObjectType &a, const ObjectType &b, Qt::SortOrder order, const BlackMisc::CPropertyIndex &index, const BlackMisc::CPropertyIndexList &tieBreakers, std::true_type)
            {
                const int c = a.comparePropertyByIndex(index, b);
                if (c == 0)
                {
                    if (!tieBreakers.isEmpty())
                    {
                        const std::integral_constant<bool, true> marker;
                        return compareForModelSort<ObjectType>(a, b, order, tieBreakers.front(), tieBreakers.copyFrontRemoved(), marker);
                    }
                    return false;
                }
                return (order == Qt::AscendingOrder) ? (c < 0) : (c > 0);
            }

            //! Sort without compare function
            template <typename ObjectType>
            bool compareForModelSort(const ObjectType &a, const ObjectType &b, Qt::SortOrder order, const BlackMisc::CPropertyIndex &index, const BlackMisc::CPropertyIndexList &tieBreakers, std::false_type)
            {
                const BlackMisc::CVariant aQv = a.propertyByIndex(index);
                const BlackMisc::CVariant bQv = b.propertyByIndex(index);
                if (!tieBreakers.isEmpty() && aQv == bQv)
                {
                    const std::integral_constant<bool, false> marker;
                    return compareForModelSort<ObjectType>(a, b, order, tieBreakers.front(), tieBreakers.copyFrontRemoved(), marker);
                }
                return (order == Qt::AscendingOrder) ? (aQv < bQv) : (bQv < aQv);
            }
        } // namespace
    } // namespace
} // namespace
#endif // guard