SN: Fixes to OS/2 specific problems (use LEX_STEM and PATH_IFS set by configure).

[wxWidgets.git] / samples / thread / test.cpp

diff --git a/samples/thread/test.cpp b/samples/thread/test.cpp
index cc19d4d063690044a9526a68d0194c8a0eb30ebb..5788b0caa23b612fcda26417e3d26b74060f449d 100644 (file)
--- a/samples/thread/test.cpp
+++ b/samples/thread/test.cpp
@@ -10,11 +10,8 @@
 /////////////////////////////////////////////////////////////////////////////
 
 /*
 /////////////////////////////////////////////////////////////////////////////
 
 /*

-    TODO:
-
-    1. show how SetPriority() works.
-    2. use worker threads to update progress controls instead of writing
-       messages - it will be more visual
+    TODO: use worker threads to update progress controls instead of writing
+          messages - it will be more visual

  */
 
 #ifdef __GNUG__
  */
 
 #ifdef __GNUG__


@@ -41,21 +38,33 @@
 #include "wx/dynarray.h"
 #include "wx/time.h"
 
 #include "wx/dynarray.h"
 #include "wx/time.h"
 

+class MyThread;
+WX_DEFINE_ARRAY(wxThread *, wxArrayThread);
+

 // Define a new application type
 // Define a new application type

-class MyApp: public wxApp
+class MyApp : public wxApp

 {
 public:
 {
 public:

-    bool OnInit(void);
+    virtual bool OnInit();
+
+public:
+    // all the threads currently alive - as soon as the thread terminates, it's
+    // removed from the array
+    wxArrayThread m_threads;
+
+    // crit section protects access to all of the arrays below
+    wxCriticalSection m_critsect;

 };
 
 };
 

-WX_DEFINE_ARRAY(wxThread *, wxArrayThread);
+// Create a new application object
+IMPLEMENT_APP(MyApp)

 
 // Define a new frame type
 class MyFrame: public wxFrame
 {
 public:
     // ctor
 
 // Define a new frame type
 class MyFrame: public wxFrame
 {
 public:
     // ctor

-    MyFrame(wxFrame *frame, char *title, int x, int y, int w, int h);
+    MyFrame(wxFrame *frame, const wxString& title, int x, int y, int w, int h);

 
     // operations
     void WriteText(const wxString& text) { m_txtctrl->WriteText(text); }
 
     // operations
     void WriteText(const wxString& text) { m_txtctrl->WriteText(text); }


@@ -66,31 +75,49 @@ public:
     void OnClear(wxCommandEvent& event);
 
     void OnStartThread(wxCommandEvent& event);
     void OnClear(wxCommandEvent& event);
 
     void OnStartThread(wxCommandEvent& event);

+    void OnStartThreads(wxCommandEvent& event);

     void OnStopThread(wxCommandEvent& event);
     void OnPauseThread(wxCommandEvent& event);
     void OnResumeThread(wxCommandEvent& event);
     void OnStopThread(wxCommandEvent& event);
     void OnPauseThread(wxCommandEvent& event);
     void OnResumeThread(wxCommandEvent& event);

+    
+    void OnStartWorker(wxCommandEvent& event);
+    void OnWorkerEvent(wxCommandEvent& event);

 
     void OnIdle(wxIdleEvent &event);
 
     void OnIdle(wxIdleEvent &event);

-    bool OnClose() { return TRUE; }
-
-    // called by dying thread
-    void OnThreadExit(wxThread *thread);
-
-public:
-    wxArrayThread m_threads;

 
 private:
 
 private:

-    void DeleteThread(size_t index);
+    // helper function - creates a new thread (but doesn't run it)
+    MyThread *CreateThread();

 
 

-    // crit section protects access to the array below
-    wxCriticalSection m_critsect;
-    wxArrayInt        m_aToDelete;
+    // just some place to put our messages in
+    wxTextCtrl *m_txtctrl;

 
 

-    wxTextCtrl       *m_txtctrl;
+    // remember the number of running threads and total number of threads
+    size_t m_nRunning, m_nCount;

 
     DECLARE_EVENT_TABLE()
 };
 
 
     DECLARE_EVENT_TABLE()
 };
 

+// ID for the menu commands
+enum
+{
+    TEST_QUIT          = 1,
+    TEST_TEXT          = 101,
+    TEST_ABOUT,
+    TEST_CLEAR,
+    TEST_START_THREAD  = 201,
+    TEST_START_THREADS,
+    TEST_STOP_THREAD,
+    TEST_PAUSE_THREAD,
+    TEST_RESUME_THREAD,
+    TEST_START_WORKER,
+    WORKER_EVENT    // this one gets sent from the worker thread
+};
+
+//--------------------------------------------------
+// GUI thread
+//--------------------------------------------------
+

 class MyThread : public wxThread
 {
 public:
 class MyThread : public wxThread
 {
 public:


@@ -99,7 +126,8 @@ public:
     // thread execution starts here
     virtual void *Entry();
 
     // thread execution starts here
     virtual void *Entry();
 

-    // called when the thread exits - whether 
+    // called when the thread exits - whether it terminates normally or is
+    // stopped with Delete() (but not when it is Kill()ed!)

     virtual void OnExit();
 
     // write something to the text control
     virtual void OnExit();
 
     // write something to the text control


@@ -120,27 +148,31 @@ MyThread::MyThread(MyFrame *frame)
 void MyThread::WriteText(const wxString& text)
 {
     wxString msg;
 void MyThread::WriteText(const wxString& text)
 {
     wxString msg;

-    msg << wxTime().FormatTime() << ": " << text;

 
     // before doing any GUI calls we must ensure that this thread is the only
     // one doing it!
 
     // before doing any GUI calls we must ensure that this thread is the only
     // one doing it!

-    wxMutexGuiLocker guiLocker;

 
 

+    wxMutexGuiEnter();
+
+    msg << text;

     m_frame->WriteText(msg);
     m_frame->WriteText(msg);

+    
+    wxMutexGuiLeave();

 }
 
 void MyThread::OnExit()
 {
 }
 
 void MyThread::OnExit()
 {

-    m_frame->OnThreadExit(this);
+    wxCriticalSectionLocker locker(wxGetApp().m_critsect);
+
+    wxGetApp().m_threads.Remove(this);

 }
 
 void *MyThread::Entry()
 {
     wxString text;
 
 }
 
 void *MyThread::Entry()
 {
     wxString text;
 

-    DeferDestroy(TRUE);
-
-    text.Printf("Thread 0x%x started.\n", GetID());
+    text.Printf("Thread 0x%x started (priority = %d).\n",
+                GetId(), GetPriority());

     WriteText(text);
 
     for ( m_count = 0; m_count < 10; m_count++ )
     WriteText(text);
 
     for ( m_count = 0; m_count < 10; m_count++ )


@@ -149,50 +181,100 @@ void *MyThread::Entry()
         if ( TestDestroy() )
             break;
 
         if ( TestDestroy() )
             break;
 

-        text.Printf("[%u] Thread 0x%x here.\n", m_count, GetID());
+        text.Printf("[%u] Thread 0x%x here.\n", m_count, GetId());

         WriteText(text);
 
         WriteText(text);
 

-#ifdef __WXMSW__
-        ::Sleep(1000);
-#else
-        wxSleep(1);
-#endif
+        // wxSleep() can't be called from non-GUI thread!
+        wxThread::Sleep(1000);

     }
 
     }
 

-    text.Printf("Thread 0x%x finished.\n", GetID());
+    text.Printf("Thread 0x%x finished.\n", GetId());

     WriteText(text);
 
     return NULL;
 }
 
     WriteText(text);
 
     return NULL;
 }
 

-// ID for the menu commands
-enum
+//--------------------------------------------------
+// worker thread
+//--------------------------------------------------
+
+class MyWorkerThread : public wxThread

 {
 {

-    TEST_QUIT          = 1,
-    TEST_TEXT          = 101,
-    TEST_ABOUT         = 102,
-    TEST_CLEAR         = 103,
-    TEST_START_THREAD  = 203,
-    TEST_STOP_THREAD   = 204,
-    TEST_PAUSE_THREAD  = 205,
-    TEST_RESUME_THREAD = 206
+public:
+    MyWorkerThread(MyFrame *frame);
+
+    // thread execution starts here
+    virtual void *Entry();
+
+    // called when the thread exits - whether it terminates normally or is
+    // stopped with Delete() (but not when it is Kill()ed!)
+    virtual void OnExit();
+
+public:
+    MyFrame *m_frame;
+    size_t   m_count;

 };
 
 };
 

+MyWorkerThread::MyWorkerThread(MyFrame *frame)
+        : wxThread()
+{
+    m_frame = frame;
+    m_count = 0;
+}
+
+void MyWorkerThread::OnExit()
+{
+}
+
+void *MyWorkerThread::Entry()
+{
+    for ( m_count = 0; m_count < 10; m_count++ )
+    {
+        // check if we were asked to exit
+        if ( TestDestroy() )
+            break;
+        
+        wxString text;
+        text.Printf("[%u] Thread 0x%x here!!", m_count, GetId());
+
+        // create any type of command event here        
+        wxCommandEvent event( wxEVT_COMMAND_MENU_SELECTED, WORKER_EVENT );
+        event.SetInt( WORKER_EVENT );
+        event.SetString( text );
+        
+        // send in a thread-safe way
+        wxPostEvent( m_frame, event );
+        
+        // same as:
+        // m_frame->AddPendingEvent( event );
+
+        // wxSleep() can't be called from non-main thread!
+        wxThread::Sleep(1000);
+    }
+
+    return NULL;
+}
+
+//--------------------------------------------------
+// main program
+//--------------------------------------------------
+

 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
     EVT_MENU(TEST_QUIT, MyFrame::OnQuit)
     EVT_MENU(TEST_ABOUT, MyFrame::OnAbout)
     EVT_MENU(TEST_CLEAR, MyFrame::OnClear)
     EVT_MENU(TEST_START_THREAD, MyFrame::OnStartThread)
 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
     EVT_MENU(TEST_QUIT, MyFrame::OnQuit)
     EVT_MENU(TEST_ABOUT, MyFrame::OnAbout)
     EVT_MENU(TEST_CLEAR, MyFrame::OnClear)
     EVT_MENU(TEST_START_THREAD, MyFrame::OnStartThread)

+    EVT_MENU(TEST_START_THREADS, MyFrame::OnStartThreads)

     EVT_MENU(TEST_STOP_THREAD, MyFrame::OnStopThread)
     EVT_MENU(TEST_PAUSE_THREAD, MyFrame::OnPauseThread)
     EVT_MENU(TEST_RESUME_THREAD, MyFrame::OnResumeThread)
     EVT_MENU(TEST_STOP_THREAD, MyFrame::OnStopThread)
     EVT_MENU(TEST_PAUSE_THREAD, MyFrame::OnPauseThread)
     EVT_MENU(TEST_RESUME_THREAD, MyFrame::OnResumeThread)

+    
+    EVT_MENU(TEST_START_WORKER, MyFrame::OnStartWorker)
+    EVT_MENU(WORKER_EVENT, MyFrame::OnWorkerEvent)

 
     EVT_IDLE(MyFrame::OnIdle)
 END_EVENT_TABLE()
 
 
     EVT_IDLE(MyFrame::OnIdle)
 END_EVENT_TABLE()
 

-// Create a new application object
-IMPLEMENT_APP  (MyApp)
-

 // `Main program' equivalent, creating windows and returning main app frame
 bool MyApp::OnInit()
 {
 // `Main program' equivalent, creating windows and returning main app frame
 bool MyApp::OnInit()
 {


@@ -203,20 +285,24 @@ bool MyApp::OnInit()
     // Make a menubar
     wxMenu *file_menu = new wxMenu;
 
     // Make a menubar
     wxMenu *file_menu = new wxMenu;
 

-    file_menu->Append(TEST_CLEAR, "&Clear log");
+    file_menu->Append(TEST_CLEAR, "&Clear log\tCtrl-L");

     file_menu->AppendSeparator();
     file_menu->Append(TEST_ABOUT, "&About");
     file_menu->AppendSeparator();
     file_menu->AppendSeparator();
     file_menu->Append(TEST_ABOUT, "&About");
     file_menu->AppendSeparator();

-    file_menu->Append(TEST_QUIT, "E&xit");
+    file_menu->Append(TEST_QUIT, "E&xit\tAlt-X");

     wxMenuBar *menu_bar = new wxMenuBar;
     menu_bar->Append(file_menu, "&File");
 
     wxMenu *thread_menu = new wxMenu;
     wxMenuBar *menu_bar = new wxMenuBar;
     menu_bar->Append(file_menu, "&File");
 
     wxMenu *thread_menu = new wxMenu;

-    thread_menu->Append(TEST_START_THREAD, "&Start a new thread");
-    thread_menu->Append(TEST_STOP_THREAD, "S&top a running thread");
+    thread_menu->Append(TEST_START_THREAD, "&Start a new thread\tCtrl-N");
+    thread_menu->Append(TEST_START_THREADS, "Start &many threads at once");
+    thread_menu->Append(TEST_STOP_THREAD, "S&top a running thread\tCtrl-S");
+    thread_menu->AppendSeparator();
+    thread_menu->Append(TEST_PAUSE_THREAD, "&Pause a running thread\tCtrl-P");
+    thread_menu->Append(TEST_RESUME_THREAD, "&Resume suspended thread\tCtrl-R");

     thread_menu->AppendSeparator();
     thread_menu->AppendSeparator();

-    thread_menu->Append(TEST_PAUSE_THREAD, "&Pause a running thread");
-    thread_menu->Append(TEST_RESUME_THREAD, "&Resume suspended thread");
+    thread_menu->Append(TEST_START_WORKER, "Start &worker thread\tCtrl-W");
+    

     menu_bar->Append(thread_menu, "&Thread");
     frame->SetMenuBar(menu_bar);
 
     menu_bar->Append(thread_menu, "&Thread");
     frame->SetMenuBar(menu_bar);
 


@@ -229,107 +315,197 @@ bool MyApp::OnInit()
 }
 
 // My frame constructor
 }
 
 // My frame constructor

-MyFrame::MyFrame(wxFrame *frame, char *title, int x, int y, int w, int h)
+MyFrame::MyFrame(wxFrame *frame, const wxString& title,
+                 int x, int y, int w, int h)

        : wxFrame(frame, -1, title, wxPoint(x, y), wxSize(w, h))
 {
        : wxFrame(frame, -1, title, wxPoint(x, y), wxSize(w, h))
 {

-    CreateStatusBar();
+    m_nRunning = m_nCount = 0;
+
+    CreateStatusBar(2);

 
     m_txtctrl = new wxTextCtrl(this, -1, "", wxPoint(0, 0), wxSize(0, 0),
                                wxTE_MULTILINE | wxTE_READONLY);
 
 }
 
 
     m_txtctrl = new wxTextCtrl(this, -1, "", wxPoint(0, 0), wxSize(0, 0),
                                wxTE_MULTILINE | wxTE_READONLY);
 
 }
 

-void MyFrame::OnStartThread(wxCommandEvent& WXUNUSED(event) )
+MyThread *MyFrame::CreateThread()

 {
     MyThread *thread = new MyThread(this);
 
 {
     MyThread *thread = new MyThread(this);
 

-    thread->Create();
+    if ( thread->Create() != wxTHREAD_NO_ERROR )
+    {
+        wxLogError("Can't create thread!");
+    }
+
+    wxCriticalSectionLocker enter(wxGetApp().m_critsect);
+    wxGetApp().m_threads.Add(thread);

 
 

-    wxCriticalSectionLocker enter(m_critsect);
-    m_threads.Add(thread);
+    return thread;

 }
 
 }
 

-void MyFrame::OnStopThread(wxCommandEvent& WXUNUSED(event) )
+void MyFrame::OnStartThreads(wxCommandEvent& WXUNUSED(event) )

 {
 {

-    int no_thrd = m_threads.Count() - 1;
+    static long s_num = 10;

 
 

-    if ( no_thrd < 0 )
+    s_num = wxGetNumberFromUser("How many threads to start: ", "",
+                                "wxThread sample", s_num, 1, 10000, this);
+    if ( s_num == -1 )

     {
     {

-        wxLogError("No thread to stop!");
+        s_num = 10;

 
         return;
     }
 
 
         return;
     }
 

-    DeleteThread(no_thrd);
+    size_t count = (size_t)s_num, n;
+
+    wxArrayThread threads;
+
+    // first create them all...
+    for ( n = 0; n < count; n++ )
+    {
+        wxThread *thr = CreateThread();
+
+        // we want to show the effect of SetPriority(): the first thread will
+        // have the lowest priority, the second - the highest, all the rest
+        // the normal one
+        if ( n == 0 )
+            thr->SetPriority(WXTHREAD_MIN_PRIORITY);
+        else if ( n == 1 )
+            thr->SetPriority(WXTHREAD_MAX_PRIORITY);
+        else
+            thr->SetPriority(WXTHREAD_DEFAULT_PRIORITY);
+
+        threads.Add(thr);
+    }
+
+    wxString msg;
+    msg.Printf("%d new threads created.", count);
+    SetStatusText(msg, 1);
+
+    // ...and then start them
+    for ( n = 0; n < count; n++ )
+    {
+        threads[n]->Run();
+    }
+}
+
+void MyFrame::OnStartThread(wxCommandEvent& WXUNUSED(event) )
+{
+    MyThread *thread = CreateThread();
+
+    if ( thread->Run() != wxTHREAD_NO_ERROR )
+    {
+        wxLogError("Can't start thread!");
+    }
+
+    SetStatusText("New thread started.", 1);
+}
+
+void MyFrame::OnStopThread(wxCommandEvent& WXUNUSED(event) )
+{
+    // stop the last thread
+    if ( wxGetApp().m_threads.IsEmpty() )
+    {
+        wxLogError("No thread to stop!");
+    }
+    else
+    {
+        wxGetApp().m_critsect.Enter();
+
+        wxThread *thread = wxGetApp().m_threads.Last();
+
+        // it's important to leave critical section before calling Delete()
+        // because delete will (implicitly) call OnExit() which also tries
+        // to enter the same crit section - would dead lock.
+        wxGetApp().m_critsect.Leave();
+
+        thread->Delete();
+
+        SetStatusText("Thread stopped.", 1);
+    }

 }
 
 void MyFrame::OnResumeThread(wxCommandEvent& WXUNUSED(event) )
 {
 }
 
 void MyFrame::OnResumeThread(wxCommandEvent& WXUNUSED(event) )
 {

-    wxCriticalSectionLocker enter(m_critsect);
+    wxCriticalSectionLocker enter(wxGetApp().m_critsect);

 
     // resume first suspended thread
 
     // resume first suspended thread

-    size_t n = 0;
-    while ( n < m_threads.Count() && m_threads[n]->IsPaused() )
-        n--;
+    size_t n = 0, count = wxGetApp().m_threads.Count();
+    while ( n < count && !wxGetApp().m_threads[n]->IsPaused() )
+        n++;

 
 

-    if ( n < 0 )
+    if ( n == count )
+    {

         wxLogError("No thread to resume!");
         wxLogError("No thread to resume!");

+    }

     else
     else

-        m_threads[n]->Resume();
+    {
+        wxGetApp().m_threads[n]->Resume();
+
+        SetStatusText("Thread resumed.", 1);
+    }

 }
 
 void MyFrame::OnPauseThread(wxCommandEvent& WXUNUSED(event) )
 {
 }
 
 void MyFrame::OnPauseThread(wxCommandEvent& WXUNUSED(event) )
 {

-    wxCriticalSectionLocker enter(m_critsect);
+    wxCriticalSectionLocker enter(wxGetApp().m_critsect);

 
     // pause last running thread
 
     // pause last running thread

-    int n = m_threads.Count() - 1;
-    while ( n >= 0 && !m_threads[n]->IsRunning() )
+    int n = wxGetApp().m_threads.Count() - 1;
+    while ( n >= 0 && !wxGetApp().m_threads[n]->IsRunning() )

         n--;
 
     if ( n < 0 )
         n--;
 
     if ( n < 0 )

+    {

         wxLogError("No thread to pause!");
         wxLogError("No thread to pause!");

+    }

     else
     else

-        m_threads[n]->Pause();
+    {
+        wxGetApp().m_threads[n]->Pause();
+
+        SetStatusText("Thread paused.", 1);
+    }

 }
 
 // set the frame title indicating the current number of threads
 void MyFrame::OnIdle(wxIdleEvent &event)
 {
 }
 
 // set the frame title indicating the current number of threads
 void MyFrame::OnIdle(wxIdleEvent &event)
 {

-    // first remove from the array all the threads which died since last call
-    {
-        wxCriticalSectionLocker enter(m_critsect);
-
-        size_t nCount = m_aToDelete.Count();
-        for ( size_t n = 0; n < nCount; n++ )
-            DeleteThread((size_t)m_aToDelete[n]);
-
-        m_aToDelete.Empty();
-    }
-
+    // update the counts of running/total threads

     size_t nRunning = 0,
     size_t nRunning = 0,

-           nCount = m_threads.Count();
+           nCount = wxGetApp().m_threads.Count();

     for ( size_t n = 0; n < nCount; n++ )
     {
     for ( size_t n = 0; n < nCount; n++ )
     {

-        if ( m_threads[n]->IsRunning() )
+        if ( wxGetApp().m_threads[n]->IsRunning() )

             nRunning++;
     }
 
             nRunning++;
     }
 

-    wxLogStatus(this, "%u threads total, %u running.", nCount, nRunning);
+    if ( nCount != m_nCount || nRunning != m_nRunning )
+    {
+        m_nRunning = nRunning;
+        m_nCount = nCount;
+
+        wxLogStatus(this, "%u threads total, %u running.", nCount, nRunning);
+    }
+    //else: avoid flicker - don't print anything

 }
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event) )
 {
 }
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event) )
 {

-    for ( size_t i = 0; i < m_threads.Count(); i++ )
-        delete m_threads[i];
+    size_t count = wxGetApp().m_threads.Count();
+    for ( size_t i = 0; i < count; i++ )
+    {
+        wxGetApp().m_threads[0]->Delete();
+    }

 
     Close(TRUE);
 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event) )
 {
 
     Close(TRUE);
 }
 
 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event) )
 {

-    wxMessageDialog dialog(this, "wxThread sample (based on minimal)\n"
-                                 "Julian Smart, Guilhem Lavaux, Vadim Zeitlin",
+    wxMessageDialog dialog(this, "wxWindows multithreaded application sample\n"
+                                 "(c) 1998 Julian Smart, Guilhem Lavaux\n"
+                                 "(c) 1999 Vadim Zeitlin\n"
+                                 "(c) 2000 Robert Roebling",

                            "About wxThread sample",
                            wxOK | wxICON_INFORMATION);
 
                            "About wxThread sample",
                            wxOK | wxICON_INFORMATION);
 


@@ -341,18 +517,22 @@ void MyFrame::OnClear(wxCommandEvent& WXUNUSED(event))
     m_txtctrl->Clear();
 }
 
     m_txtctrl->Clear();
 }
 

-void MyFrame::OnThreadExit(wxThread *thread)
+void MyFrame::OnStartWorker(wxCommandEvent& WXUNUSED(event))

 {
 {

-    int index = m_threads.Index(thread);
-    wxCHECK_RET( index != -1, "unknown thread being deleted??" );
-
-    wxCriticalSectionLocker enter(m_critsect);
+    MyWorkerThread *thread = new MyWorkerThread(this);

 
 

-    m_aToDelete.Add(index);
+    if ( thread->Create() != wxTHREAD_NO_ERROR )
+    {
+        wxLogError("Can't create thread!");
+    }
+    
+    thread->Run();

 }
 
 }
 

-void MyFrame::DeleteThread(size_t index)
+void MyFrame::OnWorkerEvent(wxCommandEvent& event)

 {
 {

-    delete m_threads[index];
-    m_threads.Remove(index);
-}
\ No newline at end of file
+    WriteText( "Got message from worker thread: " );
+    WriteText( event.GetString() );
+    WriteText( "\n" );
+}
+