src/gtk/utilsgtk.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/utilsgtk.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #include "wx/utils.h"
  14
  15 #ifndef WX_PRECOMP
  16     #include "wx/string.h"
  17     #include "wx/intl.h"
  18     #include "wx/log.h"
  19 #endif
  20
  21 #include "wx/apptrait.h"
  22 #include "wx/process.h"
  23 #include "wx/sysopt.h"
  24 #include "wx/unix/execute.h"
  25
  26 #include "wx/gtk/private/timer.h"
  27 #include "wx/evtloop.h"
  28
  29 #if wxDEBUG_LEVEL
  30     #include "wx/gtk/assertdlg_gtk.h"
  31     #if wxUSE_STACKWALKER
  32         #include "wx/stackwalk.h"
  33     #endif // wxUSE_STACKWALKER
  34 #endif // wxDEBUG_LEVEL
  35
  36 #include <stdarg.h>
  37 #include <string.h>
  38 #include <sys/stat.h>
  39 #include <sys/types.h>
  40 #include <sys/wait.h>   // for WNOHANG
  41 #include <unistd.h>
  42
  43 #include "glib.h"
  44 #include "gdk/gdk.h"
  45 #include "gtk/gtk.h"
  46 #include "gdk/gdkx.h"
  47
  48 #if wxUSE_DETECT_SM
  49     #include "X11/Xlib.h"
  50     #include "X11/SM/SMlib.h"
  51
  52     #include "wx/unix/utilsx11.h"
  53 #endif
  54
  55 //-----------------------------------------------------------------------------
  56 // data
  57 //-----------------------------------------------------------------------------
  58
  59 extern GtkWidget *wxGetRootWindow();
  60
  61 //----------------------------------------------------------------------------
  62 // misc.
  63 //----------------------------------------------------------------------------
  64 #ifndef __EMX__
  65 // on OS/2, we use the wxBell from wxBase library
  66
  67 void wxBell()
  68 {
  69     gdk_beep();
  70 }
  71 #endif
  72
  73 // ----------------------------------------------------------------------------
  74 // display characterstics
  75 // ----------------------------------------------------------------------------
  76
  77 void *wxGetDisplay()
  78 {
  79     return GDK_DISPLAY();
  80 }
  81
  82 void wxDisplaySize( int *width, int *height )
  83 {
  84     if (width) *width = gdk_screen_width();
  85     if (height) *height = gdk_screen_height();
  86 }
  87
  88 void wxDisplaySizeMM( int *width, int *height )
  89 {
  90     if (width) *width = gdk_screen_width_mm();
  91     if (height) *height = gdk_screen_height_mm();
  92 }
  93
  94 void wxGetMousePosition( int* x, int* y )
  95 {
  96     gdk_window_get_pointer( NULL, x, y, NULL );
  97 }
  98
  99 bool wxColourDisplay()
 100 {
 101     return true;
 102 }
 103
 104 int wxDisplayDepth()
 105 {
 106     return gdk_drawable_get_visual( wxGetRootWindow()->window )->depth;
 107 }
 108
 109 wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
 110 {
 111     return wxGenericFindWindowAtPoint(pt);
 112 }
 113
 114 #if !wxUSE_UNICODE
 115
 116 WXDLLIMPEXP_CORE wxCharBuffer
 117 wxConvertToGTK(const wxString& s, wxFontEncoding enc)
 118 {
 119     wxWCharBuffer wbuf;
 120     if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )
 121     {
 122         wbuf = wxConvUI->cMB2WC(s.c_str());
 123     }
 124     else // another encoding, use generic conversion class
 125     {
 126         wbuf = wxCSConv(enc).cMB2WC(s.c_str());
 127     }
 128
 129     if ( !wbuf && !s.empty() )
 130     {
 131         // conversion failed, but we still want to show something to the user
 132         // even if it's going to be wrong it is better than nothing
 133         //
 134         // we choose ISO8859-1 here arbitrarily, it's just the most common
 135         // encoding probably and, also importantly here, conversion from it
 136         // never fails as it's done internally by wxCSConv
 137         wbuf = wxCSConv(wxFONTENCODING_ISO8859_1).cMB2WC(s.c_str());
 138     }
 139
 140     return wxConvUTF8.cWC2MB(wbuf);
 141 }
 142
 143 WXDLLIMPEXP_CORE wxCharBuffer
 144 wxConvertFromGTK(const wxString& s, wxFontEncoding enc)
 145 {
 146     // this conversion should never fail as GTK+ always uses UTF-8 internally
 147     // so there are no complications here
 148     const wxWCharBuffer wbuf(wxConvUTF8.cMB2WC(s.c_str()));
 149     if ( enc == wxFONTENCODING_SYSTEM )
 150         return wxConvUI->cWC2MB(wbuf);
 151
 152     return wxCSConv(enc).cWC2MB(wbuf);
 153 }
 154
 155 #endif // !wxUSE_UNICODE
 156
 157 // Returns NULL if version is certainly greater or equal than major.minor.micro
 158 // Returns string describing the error if version is lower than
 159 // major.minor.micro OR it cannot be determined and one should not rely on the
 160 // availability of pango version major.minor.micro, nor the non-availability
 161 const gchar *wx_pango_version_check (int major, int minor, int micro)
 162 {
 163     // NOTE: you don't need to use this macro to check for Pango features
 164     //       added in pango-1.4 or earlier since GTK 2.4 (our minimum requirement
 165     //       for GTK lib) required pango 1.4...
 166
 167 #ifdef PANGO_VERSION_MAJOR
 168     if (!gtk_check_version (2,11,0))
 169     {
 170         // GTK+ 2.11 requires Pango >= 1.15.3 and pango_version_check
 171         // was added in Pango 1.15.2 thus we know for sure the pango lib we're
 172         // using has the pango_version_check function:
 173         return pango_version_check (major, minor, micro);
 174     }
 175
 176     return "can't check";
 177 #else // !PANGO_VERSION_MAJOR
 178     wxUnusedVar(major);
 179     wxUnusedVar(minor);
 180     wxUnusedVar(micro);
 181
 182     return "too old headers";
 183 #endif
 184 }
 185
 186
 187 // ----------------------------------------------------------------------------
 188 // subprocess routines
 189 // ----------------------------------------------------------------------------
 190
 191 extern "C" {
 192 static
 193 void GTK_EndProcessDetector(gpointer data, gint source,
 194                             GdkInputCondition WXUNUSED(condition))
 195 {
 196     wxEndProcessData * const
 197         proc_data = static_cast<wxEndProcessData *>(data);
 198
 199     // child exited, end waiting
 200     close(source);
 201
 202     // don't call us again!
 203     gdk_input_remove(proc_data->tag);
 204
 205     wxHandleProcessTermination(proc_data);
 206 }
 207 }
 208
 209 int wxGUIAppTraits::AddProcessCallback(wxEndProcessData *proc_data, int fd)
 210 {
 211     int tag = gdk_input_add(fd,
 212                             GDK_INPUT_READ,
 213                             GTK_EndProcessDetector,
 214                             (gpointer)proc_data);
 215
 216     return tag;
 217 }
 218
 219
 220
 221 // ----------------------------------------------------------------------------
 222 // wxPlatformInfo-related
 223 // ----------------------------------------------------------------------------
 224
 225 wxPortId wxGUIAppTraits::GetToolkitVersion(int *verMaj, int *verMin) const
 226 {
 227     if ( verMaj )
 228         *verMaj = gtk_major_version;
 229     if ( verMin )
 230         *verMin = gtk_minor_version;
 231
 232     return wxPORT_GTK;
 233 }
 234
 235 #if wxUSE_TIMER
 236
 237 wxTimerImpl *wxGUIAppTraits::CreateTimerImpl(wxTimer *timer)
 238 {
 239     return new wxGTKTimerImpl(timer);
 240 }
 241
 242 #endif // wxUSE_TIMER
 243
 244 #if wxUSE_DETECT_SM
 245 static wxString GetSM()
 246 {
 247     wxX11Display dpy;
 248     if ( !dpy )
 249         return wxEmptyString;
 250
 251     char smerr[256];
 252     char *client_id;
 253     SmcConn smc_conn = SmcOpenConnection(NULL, NULL,
 254                                          999, 999,
 255                                          0 /* mask */, NULL /* callbacks */,
 256                                          NULL, &client_id,
 257                                          WXSIZEOF(smerr), smerr);
 258
 259     if ( !smc_conn )
 260     {
 261         wxLogDebug("Failed to connect to session manager: %s", smerr);
 262         return wxEmptyString;
 263     }
 264
 265     char *vendor = SmcVendor(smc_conn);
 266     wxString ret = wxString::FromAscii( vendor );
 267     free(vendor);
 268
 269     SmcCloseConnection(smc_conn, 0, NULL);
 270     free(client_id);
 271
 272     return ret;
 273 }
 274 #endif // wxUSE_DETECT_SM
 275
 276
 277 //-----------------------------------------------------------------------------
 278 // wxGUIAppTraits
 279 //-----------------------------------------------------------------------------
 280
 281 wxEventLoopBase *wxGUIAppTraits::CreateEventLoop()
 282 {
 283     return new wxEventLoop();
 284 }
 285
 286
 287 #if wxUSE_INTL
 288 void wxGUIAppTraits::SetLocale()
 289 {
 290     gtk_set_locale();
 291     wxUpdateLocaleIsUtf8();
 292 }
 293 #endif
 294
 295 #if wxDEBUG_LEVEL && wxUSE_STACKWALKER
 296
 297 // private helper class
 298 class StackDump : public wxStackWalker
 299 {
 300 public:
 301     StackDump(GtkAssertDialog *dlg) { m_dlg=dlg; }
 302
 303 protected:
 304     virtual void OnStackFrame(const wxStackFrame& frame)
 305     {
 306         wxString fncname = frame.GetName();
 307         wxString fncargs = fncname;
 308
 309         size_t n = fncname.find(wxT('('));
 310         if (n != wxString::npos)
 311         {
 312             // remove arguments from function name
 313             fncname.erase(n);
 314
 315             // remove function name and brackets from arguments
 316             fncargs = fncargs.substr(n+1, fncargs.length()-n-2);
 317         }
 318         else
 319             fncargs = wxEmptyString;
 320
 321         // append this stack frame's info in the dialog
 322         if (!frame.GetFileName().empty() || !fncname.empty())
 323             gtk_assert_dialog_append_stack_frame(m_dlg,
 324                                                 fncname.mb_str(),
 325                                                 fncargs.mb_str(),
 326                                                 frame.GetFileName().mb_str(),
 327                                                 frame.GetLine());
 328     }
 329
 330 private:
 331     GtkAssertDialog *m_dlg;
 332 };
 333
 334 // the callback functions must be extern "C" to comply with GTK+ declarations
 335 extern "C"
 336 {
 337     void get_stackframe_callback(StackDump *dump)
 338     {
 339         // skip over frames up to including wxOnAssert()
 340         dump->ProcessFrames(3);
 341     }
 342 }
 343
 344 #endif // wxDEBUG_LEVEL && wxUSE_STACKWALKER
 345
 346 bool wxGUIAppTraits::ShowAssertDialog(const wxString& msg)
 347 {
 348 #if wxDEBUG_LEVEL
 349     // we can't show the dialog from another thread
 350     if ( wxIsMainThread() )
 351     {
 352         // under GTK2 we prefer to use a dialog widget written using directly
 353         // in GTK+ as use a dialog written using wxWidgets would need the
 354         // wxWidgets idle processing to work correctly which might not be the
 355         // case when assert happens
 356         GtkWidget *dialog = gtk_assert_dialog_new();
 357         gtk_assert_dialog_set_message(GTK_ASSERT_DIALOG(dialog), msg.mb_str());
 358
 359 #if wxUSE_STACKWALKER
 360         // save the current stack ow...
 361         StackDump dump(GTK_ASSERT_DIALOG(dialog));
 362         dump.SaveStack(100); // showing more than 100 frames is not very useful
 363
 364         // ...but process it only if the user needs it
 365         gtk_assert_dialog_set_backtrace_callback
 366         (
 367             GTK_ASSERT_DIALOG(dialog),
 368             (GtkAssertDialogStackFrameCallback)get_stackframe_callback,
 369             &dump
 370         );
 371 #endif // wxUSE_STACKWALKER
 372
 373         gint result = gtk_dialog_run(GTK_DIALOG (dialog));
 374         bool returnCode = false;
 375         switch (result)
 376         {
 377             case GTK_ASSERT_DIALOG_STOP:
 378                 wxTrap();
 379                 break;
 380             case GTK_ASSERT_DIALOG_CONTINUE:
 381                 // nothing to do
 382                 break;
 383             case GTK_ASSERT_DIALOG_CONTINUE_SUPPRESSING:
 384                 // no more asserts
 385                 returnCode = true;
 386                 break;
 387
 388             default:
 389                 wxFAIL_MSG( wxT("unexpected return code from GtkAssertDialog") );
 390         }
 391
 392         gtk_widget_destroy(dialog);
 393         return returnCode;
 394     }
 395 #endif // wxDEBUG_LEVEL
 396
 397     return wxAppTraitsBase::ShowAssertDialog(msg);
 398 }
 399
 400 wxString wxGUIAppTraits::GetDesktopEnvironment() const
 401 {
 402     wxString de = wxSystemOptions::GetOption(wxT("gtk.desktop"));
 403 #if wxUSE_DETECT_SM
 404     if ( de.empty() )
 405     {
 406         static const wxString s_SM = GetSM();
 407
 408         if (s_SM == wxT("GnomeSM"))
 409             de = wxT("GNOME");
 410         else if (s_SM == wxT("KDE"))
 411             de = wxT("KDE");
 412     }
 413 #endif // wxUSE_DETECT_SM
 414
 415     return de;
 416 }
 417
 418 #ifdef __WXGTK26__
 419
 420 // see the hack below in wxCmdLineParser::GetUsageString().
 421 // TODO: replace this hack with a g_option_group_get_entries()
 422 //       call as soon as such function exists;
 423 //       see http://bugzilla.gnome.org/show_bug.cgi?id=431021 for the relative
 424 //       feature request
 425 struct _GOptionGroup
 426 {
 427   gchar           *name;
 428   gchar           *description;
 429   gchar           *help_description;
 430
 431   GDestroyNotify   destroy_notify;
 432   gpointer         user_data;
 433
 434   GTranslateFunc   translate_func;
 435   GDestroyNotify   translate_notify;
 436   gpointer     translate_data;
 437
 438   GOptionEntry    *entries;
 439   gint             n_entries;
 440
 441   GOptionParseFunc pre_parse_func;
 442   GOptionParseFunc post_parse_func;
 443   GOptionErrorFunc error_func;
 444 };
 445
 446 wxString wxGetNameFromGtkOptionEntry(const GOptionEntry *opt)
 447 {
 448     wxString ret;
 449
 450     if (opt->short_name)
 451         ret << wxT("-") << opt->short_name;
 452     if (opt->long_name)
 453     {
 454         if (!ret.empty())
 455             ret << wxT(", ");
 456         ret << wxT("--") << opt->long_name;
 457
 458         if (opt->arg_description)
 459             ret << wxT("=") << opt->arg_description;
 460     }
 461
 462     return wxT("  ") + ret;
 463 }
 464
 465 #endif // __WXGTK26__
 466
 467 wxString
 468 wxGUIAppTraits::GetStandardCmdLineOptions(wxArrayString& names,
 469                                           wxArrayString& desc) const
 470 {
 471     wxString usage;
 472
 473 #ifdef __WXGTK26__
 474     if (!gtk_check_version(2,6,0))
 475     {
 476         // since GTK>=2.6, we can use the glib_check_version() symbol...
 477
 478         // check whether GLib version is greater than 2.6 but also lower than 2.19
 479         // because, as we use the undocumented _GOptionGroup struct, we don't want
 480         // to run this code with future versions which might change it (2.19 is the
 481         // latest one at the time of this writing)
 482         if (!glib_check_version(2,6,0) && glib_check_version(2,20,0))
 483         {
 484             usage << _("The following standard GTK+ options are also supported:\n");
 485
 486             // passing true here means that the function can open the default
 487             // display while parsing (not really used here anyhow)
 488             GOptionGroup *gtkOpts = gtk_get_option_group(true);
 489
 490             // WARNING: here we access the internals of GOptionGroup:
 491             GOptionEntry *entries = ((_GOptionGroup*)gtkOpts)->entries;
 492             unsigned int n_entries = ((_GOptionGroup*)gtkOpts)->n_entries;
 493             wxArrayString namesOptions, descOptions;
 494
 495             for ( size_t n = 0; n < n_entries; n++ )
 496             {
 497                 if ( entries[n].flags & G_OPTION_FLAG_HIDDEN )
 498                     continue;       // skip
 499
 500                 names.push_back(wxGetNameFromGtkOptionEntry(&entries[n]));
 501
 502                 const gchar * const entryDesc = entries[n].description;
 503                 desc.push_back(wxString(entryDesc));
 504             }
 505
 506             g_option_group_free (gtkOpts);
 507         }
 508     }
 509 #else
 510     wxUnusedVar(names);
 511     wxUnusedVar(desc);
 512 #endif // __WXGTK26__
 513
 514     return usage;
 515 }
 516