Add wxEventLoop::ScheduleExit().

This method allows to request exiting from the given event loop even if it's
not the currently active one, unlike Exit() which would assert in this case.
With it, it becomes possible to ask the loop to terminate as soon as possible
even if a nested loop is currently running.

See #10258.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74335 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

tests/events/evtlooptest.cpp

@@ -0,0 +1,128 @@
+///////////////////////////////////////////////////////////////////////////////
+// Name:        tests/events/evtloop.cpp
+// Purpose:     Tests for the event loop classes
+// Author:      Rob Bresalier
+// Created:     2013-05-02
+// RCS-ID:      $Id$
+// Copyright:   (c) 2013 Rob Bresalier
+///////////////////////////////////////////////////////////////////////////////
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#include "testprec.h"
+
+#ifdef __BORLANDC__
+    #pragma hdrstop
+#endif
+
+#include "wx/timer.h"
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// Use two arbitrary but different return codes for the two loops.
+const int EXIT_CODE_OUTER_LOOP = 99;
+const int EXIT_CODE_INNER_LOOP = 55;
+
+// ----------------------------------------------------------------------------
+// test class
+// ----------------------------------------------------------------------------
+
+class EvtloopTestCase : public CppUnit::TestCase
+{
+public:
+    EvtloopTestCase() { }
+
+private:
+    CPPUNIT_TEST_SUITE( EvtloopTestCase );
+        CPPUNIT_TEST( TestExit );
+    CPPUNIT_TEST_SUITE_END();
+
+    void TestExit();
+
+    DECLARE_NO_COPY_CLASS(EvtloopTestCase)
+};
+
+// register in the unnamed registry so that these tests are run by default
+CPPUNIT_TEST_SUITE_REGISTRATION( EvtloopTestCase );
+
+// also include in its own registry so that these tests can be run alone
+CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( EvtloopTestCase, "EvtloopTestCase" );
+
+
+// Helper class to schedule exit of the given event loop after the specified
+// delay.
+class ScheduleLoopExitTimer : public wxTimer
+{
+public:
+    ScheduleLoopExitTimer(wxEventLoop& loop, int rc)
+        : m_loop(loop),
+          m_rc(rc)
+    {
+    }
+
+    virtual void Notify()
+    {
+        m_loop.ScheduleExit(m_rc);
+    }
+
+private:
+    wxEventLoop& m_loop;
+    const int m_rc;
+};
+
+// Another helper which runs a nested loop and schedules exiting both the outer
+// and the inner loop after the specified delays.
+class RunNestedAndExitBothLoopsTimer : public wxTimer
+{
+public:
+    RunNestedAndExitBothLoopsTimer(wxTimer& timerOuter,
+                                   int loopOuterDuration,
+                                   int loopInnerDuration)
+        : m_timerOuter(timerOuter),
+          m_loopOuterDuration(loopOuterDuration),
+          m_loopInnerDuration(loopInnerDuration)
+    {
+    }
+
+    virtual void Notify()
+    {
+        wxEventLoop loopInner;
+        ScheduleLoopExitTimer timerInner(loopInner, EXIT_CODE_INNER_LOOP);
+
+        m_timerOuter.StartOnce(m_loopOuterDuration);
+        timerInner.StartOnce(m_loopInnerDuration);
+
+        CPPUNIT_ASSERT_EQUAL( EXIT_CODE_INNER_LOOP, loopInner.Run() );
+    }
+
+private:
+    wxTimer& m_timerOuter;
+    const int m_loopOuterDuration;
+    const int m_loopInnerDuration;
+};
+
+void EvtloopTestCase::TestExit()
+{
+    // Test that simply exiting the loop works.
+    wxEventLoop loopOuter;
+    ScheduleLoopExitTimer timerExit(loopOuter, EXIT_CODE_OUTER_LOOP);
+    timerExit.StartOnce(1);
+    CPPUNIT_ASSERT_EQUAL( EXIT_CODE_OUTER_LOOP, loopOuter.Run() );
+
+    // Test that exiting the outer loop before the inner loop (outer duration
+    // parameter less than inner duration in the timer ctor below) works.
+    ScheduleLoopExitTimer timerExitOuter(loopOuter, EXIT_CODE_OUTER_LOOP);
+    RunNestedAndExitBothLoopsTimer timerRun(timerExitOuter, 5, 10);
+    timerRun.StartOnce(1);
+    CPPUNIT_ASSERT_EQUAL( EXIT_CODE_OUTER_LOOP, loopOuter.Run() );
+
+    // Test that exiting the inner loop before the outer one works too.
+    ScheduleLoopExitTimer timerExitOuter2(loopOuter, EXIT_CODE_OUTER_LOOP);
+    RunNestedAndExitBothLoopsTimer timerRun2(timerExitOuter, 10, 5);
+    timerRun2.StartOnce(1);
+    CPPUNIT_ASSERT_EQUAL( EXIT_CODE_OUTER_LOOP, loopOuter.Run() );
+}