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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  11     #pragma implementation "app.h"
  12 #endif
  13
  14 #ifdef __VMS
  15 // vms_jackets.h should for proper working be included before anything else
  16 # include <vms_jackets.h>
  17 #undef ConnectionNumber
  18 #endif
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #include "wx/app.h"
  24 #include "wx/gdicmn.h"
  25 #include "wx/utils.h"
  26 #include "wx/intl.h"
  27 #include "wx/log.h"
  28 #include "wx/memory.h"
  29 #include "wx/font.h"
  30 #include "wx/settings.h"
  31 #include "wx/dialog.h"
  32 #include "wx/msgdlg.h"
  33 #include "wx/file.h"
  34 #include "wx/filename.h"
  35 #include "wx/module.h"
  36 #include "wx/image.h"
  37 #include "wx/thread.h"
  38
  39 #ifdef __WXGPE__
  40 #include <gpe/init.h>
  41 #endif
  42
  43 #ifdef __WXUNIVERSAL__
  44     #include "wx/univ/theme.h"
  45     #include "wx/univ/renderer.h"
  46 #endif
  47
  48 #if wxUSE_THREADS
  49     #include "wx/thread.h"
  50 #endif
  51
  52 #include <unistd.h>
  53
  54 #ifdef HAVE_POLL
  55     #if defined(__VMS)
  56         #include <poll.h>
  57     #else
  58         // bug in the OpenBSD headers: at least in 3.1 there is no extern "C"
  59         // in neither poll.h nor sys/poll.h which results in link errors later
  60         #ifdef __OPENBSD__
  61             extern "C"
  62             {
  63         #endif
  64
  65         #include <sys/poll.h>
  66
  67         #ifdef __OPENBSD__
  68             };
  69         #endif
  70     #endif // platform
  71 #else // !HAVE_POLL
  72     // we implement poll() ourselves using select() which is supposed exist in
  73     // all modern Unices
  74     #include <sys/types.h>
  75     #include <sys/time.h>
  76     #include <unistd.h>
  77 #endif // HAVE_POLL/!HAVE_POLL
  78
  79 #include "wx/gtk/win_gtk.h"
  80
  81 #include <gtk/gtk.h>
  82
  83
  84 //-----------------------------------------------------------------------------
  85 // global data
  86 //-----------------------------------------------------------------------------
  87
  88 bool   g_mainThreadLocked = FALSE;
  89 gint   g_pendingTag = 0;
  90
  91 static GtkWidget *gs_RootWindow = (GtkWidget*) NULL;
  92
  93 //-----------------------------------------------------------------------------
  94 // idle system
  95 //-----------------------------------------------------------------------------
  96
  97 extern bool g_isIdle;
  98
  99 void wxapp_install_idle_handler();
 100
 101 #if wxUSE_THREADS
 102 static wxMutex gs_idleTagsMutex;
 103 #endif
 104
 105 //-----------------------------------------------------------------------------
 106 // wxYield
 107 //-----------------------------------------------------------------------------
 108
 109 // not static because used by textctrl.cpp
 110 //
 111 // MT-FIXME
 112 bool wxIsInsideYield = FALSE;
 113
 114 bool wxApp::Yield(bool onlyIfNeeded)
 115 {
 116     if ( wxIsInsideYield )
 117     {
 118         if ( !onlyIfNeeded )
 119         {
 120             wxFAIL_MSG( wxT("wxYield called recursively" ) );
 121         }
 122
 123         return FALSE;
 124     }
 125
 126 #if wxUSE_THREADS
 127     if ( !wxThread::IsMain() )
 128     {
 129         // can't call gtk_main_iteration() from other threads like this
 130         return TRUE;
 131     }
 132 #endif // wxUSE_THREADS
 133
 134     wxIsInsideYield = TRUE;
 135
 136     // We need to remove idle callbacks or the loop will
 137     // never finish.
 138     wxTheApp->RemoveIdleTag();
 139
 140     // disable log flushing from here because a call to wxYield() shouldn't
 141     // normally result in message boxes popping up &c
 142     wxLog::Suspend();
 143
 144     while (gtk_events_pending())
 145         gtk_main_iteration();
 146
 147     // It's necessary to call ProcessIdle() to update the frames sizes which
 148     // might have been changed (it also will update other things set from
 149     // OnUpdateUI() which is a nice (and desired) side effect). But we
 150     // call ProcessIdle() only once since this is not meant for longish
 151     // background jobs (controlled by wxIdleEvent::RequestMore() and the
 152     // return value of Processidle().
 153     ProcessIdle();
 154
 155     // let the logs be flashed again
 156     wxLog::Resume();
 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     FD_ZERO(&readfds);
 311     FD_ZERO(&writefds);
 312     FD_ZERO(&exceptfds);
 313
 314     unsigned int i;
 315     for ( i = 0; i < nfds; i++ )
 316     {
 317         wxASSERT_MSG( ufds[i].fd < FD_SETSIZE, _T("fd out of range") );
 318
 319         if ( ufds[i].events & G_IO_IN )
 320             FD_SET(ufds[i].fd, &readfds);
 321
 322         if ( ufds[i].events & G_IO_PRI )
 323             FD_SET(ufds[i].fd, &exceptfds);
 324
 325         if ( ufds[i].events & G_IO_OUT )
 326             FD_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 ( FD_ISSET(ufds[i].fd, &readfds ) )
 341             ufds[i].revents |= G_IO_IN;
 342
 343         if ( FD_ISSET(ufds[i].fd, &exceptfds ) )
 344             ufds[i].revents |= G_IO_PRI;
 345
 346         if ( FD_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 }
 452
 453 wxApp::~wxApp()
 454 {
 455     if (m_idleTag) gtk_idle_remove( m_idleTag );
 456
 457     if (m_colorCube) free(m_colorCube);
 458 }
 459
 460 bool wxApp::OnInitGui()
 461 {
 462     if ( !wxAppBase::OnInitGui() )
 463         return FALSE;
 464
 465     GdkVisual *visual = gdk_visual_get_system();
 466
 467     // if this is a wxGLApp (derived from wxApp), and we've already
 468     // chosen a specific visual, then derive the GdkVisual from that
 469     if (m_glVisualInfo != NULL)
 470     {
 471 #ifdef __WXGTK20__
 472         // seems gtk_widget_set_default_visual no longer exists?
 473         GdkVisual* vis = gtk_widget_get_default_visual();
 474 #else
 475         GdkVisual* vis = gdkx_visual_get(
 476             ((XVisualInfo *) m_glVisualInfo) ->visualid );
 477         gtk_widget_set_default_visual( vis );
 478 #endif
 479
 480         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 481         gtk_widget_set_default_colormap( colormap );
 482
 483         visual = vis;
 484     }
 485
 486     // On some machines, the default visual is just 256 colours, so
 487     // we make sure we get the best. This can sometimes be wasteful.
 488
 489     else
 490     if ((gdk_visual_get_best() != gdk_visual_get_system()) && (m_useBestVisual))
 491     {
 492 #ifdef __WXGTK20__
 493         /* seems gtk_widget_set_default_visual no longer exists? */
 494         GdkVisual* vis = gtk_widget_get_default_visual();
 495 #else
 496         GdkVisual* vis = gdk_visual_get_best();
 497         gtk_widget_set_default_visual( vis );
 498 #endif
 499
 500         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 501         gtk_widget_set_default_colormap( colormap );
 502
 503         visual = vis;
 504     }
 505
 506     // Nothing to do for 15, 16, 24, 32 bit displays
 507     if (visual->depth > 8) return TRUE;
 508
 509     // initialize color cube for 8-bit color reduction dithering
 510
 511     GdkColormap *cmap = gtk_widget_get_default_colormap();
 512
 513     m_colorCube = (unsigned char*)malloc(32 * 32 * 32);
 514
 515     for (int r = 0; r < 32; r++)
 516     {
 517         for (int g = 0; g < 32; g++)
 518         {
 519             for (int b = 0; b < 32; b++)
 520             {
 521                 int rr = (r << 3) | (r >> 2);
 522                 int gg = (g << 3) | (g >> 2);
 523                 int bb = (b << 3) | (b >> 2);
 524
 525                 int index = -1;
 526
 527                 GdkColor *colors = cmap->colors;
 528                 if (colors)
 529                 {
 530                     int max = 3 * 65536;
 531
 532                     for (int i = 0; i < cmap->size; i++)
 533                     {
 534                         int rdiff = ((rr << 8) - colors[i].red);
 535                         int gdiff = ((gg << 8) - colors[i].green);
 536                         int bdiff = ((bb << 8) - colors[i].blue);
 537                         int sum = ABS (rdiff) + ABS (gdiff) + ABS (bdiff);
 538                         if (sum < max)
 539                         {
 540                             index = i; max = sum;
 541                         }
 542                     }
 543                 }
 544                 else
 545                 {
 546                     // assume 8-bit true or static colors. this really exists
 547                     GdkVisual* vis = gdk_colormap_get_visual( cmap );
 548                     index = (r >> (5 - vis->red_prec)) << vis->red_shift;
 549                     index |= (g >> (5 - vis->green_prec)) << vis->green_shift;
 550                     index |= (b >> (5 - vis->blue_prec)) << vis->blue_shift;
 551                 }
 552                 m_colorCube[ (r*1024) + (g*32) + b ] = index;
 553             }
 554         }
 555     }
 556
 557     return TRUE;
 558 }
 559
 560 GdkVisual *wxApp::GetGdkVisual()
 561 {
 562     GdkVisual *visual = NULL;
 563
 564     if (m_glVisualInfo)
 565         visual = gdkx_visual_get( ((XVisualInfo *) m_glVisualInfo)->visualid );
 566     else
 567         visual = gdk_window_get_visual( wxGetRootWindow()->window );
 568
 569     wxASSERT( visual );
 570
 571     return visual;
 572 }
 573
 574 bool wxApp::Initialize(int& argc, wxChar **argv)
 575 {
 576     bool init_result;
 577
 578 #if wxUSE_THREADS
 579     // GTK 1.2 up to version 1.2.3 has broken threads
 580     if ((gtk_major_version == 1) &&
 581         (gtk_minor_version == 2) &&
 582         (gtk_micro_version < 4))
 583     {
 584         printf( "wxWidgets warning: GUI threading disabled due to outdated GTK version\n" );
 585     }
 586     else
 587     {
 588         if (!g_thread_supported())
 589             g_thread_init(NULL);
 590     }
 591 #endif // wxUSE_THREADS
 592
 593     gtk_set_locale();
 594
 595     // We should have the wxUSE_WCHAR_T test on the _outside_
 596 #if wxUSE_WCHAR_T
 597     #if defined(__WXGTK20__)
 598         // gtk+ 2.0 supports Unicode through UTF-8 strings
 599         wxConvCurrent = &wxConvUTF8;
 600     #else // GTK 1.x
 601         if (!wxOKlibc())
 602             wxConvCurrent = &wxConvLocal;
 603     #endif
 604 #else // !wxUSE_WCHAR_T
 605     if (!wxOKlibc())
 606         wxConvCurrent = (wxMBConv*) NULL;
 607 #endif // wxUSE_WCHAR_T/!wxUSE_WCHAR_T
 608
 609 #if wxUSE_UNICODE
 610     // gtk_init() wants UTF-8, not wchar_t, so convert
 611     int i;
 612     char **argvGTK = new char *[argc + 1];
 613     for ( i = 0; i < argc; i++ )
 614     {
 615         argvGTK[i] = wxStrdupA(wxConvUTF8.cWX2MB(argv[i]));
 616     }
 617
 618     argvGTK[argc] = NULL;
 619
 620     int argcGTK = argc;
 621
 622 #ifdef __WXGPE__
 623     init_result = true;  // is there a _check() version of this?
 624     gpe_application_init( &argcGTK, &argvGTK );
 625 #else
 626     init_result = gtk_init_check( &argcGTK, &argvGTK );
 627 #endif
 628
 629     if ( argcGTK != argc )
 630     {
 631         // we have to drop the parameters which were consumed by GTK+
 632         for ( i = 0; i < argcGTK; i++ )
 633         {
 634             while ( strcmp(wxConvUTF8.cWX2MB(argv[i]), argvGTK[i]) != 0 )
 635             {
 636                 memmove(argv + i, argv + i + 1, argc - i);
 637             }
 638         }
 639
 640         argc = argcGTK;
 641     }
 642     //else: gtk_init() didn't modify our parameters
 643
 644     // free our copy
 645     for ( i = 0; i < argcGTK; i++ )
 646     {
 647         free(argvGTK[i]);
 648     }
 649
 650     delete [] argvGTK;
 651 #else // !wxUSE_UNICODE
 652     // gtk_init() shouldn't actually change argv itself (just its contents) so
 653     // it's ok to pass pointer to it
 654     init_result = gtk_init_check( &argc, &argv );
 655 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 656
 657     if (!init_result) {
 658         wxLogError(wxT("Unable to initialize gtk, is DISPLAY set properly?"));
 659         return false;
 660     }
 661
 662     // we can not enter threads before gtk_init is done
 663     gdk_threads_enter();
 664
 665     if ( !wxAppBase::Initialize(argc, argv) )
 666     {
 667         gdk_threads_leave();
 668
 669         return false;
 670     }
 671
 672     wxSetDetectableAutoRepeat( TRUE );
 673
 674 #if wxUSE_INTL
 675     wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
 676 #endif
 677
 678     return true;
 679 }
 680
 681 void wxApp::CleanUp()
 682 {
 683     gdk_threads_leave();
 684
 685     wxAppBase::CleanUp();
 686 }
 687
 688 #ifdef __WXDEBUG__
 689
 690 void wxApp::OnAssert(const wxChar *file, int line, const wxChar* cond, const wxChar *msg)
 691 {
 692     m_isInAssert = TRUE;
 693
 694     wxAppBase::OnAssert(file, line, cond, msg);
 695
 696     m_isInAssert = FALSE;
 697 }
 698
 699 #endif // __WXDEBUG__
 700
 701 void wxApp::RemoveIdleTag()
 702 {
 703 #if wxUSE_THREADS
 704     wxMutexLocker lock(gs_idleTagsMutex);
 705 #endif
 706     if (!g_isIdle)
 707     {
 708         gtk_idle_remove( wxTheApp->m_idleTag );
 709         wxTheApp->m_idleTag = 0;
 710         g_isIdle = TRUE;
 711     }
 712 }