orderablelist.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2016 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_ORDERABLELIST_H
#define SWIFT_MISC_ORDERABLELIST_H
 
#include <QList>
 
namespace swift::misc
{
    class IOrderable;
 
    template <class OBJ, class CONTAINER>
    class IOrderableList
    {
        static_assert(std::is_base_of_v<IOrderable, OBJ>, "OBJ needs to implement IOrderable");
 
    public:
        void sortAscendingByOrder() { this->container().sort(predicates::MemberLess(&OBJ::getOrder)); }
 
        void sortDescendingByOrder()
        {
            this->container().sortAscendingByOrder();
            std::reverse(this->container().begin(), this->container().end());
        }
 
        void resetOrder(int offset = 0)
        {
            int c = offset;
            for (OBJ &obj : container()) { obj.setOrder(c++); }
        }
 
        bool needsOrder() const
        {
            for (const OBJ &obj : container())
            {
                if (!obj.hasValidOrder()) { return true; }
            }
            return false;
        }
 
        QList<int> orderValues() const
        {
            QList<int> orders;
            for (const OBJ &obj : container())
            {
                if (!obj.hasValidOrder()) { continue; }
                orders.append(obj.getOrder());
            }
            return orders;
        }
 
        CONTAINER withoutItemsOfSameOrder(const CONTAINER &items) const
        {
            const QList<int> orders = items.orderValues();
            if (orders.isEmpty()) { return this->container(); }
 
            CONTAINER newContainer;
            for (const OBJ &obj : container())
            {
                if (orders.contains(obj.getOrder())) { continue; }
                newContainer.push_back(obj);
            }
            return newContainer;
        }
 
        void removeItemsWithSameOrder(const CONTAINER &items)
        {
            const QList<int> orders = items.orderValues();
            if (orders.isEmpty()) { return; }
 
            CONTAINER newContainer;
            for (const OBJ &obj : container())
            {
                if (orders.contains(obj.getOrder())) { continue; }
                newContainer.push_back(obj);
            }
            this->container() = newContainer;
        }
 
        void moveTo(const CONTAINER &items, int targetOrder)
        {
            if (items.isEmpty()) { return; }
            CONTAINER newContainer(this->withoutItemsOfSameOrder(items)); // this container without items
            CONTAINER newItems(items);
            const int shift = items.size();
            newContainer.sortAscendingByOrder(); // sorted by old order
            newContainer.resetOrder();
            for (OBJ &obj : newContainer)
            {
                if (obj.getOrder() < targetOrder) { continue; }
                obj.setOrder(obj.getOrder() + shift);
            }
            newItems.sortAscendingByOrder(); // sort by old order
            newItems.resetOrder(targetOrder);
            newContainer.push_back(newItems);
            this->container() = newContainer;
        }
 
        void freezeOrder()
        {
            int c = 0;
            for (OBJ &obj : container()) { obj.setOrder(c++); }
        }
 
        void freezeOrderReverse()
        {
            int c = this->container().size() - 1;
            for (OBJ &obj : container()) { obj.setOrder(c--); }
        }
 
        OBJ minOrderOrDefault() const
        {
            if (container().isEmpty()) { return OBJ(); }
            OBJ min = container().front();
            for (const OBJ &obj : container())
            {
                if (!obj.hasValidOrder()) { continue; }
                if (obj.getOrder() < min.getOrder()) { min = obj; }
            }
            return min;
        }
 
        OBJ maxOrderOrDefault() const
        {
            if (container().isEmpty()) { return OBJ(); }
            OBJ max = container().front();
            for (const OBJ &obj : container())
            {
                if (!obj.hasValidOrder()) { continue; }
                if (obj.getOrder() > max.getOrder()) { max = obj; }
            }
            return max;
        }
 
    protected:
        IOrderableList() = default;
 
        const CONTAINER &container() const { return static_cast<const CONTAINER &>(*this); }
 
        CONTAINER &container() { return static_cast<CONTAINER &>(*this); }
    };
} // namespace swift::misc
 
#endif // SWIFT_MISC_ORDERABLELIST_H