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     if (!g_isIdle)
 137     {
 138         // We need to remove idle callbacks or the loop will
 139         // never finish.
 140         wxTheApp->RemoveIdleTag();
 141         g_isIdle = TRUE;
 142     }
 143
 144     // disable log flushing from here because a call to wxYield() shouldn't
 145     // normally result in message boxes popping up &c
 146     wxLog::Suspend();
 147
 148     while (gtk_events_pending())
 149         gtk_main_iteration();
 150
 151     // It's necessary to call ProcessIdle() to update the frames sizes which
 152     // might have been changed (it also will update other things set from
 153     // OnUpdateUI() which is a nice (and desired) side effect). But we
 154     // call ProcessIdle() only once since this is not meant for longish
 155     // background jobs (controlled by wxIdleEvent::RequestMore() and the
 156     // return value of Processidle().
 157     ProcessIdle();
 158
 159     // let the logs be flashed again
 160     wxLog::Resume();
 161
 162     wxIsInsideYield = FALSE;
 163
 164     return TRUE;
 165 }
 166
 167 //-----------------------------------------------------------------------------
 168 // wxWakeUpIdle
 169 //-----------------------------------------------------------------------------
 170
 171 // RR/KH: The wxMutexGui calls are not needed on GTK2 according to
 172 // the GTK faq, http://www.gtk.org/faq/#AEN500
 173 // The calls to gdk_threads_enter() and leave() are specifically noted
 174 // as not being necessary.  The MutexGui calls are still left in for GTK1.
 175 // Eliminating the MutexGui calls fixes the long-standing "random" lockup
 176 // when using wxPostEvent (which calls WakeUpIdle) from a thread.
 177
 178 void wxApp::WakeUpIdle()
 179 {
 180 #ifndef __WXGTK20__
 181 #if wxUSE_THREADS
 182     if (!wxThread::IsMain())
 183         wxMutexGuiEnter();
 184 #endif // wxUSE_THREADS_
 185 #endif // __WXGTK2__
 186
 187     if (g_isIdle)
 188         wxapp_install_idle_handler();
 189
 190 #ifndef __WXGTK20__
 191 #if wxUSE_THREADS
 192     if (!wxThread::IsMain())
 193         wxMutexGuiLeave();
 194 #endif // wxUSE_THREADS_
 195 #endif // __WXGTK2__
 196 }
 197
 198 //-----------------------------------------------------------------------------
 199 // local functions
 200 //-----------------------------------------------------------------------------
 201
 202 // the callback functions must be extern "C" to comply with GTK+ declarations
 203 extern "C"
 204 {
 205
 206 static gint wxapp_pending_callback( gpointer WXUNUSED(data) )
 207 {
 208     if (!wxTheApp) return TRUE;
 209
 210     // When getting called from GDK's time-out handler
 211     // we are no longer within GDK's grab on the GUI
 212     // thread so we must lock it here ourselves.
 213     gdk_threads_enter();
 214
 215     // Sent idle event to all who request them.
 216     wxTheApp->ProcessPendingEvents();
 217
 218     {
 219 #if wxUSE_THREADS
 220         wxMutexLocker lock(gs_idleTagsMutex);
 221 #endif
 222         g_pendingTag = 0;
 223     }
 224
 225     // Flush the logged messages if any.
 226 #if wxUSE_LOG
 227     wxLog::FlushActive();
 228 #endif // wxUSE_LOG
 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 static gint wxapp_idle_callback( gpointer WXUNUSED(data) )
 239 {
 240     if (!wxTheApp)
 241         return TRUE;
 242
 243 #ifdef __WXDEBUG__
 244     // don't generate the idle events while the assert modal dialog is shown,
 245     // this completely confuses the apps which don't expect to be reentered
 246     // from some safely-looking functions
 247     if ( wxTheApp->IsInAssert() )
 248     {
 249         // But repaint the assertion message if necessary
 250         if (wxTopLevelWindows.GetCount() > 0)
 251         {
 252             wxWindow* win = (wxWindow*) wxTopLevelWindows.GetLast()->GetData();
 253 #ifdef __WXGTK20__
 254             if (win->IsKindOf(CLASSINFO(wxMessageDialog)))
 255 #else
 256             if (win->IsKindOf(CLASSINFO(wxGenericMessageDialog)))
 257 #endif
 258                 win->OnInternalIdle();
 259         }
 260         return TRUE;
 261     }
 262 #endif // __WXDEBUG__
 263
 264     // When getting called from GDK's time-out handler
 265     // we are no longer within GDK's grab on the GUI
 266     // thread so we must lock it here ourselves.
 267     gdk_threads_enter();
 268
 269     // Indicate that we are now in idle mode and event handlers
 270     // will have to reinstall the idle handler again.
 271     {
 272 #if wxUSE_THREADS
 273         wxMutexLocker lock(gs_idleTagsMutex);
 274 #endif
 275         g_isIdle = TRUE;
 276         wxTheApp->m_idleTag = 0;
 277     }
 278
 279     // Send idle event to all who request them as long as
 280     // no events have popped up in the event queue.
 281     while (wxTheApp->ProcessIdle() && (gtk_events_pending() == 0))
 282         ;
 283
 284     // Release lock again
 285     gdk_threads_leave();
 286
 287     // Return FALSE to indicate that no more idle events are
 288     // to be sent (single shot instead of continuous stream).
 289     return FALSE;
 290 }
 291
 292 #if wxUSE_THREADS
 293
 294 #ifdef HAVE_POLL
 295     #define wxPoll poll
 296     #define wxPollFd pollfd
 297 #else // !HAVE_POLL
 298
 299 typedef GPollFD wxPollFd;
 300
 301 int wxPoll(wxPollFd *ufds, unsigned int nfds, int timeout)
 302 {
 303     // convert timeout from ms to struct timeval (s/us)
 304     timeval tv_timeout;
 305     tv_timeout.tv_sec = timeout/1000;
 306     tv_timeout.tv_usec = (timeout%1000)*1000;
 307
 308     // remember the highest fd used here
 309     int fdMax = -1;
 310
 311     // and fill the sets for select()
 312     fd_set readfds;
 313     fd_set writefds;
 314     fd_set exceptfds;
 315     FD_ZERO(&readfds);
 316     FD_ZERO(&writefds);
 317     FD_ZERO(&exceptfds);
 318
 319     unsigned int i;
 320     for ( i = 0; i < nfds; i++ )
 321     {
 322         wxASSERT_MSG( ufds[i].fd < FD_SETSIZE, _T("fd out of range") );
 323
 324         if ( ufds[i].events & G_IO_IN )
 325             FD_SET(ufds[i].fd, &readfds);
 326
 327         if ( ufds[i].events & G_IO_PRI )
 328             FD_SET(ufds[i].fd, &exceptfds);
 329
 330         if ( ufds[i].events & G_IO_OUT )
 331             FD_SET(ufds[i].fd, &writefds);
 332
 333         if ( ufds[i].fd > fdMax )
 334             fdMax = ufds[i].fd;
 335     }
 336
 337     fdMax++;
 338     int res = select(fdMax, &readfds, &writefds, &exceptfds, &tv_timeout);
 339
 340     // translate the results back
 341     for ( i = 0; i < nfds; i++ )
 342     {
 343         ufds[i].revents = 0;
 344
 345         if ( FD_ISSET(ufds[i].fd, &readfds ) )
 346             ufds[i].revents |= G_IO_IN;
 347
 348         if ( FD_ISSET(ufds[i].fd, &exceptfds ) )
 349             ufds[i].revents |= G_IO_PRI;
 350
 351         if ( FD_ISSET(ufds[i].fd, &writefds ) )
 352             ufds[i].revents |= G_IO_OUT;
 353     }
 354
 355     return res;
 356 }
 357
 358 #endif // HAVE_POLL/!HAVE_POLL
 359
 360 static gint wxapp_poll_func( GPollFD *ufds, guint nfds, gint timeout )
 361 {
 362     gdk_threads_enter();
 363
 364     wxMutexGuiLeave();
 365     g_mainThreadLocked = TRUE;
 366
 367     // we rely on the fact that glib GPollFD struct is really just pollfd but
 368     // I wonder how wise is this in the long term (VZ)
 369     gint res = wxPoll( (wxPollFd *) ufds, nfds, timeout );
 370
 371     wxMutexGuiEnter();
 372     g_mainThreadLocked = FALSE;
 373
 374     gdk_threads_leave();
 375
 376     return res;
 377 }
 378
 379 #endif // wxUSE_THREADS
 380
 381 } // extern "C"
 382
 383 void wxapp_install_idle_handler()
 384 {
 385 #if wxUSE_THREADS
 386     wxMutexLocker lock(gs_idleTagsMutex);
 387 #endif
 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     wxapp_install_idle_handler();
 441
 442 #if wxUSE_THREADS
 443     g_main_set_poll_func( wxapp_poll_func );
 444 #endif
 445
 446     m_colorCube = (unsigned char*) NULL;
 447
 448     // this is NULL for a "regular" wxApp, but is set (and freed) by a wxGLApp
 449     m_glVisualInfo = (void *) NULL;
 450 }
 451
 452 wxApp::~wxApp()
 453 {
 454     if (m_idleTag) gtk_idle_remove( m_idleTag );
 455
 456     if (m_colorCube) free(m_colorCube);
 457 }
 458
 459 bool wxApp::OnInitGui()
 460 {
 461     if ( !wxAppBase::OnInitGui() )
 462         return FALSE;
 463
 464     GdkVisual *visual = gdk_visual_get_system();
 465
 466     // if this is a wxGLApp (derived from wxApp), and we've already
 467     // chosen a specific visual, then derive the GdkVisual from that
 468     if (m_glVisualInfo != NULL)
 469     {
 470 #ifdef __WXGTK20__
 471         // seems gtk_widget_set_default_visual no longer exists?
 472         GdkVisual* vis = gtk_widget_get_default_visual();
 473 #else
 474         GdkVisual* vis = gdkx_visual_get(
 475             ((XVisualInfo *) m_glVisualInfo) ->visualid );
 476         gtk_widget_set_default_visual( vis );
 477 #endif
 478
 479         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 480         gtk_widget_set_default_colormap( colormap );
 481
 482         visual = vis;
 483     }
 484
 485     // On some machines, the default visual is just 256 colours, so
 486     // we make sure we get the best. This can sometimes be wasteful.
 487
 488     else
 489     if ((gdk_visual_get_best() != gdk_visual_get_system()) && (m_useBestVisual))
 490     {
 491 #ifdef __WXGTK20__
 492         /* seems gtk_widget_set_default_visual no longer exists? */
 493         GdkVisual* vis = gtk_widget_get_default_visual();
 494 #else
 495         GdkVisual* vis = gdk_visual_get_best();
 496         gtk_widget_set_default_visual( vis );
 497 #endif
 498
 499         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 500         gtk_widget_set_default_colormap( colormap );
 501
 502         visual = vis;
 503     }
 504
 505     // Nothing to do for 15, 16, 24, 32 bit displays
 506     if (visual->depth > 8) return TRUE;
 507
 508     // initialize color cube for 8-bit color reduction dithering
 509
 510     GdkColormap *cmap = gtk_widget_get_default_colormap();
 511
 512     m_colorCube = (unsigned char*)malloc(32 * 32 * 32);
 513
 514     for (int r = 0; r < 32; r++)
 515     {
 516         for (int g = 0; g < 32; g++)
 517         {
 518             for (int b = 0; b < 32; b++)
 519             {
 520                 int rr = (r << 3) | (r >> 2);
 521                 int gg = (g << 3) | (g >> 2);
 522                 int bb = (b << 3) | (b >> 2);
 523
 524                 int index = -1;
 525
 526                 GdkColor *colors = cmap->colors;
 527                 if (colors)
 528                 {
 529                     int max = 3 * 65536;
 530
 531                     for (int i = 0; i < cmap->size; i++)
 532                     {
 533                         int rdiff = ((rr << 8) - colors[i].red);
 534                         int gdiff = ((gg << 8) - colors[i].green);
 535                         int bdiff = ((bb << 8) - colors[i].blue);
 536                         int sum = ABS (rdiff) + ABS (gdiff) + ABS (bdiff);
 537                         if (sum < max)
 538                         {
 539                             index = i; max = sum;
 540                         }
 541                     }
 542                 }
 543                 else
 544                 {
 545                     // assume 8-bit true or static colors. this really exists
 546                     GdkVisual* vis = gdk_colormap_get_visual( cmap );
 547                     index = (r >> (5 - vis->red_prec)) << vis->red_shift;
 548                     index |= (g >> (5 - vis->green_prec)) << vis->green_shift;
 549                     index |= (b >> (5 - vis->blue_prec)) << vis->blue_shift;
 550                 }
 551                 m_colorCube[ (r*1024) + (g*32) + b ] = index;
 552             }
 553         }
 554     }
 555
 556     return TRUE;
 557 }
 558
 559 GdkVisual *wxApp::GetGdkVisual()
 560 {
 561     GdkVisual *visual = NULL;
 562
 563     if (m_glVisualInfo)
 564         visual = gdkx_visual_get( ((XVisualInfo *) m_glVisualInfo)->visualid );
 565     else
 566         visual = gdk_window_get_visual( wxGetRootWindow()->window );
 567
 568     wxASSERT( visual );
 569
 570     return visual;
 571 }
 572
 573 bool wxApp::Initialize(int& argc, wxChar **argv)
 574 {
 575     bool init_result;
 576
 577 #if wxUSE_THREADS
 578     // GTK 1.2 up to version 1.2.3 has broken threads
 579     if ((gtk_major_version == 1) &&
 580         (gtk_minor_version == 2) &&
 581         (gtk_micro_version < 4))
 582     {
 583         printf( "wxWidgets warning: GUI threading disabled due to outdated GTK version\n" );
 584     }
 585     else
 586     {
 587         if (!g_thread_supported())
 588             g_thread_init(NULL);
 589     }
 590 #endif // wxUSE_THREADS
 591
 592     gtk_set_locale();
 593
 594     // We should have the wxUSE_WCHAR_T test on the _outside_
 595 #if wxUSE_WCHAR_T
 596     #if defined(__WXGTK20__)
 597         // gtk+ 2.0 supports Unicode through UTF-8 strings
 598         wxConvCurrent = &wxConvUTF8;
 599     #else // GTK 1.x
 600         if (!wxOKlibc())
 601             wxConvCurrent = &wxConvLocal;
 602     #endif
 603 #else // !wxUSE_WCHAR_T
 604     if (!wxOKlibc())
 605         wxConvCurrent = (wxMBConv*) NULL;
 606 #endif // wxUSE_WCHAR_T/!wxUSE_WCHAR_T
 607
 608 #if wxUSE_UNICODE
 609     // gtk_init() wants UTF-8, not wchar_t, so convert
 610     int i;
 611     char **argvGTK = new char *[argc + 1];
 612     for ( i = 0; i < argc; i++ )
 613     {
 614         argvGTK[i] = wxStrdupA(wxConvUTF8.cWX2MB(argv[i]));
 615     }
 616
 617     argvGTK[argc] = NULL;
 618
 619     int argcGTK = argc;
 620
 621 #ifdef __WXGPE__
 622     init_result = true;  // is there a _check() version of this?
 623     gpe_application_init( &argcGTK, &argvGTK );
 624 #else
 625     init_result = gtk_init_check( &argcGTK, &argvGTK );
 626 #endif
 627
 628     if ( argcGTK != argc )
 629     {
 630         // we have to drop the parameters which were consumed by GTK+
 631         for ( i = 0; i < argcGTK; i++ )
 632         {
 633             while ( strcmp(wxConvUTF8.cWX2MB(argv[i]), argvGTK[i]) != 0 )
 634             {
 635                 memmove(argv + i, argv + i + 1, argc - i);
 636             }
 637         }
 638
 639         argc = argcGTK;
 640     }
 641     //else: gtk_init() didn't modify our parameters
 642
 643     // free our copy
 644     for ( i = 0; i < argcGTK; i++ )
 645     {
 646         free(argvGTK[i]);
 647     }
 648
 649     delete [] argvGTK;
 650 #else // !wxUSE_UNICODE
 651     // gtk_init() shouldn't actually change argv itself (just its contents) so
 652     // it's ok to pass pointer to it
 653     init_result = gtk_init_check( &argc, &argv );
 654 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 655
 656     if (!init_result) {
 657         wxLogError(wxT("Unable to initialize gtk, is DISPLAY set properly?"));
 658         return false;
 659     }
 660
 661     // we can not enter threads before gtk_init is done
 662     gdk_threads_enter();
 663
 664     if ( !wxAppBase::Initialize(argc, argv) )
 665     {
 666         gdk_threads_leave();
 667
 668         return false;
 669     }
 670
 671     wxSetDetectableAutoRepeat( TRUE );
 672
 673 #if wxUSE_INTL
 674     wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
 675 #endif
 676
 677     return true;
 678 }
 679
 680 void wxApp::CleanUp()
 681 {
 682     gdk_threads_leave();
 683
 684     wxAppBase::CleanUp();
 685 }
 686
 687 #ifdef __WXDEBUG__
 688
 689 void wxApp::OnAssert(const wxChar *file, int line, const wxChar* cond, const wxChar *msg)
 690 {
 691     m_isInAssert = TRUE;
 692
 693     wxAppBase::OnAssert(file, line, cond, msg);
 694
 695     m_isInAssert = FALSE;
 696 }
 697
 698 #endif // __WXDEBUG__
 699
 700 void wxApp::RemoveIdleTag()
 701 {
 702 #if wxUSE_THREADS
 703     wxMutexLocker lock(gs_idleTagsMutex);
 704 #endif
 705     gtk_idle_remove( wxTheApp->m_idleTag );
 706     wxTheApp->m_idleTag = 0;
 707 }