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     gdk_threads_enter();
 229
 230     wxMutexGuiLeave();
 231     g_mainThreadLocked = true;
 232
 233     gint res = (*wxgs_poll_func)(ufds, nfds, timeout);
 234
 235     wxMutexGuiEnter();
 236     g_mainThreadLocked = false;
 237
 238     gdk_threads_leave();
 239
 240     return res;
 241 }
 242 }
 243
 244 #endif // wxUSE_THREADS
 245
 246 //-----------------------------------------------------------------------------
 247 // Access to the root window global
 248 //-----------------------------------------------------------------------------
 249
 250 GtkWidget* wxGetRootWindow()
 251 {
 252     if (gs_RootWindow == NULL)
 253     {
 254         gs_RootWindow = gtk_window_new( GTK_WINDOW_TOPLEVEL );
 255         gtk_widget_realize( gs_RootWindow );
 256     }
 257     return gs_RootWindow;
 258 }
 259
 260 //-----------------------------------------------------------------------------
 261 // wxApp
 262 //-----------------------------------------------------------------------------
 263
 264 IMPLEMENT_DYNAMIC_CLASS(wxApp,wxEvtHandler)
 265
 266 wxApp::wxApp()
 267 {
 268 #ifdef __WXDEBUG__
 269     m_isInAssert = false;
 270 #endif // __WXDEBUG__
 271 #if wxUSE_THREADS
 272     m_idleMutex = NULL;
 273 #endif
 274     m_idleSourceId = 0;
 275 }
 276
 277 wxApp::~wxApp()
 278 {
 279 }
 280
 281 bool wxApp::OnInitGui()
 282 {
 283     if ( !wxAppBase::OnInitGui() )
 284         return false;
 285
 286     // if this is a wxGLApp (derived from wxApp), and we've already
 287     // chosen a specific visual, then derive the GdkVisual from that
 288     if ( GetXVisualInfo() )
 289     {
 290         GdkVisual* vis = gtk_widget_get_default_visual();
 291
 292         GdkColormap *colormap = gdk_colormap_new( vis, FALSE );
 293         gtk_widget_set_default_colormap( colormap );
 294     }
 295     else
 296     {
 297         // On some machines, the default visual is just 256 colours, so
 298         // we make sure we get the best. This can sometimes be wasteful.
 299         if (m_useBestVisual)
 300         {
 301             if (m_forceTrueColour)
 302             {
 303                 GdkVisual* visual = gdk_visual_get_best_with_both( 24, GDK_VISUAL_TRUE_COLOR );
 304                 if (!visual)
 305                 {
 306                     wxLogError(wxT("Unable to initialize TrueColor visual."));
 307                     return false;
 308                 }
 309                 GdkColormap *colormap = gdk_colormap_new( visual, FALSE );
 310                 gtk_widget_set_default_colormap( colormap );
 311             }
 312             else
 313             {
 314                 if (gdk_visual_get_best() != gdk_visual_get_system())
 315                 {
 316                     GdkVisual* visual = gdk_visual_get_best();
 317                     GdkColormap *colormap = gdk_colormap_new( visual, FALSE );
 318                     gtk_widget_set_default_colormap( colormap );
 319                 }
 320             }
 321         }
 322     }
 323
 324 #if wxUSE_LIBHILDON
 325     m_hildonProgram = hildon_program_get_instance();
 326     if ( !m_hildonProgram )
 327     {
 328         wxLogError(_("Unable to initialize Hildon program"));
 329         return false;
 330     }
 331 #endif // wxUSE_LIBHILDON
 332
 333     return true;
 334 }
 335
 336 GdkVisual *wxApp::GetGdkVisual()
 337 {
 338     GdkVisual *visual = NULL;
 339
 340     XVisualInfo *xvi = (XVisualInfo *)GetXVisualInfo();
 341     if ( xvi )
 342         visual = gdkx_visual_get( xvi->visualid );
 343     else
 344         visual = gdk_drawable_get_visual( wxGetRootWindow()->window );
 345
 346     wxASSERT( visual );
 347
 348     return visual;
 349 }
 350
 351 // use unusual names for the parameters to avoid conflict with wxApp::arg[cv]
 352 bool wxApp::Initialize(int& argc_, wxChar **argv_)
 353 {
 354     if ( !wxAppBase::Initialize(argc_, argv_) )
 355         return false;
 356
 357 #if wxUSE_THREADS
 358     if (!g_thread_supported())
 359         g_thread_init(NULL);
 360
 361     wxgs_poll_func = g_main_context_get_poll_func(NULL);
 362     g_main_context_set_poll_func(NULL, wxapp_poll_func);
 363 #endif // wxUSE_THREADS
 364
 365     // We should have the wxUSE_WCHAR_T test on the _outside_
 366 #if wxUSE_WCHAR_T
 367     // gtk+ 2.0 supports Unicode through UTF-8 strings
 368     wxConvCurrent = &wxConvUTF8;
 369 #else // !wxUSE_WCHAR_T
 370     if (!wxOKlibc())
 371         wxConvCurrent = (wxMBConv*) NULL;
 372 #endif // wxUSE_WCHAR_T/!wxUSE_WCHAR_T
 373
 374     // decide which conversion to use for the file names
 375
 376     // (1) this variable exists for the sole purpose of specifying the encoding
 377     //     of the filenames for GTK+ programs, so use it if it is set
 378     wxString encName(wxGetenv(_T("G_FILENAME_ENCODING")));
 379     encName = encName.BeforeFirst(_T(','));
 380     if (encName.CmpNoCase(_T("@locale")) == 0)
 381         encName.clear();
 382     encName.MakeUpper();
 383 #if wxUSE_INTL
 384     if (encName.empty())
 385     {
 386         // (2) if a non default locale is set, assume that the user wants his
 387         //     filenames in this locale too
 388         encName = wxLocale::GetSystemEncodingName().Upper();
 389         // (3) finally use UTF-8 by default
 390         if (encName.empty() || encName == _T("US-ASCII"))
 391             encName = _T("UTF-8");
 392         wxSetEnv(_T("G_FILENAME_ENCODING"), encName);
 393     }
 394 #else
 395     if (encName.empty())
 396         encName = _T("UTF-8");
 397
 398     // if wxUSE_INTL==0 it probably indicates that only "C" locale is supported
 399     // by the program anyhow so prevent GTK+ from calling setlocale(LC_ALL, "")
 400     // from gtk_init_check() as it does by default
 401     gtk_disable_setlocale();
 402
 403 #endif // wxUSE_INTL
 404     static wxConvBrokenFileNames fileconv(encName);
 405     wxConvFileName = &fileconv;
 406
 407
 408     bool init_result;
 409     int i;
 410
 411 #if wxUSE_UNICODE
 412     // gtk_init() wants UTF-8, not wchar_t, so convert
 413     char **argvGTK = new char *[argc_ + 1];
 414     for ( i = 0; i < argc_; i++ )
 415     {
 416         argvGTK[i] = wxStrdupA(wxConvUTF8.cWX2MB(argv_[i]));
 417     }
 418
 419     argvGTK[argc_] = NULL;
 420
 421     int argcGTK = argc_;
 422
 423 #ifdef __WXGPE__
 424     init_result = true;  // is there a _check() version of this?
 425     gpe_application_init( &argcGTK, &argvGTK );
 426 #else
 427     init_result = gtk_init_check( &argcGTK, &argvGTK );
 428 #endif
 429     wxUpdateLocaleIsUtf8();
 430
 431     if ( argcGTK != argc_ )
 432     {
 433         // we have to drop the parameters which were consumed by GTK+
 434         for ( i = 0; i < argcGTK; i++ )
 435         {
 436             while ( strcmp(wxConvUTF8.cWX2MB(argv_[i]), argvGTK[i]) != 0 )
 437             {
 438                 memmove(argv_ + i, argv_ + i + 1, (argc_ - i)*sizeof(*argv_));
 439             }
 440         }
 441
 442         argc_ = argcGTK;
 443     }
 444     //else: gtk_init() didn't modify our parameters
 445
 446     // free our copy
 447     for ( i = 0; i < argcGTK; i++ )
 448     {
 449         free(argvGTK[i]);
 450     }
 451
 452     delete [] argvGTK;
 453 #else // !wxUSE_UNICODE
 454     // gtk_init() shouldn't actually change argv_ itself (just its contents) so
 455     // it's ok to pass pointer to it
 456     init_result = gtk_init_check( &argc_, &argv_ );
 457 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 458
 459     // update internal arg[cv] as GTK+ may have removed processed options:
 460     this->argc = argc_;
 461     this->argv = argv_;
 462
 463     if ( m_traits )
 464     {
 465         // if there are still GTK+ standard options unparsed in the command
 466         // line, it means that they were not syntactically correct and GTK+
 467         // already printed a warning on the command line and we should now
 468         // exit:
 469         wxArrayString opt, desc;
 470         m_traits->GetStandardCmdLineOptions(opt, desc);
 471
 472         for ( i = 0; i < argc_; i++ )
 473         {
 474             // leave just the names of the options with values
 475             const wxString str = wxString(argv_[i]).BeforeFirst('=');
 476
 477             for ( size_t j = 0; j < opt.size(); j++ )
 478             {
 479                 // remove the leading spaces from the option string as it does
 480                 // have them
 481                 if ( opt[j].Trim(false).BeforeFirst('=') == str )
 482                 {
 483                     // a GTK+ option can be left on the command line only if
 484                     // there was an error in (or before, in another standard
 485                     // options) it, so abort, just as we do if incorrect
 486                     // program option is given
 487                     wxLogError(_("Invalid GTK+ command line option, use \"%s --help\""),
 488                                argv_[0]);
 489                     return false;
 490                 }
 491             }
 492         }
 493     }
 494
 495     if ( !init_result )
 496     {
 497         wxLogError(_("Unable to initialize GTK+, is DISPLAY set properly?"));
 498         return false;
 499     }
 500
 501     // we can not enter threads before gtk_init is done
 502     gdk_threads_enter();
 503
 504     wxSetDetectableAutoRepeat( true );
 505
 506 #if wxUSE_INTL
 507     wxFont::SetDefaultEncoding(wxLocale::GetSystemEncoding());
 508 #endif
 509
 510 #if wxUSE_THREADS
 511     m_idleMutex = new wxMutex;
 512 #endif
 513     // make sure GtkWidget type is loaded, idle hooks need it
 514     g_type_class_ref(GTK_TYPE_WIDGET);
 515     WakeUpIdle();
 516
 517     return true;
 518 }
 519
 520 void wxApp::CleanUp()
 521 {
 522     if (m_idleSourceId != 0)
 523         g_source_remove(m_idleSourceId);
 524
 525     // release reference acquired by Initialize()
 526     g_type_class_unref(g_type_class_peek(GTK_TYPE_WIDGET));
 527
 528     gdk_threads_leave();
 529
 530     wxAppBase::CleanUp();
 531
 532     // delete this mutex as late as possible as it's used from WakeUpIdle(), in
 533     // particular do it after calling the base class CleanUp() which can result
 534     // in it being called
 535 #if wxUSE_THREADS
 536     delete m_idleMutex;
 537     m_idleMutex = NULL;
 538 #endif
 539 }
 540
 541 void wxApp::WakeUpIdle()
 542 {
 543 #if wxUSE_THREADS
 544     wxMutexLocker lock(*m_idleMutex);
 545 #endif
 546     if (m_idleSourceId == 0)
 547         m_idleSourceId = g_idle_add_full(G_PRIORITY_LOW, wxapp_idle_callback, NULL, NULL);
 548 }
 549
 550 // Checking for pending events requires first removing our idle source,
 551 // otherwise it will cause the check to always return true.
 552 bool wxApp::EventsPending()
 553 {
 554 #if wxUSE_THREADS
 555     wxMutexLocker lock(*m_idleMutex);
 556 #endif
 557     if (m_idleSourceId != 0)
 558     {
 559         g_source_remove(m_idleSourceId);
 560         m_idleSourceId = 0;
 561         wx_add_idle_hooks();
 562     }
 563     return gtk_events_pending() != 0;
 564 }
 565
 566 #ifdef __WXDEBUG__
 567
 568 void wxApp::OnAssertFailure(const wxChar *file,
 569                             int line,
 570                             const wxChar* func,
 571                             const wxChar* cond,
 572                             const wxChar *msg)
 573 {
 574
 575     // block wx idle events while assert dialog is showing
 576     m_isInAssert = true;
 577
 578     wxAppBase::OnAssertFailure(file, line, func, cond, msg);
 579
 580     m_isInAssert = false;
 581 }
 582
 583 #endif // __WXDEBUG__