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