new file added

[wxWidgets.git] / src / gtk / utilsgtk.cpp

diff --git a/src/gtk/utilsgtk.cpp b/src/gtk/utilsgtk.cpp
index 287cb599485f5b610a3b82257cb6a1b9aab0be72..9c82997f3cadd43650921736f39dcd3a452564f2 100644 (file)
--- a/src/gtk/utilsgtk.cpp
+++ b/src/gtk/utilsgtk.cpp
@@ -19,40 +19,46 @@
 #endif
 
 #include "wx/apptrait.h"
 #endif
 
 #include "wx/apptrait.h"

-

 #include "wx/process.h"
 #include "wx/process.h"

-
+#include "wx/sysopt.h"
+#ifdef __UNIX__

 #include "wx/unix/execute.h"
 #include "wx/unix/execute.h"

+#endif
+
+#include "wx/gtk/private/timer.h"
+#include "wx/evtloop.h"
+
+#include <gtk/gtk.h>
+#ifdef GDK_WINDOWING_WIN32
+#include <gdk/gdkwin32.h>
+#endif
+#ifdef GDK_WINDOWING_X11
+#include <gdk/gdkx.h>
+#endif
+
+#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 <sys/types.h>
 
 #include <stdarg.h>
 #include <string.h>
 #include <sys/stat.h>
 #include <sys/types.h>

-#include <sys/wait.h>   // for WNOHANG
+#ifdef __UNIX__

 #include <unistd.h>
 #include <unistd.h>

-
-#include "glib.h"
-#include "gdk/gdk.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
-
+#endif

 
 #if wxUSE_DETECT_SM
 
 #if wxUSE_DETECT_SM

-    #include "X11/Xlib.h"
-    #include "X11/SM/SMlib.h"
+    #include <X11/SM/SMlib.h>
+
+    #include "wx/unix/utilsx11.h"

 #endif
 
 #endif
 

+#include "wx/gtk/private/gtk2-compat.h"
+

 //-----------------------------------------------------------------------------
 // data
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // data
 //-----------------------------------------------------------------------------


@@ -62,74 +68,22 @@ extern GtkWidget *wxGetRootWindow();
 //----------------------------------------------------------------------------
 // misc.
 //----------------------------------------------------------------------------
 //----------------------------------------------------------------------------
 // misc.
 //----------------------------------------------------------------------------

-#ifndef __EMX__
-// on OS/2, we use the wxBell from wxBase library

 
 void wxBell()
 {
     gdk_beep();
 }
 
 void wxBell()
 {
     gdk_beep();
 }

-#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 characteristics

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

+#ifdef GDK_WINDOWING_X11

 void *wxGetDisplay()
 {
 void *wxGetDisplay()
 {

-    return GDK_DISPLAY();
+    return GDK_DISPLAY_XDISPLAY(gtk_widget_get_display(wxGetRootWindow()));

 }
 }

+#endif

 
 void wxDisplaySize( int *width, int *height )
 {
 
 void wxDisplaySize( int *width, int *height )
 {


@@ -143,20 +97,9 @@ 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(gtk_widget_get_root_window(wxGetRootWindow()), x, y, NULL);

 }
 
 bool wxColourDisplay()
 }
 
 bool wxColourDisplay()


@@ -166,7 +109,7 @@ bool wxColourDisplay()
 
 int wxDisplayDepth()
 {
 
 int wxDisplayDepth()
 {

-    return gdk_drawable_get_visual( wxGetRootWindow()->window )->depth;
+    return gdk_visual_get_depth(gtk_widget_get_visual(wxGetRootWindow()));

 }
 
 wxWindow* wxFindWindowAtPoint(const wxPoint& pt)
 }
 
 wxWindow* wxFindWindowAtPoint(const wxPoint& pt)


@@ -176,105 +119,110 @@ 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)

 {
 {

-    wxCharBuffer buf;
-    if ( enc == wxFONTENCODING_UTF8 )
+    wxWCharBuffer wbuf;
+    if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )

     {
     {

-        // no need for conversion at all, but do check that we have a valid
-        // UTF-8 string because passing invalid UTF-8 to GTK+ is going to
-        // result in a GTK+ error message and, especially, loss of data which
-        // was supposed to be shown in the GUI
-        if ( wxConvUTF8.ToWChar(NULL, 0, s, s.length()) == wxCONV_FAILED )
-        {
-            // warn the programmer that something is probably wrong in his code
-            //
-            // NB: don't include the string in output because chances are that
-            //     this invalid UTF-8 string could result in more errors itself
-            //     if the application shows logs in the GUI and so we get into
-            //     an infinite loop
-            wxLogDebug(_T("Invalid UTF-8 string in wxConvertToGTK()"));
-
-            // but still try to show at least something on the screen
-            wxMBConvUTF8 utf8permissive(wxMBConvUTF8::MAP_INVALID_UTF8_TO_OCTAL);
-            wxWCharBuffer wbuf(utf8permissive.cMB2WC(s));
-            buf = wxConvUTF8.cWC2MB(wbuf);
-        }
-        else // valid UTF-8 string, no need to convert
-        {
-            buf = wxCharBuffer(s);
-        }
+        wbuf = wxConvUI->cMB2WC(s);

     }
     }

-    else // !UTF-8
+    else // another encoding, use generic conversion class

     {
     {

-        wxWCharBuffer wbuf;
-        if ( enc == wxFONTENCODING_SYSTEM || enc == wxFONTENCODING_DEFAULT )
-        {
-            wbuf = wxConvUI->cMB2WC(s);
-        }
-        else // another encoding, use generic conversion class
-        {
-            wbuf = wxCSConv(enc).cMB2WC(s);
-        }
+        wbuf = wxCSConv(enc).cMB2WC(s.c_str());
+    }

 
 

-        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 buf;
+    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 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 __WXGTK3__
+    return pango_version_check(major, minor, micro);
+#elif defined(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
 // ----------------------------------------------------------------------------
 

+#ifdef __UNIX__
+

 extern "C" {
 extern "C" {

-static
-void GTK_EndProcessDetector(gpointer data, gint source,
-                            GdkInputCondition WXUNUSED(condition) )
+static gboolean EndProcessDetector(GIOChannel* source, GIOCondition, void* data)

 {
 {

-   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(g_io_channel_unix_get_fd(source));

 
 

-   // don't call us again!
-   gdk_input_remove(proc_data->tag);
+    wxHandleProcessTermination(proc_data);

 
 

-   wxHandleProcessTermination(proc_data);
+    // don't call us again!
+    return false;

 }
 }
 
 }
 }
 

-int wxAddProcessCallback(wxEndProcessData *proc_data, int fd)
+int wxGUIAppTraits::AddProcessCallback(wxEndProcessData *proc_data, int fd)

 {
 {

-    int tag = gdk_input_add(fd,
-                            GDK_INPUT_READ,
-                            GTK_EndProcessDetector,
-                            (gpointer)proc_data);
-
-    return tag;
+    GIOChannel* channel = g_io_channel_unix_new(fd);
+    GIOCondition cond = GIOCondition(G_IO_IN | G_IO_HUP | G_IO_ERR);
+    unsigned id = g_io_add_watch(channel, cond, EndProcessDetector, proc_data);
+    g_io_channel_unref(channel);
+    return int(id);

 }
 
 }
 

-
+#endif // __UNIX__

 
 // ----------------------------------------------------------------------------
 // wxPlatformInfo-related
 
 // ----------------------------------------------------------------------------
 // wxPlatformInfo-related


@@ -290,52 +238,285 @@ wxPortId wxGUIAppTraits::GetToolkitVersion(int *verMaj, int *verMin) const
     return wxPORT_GTK;
 }
 
     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()
 {
 #if wxUSE_DETECT_SM
 static wxString GetSM()
 {

-    Display     *dpy;
-    SmcConn     smc_conn;
-    char        *vendor;
-    char        *client_id_ret;
-    dpy = XOpenDisplay(NULL);
-
-    smc_conn = SmcOpenConnection(NULL, NULL,
-                                    999, 999,
-                                    0 /* mask */, NULL /* callbacks */,
-                                    NULL, &client_id_ret, 0, NULL);
-
-    if (smc_conn)
+    wxX11Display 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 )

     {
     {

-        vendor = SmcVendor(smc_conn);
-        wxString ret = wxString::FromAscii( vendor );
-        free(vendor);
+        wxLogDebug("Failed to connect to session manager: %s", smerr);
+        return wxEmptyString;
+    }

 
 

-        SmcCloseConnection(smc_conn, 0, NULL);
-        free(client_id_ret);
+    char *vendor = SmcVendor(smc_conn);
+    wxString ret = wxString::FromAscii( vendor );
+    free(vendor);

 
 

-        XCloseDisplay(dpy);
-        
-        return ret;
-    }
-    
-    return wxEmptyString;
+    SmcCloseConnection(smc_conn, 0, NULL);
+    free(client_id);
+
+    return ret;
+}
+#endif // wxUSE_DETECT_SM
+
+
+//-----------------------------------------------------------------------------
+// wxGUIAppTraits
+//-----------------------------------------------------------------------------
+
+wxEventLoopBase *wxGUIAppTraits::CreateEventLoop()
+{
+    return new wxEventLoop();
+}
+
+
+#if wxUSE_INTL && defined(__UNIX__)
+void wxGUIAppTraits::SetLocale()
+{
+#ifdef __WXGTK3__
+    setlocale(LC_ALL, "");
+#else
+    gtk_set_locale();
+#endif
+    wxUpdateLocaleIsUtf8();

 }
 #endif
 
 }
 #endif
 

+#ifdef __UNIX__
+
+#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();
+
+        // 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(),
+                                                frame.GetFileName().mb_str(),
+                                                frame.GetLine());
+    }
+
+private:
+    GtkAssertDialog *m_dlg;
+};
+
+static void get_stackframe_callback(void* p)
+{
+    StackDump* dump = static_cast<StackDump*>(p);
+    // skip over frames up to including wxOnAssert()
+    dump->ProcessFrames(3);
+}
+
+#endif // wxDEBUG_LEVEL && wxUSE_STACKWALKER
+
+bool wxGUIAppTraits::ShowAssertDialog(const wxString& msg)
+{
+#if wxDEBUG_LEVEL
+    // we can't show the dialog from another thread
+    if ( wxIsMainThread() )
+    {
+        // 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
+        // save the current stack ow...
+        StackDump dump(GTK_ASSERT_DIALOG(dialog));
+        dump.SaveStack(100); // showing more than 100 frames is not very useful
+
+        // ...but process it only if the user needs it
+        gtk_assert_dialog_set_backtrace_callback
+        (
+            GTK_ASSERT_DIALOG(dialog),
+            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;
+    }
+#endif // wxDEBUG_LEVEL
+
+    return wxAppTraitsBase::ShowAssertDialog(msg);
+}
+
+#endif // __UNIX__
+
+#if defined(__UNIX__) || defined(__OS2__)
+

 wxString wxGUIAppTraits::GetDesktopEnvironment() const
 {
 wxString wxGUIAppTraits::GetDesktopEnvironment() const
 {

+    wxString de = wxSystemOptions::GetOption(wxT("gtk.desktop"));

 #if wxUSE_DETECT_SM
 #if wxUSE_DETECT_SM

-    wxString SM = GetSM();
-    
-    if (SM == wxT("GnomeSM"))
-        return wxT("GNOME");
-        
-    if (SM == wxT("KDE"))
-        return wxT("KDE");
-#endif
+    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;
+}
+
+#endif // __UNIX__ || __OS2__
+
+#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;

 
 

-    return wxEmptyString;
+        if (opt->arg_description)
+            ret << wxT("=") << opt->arg_description;
+    }
+
+    return wxT("  ") + ret;

 }
 
 }
 

+#endif // __WXGTK26__
+
+#ifdef __UNIX__
+
+wxString
+wxGUIAppTraits::GetStandardCmdLineOptions(wxArrayString& names,
+                                          wxArrayString& desc) const
+{
+    wxString usage;
+
+#ifdef __WXGTK26__
+#ifndef __WXGTK3__
+    if (!gtk_check_version(2,6,0))
+#endif
+    {
+        // 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.33
+        // because, as we use the undocumented _GOptionGroup struct, we don't want
+        // to run this code with future versions which might change it (2.32 is the
+        // latest one at the time of this writing)
+        if (glib_check_version(2,6,0) == NULL && glib_check_version(2,33,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;
+}

 
 

+#endif // __UNIX__