X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8ecff18117f8cabc0f515ad81aa4ad265e5e17d3..a45f904dea79c37cfd02b001ff9006849e0041db:/src/common/artprov.cpp diff --git a/src/common/artprov.cpp b/src/common/artprov.cpp index 5d3ab8655e..bd79bb96e3 100644 --- a/src/common/artprov.cpp +++ b/src/common/artprov.cpp @@ -20,17 +20,14 @@ #pragma hdrstop #endif +#include "wx/artprov.h" + #ifndef WX_PRECOMP #include "wx/list.h" #include "wx/log.h" -#endif - -#include "wx/artprov.h" -#include "wx/hashmap.h" -#include "wx/module.h" - -#if wxUSE_IMAGE + #include "wx/hashmap.h" #include "wx/image.h" + #include "wx/module.h" #endif // =========================================================================== @@ -46,6 +43,7 @@ WX_DEFINE_LIST(wxArtProvidersList) // ---------------------------------------------------------------------------- WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxBitmap, wxArtProviderBitmapsHash); +WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxIconBundle, wxArtProviderIconBundlesHash); class WXDLLEXPORT wxArtProviderCache { @@ -54,14 +52,22 @@ public: 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(); static wxString ConstructHashID(const wxArtID& id, const wxArtClient& client, const wxSize& size); + static wxString ConstructHashID(const wxArtID& id, + const wxArtClient& client); + 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) @@ -78,31 +84,66 @@ bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp) } } +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(); + m_iconBundlesHash.clear(); } -/*static*/ wxString wxArtProviderCache::ConstructHashID( - const wxArtID& id, const wxArtClient& client, - const wxSize& size) +/* static */ wxString +wxArtProviderCache::ConstructHashID(const wxArtID& id, + const wxArtClient& client) { - wxString str; - str.Printf(wxT("%s-%s-%i-%i"), id.c_str(), client.c_str(), size.x, size.y); - return str; + return id + _T('-') + client; } -// ---------------------------------------------------------------------------- +/* static */ wxString +wxArtProviderCache::ConstructHashID(const wxArtID& id, + const wxArtClient& client, + const wxSize& size) +{ + return ConstructHashID(id, client) + _T('-') + + wxString::Format(_T("%d-%d"), size.x, size.y); +} + +// ============================================================================ // wxArtProvider class -// ---------------------------------------------------------------------------- +// ============================================================================ 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 ) { @@ -110,28 +151,37 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL; sm_cache = new wxArtProviderCache; } - sm_providers->Insert(provider); sm_cache->Clear(); } -/*static*/ bool wxArtProvider::PopProvider() +/*static*/ void wxArtProvider::Push(wxArtProvider *provider) +{ + CommonAddingProvider(); + sm_providers->Insert(provider); +} + +/*static*/ void wxArtProvider::Insert(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->empty(), false, _T("wxArtProviders stack is empty") ); delete sm_providers->GetFirst()->GetData(); - sm_providers->Erase(sm_providers->GetFirst()); sm_cache->Clear(); return true; } -/*static*/ bool wxArtProvider::RemoveProvider(wxArtProvider *provider) +/*static*/ bool wxArtProvider::Remove(wxArtProvider *provider) { wxCHECK_MSG( sm_providers, false, _T("no wxArtProvider exists") ); if ( sm_providers->DeleteObject(provider) ) { - delete provider; sm_cache->Clear(); return true; } @@ -139,13 +189,33 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL; 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() { - WX_CLEAR_LIST(wxArtProvidersList, *sm_providers); - wxDELETE(sm_providers); - wxDELETE(sm_cache); + if ( sm_providers ) + { + while ( !sm_providers->empty() ) + delete *sm_providers->begin(); + + delete sm_providers; + sm_providers = NULL; + + delete sm_cache; + sm_cache = NULL; + } } +// ---------------------------------------------------------------------------- +// wxArtProvider: retrieving bitmaps/icons +// ---------------------------------------------------------------------------- + /*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id, const wxArtClient& client, const wxSize& size) @@ -177,20 +247,53 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL; #endif break; } + // We could try the IconBundles here and convert what we find + // to a bitmap. } - sm_cache->PutBitmap(hashId, bmp); - } + } return bmp; } +/*static*/ wxIconBundle wxArtProvider::GetIconBundle(const wxArtID& id, const wxArtClient& client) +{ + // safety-check against writing client,id,size instead of id,client,size: + wxASSERT_MSG( client.Last() == _T('C'), _T("invalid 'client' parameter") ); + + wxCHECK_MSG( sm_providers, wxNullIconBundle, _T("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) { wxCHECK_MSG( sm_providers, wxNullIcon, _T("no wxArtProvider exists") ); + // First look for an appropriate icon bundle - this will give us the best icon + wxIconBundle iconBundle = GetIconBundle(id, client); + if ( iconBundle.IsOk() ) + return iconBundle.GetIcon(size); + + // If there is no icon bundle then look for a bitmap wxBitmap bmp = GetBitmap(id, client, size); if ( !bmp.Ok() ) return wxNullIcon; @@ -245,6 +348,39 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL; #endif // GTK+ 2/else } +// ---------------------------------------------------------------------------- +// 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 + +// ============================================================================ +// wxArtProviderModule +// ============================================================================ class wxArtProviderModule: public wxModule {