defer creating bitmap representation until it is needed

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63090 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/gtk/bitmap.h

@@ -104,8 +104,7 @@ public:
     void SetHeight( int height );
     void SetWidth( int width );
     void SetDepth( int depth );
-    void SetPixmap( GdkPixmap *pixmap );
+    void SetPixbuf(GdkPixbuf* pixbuf);
-    void SetPixbuf(GdkPixbuf* pixbuf, int depth = 0);
 
     GdkPixmap *GetPixmap() const;
     bool HasPixmap() const;
@@ -127,6 +126,7 @@ protected:
     virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* data) const;
 
 private:
+    void SetPixmap(GdkPixmap* pixmap);
 #if wxUSE_IMAGE
     // to be called from CreateFromImage only!
     bool CreateFromImageAsPixmap(const wxImage& image, int depth);
@@ -144,7 +144,6 @@ public:
     // (wxBitmap may keep same bitmap e.g. as both pixmap and pixbuf):
     void PurgeOtherRepresentations(Representation keep);
 
-private:
     DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 

src/gtk/bitmap.cpp

@@ -13,9 +13,7 @@
 #include "wx/bitmap.h"
 
 #ifndef WX_PRECOMP
-    #include "wx/app.h"
     #include "wx/icon.h"
-    #include "wx/math.h"
     #include "wx/image.h"
     #include "wx/colour.h"
 #endif
@@ -26,12 +24,50 @@
 
 #include <gtk/gtk.h>
 
-//-----------------------------------------------------------------------------
-// data
-//-----------------------------------------------------------------------------
-
 extern GtkWidget *wxGetRootWindow();
 
+static void PixmapToPixbuf(GdkPixmap* pixmap, GdkPixbuf* pixbuf, int w, int h)
+{
+    gdk_pixbuf_get_from_drawable(pixbuf, pixmap, NULL, 0, 0, 0, 0, w, h);
+    if (gdk_drawable_get_depth(pixmap) == 1)
+    {
+        // invert to match XBM convention
+        guchar* p = gdk_pixbuf_get_pixels(pixbuf);
+        const int inc = 3 + int(gdk_pixbuf_get_has_alpha(pixbuf) != 0);
+        const int rowpad = gdk_pixbuf_get_rowstride(pixbuf) - w * inc;
+        for (int y = h; y; y--, p += rowpad)
+            for (int x = w; x; x--, p += inc)
+            {
+                // pixels are either (0,0,0) or (0xff,0xff,0xff)
+                p[0] = ~p[0];
+                p[1] = ~p[1];
+                p[2] = ~p[2];
+            }
+    }
+}
+
+static void MaskToAlpha(GdkPixmap* mask, GdkPixbuf* pixbuf, int w, int h)
+{
+    GdkPixbuf* mask_pixbuf = gdk_pixbuf_get_from_drawable(
+        NULL, mask, NULL, 0, 0, 0, 0, w, h);
+    guchar* p = gdk_pixbuf_get_pixels(pixbuf) + 3;
+    const guchar* mask_data = gdk_pixbuf_get_pixels(mask_pixbuf);
+    const int rowpad = gdk_pixbuf_get_rowstride(pixbuf) - w * 4;
+    const int mask_rowpad = gdk_pixbuf_get_rowstride(mask_pixbuf) - w * 3;
+    for (int y = h; y; y--, p += rowpad, mask_data += mask_rowpad)
+    {
+        for (int x = w; x; x--, p += 4, mask_data += 3)
+        {
+            *p = 255;
+            // no need to test all 3 components,
+            //   pixels are either (0,0,0) or (0xff,0xff,0xff)
+            if (mask_data[0] == 0)
+                *p = 0;
+        }
+    }
+    g_object_unref(mask_pixbuf);
+}
+
 //-----------------------------------------------------------------------------
 // wxMask
 //-----------------------------------------------------------------------------
@@ -166,10 +202,10 @@ GdkBitmap *wxMask::GetBitmap() const
 class wxBitmapRefData: public wxGDIRefData
 {
 public:
-    wxBitmapRefData();
+    wxBitmapRefData(int width, int height, int depth);
     virtual ~wxBitmapRefData();
 
-    virtual bool IsOk() const { return m_pixmap || m_pixbuf; }
+    virtual bool IsOk() const;
 
     GdkPixmap      *m_pixmap;
     GdkPixbuf      *m_pixbuf;
@@ -177,16 +213,20 @@ public:
     int             m_width;
     int             m_height;
     int             m_bpp;
+    bool m_alphaRequested;
 };
 
-wxBitmapRefData::wxBitmapRefData()
+wxBitmapRefData::wxBitmapRefData(int width, int height, int depth)
 {
     m_pixmap = NULL;
     m_pixbuf = NULL;
     m_mask = NULL;
-    m_width = 0;
+    m_width = width;
-    m_height = 0;
+    m_height = height;
-    m_bpp = 0;
+    m_bpp = depth;
+    if (m_bpp < 0)
+        m_bpp = gdk_drawable_get_depth(wxGetRootWindow()->window);
+    m_alphaRequested = depth == 32;
 }
 
 wxBitmapRefData::~wxBitmapRefData()
@@ -198,6 +238,10 @@ wxBitmapRefData::~wxBitmapRefData()
     delete m_mask;
 }
 
+bool wxBitmapRefData::IsOk() const
+{
+    return m_bpp != 0;
+}
 
 //-----------------------------------------------------------------------------
 // wxBitmap
@@ -244,43 +288,9 @@ wxBitmap::~wxBitmap()
 bool wxBitmap::Create( int width, int height, int depth )
 {
     UnRef();
-
+    wxCHECK_MSG(width >= 0 && height >= 0, false, "invalid bitmap size");
-    if ( width <= 0 || height <= 0 )
+    m_refData = new wxBitmapRefData(width, height, depth);
-    {
+    return true;
-        return false;
-    }
-
-    const GdkVisual* visual = wxTheApp->GetGdkVisual();
-
-    if (depth == 32)
-    {
-        SetPixbuf(gdk_pixbuf_new(GDK_COLORSPACE_RGB, true, 8, width, height), 32);
-
-        if (!M_BMPDATA)
-            return false;
-
-        // must initialize alpha, otherwise GetPixmap()
-        // will create a mask out of garbage
-        gdk_pixbuf_fill(M_BMPDATA->m_pixbuf, 0x000000ff);
-    }
-    else if (depth == 24)
-    {
-        if (visual->depth == depth)
-            SetPixmap(gdk_pixmap_new(wxGetRootWindow()->window, width, height, depth));
-        else
-            SetPixbuf(gdk_pixbuf_new(GDK_COLORSPACE_RGB, false, 8, width, height), 24);
-    }
-    else
-    {
-        if (depth != 1)
-        {
-            if (depth == -1)
-                depth = visual->depth;
-        }
-        SetPixmap(gdk_pixmap_new(wxGetRootWindow()->window, width, height, depth));
-    }
-
-    return IsOk();
 }
 
 #if wxUSE_IMAGE
@@ -394,7 +404,7 @@ bool wxBitmap::CreateFromImageAsPixbuf(const wxImage& image)
     int height = image.GetHeight();
 
     Create(width, height, 32);
-    GdkPixbuf* pixbuf = M_BMPDATA->m_pixbuf;
+    GdkPixbuf* pixbuf = GetPixbuf();
     if (!pixbuf)
         return false;
 
@@ -569,40 +579,46 @@ wxBitmap wxBitmap::GetSubBitmap( const wxRect& rect) const
     wxBitmap ret;
 
     wxCHECK_MSG(IsOk(), ret, wxT("invalid bitmap"));
+
+    const int w = rect.width;
+    const int h = rect.height;
+    const wxBitmapRefData* bmpData = M_BMPDATA;
+
     wxCHECK_MSG(rect.x >= 0 && rect.y >= 0 &&
-                rect.x + rect.width <= M_BMPDATA->m_width &&
+                rect.x + w <= bmpData->m_width &&
-                rect.y + rect.height <= M_BMPDATA->m_height,
+                rect.y + h <= bmpData->m_height,
                 ret, wxT("invalid bitmap region"));
 
-    if (HasPixbuf() || M_BMPDATA->m_bpp == 32)
+    wxBitmapRefData* newRef = new wxBitmapRefData(*bmpData);
-    {
+    ret.m_refData = newRef;
-        GdkPixbuf *pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB,
+    newRef->m_width = w;
-                                           gdk_pixbuf_get_has_alpha(GetPixbuf()),
+    newRef->m_height = h;
-                                           8, rect.width, rect.height);
-        if (!pixbuf)
-            return ret;
 
-        ret.SetPixbuf(pixbuf, M_BMPDATA->m_bpp);
+    if (bmpData->m_pixbuf)
-        gdk_pixbuf_copy_area(GetPixbuf(),
+    {
-                             rect.x, rect.y, rect.width, rect.height,
+        GdkPixbuf* pixbuf =
-                             pixbuf, 0, 0);
+            gdk_pixbuf_new_subpixbuf(bmpData->m_pixbuf, rect.x, rect.y, w, h);
+        newRef->m_pixbuf = gdk_pixbuf_copy(pixbuf);
+        g_object_unref(pixbuf);
     }
-    else
+    if (bmpData->m_pixmap)
     {
-        ret.Create(rect.width, rect.height, M_BMPDATA->m_bpp);
+        newRef->m_pixmap = gdk_pixmap_new(bmpData->m_pixmap, w, h, -1);
-        wxGtkObject<GdkGC> gc(gdk_gc_new( ret.GetPixmap() ));
+        GdkGC* gc = gdk_gc_new(newRef->m_pixmap);
-        gdk_draw_drawable( ret.GetPixmap(), gc, GetPixmap(), rect.x, rect.y, 0, 0, rect.width, rect.height );
+        gdk_draw_drawable(
+            newRef->m_pixmap, gc, bmpData->m_pixmap, rect.x, rect.y, 0, 0, w, h);
+        g_object_unref(gc);
     }
-    // make mask, unless there is already alpha
+    newRef->m_mask = NULL;
-    if (GetMask() && !HasAlpha())
+    if (bmpData->m_mask && bmpData->m_mask->m_bitmap)
     {
-        wxMask *mask = new wxMask;
+        GdkPixmap* sub_mask = gdk_pixmap_new(bmpData->m_mask->m_bitmap, w, h, 1);
-        mask->m_bitmap = gdk_pixmap_new( wxGetRootWindow()->window, rect.width, rect.height, 1 );
+        newRef->m_mask = new wxMask;
-
+        newRef->m_mask->m_bitmap = sub_mask;
-        wxGtkObject<GdkGC> gc(gdk_gc_new( mask->m_bitmap ));
+        GdkGC* gc = gdk_gc_new(sub_mask);
-        gdk_draw_drawable(mask->m_bitmap, gc, M_BMPDATA->m_mask->m_bitmap, rect.x, rect.y, 0, 0, rect.width, rect.height);
+        gdk_draw_drawable(
-
+            sub_mask, gc, bmpData->m_mask->m_bitmap, rect.x, rect.y, 0, 0, w, h);
-        ret.SetMask( mask );
+        g_object_unref(gc);
     }
 
     return ret;
@@ -685,43 +701,46 @@ void wxBitmap::SetDepth( int depth )
 
 void wxBitmap::SetPixmap( GdkPixmap *pixmap )
 {
+    UnRef();
+
     if (!pixmap)
         return;
 
-    if (!m_refData)
+    int w, h;
-        m_refData = new wxBitmapRefData;
+    gdk_drawable_get_size(pixmap, &w, &h);
-
+    wxBitmapRefData* bmpData = new wxBitmapRefData(w, h, 0);
-    // AllocExclusive should not be needed for this internal function
+    m_refData = bmpData;
-    wxASSERT(m_refData->GetRefCount() == 1);
+    bmpData->m_pixmap = pixmap;
-    wxASSERT(M_BMPDATA->m_pixmap == NULL);
+    bmpData->m_bpp = gdk_drawable_get_depth(pixmap);
-    M_BMPDATA->m_pixmap = pixmap;
-    gdk_drawable_get_size(pixmap, &M_BMPDATA->m_width, &M_BMPDATA->m_height);
-    M_BMPDATA->m_bpp = gdk_drawable_get_depth(pixmap);
-    PurgeOtherRepresentations(Pixmap);
 }
 
 GdkPixmap *wxBitmap::GetPixmap() const
 {
     wxCHECK_MSG( IsOk(), NULL, wxT("invalid bitmap") );
 
-    // create the pixmap on the fly if we use Pixbuf representation:
+    wxBitmapRefData* bmpData = M_BMPDATA;
-    if (M_BMPDATA->m_pixmap == NULL)
+    if (bmpData->m_pixmap)
+        return bmpData->m_pixmap;
+
+    if (bmpData->m_pixbuf)
     {
-        GdkPixmap** pmask = NULL;
+        GdkPixmap** mask_pixmap = NULL;
-        if (gdk_pixbuf_get_has_alpha(M_BMPDATA->m_pixbuf))
+        if (gdk_pixbuf_get_has_alpha(bmpData->m_pixbuf))
         {
             // make new mask from alpha
-            delete M_BMPDATA->m_mask;
+            delete bmpData->m_mask;
-            M_BMPDATA->m_mask = new wxMask;
+            bmpData->m_mask = new wxMask;
-            pmask = &M_BMPDATA->m_mask->m_bitmap;
+            mask_pixmap = &bmpData->m_mask->m_bitmap;
         }
-        gdk_pixbuf_render_pixmap_and_mask(M_BMPDATA->m_pixbuf,
+        gdk_pixbuf_render_pixmap_and_mask(
-                                          &M_BMPDATA->m_pixmap,
+            bmpData->m_pixbuf, &bmpData->m_pixmap, mask_pixmap, 128);
-                                          pmask,
-                                          0x80 /* alpha threshold */);
     }
-
+    else
-    return M_BMPDATA->m_pixmap;
+    {
+        bmpData->m_pixmap = gdk_pixmap_new(wxGetRootWindow()->window,
+            bmpData->m_width, bmpData->m_height, bmpData->m_bpp == 1 ? 1 : -1);
+    }
+    return bmpData->m_pixmap;
 }
 
 bool wxBitmap::HasPixmap() const
@@ -735,49 +754,22 @@ GdkPixbuf *wxBitmap::GetPixbuf() const
 {
     wxCHECK_MSG( IsOk(), NULL, wxT("invalid bitmap") );
 
-    if (M_BMPDATA->m_pixbuf == NULL)
+    wxBitmapRefData* bmpData = M_BMPDATA;
-    {
+    if (bmpData->m_pixbuf)
+        return bmpData->m_pixbuf;
 
-        int width = GetWidth();
+    const int w = bmpData->m_width;
-        int height = GetHeight();
+    const int h = bmpData->m_height;
-
+    GdkPixmap* mask = NULL;
-        GdkPixbuf *pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB,
+    if (bmpData->m_mask)
-                                           GetMask() != NULL,
+        mask = bmpData->m_mask->m_bitmap;
-                                           8, width, height);
+    const bool useAlpha = bmpData->m_alphaRequested || mask;
-        M_BMPDATA->m_pixbuf = pixbuf;
+    bmpData->m_pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, useAlpha, 8, w, h);
-        gdk_pixbuf_get_from_drawable(pixbuf, M_BMPDATA->m_pixmap, NULL,
+    if (bmpData->m_pixmap)
-                                     0, 0, 0, 0, width, height);
+        PixmapToPixbuf(bmpData->m_pixmap, bmpData->m_pixbuf, w, h);
-        // apply the mask to created pixbuf:
+    if (mask)
-        if (M_BMPDATA->m_pixbuf && M_BMPDATA->m_mask)
+        MaskToAlpha(mask, bmpData->m_pixbuf, w, h);
-        {
+    return bmpData->m_pixbuf;
-            GdkPixbuf *pmask =
-                gdk_pixbuf_get_from_drawable(NULL,
-                                             M_BMPDATA->m_mask->GetBitmap(),
-                                             NULL,
-                                             0, 0, 0, 0, width, height);
-            if (pmask)
-            {
-                guchar *bmp = gdk_pixbuf_get_pixels(pixbuf);
-                guchar *mask = gdk_pixbuf_get_pixels(pmask);
-                int bmprowinc = gdk_pixbuf_get_rowstride(pixbuf) - 4 * width;
-                int maskrowinc = gdk_pixbuf_get_rowstride(pmask) - 3 * width;
-
-                for (int y = 0; y < height;
-                     y++, bmp += bmprowinc, mask += maskrowinc)
-                {
-                    for (int x = 0; x < width; x++, bmp += 4, mask += 3)
-                    {
-                        if (mask[0] == 0 /*black pixel*/)
-                            bmp[3] = 0;
-                    }
-                }
-
-                g_object_unref (pmask);
-            }
-        }
-    }
-
-    return M_BMPDATA->m_pixbuf;
 }
 
 bool wxBitmap::HasPixbuf() const
@@ -787,27 +779,20 @@ bool wxBitmap::HasPixbuf() const
     return M_BMPDATA->m_pixbuf != NULL;
 }
 
-void wxBitmap::SetPixbuf(GdkPixbuf* pixbuf, int depth)
+void wxBitmap::SetPixbuf(GdkPixbuf* pixbuf)
 {
+    UnRef();
+    
     if (!pixbuf)
         return;
 
-    if (!m_refData)
+    int depth = -1;
-        m_refData = new wxBitmapRefData;
+    if (gdk_pixbuf_get_has_alpha(pixbuf))
+        depth = 32;
+    m_refData = new wxBitmapRefData(
+        gdk_pixbuf_get_width(pixbuf), gdk_pixbuf_get_height(pixbuf), depth);
 
-    // AllocExclusive should not be needed for this internal function
-    wxASSERT(m_refData->GetRefCount() == 1);
-    wxASSERT(M_BMPDATA->m_pixbuf == NULL);
     M_BMPDATA->m_pixbuf = pixbuf;
-    M_BMPDATA->m_width = gdk_pixbuf_get_width(pixbuf);
-    M_BMPDATA->m_height = gdk_pixbuf_get_height(pixbuf);
-    // if depth specified
-    if (depth != 0)
-        M_BMPDATA->m_bpp = depth;
-    else if (M_BMPDATA->m_bpp == 0)
-        // use something reasonable
-        M_BMPDATA->m_bpp = wxTheApp->GetGdkVisual()->depth;
-    PurgeOtherRepresentations(Pixbuf);
 }
 
 void wxBitmap::PurgeOtherRepresentations(wxBitmap::Representation keep)
@@ -849,22 +834,20 @@ void wxBitmap::UngetRawData(wxPixelDataBase& WXUNUSED(data))
 
 bool wxBitmap::HasAlpha() const
 {
-    return m_refData != NULL && M_BMPDATA->m_pixbuf != NULL &&
+    const wxBitmapRefData* bmpData = M_BMPDATA;
-        gdk_pixbuf_get_has_alpha(M_BMPDATA->m_pixbuf);
+    return bmpData && (bmpData->m_alphaRequested ||
+        (bmpData->m_pixbuf && gdk_pixbuf_get_has_alpha(bmpData->m_pixbuf)));
 }
 
 wxGDIRefData* wxBitmap::CreateGDIRefData() const
 {
-    return new wxBitmapRefData;
+    return new wxBitmapRefData(0, 0, 0);
 }
 
 wxGDIRefData* wxBitmap::CloneGDIRefData(const wxGDIRefData* data) const
 {
     const wxBitmapRefData* oldRef = static_cast<const wxBitmapRefData*>(data);
-    wxBitmapRefData* newRef = new wxBitmapRefData;
+    wxBitmapRefData* newRef = new wxBitmapRefData(*oldRef);
-    newRef->m_width = oldRef->m_width;
-    newRef->m_height = oldRef->m_height;
-    newRef->m_bpp = oldRef->m_bpp;
     if (oldRef->m_pixmap != NULL)
     {
         newRef->m_pixmap = gdk_pixmap_new(