1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxWidgets thread sample
4 // Author: Guilhem Lavaux, Vadim Zeitlin
8 // Copyright: (c) 1998-2002 wxWidgets team
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx/wx.h".
13 #include "wx/wxprec.h"
24 #error "This sample requires thread support!"
25 #endif // wxUSE_THREADS
27 #include "wx/thread.h"
28 #include "wx/dynarray.h"
29 #include "wx/numdlg.h"
31 #include "wx/progdlg.h"
33 #include "../sample.xpm"
35 // define this to use wxExecute in the exec tests, otherwise just use system
39 #define EXEC(cmd) wxExecute((cmd), wxEXEC_SYNC)
41 #define EXEC(cmd) system(cmd)
45 WX_DEFINE_ARRAY_PTR(wxThread
*, wxArrayThread
);
47 // Define a new application type
48 class MyApp
: public wxApp
54 virtual bool OnInit();
57 // all the threads currently alive - as soon as the thread terminates, it's
58 // removed from the array
59 wxArrayThread m_threads
;
61 // crit section protects access to all of the arrays below
62 wxCriticalSection m_critsect
;
64 // semaphore used to wait for the threads to exit, see MyFrame::OnQuit()
65 wxSemaphore m_semAllDone
;
67 // the last exiting thread should post to m_semAllDone if this is true
68 // (protected by the same m_critsect)
69 bool m_waitingUntilAllDone
;
72 // Create a new application object
75 // Define a new frame type
76 class MyFrame
: public wxFrame
80 MyFrame(wxFrame
*frame
, const wxString
& title
, int x
, int y
, int w
, int h
);
84 void WriteText(const wxString
& text
) { m_txtctrl
->WriteText(text
); }
86 // accessors for MyWorkerThread (called in its context!)
91 void OnQuit(wxCommandEvent
& event
);
92 void OnClear(wxCommandEvent
& event
);
94 void OnStartThread(wxCommandEvent
& event
);
95 void OnStartThreads(wxCommandEvent
& event
);
96 void OnStopThread(wxCommandEvent
& event
);
97 void OnPauseThread(wxCommandEvent
& event
);
98 void OnResumeThread(wxCommandEvent
& event
);
100 void OnStartWorker(wxCommandEvent
& event
);
101 void OnWorkerEvent(wxCommandEvent
& event
);
102 void OnUpdateWorker(wxUpdateUIEvent
& event
);
104 void OnExecMain(wxCommandEvent
& event
);
105 void OnExecThread(wxCommandEvent
& event
);
107 void OnShowCPUs(wxCommandEvent
& event
);
108 void OnAbout(wxCommandEvent
& event
);
110 void OnIdle(wxIdleEvent
&event
);
113 // helper function - creates a new thread (but doesn't run it)
114 MyThread
*CreateThread();
116 // just some place to put our messages in
117 wxTextCtrl
*m_txtctrl
;
119 // remember the number of running threads and total number of threads
120 size_t m_nRunning
, m_nCount
;
122 // the progress dialog which we show while worker thread is running
123 wxProgressDialog
*m_dlgProgress
;
125 // was the worker thread cancelled by user?
128 // protects m_cancelled
129 wxCriticalSection m_critsectWork
;
131 DECLARE_EVENT_TABLE()
134 // ID for the menu commands
137 THREAD_QUIT
= wxID_EXIT
,
138 THREAD_ABOUT
= wxID_ABOUT
,
141 THREAD_START_THREAD
= 201,
142 THREAD_START_THREADS
,
145 THREAD_RESUME_THREAD
,
153 WORKER_EVENT
// this one gets sent from the worker thread
156 // ----------------------------------------------------------------------------
158 // ----------------------------------------------------------------------------
160 class MyThread
: public wxThread
163 MyThread(MyFrame
*frame
);
165 // thread execution starts here
166 virtual void *Entry();
168 // called when the thread exits - whether it terminates normally or is
169 // stopped with Delete() (but not when it is Kill()ed!)
170 virtual void OnExit();
172 // write something to the text control
173 void WriteText(const wxString
& text
);
180 MyThread::MyThread(MyFrame
*frame
)
187 void MyThread::WriteText(const wxString
& text
)
191 // before doing any GUI calls we must ensure that this thread is the only
197 m_frame
->WriteText(msg
);
202 void MyThread::OnExit()
204 wxCriticalSectionLocker
locker(wxGetApp().m_critsect
);
206 wxArrayThread
& threads
= wxGetApp().m_threads
;
207 threads
.Remove(this);
209 if ( threads
.IsEmpty() )
211 // signal the main thread that there are no more threads left if it is
213 if ( wxGetApp().m_waitingUntilAllDone
)
215 wxGetApp().m_waitingUntilAllDone
= false;
217 wxGetApp().m_semAllDone
.Post();
222 void *MyThread::Entry()
226 text
.Printf(wxT("Thread 0x%lx started (priority = %u).\n"),
227 GetId(), GetPriority());
229 // wxLogMessage(text); -- test wxLog thread safeness
231 for ( m_count
= 0; m_count
< 10; m_count
++ )
233 // check if we were asked to exit
237 text
.Printf(wxT("[%u] Thread 0x%lx here.\n"), m_count
, GetId());
240 // wxSleep() can't be called from non-GUI thread!
241 wxThread::Sleep(1000);
244 text
.Printf(wxT("Thread 0x%lx finished.\n"), GetId());
246 // wxLogMessage(text); -- test wxLog thread safeness
251 // ----------------------------------------------------------------------------
253 // ----------------------------------------------------------------------------
255 class MyWorkerThread
: public wxThread
258 MyWorkerThread(MyFrame
*frame
);
260 // thread execution starts here
261 virtual void *Entry();
263 // called when the thread exits - whether it terminates normally or is
264 // stopped with Delete() (but not when it is Kill()ed!)
265 virtual void OnExit();
272 MyWorkerThread::MyWorkerThread(MyFrame
*frame
)
279 void MyWorkerThread::OnExit()
283 void *MyWorkerThread::Entry()
285 for ( m_count
= 0; !m_frame
->Cancelled() && (m_count
< 100); m_count
++ )
287 // check if we were asked to exit
291 // create any type of command event here
292 wxCommandEvent
event( wxEVT_COMMAND_MENU_SELECTED
, WORKER_EVENT
);
293 event
.SetInt( m_count
);
295 // send in a thread-safe way
296 wxPostEvent( m_frame
, event
);
298 // wxSleep() can't be called from non-main thread!
299 wxThread::Sleep(200);
302 wxCommandEvent
event( wxEVT_COMMAND_MENU_SELECTED
, WORKER_EVENT
);
303 event
.SetInt(-1); // that's all
304 wxPostEvent( m_frame
, event
);
309 // ----------------------------------------------------------------------------
310 // a thread which simply calls wxExecute
311 // ----------------------------------------------------------------------------
313 class MyExecThread
: public wxThread
316 MyExecThread(const wxChar
*command
) : wxThread(wxTHREAD_JOINABLE
),
322 virtual ExitCode
Entry()
324 return (ExitCode
)EXEC(m_command
);
331 // ----------------------------------------------------------------------------
333 // ----------------------------------------------------------------------------
335 BEGIN_EVENT_TABLE(MyFrame
, wxFrame
)
336 EVT_MENU(THREAD_QUIT
, MyFrame::OnQuit
)
337 EVT_MENU(THREAD_CLEAR
, MyFrame::OnClear
)
338 EVT_MENU(THREAD_START_THREAD
, MyFrame::OnStartThread
)
339 EVT_MENU(THREAD_START_THREADS
, MyFrame::OnStartThreads
)
340 EVT_MENU(THREAD_STOP_THREAD
, MyFrame::OnStopThread
)
341 EVT_MENU(THREAD_PAUSE_THREAD
, MyFrame::OnPauseThread
)
342 EVT_MENU(THREAD_RESUME_THREAD
, MyFrame::OnResumeThread
)
344 EVT_MENU(THREAD_EXEC_MAIN
, MyFrame::OnExecMain
)
345 EVT_MENU(THREAD_EXEC_THREAD
, MyFrame::OnExecThread
)
347 EVT_MENU(THREAD_SHOWCPUS
, MyFrame::OnShowCPUs
)
348 EVT_MENU(THREAD_ABOUT
, MyFrame::OnAbout
)
350 EVT_UPDATE_UI(THREAD_START_WORKER
, MyFrame::OnUpdateWorker
)
351 EVT_MENU(THREAD_START_WORKER
, MyFrame::OnStartWorker
)
352 EVT_MENU(WORKER_EVENT
, MyFrame::OnWorkerEvent
)
354 EVT_IDLE(MyFrame::OnIdle
)
360 m_waitingUntilAllDone
= false;
363 // `Main program' equivalent, creating windows and returning main app frame
366 // uncomment this to get some debugging messages from the trace code
367 // on the console (or just set WXTRACE env variable to include "thread")
368 //wxLog::AddTraceMask("thread");
370 // Create the main frame window
371 MyFrame
*frame
= new MyFrame((wxFrame
*)NULL
, _T("wxWidgets threads sample"),
375 wxMenuBar
*menuBar
= new wxMenuBar
;
377 wxMenu
*menuFile
= new wxMenu
;
378 menuFile
->Append(THREAD_CLEAR
, _T("&Clear log\tCtrl-L"));
379 menuFile
->AppendSeparator();
380 menuFile
->Append(THREAD_QUIT
, _T("E&xit\tAlt-X"));
381 menuBar
->Append(menuFile
, _T("&File"));
383 wxMenu
*menuThread
= new wxMenu
;
384 menuThread
->Append(THREAD_START_THREAD
, _T("&Start a new thread\tCtrl-N"));
385 menuThread
->Append(THREAD_START_THREADS
, _T("Start &many threads at once"));
386 menuThread
->Append(THREAD_STOP_THREAD
, _T("S&top a running thread\tCtrl-S"));
387 menuThread
->AppendSeparator();
388 menuThread
->Append(THREAD_PAUSE_THREAD
, _T("&Pause a running thread\tCtrl-P"));
389 menuThread
->Append(THREAD_RESUME_THREAD
, _T("&Resume suspended thread\tCtrl-R"));
390 menuThread
->AppendSeparator();
391 menuThread
->Append(THREAD_START_WORKER
, _T("Start &worker thread\tCtrl-W"));
392 menuBar
->Append(menuThread
, _T("&Thread"));
394 wxMenu
*menuExec
= new wxMenu
;
395 menuExec
->Append(THREAD_EXEC_MAIN
, _T("&Launch a program from main thread\tF5"));
396 menuExec
->Append(THREAD_EXEC_THREAD
, _T("L&aunch a program from a thread\tCtrl-F5"));
397 menuBar
->Append(menuExec
, _T("&Execute"));
399 wxMenu
*menuHelp
= new wxMenu
;
400 menuHelp
->Append(THREAD_SHOWCPUS
, _T("&Show CPU count"));
401 menuHelp
->AppendSeparator();
402 menuHelp
->Append(THREAD_ABOUT
, _T("&About..."));
403 menuBar
->Append(menuHelp
, _T("&Help"));
405 frame
->SetMenuBar(menuBar
);
415 // My frame constructor
416 MyFrame::MyFrame(wxFrame
*frame
, const wxString
& title
,
417 int x
, int y
, int w
, int h
)
418 : wxFrame(frame
, wxID_ANY
, title
, wxPoint(x
, y
), wxSize(w
, h
))
420 SetIcon(wxIcon(sample_xpm
));
422 m_nRunning
= m_nCount
= 0;
424 m_dlgProgress
= (wxProgressDialog
*)NULL
;
428 #endif // wxUSE_STATUSBAR
430 m_txtctrl
= new wxTextCtrl(this, wxID_ANY
, _T(""), wxPoint(0, 0), wxSize(0, 0),
431 wxTE_MULTILINE
| wxTE_READONLY
);
437 // NB: although the OS will terminate all the threads anyhow when the main
438 // one exits, it's good practice to do it ourselves -- even if it's not
439 // completely trivial in this example
441 // tell all the threads to terminate: note that they can't terminate while
442 // we're deleting them because they will block in their OnExit() -- this is
443 // important as otherwise we might access invalid array elements
446 wxGetApp().m_critsect
.Enter();
448 // check if we have any threads running first
449 const wxArrayThread
& threads
= wxGetApp().m_threads
;
450 size_t count
= threads
.GetCount();
454 // set the flag for MyThread::OnExit()
455 wxGetApp().m_waitingUntilAllDone
= true;
458 while ( ! threads
.IsEmpty() )
460 thread
= threads
.Last();
462 wxGetApp().m_critsect
.Leave();
466 wxGetApp().m_critsect
.Enter();
470 wxGetApp().m_critsect
.Leave();
474 // now wait for them to really terminate
475 wxGetApp().m_semAllDone
.Wait();
477 //else: no threads to terminate, no condition to wait for
480 MyThread
*MyFrame::CreateThread()
482 MyThread
*thread
= new MyThread(this);
484 if ( thread
->Create() != wxTHREAD_NO_ERROR
)
486 wxLogError(wxT("Can't create thread!"));
489 wxCriticalSectionLocker
enter(wxGetApp().m_critsect
);
490 wxGetApp().m_threads
.Add(thread
);
495 void MyFrame::OnStartThreads(wxCommandEvent
& WXUNUSED(event
) )
497 static long s_num
= 10;
499 s_num
= wxGetNumberFromUser(_T("How many threads to start: "), _T(""),
500 _T("wxThread sample"), s_num
, 1, 10000, this);
508 size_t count
= (size_t)s_num
, n
;
510 wxArrayThread threads
;
512 // first create them all...
513 for ( n
= 0; n
< count
; n
++ )
515 wxThread
*thr
= CreateThread();
517 // we want to show the effect of SetPriority(): the first thread will
518 // have the lowest priority, the second - the highest, all the rest
521 thr
->SetPriority(WXTHREAD_MIN_PRIORITY
);
523 thr
->SetPriority(WXTHREAD_MAX_PRIORITY
);
525 thr
->SetPriority(WXTHREAD_DEFAULT_PRIORITY
);
532 msg
.Printf(wxT("%d new threads created."), count
);
533 SetStatusText(msg
, 1);
534 #endif // wxUSE_STATUSBAR
536 // ...and then start them
537 for ( n
= 0; n
< count
; n
++ )
543 void MyFrame::OnStartThread(wxCommandEvent
& WXUNUSED(event
) )
545 MyThread
*thread
= CreateThread();
547 if ( thread
->Run() != wxTHREAD_NO_ERROR
)
549 wxLogError(wxT("Can't start thread!"));
553 SetStatusText(_T("New thread started."), 1);
554 #endif // wxUSE_STATUSBAR
557 void MyFrame::OnStopThread(wxCommandEvent
& WXUNUSED(event
) )
559 wxGetApp().m_critsect
.Enter();
561 // stop the last thread
562 if ( wxGetApp().m_threads
.IsEmpty() )
564 wxLogError(wxT("No thread to stop!"));
566 wxGetApp().m_critsect
.Leave();
570 wxThread
*thread
= wxGetApp().m_threads
.Last();
572 // it's important to leave critical section before calling Delete()
573 // because delete will (implicitly) call OnExit() which also tries
574 // to enter the same crit section - would dead lock.
575 wxGetApp().m_critsect
.Leave();
580 SetStatusText(_T("Thread stopped."), 1);
581 #endif // wxUSE_STATUSBAR
585 void MyFrame::OnResumeThread(wxCommandEvent
& WXUNUSED(event
) )
587 wxCriticalSectionLocker
enter(wxGetApp().m_critsect
);
589 // resume first suspended thread
590 size_t n
= 0, count
= wxGetApp().m_threads
.Count();
591 while ( n
< count
&& !wxGetApp().m_threads
[n
]->IsPaused() )
596 wxLogError(wxT("No thread to resume!"));
600 wxGetApp().m_threads
[n
]->Resume();
603 SetStatusText(_T("Thread resumed."), 1);
604 #endif // wxUSE_STATUSBAR
608 void MyFrame::OnPauseThread(wxCommandEvent
& WXUNUSED(event
) )
610 wxCriticalSectionLocker
enter(wxGetApp().m_critsect
);
612 // pause last running thread
613 int n
= wxGetApp().m_threads
.Count() - 1;
614 while ( n
>= 0 && !wxGetApp().m_threads
[n
]->IsRunning() )
619 wxLogError(wxT("No thread to pause!"));
623 wxGetApp().m_threads
[n
]->Pause();
626 SetStatusText(_T("Thread paused."), 1);
627 #endif // wxUSE_STATUSBAR
631 // set the frame title indicating the current number of threads
632 void MyFrame::OnIdle(wxIdleEvent
& event
)
634 wxCriticalSectionLocker
enter(wxGetApp().m_critsect
);
636 // update the counts of running/total threads
638 nCount
= wxGetApp().m_threads
.Count();
639 for ( size_t n
= 0; n
< nCount
; n
++ )
641 if ( wxGetApp().m_threads
[n
]->IsRunning() )
645 if ( nCount
!= m_nCount
|| nRunning
!= m_nRunning
)
647 m_nRunning
= nRunning
;
650 wxLogStatus(this, wxT("%u threads total, %u running."), nCount
, nRunning
);
652 //else: avoid flicker - don't print anything
657 void MyFrame::OnQuit(wxCommandEvent
& WXUNUSED(event
) )
662 void MyFrame::OnExecMain(wxCommandEvent
& WXUNUSED(event
))
664 wxLogMessage(wxT("The exit code from the main program is %ld"),
665 EXEC(_T("/bin/echo \"main program\"")));
668 void MyFrame::OnExecThread(wxCommandEvent
& WXUNUSED(event
))
670 MyExecThread
thread(wxT("/bin/echo \"child thread\""));
673 wxLogMessage(wxT("The exit code from a child thread is %ld"),
674 (long)thread
.Wait());
677 void MyFrame::OnShowCPUs(wxCommandEvent
& WXUNUSED(event
))
681 int nCPUs
= wxThread::GetCPUCount();
685 msg
= _T("Unknown number of CPUs");
689 msg
= _T("WARNING: you're running without any CPUs!");
693 msg
= _T("This system only has one CPU.");
697 msg
.Printf(wxT("This system has %d CPUs"), nCPUs
);
703 void MyFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
) )
705 wxMessageDialog
dialog(this,
706 _T("wxWidgets multithreaded application sample\n")
707 _T("(c) 1998 Julian Smart, Guilhem Lavaux\n")
708 _T("(c) 1999 Vadim Zeitlin\n")
709 _T("(c) 2000 Robert Roebling"),
710 _T("About wxThread sample"),
711 wxOK
| wxICON_INFORMATION
);
716 void MyFrame::OnClear(wxCommandEvent
& WXUNUSED(event
))
721 void MyFrame::OnUpdateWorker(wxUpdateUIEvent
& event
)
723 event
.Enable( m_dlgProgress
== NULL
);
726 void MyFrame::OnStartWorker(wxCommandEvent
& WXUNUSED(event
))
728 MyWorkerThread
*thread
= new MyWorkerThread(this);
730 if ( thread
->Create() != wxTHREAD_NO_ERROR
)
732 wxLogError(wxT("Can't create thread!"));
736 m_dlgProgress
= new wxProgressDialog
738 _T("Progress dialog"),
739 _T("Wait until the thread terminates or press [Cancel]"),
745 wxPD_ESTIMATED_TIME
|
749 // thread is not running yet, no need for crit sect
755 void MyFrame::OnWorkerEvent(wxCommandEvent
& event
)
758 WriteText( _T("Got message from worker thread: ") );
759 WriteText( event
.GetString() );
760 WriteText( _T("\n") );
762 int n
= event
.GetInt();
765 m_dlgProgress
->Destroy();
766 m_dlgProgress
= (wxProgressDialog
*)NULL
;
768 // the dialog is aborted because the event came from another thread, so
769 // we may need to wake up the main event loop for the dialog to be
775 if ( !m_dlgProgress
->Update(n
) )
777 wxCriticalSectionLocker
lock(m_critsectWork
);
785 bool MyFrame::Cancelled()
787 wxCriticalSectionLocker
lock(m_critsectWork
);