src/gtk1/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
  38 #ifdef __WXGPE__
  39 #include <gpe/init.h>
  40 #endif
  41
  42 #ifdef __WXUNIVERSAL__
  43     #include "wx/univ/theme.h"
  44     #include "wx/univ/renderer.h"
  45 #endif
  46
  47 #if wxUSE_THREADS
  48     #include "wx/thread.h"
  49 #endif
  50
  51 #include <unistd.h>
  52
  53 #ifdef HAVE_POLL
  54     #if defined(__VMS)
  55         #include <poll.h>
  56     #else
  57         // bug in the OpenBSD headers: at least in 3.1 there is no extern "C"
  58         // in neither poll.h nor sys/poll.h which results in link errors later
  59         #ifdef __OPENBSD__
  60             extern "C"
  61             {
  62         #endif
  63
  64         #include <sys/poll.h>
  65
  66         #ifdef __OPENBSD__
  67             };
  68         #endif
  69     #endif // platform
  70 #else // !HAVE_POLL
  71     // we implement poll() ourselves using select() which is supposed exist in
  72     // all modern Unices
  73     #include <sys/types.h>
  74     #include <sys/time.h>
  75     #include <unistd.h>
  76 #endif // HAVE_POLL/!HAVE_POLL
  77
  78 #include "wx/gtk/win_gtk.h"
  79
  80 #include <gtk/gtk.h>
  81
  82
  83 //-----------------------------------------------------------------------------
  84 // global data
  85 //-----------------------------------------------------------------------------
  86
  87 bool   g_mainThreadLocked = FALSE;
  88 gint   g_pendingTag = 0;
  89
  90 static GtkWidget *gs_RootWindow = (GtkWidget*) NULL;
  91
  92 //-----------------------------------------------------------------------------
  93 // idle system
  94 //-----------------------------------------------------------------------------
  95
  96 extern bool g_isIdle;
  97
  98 void wxapp_install_idle_handler();
  99
 100 //-----------------------------------------------------------------------------
 101 // wxYield
 102 //-----------------------------------------------------------------------------
 103
 104 // not static because used by textctrl.cpp
 105 //
 106 // MT-FIXME
 107 bool wxIsInsideYield = FALSE;
 108
 109 bool wxApp::Yield(bool onlyIfNeeded)
 110 {
 111     if ( wxIsInsideYield )
 112     {
 113         if ( !onlyIfNeeded )
 114         {
 115             wxFAIL_MSG( wxT("wxYield called recursively" ) );
 116         }
 117
 118         return FALSE;
 119     }
 120
 121 #if wxUSE_THREADS
 122     if ( !wxThread::IsMain() )
 123     {
 124         // can't call gtk_main_iteration() from other threads like this
 125         return TRUE;
 126     }
 127 #endif // wxUSE_THREADS
 128
 129     wxIsInsideYield = TRUE;
 130
 131     if (!g_isIdle)
 132     {
 133         // We need to remove idle callbacks or the loop will
 134         // never finish.
 135         gtk_idle_remove( m_idleTag );
 136         m_idleTag = 0;
 137         g_isIdle = TRUE;
 138     }
 139
 140     // disable log flushing from here because a call to wxYield() shouldn't
 141     // normally result in message boxes popping up &c
 142     wxLog::Suspend();
 143
 144     while (gtk_events_pending())
 145         gtk_main_iteration();
 146
 147     // It's necessary to call ProcessIdle() to update the frames sizes which
 148     // might have been changed (it also will update other things set from
 149     // OnUpdateUI() which is a nice (and desired) side effect). But we
 150     // call ProcessIdle() only once since this is not meant for longish
 151     // background jobs (controlled by wxIdleEvent::RequestMore() and the
 152     // return value of Processidle().
 153     ProcessIdle();
 154
 155     // let the logs be flashed again
 156     wxLog::Resume();
 157
 158     wxIsInsideYield = FALSE;
 159
 160     return TRUE;
 161 }
 162
 163 //-----------------------------------------------------------------------------
 164 // wxWakeUpIdle
 165 //-----------------------------------------------------------------------------
 166
 167 void wxApp::WakeUpIdle()
 168 {
 169 #if wxUSE_THREADS
 170     if (!wxThread::IsMain())
 171         wxMutexGuiEnter();
 172 #endif
 173
 174     if (g_isIdle)
 175         wxapp_install_idle_handler();
 176
 177 #if wxUSE_THREADS
 178     if (!wxThread::IsMain())
 179         wxMutexGuiLeave();
 180 #endif
 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     g_pendingTag = 0;
 204
 205     // Flush the logged messages if any.
 206 #if wxUSE_LOG
 207     wxLog::FlushActive();
 208 #endif // wxUSE_LOG
 209
 210     // Release lock again
 211     gdk_threads_leave();
 212
 213     // Return FALSE to indicate that no more idle events are
 214     // to be sent (single shot instead of continuous stream)
 215     return FALSE;
 216 }
 217
 218 static gint wxapp_idle_callback( gpointer WXUNUSED(data) )
 219 {
 220     if (!wxTheApp)
 221         return TRUE;
 222
 223 #ifdef __WXDEBUG__
 224     // don't generate the idle events while the assert modal dialog is shown,
 225     // this completely confuses the apps which don't expect to be reentered
 226     // from some safely-looking functions
 227     if ( wxTheApp->IsInAssert() )
 228     {
 229         // But repaint the assertion message if necessary
 230         if (wxTopLevelWindows.GetCount() > 0)
 231         {
 232             wxWindow* win = (wxWindow*) wxTopLevelWindows.GetLast()->GetData();
 233 #ifdef __WXGTK20__
 234             if (win->IsKindOf(CLASSINFO(wxMessageDialog)))
 235 #else
 236             if (win->IsKindOf(CLASSINFO(wxGenericMessageDialog)))
 237 #endif
 238                 win->OnInternalIdle();
 239         }
 240         return TRUE;
 241     }
 242 #endif // __WXDEBUG__
 243
 244     // When getting called from GDK's time-out handler
 245     // we are no longer within GDK's grab on the GUI
 246     // thread so we must lock it here ourselves.
 247     gdk_threads_enter();
 248
 249     // Indicate that we are now in idle mode and event handlers
 250     // will have to reinstall the idle handler again.
 251     g_isIdle = TRUE;
 252     wxTheApp->m_idleTag = 0;
 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 (wxTheApp->ProcessIdle() && (gtk_events_pending() == 0))
 257         ;
 258
 259     // Release lock again
 260     gdk_threads_leave();
 261
 262     // Return FALSE to indicate that no more idle events are
 263     // to be sent (single shot instead of continuous stream).
 264     return FALSE;
 265 }
 266
 267 #if wxUSE_THREADS
 268
 269 #ifdef HAVE_POLL
 270     #define wxPoll poll
 271     #define wxPollFd pollfd
 272 #else // !HAVE_POLL
 273
 274 typedef GPollFD wxPollFd;
 275
 276 int wxPoll(wxPollFd *ufds, unsigned int nfds, int timeout)
 277 {
 278     // convert timeout from ms to struct timeval (s/us)
 279     timeval tv_timeout;
 280     tv_timeout.tv_sec = timeout/1000;
 281     tv_timeout.tv_usec = (timeout%1000)*1000;
 282
 283     // remember the highest fd used here
 284     int fdMax = -1;
 285
 286     // and fill the sets for select()
 287     fd_set readfds;
 288     fd_set writefds;
 289     fd_set exceptfds;
 290     FD_ZERO(&readfds);
 291     FD_ZERO(&writefds);
 292     FD_ZERO(&exceptfds);
 293
 294     unsigned int i;
 295     for ( i = 0; i < nfds; i++ )
 296     {
 297         wxASSERT_MSG( ufds[i].fd < FD_SETSIZE, _T("fd out of range") );
 298
 299         if ( ufds[i].events & G_IO_IN )
 300             FD_SET(ufds[i].fd, &readfds);
 301
 302         if ( ufds[i].events & G_IO_PRI )
 303             FD_SET(ufds[i].fd, &exceptfds);
 304
 305         if ( ufds[i].events & G_IO_OUT )
 306             FD_SET(ufds[i].fd, &writefds);
 307
 308         if ( ufds[i].fd > fdMax )
 309             fdMax = ufds[i].fd;
 310     }
 311
 312     fdMax++;
 313     int res = select(fdMax, &readfds, &writefds, &exceptfds, &tv_timeout);
 314
 315     // translate the results back
 316     for ( i = 0; i < nfds; i++ )
 317     {
 318         ufds[i].revents = 0;
 319
 320         if ( FD_ISSET(ufds[i].fd, &readfds ) )
 321             ufds[i].revents |= G_IO_IN;
 322
 323         if ( FD_ISSET(ufds[i].fd, &exceptfds ) )
 324             ufds[i].revents |= G_IO_PRI;
 325
 326         if ( FD_ISSET(ufds[i].fd, &writefds ) )
 327             ufds[i].revents |= G_IO_OUT;
 328     }
 329
 330     return res;
 331 }
 332
 333 #endif // HAVE_POLL/!HAVE_POLL
 334
 335 static gint wxapp_poll_func( GPollFD *ufds, guint nfds, gint timeout )
 336 {
 337     gdk_threads_enter();
 338
 339     wxMutexGuiLeave();
 340     g_mainThreadLocked = TRUE;
 341
 342     // we rely on the fact that glib GPollFD struct is really just pollfd but
 343     // I wonder how wise is this in the long term (VZ)
 344     gint res = wxPoll( (wxPollFd *) ufds, nfds, timeout );
 345
 346     wxMutexGuiEnter();
 347     g_mainThreadLocked = FALSE;
 348
 349     gdk_threads_leave();
 350
 351     return res;
 352 }
 353
 354 #endif // wxUSE_THREADS
 355
 356 } // extern "C"
 357
 358 void wxapp_install_idle_handler()
 359 {
 360     // GD: this assert is raised when using the thread sample (which works)
 361     //     so the test is probably not so easy. Can widget callbacks be
 362     //     triggered from child threads and, if so, for which widgets?
 363     // wxASSERT_MSG( wxThread::IsMain() || gs_WakeUpIdle, wxT("attempt to install idle handler from widget callback in child thread (should be exclusively from wxWakeUpIdle)") );
 364
 365     wxASSERT_MSG( wxTheApp->m_idleTag == 0, wxT("attempt to install idle handler twice") );
 366
 367     g_isIdle = FALSE;
 368
 369     if (g_pendingTag == 0)
 370         g_pendingTag = gtk_idle_add_priority( 900, wxapp_pending_callback, (gpointer) NULL );
 371
 372     // This routine gets called by all event handlers
 373     // indicating that the idle is over. It may also
 374     // get called from other thread for sending events
 375     // to the main thread (and processing these in
 376     // idle time). Very low priority.
 377     wxTheApp->m_idleTag = gtk_idle_add_priority( 1000, wxapp_idle_callback, (gpointer) NULL );
 378 }
 379
 380 //-----------------------------------------------------------------------------
 381 // Access to the root window global
 382 //-----------------------------------------------------------------------------
 383
 384 GtkWidget* wxGetRootWindow()
 385 {
 386     if (gs_RootWindow == NULL)
 387     {
 388         gs_RootWindow = gtk_window_new( GTK_WINDOW_TOPLEVEL );
 389         gtk_widget_realize( gs_RootWindow );
 390     }
 391     return gs_RootWindow;
 392 }
 393
 394 //-----------------------------------------------------------------------------
 395 // wxApp
 396 //-----------------------------------------------------------------------------
 397
 398 IMPLEMENT_DYNAMIC_CLASS(wxApp,wxEvtHandler)
 399
 400 BEGIN_EVENT_TABLE(wxApp, wxEvtHandler)
 401     EVT_IDLE(wxAppBase::OnIdle)
 402 END_EVENT_TABLE()
 403
 404 wxApp::wxApp()
 405 {
 406 #ifdef __WXDEBUG__
 407     m_isInAssert = FALSE;
 408 #endif // __WXDEBUG__
 409
 410     m_idleTag = 0;
 411     wxapp_install_idle_handler();
 412
 413 #if wxUSE_THREADS
 414     g_main_set_poll_func( wxapp_poll_func );
 415 #endif
 416
 417     m_colorCube = (unsigned char*) NULL;
 418
 419     // this is NULL for a "regular" wxApp, but is set (and freed) by a wxGLApp
 420     m_glVisualInfo = (void *) NULL;
 421 }
 422
 423 wxApp::~wxApp()
 424 {
 425     if (m_idleTag) gtk_idle_remove( m_idleTag );
 426
 427     if (m_colorCube) free(m_colorCube);
 428 }
 429
 430 bool wxApp::OnInitGui()
 431 {
 432     if ( !wxAppBase::OnInitGui() )
 433         return FALSE;
 434
 435     GdkVisual *visual = gdk_visual_get_system();
 436
 437     // if this is a wxGLApp (derived from wxApp), and we've already
 438     // chosen a specific visual, then derive the GdkVisual from that
 439     if (m_glVisualInfo != NULL)
 440     {
 441 #ifdef __WXGTK20__
 442         // seems gtk_widget_set_default_visual no longer exists?
 443         GdkVisual* vis = gtk_widget_get_default_visual();
 444 #else
 445         GdkVisual* vis = gdkx_visual_get(
 446             ((XVisualInfo *) m_glVisualInfo) ->visualid );
 447         gtk_widget_set_default_visual( vis );
 448 #endif
 449
 450         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 451         gtk_widget_set_default_colormap( colormap );
 452
 453         visual = vis;
 454     }
 455
 456     // On some machines, the default visual is just 256 colours, so
 457     // we make sure we get the best. This can sometimes be wasteful.
 458
 459     else
 460     if ((gdk_visual_get_best() != gdk_visual_get_system()) && (m_useBestVisual))
 461     {
 462 #ifdef __WXGTK20__
 463         /* seems gtk_widget_set_default_visual no longer exists? */
 464         GdkVisual* vis = gtk_widget_get_default_visual();
 465 #else
 466         GdkVisual* vis = gdk_visual_get_best();
 467         gtk_widget_set_default_visual( vis );
 468 #endif
 469
 470         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 471         gtk_widget_set_default_colormap( colormap );
 472
 473         visual = vis;
 474     }
 475
 476     // Nothing to do for 15, 16, 24, 32 bit displays
 477     if (visual->depth > 8) return TRUE;
 478
 479     // initialize color cube for 8-bit color reduction dithering
 480
 481     GdkColormap *cmap = gtk_widget_get_default_colormap();
 482
 483     m_colorCube = (unsigned char*)malloc(32 * 32 * 32);
 484
 485     for (int r = 0; r < 32; r++)
 486     {
 487         for (int g = 0; g < 32; g++)
 488         {
 489             for (int b = 0; b < 32; b++)
 490             {
 491                 int rr = (r << 3) | (r >> 2);
 492                 int gg = (g << 3) | (g >> 2);
 493                 int bb = (b << 3) | (b >> 2);
 494
 495                 int index = -1;
 496
 497                 GdkColor *colors = cmap->colors;
 498                 if (colors)
 499                 {
 500                     int max = 3 * 65536;
 501
 502                     for (int i = 0; i < cmap->size; i++)
 503                     {
 504                         int rdiff = ((rr << 8) - colors[i].red);
 505                         int gdiff = ((gg << 8) - colors[i].green);
 506                         int bdiff = ((bb << 8) - colors[i].blue);
 507                         int sum = ABS (rdiff) + ABS (gdiff) + ABS (bdiff);
 508                         if (sum < max)
 509                         {
 510                             index = i; max = sum;
 511                         }
 512                     }
 513                 }
 514                 else
 515                 {
 516                     // assume 8-bit true or static colors. this really exists
 517                     GdkVisual* vis = gdk_colormap_get_visual( cmap );
 518                     index = (r >> (5 - vis->red_prec)) << vis->red_shift;
 519                     index |= (g >> (5 - vis->green_prec)) << vis->green_shift;
 520                     index |= (b >> (5 - vis->blue_prec)) << vis->blue_shift;
 521                 }
 522                 m_colorCube[ (r*1024) + (g*32) + b ] = index;
 523             }
 524         }
 525     }
 526
 527     return TRUE;
 528 }
 529
 530 GdkVisual *wxApp::GetGdkVisual()
 531 {
 532     GdkVisual *visual = NULL;
 533
 534     if (m_glVisualInfo)
 535         visual = gdkx_visual_get( ((XVisualInfo *) m_glVisualInfo)->visualid );
 536     else
 537         visual = gdk_window_get_visual( wxGetRootWindow()->window );
 538
 539     wxASSERT( visual );
 540
 541     return visual;
 542 }
 543
 544 bool wxApp::Initialize(int& argc, wxChar **argv)
 545 {
 546     bool init_result;
 547
 548 #if wxUSE_THREADS
 549     // GTK 1.2 up to version 1.2.3 has broken threads
 550     if ((gtk_major_version == 1) &&
 551         (gtk_minor_version == 2) &&
 552         (gtk_micro_version < 4))
 553     {
 554         printf( "wxWidgets warning: GUI threading disabled due to outdated GTK version\n" );
 555     }
 556     else
 557     {
 558         if (!g_thread_supported())
 559             g_thread_init(NULL);
 560     }
 561 #endif // wxUSE_THREADS
 562
 563     gtk_set_locale();
 564
 565     // We should have the wxUSE_WCHAR_T test on the _outside_
 566 #if wxUSE_WCHAR_T
 567     #if defined(__WXGTK20__)
 568         // gtk+ 2.0 supports Unicode through UTF-8 strings
 569         wxConvCurrent = &wxConvUTF8;
 570     #else // GTK 1.x
 571         if (!wxOKlibc())
 572             wxConvCurrent = &wxConvLocal;
 573     #endif
 574 #else // !wxUSE_WCHAR_T
 575     if (!wxOKlibc())
 576         wxConvCurrent = (wxMBConv*) NULL;
 577 #endif // wxUSE_WCHAR_T/!wxUSE_WCHAR_T
 578
 579 #if wxUSE_UNICODE
 580     // gtk_init() wants UTF-8, not wchar_t, so convert
 581     int i;
 582     char **argvGTK = new char *[argc + 1];
 583     for ( i = 0; i < argc; i++ )
 584     {
 585         argvGTK[i] = wxStrdupA(wxConvUTF8.cWX2MB(argv[i]));
 586     }
 587
 588     argvGTK[argc] = NULL;
 589
 590     int argcGTK = argc;
 591
 592 #ifdef __WXGPE__
 593     init_result = true;  // is there a _check() version of this?
 594     gpe_application_init( &argcGTK, &argvGTK );
 595 #else
 596     init_result = gtk_init_check( &argcGTK, &argvGTK );
 597 #endif
 598
 599     if ( argcGTK != argc )
 600     {
 601         // we have to drop the parameters which were consumed by GTK+
 602         for ( i = 0; i < argcGTK; i++ )
 603         {
 604             while ( strcmp(wxConvUTF8.cWX2MB(argv[i]), argvGTK[i]) != 0 )
 605             {
 606                 memmove(argv + i, argv + i + 1, argc - i);
 607             }
 608         }
 609
 610         argc = argcGTK;
 611     }
 612     //else: gtk_init() didn't modify our parameters
 613
 614     // free our copy
 615     for ( i = 0; i < argcGTK; i++ )
 616     {
 617         free(argvGTK[i]);
 618     }
 619
 620     delete [] argvGTK;
 621 #else // !wxUSE_UNICODE
 622     // gtk_init() shouldn't actually change argv itself (just its contents) so
 623     // it's ok to pass pointer to it
 624     init_result = gtk_init_check( &argc, &argv );
 625 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 626
 627     if (!init_result) {
 628         wxLogError(wxT("Unable to initialize gtk, is DISPLAY set properly?"));
 629         return false;
 630     }
 631
 632     // we can not enter threads before gtk_init is done
 633     gdk_threads_enter();
 634
 635     if ( !wxAppBase::Initialize(argc, argv) )
 636     {
 637         gdk_threads_leave();
 638
 639         return false;
 640     }
 641
 642     wxSetDetectableAutoRepeat( TRUE );
 643
 644 #if wxUSE_INTL
 645     wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
 646 #endif
 647
 648     return true;
 649 }
 650
 651 void wxApp::CleanUp()
 652 {
 653     gdk_threads_leave();
 654
 655     wxAppBase::CleanUp();
 656 }
 657
 658 #ifdef __WXDEBUG__
 659
 660 void wxApp::OnAssert(const wxChar *file, int line, const wxChar* cond, const wxChar *msg)
 661 {
 662     m_isInAssert = TRUE;
 663
 664     wxAppBase::OnAssert(file, line, cond, msg);
 665
 666     m_isInAssert = FALSE;
 667 }
 668
 669 #endif // __WXDEBUG__
 670