/*
  ==============================================================================

   This file is part of the JUCE framework.
   Copyright (c) Raw Material Software Limited

   JUCE is an open source framework subject to commercial or open source
   licensing.

   By downloading, installing, or using the JUCE framework, or combining the
   JUCE framework with any other source code, object code, content or any other
   copyrightable work, you agree to the terms of the JUCE End User Licence
   Agreement, and all incorporated terms including the JUCE Privacy Policy and
   the JUCE Website Terms of Service, as applicable, which will bind you. If you
   do not agree to the terms of these agreements, we will not license the JUCE
   framework to you, and you must discontinue the installation or download
   process and cease use of the JUCE framework.

   JUCE End User Licence Agreement: https://juce.com/legal/juce-9-licence/
   JUCE Privacy Policy: https://juce.com/juce-privacy-policy
   JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/

   Or:

   You may also use this code under the terms of the AGPLv3:
   https://www.gnu.org/licenses/agpl-3.0.en.html

   THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
   WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
   MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.

  ==============================================================================
*/

namespace juce
{

class ListenerListTests final : public UnitTest
{
public:
    //==============================================================================
    class TestListener
    {
    public:
        explicit TestListener (std::function<void()> cb) : callback (std::move (cb)) {}

        void doCallback()
        {
            ++numCalls;
            callback();
        }

        int getNumCalls() const { return numCalls; }

    private:
        int numCalls = 0;
        std::function<void()> callback;
    };

    class TestObject
    {
    public:
        void addListener (std::function<void()> cb)
        {
            listeners.push_back (std::make_unique<TestListener> (std::move (cb)));
            listenerList.add (listeners.back().get());
        }

        void removeListener (int i) { listenerList.remove (listeners[(size_t) i].get()); }

        void callListeners()
        {
            ++callLevel;
            listenerList.call ([] (auto& l) { l.doCallback(); });
            --callLevel;
        }

        int getNumListeners() const { return (int) listeners.size(); }

        auto& getListener (int i) { return *listeners[(size_t) i]; }

        int getCallLevel() const
        {
            return callLevel;
        }

        bool wereAllNonRemovedListenersCalled (int numCalls) const
        {
            return std::all_of (std::begin (listeners),
                                std::end (listeners),
                                [&] (auto& listener)
                                {
                                    return (! listenerList.contains (listener.get())) || listener->getNumCalls() == numCalls;
                                });
        }

    private:
        std::vector<std::unique_ptr<TestListener>> listeners;
        ListenerList<TestListener> listenerList;
        int callLevel = 0;
    };

    //==============================================================================
    ListenerListTests() : UnitTest ("ListenerList", UnitTestCategories::containers) {}

    void runTest() final
    {
        // This is a test that the pre-iterator adjustment implementation should pass too
        beginTest ("All non-removed listeners should be called - removing an already called listener");
        {
            TestObject test;

            for (int i = 0; i < 20; ++i)
            {
                test.addListener ([i, &test]
                                  {
                                      if (i == 5)
                                          test.removeListener (6);
                                  });
            }

            test.callListeners();
            expect (test.wereAllNonRemovedListenersCalled (1));
        }

        // Iterator adjustment is necessary for passing this
        beginTest ("All non-removed listeners should be called - removing a yet uncalled listener");
        {
            TestObject test;

            for (int i = 0; i < 20; ++i)
            {
                test.addListener ([i, &test]
                                  {
                                      if (i == 5)
                                          test.removeListener (4);
                                  });
            }

            test.callListeners();
            expect (test.wereAllNonRemovedListenersCalled (1));
        }

        // This test case demonstrates why we have to call --it.index instead of it.next()
        beginTest ("All non-removed listeners should be called - one callback removes multiple listeners");
        {
            TestObject test;

            for (int i = 0; i < 20; ++i)
            {
                test.addListener ([i, &test]
                                  {
                                      if (i == 19)
                                      {
                                          test.removeListener (19);
                                          test.removeListener (0);
                                      }
                                  });
            }

            test.callListeners();
            expect (test.wereAllNonRemovedListenersCalled (1));
        }

        beginTest ("All non-removed listeners should be called - removing listeners randomly");
        {
            auto random = getRandom();

            for (auto run = 0; run < 10; ++run)
            {
                const auto numListeners = random.nextInt ({ 10, 100 });
                const auto listenersThatRemoveListeners = chooseUnique (random,
                                                                        numListeners,
                                                                        random.nextInt ({ 0, numListeners / 2 }));

                // The listener in position [key] should remove listeners in [value]
                std::map<int, std::set<int>> removals;

                for (auto i : listenersThatRemoveListeners)
                {
                    // Random::nextInt ({1, 1}); triggers an assertion
                    removals[i] = chooseUnique (random,
                                                numListeners,
                                                random.nextInt ({ 1, std::max (2, numListeners / 10) }));
                }

                TestObject test;

                for (int i = 0; i < numListeners; ++i)
                {
                    test.addListener ([i, &removals, &test]
                                      {
                                          const auto iter = removals.find (i);

                                          if (iter == removals.end())
                                              return;

                                          for (auto j : iter->second)
                                          {
                                              test.removeListener (j);
                                          }
                                      });
                }

                test.callListeners();
                expect (test.wereAllNonRemovedListenersCalled (1));
            }
        }

        // Iterator adjustment is not necessary for passing this
        beginTest ("All non-removed listeners should be called - add listener during iteration");
        {
            TestObject test;
            const auto numStartingListeners = 20;

            for (int i = 0; i < numStartingListeners; ++i)
            {
                test.addListener ([i, &test]
                                  {
                                      if (i == 5 || i == 6)
                                          test.addListener ([] {});
                                  });
            }

            test.callListeners();

            // Only the Listeners added before the test can be expected to have been called
            bool success = true;

            for (int i = 0; i < numStartingListeners; ++i)
                success = success && test.getListener (i).getNumCalls() == 1;

            // Listeners added during the iteration must not be called in that iteration
            for (int i = numStartingListeners; i < test.getNumListeners(); ++i)
                success = success && test.getListener (i).getNumCalls() == 0;

            expect (success);
        }

        beginTest ("All non-removed listeners should be called - nested ListenerList::call()");
        {
            TestObject test;

            for (int i = 0; i < 20; ++i)
            {
                test.addListener ([i, &test]
                                  {
                                      const auto callLevel = test.getCallLevel();

                                      if (i == 6 && callLevel == 1)
                                      {
                                          test.callListeners();
                                      }

                                      if (i == 5)
                                      {
                                          if (callLevel == 1)
                                              test.removeListener (4);
                                          else if (callLevel == 2)
                                              test.removeListener (6);
                                      }
                                  });
            }

            test.callListeners();
            expect (test.wereAllNonRemovedListenersCalled (2));
        }

        beginTest ("All non-removed listeners should be called - random ListenerList::call()");
        {
            const auto numListeners = 20;
            auto random = getRandom();

            for (int run = 0; run < 10; ++run)
            {
                TestObject test;
                auto numCalls = 0;

                auto listenersToRemove = chooseUnique (random, numListeners, numListeners / 2);

                for (int i = 0; i < numListeners; ++i)
                {
                    // Capturing numListeners is a warning on MacOS, not capturing it is an error on Windows
                    test.addListener ([&]
                                      {
                                          const auto callLevel = test.getCallLevel();

                                          if (callLevel < 4 && random.nextFloat() < 0.05f)
                                          {
                                              ++numCalls;
                                              test.callListeners();
                                          }

                                          if (random.nextFloat() < 0.5f)
                                          {
                                              const auto listenerToRemove = random.nextInt ({ 0, numListeners });

                                              if (listenersToRemove.erase (listenerToRemove) > 0)
                                                  test.removeListener (listenerToRemove);
                                          }
                                      });
                }

                while (listenersToRemove.size() > 0)
                {
                    test.callListeners();
                    ++numCalls;
                }

                expect (test.wereAllNonRemovedListenersCalled (numCalls));
            }
        }

        beginTest ("Deleting the listener list from a callback");
        {
            struct Listener
            {
                std::function<void()> onCallback;
                void notify() { onCallback(); }
            };

            auto listeners = std::make_unique<juce::ListenerList<Listener>>();

            const auto callback = [&]
            {
                expect (listeners != nullptr);
                listeners.reset();
            };

            Listener listener1 { callback };
            Listener listener2 { callback };

            listeners->add (&listener1);
            listeners->add (&listener2);

            listeners->call (&Listener::notify);

            expect (listeners == nullptr);
        }

        beginTest ("Using a BailOutChecker");
        {
            struct Listener
            {
                std::function<void()> onCallback;
                void notify() { onCallback(); }
            };

            ListenerList<Listener> listeners;

            bool listener1Called = false;
            bool listener2Called = false;
            bool listener3Called = false;

            Listener listener1 { [&]{ listener1Called = true; } };
            Listener listener2 { [&]{ listener2Called = true; } };
            Listener listener3 { [&]{ listener3Called = true; } };

            listeners.add (&listener1);
            listeners.add (&listener2);
            listeners.add (&listener3);

            struct BailOutChecker
            {
                bool& bailOutBool;
                bool shouldBailOut() const { return bailOutBool; }
            };

            BailOutChecker bailOutChecker { listener2Called };
            listeners.callChecked (bailOutChecker, &Listener::notify);

            expect (  listener1Called);
            expect (  listener2Called);
            expect (! listener3Called);
        }

        beginTest ("Using a critical section");
        {
            struct Listener
            {
                std::function<void()> onCallback;
                void notify() { onCallback(); }
            };

            struct TestCriticalSection
            {
                TestCriticalSection()  noexcept { isAlive() = true; }
                ~TestCriticalSection() noexcept { isAlive() = false; }

                static void enter() noexcept { numOutOfScopeCalls() += isAlive() ? 0 : 1; }
                static void exit()  noexcept { numOutOfScopeCalls() += isAlive() ? 0 : 1; }

                static bool tryEnter() noexcept
                {
                    numOutOfScopeCalls() += isAlive() ? 0 : 1;
                    return true;
                }

                using ScopedLockType = GenericScopedLock<TestCriticalSection>;

                static bool& isAlive() noexcept
                {
                    static bool inScope = false;
                    return inScope;
                }

                static int& numOutOfScopeCalls() noexcept
                {
                    static int numOutOfScopeCalls = 0;
                    return numOutOfScopeCalls;
                }
            };

            auto listeners = std::make_unique<juce::ListenerList<Listener, Array<Listener*, TestCriticalSection>>>();

            const auto callback = [&]{ listeners.reset(); };

            Listener listener { callback };

            listeners->add (&listener);
            listeners->call (&Listener::notify);

            expect (listeners == nullptr);
            expect (TestCriticalSection::numOutOfScopeCalls() == 0);
        }

        beginTest ("Adding a listener during a callback when one has already been removed");
        {
            struct Listener{};

            ListenerList<Listener> listeners;
            expect (listeners.size() == 0);

            Listener listener1;
            Listener listener2;
            listeners.add (&listener1);
            listeners.add (&listener2);
            expect (listeners.size() == 2);

            int numberOfCallbacks = 0;

            listeners.call ([&] (auto& l)
            {
                listeners.remove (&l);
                expect (listeners.size() == 1);

                listeners.add (&l);
                expect (listeners.size() == 2);

                ++numberOfCallbacks;
            });

            expect (numberOfCallbacks == 2);
            expect (listeners.size() == 2);
        }

        beginTest ("Add and remove a nested listener");
        {
            struct Listener{};

            ListenerList<Listener> listeners;
            expect (listeners.size() == 0);

            Listener listener1;
            Listener listener2;
            listeners.add (&listener1);
            listeners.add (&listener2);
            expect (listeners.size() == 2);

            int numberOfCallbacks = 0;

            listeners.call ([&] (auto)
            {
                Listener nestedListener;

                listeners.add (&nestedListener);
                expect (listeners.size() == 3);

                listeners.remove (&nestedListener);
                expect (listeners.size() == 2);

                ++numberOfCallbacks;
            });

            expect (numberOfCallbacks == 2);
            expect (listeners.size() == 2);
        }

        beginTest ("ThreadSafeListenerList stress test");
        {
            struct Listener { void callback(){} };

            ThreadPool threadPool { 10 };
            ThreadSafeListenerList<Listener> listeners;

            for (int i = 0; i < 1'000; ++i)
            {
                threadPool.addJob ([&]
                {
                    std::vector<std::unique_ptr<Listener>> listenersToAdd;

                    for (int j = 0; j < 1'000; ++j)
                    {
                        listenersToAdd.push_back (std::make_unique<Listener>());
                        listeners.add (listenersToAdd.back().get());
                    }

                    for (auto& listener : listenersToAdd)
                        listeners.remove (listener.get());
                });

                threadPool.addJob ([&]
                {
                    listeners.call (&Listener::callback);
                });
            }

            expect (threadPool.removeAllJobs (false, 30'000));
        }
    }

private:
    static std::set<int> chooseUnique (Random& random, int max, int numChosen)
    {
        std::set<int> result;

        while ((int) result.size() < numChosen)
            result.insert (random.nextInt ({ 0, max }));

        return result;
    }
};

class LightweightListenerListTests final : public UnitTest
{
public:
    LightweightListenerListTests() : UnitTest ("LightweightListenerList", UnitTestCategories::containers) {}

    void runTest() final
    {
        class Listener
        {
        public:
            void triggerCallback() { ++numCallbacksTriggered; }
            int getNumCallbacksTriggered() const { return numCallbacksTriggered; }

        private:
            int numCallbacksTriggered = 0;
        };

        beginTest ("Default list is empty");
        {
            LightweightListenerList<Listener> listeners;
            expect (listeners.isEmpty());
            expect (listeners.size() == 0);
        }

        beginTest ("Adding a listener");
        {
            LightweightListenerList<Listener> listeners;
            Listener listener;

            expect (listener.getNumCallbacksTriggered() == 0);
            expect (! listeners.contains (&listener));

            listeners.add (&listener);
            expect (! listeners.isEmpty());
            expect (listeners.size() == 1);
            expect (listeners.contains (&listener));
            expect (listener.getNumCallbacksTriggered() == 0);

            listeners.call (&Listener::triggerCallback);
            expect (listener.getNumCallbacksTriggered() == 1);
            expect (! listeners.isEmpty());
            expect (listeners.size() == 1);

            listeners.call (&Listener::triggerCallback);

            expect (listener.getNumCallbacksTriggered() == 2);
        }

        beginTest ("Adding the same listener twice");
        {
            LightweightListenerList<Listener> listeners;
            Listener listener;

            listeners.add (&listener);
            listeners.add (&listener);

            expect (! listeners.isEmpty());
            expect (listeners.size() == 1);
            expect (listeners.contains (&listener));
            expect (listener.getNumCallbacksTriggered() == 0);

            listeners.call (&Listener::triggerCallback);
            expect (listener.getNumCallbacksTriggered() == 1);
        }

        beginTest ("Adding multiple listeners");
        {
            LightweightListenerList<Listener> listeners;
            Listener listener1;
            Listener listener2;
            Listener listener3;

            expect (! listeners.contains (&listener1));
            expect (! listeners.contains (&listener2));
            expect (! listeners.contains (&listener3));

            listeners.add (&listener1);
            expect (  listeners.contains (&listener1));
            expect (! listeners.contains (&listener2));
            expect (! listeners.contains (&listener3));

            listeners.call (&Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 1);
            expect (listener2.getNumCallbacksTriggered() == 0);
            expect (listener3.getNumCallbacksTriggered() == 0);

            listeners.add (&listener2);
            expect (! listeners.isEmpty());
            expect (listeners.size() == 2);
            expect (  listeners.contains (&listener1));
            expect (  listeners.contains (&listener2));
            expect (! listeners.contains (&listener3));

            listeners.call (&Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 2);
            expect (listener2.getNumCallbacksTriggered() == 1);
            expect (listener3.getNumCallbacksTriggered() == 0);

            listeners.add (&listener3);
            expect (! listeners.isEmpty());
            expect (listeners.size() == 3);
            expect (listeners.contains (&listener1));
            expect (listeners.contains (&listener2));
            expect (listeners.contains (&listener3));

            listeners.call (&Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 3);
            expect (listener2.getNumCallbacksTriggered() == 2);
            expect (listener3.getNumCallbacksTriggered() == 1);
        }

        beginTest ("Removing a listener");
        {
            LightweightListenerList<Listener> listeners;
            Listener listener1;
            Listener listener2;
            Listener listener3;

            listeners.add (&listener1);
            listeners.add (&listener2);
            listeners.add (&listener3);

            listeners.remove (&listener2);
            expect (listeners.size() == 2);
            expect (! listeners.contains (&listener2));

            listeners.call (&Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 1);
            expect (listener2.getNumCallbacksTriggered() == 0);
            expect (listener3.getNumCallbacksTriggered() == 1);

            listeners.remove (&listener1);
            expect (listeners.size() == 1);
            expect (! listeners.contains (&listener1));

            listeners.call (&Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 1);
            expect (listener2.getNumCallbacksTriggered() == 0);
            expect (listener3.getNumCallbacksTriggered() == 2);

            listeners.remove (&listener3);
            expect (listeners.size() == 0);
            expect (! listeners.contains (&listener3));

            listeners.call (&Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 1);
            expect (listener2.getNumCallbacksTriggered() == 0);
            expect (listener3.getNumCallbacksTriggered() == 2);
        }

        beginTest ("Adding a scoped listener");
        {
            LightweightListenerList<Listener> listeners;
            Listener listener;

            {
                const auto scopeGuard = listeners.addScoped (listener);
                expect (! listeners.isEmpty());
                expect (listeners.size() == 1);
                expect (listeners.contains (&listener));
            }

            expect (listeners.isEmpty());
            expect (listeners.size() == 0);
            expect (! listeners.contains (&listener));
        }

        beginTest ("Clear the listeners");
        {
            LightweightListenerList<Listener> listeners;
            Listener listener1;
            Listener listener2;
            Listener listener3;

            listeners.add (&listener1);
            listeners.add (&listener2);
            listeners.add (&listener3);

            listeners.clear();
            expect (listeners.isEmpty());
            expect (listeners.size() == 0);

            listeners.call (&Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 0);
            expect (listener2.getNumCallbacksTriggered() == 0);
            expect (listener3.getNumCallbacksTriggered() == 0);
        }

        beginTest ("Call excluding");
        {
            LightweightListenerList<Listener> listeners;
            Listener listener1;
            Listener listener2;
            Listener listener3;

            listeners.add (&listener1);
            listeners.add (&listener2);
            listeners.add (&listener3);

            listeners.callExcluding (&listener1, &Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 0);
            expect (listener2.getNumCallbacksTriggered() == 1);
            expect (listener3.getNumCallbacksTriggered() == 1);

            listeners.callExcluding (&listener2, &Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 1);
            expect (listener2.getNumCallbacksTriggered() == 1);
            expect (listener3.getNumCallbacksTriggered() == 2);

            listeners.callExcluding (&listener3, &Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 2);
            expect (listener2.getNumCallbacksTriggered() == 2);
            expect (listener3.getNumCallbacksTriggered() == 2);

        }

        beginTest ("Call with bail-out checker");
        {
            LightweightListenerList<Listener> listeners;
            Listener listener1;
            Listener listener2;
            Listener listener3;

            listeners.add (&listener1);
            listeners.add (&listener2);
            listeners.add (&listener3);

            struct BailOutChecker
            {
                bool shouldBailOut() const { return f(); }
                std::function<bool()> f;
            };

            const BailOutChecker bailOutChecker { [&] { return listener2.getNumCallbacksTriggered() == 2; } };

            // all the listeners should be called
            listeners.callChecked (bailOutChecker, &Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 1);
            expect (listener2.getNumCallbacksTriggered() == 1);
            expect (listener3.getNumCallbacksTriggered() == 1);

            // only listeners 1 and 2 should be called
            listeners.callChecked (bailOutChecker, &Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 2);
            expect (listener2.getNumCallbacksTriggered() == 2);
            expect (listener3.getNumCallbacksTriggered() == 1);

            // none of the listeners should be called
            listeners.callChecked (bailOutChecker, &Listener::triggerCallback);
            expect (listener1.getNumCallbacksTriggered() == 2);
            expect (listener2.getNumCallbacksTriggered() == 2);
            expect (listener3.getNumCallbacksTriggered() == 1);
        }
    }
};

static ListenerListTests listenerListTests;
static LightweightListenerListTests lightweightListenerListTests;

} // namespace juce
