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