Update version to 2.9.4 in version.bkl too and rebake everything.

[wxWidgets.git] / src / common / artprov.cpp

diff --git a/src/common/artprov.cpp b/src/common/artprov.cpp
index a8785916b58c5bd7d1876ba54d8ccf22f522d6c6..69c692852870f14460b3b92aa33706dcbc26fca7 100644 (file)
--- a/src/common/artprov.cpp
+++ b/src/common/artprov.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        artprov.cpp
+// Name:        src/common/artprov.cpp

 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:
 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:


@@ -13,10 +13,6 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // headers
 // ---------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "artprov.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -24,29 +20,30 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#include "wx/artprov.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/log.h"

     #include "wx/list.h"
     #include "wx/list.h"

+    #include "wx/log.h"
+    #include "wx/hashmap.h"
+    #include "wx/image.h"
+    #include "wx/module.h"

 #endif
 
 #endif
 

-#include "wx/artprov.h"
-#include "wx/hashmap.h"
-#include "wx/module.h"
-
-

 // ===========================================================================
 // implementation
 // ===========================================================================
 
 #include "wx/listimpl.cpp"
 WX_DECLARE_LIST(wxArtProvider, wxArtProvidersList);
 // ===========================================================================
 // implementation
 // ===========================================================================
 
 #include "wx/listimpl.cpp"
 WX_DECLARE_LIST(wxArtProvider, wxArtProvidersList);

-WX_DEFINE_LIST(wxArtProvidersList);
+WX_DEFINE_LIST(wxArtProvidersList)

 
 // ----------------------------------------------------------------------------
 // Cache class - stores already requested bitmaps
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // Cache class - stores already requested bitmaps
 // ----------------------------------------------------------------------------
 

-WX_DECLARE_STRING_HASH_MAP(wxBitmap, wxArtProviderBitmapsHash);
+WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxBitmap, wxArtProviderBitmapsHash);
+WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxIconBundle, wxArtProviderIconBundlesHash);

 
 class WXDLLEXPORT wxArtProviderCache
 {
 
 class WXDLLEXPORT wxArtProviderCache
 {


@@ -55,14 +52,22 @@ public:
     void PutBitmap(const wxString& full_id, const wxBitmap& bmp)
         { m_bitmapsHash[full_id] = bmp; }
 
     void PutBitmap(const wxString& full_id, const wxBitmap& bmp)
         { m_bitmapsHash[full_id] = bmp; }
 

+    bool GetIconBundle(const wxString& full_id, wxIconBundle* bmp);
+    void PutIconBundle(const wxString& full_id, const wxIconBundle& iconbundle)
+        { m_iconBundlesHash[full_id] = iconbundle; }
+

     void Clear();
     void Clear();

-    
-    static wxString ConstructHashID(const wxArtDomain& domain, 
-                                    const wxArtID& id,
+
+    static wxString ConstructHashID(const wxArtID& id,
+                                    const wxArtClient& client,

                                     const wxSize& size);
 
                                     const wxSize& size);
 

+    static wxString ConstructHashID(const wxArtID& id,
+                                    const wxArtClient& client);
+

 private:
 private:

-    wxArtProviderBitmapsHash m_bitmapsHash;
+    wxArtProviderBitmapsHash m_bitmapsHash;         // cache of wxBitmaps
+    wxArtProviderIconBundlesHash m_iconBundlesHash; // cache of wxIconBundles

 };
 
 bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp)
 };
 
 bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp)


@@ -70,130 +75,384 @@ bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp)
     wxArtProviderBitmapsHash::iterator entry = m_bitmapsHash.find(full_id);
     if ( entry == m_bitmapsHash.end() )
     {
     wxArtProviderBitmapsHash::iterator entry = m_bitmapsHash.find(full_id);
     if ( entry == m_bitmapsHash.end() )
     {

-        return FALSE;
+        return false;

     }
     else
     {
         *bmp = entry->second;
     }
     else
     {
         *bmp = entry->second;

-        return TRUE;
+        return true;
+    }
+}
+
+bool wxArtProviderCache::GetIconBundle(const wxString& full_id, wxIconBundle* bmp)
+{
+    wxArtProviderIconBundlesHash::iterator entry = m_iconBundlesHash.find(full_id);
+    if ( entry == m_iconBundlesHash.end() )
+    {
+        return false;
+    }
+    else
+    {
+        *bmp = entry->second;
+        return true;

     }
 }
 
 void wxArtProviderCache::Clear()
 {
     m_bitmapsHash.clear();
     }
 }
 
 void wxArtProviderCache::Clear()
 {
     m_bitmapsHash.clear();

+    m_iconBundlesHash.clear();

 }
 
 }
 

-/*static*/ wxString wxArtProviderCache::ConstructHashID(
-                                    const wxArtDomain& domain, 
-                                    const wxArtID& id, const wxSize& size)
+/* static */ wxString
+wxArtProviderCache::ConstructHashID(const wxArtID& id,
+                                    const wxArtClient& client)

 {
 {

-    wxString str;
-    str.Printf(wxT("%s-%s-%i-%i"), domain.c_str(), id.c_str(), size.x, size.y);
-    return str;
+    return id + wxT('-') + client;

 }
 
 
 }
 
 

-// ----------------------------------------------------------------------------
+/* static */ wxString
+wxArtProviderCache::ConstructHashID(const wxArtID& id,
+                                    const wxArtClient& client,
+                                    const wxSize& size)
+{
+    return ConstructHashID(id, client) + wxT('-') +
+            wxString::Format(wxT("%d-%d"), size.x, size.y);
+}
+
+// ============================================================================

 // wxArtProvider class
 // wxArtProvider class

-// ----------------------------------------------------------------------------
+// ============================================================================

 
 IMPLEMENT_ABSTRACT_CLASS(wxArtProvider, wxObject)
 
 wxArtProvidersList *wxArtProvider::sm_providers = NULL;
 wxArtProviderCache *wxArtProvider::sm_cache = NULL;
 
 
 IMPLEMENT_ABSTRACT_CLASS(wxArtProvider, wxObject)
 
 wxArtProvidersList *wxArtProvider::sm_providers = NULL;
 wxArtProviderCache *wxArtProvider::sm_cache = NULL;
 

-/*static*/ void wxArtProvider::PushProvider(wxArtProvider *provider)
+// ----------------------------------------------------------------------------
+// wxArtProvider ctors/dtor
+// ----------------------------------------------------------------------------
+
+wxArtProvider::~wxArtProvider()
+{
+    Remove(this);
+}
+
+// ----------------------------------------------------------------------------
+// wxArtProvider operations on provider stack
+// ----------------------------------------------------------------------------
+
+/*static*/ void wxArtProvider::CommonAddingProvider()

 {
     if ( !sm_providers )
     {
         sm_providers = new wxArtProvidersList;
 {
     if ( !sm_providers )
     {
         sm_providers = new wxArtProvidersList;

-        sm_providers->DeleteContents(TRUE);

         sm_cache = new wxArtProviderCache;
     }
 
         sm_cache = new wxArtProviderCache;
     }
 

+    sm_cache->Clear();
+}
+
+/*static*/ void wxArtProvider::Push(wxArtProvider *provider)
+{
+    CommonAddingProvider();

     sm_providers->Insert(provider);
 }
 
     sm_providers->Insert(provider);
 }
 

-/*static*/ bool wxArtProvider::PopProvider()
+/*static*/ void wxArtProvider::PushBack(wxArtProvider *provider)
+{
+    CommonAddingProvider();
+    sm_providers->Append(provider);
+}
+
+/*static*/ bool wxArtProvider::Pop()

 {
 {

-    wxCHECK_MSG( sm_providers, FALSE, _T("no wxArtProvider exists") );
-    wxCHECK_MSG( sm_providers->GetCount() > 0, FALSE, _T("wxArtProviders stack is empty") );
+    wxCHECK_MSG( sm_providers, false, wxT("no wxArtProvider exists") );
+    wxCHECK_MSG( !sm_providers->empty(), false, wxT("wxArtProviders stack is empty") );

 
 

-    sm_providers->DeleteNode(sm_providers->GetFirst());
+    delete sm_providers->GetFirst()->GetData();

     sm_cache->Clear();
     sm_cache->Clear();

-    return TRUE;
+    return true;

 }
 
 }
 

-/*static*/ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
+/*static*/ bool wxArtProvider::Remove(wxArtProvider *provider)

 {
 {

-    wxCHECK_MSG( sm_providers, FALSE, _T("no wxArtProvider exists") );
+    wxCHECK_MSG( sm_providers, false, wxT("no wxArtProvider exists") );

 
     if ( sm_providers->DeleteObject(provider) )
     {
         sm_cache->Clear();
 
     if ( sm_providers->DeleteObject(provider) )
     {
         sm_cache->Clear();

-        return TRUE;
+        return true;

     }
     }

-    
-    return FALSE;
+
+    return false;
+}
+
+/*static*/ bool wxArtProvider::Delete(wxArtProvider *provider)
+{
+    // provider will remove itself from the stack in its dtor
+    delete provider;
+
+    return true;

 }
 
 /*static*/ void wxArtProvider::CleanUpProviders()
 {
 }
 
 /*static*/ void wxArtProvider::CleanUpProviders()
 {

-    wxDELETE(sm_providers);
-    wxDELETE(sm_cache);
+    if ( sm_providers )
+    {
+        while ( !sm_providers->empty() )
+            delete *sm_providers->begin();
+
+        wxDELETE(sm_providers);
+        wxDELETE(sm_cache);
+    }

 }
 
 }
 

-/*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtDomain& domain,
-                                             const wxArtID& id,
+// ----------------------------------------------------------------------------
+// wxArtProvider: retrieving bitmaps/icons
+// ----------------------------------------------------------------------------
+
+/*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id,
+                                             const wxArtClient& client,

                                              const wxSize& size)
 {
                                              const wxSize& size)
 {

-    wxCHECK_MSG( sm_providers, wxNullBitmap, _T("no wxArtProvider exists") );
+    // safety-check against writing client,id,size instead of id,client,size:
+    wxASSERT_MSG( client.Last() == wxT('C'), wxT("invalid 'client' parameter") );
+
+    wxCHECK_MSG( sm_providers, wxNullBitmap, wxT("no wxArtProvider exists") );

 
 

-    wxString hashId = wxArtProviderCache::ConstructHashID(domain, id, size);
+    wxString hashId = wxArtProviderCache::ConstructHashID(id, client, size);

 
     wxBitmap bmp;
     if ( !sm_cache->GetBitmap(hashId, &bmp) )
     {
 
     wxBitmap bmp;
     if ( !sm_cache->GetBitmap(hashId, &bmp) )
     {

-        for (wxArtProvidersList::Node *node = sm_providers->GetFirst();
+        for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();

              node; node = node->GetNext())
         {
              node; node = node->GetNext())
         {

-            bmp = node->GetData()->CreateBitmap(domain, id, size);
-            if ( bmp.Ok() )
+            bmp = node->GetData()->CreateBitmap(id, client, size);
+            if ( bmp.IsOk() )

                 break;
         }
                 break;
         }

+
+        wxSize sizeNeeded = size;
+        if ( !bmp.IsOk() )
+        {
+            // no bitmap created -- as a fallback, try if we can find desired
+            // icon in a bundle
+            wxIconBundle iconBundle = DoGetIconBundle(id, client);
+            if ( iconBundle.IsOk() )
+            {
+                if ( sizeNeeded == wxDefaultSize )
+                    sizeNeeded = GetNativeSizeHint(client);
+
+                wxIcon icon(iconBundle.GetIcon(sizeNeeded));
+                if ( icon.IsOk() )
+                {
+                    // this icon may be not of the correct size, it will be
+                    // rescaled below in such case
+                    bmp.CopyFromIcon(icon);
+                }
+            }
+        }
+
+        // if we didn't get the correct size, resize the bitmap
+#if wxUSE_IMAGE && (!defined(__WXMSW__) || wxUSE_WXDIB)
+        if ( bmp.IsOk() && sizeNeeded != wxDefaultSize )
+        {
+            if ( bmp.GetSize() != sizeNeeded )
+            {
+                wxImage img = bmp.ConvertToImage();
+                img.Rescale(sizeNeeded.x, sizeNeeded.y);
+                bmp = wxBitmap(img);
+            }
+        }
+#endif // wxUSE_IMAGE
+

         sm_cache->PutBitmap(hashId, bmp);
     }
 
     return bmp;
 }
 
         sm_cache->PutBitmap(hashId, bmp);
     }
 
     return bmp;
 }
 

-/*static*/ wxIcon wxArtProvider::GetIcon(const wxArtDomain& domain, 
-                                         const wxArtID& id,
-                                         const wxSize& size)
+/*static*/
+wxIconBundle wxArtProvider::GetIconBundle(const wxArtID& id, const wxArtClient& client)

 {
 {

-    wxCHECK_MSG( sm_providers, wxNullIcon, _T("no wxArtProvider exists") );
+    wxIconBundle iconbundle(DoGetIconBundle(id, client));

 
 

-    wxBitmap bmp = GetBitmap(domain, id, size);
-    if ( bmp.Ok() )
+    if ( iconbundle.IsOk() )

     {
     {

-        wxIcon icon;
-        icon.CopyFromBitmap(bmp);
-        return icon;
+        return iconbundle;

     }
     else
     {
     }
     else
     {

+        // fall back to single-icon bundle
+        return wxIconBundle(GetIcon(id, client));
+    }
+}
+
+/*static*/
+wxIconBundle wxArtProvider::DoGetIconBundle(const wxArtID& id, const wxArtClient& client)
+{
+    // safety-check against writing client,id,size instead of id,client,size:
+    wxASSERT_MSG( client.Last() == wxT('C'), wxT("invalid 'client' parameter") );
+
+    wxCHECK_MSG( sm_providers, wxNullIconBundle, wxT("no wxArtProvider exists") );
+
+    wxString hashId = wxArtProviderCache::ConstructHashID(id, client);
+
+    wxIconBundle iconbundle;
+    if ( !sm_cache->GetIconBundle(hashId, &iconbundle) )
+    {
+        for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
+             node; node = node->GetNext())
+        {
+            iconbundle = node->GetData()->CreateIconBundle(id, client);
+            if ( iconbundle.IsOk() )
+                break;
+        }
+
+        sm_cache->PutIconBundle(hashId, iconbundle);
+    }
+
+    return iconbundle;
+}
+
+/*static*/ wxIcon wxArtProvider::GetIcon(const wxArtID& id,
+                                         const wxArtClient& client,
+                                         const wxSize& size)
+{
+    wxBitmap bmp = GetBitmap(id, client, size);
+
+    if ( !bmp.IsOk() )

         return wxNullIcon;
         return wxNullIcon;

+
+    wxIcon icon;
+    icon.CopyFromBitmap(bmp);
+    return icon;
+}
+
+/* static */
+wxArtID wxArtProvider::GetMessageBoxIconId(int flags)
+{
+    switch ( flags & wxICON_MASK )
+    {
+        default:
+            wxFAIL_MSG(wxT("incorrect message box icon flags"));
+            // fall through
+
+        case wxICON_ERROR:
+            return wxART_ERROR;
+
+        case wxICON_INFORMATION:
+            return wxART_INFORMATION;
+
+        case wxICON_WARNING:
+            return wxART_WARNING;
+
+        case wxICON_QUESTION:
+            return wxART_QUESTION;

     }
 }
 
     }
 }
 

+/*static*/ wxSize wxArtProvider::GetSizeHint(const wxArtClient& client,
+                                         bool platform_dependent)
+{
+    if (!platform_dependent)
+    {
+        wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
+        if (node)
+            return node->GetData()->DoGetSizeHint(client);
+    }
+
+    return GetNativeSizeHint(client);
+}

 
 

+#ifndef wxHAS_NATIVE_ART_PROVIDER_IMPL
+/*static*/
+wxSize wxArtProvider::GetNativeSizeHint(const wxArtClient& WXUNUSED(client))
+{
+    // rather than returning some arbitrary value that doesn't make much
+    // sense (as 2.8 used to do), tell the caller that we don't have a clue:
+    return wxDefaultSize;
+}
+
+/*static*/
+void wxArtProvider::InitNativeProvider()
+{
+}
+#endif // !wxHAS_NATIVE_ART_PROVIDER_IMPL
+
+
+/* static */
+bool wxArtProvider::HasNativeProvider()
+{
+#ifdef __WXGTK20__
+    return true;
+#else
+    return false;
+#endif
+}
+
+// ----------------------------------------------------------------------------
+// deprecated wxArtProvider methods
+// ----------------------------------------------------------------------------
+
+#if WXWIN_COMPATIBILITY_2_6
+
+/* static */ void wxArtProvider::PushProvider(wxArtProvider *provider)
+{
+    Push(provider);
+}
+
+/* static */ void wxArtProvider::InsertProvider(wxArtProvider *provider)
+{
+    Insert(provider);
+}
+
+/* static */ bool wxArtProvider::PopProvider()
+{
+    return Pop();
+}
+
+/* static */ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
+{
+    // RemoveProvider() used to delete the provider being removed so this is
+    // not a typo, we must call Delete() and not Remove() here
+    return Delete(provider);
+}
+
+#endif // WXWIN_COMPATIBILITY_2_6
+
+#if WXWIN_COMPATIBILITY_2_8
+/* static */ void wxArtProvider::Insert(wxArtProvider *provider)
+{
+    PushBack(provider);
+}
+#endif // WXWIN_COMPATIBILITY_2_8
+
+// ============================================================================
+// wxArtProviderModule
+// ============================================================================

 
 class wxArtProviderModule: public wxModule
 {
 public:
 
 class wxArtProviderModule: public wxModule
 {
 public:

-    bool OnInit() { return TRUE; }
-    void OnExit() { wxArtProvider::CleanUpProviders(); }
+    bool OnInit()
+    {
+#if wxUSE_ARTPROVIDER_STD
+        wxArtProvider::InitStdProvider();
+#endif // wxUSE_ARTPROVIDER_STD
+#if wxUSE_ARTPROVIDER_TANGO
+        wxArtProvider::InitTangoProvider();
+#endif // wxUSE_ARTPROVIDER_TANGO
+        wxArtProvider::InitNativeProvider();
+        return true;
+    }
+    void OnExit()
+    {
+        wxArtProvider::CleanUpProviders();
+    }

 
     DECLARE_DYNAMIC_CLASS(wxArtProviderModule)
 };
 
     DECLARE_DYNAMIC_CLASS(wxArtProviderModule)
 };