src/gtk/app.cpp

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