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
  25 #include "wx/unix/execute.h"
  26
  27 #include "wx/gtk/private/timer.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 // Escapes string so that it is valid Pango markup XML string:
 100 wxString wxEscapeStringForPangoMarkup(const wxString& str)
 101 {
 102     size_t len = str.length();
 103     wxString out;
 104     out.Alloc(len);
 105     for (size_t i = 0; i < len; i++)
 106     {
 107         wxChar c = str[i];
 108         switch (c)
 109         {
 110             case _T('&'):
 111                 out << _T("&amp;");
 112                 break;
 113             case _T('<'):
 114                 out << _T("&lt;");
 115                 break;
 116             case _T('>'):
 117                 out << _T("&gt;");
 118                 break;
 119             case _T('\''):
 120                 out << _T("&apos;");
 121                 break;
 122             case _T('"'):
 123                 out << _T("&quot;");
 124                 break;
 125             default:
 126                 out << c;
 127                 break;
 128         }
 129     }
 130     return out;
 131 }
 132
 133
 134 // ----------------------------------------------------------------------------
 135 // display characterstics
 136 // ----------------------------------------------------------------------------
 137
 138 void *wxGetDisplay()
 139 {
 140     return GDK_DISPLAY();
 141 }
 142
 143 void wxDisplaySize( int *width, int *height )
 144 {
 145     if (width) *width = gdk_screen_width();
 146     if (height) *height = gdk_screen_height();
 147 }
 148
 149 void wxDisplaySizeMM( int *width, int *height )
 150 {
 151     if (width) *width = gdk_screen_width_mm();
 152     if (height) *height = gdk_screen_height_mm();
 153 }
 154
 155 void wxClientDisplayRect(int *x, int *y, int *width, int *height)
 156 {
 157     // This is supposed to return desktop dimensions minus any window
 158     // manager panels, menus, taskbars, etc.  If there is a way to do that
 159     // for this platform please fix this function, otherwise it defaults
 160     // to the entire desktop.
 161     if (x) *x = 0;
 162     if (y) *y = 0;
 163     wxDisplaySize(width, height);
 164 }
 165
 166 void wxGetMousePosition( int* x, int* y )
 167 {
 168     gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL );
 169 }
 170
 171 bool wxColourDisplay()
 172 {
 173     return true;
 174 }
 175
 176 int wxDisplayDepth()
 177 {
 178     return gdk_drawable_get_visual( wxGetRootWindow()->window )->depth;
 179 }
 180
 181 wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
 182 {
 183     return wxGenericFindWindowAtPoint(pt);
 184 }
 185
 186 #if !wxUSE_UNICODE
 187
 188 wxCharBuffer wxConvertToGTK(const wxString& s, wxFontEncoding enc)
 189 {
 190     wxWCharBuffer wbuf;
 191     if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )
 192     {
 193         wbuf = wxConvUI->cMB2WC(s);
 194     }
 195     else // another encoding, use generic conversion class
 196     {
 197         wbuf = wxCSConv(enc).cMB2WC(s);
 198     }
 199
 200     if ( !wbuf && !s.empty() )
 201     {
 202         // conversion failed, but we still want to show something to the user
 203         // even if it's going to be wrong it is better than nothing
 204         //
 205         // we choose ISO8859-1 here arbitrarily, it's just the most common
 206         // encoding probably and, also importantly here, conversion from it
 207         // never fails as it's done internally by wxCSConv
 208         wbuf = wxCSConv(wxFONTENCODING_ISO8859_1).cMB2WC(s);
 209     }
 210
 211     return wxConvUTF8.cWC2MB(wbuf);
 212 }
 213
 214 wxCharBuffer wxConvertFromGTK(const wxString& s, wxFontEncoding enc)
 215 {
 216     // this conversion should never fail as GTK+ always uses UTF-8 internally
 217     // so there are no complications here
 218     const wxWCharBuffer wbuf(wxConvUTF8.cMB2WC(s));
 219     if ( enc == wxFONTENCODING_SYSTEM )
 220         return wxConvUI->cWC2MB(wbuf);
 221
 222     return wxCSConv(enc).cWC2MB(wbuf);
 223 }
 224
 225 #endif // !wxUSE_UNICODE
 226
 227 // ----------------------------------------------------------------------------
 228 // subprocess routines
 229 // ----------------------------------------------------------------------------
 230
 231 extern "C" {
 232 static
 233 void GTK_EndProcessDetector(gpointer data, gint source,
 234                             GdkInputCondition WXUNUSED(condition) )
 235 {
 236    wxEndProcessData *proc_data = (wxEndProcessData *)data;
 237
 238    // has the process really terminated? unfortunately GDK (or GLib) seem to
 239    // generate G_IO_HUP notification even when it simply tries to read from a
 240    // closed fd and hasn't terminated at all
 241    int pid = (proc_data->pid > 0) ? proc_data->pid : -(proc_data->pid);
 242    int status = 0;
 243    int rc = waitpid(pid, &status, WNOHANG);
 244
 245    if ( rc == 0 )
 246    {
 247        // no, it didn't exit yet, continue waiting
 248        return;
 249    }
 250
 251    // set exit code to -1 if something bad happened
 252    proc_data->exitcode = rc != -1 && WIFEXITED(status) ? WEXITSTATUS(status)
 253                                                       : -1;
 254
 255    // child exited, end waiting
 256    close(source);
 257
 258    // don't call us again!
 259    gdk_input_remove(proc_data->tag);
 260
 261    wxHandleProcessTermination(proc_data);
 262 }
 263 }
 264
 265 int wxAddProcessCallback(wxEndProcessData *proc_data, int fd)
 266 {
 267     int tag = gdk_input_add(fd,
 268                             GDK_INPUT_READ,
 269                             GTK_EndProcessDetector,
 270                             (gpointer)proc_data);
 271
 272     return tag;
 273 }
 274
 275
 276
 277 // ----------------------------------------------------------------------------
 278 // wxPlatformInfo-related
 279 // ----------------------------------------------------------------------------
 280
 281 wxPortId wxGUIAppTraits::GetToolkitVersion(int *verMaj, int *verMin) const
 282 {
 283     if ( verMaj )
 284         *verMaj = gtk_major_version;
 285     if ( verMin )
 286         *verMin = gtk_minor_version;
 287
 288     return wxPORT_GTK;
 289 }
 290
 291 wxTimerImpl *wxGUIAppTraits::CreateTimerImpl(wxTimer *timer)
 292 {
 293     return new wxGTKTimerImpl(timer);
 294 }
 295
 296 #if wxUSE_DETECT_SM
 297 static wxString GetSM()
 298 {
 299     class Dpy
 300     {
 301     public:
 302         Dpy() { m_dpy = XOpenDisplay(NULL); }
 303         ~Dpy() { if ( m_dpy ) XCloseDisplay(m_dpy); }
 304
 305         operator Display *() const { return m_dpy; }
 306     private:
 307         Display *m_dpy;
 308     } dpy;
 309
 310     if ( !dpy )
 311         return wxEmptyString;
 312
 313     char *client_id;
 314     SmcConn smc_conn = SmcOpenConnection(NULL, NULL,
 315                                          999, 999,
 316                                          0 /* mask */, NULL /* callbacks */,
 317                                          NULL, &client_id,
 318                                          0, NULL);
 319
 320     if ( !smc_conn )
 321         return wxEmptyString;
 322
 323     char *vendor = SmcVendor(smc_conn);
 324     wxString ret = wxString::FromAscii( vendor );
 325     free(vendor);
 326
 327     SmcCloseConnection(smc_conn, 0, NULL);
 328     free(client_id);
 329
 330     return ret;
 331 }
 332 #endif // wxUSE_DETECT_SM
 333
 334
 335 //-----------------------------------------------------------------------------
 336 // wxGUIAppTraits
 337 //-----------------------------------------------------------------------------
 338
 339 #if wxUSE_INTL
 340 void wxGUIAppTraits::SetLocale()
 341 {
 342     gtk_set_locale();
 343 }
 344 #endif
 345
 346 #ifdef __WXDEBUG__
 347
 348 #if wxUSE_STACKWALKER
 349
 350 // private helper class
 351 class StackDump : public wxStackWalker
 352 {
 353 public:
 354     StackDump(GtkAssertDialog *dlg) { m_dlg=dlg; }
 355
 356 protected:
 357     virtual void OnStackFrame(const wxStackFrame& frame)
 358     {
 359         wxString fncname = frame.GetName();
 360         wxString fncargs = fncname;
 361
 362         size_t n = fncname.find(wxT('('));
 363         if (n != wxString::npos)
 364         {
 365             // remove arguments from function name
 366             fncname.erase(n);
 367
 368             // remove function name and brackets from arguments
 369             fncargs = fncargs.substr(n+1, fncargs.length()-n-2);
 370         }
 371         else
 372             fncargs = wxEmptyString;
 373
 374         // append this stack frame's info in the dialog
 375         if (!frame.GetFileName().empty() || !fncname.empty())
 376             gtk_assert_dialog_append_stack_frame(m_dlg,
 377                                                 fncname.mb_str(),
 378                                                 fncargs.mb_str(),
 379                                                 frame.GetFileName().mb_str(),
 380                                                 frame.GetLine());
 381     }
 382
 383 private:
 384     GtkAssertDialog *m_dlg;
 385 };
 386
 387 // the callback functions must be extern "C" to comply with GTK+ declarations
 388 extern "C"
 389 {
 390     void get_stackframe_callback(StackDump *dump)
 391     {
 392         // skip over frames up to including wxOnAssert()
 393         dump->ProcessFrames(3);
 394     }
 395 }
 396
 397 #endif      // wxUSE_STACKWALKER
 398
 399 bool wxGUIAppTraits::ShowAssertDialog(const wxString& msg)
 400 {
 401     // under GTK2 we prefer to use a dialog widget written using directly GTK+;
 402     // in fact we cannot use a dialog written using wxWidgets: it would need
 403     // the wxWidgets idle processing to work correctly!
 404     GtkWidget *dialog = gtk_assert_dialog_new();
 405     gtk_assert_dialog_set_message(GTK_ASSERT_DIALOG(dialog), msg.mb_str());
 406
 407 #if wxUSE_STACKWALKER
 408     // don't show more than maxLines or we could get a dialog too tall to be
 409     // shown on screen: 20 should be ok everywhere as even with 15 pixel high
 410     // characters it is still only 300 pixels...
 411     static const int maxLines = 20;
 412
 413     // save current stack frame...
 414     StackDump dump(GTK_ASSERT_DIALOG(dialog));
 415     dump.SaveStack(maxLines);
 416
 417     // ...but process it only if the user needs it
 418     gtk_assert_dialog_set_backtrace_callback(GTK_ASSERT_DIALOG(dialog),
 419                                              (GtkAssertDialogStackFrameCallback)get_stackframe_callback,
 420                                              &dump);
 421 #endif      // wxUSE_STACKWALKER
 422
 423     gint result = gtk_dialog_run(GTK_DIALOG (dialog));
 424     bool returnCode = false;
 425     switch (result)
 426     {
 427     case GTK_ASSERT_DIALOG_STOP:
 428         wxTrap();
 429         break;
 430     case GTK_ASSERT_DIALOG_CONTINUE:
 431         // nothing to do
 432         break;
 433     case GTK_ASSERT_DIALOG_CONTINUE_SUPPRESSING:
 434         // no more asserts
 435         returnCode = true;
 436         break;
 437
 438     default:
 439         wxFAIL_MSG( _T("unexpected return code from GtkAssertDialog") );
 440     }
 441
 442     gtk_widget_destroy(dialog);
 443     return returnCode;
 444 }
 445
 446 #endif  // __WXDEBUG__
 447
 448 wxString wxGUIAppTraits::GetDesktopEnvironment() const
 449 {
 450 #if wxUSE_DETECT_SM
 451     const wxString SM = GetSM();
 452
 453     if (SM == wxT("GnomeSM"))
 454         return wxT("GNOME");
 455
 456     if (SM == wxT("KDE"))
 457         return wxT("KDE");
 458 #endif // wxUSE_DETECT_SM
 459
 460     return wxEmptyString;
 461 }
 462
 463
 464