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