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 #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     // NOTE: you don't need to use this macro to check for Pango features
 190     //       added in pango-1.4 or earlier since GTK 2.4 (our minimum requirement
 191     //       for GTK lib) required pango 1.4...
 192
 193 #ifdef PANGO_VERSION_MAJOR
 194     if (!gtk_check_version (2,11,0))
 195     {
 196         // GTK+ 2.11 requires Pango >= 1.15.3 and pango_version_check
 197         // was added in Pango 1.15.2 thus we know for sure the pango lib we're
 198         // using has the pango_version_check function:
 199         return pango_version_check (major, minor, micro);
 200     }
 201
 202     return "can't check";
 203 #else // !PANGO_VERSION_MAJOR
 204     wxUnusedVar(major);
 205     wxUnusedVar(minor);
 206     wxUnusedVar(micro);
 207
 208     return "too old headers";
 209 #endif
 210 }
 211
 212
 213 // ----------------------------------------------------------------------------
 214 // subprocess routines
 215 // ----------------------------------------------------------------------------
 216
 217 extern "C" {
 218 static
 219 void GTK_EndProcessDetector(gpointer data, gint source,
 220                             GdkInputCondition WXUNUSED(condition))
 221 {
 222     wxEndProcessData * const
 223         proc_data = static_cast<wxEndProcessData *>(data);
 224
 225     // child exited, end waiting
 226     close(source);
 227
 228     // don't call us again!
 229     gdk_input_remove(proc_data->tag);
 230
 231     wxHandleProcessTermination(proc_data);
 232 }
 233 }
 234
 235 int wxGUIAppTraits::AddProcessCallback(wxEndProcessData *proc_data, int fd)
 236 {
 237     int tag = gdk_input_add(fd,
 238                             GDK_INPUT_READ,
 239                             GTK_EndProcessDetector,
 240                             (gpointer)proc_data);
 241
 242     return tag;
 243 }
 244
 245
 246
 247 // ----------------------------------------------------------------------------
 248 // wxPlatformInfo-related
 249 // ----------------------------------------------------------------------------
 250
 251 wxPortId wxGUIAppTraits::GetToolkitVersion(int *verMaj, int *verMin) const
 252 {
 253     if ( verMaj )
 254         *verMaj = gtk_major_version;
 255     if ( verMin )
 256         *verMin = gtk_minor_version;
 257
 258     return wxPORT_GTK;
 259 }
 260
 261 #if wxUSE_TIMER
 262
 263 wxTimerImpl *wxGUIAppTraits::CreateTimerImpl(wxTimer *timer)
 264 {
 265     return new wxGTKTimerImpl(timer);
 266 }
 267
 268 #endif // wxUSE_TIMER
 269
 270 #if wxUSE_DETECT_SM
 271 static wxString GetSM()
 272 {
 273     class Dpy
 274     {
 275     public:
 276         Dpy() { m_dpy = XOpenDisplay(NULL); }
 277         ~Dpy() { if ( m_dpy ) XCloseDisplay(m_dpy); }
 278
 279         operator Display *() const { return m_dpy; }
 280     private:
 281         Display *m_dpy;
 282     } dpy;
 283
 284     if ( !dpy )
 285         return wxEmptyString;
 286
 287     char smerr[256];
 288     char *client_id;
 289     SmcConn smc_conn = SmcOpenConnection(NULL, NULL,
 290                                          999, 999,
 291                                          0 /* mask */, NULL /* callbacks */,
 292                                          NULL, &client_id,
 293                                          WXSIZEOF(smerr), smerr);
 294
 295     if ( !smc_conn )
 296     {
 297         wxLogDebug("Failed to connect to session manager: %s", smerr);
 298         return wxEmptyString;
 299     }
 300
 301     char *vendor = SmcVendor(smc_conn);
 302     wxString ret = wxString::FromAscii( vendor );
 303     free(vendor);
 304
 305     SmcCloseConnection(smc_conn, 0, NULL);
 306     free(client_id);
 307
 308     return ret;
 309 }
 310 #endif // wxUSE_DETECT_SM
 311
 312
 313 //-----------------------------------------------------------------------------
 314 // wxGUIAppTraits
 315 //-----------------------------------------------------------------------------
 316
 317 wxEventLoopBase *wxGUIAppTraits::CreateEventLoop()
 318 {
 319     return new wxEventLoop();
 320 }
 321
 322
 323 #if wxUSE_INTL
 324 void wxGUIAppTraits::SetLocale()
 325 {
 326     gtk_set_locale();
 327     wxUpdateLocaleIsUtf8();
 328 }
 329 #endif
 330
 331 #if wxDEBUG_LEVEL && wxUSE_STACKWALKER
 332
 333 // private helper class
 334 class StackDump : public wxStackWalker
 335 {
 336 public:
 337     StackDump(GtkAssertDialog *dlg) { m_dlg=dlg; }
 338
 339 protected:
 340     virtual void OnStackFrame(const wxStackFrame& frame)
 341     {
 342         wxString fncname = frame.GetName();
 343         wxString fncargs = fncname;
 344
 345         size_t n = fncname.find(wxT('('));
 346         if (n != wxString::npos)
 347         {
 348             // remove arguments from function name
 349             fncname.erase(n);
 350
 351             // remove function name and brackets from arguments
 352             fncargs = fncargs.substr(n+1, fncargs.length()-n-2);
 353         }
 354         else
 355             fncargs = wxEmptyString;
 356
 357         // append this stack frame's info in the dialog
 358         if (!frame.GetFileName().empty() || !fncname.empty())
 359             gtk_assert_dialog_append_stack_frame(m_dlg,
 360                                                 fncname.mb_str(),
 361                                                 fncargs.mb_str(),
 362                                                 frame.GetFileName().mb_str(),
 363                                                 frame.GetLine());
 364     }
 365
 366 private:
 367     GtkAssertDialog *m_dlg;
 368 };
 369
 370 // the callback functions must be extern "C" to comply with GTK+ declarations
 371 extern "C"
 372 {
 373     void get_stackframe_callback(StackDump *dump)
 374     {
 375         // skip over frames up to including wxOnAssert()
 376         dump->ProcessFrames(3);
 377     }
 378 }
 379
 380 #endif // wxDEBUG_LEVEL && wxUSE_STACKWALKER
 381
 382 bool wxGUIAppTraits::ShowAssertDialog(const wxString& msg)
 383 {
 384 #if wxDEBUG_LEVEL
 385     // under GTK2 we prefer to use a dialog widget written using directly in
 386     // GTK+ as use a dialog written using wxWidgets would need the wxWidgets
 387     // idle processing to work correctly which might not be the case when
 388     // assert happens
 389     GtkWidget *dialog = gtk_assert_dialog_new();
 390     gtk_assert_dialog_set_message(GTK_ASSERT_DIALOG(dialog), msg.mb_str());
 391
 392 #if wxUSE_STACKWALKER
 393     // don't show more than maxLines or we could get a dialog too tall to be
 394     // shown on screen: 20 should be ok everywhere as even with 15 pixel high
 395     // characters it is still only 300 pixels...
 396     static const int maxLines = 20;
 397
 398     // save current stack frame...
 399     StackDump dump(GTK_ASSERT_DIALOG(dialog));
 400     dump.SaveStack(maxLines);
 401
 402     // ...but process it only if the user needs it
 403     gtk_assert_dialog_set_backtrace_callback(GTK_ASSERT_DIALOG(dialog),
 404                                              (GtkAssertDialogStackFrameCallback)get_stackframe_callback,
 405                                              &dump);
 406 #endif      // wxUSE_STACKWALKER
 407
 408     gint result = gtk_dialog_run(GTK_DIALOG (dialog));
 409     bool returnCode = false;
 410     switch (result)
 411     {
 412     case GTK_ASSERT_DIALOG_STOP:
 413         wxTrap();
 414         break;
 415     case GTK_ASSERT_DIALOG_CONTINUE:
 416         // nothing to do
 417         break;
 418     case GTK_ASSERT_DIALOG_CONTINUE_SUPPRESSING:
 419         // no more asserts
 420         returnCode = true;
 421         break;
 422
 423     default:
 424         wxFAIL_MSG( wxT("unexpected return code from GtkAssertDialog") );
 425     }
 426
 427     gtk_widget_destroy(dialog);
 428     return returnCode;
 429 #else // !wxDEBUG_LEVEL
 430     // this function is never called in this case
 431     wxUnusedVar(msg);
 432     return false;
 433 #endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL
 434 }
 435
 436 wxString wxGUIAppTraits::GetDesktopEnvironment() const
 437 {
 438     wxString de = wxSystemOptions::GetOption(wxT("gtk.desktop"));
 439 #if wxUSE_DETECT_SM
 440     if ( de.empty() )
 441     {
 442         static const wxString s_SM = GetSM();
 443
 444         if (s_SM == wxT("GnomeSM"))
 445             de = wxT("GNOME");
 446         else if (s_SM == wxT("KDE"))
 447             de = wxT("KDE");
 448     }
 449 #endif // wxUSE_DETECT_SM
 450
 451     return de;
 452 }
 453
 454 #ifdef __WXGTK26__
 455
 456 // see the hack below in wxCmdLineParser::GetUsageString().
 457 // TODO: replace this hack with a g_option_group_get_entries()
 458 //       call as soon as such function exists;
 459 //       see http://bugzilla.gnome.org/show_bug.cgi?id=431021 for the relative
 460 //       feature request
 461 struct _GOptionGroup
 462 {
 463   gchar           *name;
 464   gchar           *description;
 465   gchar           *help_description;
 466
 467   GDestroyNotify   destroy_notify;
 468   gpointer         user_data;
 469
 470   GTranslateFunc   translate_func;
 471   GDestroyNotify   translate_notify;
 472   gpointer     translate_data;
 473
 474   GOptionEntry    *entries;
 475   gint             n_entries;
 476
 477   GOptionParseFunc pre_parse_func;
 478   GOptionParseFunc post_parse_func;
 479   GOptionErrorFunc error_func;
 480 };
 481
 482 wxString wxGetNameFromGtkOptionEntry(const GOptionEntry *opt)
 483 {
 484     wxString ret;
 485
 486     if (opt->short_name)
 487         ret << wxT("-") << opt->short_name;
 488     if (opt->long_name)
 489     {
 490         if (!ret.empty())
 491             ret << wxT(", ");
 492         ret << wxT("--") << opt->long_name;
 493
 494         if (opt->arg_description)
 495             ret << wxT("=") << opt->arg_description;
 496     }
 497
 498     return wxT("  ") + ret;
 499 }
 500
 501 #endif // __WXGTK26__
 502
 503 wxString
 504 wxGUIAppTraits::GetStandardCmdLineOptions(wxArrayString& names,
 505                                           wxArrayString& desc) const
 506 {
 507     wxString usage;
 508
 509 #ifdef __WXGTK26__
 510     if (!gtk_check_version(2,6,0))
 511     {
 512         // since GTK>=2.6, we can use the glib_check_version() symbol...
 513
 514         // check whether GLib version is greater than 2.6 but also lower than 2.19
 515         // because, as we use the undocumented _GOptionGroup struct, we don't want
 516         // to run this code with future versions which might change it (2.19 is the
 517         // latest one at the time of this writing)
 518         if (!glib_check_version(2,6,0) && glib_check_version(2,20,0))
 519         {
 520             usage << _("The following standard GTK+ options are also supported:\n");
 521
 522             // passing true here means that the function can open the default
 523             // display while parsing (not really used here anyhow)
 524             GOptionGroup *gtkOpts = gtk_get_option_group(true);
 525
 526             // WARNING: here we access the internals of GOptionGroup:
 527             GOptionEntry *entries = ((_GOptionGroup*)gtkOpts)->entries;
 528             unsigned int n_entries = ((_GOptionGroup*)gtkOpts)->n_entries;
 529             wxArrayString namesOptions, descOptions;
 530
 531             for ( size_t n = 0; n < n_entries; n++ )
 532             {
 533                 if ( entries[n].flags & G_OPTION_FLAG_HIDDEN )
 534                     continue;       // skip
 535
 536                 names.push_back(wxGetNameFromGtkOptionEntry(&entries[n]));
 537
 538                 const gchar * const entryDesc = entries[n].description;
 539                 desc.push_back(wxString(entryDesc));
 540             }
 541
 542             g_option_group_free (gtkOpts);
 543         }
 544     }
 545 #else
 546     wxUnusedVar(names);
 547     wxUnusedVar(desc);
 548 #endif // __WXGTK26__
 549
 550     return usage;
 551 }
 552