src/gtk1/app.cpp

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