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 // 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/memory.h"
  20     #include "wx/font.h"
  21 #endif
  22
  23 #include "wx/thread.h"
  24
  25 #ifdef __WXGPE__
  26     #include <gpe/init.h>
  27 #endif
  28
  29 #include "wx/gtk/private.h"
  30 #include "wx/apptrait.h"
  31
  32 #if wxUSE_LIBHILDON
  33     #include <hildon-widgets/hildon-program.h>
  34 #endif // wxUSE_LIBHILDON
  35
  36 #include <gdk/gdkx.h>
  37
  38 //-----------------------------------------------------------------------------
  39 // link GnomeVFS
  40 //-----------------------------------------------------------------------------
  41
  42 #if wxUSE_MIMETYPE && wxUSE_LIBGNOMEVFS
  43     #include "wx/link.h"
  44     wxFORCE_LINK_MODULE(gnome_vfs)
  45 #endif
  46
  47 //-----------------------------------------------------------------------------
  48 // global data
  49 //-----------------------------------------------------------------------------
  50
  51 bool   g_mainThreadLocked = false;
  52
  53 static GtkWidget *gs_RootWindow = (GtkWidget*) NULL;
  54
  55 //-----------------------------------------------------------------------------
  56 // wxYield
  57 //-----------------------------------------------------------------------------
  58
  59 // not static because used by textctrl.cpp
  60 //
  61 // MT-FIXME
  62 bool wxIsInsideYield = false;
  63
  64 bool wxApp::Yield(bool onlyIfNeeded)
  65 {
  66     if ( wxIsInsideYield )
  67     {
  68         if ( !onlyIfNeeded )
  69         {
  70             wxFAIL_MSG( wxT("wxYield called recursively" ) );
  71         }
  72
  73         return false;
  74     }
  75
  76 #if wxUSE_THREADS
  77     if ( !wxThread::IsMain() )
  78     {
  79         // can't call gtk_main_iteration() from other threads like this
  80         return true;
  81     }
  82 #endif // wxUSE_THREADS
  83
  84     wxIsInsideYield = true;
  85
  86 #if wxUSE_LOG
  87     // disable log flushing from here because a call to wxYield() shouldn't
  88     // normally result in message boxes popping up &c
  89     wxLog::Suspend();
  90 #endif
  91
  92     while (EventsPending())
  93         gtk_main_iteration();
  94
  95     // It's necessary to call ProcessIdle() to update the frames sizes which
  96     // might have been changed (it also will update other things set from
  97     // OnUpdateUI() which is a nice (and desired) side effect). But we
  98     // call ProcessIdle() only once since this is not meant for longish
  99     // background jobs (controlled by wxIdleEvent::RequestMore() and the
 100     // return value of Processidle().
 101     ProcessIdle();
 102
 103 #if wxUSE_LOG
 104     // let the logs be flashed again
 105     wxLog::Resume();
 106 #endif
 107
 108     wxIsInsideYield = false;
 109
 110     return true;
 111 }
 112
 113 //-----------------------------------------------------------------------------
 114 // local functions
 115 //-----------------------------------------------------------------------------
 116
 117 // One-shot signal emission hook, to install idle handler.
 118 extern "C" {
 119 static gboolean
 120 wx_emission_hook(GSignalInvocationHint*, guint, const GValue*, gpointer data)
 121 {
 122     wxApp* app = wxTheApp;
 123     if (app != NULL)
 124         app->WakeUpIdle();
 125     gulong* hook_id = (gulong*)data;
 126     // record that hook is not installed
 127     *hook_id = 0;
 128     // remove hook
 129     return false;
 130 }
 131 }
 132
 133 // Add signal emission hooks, to re-install idle handler when needed.
 134 static void wx_add_idle_hooks()
 135 {
 136     // "event" hook
 137     {
 138         static gulong hook_id = 0;
 139         if (hook_id == 0)
 140         {
 141             static guint sig_id = 0;
 142             if (sig_id == 0)
 143                 sig_id = g_signal_lookup("event", GTK_TYPE_WIDGET);
 144             hook_id = g_signal_add_emission_hook(
 145                 sig_id, 0, wx_emission_hook, &hook_id, NULL);
 146         }
 147     }
 148     // "size_allocate" hook
 149     // Needed to match the behavior of the old idle system,
 150     // but probably not necessary.
 151     {
 152         static gulong hook_id = 0;
 153         if (hook_id == 0)
 154         {
 155             static guint sig_id = 0;
 156             if (sig_id == 0)
 157                 sig_id = g_signal_lookup("size_allocate", GTK_TYPE_WIDGET);
 158             hook_id = g_signal_add_emission_hook(
 159                 sig_id, 0, wx_emission_hook, &hook_id, NULL);
 160         }
 161     }
 162 }
 163
 164 extern "C" {
 165 static gboolean wxapp_idle_callback(gpointer)
 166 {
 167     return wxTheApp->DoIdle();
 168 }
 169 }
 170
 171 bool wxApp::DoIdle()
 172 {
 173     guint id_save;
 174     {
 175         // Allow another idle source to be added while this one is busy.
 176         // Needed if an idle event handler runs a new event loop,
 177         // for example by showing a dialog.
 178 #if wxUSE_THREADS
 179         wxMutexLocker lock(*m_idleMutex);
 180 #endif
 181         id_save = m_idleSourceId;
 182         m_idleSourceId = 0;
 183         wx_add_idle_hooks();
 184 #ifdef __WXDEBUG__
 185         // don't generate the idle events while the assert modal dialog is shown,
 186         // this matches the behavior of wxMSW
 187         if (m_isInAssert)
 188             return false;
 189 #endif
 190     }
 191
 192     gdk_threads_enter();
 193     bool needMore;
 194     do {
 195         needMore = ProcessIdle();
 196     } while (needMore && gtk_events_pending() == 0);
 197     gdk_threads_leave();
 198
 199 #if wxUSE_THREADS
 200     wxMutexLocker lock(*m_idleMutex);
 201 #endif
 202     // if a new idle source was added during ProcessIdle
 203     if (m_idleSourceId != 0)
 204     {
 205         // remove it
 206         g_source_remove(m_idleSourceId);
 207         m_idleSourceId = 0;
 208     }
 209     // if more idle processing requested
 210     if (needMore)
 211     {
 212         // keep this source installed
 213         m_idleSourceId = id_save;
 214         return true;
 215     }
 216     // add hooks and remove this source
 217     wx_add_idle_hooks();
 218     return false;
 219 }
 220
 221 #if wxUSE_THREADS
 222
 223 static GPollFunc wxgs_poll_func;
 224
 225 extern "C" {
 226 static gint wxapp_poll_func( GPollFD *ufds, guint nfds, gint timeout )
 227 {
 228     g_mainThreadLocked = true;
 229
 230     gint res = (*wxgs_poll_func)(ufds, nfds, timeout);
 231
 232     g_mainThreadLocked = false;
 233
 234     return res;
 235 }
 236 }
 237
 238 #endif // wxUSE_THREADS
 239
 240 //-----------------------------------------------------------------------------
 241 // Access to the root window global
 242 //-----------------------------------------------------------------------------
 243
 244 GtkWidget* wxGetRootWindow()
 245 {
 246     if (gs_RootWindow == NULL)
 247     {
 248         gs_RootWindow = gtk_window_new( GTK_WINDOW_TOPLEVEL );
 249         gtk_widget_realize( gs_RootWindow );
 250     }
 251     return gs_RootWindow;
 252 }
 253
 254 //-----------------------------------------------------------------------------
 255 // wxApp
 256 //-----------------------------------------------------------------------------
 257
 258 IMPLEMENT_DYNAMIC_CLASS(wxApp,wxEvtHandler)
 259
 260 wxApp::wxApp()
 261 {
 262 #ifdef __WXDEBUG__
 263     m_isInAssert = false;
 264 #endif // __WXDEBUG__
 265 #if wxUSE_THREADS
 266     m_idleMutex = NULL;
 267 #endif
 268     m_idleSourceId = 0;
 269 }
 270
 271 wxApp::~wxApp()
 272 {
 273 }
 274
 275 bool wxApp::OnInitGui()
 276 {
 277     if ( !wxAppBase::OnInitGui() )
 278         return false;
 279
 280     // if this is a wxGLApp (derived from wxApp), and we've already
 281     // chosen a specific visual, then derive the GdkVisual from that
 282     if ( GetXVisualInfo() )
 283     {
 284         GdkVisual* vis = gtk_widget_get_default_visual();
 285
 286         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 287         gtk_widget_set_default_colormap( colormap );
 288     }
 289     else
 290     {
 291         // On some machines, the default visual is just 256 colours, so
 292         // we make sure we get the best. This can sometimes be wasteful.
 293         if (m_useBestVisual)
 294         {
 295             if (m_forceTrueColour)
 296             {
 297                 GdkVisual* visual = gdk_visual_get_best_with_both( 24, GDK_VISUAL_TRUE_COLOR );
 298                 if (!visual)
 299                 {
 300                     wxLogError(wxT("Unable to initialize TrueColor visual."));
 301                     return false;
 302                 }
 303                 GdkColormap *colormap = gdk_colormap_new( visual, FALSE );
 304                 gtk_widget_set_default_colormap( colormap );
 305             }
 306             else
 307             {
 308                 if (gdk_visual_get_best() != gdk_visual_get_system())
 309                 {
 310                     GdkVisual* visual = gdk_visual_get_best();
 311                     GdkColormap *colormap = gdk_colormap_new( visual, FALSE );
 312                     gtk_widget_set_default_colormap( colormap );
 313                 }
 314             }
 315         }
 316     }
 317
 318 #if wxUSE_LIBHILDON
 319     m_hildonProgram = hildon_program_get_instance();
 320     if ( !m_hildonProgram )
 321     {
 322         wxLogError(_("Unable to initialize Hildon program"));
 323         return false;
 324     }
 325 #endif // wxUSE_LIBHILDON
 326
 327     return true;
 328 }
 329
 330 GdkVisual *wxApp::GetGdkVisual()
 331 {
 332     GdkVisual *visual = NULL;
 333
 334     XVisualInfo *xvi = (XVisualInfo *)GetXVisualInfo();
 335     if ( xvi )
 336         visual = gdkx_visual_get( xvi->visualid );
 337     else
 338         visual = gdk_drawable_get_visual( wxGetRootWindow()->window );
 339
 340     wxASSERT( visual );
 341
 342     return visual;
 343 }
 344
 345 // use unusual names for the parameters to avoid conflict with wxApp::arg[cv]
 346 bool wxApp::Initialize(int& argc_, wxChar **argv_)
 347 {
 348     if ( !wxAppBase::Initialize(argc_, argv_) )
 349         return false;
 350
 351 #if wxUSE_THREADS
 352     if (!g_thread_supported())
 353     {
 354         g_thread_init(NULL);
 355         gdk_threads_init();
 356     }
 357
 358     wxgs_poll_func = g_main_context_get_poll_func(NULL);
 359     g_main_context_set_poll_func(NULL, wxapp_poll_func);
 360 #endif // wxUSE_THREADS
 361
 362     // We should have the wxUSE_WCHAR_T test on the _outside_
 363 #if wxUSE_WCHAR_T
 364     // gtk+ 2.0 supports Unicode through UTF-8 strings
 365     wxConvCurrent = &wxConvUTF8;
 366 #else // !wxUSE_WCHAR_T
 367     if (!wxOKlibc())
 368         wxConvCurrent = (wxMBConv*) NULL;
 369 #endif // wxUSE_WCHAR_T/!wxUSE_WCHAR_T
 370
 371     // decide which conversion to use for the file names
 372
 373     // (1) this variable exists for the sole purpose of specifying the encoding
 374     //     of the filenames for GTK+ programs, so use it if it is set
 375     wxString encName(wxGetenv(_T("G_FILENAME_ENCODING")));
 376     encName = encName.BeforeFirst(_T(','));
 377     if (encName.CmpNoCase(_T("@locale")) == 0)
 378         encName.clear();
 379     encName.MakeUpper();
 380 #if wxUSE_INTL
 381     if (encName.empty())
 382     {
 383         // (2) if a non default locale is set, assume that the user wants his
 384         //     filenames in this locale too
 385         encName = wxLocale::GetSystemEncodingName().Upper();
 386         // (3) finally use UTF-8 by default
 387         if (encName.empty() || encName == _T("US-ASCII"))
 388             encName = _T("UTF-8");
 389         wxSetEnv(_T("G_FILENAME_ENCODING"), encName);
 390     }
 391 #else
 392     if (encName.empty())
 393         encName = _T("UTF-8");
 394
 395     // if wxUSE_INTL==0 it probably indicates that only "C" locale is supported
 396     // by the program anyhow so prevent GTK+ from calling setlocale(LC_ALL, "")
 397     // from gtk_init_check() as it does by default
 398     gtk_disable_setlocale();
 399
 400 #endif // wxUSE_INTL
 401     static wxConvBrokenFileNames fileconv(encName);
 402     wxConvFileName = &fileconv;
 403
 404
 405     bool init_result;
 406     int i;
 407
 408 #if wxUSE_UNICODE
 409     // gtk_init() wants UTF-8, not wchar_t, so convert
 410     char **argvGTK = new char *[argc_ + 1];
 411     for ( i = 0; i < argc_; i++ )
 412     {
 413         argvGTK[i] = wxStrdupA(wxConvUTF8.cWX2MB(argv_[i]));
 414     }
 415
 416     argvGTK[argc_] = NULL;
 417
 418     int argcGTK = argc_;
 419
 420 #ifdef __WXGPE__
 421     init_result = true;  // is there a _check() version of this?
 422     gpe_application_init( &argcGTK, &argvGTK );
 423 #else
 424     init_result = gtk_init_check( &argcGTK, &argvGTK );
 425 #endif
 426     wxUpdateLocaleIsUtf8();
 427
 428     if ( argcGTK != argc_ )
 429     {
 430         // we have to drop the parameters which were consumed by GTK+
 431         for ( i = 0; i < argcGTK; i++ )
 432         {
 433             while ( strcmp(wxConvUTF8.cWX2MB(argv_[i]), argvGTK[i]) != 0 )
 434             {
 435                 memmove(argv_ + i, argv_ + i + 1, (argc_ - i)*sizeof(*argv_));
 436             }
 437         }
 438
 439         argc_ = argcGTK;
 440     }
 441     //else: gtk_init() didn't modify our parameters
 442
 443     // free our copy
 444     for ( i = 0; i < argcGTK; i++ )
 445     {
 446         free(argvGTK[i]);
 447     }
 448
 449     delete [] argvGTK;
 450 #else // !wxUSE_UNICODE
 451     // gtk_init() shouldn't actually change argv_ itself (just its contents) so
 452     // it's ok to pass pointer to it
 453     init_result = gtk_init_check( &argc_, &argv_ );
 454 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 455
 456     // update internal arg[cv] as GTK+ may have removed processed options:
 457     this->argc = argc_;
 458     this->argv = argv_;
 459
 460     if ( m_traits )
 461     {
 462         // if there are still GTK+ standard options unparsed in the command
 463         // line, it means that they were not syntactically correct and GTK+
 464         // already printed a warning on the command line and we should now
 465         // exit:
 466         wxArrayString opt, desc;
 467         m_traits->GetStandardCmdLineOptions(opt, desc);
 468
 469         for ( i = 0; i < argc_; i++ )
 470         {
 471             // leave just the names of the options with values
 472             const wxString str = wxString(argv_[i]).BeforeFirst('=');
 473
 474             for ( size_t j = 0; j < opt.size(); j++ )
 475             {
 476                 // remove the leading spaces from the option string as it does
 477                 // have them
 478                 if ( opt[j].Trim(false).BeforeFirst('=') == str )
 479                 {
 480                     // a GTK+ option can be left on the command line only if
 481                     // there was an error in (or before, in another standard
 482                     // options) it, so abort, just as we do if incorrect
 483                     // program option is given
 484                     wxLogError(_("Invalid GTK+ command line option, use \"%s --help\""),
 485                                argv_[0]);
 486                     return false;
 487                 }
 488             }
 489         }
 490     }
 491
 492     if ( !init_result )
 493     {
 494         wxLogError(_("Unable to initialize GTK+, is DISPLAY set properly?"));
 495         return false;
 496     }
 497
 498     // we can not enter threads before gtk_init is done
 499     gdk_threads_enter();
 500
 501     wxSetDetectableAutoRepeat( true );
 502
 503 #if wxUSE_INTL
 504     wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
 505 #endif
 506
 507 #if wxUSE_THREADS
 508     m_idleMutex = new wxMutex;
 509 #endif
 510     // make sure GtkWidget type is loaded, idle hooks need it
 511     g_type_class_ref(GTK_TYPE_WIDGET);
 512     WakeUpIdle();
 513
 514     return true;
 515 }
 516
 517 void wxApp::CleanUp()
 518 {
 519     if (m_idleSourceId != 0)
 520         g_source_remove(m_idleSourceId);
 521
 522     // release reference acquired by Initialize()
 523     g_type_class_unref(g_type_class_peek(GTK_TYPE_WIDGET));
 524
 525     gdk_threads_leave();
 526
 527     wxAppBase::CleanUp();
 528
 529     // delete this mutex as late as possible as it's used from WakeUpIdle(), in
 530     // particular do it after calling the base class CleanUp() which can result
 531     // in it being called
 532 #if wxUSE_THREADS
 533     delete m_idleMutex;
 534     m_idleMutex = NULL;
 535 #endif
 536 }
 537
 538 void wxApp::WakeUpIdle()
 539 {
 540 #if wxUSE_THREADS
 541     wxMutexLocker lock(*m_idleMutex);
 542 #endif
 543     if (m_idleSourceId == 0)
 544         m_idleSourceId = g_idle_add_full(G_PRIORITY_LOW, wxapp_idle_callback, NULL, NULL);
 545 }
 546
 547 // Checking for pending events requires first removing our idle source,
 548 // otherwise it will cause the check to always return true.
 549 bool wxApp::EventsPending()
 550 {
 551 #if wxUSE_THREADS
 552     wxMutexLocker lock(*m_idleMutex);
 553 #endif
 554     if (m_idleSourceId != 0)
 555     {
 556         g_source_remove(m_idleSourceId);
 557         m_idleSourceId = 0;
 558         wx_add_idle_hooks();
 559     }
 560     return gtk_events_pending() != 0;
 561 }
 562
 563 #ifdef __WXDEBUG__
 564
 565 void wxApp::OnAssertFailure(const wxChar *file,
 566                             int line,
 567                             const wxChar* func,
 568                             const wxChar* cond,
 569                             const wxChar *msg)
 570 {
 571
 572     // block wx idle events while assert dialog is showing
 573     m_isInAssert = true;
 574
 575     wxAppBase::OnAssertFailure(file, line, func, cond, msg);
 576
 577     m_isInAssert = false;
 578 }
 579
 580 #endif // __WXDEBUG__
 581
 582 #if wxUSE_THREADS
 583 void wxGUIAppTraits::MutexGuiEnter()
 584 {
 585     gdk_threads_enter();
 586 }
 587
 588 void wxGUIAppTraits::MutexGuiLeave()
 589 {
 590     gdk_threads_leave();
 591 }
 592 #endif // wxUSE_THREADS