]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/utilsgtk.cpp
#11259: Correction for bad help button on OSX
[wxWidgets.git] / src / gtk / utilsgtk.cpp
index 35dd71d871ee0f46c3fee1fdd81611886a6e978f..bfcbbc8ab20497ec8a771cf321381e7600418f1f 100644 (file)
 #include "wx/wxprec.h"
 
 #include "wx/utils.h"
 #include "wx/wxprec.h"
 
 #include "wx/utils.h"
-#include "wx/string.h"
 
 
-#include "wx/apptrait.h"
-#include "wx/intl.h"
-#include "wx/log.h"
+#ifndef WX_PRECOMP
+    #include "wx/string.h"
+    #include "wx/intl.h"
+    #include "wx/log.h"
+#endif
 
 
+#include "wx/apptrait.h"
 #include "wx/process.h"
 #include "wx/process.h"
-
+#include "wx/sysopt.h"
 #include "wx/unix/execute.h"
 
 #include "wx/unix/execute.h"
 
+#include "wx/gtk/private/timer.h"
+#include "wx/evtloop.h"
+
+#if wxDEBUG_LEVEL
+    #include "wx/gtk/assertdlg_gtk.h"
+    #if wxUSE_STACKWALKER
+        #include "wx/stackwalk.h"
+    #endif // wxUSE_STACKWALKER
+#endif // wxDEBUG_LEVEL
+
 #include <stdarg.h>
 #include <string.h>
 #include <sys/stat.h>
 #include <stdarg.h>
 #include <string.h>
 #include <sys/stat.h>
 #include "gtk/gtk.h"
 #include "gdk/gdkx.h"
 
 #include "gtk/gtk.h"
 #include "gdk/gdkx.h"
 
-#ifdef HAVE_X11_XKBLIB_H
-    /* under HP-UX and Solaris 2.6, at least, XKBlib.h defines structures with
-     * field named "explicit" - which is, of course, an error for a C++
-     * compiler. To be on the safe side, just redefine it everywhere. */
-    #define explicit __wx_explicit
-
-    #include "X11/XKBlib.h"
-
-    #undef explicit
-#endif // HAVE_X11_XKBLIB_H
+#if wxUSE_DETECT_SM
+    #include "X11/Xlib.h"
+    #include "X11/SM/SMlib.h"
+#endif
 
 //-----------------------------------------------------------------------------
 // data
 
 //-----------------------------------------------------------------------------
 // data
@@ -62,57 +68,6 @@ void wxBell()
 }
 #endif
 
 }
 #endif
 
-/* Don't synthesize KeyUp events holding down a key and producing
-   KeyDown events with autorepeat. */
-#ifdef HAVE_X11_XKBLIB_H
-bool wxSetDetectableAutoRepeat( bool flag )
-{
-    Bool result;
-    XkbSetDetectableAutoRepeat( GDK_DISPLAY(), flag, &result );
-    return result;       /* TRUE if keyboard hardware supports this mode */
-}
-#else
-bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
-{
-    return FALSE;
-}
-#endif
-
-// Escapes string so that it is valid Pango markup XML string:
-wxString wxEscapeStringForPangoMarkup(const wxString& str)
-{
-    size_t len = str.length();
-    wxString out;
-    out.Alloc(len);
-    for (size_t i = 0; i < len; i++)
-    {
-        wxChar c = str[i];
-        switch (c)
-        {
-            case _T('&'):
-                out << _T("&amp;");
-                break;
-            case _T('<'):
-                out << _T("&lt;");
-                break;
-            case _T('>'):
-                out << _T("&gt;");
-                break;
-            case _T('\''):
-                out << _T("&apos;");
-                break;
-            case _T('"'):
-                out << _T("&quot;");
-                break;
-            default:
-                out << c;
-                break;
-        }
-    }
-    return out;
-}
-
-
 // ----------------------------------------------------------------------------
 // display characterstics
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // display characterstics
 // ----------------------------------------------------------------------------
@@ -134,25 +89,14 @@ void wxDisplaySizeMM( int *width, int *height )
     if (height) *height = gdk_screen_height_mm();
 }
 
     if (height) *height = gdk_screen_height_mm();
 }
 
-void wxClientDisplayRect(int *x, int *y, int *width, int *height)
-{
-    // This is supposed to return desktop dimensions minus any window
-    // manager panels, menus, taskbars, etc.  If there is a way to do that
-    // for this platform please fix this function, otherwise it defaults
-    // to the entire desktop.
-    if (x) *x = 0;
-    if (y) *y = 0;
-    wxDisplaySize(width, height);
-}
-
 void wxGetMousePosition( int* x, int* y )
 {
 void wxGetMousePosition( int* x, int* y )
 {
-    gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL );
+    gdk_window_get_pointer( NULL, x, y, NULL );
 }
 
 bool wxColourDisplay()
 {
 }
 
 bool wxColourDisplay()
 {
-    return TRUE;
+    return true;
 }
 
 int wxDisplayDepth()
 }
 
 int wxDisplayDepth()
@@ -160,21 +104,6 @@ int wxDisplayDepth()
     return gdk_drawable_get_visual( wxGetRootWindow()->window )->depth;
 }
 
     return gdk_drawable_get_visual( wxGetRootWindow()->window )->depth;
 }
 
-wxToolkitInfo& wxGUIAppTraits::GetToolkitInfo()
-{
-    static wxToolkitInfo info;
-    info.shortName = _T("gtk2");
-    info.name = _T("wxGTK");
-#ifdef __WXUNIVERSAL__
-    info.shortName << _T("univ");
-    info.name << _T("/wxUniversal");
-#endif
-    info.versionMajor = gtk_major_version;
-    info.versionMinor = gtk_minor_version;
-    info.os = wxGTK;
-    return info;
-}
-
 wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
 {
     return wxGenericFindWindowAtPoint(pt);
 wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
 {
     return wxGenericFindWindowAtPoint(pt);
@@ -182,33 +111,77 @@ wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
 
 #if !wxUSE_UNICODE
 
 
 #if !wxUSE_UNICODE
 
-wxCharBuffer wxConvertToGTK(const wxString& s, wxFontEncoding enc)
+WXDLLIMPEXP_CORE wxCharBuffer
+wxConvertToGTK(const wxString& s, wxFontEncoding enc)
 {
 {
-    if ( enc == wxFONTENCODING_UTF8 )
-    {
-        // no need for conversion at all
-        return wxCharBuffer(s);
-    }
-
     wxWCharBuffer wbuf;
     if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )
     {
     wxWCharBuffer wbuf;
     if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )
     {
-        wbuf = wxConvLocal.cMB2WC(s);
+        wbuf = wxConvUI->cMB2WC(s.c_str());
     }
     else // another encoding, use generic conversion class
     {
     }
     else // another encoding, use generic conversion class
     {
-        wbuf = wxCSConv(enc).cMB2WC(s);
+        wbuf = wxCSConv(enc).cMB2WC(s.c_str());
     }
 
     }
 
-    wxCharBuffer buf;
-    if ( wbuf )
-        buf = wxConvUTF8.cWC2MB(wbuf);
+    if ( !wbuf && !s.empty() )
+    {
+        // conversion failed, but we still want to show something to the user
+        // even if it's going to be wrong it is better than nothing
+        //
+        // we choose ISO8859-1 here arbitrarily, it's just the most common
+        // encoding probably and, also importantly here, conversion from it
+        // never fails as it's done internally by wxCSConv
+        wbuf = wxCSConv(wxFONTENCODING_ISO8859_1).cMB2WC(s.c_str());
+    }
+
+    return wxConvUTF8.cWC2MB(wbuf);
+}
+
+WXDLLIMPEXP_CORE wxCharBuffer
+wxConvertFromGTK(const wxString& s, wxFontEncoding enc)
+{
+    // this conversion should never fail as GTK+ always uses UTF-8 internally
+    // so there are no complications here
+    const wxWCharBuffer wbuf(wxConvUTF8.cMB2WC(s.c_str()));
+    if ( enc == wxFONTENCODING_SYSTEM )
+        return wxConvUI->cWC2MB(wbuf);
 
 
-    return buf;
+    return wxCSConv(enc).cWC2MB(wbuf);
 }
 
 #endif // !wxUSE_UNICODE
 
 }
 
 #endif // !wxUSE_UNICODE
 
+// Returns NULL if version is certainly greater or equal than major.minor.micro
+// Returns string describing the error if version is lower than
+// major.minor.micro OR it cannot be determined and one should not rely on the
+// availability of pango version major.minor.micro, nor the non-availability
+const gchar *wx_pango_version_check (int major, int minor, int micro)
+{
+    // NOTE: you don't need to use this macro to check for Pango features
+    //       added in pango-1.4 or earlier since GTK 2.4 (our minimum requirement
+    //       for GTK lib) required pango 1.4...
+
+#ifdef PANGO_VERSION_MAJOR
+    if (!gtk_check_version (2,11,0))
+    {
+        // GTK+ 2.11 requires Pango >= 1.15.3 and pango_version_check
+        // was added in Pango 1.15.2 thus we know for sure the pango lib we're
+        // using has the pango_version_check function:
+        return pango_version_check (major, minor, micro);
+    }
+
+    return "can't check";
+#else // !PANGO_VERSION_MAJOR
+    wxUnusedVar(major);
+    wxUnusedVar(minor);
+    wxUnusedVar(micro);
+
+    return "too old headers";
+#endif
+}
+
+
 // ----------------------------------------------------------------------------
 // subprocess routines
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // subprocess routines
 // ----------------------------------------------------------------------------
@@ -216,38 +189,22 @@ wxCharBuffer wxConvertToGTK(const wxString& s, wxFontEncoding enc)
 extern "C" {
 static
 void GTK_EndProcessDetector(gpointer data, gint source,
 extern "C" {
 static
 void GTK_EndProcessDetector(gpointer data, gint source,
-                            GdkInputCondition WXUNUSED(condition) )
+                            GdkInputCondition WXUNUSED(condition))
 {
 {
-   wxEndProcessData *proc_data = (wxEndProcessData *)data;
-
-   // has the process really terminated? unfortunately GDK (or GLib) seem to
-   // generate G_IO_HUP notification even when it simply tries to read from a
-   // closed fd and hasn't terminated at all
-   int pid = (proc_data->pid > 0) ? proc_data->pid : -(proc_data->pid);
-   int status = 0;
-   int rc = waitpid(pid, &status, WNOHANG);
-
-   if ( rc == 0 )
-   {
-       // no, it didn't exit yet, continue waiting
-       return;
-   }
-
-   // set exit code to -1 if something bad happened
-   proc_data->exitcode = rc != -1 && WIFEXITED(status) ? WEXITSTATUS(status)
-                                                      : -1;
+    wxEndProcessData * const
+        proc_data = static_cast<wxEndProcessData *>(data);
 
 
-   // child exited, end waiting
-   close(source);
+    // child exited, end waiting
+    close(source);
 
 
-   // don't call us again!
-   gdk_input_remove(proc_data->tag);
+    // don't call us again!
+    gdk_input_remove(proc_data->tag);
 
 
-   wxHandleProcessTermination(proc_data);
+    wxHandleProcessTermination(proc_data);
 }
 }
 
 }
 }
 
-int wxAddProcessCallback(wxEndProcessData *proc_data, int fd)
+int wxGUIAppTraits::AddProcessCallback(wxEndProcessData *proc_data, int fd)
 {
     int tag = gdk_input_add(fd,
                             GDK_INPUT_READ,
 {
     int tag = gdk_input_add(fd,
                             GDK_INPUT_READ,
@@ -257,3 +214,311 @@ int wxAddProcessCallback(wxEndProcessData *proc_data, int fd)
     return tag;
 }
 
     return tag;
 }
 
+
+
+// ----------------------------------------------------------------------------
+// wxPlatformInfo-related
+// ----------------------------------------------------------------------------
+
+wxPortId wxGUIAppTraits::GetToolkitVersion(int *verMaj, int *verMin) const
+{
+    if ( verMaj )
+        *verMaj = gtk_major_version;
+    if ( verMin )
+        *verMin = gtk_minor_version;
+
+    return wxPORT_GTK;
+}
+
+#if wxUSE_TIMER
+
+wxTimerImpl *wxGUIAppTraits::CreateTimerImpl(wxTimer *timer)
+{
+    return new wxGTKTimerImpl(timer);
+}
+
+#endif // wxUSE_TIMER
+
+#if wxUSE_DETECT_SM
+static wxString GetSM()
+{
+    class Dpy
+    {
+    public:
+        Dpy() { m_dpy = XOpenDisplay(NULL); }
+        ~Dpy() { if ( m_dpy ) XCloseDisplay(m_dpy); }
+
+        operator Display *() const { return m_dpy; }
+    private:
+        Display *m_dpy;
+    } dpy;
+
+    if ( !dpy )
+        return wxEmptyString;
+
+    char smerr[256];
+    char *client_id;
+    SmcConn smc_conn = SmcOpenConnection(NULL, NULL,
+                                         999, 999,
+                                         0 /* mask */, NULL /* callbacks */,
+                                         NULL, &client_id,
+                                         WXSIZEOF(smerr), smerr);
+
+    if ( !smc_conn )
+    {
+        wxLogDebug("Failed to connect to session manager: %s", smerr);
+        return wxEmptyString;
+    }
+
+    char *vendor = SmcVendor(smc_conn);
+    wxString ret = wxString::FromAscii( vendor );
+    free(vendor);
+
+    SmcCloseConnection(smc_conn, 0, NULL);
+    free(client_id);
+
+    return ret;
+}
+#endif // wxUSE_DETECT_SM
+
+
+//-----------------------------------------------------------------------------
+// wxGUIAppTraits
+//-----------------------------------------------------------------------------
+
+wxEventLoopBase *wxGUIAppTraits::CreateEventLoop()
+{
+    return new wxEventLoop();
+}
+
+
+#if wxUSE_INTL
+void wxGUIAppTraits::SetLocale()
+{
+    gtk_set_locale();
+    wxUpdateLocaleIsUtf8();
+}
+#endif
+
+#if wxDEBUG_LEVEL && wxUSE_STACKWALKER
+
+// private helper class
+class StackDump : public wxStackWalker
+{
+public:
+    StackDump(GtkAssertDialog *dlg) { m_dlg=dlg; }
+
+protected:
+    virtual void OnStackFrame(const wxStackFrame& frame)
+    {
+        wxString fncname = frame.GetName();
+        wxString fncargs = fncname;
+
+        size_t n = fncname.find(wxT('('));
+        if (n != wxString::npos)
+        {
+            // remove arguments from function name
+            fncname.erase(n);
+
+            // remove function name and brackets from arguments
+            fncargs = fncargs.substr(n+1, fncargs.length()-n-2);
+        }
+        else
+            fncargs = wxEmptyString;
+
+        // append this stack frame's info in the dialog
+        if (!frame.GetFileName().empty() || !fncname.empty())
+            gtk_assert_dialog_append_stack_frame(m_dlg,
+                                                fncname.mb_str(),
+                                                fncargs.mb_str(),
+                                                frame.GetFileName().mb_str(),
+                                                frame.GetLine());
+    }
+
+private:
+    GtkAssertDialog *m_dlg;
+};
+
+// the callback functions must be extern "C" to comply with GTK+ declarations
+extern "C"
+{
+    void get_stackframe_callback(StackDump *dump)
+    {
+        // skip over frames up to including wxOnAssert()
+        dump->ProcessFrames(3);
+    }
+}
+
+#endif // wxDEBUG_LEVEL && wxUSE_STACKWALKER
+
+bool wxGUIAppTraits::ShowAssertDialog(const wxString& msg)
+{
+#if wxDEBUG_LEVEL
+    // under GTK2 we prefer to use a dialog widget written using directly in
+    // GTK+ as use a dialog written using wxWidgets would need the wxWidgets
+    // idle processing to work correctly which might not be the case when
+    // assert happens
+    GtkWidget *dialog = gtk_assert_dialog_new();
+    gtk_assert_dialog_set_message(GTK_ASSERT_DIALOG(dialog), msg.mb_str());
+
+#if wxUSE_STACKWALKER
+    // don't show more than maxLines or we could get a dialog too tall to be
+    // shown on screen: 20 should be ok everywhere as even with 15 pixel high
+    // characters it is still only 300 pixels...
+    static const int maxLines = 20;
+
+    // save current stack frame...
+    StackDump dump(GTK_ASSERT_DIALOG(dialog));
+    dump.SaveStack(maxLines);
+
+    // ...but process it only if the user needs it
+    gtk_assert_dialog_set_backtrace_callback(GTK_ASSERT_DIALOG(dialog),
+                                             (GtkAssertDialogStackFrameCallback)get_stackframe_callback,
+                                             &dump);
+#endif      // wxUSE_STACKWALKER
+
+    gint result = gtk_dialog_run(GTK_DIALOG (dialog));
+    bool returnCode = false;
+    switch (result)
+    {
+    case GTK_ASSERT_DIALOG_STOP:
+        wxTrap();
+        break;
+    case GTK_ASSERT_DIALOG_CONTINUE:
+        // nothing to do
+        break;
+    case GTK_ASSERT_DIALOG_CONTINUE_SUPPRESSING:
+        // no more asserts
+        returnCode = true;
+        break;
+
+    default:
+        wxFAIL_MSG( wxT("unexpected return code from GtkAssertDialog") );
+    }
+
+    gtk_widget_destroy(dialog);
+    return returnCode;
+#else // !wxDEBUG_LEVEL
+    // this function is never called in this case
+    wxUnusedVar(msg);
+    return false;
+#endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL
+}
+
+wxString wxGUIAppTraits::GetDesktopEnvironment() const
+{
+    wxString de = wxSystemOptions::GetOption(wxT("gtk.desktop"));
+#if wxUSE_DETECT_SM
+    if ( de.empty() )
+    {
+        static const wxString s_SM = GetSM();
+
+        if (s_SM == wxT("GnomeSM"))
+            de = wxT("GNOME");
+        else if (s_SM == wxT("KDE"))
+            de = wxT("KDE");
+    }
+#endif // wxUSE_DETECT_SM
+
+    return de;
+}
+
+#ifdef __WXGTK26__
+
+// see the hack below in wxCmdLineParser::GetUsageString().
+// TODO: replace this hack with a g_option_group_get_entries()
+//       call as soon as such function exists;
+//       see http://bugzilla.gnome.org/show_bug.cgi?id=431021 for the relative
+//       feature request
+struct _GOptionGroup
+{
+  gchar           *name;
+  gchar           *description;
+  gchar           *help_description;
+
+  GDestroyNotify   destroy_notify;
+  gpointer         user_data;
+
+  GTranslateFunc   translate_func;
+  GDestroyNotify   translate_notify;
+  gpointer     translate_data;
+
+  GOptionEntry    *entries;
+  gint             n_entries;
+
+  GOptionParseFunc pre_parse_func;
+  GOptionParseFunc post_parse_func;
+  GOptionErrorFunc error_func;
+};
+
+wxString wxGetNameFromGtkOptionEntry(const GOptionEntry *opt)
+{
+    wxString ret;
+
+    if (opt->short_name)
+        ret << wxT("-") << opt->short_name;
+    if (opt->long_name)
+    {
+        if (!ret.empty())
+            ret << wxT(", ");
+        ret << wxT("--") << opt->long_name;
+
+        if (opt->arg_description)
+            ret << wxT("=") << opt->arg_description;
+    }
+
+    return wxT("  ") + ret;
+}
+
+#endif // __WXGTK26__
+
+wxString
+wxGUIAppTraits::GetStandardCmdLineOptions(wxArrayString& names,
+                                          wxArrayString& desc) const
+{
+    wxString usage;
+
+#ifdef __WXGTK26__
+    if (!gtk_check_version(2,6,0))
+    {
+        // since GTK>=2.6, we can use the glib_check_version() symbol...
+
+        // check whether GLib version is greater than 2.6 but also lower than 2.19
+        // because, as we use the undocumented _GOptionGroup struct, we don't want
+        // to run this code with future versions which might change it (2.19 is the
+        // latest one at the time of this writing)
+        if (!glib_check_version(2,6,0) && glib_check_version(2,20,0))
+        {
+            usage << _("The following standard GTK+ options are also supported:\n");
+
+            // passing true here means that the function can open the default
+            // display while parsing (not really used here anyhow)
+            GOptionGroup *gtkOpts = gtk_get_option_group(true);
+
+            // WARNING: here we access the internals of GOptionGroup:
+            GOptionEntry *entries = ((_GOptionGroup*)gtkOpts)->entries;
+            unsigned int n_entries = ((_GOptionGroup*)gtkOpts)->n_entries;
+            wxArrayString namesOptions, descOptions;
+
+            for ( size_t n = 0; n < n_entries; n++ )
+            {
+                if ( entries[n].flags & G_OPTION_FLAG_HIDDEN )
+                    continue;       // skip
+
+                names.push_back(wxGetNameFromGtkOptionEntry(&entries[n]));
+
+                const gchar * const entryDesc = entries[n].description;
+                desc.push_back(wxString(entryDesc));
+            }
+
+            g_option_group_free (gtkOpts);
+        }
+    }
+#else
+    wxUnusedVar(names);
+    wxUnusedVar(desc);
+#endif // __WXGTK26__
+
+    return usage;
+}
+