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