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
  23 #include "wx/process.h"
  24 #include "wx/sysopt.h"
  25
  26 #include "wx/unix/execute.h"
  27
  28 #include "wx/gtk/private/timer.h"
  29 #include "wx/evtloop.h"
  30
  31 #ifdef __WXDEBUG__
  32     #include "wx/gtk/assertdlg_gtk.h"
  33     #if wxUSE_STACKWALKER
  34         #include "wx/stackwalk.h"
  35     #endif // wxUSE_STACKWALKER
  36 #endif // __WXDEBUG__
  37
  38 #include <stdarg.h>
  39 #include <string.h>
  40 #include <sys/stat.h>
  41 #include <sys/types.h>
  42 #include <sys/wait.h>   // for WNOHANG
  43 #include <unistd.h>
  44
  45 #include "glib.h"
  46 #include "gdk/gdk.h"
  47 #include "gtk/gtk.h"
  48 #include "gdk/gdkx.h"
  49
  50 #ifdef HAVE_X11_XKBLIB_H
  51     /* under HP-UX and Solaris 2.6, at least, XKBlib.h defines structures with
  52      * field named "explicit" - which is, of course, an error for a C++
  53      * compiler. To be on the safe side, just redefine it everywhere. */
  54     #define explicit __wx_explicit
  55
  56     #include "X11/XKBlib.h"
  57
  58     #undef explicit
  59 #endif // HAVE_X11_XKBLIB_H
  60
  61
  62 #if wxUSE_DETECT_SM
  63     #include "X11/Xlib.h"
  64     #include "X11/SM/SMlib.h"
  65 #endif
  66
  67 //-----------------------------------------------------------------------------
  68 // data
  69 //-----------------------------------------------------------------------------
  70
  71 extern GtkWidget *wxGetRootWindow();
  72
  73 //----------------------------------------------------------------------------
  74 // misc.
  75 //----------------------------------------------------------------------------
  76 #ifndef __EMX__
  77 // on OS/2, we use the wxBell from wxBase library
  78
  79 void wxBell()
  80 {
  81     gdk_beep();
  82 }
  83 #endif
  84
  85 /* Don't synthesize KeyUp events holding down a key and producing
  86    KeyDown events with autorepeat. */
  87 #ifdef HAVE_X11_XKBLIB_H
  88 bool wxSetDetectableAutoRepeat( bool flag )
  89 {
  90     Bool result;
  91     XkbSetDetectableAutoRepeat( GDK_DISPLAY(), flag, &result );
  92     return result;       /* true if keyboard hardware supports this mode */
  93 }
  94 #else
  95 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
  96 {
  97     return false;
  98 }
  99 #endif
 100
 101 // Escapes string so that it is valid Pango markup XML string:
 102 wxString wxEscapeStringForPangoMarkup(const wxString& str)
 103 {
 104     size_t len = str.length();
 105     wxString out;
 106     out.Alloc(len);
 107     for (size_t i = 0; i < len; i++)
 108     {
 109         wxChar c = str[i];
 110         switch (c)
 111         {
 112             case _T('&'):
 113                 out << _T("&amp;");
 114                 break;
 115             case _T('<'):
 116                 out << _T("&lt;");
 117                 break;
 118             case _T('>'):
 119                 out << _T("&gt;");
 120                 break;
 121             case _T('\''):
 122                 out << _T("&apos;");
 123                 break;
 124             case _T('"'):
 125                 out << _T("&quot;");
 126                 break;
 127             default:
 128                 out << c;
 129                 break;
 130         }
 131     }
 132     return out;
 133 }
 134
 135
 136 // ----------------------------------------------------------------------------
 137 // display characterstics
 138 // ----------------------------------------------------------------------------
 139
 140 void *wxGetDisplay()
 141 {
 142     return GDK_DISPLAY();
 143 }
 144
 145 void wxDisplaySize( int *width, int *height )
 146 {
 147     if (width) *width = gdk_screen_width();
 148     if (height) *height = gdk_screen_height();
 149 }
 150
 151 void wxDisplaySizeMM( int *width, int *height )
 152 {
 153     if (width) *width = gdk_screen_width_mm();
 154     if (height) *height = gdk_screen_height_mm();
 155 }
 156
 157 void wxClientDisplayRect(int *x, int *y, int *width, int *height)
 158 {
 159     // This is supposed to return desktop dimensions minus any window
 160     // manager panels, menus, taskbars, etc.  If there is a way to do that
 161     // for this platform please fix this function, otherwise it defaults
 162     // to the entire desktop.
 163     if (x) *x = 0;
 164     if (y) *y = 0;
 165     wxDisplaySize(width, height);
 166 }
 167
 168 void wxGetMousePosition( int* x, int* y )
 169 {
 170     gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL );
 171 }
 172
 173 bool wxColourDisplay()
 174 {
 175     return true;
 176 }
 177
 178 int wxDisplayDepth()
 179 {
 180     return gdk_drawable_get_visual( wxGetRootWindow()->window )->depth;
 181 }
 182
 183 wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
 184 {
 185     return wxGenericFindWindowAtPoint(pt);
 186 }
 187
 188 #if !wxUSE_UNICODE
 189
 190 wxCharBuffer wxConvertToGTK(const wxString& s, wxFontEncoding enc)
 191 {
 192     wxWCharBuffer wbuf;
 193     if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )
 194     {
 195         wbuf = wxConvUI->cMB2WC(s);
 196     }
 197     else // another encoding, use generic conversion class
 198     {
 199         wbuf = wxCSConv(enc).cMB2WC(s);
 200     }
 201
 202     if ( !wbuf && !s.empty() )
 203     {
 204         // conversion failed, but we still want to show something to the user
 205         // even if it's going to be wrong it is better than nothing
 206         //
 207         // we choose ISO8859-1 here arbitrarily, it's just the most common
 208         // encoding probably and, also importantly here, conversion from it
 209         // never fails as it's done internally by wxCSConv
 210         wbuf = wxCSConv(wxFONTENCODING_ISO8859_1).cMB2WC(s);
 211     }
 212
 213     return wxConvUTF8.cWC2MB(wbuf);
 214 }
 215
 216 wxCharBuffer wxConvertFromGTK(const wxString& s, wxFontEncoding enc)
 217 {
 218     // this conversion should never fail as GTK+ always uses UTF-8 internally
 219     // so there are no complications here
 220     const wxWCharBuffer wbuf(wxConvUTF8.cMB2WC(s));
 221     if ( enc == wxFONTENCODING_SYSTEM )
 222         return wxConvUI->cWC2MB(wbuf);
 223
 224     return wxCSConv(enc).cWC2MB(wbuf);
 225 }
 226
 227 #endif // !wxUSE_UNICODE
 228
 229 // Returns false if version is certainly greater or equal than major.minor.micro
 230 // Returns true if version is lower than major.minor.micro OR it cannot be
 231 // determined and one should not rely on the availability of pango version
 232 // major.minor.micro, nor the non-availability
 233 const gchar *wx_pango_version_check (int major, int minor, int micro)
 234 {
 235 #ifdef PANGO_VERSION_MAJOR
 236     if (!gtk_check_version (2,11,0))
 237     {
 238         // GTK+ 2.11 requires Pango >= 1.15.3 and pango_version_check
 239         // was added in Pango 1.15.2 thus we know for sure the pango lib we're
 240         // using has the pango_version_check function:
 241         return pango_version_check (major, minor, micro);
 242     }
 243
 244     return "can't check";
 245 #else // !PANGO_VERSION_MAJOR
 246     return "too old headers";
 247 #endif
 248 }
 249
 250
 251 // ----------------------------------------------------------------------------
 252 // subprocess routines
 253 // ----------------------------------------------------------------------------
 254
 255 extern "C" {
 256 static
 257 void GTK_EndProcessDetector(gpointer data, gint source,
 258                             GdkInputCondition WXUNUSED(condition) )
 259 {
 260    wxEndProcessData *proc_data = (wxEndProcessData *)data;
 261
 262    // has the process really terminated? unfortunately GDK (or GLib) seem to
 263    // generate G_IO_HUP notification even when it simply tries to read from a
 264    // closed fd and hasn't terminated at all
 265    int pid = (proc_data->pid > 0) ? proc_data->pid : -(proc_data->pid);
 266    int status = 0;
 267    int rc = waitpid(pid, &status, WNOHANG);
 268
 269    if ( rc == 0 )
 270    {
 271        // no, it didn't exit yet, continue waiting
 272        return;
 273    }
 274
 275    // set exit code to -1 if something bad happened
 276    proc_data->exitcode = rc != -1 && WIFEXITED(status) ? WEXITSTATUS(status)
 277                                                       : -1;
 278
 279    // child exited, end waiting
 280    close(source);
 281
 282    // don't call us again!
 283    gdk_input_remove(proc_data->tag);
 284
 285    wxHandleProcessTermination(proc_data);
 286 }
 287 }
 288
 289 int wxAddProcessCallback(wxEndProcessData *proc_data, int fd)
 290 {
 291     int tag = gdk_input_add(fd,
 292                             GDK_INPUT_READ,
 293                             GTK_EndProcessDetector,
 294                             (gpointer)proc_data);
 295
 296     return tag;
 297 }
 298
 299
 300
 301 // ----------------------------------------------------------------------------
 302 // wxPlatformInfo-related
 303 // ----------------------------------------------------------------------------
 304
 305 wxPortId wxGUIAppTraits::GetToolkitVersion(int *verMaj, int *verMin) const
 306 {
 307     if ( verMaj )
 308         *verMaj = gtk_major_version;
 309     if ( verMin )
 310         *verMin = gtk_minor_version;
 311
 312     return wxPORT_GTK;
 313 }
 314
 315 wxTimerImpl *wxGUIAppTraits::CreateTimerImpl(wxTimer *timer)
 316 {
 317     return new wxGTKTimerImpl(timer);
 318 }
 319
 320 #if wxUSE_DETECT_SM
 321 static wxString GetSM()
 322 {
 323     class Dpy
 324     {
 325     public:
 326         Dpy() { m_dpy = XOpenDisplay(NULL); }
 327         ~Dpy() { if ( m_dpy ) XCloseDisplay(m_dpy); }
 328
 329         operator Display *() const { return m_dpy; }
 330     private:
 331         Display *m_dpy;
 332     } dpy;
 333
 334     if ( !dpy )
 335         return wxEmptyString;
 336
 337     char smerr[256];
 338     char *client_id;
 339     SmcConn smc_conn = SmcOpenConnection(NULL, NULL,
 340                                          999, 999,
 341                                          0 /* mask */, NULL /* callbacks */,
 342                                          NULL, &client_id,
 343                                          WXSIZEOF(smerr), smerr);
 344
 345     if ( !smc_conn )
 346     {
 347         wxLogWarning(_("Failed to connect to session manager: %s"), smerr);
 348         return wxEmptyString;
 349     }
 350
 351     char *vendor = SmcVendor(smc_conn);
 352     wxString ret = wxString::FromAscii( vendor );
 353     free(vendor);
 354
 355     SmcCloseConnection(smc_conn, 0, NULL);
 356     free(client_id);
 357
 358     return ret;
 359 }
 360 #endif // wxUSE_DETECT_SM
 361
 362
 363 //-----------------------------------------------------------------------------
 364 // wxGUIAppTraits
 365 //-----------------------------------------------------------------------------
 366
 367 wxEventLoop *wxGUIAppTraits::CreateEventLoop()
 368 {
 369     return new wxEventLoop();
 370 }
 371
 372
 373 #if wxUSE_INTL
 374 void wxGUIAppTraits::SetLocale()
 375 {
 376     gtk_set_locale();
 377     wxUpdateLocaleIsUtf8();
 378 }
 379 #endif
 380
 381 #ifdef __WXDEBUG__
 382
 383 #if wxUSE_STACKWALKER
 384
 385 // private helper class
 386 class StackDump : public wxStackWalker
 387 {
 388 public:
 389     StackDump(GtkAssertDialog *dlg) { m_dlg=dlg; }
 390
 391 protected:
 392     virtual void OnStackFrame(const wxStackFrame& frame)
 393     {
 394         wxString fncname = frame.GetName();
 395         wxString fncargs = fncname;
 396
 397         size_t n = fncname.find(wxT('('));
 398         if (n != wxString::npos)
 399         {
 400             // remove arguments from function name
 401             fncname.erase(n);
 402
 403             // remove function name and brackets from arguments
 404             fncargs = fncargs.substr(n+1, fncargs.length()-n-2);
 405         }
 406         else
 407             fncargs = wxEmptyString;
 408
 409         // append this stack frame's info in the dialog
 410         if (!frame.GetFileName().empty() || !fncname.empty())
 411             gtk_assert_dialog_append_stack_frame(m_dlg,
 412                                                 fncname.mb_str(),
 413                                                 fncargs.mb_str(),
 414                                                 frame.GetFileName().mb_str(),
 415                                                 frame.GetLine());
 416     }
 417
 418 private:
 419     GtkAssertDialog *m_dlg;
 420 };
 421
 422 // the callback functions must be extern "C" to comply with GTK+ declarations
 423 extern "C"
 424 {
 425     void get_stackframe_callback(StackDump *dump)
 426     {
 427         // skip over frames up to including wxOnAssert()
 428         dump->ProcessFrames(3);
 429     }
 430 }
 431
 432 #endif      // wxUSE_STACKWALKER
 433
 434 bool wxGUIAppTraits::ShowAssertDialog(const wxString& msg)
 435 {
 436     // under GTK2 we prefer to use a dialog widget written using directly GTK+;
 437     // in fact we cannot use a dialog written using wxWidgets: it would need
 438     // the wxWidgets idle processing to work correctly!
 439     GtkWidget *dialog = gtk_assert_dialog_new();
 440     gtk_assert_dialog_set_message(GTK_ASSERT_DIALOG(dialog), msg.mb_str());
 441
 442 #if wxUSE_STACKWALKER
 443     // don't show more than maxLines or we could get a dialog too tall to be
 444     // shown on screen: 20 should be ok everywhere as even with 15 pixel high
 445     // characters it is still only 300 pixels...
 446     static const int maxLines = 20;
 447
 448     // save current stack frame...
 449     StackDump dump(GTK_ASSERT_DIALOG(dialog));
 450     dump.SaveStack(maxLines);
 451
 452     // ...but process it only if the user needs it
 453     gtk_assert_dialog_set_backtrace_callback(GTK_ASSERT_DIALOG(dialog),
 454                                              (GtkAssertDialogStackFrameCallback)get_stackframe_callback,
 455                                              &dump);
 456 #endif      // wxUSE_STACKWALKER
 457
 458     gint result = gtk_dialog_run(GTK_DIALOG (dialog));
 459     bool returnCode = false;
 460     switch (result)
 461     {
 462     case GTK_ASSERT_DIALOG_STOP:
 463         wxTrap();
 464         break;
 465     case GTK_ASSERT_DIALOG_CONTINUE:
 466         // nothing to do
 467         break;
 468     case GTK_ASSERT_DIALOG_CONTINUE_SUPPRESSING:
 469         // no more asserts
 470         returnCode = true;
 471         break;
 472
 473     default:
 474         wxFAIL_MSG( _T("unexpected return code from GtkAssertDialog") );
 475     }
 476
 477     gtk_widget_destroy(dialog);
 478     return returnCode;
 479 }
 480
 481 #endif  // __WXDEBUG__
 482
 483 wxString wxGUIAppTraits::GetDesktopEnvironment() const
 484 {
 485     wxString de = wxSystemOptions::GetOption(_T("gtk.desktop"));
 486     if ( de.empty() )
 487     {
 488 #if wxUSE_DETECT_SM
 489         static const wxString s_SM = GetSM();
 490
 491         if (s_SM == wxT("GnomeSM"))
 492             de = wxT("GNOME");
 493         else if (s_SM == wxT("KDE"))
 494             de = wxT("KDE");
 495     }
 496 #endif // wxUSE_DETECT_SM
 497
 498     return de;
 499 }
 500
 501 #ifdef __WXGTK26__
 502
 503 // see the hack below in wxCmdLineParser::GetUsageString().
 504 // TODO: replace this hack with a g_option_group_get_entries()
 505 //       call as soon as such function exists
 506 struct _GOptionGroup
 507 {
 508   gchar           *name;
 509   gchar           *description;
 510   gchar           *help_description;
 511
 512   GDestroyNotify   destroy_notify;
 513   gpointer         user_data;
 514
 515   GTranslateFunc   translate_func;
 516   GDestroyNotify   translate_notify;
 517   gpointer     translate_data;
 518
 519   GOptionEntry    *entries;
 520   gint             n_entries;
 521
 522   GOptionParseFunc pre_parse_func;
 523   GOptionParseFunc post_parse_func;
 524   GOptionErrorFunc error_func;
 525 };
 526
 527 wxString wxGetNameFromGtkOptionEntry(const GOptionEntry *opt)
 528 {
 529     wxString ret;
 530
 531     if (opt->short_name)
 532         ret << _T("-") << opt->short_name;
 533     if (opt->long_name)
 534     {
 535         if (!ret.empty())
 536             ret << _T(", ");
 537         ret << _T("--") << opt->long_name;
 538
 539         if (opt->arg_description)
 540             ret << _T("=") << opt->arg_description;
 541     }
 542
 543     return _T("  ") + ret;
 544 }
 545
 546 #endif // __WXGTK26__
 547
 548 wxString
 549 wxGUIAppTraits::GetStandardCmdLineOptions(wxArrayString& names,
 550                                           wxArrayString& desc) const
 551 {
 552     wxString usage;
 553
 554 #ifdef __WXGTK26__
 555     // check whether GTK version is greater than 2.6 but also lower than 2.12
 556     // because, as we use the undocumented _GOptionGroup struct, we don't want
 557     // to run this code with future versions which might change it (2.11 is the
 558     // latest one at the time of this writing)
 559     if (!gtk_check_version(2,6,0) &&
 560         gtk_check_version(2,12,0))
 561     {
 562         usage << _("The following standard GTK+ options are also supported:\n");
 563
 564         // passing true here means that the function can open the default
 565         // display while parsing (not really used here anyhow)
 566         GOptionGroup *gtkOpts = gtk_get_option_group(true);
 567
 568         // WARNING: here we access the internals of GOptionGroup:
 569         GOptionEntry *entries = ((_GOptionGroup*)gtkOpts)->entries;
 570         unsigned int n_entries = ((_GOptionGroup*)gtkOpts)->n_entries;
 571         wxArrayString namesOptions, descOptions;
 572
 573         for ( size_t n = 0; n < n_entries; n++ )
 574         {
 575             if ( entries[n].flags & G_OPTION_FLAG_HIDDEN )
 576                 continue;       // skip
 577
 578             names.push_back(wxGetNameFromGtkOptionEntry(&entries[n]));
 579
 580             const gchar * const entryDesc = entries[n].description;
 581             desc.push_back(entryDesc ? wxString(entryDesc) : _T(""));
 582         }
 583
 584         g_option_group_free (gtkOpts);
 585     }
 586 #else
 587     wxUnusedVar(names);
 588     wxUnusedVar(desc);
 589 #endif // __WXGTK26__
 590
 591     return usage;
 592 }
 593