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 = 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 bool wxApp::DoYield(bool onlyIfNeeded, long eventsToProcess)
 107 {
 108     if ( m_isInsideYield )
 109     {
 110         if ( !onlyIfNeeded )
 111         {
 112             wxFAIL_MSG( wxT("wxYield called recursively" ) );
 113         }
 114
 115         return false;
 116     }
 117
 118 #if wxUSE_THREADS
 119     if ( !wxThread::IsMain() )
 120     {
 121         // can't call gtk_main_iteration() from other threads like this
 122         return true;
 123     }
 124 #endif // wxUSE_THREADS
 125
 126     m_isInsideYield = true;
 127     m_eventsToProcessInsideYield = eventsToProcess;
 128
 129     // We need to remove idle callbacks or the loop will
 130     // never finish.
 131     wxTheApp->RemoveIdleTag();
 132
 133 #if wxUSE_LOG
 134     // disable log flushing from here because a call to wxYield() shouldn't
 135     // normally result in message boxes popping up &c
 136     wxLog::Suspend();
 137 #endif
 138
 139     // TODO: implement event filtering using the eventsToProcess mask
 140     while (gtk_events_pending())
 141         gtk_main_iteration();
 142
 143     // It's necessary to call ProcessIdle() to update the frames sizes which
 144     // might have been changed (it also will update other things set from
 145     // OnUpdateUI() which is a nice (and desired) side effect). But we
 146     // call ProcessIdle() only once since this is not meant for longish
 147     // background jobs (controlled by wxIdleEvent::RequestMore() and the
 148     // return value of Processidle().
 149     ProcessIdle();
 150
 151 #if wxUSE_LOG
 152     // let the logs be flashed again
 153     wxLog::Resume();
 154 #endif
 155
 156     m_isInsideYield = false;
 157
 158     return true;
 159 }
 160
 161 //-----------------------------------------------------------------------------
 162 // wxWakeUpIdle
 163 //-----------------------------------------------------------------------------
 164
 165 // RR/KH: The wxMutexGui calls are not needed on GTK2 according to
 166 // the GTK faq, http://www.gtk.org/faq/#AEN500
 167 // The calls to gdk_threads_enter() and leave() are specifically noted
 168 // as not being necessary.  The MutexGui calls are still left in for GTK1.
 169 // Eliminating the MutexGui calls fixes the long-standing "random" lockup
 170 // when using wxPostEvent (which calls WakeUpIdle) from a thread.
 171
 172 void wxApp::WakeUpIdle()
 173 {
 174 #if wxUSE_THREADS
 175     if (!wxThread::IsMain())
 176         wxMutexGuiEnter();
 177 #endif // wxUSE_THREADS
 178
 179     wxapp_install_idle_handler();
 180
 181 #if wxUSE_THREADS
 182     if (!wxThread::IsMain())
 183         wxMutexGuiLeave();
 184 #endif // wxUSE_THREADS
 185 }
 186
 187 //-----------------------------------------------------------------------------
 188 // local functions
 189 //-----------------------------------------------------------------------------
 190
 191 // the callback functions must be extern "C" to comply with GTK+ declarations
 192 extern "C"
 193 {
 194
 195 static gint wxapp_pending_callback( gpointer WXUNUSED(data) )
 196 {
 197     if (!wxTheApp) return TRUE;
 198
 199     // When getting called from GDK's time-out handler
 200     // we are no longer within GDK's grab on the GUI
 201     // thread so we must lock it here ourselves.
 202     gdk_threads_enter();
 203
 204     // Sent idle event to all who request them.
 205     wxTheApp->ProcessPendingEvents();
 206
 207     {
 208 #if wxUSE_THREADS
 209         wxMutexLocker lock(gs_idleTagsMutex);
 210 #endif
 211         g_pendingTag = 0;
 212     }
 213
 214     // Flush the logged messages if any.
 215 #if wxUSE_LOG
 216     wxLog::FlushActive();
 217 #endif // wxUSE_LOG
 218
 219     // Release lock again
 220     gdk_threads_leave();
 221
 222     // Return FALSE to indicate that no more idle events are
 223     // to be sent (single shot instead of continuous stream)
 224     return FALSE;
 225 }
 226
 227 static gint wxapp_idle_callback( gpointer WXUNUSED(data) )
 228 {
 229     if (!wxTheApp)
 230         return TRUE;
 231
 232 #ifdef __WXDEBUG__
 233     // don't generate the idle events while the assert modal dialog is shown,
 234     // this completely confuses the apps which don't expect to be reentered
 235     // from some safely-looking functions
 236     if ( wxTheApp->IsInAssert() )
 237     {
 238         // But repaint the assertion message if necessary
 239         if (wxTopLevelWindows.GetCount() > 0)
 240         {
 241             wxWindow* win = (wxWindow*) wxTopLevelWindows.GetLast()->GetData();
 242             if (win->IsKindOf(CLASSINFO(wxGenericMessageDialog)))
 243                 win->OnInternalIdle();
 244         }
 245         return TRUE;
 246     }
 247 #endif // __WXDEBUG__
 248
 249     // When getting called from GDK's time-out handler
 250     // we are no longer within GDK's grab on the GUI
 251     // thread so we must lock it here ourselves.
 252     gdk_threads_enter();
 253
 254     // Indicate that we are now in idle mode and event handlers
 255     // will have to reinstall the idle handler again.
 256     {
 257 #if wxUSE_THREADS
 258         wxMutexLocker lock(gs_idleTagsMutex);
 259 #endif
 260         g_isIdle = TRUE;
 261         wxTheApp->m_idleTag = 0;
 262     }
 263
 264     // Send idle event to all who request them as long as
 265     // no events have popped up in the event queue.
 266     while (wxTheApp->ProcessIdle() && (gtk_events_pending() == 0))
 267         ;
 268
 269     // Release lock again
 270     gdk_threads_leave();
 271
 272     // Return FALSE to indicate that no more idle events are
 273     // to be sent (single shot instead of continuous stream).
 274     return FALSE;
 275 }
 276
 277 #if wxUSE_THREADS
 278
 279 #ifdef HAVE_POLL
 280     #define wxPoll poll
 281     #define wxPollFd pollfd
 282 #else // !HAVE_POLL
 283
 284 typedef GPollFD wxPollFd;
 285
 286 int wxPoll(wxPollFd *ufds, unsigned int nfds, int timeout)
 287 {
 288     // convert timeout from ms to struct timeval (s/us)
 289     timeval tv_timeout;
 290     tv_timeout.tv_sec = timeout/1000;
 291     tv_timeout.tv_usec = (timeout%1000)*1000;
 292
 293     // remember the highest fd used here
 294     int fdMax = -1;
 295
 296     // and fill the sets for select()
 297     fd_set readfds;
 298     fd_set writefds;
 299     fd_set exceptfds;
 300     wxFD_ZERO(&readfds);
 301     wxFD_ZERO(&writefds);
 302     wxFD_ZERO(&exceptfds);
 303
 304     unsigned int i;
 305     for ( i = 0; i < nfds; i++ )
 306     {
 307         wxASSERT_MSG( ufds[i].fd < FD_SETSIZE, _T("fd out of range") );
 308
 309         if ( ufds[i].events & G_IO_IN )
 310             wxFD_SET(ufds[i].fd, &readfds);
 311
 312         if ( ufds[i].events & G_IO_PRI )
 313             wxFD_SET(ufds[i].fd, &exceptfds);
 314
 315         if ( ufds[i].events & G_IO_OUT )
 316             wxFD_SET(ufds[i].fd, &writefds);
 317
 318         if ( ufds[i].fd > fdMax )
 319             fdMax = ufds[i].fd;
 320     }
 321
 322     fdMax++;
 323     int res = select(fdMax, &readfds, &writefds, &exceptfds, &tv_timeout);
 324
 325     // translate the results back
 326     for ( i = 0; i < nfds; i++ )
 327     {
 328         ufds[i].revents = 0;
 329
 330         if ( wxFD_ISSET(ufds[i].fd, &readfds ) )
 331             ufds[i].revents |= G_IO_IN;
 332
 333         if ( wxFD_ISSET(ufds[i].fd, &exceptfds ) )
 334             ufds[i].revents |= G_IO_PRI;
 335
 336         if ( wxFD_ISSET(ufds[i].fd, &writefds ) )
 337             ufds[i].revents |= G_IO_OUT;
 338     }
 339
 340     return res;
 341 }
 342
 343 #endif // HAVE_POLL/!HAVE_POLL
 344
 345 static gint wxapp_poll_func( GPollFD *ufds, guint nfds, gint timeout )
 346 {
 347     gdk_threads_enter();
 348
 349     wxMutexGuiLeave();
 350     g_mainThreadLocked = true;
 351
 352     // we rely on the fact that glib GPollFD struct is really just pollfd but
 353     // I wonder how wise is this in the long term (VZ)
 354     gint res = wxPoll( (wxPollFd *) ufds, nfds, timeout );
 355
 356     wxMutexGuiEnter();
 357     g_mainThreadLocked = false;
 358
 359     gdk_threads_leave();
 360
 361     return res;
 362 }
 363
 364 #endif // wxUSE_THREADS
 365
 366 } // extern "C"
 367
 368 void wxapp_install_idle_handler()
 369 {
 370 #if wxUSE_THREADS
 371     wxMutexLocker lock(gs_idleTagsMutex);
 372 #endif
 373
 374     // Don't install the handler if it's already installed. This test *MUST*
 375     // be done when gs_idleTagsMutex is locked!
 376     if (!g_isIdle)
 377         return;
 378
 379     // GD: this assert is raised when using the thread sample (which works)
 380     //     so the test is probably not so easy. Can widget callbacks be
 381     //     triggered from child threads and, if so, for which widgets?
 382     // wxASSERT_MSG( wxThread::IsMain() || gs_WakeUpIdle, wxT("attempt to install idle handler from widget callback in child thread (should be exclusively from wxWakeUpIdle)") );
 383
 384     wxASSERT_MSG( wxTheApp->m_idleTag == 0, wxT("attempt to install idle handler twice") );
 385
 386     g_isIdle = false;
 387
 388     if (g_pendingTag == 0)
 389         g_pendingTag = gtk_idle_add_priority( 900, wxapp_pending_callback, (gpointer) NULL );
 390
 391     // This routine gets called by all event handlers
 392     // indicating that the idle is over. It may also
 393     // get called from other thread for sending events
 394     // to the main thread (and processing these in
 395     // idle time). Very low priority.
 396     wxTheApp->m_idleTag = gtk_idle_add_priority( 1000, wxapp_idle_callback, (gpointer) NULL );
 397 }
 398
 399 static bool wxOKlibc()
 400 {
 401 #if defined(__UNIX__) && defined(__GLIBC__)
 402     // glibc 2.0 uses UTF-8 even when it shouldn't
 403     wchar_t res = 0;
 404     if ((MB_CUR_MAX == 2) &&
 405         (wxMB2WC(&res, "\xdd\xa5", 1) == 1) &&
 406         (res==0x765))
 407     {
 408         // this is UTF-8 allright, check whether that's what we want
 409         char *cur_locale = setlocale(LC_CTYPE, NULL);
 410         if ((strlen(cur_locale) < 4) ||
 411         (strcasecmp(cur_locale + strlen(cur_locale) - 4, "utf8")) ||
 412         (strcasecmp(cur_locale + strlen(cur_locale) - 5, "utf-8"))) {
 413         // nope, don't use libc conversion
 414         return false;
 415         }
 416     }
 417 #endif
 418     return true;
 419 }
 420
 421 //-----------------------------------------------------------------------------
 422 // Access to the root window global
 423 //-----------------------------------------------------------------------------
 424
 425 GtkWidget* wxGetRootWindow()
 426 {
 427     if (gs_RootWindow == NULL)
 428     {
 429         gs_RootWindow = gtk_window_new( GTK_WINDOW_TOPLEVEL );
 430         gtk_widget_realize( gs_RootWindow );
 431     }
 432     return gs_RootWindow;
 433 }
 434
 435 //-----------------------------------------------------------------------------
 436 // wxApp
 437 //-----------------------------------------------------------------------------
 438
 439 IMPLEMENT_DYNAMIC_CLASS(wxApp,wxEvtHandler)
 440
 441 wxApp::wxApp()
 442 {
 443 #ifdef __WXDEBUG__
 444     m_isInAssert = false;
 445 #endif // __WXDEBUG__
 446
 447     m_idleTag = 0;
 448     g_isIdle = TRUE;
 449     wxapp_install_idle_handler();
 450
 451 #if wxUSE_THREADS
 452     g_main_set_poll_func( wxapp_poll_func );
 453 #endif
 454
 455     m_colorCube = (unsigned char*) NULL;
 456
 457     // this is NULL for a "regular" wxApp, but is set (and freed) by a wxGLApp
 458     m_glVisualInfo = NULL;
 459     m_glFBCInfo = NULL;
 460 }
 461
 462 wxApp::~wxApp()
 463 {
 464     if (m_idleTag) gtk_idle_remove( m_idleTag );
 465
 466     if (m_colorCube) free(m_colorCube);
 467 }
 468
 469 bool wxApp::OnInitGui()
 470 {
 471     if ( !wxAppBase::OnInitGui() )
 472         return false;
 473
 474     GdkVisual *visual = gdk_visual_get_system();
 475
 476     // if this is a wxGLApp (derived from wxApp), and we've already
 477     // chosen a specific visual, then derive the GdkVisual from that
 478     if (m_glVisualInfo != NULL)
 479     {
 480         GdkVisual* vis = gdkx_visual_get(
 481             ((XVisualInfo *) m_glVisualInfo) ->visualid );
 482         gtk_widget_set_default_visual( vis );
 483
 484         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 485         gtk_widget_set_default_colormap( colormap );
 486
 487         visual = vis;
 488     }
 489
 490     // On some machines, the default visual is just 256 colours, so
 491     // we make sure we get the best. This can sometimes be wasteful.
 492
 493     else
 494     if ((gdk_visual_get_best() != gdk_visual_get_system()) && (m_useBestVisual))
 495     {
 496         GdkVisual* vis = gdk_visual_get_best();
 497         gtk_widget_set_default_visual( vis );
 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 (!wxOKlibc())
 596         wxConvCurrent = &wxConvLocal;
 597
 598 #if wxUSE_UNICODE
 599     // gtk_init() wants UTF-8, not wchar_t, so convert
 600     int i;
 601     char **argvGTK = new char *[argc + 1];
 602     for ( i = 0; i < argc; i++ )
 603     {
 604         argvGTK[i] = wxStrdupA(wxConvUTF8.cWX2MB(argv[i]));
 605     }
 606
 607     argvGTK[argc] = NULL;
 608
 609     int argcGTK = argc;
 610
 611 #ifdef __WXGPE__
 612     init_result = true;  // is there a _check() version of this?
 613     gpe_application_init( &argcGTK, &argvGTK );
 614 #else
 615     init_result = gtk_init_check( &argcGTK, &argvGTK );
 616 #endif
 617
 618     if ( argcGTK != argc )
 619     {
 620         // we have to drop the parameters which were consumed by GTK+
 621         for ( i = 0; i < argcGTK; i++ )
 622         {
 623             while ( strcmp(wxConvUTF8.cWX2MB(argv[i]), argvGTK[i]) != 0 )
 624             {
 625                 memmove(argv + i, argv + i + 1, argc - i);
 626             }
 627         }
 628
 629         argc = argcGTK;
 630     }
 631     //else: gtk_init() didn't modify our parameters
 632
 633     // free our copy
 634     for ( i = 0; i < argcGTK; i++ )
 635     {
 636         free(argvGTK[i]);
 637     }
 638
 639     delete [] argvGTK;
 640 #else // !wxUSE_UNICODE
 641     // gtk_init() shouldn't actually change argv itself (just its contents) so
 642     // it's ok to pass pointer to it
 643     init_result = gtk_init_check( &argc, &argv );
 644 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 645
 646     if (!init_result) {
 647         wxLogError(wxT("Unable to initialize gtk, is DISPLAY set properly?"));
 648         return false;
 649     }
 650
 651     // we can not enter threads before gtk_init is done
 652     gdk_threads_enter();
 653
 654     if ( !wxAppBase::Initialize(argc, argv) )
 655     {
 656         gdk_threads_leave();
 657
 658         return false;
 659     }
 660
 661     wxSetDetectableAutoRepeat( TRUE );
 662
 663 #if wxUSE_INTL
 664     wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
 665 #endif
 666
 667     return true;
 668 }
 669
 670 void wxApp::CleanUp()
 671 {
 672     gdk_threads_leave();
 673
 674     wxAppBase::CleanUp();
 675 }
 676
 677 #ifdef __WXDEBUG__
 678
 679 void wxApp::OnAssert(const wxChar *file, int line, const wxChar* cond, const wxChar *msg)
 680 {
 681     m_isInAssert = true;
 682
 683     wxAppBase::OnAssert(file, line, cond, msg);
 684
 685     m_isInAssert = false;
 686 }
 687
 688 #endif // __WXDEBUG__
 689
 690 void wxApp::RemoveIdleTag()
 691 {
 692 #if wxUSE_THREADS
 693     wxMutexLocker lock(gs_idleTagsMutex);
 694 #endif
 695     if (!g_isIdle)
 696     {
 697         gtk_idle_remove( wxTheApp->m_idleTag );
 698         wxTheApp->m_idleTag = 0;
 699         g_isIdle = true;
 700     }
 701 }