]> git.saurik.com Git - wxWidgets.git/blob - src/gtk/app.cpp
correcting CGImage handling to be always correctly initialized and freed on OSX build...
[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 __VMS
11 // vms_jackets.h should for proper working be included before anything else
12 # include <vms_jackets.h>
13 #undef ConnectionNumber
14 #endif
15
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
18
19 #include "wx/app.h"
20 #include "wx/gdicmn.h"
21 #include "wx/utils.h"
22 #include "wx/intl.h"
23 #include "wx/log.h"
24 #include "wx/memory.h"
25 #include "wx/font.h"
26 #include "wx/settings.h"
27 #include "wx/dialog.h"
28 #include "wx/msgdlg.h"
29 #include "wx/file.h"
30 #include "wx/filename.h"
31 #include "wx/module.h"
32 #include "wx/image.h"
33 #include "wx/thread.h"
34
35 #ifdef __WXGPE__
36 #include <gpe/init.h>
37 #endif
38
39 #ifdef __WXUNIVERSAL__
40 #include "wx/univ/theme.h"
41 #include "wx/univ/renderer.h"
42 #endif
43
44 #if wxUSE_THREADS
45 #include "wx/thread.h"
46 #endif
47
48 #include <unistd.h>
49
50 #ifdef HAVE_POLL
51 #if defined(__VMS)
52 #include <poll.h>
53 #else
54 // bug in the OpenBSD headers: at least in 3.1 there is no extern "C"
55 // in neither poll.h nor sys/poll.h which results in link errors later
56 #ifdef __OPENBSD__
57 extern "C"
58 {
59 #endif
60
61 #include <sys/poll.h>
62
63 #ifdef __OPENBSD__
64 };
65 #endif
66 #endif // platform
67 #else // !HAVE_POLL
68 // we implement poll() ourselves using select() which is supposed exist in
69 // all modern Unices
70 #include <sys/types.h>
71 #include <sys/time.h>
72 #include <unistd.h>
73 #endif // HAVE_POLL/!HAVE_POLL
74
75 #include "wx/unix/private.h"
76 #include "wx/gtk/win_gtk.h"
77
78 #include <gtk/gtk.h>
79
80 //-----------------------------------------------------------------------------
81 // global data
82 //-----------------------------------------------------------------------------
83
84 bool g_mainThreadLocked = FALSE;
85 gint g_pendingTag = 0;
86
87 static GtkWidget *gs_RootWindow = (GtkWidget*) NULL;
88
89 //-----------------------------------------------------------------------------
90 // idle system
91 //-----------------------------------------------------------------------------
92
93 extern bool g_isIdle;
94
95 void wxapp_install_idle_handler();
96
97 #if wxUSE_THREADS
98 static wxMutex gs_idleTagsMutex;
99 #endif
100
101 //-----------------------------------------------------------------------------
102 // wxYield
103 //-----------------------------------------------------------------------------
104
105 // not static because used by textctrl.cpp
106 //
107 // MT-FIXME
108 bool wxIsInsideYield = FALSE;
109
110 bool wxApp::Yield(bool onlyIfNeeded)
111 {
112 if ( wxIsInsideYield )
113 {
114 if ( !onlyIfNeeded )
115 {
116 wxFAIL_MSG( wxT("wxYield called recursively" ) );
117 }
118
119 return FALSE;
120 }
121
122 #if wxUSE_THREADS
123 if ( !wxThread::IsMain() )
124 {
125 // can't call gtk_main_iteration() from other threads like this
126 return TRUE;
127 }
128 #endif // wxUSE_THREADS
129
130 wxIsInsideYield = TRUE;
131
132 // We need to remove idle callbacks or the loop will
133 // never finish.
134 wxTheApp->RemoveIdleTag();
135
136 #if wxUSE_LOG
137 // disable log flushing from here because a call to wxYield() shouldn't
138 // normally result in message boxes popping up &c
139 wxLog::Suspend();
140 #endif
141
142 while (gtk_events_pending())
143 gtk_main_iteration();
144
145 // It's necessary to call ProcessIdle() to update the frames sizes which
146 // might have been changed (it also will update other things set from
147 // OnUpdateUI() which is a nice (and desired) side effect). But we
148 // call ProcessIdle() only once since this is not meant for longish
149 // background jobs (controlled by wxIdleEvent::RequestMore() and the
150 // return value of Processidle().
151 ProcessIdle();
152
153 #if wxUSE_LOG
154 // let the logs be flashed again
155 wxLog::Resume();
156 #endif
157
158 wxIsInsideYield = FALSE;
159
160 return TRUE;
161 }
162
163 //-----------------------------------------------------------------------------
164 // wxWakeUpIdle
165 //-----------------------------------------------------------------------------
166
167 // RR/KH: The wxMutexGui calls are not needed on GTK2 according to
168 // the GTK faq, http://www.gtk.org/faq/#AEN500
169 // The calls to gdk_threads_enter() and leave() are specifically noted
170 // as not being necessary. The MutexGui calls are still left in for GTK1.
171 // Eliminating the MutexGui calls fixes the long-standing "random" lockup
172 // when using wxPostEvent (which calls WakeUpIdle) from a thread.
173
174 void wxApp::WakeUpIdle()
175 {
176 #ifndef __WXGTK20__
177 #if wxUSE_THREADS
178 if (!wxThread::IsMain())
179 wxMutexGuiEnter();
180 #endif // wxUSE_THREADS_
181 #endif // __WXGTK2__
182
183 wxapp_install_idle_handler();
184
185 #ifndef __WXGTK20__
186 #if wxUSE_THREADS
187 if (!wxThread::IsMain())
188 wxMutexGuiLeave();
189 #endif // wxUSE_THREADS_
190 #endif // __WXGTK2__
191 }
192
193 //-----------------------------------------------------------------------------
194 // local functions
195 //-----------------------------------------------------------------------------
196
197 // the callback functions must be extern "C" to comply with GTK+ declarations
198 extern "C"
199 {
200
201 static gint wxapp_pending_callback( gpointer WXUNUSED(data) )
202 {
203 if (!wxTheApp) return TRUE;
204
205 // When getting called from GDK's time-out handler
206 // we are no longer within GDK's grab on the GUI
207 // thread so we must lock it here ourselves.
208 gdk_threads_enter();
209
210 // Sent idle event to all who request them.
211 wxTheApp->ProcessPendingEvents();
212
213 {
214 #if wxUSE_THREADS
215 wxMutexLocker lock(gs_idleTagsMutex);
216 #endif
217 g_pendingTag = 0;
218 }
219
220 // Flush the logged messages if any.
221 #if wxUSE_LOG
222 wxLog::FlushActive();
223 #endif // wxUSE_LOG
224
225 // Release lock again
226 gdk_threads_leave();
227
228 // Return FALSE to indicate that no more idle events are
229 // to be sent (single shot instead of continuous stream)
230 return FALSE;
231 }
232
233 static gint wxapp_idle_callback( gpointer WXUNUSED(data) )
234 {
235 if (!wxTheApp)
236 return TRUE;
237
238 #ifdef __WXDEBUG__
239 // don't generate the idle events while the assert modal dialog is shown,
240 // this completely confuses the apps which don't expect to be reentered
241 // from some safely-looking functions
242 if ( wxTheApp->IsInAssert() )
243 {
244 // But repaint the assertion message if necessary
245 if (wxTopLevelWindows.GetCount() > 0)
246 {
247 wxWindow* win = (wxWindow*) wxTopLevelWindows.GetLast()->GetData();
248 #ifdef __WXGTK20__
249 if (win->IsKindOf(CLASSINFO(wxMessageDialog)))
250 #else
251 if (win->IsKindOf(CLASSINFO(wxGenericMessageDialog)))
252 #endif
253 win->OnInternalIdle();
254 }
255 return TRUE;
256 }
257 #endif // __WXDEBUG__
258
259 // When getting called from GDK's time-out handler
260 // we are no longer within GDK's grab on the GUI
261 // thread so we must lock it here ourselves.
262 gdk_threads_enter();
263
264 // Indicate that we are now in idle mode and event handlers
265 // will have to reinstall the idle handler again.
266 {
267 #if wxUSE_THREADS
268 wxMutexLocker lock(gs_idleTagsMutex);
269 #endif
270 g_isIdle = TRUE;
271 wxTheApp->m_idleTag = 0;
272 }
273
274 // Send idle event to all who request them as long as
275 // no events have popped up in the event queue.
276 while (wxTheApp->ProcessIdle() && (gtk_events_pending() == 0))
277 ;
278
279 // Release lock again
280 gdk_threads_leave();
281
282 // Return FALSE to indicate that no more idle events are
283 // to be sent (single shot instead of continuous stream).
284 return FALSE;
285 }
286
287 #if wxUSE_THREADS
288
289 #ifdef HAVE_POLL
290 #define wxPoll poll
291 #define wxPollFd pollfd
292 #else // !HAVE_POLL
293
294 typedef GPollFD wxPollFd;
295
296 int wxPoll(wxPollFd *ufds, unsigned int nfds, int timeout)
297 {
298 // convert timeout from ms to struct timeval (s/us)
299 timeval tv_timeout;
300 tv_timeout.tv_sec = timeout/1000;
301 tv_timeout.tv_usec = (timeout%1000)*1000;
302
303 // remember the highest fd used here
304 int fdMax = -1;
305
306 // and fill the sets for select()
307 fd_set readfds;
308 fd_set writefds;
309 fd_set exceptfds;
310 wxFD_ZERO(&readfds);
311 wxFD_ZERO(&writefds);
312 wxFD_ZERO(&exceptfds);
313
314 unsigned int i;
315 for ( i = 0; i < nfds; i++ )
316 {
317 wxASSERT_MSG( ufds[i].fd < wxFD_SETSIZE, _T("fd out of range") );
318
319 if ( ufds[i].events & G_IO_IN )
320 wxFD_SET(ufds[i].fd, &readfds);
321
322 if ( ufds[i].events & G_IO_PRI )
323 wxFD_SET(ufds[i].fd, &exceptfds);
324
325 if ( ufds[i].events & G_IO_OUT )
326 wxFD_SET(ufds[i].fd, &writefds);
327
328 if ( ufds[i].fd > fdMax )
329 fdMax = ufds[i].fd;
330 }
331
332 fdMax++;
333 int res = select(fdMax, &readfds, &writefds, &exceptfds, &tv_timeout);
334
335 // translate the results back
336 for ( i = 0; i < nfds; i++ )
337 {
338 ufds[i].revents = 0;
339
340 if ( wxFD_ISSET(ufds[i].fd, &readfds ) )
341 ufds[i].revents |= G_IO_IN;
342
343 if ( wxFD_ISSET(ufds[i].fd, &exceptfds ) )
344 ufds[i].revents |= G_IO_PRI;
345
346 if ( wxFD_ISSET(ufds[i].fd, &writefds ) )
347 ufds[i].revents |= G_IO_OUT;
348 }
349
350 return res;
351 }
352
353 #endif // HAVE_POLL/!HAVE_POLL
354
355 static gint wxapp_poll_func( GPollFD *ufds, guint nfds, gint timeout )
356 {
357 gdk_threads_enter();
358
359 wxMutexGuiLeave();
360 g_mainThreadLocked = TRUE;
361
362 // we rely on the fact that glib GPollFD struct is really just pollfd but
363 // I wonder how wise is this in the long term (VZ)
364 gint res = wxPoll( (wxPollFd *) ufds, nfds, timeout );
365
366 wxMutexGuiEnter();
367 g_mainThreadLocked = FALSE;
368
369 gdk_threads_leave();
370
371 return res;
372 }
373
374 #endif // wxUSE_THREADS
375
376 } // extern "C"
377
378 void wxapp_install_idle_handler()
379 {
380 #if wxUSE_THREADS
381 wxMutexLocker lock(gs_idleTagsMutex);
382 #endif
383
384 // Don't install the handler if it's already installed. This test *MUST*
385 // be done when gs_idleTagsMutex is locked!
386 if (!g_isIdle)
387 return;
388
389 // GD: this assert is raised when using the thread sample (which works)
390 // so the test is probably not so easy. Can widget callbacks be
391 // triggered from child threads and, if so, for which widgets?
392 // wxASSERT_MSG( wxThread::IsMain() || gs_WakeUpIdle, wxT("attempt to install idle handler from widget callback in child thread (should be exclusively from wxWakeUpIdle)") );
393
394 wxASSERT_MSG( wxTheApp->m_idleTag == 0, wxT("attempt to install idle handler twice") );
395
396 g_isIdle = FALSE;
397
398 if (g_pendingTag == 0)
399 g_pendingTag = gtk_idle_add_priority( 900, wxapp_pending_callback, (gpointer) NULL );
400
401 // This routine gets called by all event handlers
402 // indicating that the idle is over. It may also
403 // get called from other thread for sending events
404 // to the main thread (and processing these in
405 // idle time). Very low priority.
406 wxTheApp->m_idleTag = gtk_idle_add_priority( 1000, wxapp_idle_callback, (gpointer) NULL );
407 }
408
409 //-----------------------------------------------------------------------------
410 // Access to the root window global
411 //-----------------------------------------------------------------------------
412
413 GtkWidget* wxGetRootWindow()
414 {
415 if (gs_RootWindow == NULL)
416 {
417 gs_RootWindow = gtk_window_new( GTK_WINDOW_TOPLEVEL );
418 gtk_widget_realize( gs_RootWindow );
419 }
420 return gs_RootWindow;
421 }
422
423 //-----------------------------------------------------------------------------
424 // wxApp
425 //-----------------------------------------------------------------------------
426
427 IMPLEMENT_DYNAMIC_CLASS(wxApp,wxEvtHandler)
428
429 BEGIN_EVENT_TABLE(wxApp, wxEvtHandler)
430 EVT_IDLE(wxAppBase::OnIdle)
431 END_EVENT_TABLE()
432
433 wxApp::wxApp()
434 {
435 #ifdef __WXDEBUG__
436 m_isInAssert = FALSE;
437 #endif // __WXDEBUG__
438
439 m_idleTag = 0;
440 g_isIdle = TRUE;
441 wxapp_install_idle_handler();
442
443 #if wxUSE_THREADS
444 g_main_set_poll_func( wxapp_poll_func );
445 #endif
446
447 m_colorCube = (unsigned char*) NULL;
448
449 // this is NULL for a "regular" wxApp, but is set (and freed) by a wxGLApp
450 m_glVisualInfo = (void *) NULL;
451 m_glFBCInfo = (void *) NULL;
452 }
453
454 wxApp::~wxApp()
455 {
456 if (m_idleTag) gtk_idle_remove( m_idleTag );
457
458 if (m_colorCube) free(m_colorCube);
459 }
460
461 bool wxApp::OnInitGui()
462 {
463 if ( !wxAppBase::OnInitGui() )
464 return FALSE;
465
466 GdkVisual *visual = gdk_visual_get_system();
467
468 // if this is a wxGLApp (derived from wxApp), and we've already
469 // chosen a specific visual, then derive the GdkVisual from that
470 if (m_glVisualInfo != NULL)
471 {
472 #ifdef __WXGTK20__
473 // seems gtk_widget_set_default_visual no longer exists?
474 GdkVisual* vis = gtk_widget_get_default_visual();
475 #else
476 GdkVisual* vis = gdkx_visual_get(
477 ((XVisualInfo *) m_glVisualInfo) ->visualid );
478 gtk_widget_set_default_visual( vis );
479 #endif
480
481 GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
482 gtk_widget_set_default_colormap( colormap );
483
484 visual = vis;
485 }
486
487 // On some machines, the default visual is just 256 colours, so
488 // we make sure we get the best. This can sometimes be wasteful.
489
490 else
491 if ((gdk_visual_get_best() != gdk_visual_get_system()) && (m_useBestVisual))
492 {
493 #ifdef __WXGTK20__
494 /* seems gtk_widget_set_default_visual no longer exists? */
495 GdkVisual* vis = gtk_widget_get_default_visual();
496 #else
497 GdkVisual* vis = gdk_visual_get_best();
498 gtk_widget_set_default_visual( vis );
499 #endif
500
501 GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
502 gtk_widget_set_default_colormap( colormap );
503
504 visual = vis;
505 }
506
507 // Nothing to do for 15, 16, 24, 32 bit displays
508 if (visual->depth > 8) return TRUE;
509
510 // initialize color cube for 8-bit color reduction dithering
511
512 GdkColormap *cmap = gtk_widget_get_default_colormap();
513
514 m_colorCube = (unsigned char*)malloc(32 * 32 * 32);
515
516 for (int r = 0; r < 32; r++)
517 {
518 for (int g = 0; g < 32; g++)
519 {
520 for (int b = 0; b < 32; b++)
521 {
522 int rr = (r << 3) | (r >> 2);
523 int gg = (g << 3) | (g >> 2);
524 int bb = (b << 3) | (b >> 2);
525
526 int index = -1;
527
528 GdkColor *colors = cmap->colors;
529 if (colors)
530 {
531 int max = 3 * 65536;
532
533 for (int i = 0; i < cmap->size; i++)
534 {
535 int rdiff = ((rr << 8) - colors[i].red);
536 int gdiff = ((gg << 8) - colors[i].green);
537 int bdiff = ((bb << 8) - colors[i].blue);
538 int sum = ABS (rdiff) + ABS (gdiff) + ABS (bdiff);
539 if (sum < max)
540 {
541 index = i; max = sum;
542 }
543 }
544 }
545 else
546 {
547 // assume 8-bit true or static colors. this really exists
548 GdkVisual* vis = gdk_colormap_get_visual( cmap );
549 index = (r >> (5 - vis->red_prec)) << vis->red_shift;
550 index |= (g >> (5 - vis->green_prec)) << vis->green_shift;
551 index |= (b >> (5 - vis->blue_prec)) << vis->blue_shift;
552 }
553 m_colorCube[ (r*1024) + (g*32) + b ] = index;
554 }
555 }
556 }
557
558 return TRUE;
559 }
560
561 GdkVisual *wxApp::GetGdkVisual()
562 {
563 GdkVisual *visual = NULL;
564
565 if (m_glVisualInfo)
566 visual = gdkx_visual_get( ((XVisualInfo *) m_glVisualInfo)->visualid );
567 else
568 visual = gdk_window_get_visual( wxGetRootWindow()->window );
569
570 wxASSERT( visual );
571
572 return visual;
573 }
574
575 bool wxApp::Initialize(int& argc, wxChar **argv)
576 {
577 bool init_result;
578
579 #if wxUSE_THREADS
580 // GTK 1.2 up to version 1.2.3 has broken threads
581 if ((gtk_major_version == 1) &&
582 (gtk_minor_version == 2) &&
583 (gtk_micro_version < 4))
584 {
585 printf( "wxWidgets warning: GUI threading disabled due to outdated GTK version\n" );
586 }
587 else
588 {
589 if (!g_thread_supported())
590 g_thread_init(NULL);
591 }
592 #endif // wxUSE_THREADS
593
594 gtk_set_locale();
595
596 // We should have the wxUSE_WCHAR_T test on the _outside_
597 #if wxUSE_WCHAR_T
598 #if defined(__WXGTK20__)
599 // gtk+ 2.0 supports Unicode through UTF-8 strings
600 wxConvCurrent = &wxConvUTF8;
601 #else // GTK 1.x
602 if (!wxOKlibc())
603 wxConvCurrent = &wxConvLocal;
604 #endif
605 #else // !wxUSE_WCHAR_T
606 if (!wxOKlibc())
607 wxConvCurrent = (wxMBConv*) NULL;
608 #endif // wxUSE_WCHAR_T/!wxUSE_WCHAR_T
609
610 #ifdef __WXGTK20__
611 // decide which conversion to use for the file names
612
613 // (1) this variable exists for the sole purpose of specifying the encoding
614 // of the filenames for GTK+ programs, so use it if it is set
615 wxString encName(wxGetenv(_T("G_FILENAME_ENCODING")));
616 encName = encName.BeforeFirst(_T(','));
617 if (encName == _T("@locale"))
618 encName.clear();
619 encName.MakeUpper();
620 #if wxUSE_INTL
621 if (encName.empty())
622 {
623 // (2) if a non default locale is set, assume that the user wants his
624 // filenames in this locale too
625 encName = wxLocale::GetSystemEncodingName().Upper();
626 // (3) finally use UTF-8 by default
627 if (encName.empty() || encName == _T("US-ASCII"))
628 encName = _T("UTF-8");
629 wxSetEnv(_T("G_FILENAME_ENCODING"), encName);
630 }
631 #else
632 if (encName.empty())
633 encName = _T("UTF-8");
634 #endif // wxUSE_INTL
635 static wxConvBrokenFileNames fileconv(encName);
636 wxConvFileName = &fileconv;
637 #endif // __WXGTK20__
638
639 #if wxUSE_UNICODE
640 // gtk_init() wants UTF-8, not wchar_t, so convert
641 int i;
642 char **argvGTK = new char *[argc + 1];
643 for ( i = 0; i < argc; i++ )
644 {
645 argvGTK[i] = wxStrdupA(wxConvUTF8.cWX2MB(argv[i]));
646 }
647
648 argvGTK[argc] = NULL;
649
650 int argcGTK = argc;
651
652 #ifdef __WXGPE__
653 init_result = true; // is there a _check() version of this?
654 gpe_application_init( &argcGTK, &argvGTK );
655 #else
656 init_result = gtk_init_check( &argcGTK, &argvGTK );
657 #endif
658
659 if ( argcGTK != argc )
660 {
661 // we have to drop the parameters which were consumed by GTK+
662 for ( i = 0; i < argcGTK; i++ )
663 {
664 while ( strcmp(wxConvUTF8.cWX2MB(argv[i]), argvGTK[i]) != 0 )
665 {
666 memmove(argv + i, argv + i + 1, argc - i);
667 }
668 }
669
670 argc = argcGTK;
671 }
672 //else: gtk_init() didn't modify our parameters
673
674 // free our copy
675 for ( i = 0; i < argcGTK; i++ )
676 {
677 free(argvGTK[i]);
678 }
679
680 delete [] argvGTK;
681 #else // !wxUSE_UNICODE
682 // gtk_init() shouldn't actually change argv itself (just its contents) so
683 // it's ok to pass pointer to it
684 init_result = gtk_init_check( &argc, &argv );
685 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
686
687 if (!init_result) {
688 wxLogError(wxT("Unable to initialize gtk, is DISPLAY set properly?"));
689 return false;
690 }
691
692 // we can not enter threads before gtk_init is done
693 gdk_threads_enter();
694
695 if ( !wxAppBase::Initialize(argc, argv) )
696 {
697 gdk_threads_leave();
698
699 return false;
700 }
701
702 wxSetDetectableAutoRepeat( TRUE );
703
704 #if wxUSE_INTL
705 wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
706 #endif
707
708 return true;
709 }
710
711 void wxApp::CleanUp()
712 {
713 gdk_threads_leave();
714
715 wxAppBase::CleanUp();
716 }
717
718 #ifdef __WXDEBUG__
719
720 void wxApp::OnAssert(const wxChar *file, int line, const wxChar* cond, const wxChar *msg)
721 {
722 m_isInAssert = TRUE;
723
724 wxAppBase::OnAssert(file, line, cond, msg);
725
726 m_isInAssert = FALSE;
727 }
728
729 #endif // __WXDEBUG__
730
731 void wxApp::RemoveIdleTag()
732 {
733 #if wxUSE_THREADS
734 wxMutexLocker lock(gs_idleTagsMutex);
735 #endif
736 if (!g_isIdle)
737 {
738 gtk_idle_remove( wxTheApp->m_idleTag );
739 wxTheApp->m_idleTag = 0;
740 g_isIdle = TRUE;
741 }
742 }