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: No wxMutexGui calls are needed here according to the GTK faq,
 168 // http://www.gtk.org/faq/#AEN500 - this caused problems for wxPostEvent.
 169
 170 void wxApp::WakeUpIdle()
 171 {
 172     wxapp_install_idle_handler();
 173 }
 174
 175 //-----------------------------------------------------------------------------
 176 // local functions
 177 //-----------------------------------------------------------------------------
 178
 179 // the callback functions must be extern "C" to comply with GTK+ declarations
 180 extern "C"
 181 {
 182
 183 static gint wxapp_pending_callback( gpointer WXUNUSED(data) )
 184 {
 185     if (!wxTheApp) return TRUE;
 186
 187     // When getting called from GDK's time-out handler
 188     // we are no longer within GDK's grab on the GUI
 189     // thread so we must lock it here ourselves.
 190     gdk_threads_enter();
 191
 192     // Sent idle event to all who request them.
 193     wxTheApp->ProcessPendingEvents();
 194
 195     {
 196 #if wxUSE_THREADS
 197         wxMutexLocker lock(gs_idleTagsMutex);
 198 #endif
 199         g_pendingTag = 0;
 200     }
 201
 202     // Flush the logged messages if any.
 203 #if wxUSE_LOG
 204     wxLog::FlushActive();
 205 #endif // wxUSE_LOG
 206
 207     // Release lock again
 208     gdk_threads_leave();
 209
 210     // Return FALSE to indicate that no more idle events are
 211     // to be sent (single shot instead of continuous stream)
 212     return FALSE;
 213 }
 214
 215 static gint wxapp_idle_callback( gpointer WXUNUSED(data) )
 216 {
 217     if (!wxTheApp)
 218         return TRUE;
 219
 220 #ifdef __WXDEBUG__
 221     // don't generate the idle events while the assert modal dialog is shown,
 222     // this completely confuses the apps which don't expect to be reentered
 223     // from some safely-looking functions
 224     if ( wxTheApp->IsInAssert() )
 225     {
 226         // But repaint the assertion message if necessary
 227         if (wxTopLevelWindows.GetCount() > 0)
 228         {
 229             wxWindow* win = (wxWindow*) wxTopLevelWindows.GetLast()->GetData();
 230             if (win->IsKindOf(CLASSINFO(wxMessageDialog)))
 231                 win->OnInternalIdle();
 232         }
 233         return TRUE;
 234     }
 235 #endif // __WXDEBUG__
 236
 237     // When getting called from GDK's time-out handler
 238     // we are no longer within GDK's grab on the GUI
 239     // thread so we must lock it here ourselves.
 240     gdk_threads_enter();
 241
 242     // Indicate that we are now in idle mode and event handlers
 243     // will have to reinstall the idle handler again.
 244     {
 245 #if wxUSE_THREADS
 246         wxMutexLocker lock(gs_idleTagsMutex);
 247 #endif
 248         g_isIdle = TRUE;
 249         wxTheApp->m_idleTag = 0;
 250     }
 251
 252     bool moreIdles = false;
 253
 254     // Send idle event to all who request them as long as
 255     // no events have popped up in the event queue.
 256     while (moreIdles = wxTheApp->ProcessIdle() && (gtk_events_pending() == 0))
 257         ;
 258
 259     // Release lock again
 260     gdk_threads_leave();
 261
 262     // Return FALSE if no more idle events are to be sent
 263     return moreIdles;
 264 }
 265
 266 #if wxUSE_THREADS
 267
 268 #ifdef HAVE_POLL
 269     #define wxPoll poll
 270     #define wxPollFd pollfd
 271 #else // !HAVE_POLL
 272
 273 typedef GPollFD wxPollFd;
 274
 275 int wxPoll(wxPollFd *ufds, unsigned int nfds, int timeout)
 276 {
 277     // convert timeout from ms to struct timeval (s/us)
 278     timeval tv_timeout;
 279     tv_timeout.tv_sec = timeout/1000;
 280     tv_timeout.tv_usec = (timeout%1000)*1000;
 281
 282     // remember the highest fd used here
 283     int fdMax = -1;
 284
 285     // and fill the sets for select()
 286     fd_set readfds;
 287     fd_set writefds;
 288     fd_set exceptfds;
 289     wxFD_ZERO(&readfds);
 290     wxFD_ZERO(&writefds);
 291     wxFD_ZERO(&exceptfds);
 292
 293     unsigned int i;
 294     for ( i = 0; i < nfds; i++ )
 295     {
 296         wxASSERT_MSG( ufds[i].fd < wxFD_SETSIZE, _T("fd out of range") );
 297
 298         if ( ufds[i].events & G_IO_IN )
 299             wxFD_SET(ufds[i].fd, &readfds);
 300
 301         if ( ufds[i].events & G_IO_PRI )
 302             wxFD_SET(ufds[i].fd, &exceptfds);
 303
 304         if ( ufds[i].events & G_IO_OUT )
 305             wxFD_SET(ufds[i].fd, &writefds);
 306
 307         if ( ufds[i].fd > fdMax )
 308             fdMax = ufds[i].fd;
 309     }
 310
 311     fdMax++;
 312     int res = select(fdMax, &readfds, &writefds, &exceptfds, &tv_timeout);
 313
 314     // translate the results back
 315     for ( i = 0; i < nfds; i++ )
 316     {
 317         ufds[i].revents = 0;
 318
 319         if ( wxFD_ISSET(ufds[i].fd, &readfds ) )
 320             ufds[i].revents |= G_IO_IN;
 321
 322         if ( wxFD_ISSET(ufds[i].fd, &exceptfds ) )
 323             ufds[i].revents |= G_IO_PRI;
 324
 325         if ( wxFD_ISSET(ufds[i].fd, &writefds ) )
 326             ufds[i].revents |= G_IO_OUT;
 327     }
 328
 329     return res;
 330 }
 331
 332 #endif // HAVE_POLL/!HAVE_POLL
 333
 334 static gint wxapp_poll_func( GPollFD *ufds, guint nfds, gint timeout )
 335 {
 336     gdk_threads_enter();
 337
 338     wxMutexGuiLeave();
 339     g_mainThreadLocked = TRUE;
 340
 341     // we rely on the fact that glib GPollFD struct is really just pollfd but
 342     // I wonder how wise is this in the long term (VZ)
 343     gint res = wxPoll( (wxPollFd *) ufds, nfds, timeout );
 344
 345     wxMutexGuiEnter();
 346     g_mainThreadLocked = FALSE;
 347
 348     gdk_threads_leave();
 349
 350     return res;
 351 }
 352
 353 #endif // wxUSE_THREADS
 354
 355 } // extern "C"
 356
 357 void wxapp_install_idle_handler()
 358 {
 359 #if wxUSE_THREADS
 360     wxMutexLocker lock(gs_idleTagsMutex);
 361 #endif
 362
 363     // Don't install the handler if it's already installed. This test *MUST*
 364     // be done when gs_idleTagsMutex is locked!
 365     if (!g_isIdle)
 366         return;
 367
 368     // GD: this assert is raised when using the thread sample (which works)
 369     //     so the test is probably not so easy. Can widget callbacks be
 370     //     triggered from child threads and, if so, for which widgets?
 371     // wxASSERT_MSG( wxThread::IsMain() || gs_WakeUpIdle, wxT("attempt to install idle handler from widget callback in child thread (should be exclusively from wxWakeUpIdle)") );
 372
 373     wxASSERT_MSG( wxTheApp->m_idleTag == 0, wxT("attempt to install idle handler twice") );
 374
 375     g_isIdle = FALSE;
 376
 377     if (g_pendingTag == 0)
 378         g_pendingTag = g_idle_add_full( 900, wxapp_pending_callback, NULL, NULL );
 379
 380     // This routine gets called by all event handlers
 381     // indicating that the idle is over. It may also
 382     // get called from other thread for sending events
 383     // to the main thread (and processing these in
 384     // idle time). Very low priority.
 385     wxTheApp->m_idleTag = g_idle_add_full( 1000, wxapp_idle_callback, NULL, NULL );
 386 }
 387
 388 //-----------------------------------------------------------------------------
 389 // Access to the root window global
 390 //-----------------------------------------------------------------------------
 391
 392 GtkWidget* wxGetRootWindow()
 393 {
 394     if (gs_RootWindow == NULL)
 395     {
 396         gs_RootWindow = gtk_window_new( GTK_WINDOW_TOPLEVEL );
 397         gtk_widget_realize( gs_RootWindow );
 398     }
 399     return gs_RootWindow;
 400 }
 401
 402 //-----------------------------------------------------------------------------
 403 // wxApp
 404 //-----------------------------------------------------------------------------
 405
 406 IMPLEMENT_DYNAMIC_CLASS(wxApp,wxEvtHandler)
 407
 408 BEGIN_EVENT_TABLE(wxApp, wxEvtHandler)
 409     EVT_IDLE(wxAppBase::OnIdle)
 410 END_EVENT_TABLE()
 411
 412 wxApp::wxApp()
 413 {
 414 #ifdef __WXDEBUG__
 415     m_isInAssert = FALSE;
 416 #endif // __WXDEBUG__
 417
 418     m_idleTag = 0;
 419     g_isIdle = TRUE;
 420     wxapp_install_idle_handler();
 421
 422 #if wxUSE_THREADS
 423     g_main_context_set_poll_func( NULL, wxapp_poll_func );
 424 #endif
 425
 426     m_colorCube = (unsigned char*) NULL;
 427
 428     // this is NULL for a "regular" wxApp, but is set (and freed) by a wxGLApp
 429     m_glVisualInfo = (void *) NULL;
 430     m_glFBCInfo = (void *) NULL;
 431 }
 432
 433 wxApp::~wxApp()
 434 {
 435     if (m_idleTag)
 436         g_source_remove( m_idleTag );
 437
 438     if (m_colorCube)
 439         free(m_colorCube);
 440 }
 441
 442 bool wxApp::OnInitGui()
 443 {
 444     if ( !wxAppBase::OnInitGui() )
 445         return FALSE;
 446
 447     GdkVisual *visual = gdk_visual_get_system();
 448
 449     // if this is a wxGLApp (derived from wxApp), and we've already
 450     // chosen a specific visual, then derive the GdkVisual from that
 451     if (m_glVisualInfo != NULL)
 452     {
 453         // seems gtk_widget_set_default_visual no longer exists?
 454         GdkVisual* vis = gtk_widget_get_default_visual();
 455
 456         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 457         gtk_widget_set_default_colormap( colormap );
 458
 459         visual = vis;
 460     }
 461
 462     // On some machines, the default visual is just 256 colours, so
 463     // we make sure we get the best. This can sometimes be wasteful.
 464
 465     else
 466     if ((gdk_visual_get_best() != gdk_visual_get_system()) && (m_useBestVisual))
 467     {
 468         /* seems gtk_widget_set_default_visual no longer exists? */
 469         GdkVisual* vis = gtk_widget_get_default_visual();
 470
 471         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 472         gtk_widget_set_default_colormap( colormap );
 473
 474         visual = vis;
 475     }
 476
 477     // Nothing to do for 15, 16, 24, 32 bit displays
 478     if (visual->depth > 8) return TRUE;
 479
 480     // initialize color cube for 8-bit color reduction dithering
 481
 482     GdkColormap *cmap = gtk_widget_get_default_colormap();
 483
 484     m_colorCube = (unsigned char*)malloc(32 * 32 * 32);
 485
 486     for (int r = 0; r < 32; r++)
 487     {
 488         for (int g = 0; g < 32; g++)
 489         {
 490             for (int b = 0; b < 32; b++)
 491             {
 492                 int rr = (r << 3) | (r >> 2);
 493                 int gg = (g << 3) | (g >> 2);
 494                 int bb = (b << 3) | (b >> 2);
 495
 496                 int index = -1;
 497
 498                 GdkColor *colors = cmap->colors;
 499                 if (colors)
 500                 {
 501                     int max = 3 * 65536;
 502
 503                     for (int i = 0; i < cmap->size; i++)
 504                     {
 505                         int rdiff = ((rr << 8) - colors[i].red);
 506                         int gdiff = ((gg << 8) - colors[i].green);
 507                         int bdiff = ((bb << 8) - colors[i].blue);
 508                         int sum = ABS (rdiff) + ABS (gdiff) + ABS (bdiff);
 509                         if (sum < max)
 510                         {
 511                             index = i; max = sum;
 512                         }
 513                     }
 514                 }
 515                 else
 516                 {
 517                     // assume 8-bit true or static colors. this really exists
 518                     GdkVisual* vis = gdk_colormap_get_visual( cmap );
 519                     index = (r >> (5 - vis->red_prec)) << vis->red_shift;
 520                     index |= (g >> (5 - vis->green_prec)) << vis->green_shift;
 521                     index |= (b >> (5 - vis->blue_prec)) << vis->blue_shift;
 522                 }
 523                 m_colorCube[ (r*1024) + (g*32) + b ] = index;
 524             }
 525         }
 526     }
 527
 528     return TRUE;
 529 }
 530
 531 GdkVisual *wxApp::GetGdkVisual()
 532 {
 533     GdkVisual *visual = NULL;
 534
 535     if (m_glVisualInfo)
 536         visual = gdkx_visual_get( ((XVisualInfo *) m_glVisualInfo)->visualid );
 537     else
 538         visual = gdk_window_get_visual( wxGetRootWindow()->window );
 539
 540     wxASSERT( visual );
 541
 542     return visual;
 543 }
 544
 545 bool wxApp::Initialize(int& argc, wxChar **argv)
 546 {
 547     bool init_result;
 548
 549 #if wxUSE_THREADS
 550     // GTK 1.2 up to version 1.2.3 has broken threads
 551     if ((gtk_major_version == 1) &&
 552         (gtk_minor_version == 2) &&
 553         (gtk_micro_version < 4))
 554     {
 555         printf( "wxWidgets warning: GUI threading disabled due to outdated GTK version\n" );
 556     }
 557     else
 558     {
 559         if (!g_thread_supported())
 560             g_thread_init(NULL);
 561     }
 562 #endif // wxUSE_THREADS
 563
 564     gtk_set_locale();
 565
 566     // We should have the wxUSE_WCHAR_T test on the _outside_
 567 #if wxUSE_WCHAR_T
 568     // gtk+ 2.0 supports Unicode through UTF-8 strings
 569     wxConvCurrent = &wxConvUTF8;
 570 #else // !wxUSE_WCHAR_T
 571     if (!wxOKlibc())
 572         wxConvCurrent = (wxMBConv*) NULL;
 573 #endif // wxUSE_WCHAR_T/!wxUSE_WCHAR_T
 574
 575     // decide which conversion to use for the file names
 576
 577     // (1) this variable exists for the sole purpose of specifying the encoding
 578     //     of the filenames for GTK+ programs, so use it if it is set
 579     wxString encName(wxGetenv(_T("G_FILENAME_ENCODING")));
 580     encName = encName.BeforeFirst(_T(','));
 581     if (encName == _T("@locale"))
 582         encName.clear();
 583     encName.MakeUpper();
 584 #if wxUSE_INTL
 585     if (encName.empty())
 586     {
 587         // (2) if a non default locale is set, assume that the user wants his
 588         //     filenames in this locale too
 589         encName = wxLocale::GetSystemEncodingName().Upper();
 590         // (3) finally use UTF-8 by default
 591         if (encName.empty() || encName == _T("US-ASCII"))
 592             encName = _T("UTF-8");
 593         wxSetEnv(_T("G_FILENAME_ENCODING"), encName);
 594     }
 595 #else
 596     if (encName.empty())
 597         encName = _T("UTF-8");
 598 #endif // wxUSE_INTL
 599     static wxConvBrokenFileNames fileconv(encName);
 600     wxConvFileName = &fileconv;
 601
 602 #if wxUSE_UNICODE
 603     // gtk_init() wants UTF-8, not wchar_t, so convert
 604     int i;
 605     char **argvGTK = new char *[argc + 1];
 606     for ( i = 0; i < argc; i++ )
 607     {
 608         argvGTK[i] = wxStrdupA(wxConvUTF8.cWX2MB(argv[i]));
 609     }
 610
 611     argvGTK[argc] = NULL;
 612
 613     int argcGTK = argc;
 614
 615 #ifdef __WXGPE__
 616     init_result = true;  // is there a _check() version of this?
 617     gpe_application_init( &argcGTK, &argvGTK );
 618 #else
 619     init_result = gtk_init_check( &argcGTK, &argvGTK );
 620 #endif
 621
 622     if ( argcGTK != argc )
 623     {
 624         // we have to drop the parameters which were consumed by GTK+
 625         for ( i = 0; i < argcGTK; i++ )
 626         {
 627             while ( strcmp(wxConvUTF8.cWX2MB(argv[i]), argvGTK[i]) != 0 )
 628             {
 629                 memmove(argv + i, argv + i + 1, argc - i);
 630             }
 631         }
 632
 633         argc = argcGTK;
 634     }
 635     //else: gtk_init() didn't modify our parameters
 636
 637     // free our copy
 638     for ( i = 0; i < argcGTK; i++ )
 639     {
 640         free(argvGTK[i]);
 641     }
 642
 643     delete [] argvGTK;
 644 #else // !wxUSE_UNICODE
 645     // gtk_init() shouldn't actually change argv itself (just its contents) so
 646     // it's ok to pass pointer to it
 647     init_result = gtk_init_check( &argc, &argv );
 648 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 649
 650     if (!init_result) {
 651         wxLogError(wxT("Unable to initialize gtk, is DISPLAY set properly?"));
 652         return false;
 653     }
 654
 655     // we can not enter threads before gtk_init is done
 656     gdk_threads_enter();
 657
 658     if ( !wxAppBase::Initialize(argc, argv) )
 659     {
 660         gdk_threads_leave();
 661
 662         return false;
 663     }
 664
 665     wxSetDetectableAutoRepeat( TRUE );
 666
 667 #if wxUSE_INTL
 668     wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
 669 #endif
 670
 671     return true;
 672 }
 673
 674 void wxApp::CleanUp()
 675 {
 676     gdk_threads_leave();
 677
 678     wxAppBase::CleanUp();
 679 }
 680
 681 #ifdef __WXDEBUG__
 682
 683 void wxApp::OnAssert(const wxChar *file, int line, const wxChar* cond, const wxChar *msg)
 684 {
 685     m_isInAssert = TRUE;
 686
 687     wxAppBase::OnAssert(file, line, cond, msg);
 688
 689     m_isInAssert = FALSE;
 690 }
 691
 692 #endif // __WXDEBUG__
 693
 694 void wxApp::RemoveIdleTag()
 695 {
 696 #if wxUSE_THREADS
 697     wxMutexLocker lock(gs_idleTagsMutex);
 698 #endif
 699     if (!g_isIdle)
 700     {
 701         g_source_remove( wxTheApp->m_idleTag );
 702         wxTheApp->m_idleTag = 0;
 703         g_isIdle = TRUE;
 704     }
 705 }