]> git.saurik.com Git - wxWidgets.git/blob - src/gtk/app.cpp
some wxArtProv docs
[wxWidgets.git] / src / gtk / app.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: app.cpp
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling, Julian Smart
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 #ifdef __GNUG__
11 #pragma implementation "app.h"
12 #endif
13
14 #ifdef __VMS
15 #include <vms_jackets.h>
16 #endif
17
18 #include "wx/app.h"
19 #include "wx/gdicmn.h"
20 #include "wx/utils.h"
21 #include "wx/intl.h"
22 #include "wx/log.h"
23 #include "wx/memory.h"
24 #include "wx/font.h"
25 #include "wx/settings.h"
26 #include "wx/dialog.h"
27
28 #if wxUSE_WX_RESOURCES
29 #include "wx/resource.h"
30 #endif
31
32 #include "wx/module.h"
33 #include "wx/image.h"
34
35 #ifdef __WXUNIVERSAL__
36 #include "wx/univ/theme.h"
37 #include "wx/univ/renderer.h"
38 #endif
39
40 #if wxUSE_THREADS
41 #include "wx/thread.h"
42 #endif
43
44 #include <unistd.h>
45 #ifdef __VMS
46 # include <poll.h>
47 #else
48 # include <sys/poll.h>
49 #endif
50 #include "wx/gtk/win_gtk.h"
51
52 #include <gtk/gtk.h>
53
54
55 //-----------------------------------------------------------------------------
56 // global data
57 //-----------------------------------------------------------------------------
58
59 wxApp *wxTheApp = (wxApp *) NULL;
60 wxAppInitializerFunction wxAppBase::m_appInitFn = (wxAppInitializerFunction) NULL;
61
62 bool g_mainThreadLocked = FALSE;
63 gint g_pendingTag = 0;
64
65 static GtkWidget *gs_RootWindow = (GtkWidget*) NULL;
66
67 //-----------------------------------------------------------------------------
68 // idle system
69 //-----------------------------------------------------------------------------
70
71 extern bool g_isIdle;
72
73 void wxapp_install_idle_handler();
74
75 //-----------------------------------------------------------------------------
76 // wxExit
77 //-----------------------------------------------------------------------------
78
79 void wxExit()
80 {
81 gtk_main_quit();
82 }
83
84 //-----------------------------------------------------------------------------
85 // wxYield
86 //-----------------------------------------------------------------------------
87
88 bool wxApp::Yield(bool onlyIfNeeded)
89 {
90 // MT-FIXME
91 static bool s_inYield = FALSE;
92
93 if ( s_inYield )
94 {
95 if ( !onlyIfNeeded )
96 {
97 wxFAIL_MSG( wxT("wxYield called recursively" ) );
98 }
99
100 return FALSE;
101 }
102
103 #if wxUSE_THREADS
104 if ( !wxThread::IsMain() )
105 {
106 // can't call gtk_main_iteration() from other threads like this
107 return TRUE;
108 }
109 #endif // wxUSE_THREADS
110
111 s_inYield = TRUE;
112
113 if (!g_isIdle)
114 {
115 // We need to remove idle callbacks or the loop will
116 // never finish.
117 gtk_idle_remove( m_idleTag );
118 m_idleTag = 0;
119 g_isIdle = TRUE;
120 }
121
122 // disable log flushing from here because a call to wxYield() shouldn't
123 // normally result in message boxes popping up &c
124 wxLog::Suspend();
125
126 while (gtk_events_pending())
127 gtk_main_iteration();
128
129 // It's necessary to call ProcessIdle() to update the frames sizes which
130 // might have been changed (it also will update other things set from
131 // OnUpdateUI() which is a nice (and desired) side effect). But we
132 // call ProcessIdle() only once since this is not meant for longish
133 // background jobs (controlled by wxIdleEvent::RequestMore() and the
134 // return value of Processidle().
135 ProcessIdle();
136
137 // let the logs be flashed again
138 wxLog::Resume();
139
140 s_inYield = FALSE;
141
142 return TRUE;
143 }
144
145 //-----------------------------------------------------------------------------
146 // wxWakeUpIdle
147 //-----------------------------------------------------------------------------
148
149 void wxWakeUpIdle()
150 {
151 #if wxUSE_THREADS
152 if (!wxThread::IsMain())
153 wxMutexGuiEnter();
154 #endif
155
156 if (g_isIdle)
157 wxapp_install_idle_handler();
158
159 #if wxUSE_THREADS
160 if (!wxThread::IsMain())
161 wxMutexGuiLeave();
162 #endif
163 }
164
165 //-----------------------------------------------------------------------------
166 // local functions
167 //-----------------------------------------------------------------------------
168
169 // the callback functions must be extern "C" to comply with GTK+ declarations
170 extern "C"
171 {
172
173 static gint wxapp_pending_callback( gpointer WXUNUSED(data) )
174 {
175 if (!wxTheApp) return TRUE;
176
177 // When getting called from GDK's time-out handler
178 // we are no longer within GDK's grab on the GUI
179 // thread so we must lock it here ourselves.
180 gdk_threads_enter();
181
182 // Sent idle event to all who request them.
183 wxTheApp->ProcessPendingEvents();
184
185 g_pendingTag = 0;
186
187 // Flush the logged messages if any.
188 #if wxUSE_LOG
189 wxLog::FlushActive();
190 #endif // wxUSE_LOG
191
192 // Release lock again
193 gdk_threads_leave();
194
195 // Return FALSE to indicate that no more idle events are
196 // to be sent (single shot instead of continuous stream)
197 return FALSE;
198 }
199
200 static gint wxapp_idle_callback( gpointer WXUNUSED(data) )
201 {
202 if (!wxTheApp)
203 return TRUE;
204
205 #ifdef __WXDEBUG__
206 // don't generate the idle events while the assert modal dialog is shown,
207 // this completely confuses the apps which don't expect to be reentered
208 // from some safely-looking functions
209 if ( wxTheApp->IsInAssert() )
210 {
211 return TRUE;
212 }
213 #endif // __WXDEBUG__
214
215 // When getting called from GDK's time-out handler
216 // we are no longer within GDK's grab on the GUI
217 // thread so we must lock it here ourselves.
218 gdk_threads_enter();
219
220 // Indicate that we are now in idle mode and event handlers
221 // will have to reinstall the idle handler again.
222 g_isIdle = TRUE;
223 wxTheApp->m_idleTag = 0;
224
225 // Send idle event to all who request them as long as
226 // no events have popped up in the event queue.
227 while (wxTheApp->ProcessIdle() && (gtk_events_pending() == 0))
228 ;
229
230 // Release lock again
231 gdk_threads_leave();
232
233 // Return FALSE to indicate that no more idle events are
234 // to be sent (single shot instead of continuous stream).
235 return FALSE;
236 }
237
238 #if wxUSE_THREADS
239
240 static gint wxapp_poll_func( GPollFD *ufds, guint nfds, gint timeout )
241 {
242 gint res;
243 gdk_threads_enter();
244
245 wxMutexGuiLeave();
246 g_mainThreadLocked = TRUE;
247
248 res = poll( (struct pollfd*) ufds, nfds, timeout );
249
250 wxMutexGuiEnter();
251 g_mainThreadLocked = FALSE;
252
253 gdk_threads_leave();
254
255 return res;
256 }
257
258 #endif // wxUSE_THREADS
259
260 } // extern "C"
261
262 void wxapp_install_idle_handler()
263 {
264 wxASSERT_MSG( wxTheApp->m_idleTag == 0, wxT("attempt to install idle handler twice") );
265
266 g_isIdle = FALSE;
267
268 if (g_pendingTag == 0)
269 g_pendingTag = gtk_idle_add_priority( 900, wxapp_pending_callback, (gpointer) NULL );
270
271 // This routine gets called by all event handlers
272 // indicating that the idle is over. It may also
273 // get called from other thread for sending events
274 // to the main thread (and processing these in
275 // idle time). Very low priority.
276 wxTheApp->m_idleTag = gtk_idle_add_priority( 1000, wxapp_idle_callback, (gpointer) NULL );
277 }
278
279 //-----------------------------------------------------------------------------
280 // Access to the root window global
281 //-----------------------------------------------------------------------------
282
283 GtkWidget* wxGetRootWindow()
284 {
285 if (gs_RootWindow == NULL)
286 {
287 gs_RootWindow = gtk_window_new( GTK_WINDOW_TOPLEVEL );
288 gtk_widget_realize( gs_RootWindow );
289 }
290 return gs_RootWindow;
291 }
292
293 //-----------------------------------------------------------------------------
294 // wxApp
295 //-----------------------------------------------------------------------------
296
297 IMPLEMENT_DYNAMIC_CLASS(wxApp,wxEvtHandler)
298
299 BEGIN_EVENT_TABLE(wxApp, wxEvtHandler)
300 EVT_IDLE(wxApp::OnIdle)
301 END_EVENT_TABLE()
302
303 wxApp::wxApp()
304 {
305 m_initialized = FALSE;
306 #ifdef __WXDEBUG__
307 m_isInAssert = FALSE;
308 #endif // __WXDEBUG__
309
310 m_idleTag = 0;
311 wxapp_install_idle_handler();
312
313 #if wxUSE_THREADS
314 g_main_set_poll_func( wxapp_poll_func );
315 #endif
316
317 m_colorCube = (unsigned char*) NULL;
318
319 // this is NULL for a "regular" wxApp, but is set (and freed) by a wxGLApp
320 m_glVisualInfo = (void *) NULL;
321 }
322
323 wxApp::~wxApp()
324 {
325 if (m_idleTag) gtk_idle_remove( m_idleTag );
326
327 if (m_colorCube) free(m_colorCube);
328 }
329
330 bool wxApp::OnInitGui()
331 {
332 if ( !wxAppBase::OnInitGui() )
333 return FALSE;
334
335 GdkVisual *visual = gdk_visual_get_system();
336
337 // if this is a wxGLApp (derived from wxApp), and we've already
338 // chosen a specific visual, then derive the GdkVisual from that
339 if (m_glVisualInfo != NULL)
340 {
341 #ifdef __WXGTK20__
342 // seems gtk_widget_set_default_visual no longer exists?
343 GdkVisual* vis = gtk_widget_get_default_visual();
344 #else
345 GdkVisual* vis = gdkx_visual_get(
346 ((XVisualInfo *) m_glVisualInfo) ->visualid );
347 gtk_widget_set_default_visual( vis );
348 #endif
349
350 GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
351 gtk_widget_set_default_colormap( colormap );
352
353 visual = vis;
354 }
355
356 // On some machines, the default visual is just 256 colours, so
357 // we make sure we get the best. This can sometimes be wasteful.
358
359 else
360 if ((gdk_visual_get_best() != gdk_visual_get_system()) && (m_useBestVisual))
361 {
362 #ifdef __WXGTK20__
363 /* seems gtk_widget_set_default_visual no longer exists? */
364 GdkVisual* vis = gtk_widget_get_default_visual();
365 #else
366 GdkVisual* vis = gdk_visual_get_best();
367 gtk_widget_set_default_visual( vis );
368 #endif
369
370 GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
371 gtk_widget_set_default_colormap( colormap );
372
373 visual = vis;
374 }
375
376 // Nothing to do for 15, 16, 24, 32 bit displays
377 if (visual->depth > 8) return TRUE;
378
379 // initialize color cube for 8-bit color reduction dithering
380
381 GdkColormap *cmap = gtk_widget_get_default_colormap();
382
383 m_colorCube = (unsigned char*)malloc(32 * 32 * 32);
384
385 for (int r = 0; r < 32; r++)
386 {
387 for (int g = 0; g < 32; g++)
388 {
389 for (int b = 0; b < 32; b++)
390 {
391 int rr = (r << 3) | (r >> 2);
392 int gg = (g << 3) | (g >> 2);
393 int bb = (b << 3) | (b >> 2);
394
395 int index = -1;
396
397 GdkColor *colors = cmap->colors;
398 if (colors)
399 {
400 int max = 3 * 65536;
401
402 for (int i = 0; i < cmap->size; i++)
403 {
404 int rdiff = ((rr << 8) - colors[i].red);
405 int gdiff = ((gg << 8) - colors[i].green);
406 int bdiff = ((bb << 8) - colors[i].blue);
407 int sum = ABS (rdiff) + ABS (gdiff) + ABS (bdiff);
408 if (sum < max)
409 {
410 index = i; max = sum;
411 }
412 }
413 }
414 else
415 {
416 // assume 8-bit true or static colors. this really exists
417 GdkVisual* vis = gdk_colormap_get_visual( cmap );
418 index = (r >> (5 - vis->red_prec)) << vis->red_shift;
419 index |= (g >> (5 - vis->green_prec)) << vis->green_shift;
420 index |= (b >> (5 - vis->blue_prec)) << vis->blue_shift;
421 }
422 m_colorCube[ (r*1024) + (g*32) + b ] = index;
423 }
424 }
425 }
426
427 return TRUE;
428 }
429
430 GdkVisual *wxApp::GetGdkVisual()
431 {
432 GdkVisual *visual = NULL;
433
434 if (m_glVisualInfo)
435 visual = gdkx_visual_get( ((XVisualInfo *) m_glVisualInfo)->visualid );
436 else
437 visual = gdk_window_get_visual( wxGetRootWindow()->window );
438
439 wxASSERT( visual );
440
441 return visual;
442 }
443
444 bool wxApp::ProcessIdle()
445 {
446 wxIdleEvent event;
447 event.SetEventObject( this );
448 ProcessEvent( event );
449
450 return event.MoreRequested();
451 }
452
453 void wxApp::OnIdle( wxIdleEvent &event )
454 {
455 static bool s_inOnIdle = FALSE;
456
457 // Avoid recursion (via ProcessEvent default case)
458 if (s_inOnIdle)
459 return;
460
461 s_inOnIdle = TRUE;
462
463 // Resend in the main thread events which have been prepared in other
464 // threads
465 ProcessPendingEvents();
466
467 // 'Garbage' collection of windows deleted with Close()
468 DeletePendingObjects();
469
470 // Send OnIdle events to all windows
471 bool needMore = SendIdleEvents();
472
473 if (needMore)
474 event.RequestMore(TRUE);
475
476 s_inOnIdle = FALSE;
477 }
478
479 bool wxApp::SendIdleEvents()
480 {
481 bool needMore = FALSE;
482
483 wxWindowList::Node* node = wxTopLevelWindows.GetFirst();
484 while (node)
485 {
486 wxWindow* win = node->GetData();
487 if (SendIdleEvents(win))
488 needMore = TRUE;
489 node = node->GetNext();
490 }
491
492 return needMore;
493 }
494
495 bool wxApp::SendIdleEvents( wxWindow* win )
496 {
497 bool needMore = FALSE;
498
499 wxIdleEvent event;
500 event.SetEventObject(win);
501
502 win->GetEventHandler()->ProcessEvent(event);
503
504 if (event.MoreRequested())
505 needMore = TRUE;
506
507 wxNode* node = win->GetChildren().First();
508 while (node)
509 {
510 wxWindow* win = (wxWindow*) node->Data();
511 if (SendIdleEvents(win))
512 needMore = TRUE;
513
514 node = node->Next();
515 }
516
517 win->OnInternalIdle();
518
519 return needMore;
520 }
521
522 int wxApp::MainLoop()
523 {
524 gtk_main();
525 return 0;
526 }
527
528 void wxApp::ExitMainLoop()
529 {
530 if (gtk_main_level() > 0)
531 gtk_main_quit();
532 }
533
534 bool wxApp::Initialized()
535 {
536 return m_initialized;
537 }
538
539 bool wxApp::Pending()
540 {
541 return (gtk_events_pending() > 0);
542 }
543
544 void wxApp::Dispatch()
545 {
546 gtk_main_iteration();
547 }
548
549 void wxApp::DeletePendingObjects()
550 {
551 wxNode *node = wxPendingDelete.First();
552 while (node)
553 {
554 wxObject *obj = (wxObject *)node->Data();
555
556 delete obj;
557
558 if (wxPendingDelete.Find(obj))
559 delete node;
560
561 node = wxPendingDelete.First();
562 }
563 }
564
565 bool wxApp::Initialize()
566 {
567 wxClassInfo::InitializeClasses();
568
569 #if wxUSE_INTL
570 wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
571 #endif
572
573 // GL: I'm annoyed ... I don't know where to put this and I don't want to
574 // create a module for that as it's part of the core.
575 #if wxUSE_THREADS
576 wxPendingEvents = new wxList();
577 wxPendingEventsLocker = new wxCriticalSection();
578 #endif
579
580 wxTheColourDatabase = new wxColourDatabase( wxKEY_STRING );
581 wxTheColourDatabase->Initialize();
582
583 wxInitializeStockLists();
584 wxInitializeStockObjects();
585
586 #if wxUSE_WX_RESOURCES
587 wxInitializeResourceSystem();
588 #endif
589
590 wxModule::RegisterModules();
591 if (!wxModule::InitializeModules()) return FALSE;
592
593 return TRUE;
594 }
595
596 void wxApp::CleanUp()
597 {
598 wxModule::CleanUpModules();
599
600 #if wxUSE_WX_RESOURCES
601 wxCleanUpResourceSystem();
602 #endif
603
604 delete wxTheColourDatabase;
605 wxTheColourDatabase = (wxColourDatabase*) NULL;
606
607 wxDeleteStockObjects();
608
609 wxDeleteStockLists();
610
611 delete wxTheApp;
612 wxTheApp = (wxApp*) NULL;
613
614 wxClassInfo::CleanUpClasses();
615
616 #if wxUSE_THREADS
617 delete wxPendingEvents;
618 delete wxPendingEventsLocker;
619 #endif
620
621 // check for memory leaks
622 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
623 if (wxDebugContext::CountObjectsLeft(TRUE) > 0)
624 {
625 wxLogDebug(wxT("There were memory leaks.\n"));
626 wxDebugContext::Dump();
627 wxDebugContext::PrintStatistics();
628 }
629 #endif // Debug
630
631 #if wxUSE_LOG
632 // do this as the very last thing because everything else can log messages
633 wxLog::DontCreateOnDemand();
634
635 wxLog *oldLog = wxLog::SetActiveTarget( (wxLog*) NULL );
636 if (oldLog)
637 delete oldLog;
638 #endif // wxUSE_LOG
639 }
640
641 //-----------------------------------------------------------------------------
642 // wxEntry
643 //-----------------------------------------------------------------------------
644
645 // NB: argc and argv may be changed here, pass by reference!
646 int wxEntryStart( int& argc, char *argv[] )
647 {
648 #if wxUSE_THREADS
649 // GTK 1.2 up to version 1.2.3 has broken threads
650 if ((gtk_major_version == 1) &&
651 (gtk_minor_version == 2) &&
652 (gtk_micro_version < 4))
653 {
654 printf( "wxWindows warning: GUI threading disabled due to outdated GTK version\n" );
655 }
656 else
657 {
658 g_thread_init(NULL);
659 }
660 #endif
661
662 gtk_set_locale();
663
664 // We should have the wxUSE_WCHAR_T test on the _outside_
665 #if wxUSE_WCHAR_T
666 #if defined(__WXGTK20__)
667 // gtk+ 2.0 supports Unicode through UTF-8 strings
668 wxConvCurrent = &wxConvUTF8;
669 #else
670 if (!wxOKlibc()) wxConvCurrent = &wxConvLocal;
671 #endif
672 #else
673 if (!wxOKlibc()) wxConvCurrent = (wxMBConv*) NULL;
674 #endif
675
676 gdk_threads_enter();
677
678 gtk_init( &argc, &argv );
679
680 wxSetDetectableAutoRepeat( TRUE );
681
682 if (!wxApp::Initialize())
683 {
684 gdk_threads_leave();
685 return -1;
686 }
687
688 return 0;
689 }
690
691
692 int wxEntryInitGui()
693 {
694 int retValue = 0;
695
696 if ( !wxTheApp->OnInitGui() )
697 retValue = -1;
698
699 wxGetRootWindow();
700
701 return retValue;
702 }
703
704
705 void wxEntryCleanup()
706 {
707 #if wxUSE_LOG
708 // flush the logged messages if any
709 wxLog *log = wxLog::GetActiveTarget();
710 if (log != NULL && log->HasPendingMessages())
711 log->Flush();
712
713 // continuing to use user defined log target is unsafe from now on because
714 // some resources may be already unavailable, so replace it by something
715 // more safe
716 wxLog *oldlog = wxLog::SetActiveTarget(new wxLogStderr);
717 if ( oldlog )
718 delete oldlog;
719 #endif // wxUSE_LOG
720
721 wxApp::CleanUp();
722
723 gdk_threads_leave();
724 }
725
726
727 int wxEntry( int argc, char *argv[] )
728 {
729 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
730 // This seems to be necessary since there are 'rogue'
731 // objects present at this point (perhaps global objects?)
732 // Setting a checkpoint will ignore them as far as the
733 // memory checking facility is concerned.
734 // Of course you may argue that memory allocated in globals should be
735 // checked, but this is a reasonable compromise.
736 wxDebugContext::SetCheckpoint();
737 #endif
738 int err = wxEntryStart(argc, argv);
739 if (err)
740 return err;
741
742 if (!wxTheApp)
743 {
744 wxCHECK_MSG( wxApp::GetInitializerFunction(), -1,
745 wxT("wxWindows error: No initializer - use IMPLEMENT_APP macro.\n") );
746
747 wxAppInitializerFunction app_ini = wxApp::GetInitializerFunction();
748
749 wxObject *test_app = app_ini();
750
751 wxTheApp = (wxApp*) test_app;
752 }
753
754 wxCHECK_MSG( wxTheApp, -1, wxT("wxWindows error: no application object") );
755
756 wxTheApp->argc = argc;
757 #if wxUSE_UNICODE
758 wxTheApp->argv = new wxChar*[argc+1];
759 int mb_argc = 0;
760 while (mb_argc < argc)
761 {
762 wxTheApp->argv[mb_argc] = wxStrdup(wxConvLibc.cMB2WX(argv[mb_argc]));
763 mb_argc++;
764 }
765 wxTheApp->argv[mb_argc] = (wxChar *)NULL;
766 #else
767 wxTheApp->argv = argv;
768 #endif
769
770 wxString name(wxFileNameFromPath(argv[0]));
771 wxStripExtension( name );
772 wxTheApp->SetAppName( name );
773
774 int retValue;
775 retValue = wxEntryInitGui();
776
777 // Here frames insert themselves automatically into wxTopLevelWindows by
778 // getting created in OnInit().
779 if ( retValue == 0 )
780 {
781 if ( !wxTheApp->OnInit() )
782 retValue = -1;
783 }
784
785 if ( retValue == 0 )
786 {
787 /* delete pending toplevel windows (typically a single
788 dialog) so that, if there isn't any left, we don't
789 call OnRun() */
790 wxTheApp->DeletePendingObjects();
791
792 wxTheApp->m_initialized = wxTopLevelWindows.GetCount() != 0;
793
794 if (wxTheApp->Initialized())
795 {
796 wxTheApp->OnRun();
797
798 wxWindow *topWindow = wxTheApp->GetTopWindow();
799 if (topWindow)
800 {
801 /* Forcibly delete the window. */
802 if (topWindow->IsKindOf(CLASSINFO(wxFrame)) ||
803 topWindow->IsKindOf(CLASSINFO(wxDialog)) )
804 {
805 topWindow->Close( TRUE );
806 wxTheApp->DeletePendingObjects();
807 }
808 else
809 {
810 delete topWindow;
811 wxTheApp->SetTopWindow( (wxWindow*) NULL );
812 }
813 }
814
815 retValue = wxTheApp->OnExit();
816 }
817 }
818
819 wxEntryCleanup();
820
821 return retValue;
822 }
823
824 #ifdef __WXDEBUG__
825
826 void wxApp::OnAssert(const wxChar *file, int line, const wxChar *msg)
827 {
828 m_isInAssert = TRUE;
829
830 wxAppBase::OnAssert(file, line, msg);
831
832 m_isInAssert = FALSE;
833 }
834
835 #endif // __WXDEBUG__
836