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