Fix discrepancy between different ways of measuring text extents under Mac.

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

diff --git a/src/gtk/cursor.cpp b/src/gtk/cursor.cpp
index c4b56c61723c5b952d566b6b731993698d74c9dd..0dedcab00bc284214fef93b866bb7d4447ef1e1a 100644 (file)
--- a/src/gtk/cursor.cpp
+++ b/src/gtk/cursor.cpp
@@ -1,77 +1,150 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        cursor.cpp
-// Purpose:
+// Name:        src/gtk/cursor.cpp
+// Purpose:     wxCursor implementation

 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-
-#ifdef __GNUG__
-#pragma implementation "cursor.h"
-#endif
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"

 
 #include "wx/cursor.h"
 
 #include "wx/cursor.h"

-#include "wx/utils.h"
-#include "wx/app.h"

 
 

-#include <gdk/gdk.h>
-#include <gtk/gtk.h>
+#ifndef WX_PRECOMP
+    #include "wx/window.h"
+    #include "wx/app.h"
+    #include "wx/image.h"
+    #include "wx/bitmap.h"
+    #include "wx/log.h"
+#endif // WX_PRECOMP

 
 

-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
-
-extern void wxapp_install_idle_handler();
-extern bool g_isIdle;
+#include <gtk/gtk.h>

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

-// wxCursor
+// wxCursorRefData

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

-class wxCursorRefData: public wxObjectRefData
+class wxCursorRefData: public wxGDIRefData

 {
 {

-  public:
-
+public:

     wxCursorRefData();
     wxCursorRefData();

-    ~wxCursorRefData();
+    virtual ~wxCursorRefData();
+
+    virtual bool IsOk() const { return m_cursor != NULL; }

 
     GdkCursor *m_cursor;
 };
 
 wxCursorRefData::wxCursorRefData()
 {
 
     GdkCursor *m_cursor;
 };
 
 wxCursorRefData::wxCursorRefData()
 {

-    m_cursor = (GdkCursor *) NULL;
+    m_cursor = NULL;

 }
 
 wxCursorRefData::~wxCursorRefData()
 {
 }
 
 wxCursorRefData::~wxCursorRefData()
 {

-    if (m_cursor) gdk_cursor_destroy( m_cursor );
+    if (m_cursor) gdk_cursor_unref( m_cursor );

 }
 
 }
 

+
+//-----------------------------------------------------------------------------
+// wxCursor

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

-#define M_CURSORDATA ((wxCursorRefData *)m_refData)
+#define M_CURSORDATA static_cast<wxCursorRefData*>(m_refData)
+
+IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxGDIObject)
+
+// used in the following two ctors
+extern GtkWidget *wxGetRootWindow();

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxCursor,wxObject)

 
 wxCursor::wxCursor()
 {
 
 wxCursor::wxCursor()
 {

+}
+
+#if wxUSE_IMAGE
+wxCursor::wxCursor(const wxString& cursor_file,
+                   wxBitmapType type,
+                   int hotSpotX, int hotSpotY)
+{
+    wxImage img;
+    if (!img.LoadFile(cursor_file, type))
+        return;

 
 

+    // eventually set the hotspot:
+    if (!img.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X))
+        img.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotSpotX);
+    if (!img.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y))
+        img.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotSpotY);
+
+    InitFromImage(img);

 }
 
 }
 

-wxCursor::wxCursor( int cursorId )
+wxCursor::wxCursor(const wxImage& img)
+{
+    InitFromImage(img);
+}
+#endif
+
+wxCursor::wxCursor(const char bits[], int width, int height,
+                   int hotSpotX, int hotSpotY,
+                   const char maskBits[], const wxColour *fg, const wxColour *bg)
+{
+    if (!maskBits)
+        maskBits = bits;
+    if (!fg)
+        fg = wxBLACK;
+    if (!bg)
+        bg = wxWHITE;
+    if (hotSpotX < 0 || hotSpotX >= width)
+        hotSpotX = 0;
+    if (hotSpotY < 0 || hotSpotY >= height)
+        hotSpotY = 0;
+
+    GdkBitmap *data = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) bits, width, height );
+    GdkBitmap *mask = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) maskBits, width, height);
+
+    m_refData = new wxCursorRefData;
+    M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(
+                 data, mask, fg->GetColor(), bg->GetColor(),
+                 hotSpotX, hotSpotY );
+
+    g_object_unref (data);
+    g_object_unref (mask);
+}
+
+wxCursor::~wxCursor()
+{
+}
+
+void wxCursor::InitFromStock( wxStockCursor cursorId )

 {
     m_refData = new wxCursorRefData();
 
     GdkCursorType gdk_cur = GDK_LEFT_PTR;
     switch (cursorId)
     {
 {
     m_refData = new wxCursorRefData();
 
     GdkCursorType gdk_cur = GDK_LEFT_PTR;
     switch (cursorId)
     {

+        case wxCURSOR_BLANK:
+            {
+                const char bits[] = { 0 };
+                const GdkColor color = { 0, 0, 0, 0 };
+
+                GdkPixmap *pixmap = gdk_bitmap_create_from_data(NULL, bits, 1, 1);
+                M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(pixmap,
+                                                                    pixmap,
+                                                                    &color,
+                                                                    &color,
+                                                                    0, 0);
+                g_object_unref(pixmap);
+            }
+            return;
+

         case wxCURSOR_ARROW:            // fall through to default
         case wxCURSOR_DEFAULT:          gdk_cur = GDK_LEFT_PTR; break;
         case wxCURSOR_RIGHT_ARROW:      gdk_cur = GDK_RIGHT_PTR; break;
         case wxCURSOR_ARROW:            // fall through to default
         case wxCURSOR_DEFAULT:          gdk_cur = GDK_LEFT_PTR; break;
         case wxCURSOR_RIGHT_ARROW:      gdk_cur = GDK_RIGHT_PTR; break;

-        case wxCURSOR_HAND:             gdk_cur = GDK_HAND1; break;
+        case wxCURSOR_HAND:             gdk_cur = GDK_HAND2; break;

         case wxCURSOR_CROSS:            gdk_cur = GDK_CROSSHAIR; break;
         case wxCURSOR_SIZEWE:           gdk_cur = GDK_SB_H_DOUBLE_ARROW; break;
         case wxCURSOR_SIZENS:           gdk_cur = GDK_SB_V_DOUBLE_ARROW; break;
         case wxCURSOR_CROSS:            gdk_cur = GDK_CROSSHAIR; break;
         case wxCURSOR_SIZEWE:           gdk_cur = GDK_SB_H_DOUBLE_ARROW; break;
         case wxCURSOR_SIZENS:           gdk_cur = GDK_SB_V_DOUBLE_ARROW; break;


@@ -102,6 +175,7 @@ wxCursor::wxCursor( int cursorId )
         case wxCURSOR_BASED_ARROW_UP:   gdk_cur = GDK_BASED_ARROW_UP; break;
         case wxCURSOR_BASED_ARROW_DOWN: gdk_cur = GDK_BASED_ARROW_DOWN; break;
 */
         case wxCURSOR_BASED_ARROW_UP:   gdk_cur = GDK_BASED_ARROW_UP; break;
         case wxCURSOR_BASED_ARROW_DOWN: gdk_cur = GDK_BASED_ARROW_DOWN; break;
 */

+

         default:
             wxFAIL_MSG(wxT("unsupported cursor type"));
             // will use the standard one
         default:
             wxFAIL_MSG(wxT("unsupported cursor type"));
             // will use the standard one


@@ -111,213 +185,181 @@ wxCursor::wxCursor( int cursorId )
     M_CURSORDATA->m_cursor = gdk_cursor_new( gdk_cur );
 }
 
     M_CURSORDATA->m_cursor = gdk_cursor_new( gdk_cur );
 }
 

-extern GtkWidget *wxGetRootWindow();
+#if wxUSE_IMAGE

 
 

-wxCursor::wxCursor(const char bits[], int width, int  height,
-                   int hotSpotX, int hotSpotY,
-                   const char maskBits[], wxColour *fg, wxColour *bg)
+static void GetHotSpot(const wxImage& image, int& x, int& y)

 {
 {

-    if (!maskBits)
-        maskBits = bits;
-    if (!fg)
-        fg = wxBLACK;
-    if (!bg)
-        bg = wxWHITE;
-    if (hotSpotX < 0 || hotSpotX >= width)
-        hotSpotX = 0;
-    if (hotSpotY < 0 || hotSpotY >= height)
-        hotSpotY = 0;
-
-    GdkBitmap *data = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) bits, width, height );
-    GdkBitmap *mask = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) maskBits, width, height);
-
-    m_refData = new wxCursorRefData;
-    M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(
-                 data, mask, fg->GetColor(), bg->GetColor(),
-                 hotSpotX, hotSpotY );
-
-    gdk_bitmap_unref( data );
-    gdk_bitmap_unref( mask );
+    if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X))
+        x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
+    else
+        x = 0;
+
+    if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y))
+        y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
+    else
+        y = 0;
+
+    if (x < 0 || x >= image.GetWidth())
+        x = 0;
+    if (y < 0 || y >= image.GetHeight())
+        y = 0;

 }
 
 }
 

-
-wxCursor::wxCursor( const wxCursor &cursor )
+void wxCursor::InitFromImage( const wxImage & image )

 {
 {

-    Ref( cursor );
-}
+    int w = image.GetWidth() ;
+    int h = image.GetHeight();
+    bool bHasMask = image.HasMask();
+    int hotSpotX, hotSpotY;
+    GetHotSpot(image, hotSpotX, hotSpotY);
+    m_refData = new wxCursorRefData;
+    wxImage image_copy(image);

 
 

-#if wxUSE_IMAGE
-wxCursor::wxCursor( const wxImage & image )
-{
-    unsigned char * rgbBits = image.GetData();
-    int w = image.GetWidth()  ;
-    int h = image.GetHeight() ;
-    bool bHasMask = image.HasMask() ;
-    int imagebitcount = (w*h)/8;
-
-    unsigned char r, g, b ;
-    unsigned char * bits = new unsigned char [imagebitcount];
-    unsigned char * maskBits = new unsigned char [imagebitcount];
-
-    int i,j, i8; unsigned char c, cMask;
-    for (i=0; i<imagebitcount; i++)
+    GdkDisplay* display = gdk_drawable_get_display(wxGetRootWindow()->window);
+    if (gdk_display_supports_cursor_color(display))
+    {
+        if (!image.HasAlpha())

         {
         {

-        bits[i] = 0;
-        i8 = i * 8;
-
-        cMask = 1;
-        for (j=0; j<8; j++)
-           {
-           // possible overflow if we do the summation first ?
-           c = rgbBits[(i8+j)*3]/3 + rgbBits[(i8+j)*3+1]/3 + rgbBits[(i8+j)*3+2]/3 ;
-           //if average value is > mid grey
-           if (c>127)
-              bits[i] = bits[i] | cMask ;
-           cMask = cMask * 2 ;
-           }
+            // add alpha, so wxBitmap will convert to pixbuf format
+            image_copy.InitAlpha();

         }
         }

+        wxBitmap bitmap(image_copy);
+        wxASSERT(bitmap.HasPixbuf());
+        M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixbuf
+                             (
+                              display,
+                              bitmap.GetPixbuf(),
+                              hotSpotX, hotSpotY
+                             );
+        return;
+    }
+
+    unsigned long keyMaskColor = 0;
+    GdkPixmap* mask;

     if (bHasMask)
     if (bHasMask)

-        {
-        r = image.GetMaskRed() ;
-        g = image.GetMaskGreen() ;
-        b = image.GetMaskBlue() ;
+    {
+        keyMaskColor = wxImageHistogram::MakeKey(
+            image.GetMaskRed(), image.GetMaskGreen(), image.GetMaskBlue());
+        // get mask before image is modified
+        wxBitmap bitmap(image, 1);
+        mask = bitmap.GetMask()->GetBitmap();
+        g_object_ref(mask);
+    }
+    else
+    {
+        const int size = ((w + 7) / 8) * h;
+        char* bits = new char[size];
+        memset(bits, 0xff, size);
+        mask = gdk_bitmap_create_from_data(
+            wxGetRootWindow()->window, bits, w, h);
+        delete[] bits;
+    }

 
 

-        for (i=0; i<imagebitcount; i++)
-        {
-        maskBits[i] = 0x0;
-        i8 = i * 8;
-
-        cMask = 1;
-        for (j=0; j<8; j++)
-           {
-           if (rgbBits[(i8+j)*3] != r || rgbBits[(i8+j)*3+1] != g || rgbBits[(i8+j)*3+2] != b)
-              maskBits[i] = maskBits[i] | cMask ;
-           cMask = cMask * 2 ;
-           }
-        }
-        }
-      else
+    // modify image so wxBitmap can be used to convert to pixmap
+    image_copy.SetMask(false);
+    int i, j;
+    wxByte* data = image_copy.GetData();
+    for (j = 0; j < h; j++)
+    {
+        for (i = 0; i < w; i++, data += 3)

         {
         {

-        for (i=0; i<imagebitcount; i++)
-            maskBits[i]= 0xFF ;
+            //if average value is > mid grey
+            if (int(data[0]) + data[1] + data[2] >= 3 * 128)
+            {
+                // wxBitmap only converts (255,255,255) to white
+                data[0] = 255;
+                data[1] = 255;
+                data[2] = 255;
+            }

         }
         }

-    //find the most frequent color(s)
-    //it seems a waste of effort to copy the image
-    //but otherwise we need to remove the const modifier ??
-    wxImage tmpImage = image.Copy();
-    wxImageHistogram histogram;
-
-    //colors as rrggbb
-    unsigned long key;
-    unsigned long value;
-    unsigned long keyMaskColor = 0;
-    if (bHasMask)
-        keyMaskColor = (r << 16) | (g << 8) | b;
+    }
+    wxBitmap bitmap(image_copy, 1);

 
 

-    tmpImage.ComputeHistogram(histogram);
+    // find the most frequent color(s)
+    wxImageHistogram histogram;
+    image.ComputeHistogram(histogram);

 
 

-    long MostFreqCol = 0;
+    long colMostFreq = 0;

     unsigned long nMost = 0;
     unsigned long nMost = 0;

-    long NextFreqCol = 0;
+    long colNextMostFreq = 0;

     unsigned long nNext = 0;
     unsigned long nNext = 0;

-    wxImageHistogram::iterator entry = histogram.begin();
-
-    while ( entry != histogram.end() )
+    for ( wxImageHistogram::iterator entry = histogram.begin();
+          entry != histogram.end();
+          ++entry )

     {
     {

-        value = entry->second.value;
-        key = entry->first;
+        unsigned long key = entry->first;

         if ( !bHasMask || (key != keyMaskColor) )
         {
         if ( !bHasMask || (key != keyMaskColor) )
         {

+            unsigned long value = entry->second.value;

             if (value > nMost)
             {
             if (value > nMost)
             {

+                nNext = nMost;
+                colNextMostFreq = colMostFreq;

                 nMost = value;
                 nMost = value;

-                MostFreqCol = key;
+                colMostFreq = key;

             }
             else if (value > nNext)
             {
                 nNext = value;
             }
             else if (value > nNext)
             {
                 nNext = value;

-                NextFreqCol = key;
+                colNextMostFreq = key;

             }
         }
     }
 
             }
         }
     }
 

-    wxColour fg = wxColour ( (unsigned char)(MostFreqCol >> 16),
-                             (unsigned char)(MostFreqCol >> 8),
-                             (unsigned char)(MostFreqCol) ) ;
-
-    wxColour bg = wxColour ( (unsigned char)(NextFreqCol >> 16),
-                             (unsigned char)(NextFreqCol >> 8),
-                             (unsigned char)(NextFreqCol) ) ;
-
-    int hotSpotX=0;
-    int hotSpotY=0;
-
-    if (image.HasOption(wxCUR_HOTSPOT_X))
-        hotSpotX = image.GetOptionInt(wxCUR_HOTSPOT_X);
-    if (image.HasOption(wxCUR_HOTSPOT_Y))
-        hotSpotY = image.GetOptionInt(wxCUR_HOTSPOT_Y);
-
-    if (hotSpotX < 0 || hotSpotX >= w)
-        hotSpotX = 0;
-    if (hotSpotY < 0 || hotSpotY >= h)
-        hotSpotY = 0;
-
-    GdkBitmap *data = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) bits,
-        w, h );
-    GdkBitmap *mask = gdk_bitmap_create_from_data( wxGetRootWindow()->window, (gchar *) maskBits,
-        w, h );
-
-    m_refData = new wxCursorRefData;
-    M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap(
-        data, mask, fg.GetColor(), bg.GetColor(),
-        hotSpotX, hotSpotY );
+    wxColour fg = wxColour ( (unsigned char)(colMostFreq >> 16),
+                             (unsigned char)(colMostFreq >> 8),
+                             (unsigned char)(colMostFreq) );

 
 

-    gdk_bitmap_unref( data );
-    gdk_bitmap_unref( mask );
-    delete [] bits ;
-    delete [] maskBits;
-}
-#endif
+    wxColour bg = wxColour ( (unsigned char)(colNextMostFreq >> 16),
+                             (unsigned char)(colNextMostFreq >> 8),
+                             (unsigned char)(colNextMostFreq) );

 
 

-wxCursor::~wxCursor()
-{
-}
+    int fg_intensity = fg.Red() + fg.Green() + fg.Blue();
+    int bg_intensity = bg.Red() + bg.Green() + bg.Blue();

 
 

-wxCursor& wxCursor::operator = ( const wxCursor& cursor )
-{
-    if (*this == cursor)
-        return (*this);
+    if (bg_intensity > fg_intensity)
+    {
+        //swap fg and bg
+        wxColour tmp = fg;
+        fg = bg;
+        bg = tmp;
+    }

 
 

-    Ref( cursor );
+    M_CURSORDATA->m_cursor = gdk_cursor_new_from_pixmap
+                             (
+                                bitmap.GetPixmap(),
+                                mask,
+                                fg.GetColor(), bg.GetColor(),
+                                hotSpotX, hotSpotY
+                             );

 
 

-    return *this;
+    g_object_unref (mask);

 }
 
 }
 

-bool wxCursor::operator == ( const wxCursor& cursor ) const
-{
-    return m_refData == cursor.m_refData;
-}
+#endif // wxUSE_IMAGE

 
 

-bool wxCursor::operator != ( const wxCursor& cursor ) const
+GdkCursor *wxCursor::GetCursor() const

 {
 {

-    return m_refData != cursor.m_refData;
+    return M_CURSORDATA->m_cursor;

 }
 
 }
 

-bool wxCursor::Ok() const
+wxGDIRefData *wxCursor::CreateGDIRefData() const

 {
 {

-    return (m_refData != NULL);
+    return new wxCursorRefData;

 }
 
 }
 

-GdkCursor *wxCursor::GetCursor() const
+wxGDIRefData *wxCursor::CloneGDIRefData(const wxGDIRefData *data) const

 {
 {

-    return M_CURSORDATA->m_cursor;
+    return new wxCursorRefData(*static_cast<const wxCursorRefData *>(data));

 }
 
 //-----------------------------------------------------------------------------
 // busy cursor routines
 //-----------------------------------------------------------------------------
 
 }
 
 //-----------------------------------------------------------------------------
 // busy cursor routines
 //-----------------------------------------------------------------------------
 

-extern wxCursor g_globalCursor;
+/* Current cursor, in order to hang on to
+ * cursor handle when setting the cursor globally */
+wxCursor g_globalCursor;

 
 static wxCursor  gs_savedCursor;
 static int       gs_busyCount = 0;
 
 static wxCursor  gs_savedCursor;
 static int       gs_busyCount = 0;


@@ -332,19 +374,31 @@ const wxCursor wxBusyCursor::GetBusyCursor()
     return wxCursor(wxCURSOR_WATCH);
 }
 
     return wxCursor(wxCURSOR_WATCH);
 }
 

+static void InternalIdle(const wxWindowList& list, GdkDisplay*& display)
+{
+    wxWindowList::const_iterator i = list.begin();
+    for (size_t n = list.size(); n--; ++i)
+    {
+        wxWindow* win = *i;
+        if (display == NULL && win->m_widget && win->m_widget->window)
+            display = gdk_drawable_get_display(win->m_widget->window);
+        win->OnInternalIdle();
+        InternalIdle(win->GetChildren(), display);
+    }
+}
+

 void wxEndBusyCursor()
 {
     if (--gs_busyCount > 0)
         return;
 
 void wxEndBusyCursor()
 {
     if (--gs_busyCount > 0)
         return;
 

-    wxSetCursor( gs_savedCursor );
+    g_globalCursor = gs_savedCursor;

     gs_savedCursor = wxNullCursor;
     gs_savedCursor = wxNullCursor;

-
-    if (wxTheApp)
-        wxTheApp->SendIdleEvents();
+    GdkDisplay* unused = NULL;
+    InternalIdle(wxTopLevelWindows, unused);

 }
 
 }
 

-void wxBeginBusyCursor( wxCursor *WXUNUSED(cursor) )
+void wxBeginBusyCursor(const wxCursor* cursor)

 {
     if (gs_busyCount++ > 0)
         return;
 {
     if (gs_busyCount++ > 0)
         return;


@@ -353,13 +407,11 @@ void wxBeginBusyCursor( wxCursor *WXUNUSED(cursor) )
                   wxT("forgot to call wxEndBusyCursor, will leak memory") );
 
     gs_savedCursor = g_globalCursor;
                   wxT("forgot to call wxEndBusyCursor, will leak memory") );
 
     gs_savedCursor = g_globalCursor;

-
-    wxSetCursor( wxCursor(wxCURSOR_WATCH) );
-
-    if (wxTheApp)
-        wxTheApp->SendIdleEvents();
-
-    gdk_flush();
+    g_globalCursor = *cursor;
+    GdkDisplay* display = NULL;
+    InternalIdle(wxTopLevelWindows, display);
+    if (display)
+        gdk_display_flush(display);

 }
 
 bool wxIsBusy()
 }
 
 bool wxIsBusy()


@@ -369,8 +421,6 @@ bool wxIsBusy()
 
 void wxSetCursor( const wxCursor& cursor )
 {
 
 void wxSetCursor( const wxCursor& cursor )
 {

-    if (g_isIdle)
-        wxapp_install_idle_handler();
-

     g_globalCursor = cursor;
     g_globalCursor = cursor;

+    wxTheApp->WakeUpIdle();

 }
 }