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