AQueue.h

/*
 * AUI Framework - Declarative UI toolkit for modern C++20
 * Copyright (C) 2020-2024 Alex2772 and Contributors
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
#include <queue>
#include <AUI/Core.h>
#include <AUI/Traits/containers.h>
 
 
template <class StoredType>
class AQueue : public std::queue<StoredType>
{
    using super = std::queue<StoredType>;
public:
    void removeAll(const StoredType& item) noexcept
    {
        aui::container::remove_all(*this, item);
    }
 
    void removeFirst(const StoredType& item) noexcept
    {
        aui::container::remove_first(*this, item);
    }
 
 
    AQueue<StoredType>& operator<<(const StoredType& rhs)
    {
        super::push(rhs);
        return *this;
    }
 
 
    AQueue<StoredType>& operator<<(StoredType&& rhs)
    {
        super::push(std::move(rhs));
        return *this;
    }
 
    bool contains(const StoredType& value) const noexcept {
        return aui::container::contains(*this, value);
    }
 
 
    template<typename OtherContainer>
    bool isSubsetOf(const OtherContainer& c) const noexcept
    {
        return aui::container::is_subset(*this, c);
    }
 
    template<typename Factory>
    [[nodiscard]]
    StoredType popOrGenerate(Factory factory) noexcept(noexcept(factory())) {
        if (super::empty()) {
            return factory();
        }
        auto v = std::move(super::front());
        super::pop();
        return v;
    }
};