src/common/artprov.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/artprov.cpp
   3 // Purpose:     wxArtProvider class
   4 // Author:      Vaclav Slavik
   5 // Modified by:
   6 // Created:     18/03/2002
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vaclav Slavik
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ---------------------------------------------------------------------------
  13 // headers
  14 // ---------------------------------------------------------------------------
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #if defined(__BORLANDC__)
  20     #pragma hdrstop
  21 #endif
  22
  23 #include "wx/artprov.h"
  24
  25 #ifndef WX_PRECOMP
  26     #include "wx/list.h"
  27     #include "wx/log.h"
  28     #include "wx/hashmap.h"
  29     #include "wx/image.h"
  30     #include "wx/module.h"
  31 #endif
  32
  33 // ===========================================================================
  34 // implementation
  35 // ===========================================================================
  36
  37 #include "wx/listimpl.cpp"
  38 WX_DECLARE_LIST(wxArtProvider, wxArtProvidersList);
  39 WX_DEFINE_LIST(wxArtProvidersList)
  40
  41 // ----------------------------------------------------------------------------
  42 // Cache class - stores already requested bitmaps
  43 // ----------------------------------------------------------------------------
  44
  45 WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxBitmap, wxArtProviderBitmapsHash);
  46 WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxIconBundle, wxArtProviderIconBundlesHash);
  47
  48 class WXDLLEXPORT wxArtProviderCache
  49 {
  50 public:
  51     bool GetBitmap(const wxString& full_id, wxBitmap* bmp);
  52     void PutBitmap(const wxString& full_id, const wxBitmap& bmp)
  53         { m_bitmapsHash[full_id] = bmp; }
  54
  55     bool GetIconBundle(const wxString& full_id, wxIconBundle* bmp);
  56     void PutIconBundle(const wxString& full_id, const wxIconBundle& iconbundle)
  57         { m_iconBundlesHash[full_id] = iconbundle; }
  58
  59     void Clear();
  60
  61     static wxString ConstructHashID(const wxArtID& id,
  62                                     const wxArtClient& client,
  63                                     const wxSize& size);
  64
  65     static wxString ConstructHashID(const wxArtID& id,
  66                                     const wxArtClient& client);
  67
  68 private:
  69     wxArtProviderBitmapsHash m_bitmapsHash;         // cache of wxBitmaps
  70     wxArtProviderIconBundlesHash m_iconBundlesHash; // cache of wxIconBundles
  71 };
  72
  73 bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp)
  74 {
  75     wxArtProviderBitmapsHash::iterator entry = m_bitmapsHash.find(full_id);
  76     if ( entry == m_bitmapsHash.end() )
  77     {
  78         return false;
  79     }
  80     else
  81     {
  82         *bmp = entry->second;
  83         return true;
  84     }
  85 }
  86
  87 bool wxArtProviderCache::GetIconBundle(const wxString& full_id, wxIconBundle* bmp)
  88 {
  89     wxArtProviderIconBundlesHash::iterator entry = m_iconBundlesHash.find(full_id);
  90     if ( entry == m_iconBundlesHash.end() )
  91     {
  92         return false;
  93     }
  94     else
  95     {
  96         *bmp = entry->second;
  97         return true;
  98     }
  99 }
 100
 101 void wxArtProviderCache::Clear()
 102 {
 103     m_bitmapsHash.clear();
 104     m_iconBundlesHash.clear();
 105 }
 106
 107 /* static */ wxString
 108 wxArtProviderCache::ConstructHashID(const wxArtID& id,
 109                                     const wxArtClient& client)
 110 {
 111     return id + wxT('-') + client;
 112 }
 113
 114
 115 /* static */ wxString
 116 wxArtProviderCache::ConstructHashID(const wxArtID& id,
 117                                     const wxArtClient& client,
 118                                     const wxSize& size)
 119 {
 120     return ConstructHashID(id, client) + wxT('-') +
 121             wxString::Format(wxT("%d-%d"), size.x, size.y);
 122 }
 123
 124 // ============================================================================
 125 // wxArtProvider class
 126 // ============================================================================
 127
 128 IMPLEMENT_ABSTRACT_CLASS(wxArtProvider, wxObject)
 129
 130 wxArtProvidersList *wxArtProvider::sm_providers = NULL;
 131 wxArtProviderCache *wxArtProvider::sm_cache = NULL;
 132
 133 // ----------------------------------------------------------------------------
 134 // wxArtProvider ctors/dtor
 135 // ----------------------------------------------------------------------------
 136
 137 wxArtProvider::~wxArtProvider()
 138 {
 139     Remove(this);
 140 }
 141
 142 // ----------------------------------------------------------------------------
 143 // wxArtProvider operations on provider stack
 144 // ----------------------------------------------------------------------------
 145
 146 /*static*/ void wxArtProvider::CommonAddingProvider()
 147 {
 148     if ( !sm_providers )
 149     {
 150         sm_providers = new wxArtProvidersList;
 151         sm_cache = new wxArtProviderCache;
 152     }
 153
 154     sm_cache->Clear();
 155 }
 156
 157 /*static*/ void wxArtProvider::Push(wxArtProvider *provider)
 158 {
 159     CommonAddingProvider();
 160     sm_providers->Insert(provider);
 161 }
 162
 163 /*static*/ void wxArtProvider::PushBack(wxArtProvider *provider)
 164 {
 165     CommonAddingProvider();
 166     sm_providers->Append(provider);
 167 }
 168
 169 /*static*/ bool wxArtProvider::Pop()
 170 {
 171     wxCHECK_MSG( sm_providers, false, wxT("no wxArtProvider exists") );
 172     wxCHECK_MSG( !sm_providers->empty(), false, wxT("wxArtProviders stack is empty") );
 173
 174     delete sm_providers->GetFirst()->GetData();
 175     sm_cache->Clear();
 176     return true;
 177 }
 178
 179 /*static*/ bool wxArtProvider::Remove(wxArtProvider *provider)
 180 {
 181     wxCHECK_MSG( sm_providers, false, wxT("no wxArtProvider exists") );
 182
 183     if ( sm_providers->DeleteObject(provider) )
 184     {
 185         sm_cache->Clear();
 186         return true;
 187     }
 188
 189     return false;
 190 }
 191
 192 /*static*/ bool wxArtProvider::Delete(wxArtProvider *provider)
 193 {
 194     // provider will remove itself from the stack in its dtor
 195     delete provider;
 196
 197     return true;
 198 }
 199
 200 /*static*/ void wxArtProvider::CleanUpProviders()
 201 {
 202     if ( sm_providers )
 203     {
 204         while ( !sm_providers->empty() )
 205             delete *sm_providers->begin();
 206
 207         delete sm_providers;
 208         sm_providers = NULL;
 209
 210         delete sm_cache;
 211         sm_cache = NULL;
 212     }
 213 }
 214
 215 // ----------------------------------------------------------------------------
 216 // wxArtProvider: retrieving bitmaps/icons
 217 // ----------------------------------------------------------------------------
 218
 219 /*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id,
 220                                              const wxArtClient& client,
 221                                              const wxSize& size)
 222 {
 223     // safety-check against writing client,id,size instead of id,client,size:
 224     wxASSERT_MSG( client.Last() == wxT('C'), wxT("invalid 'client' parameter") );
 225
 226     wxCHECK_MSG( sm_providers, wxNullBitmap, wxT("no wxArtProvider exists") );
 227
 228     wxString hashId = wxArtProviderCache::ConstructHashID(id, client, size);
 229
 230     wxBitmap bmp;
 231     if ( !sm_cache->GetBitmap(hashId, &bmp) )
 232     {
 233         for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
 234              node; node = node->GetNext())
 235         {
 236             bmp = node->GetData()->CreateBitmap(id, client, size);
 237             if ( bmp.Ok() )
 238                 break;
 239         }
 240
 241         if ( !bmp.Ok() )
 242         {
 243             // no bitmap created -- as a fallback, try if we can find desired
 244             // icon in a bundle
 245             wxIconBundle iconBundle = DoGetIconBundle(id, client);
 246             if ( iconBundle.IsOk() )
 247             {
 248                 wxSize sz(size != wxDefaultSize
 249                             ? size
 250                             : GetNativeSizeHint(client));
 251                 wxIcon icon(iconBundle.GetIcon(sz));
 252                 if ( icon.IsOk() )
 253                     bmp.CopyFromIcon(icon);
 254             }
 255         }
 256
 257         if ( bmp.IsOk() )
 258         {
 259             // if we didn't get the correct size, resize the bitmap
 260 #if wxUSE_IMAGE && (!defined(__WXMSW__) || wxUSE_WXDIB)
 261             if ( size != wxDefaultSize &&
 262                  (bmp.GetWidth() != size.x || bmp.GetHeight() != size.y) )
 263             {
 264                 wxImage img = bmp.ConvertToImage();
 265                 img.Rescale(size.x, size.y);
 266                 bmp = wxBitmap(img);
 267             }
 268 #endif
 269         }
 270
 271         sm_cache->PutBitmap(hashId, bmp);
 272     }
 273
 274     return bmp;
 275 }
 276
 277 /*static*/
 278 wxIconBundle wxArtProvider::GetIconBundle(const wxArtID& id, const wxArtClient& client)
 279 {
 280     wxIconBundle iconbundle(DoGetIconBundle(id, client));
 281
 282     if ( iconbundle.IsOk() )
 283     {
 284         return iconbundle;
 285     }
 286     else
 287     {
 288         // fall back to single-icon bundle
 289         return wxIconBundle(GetIcon(id, client));
 290     }
 291 }
 292
 293 /*static*/
 294 wxIconBundle wxArtProvider::DoGetIconBundle(const wxArtID& id, const wxArtClient& client)
 295 {
 296     // safety-check against writing client,id,size instead of id,client,size:
 297     wxASSERT_MSG( client.Last() == wxT('C'), wxT("invalid 'client' parameter") );
 298
 299     wxCHECK_MSG( sm_providers, wxNullIconBundle, wxT("no wxArtProvider exists") );
 300
 301     wxString hashId = wxArtProviderCache::ConstructHashID(id, client);
 302
 303     wxIconBundle iconbundle;
 304     if ( !sm_cache->GetIconBundle(hashId, &iconbundle) )
 305     {
 306         for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
 307              node; node = node->GetNext())
 308         {
 309             iconbundle = node->GetData()->CreateIconBundle(id, client);
 310             if ( iconbundle.IsOk() )
 311                 break;
 312         }
 313
 314         sm_cache->PutIconBundle(hashId, iconbundle);
 315     }
 316
 317     return iconbundle;
 318 }
 319
 320 /*static*/ wxIcon wxArtProvider::GetIcon(const wxArtID& id,
 321                                          const wxArtClient& client,
 322                                          const wxSize& size)
 323 {
 324     wxBitmap bmp = GetBitmap(id, client, size);
 325
 326     if ( !bmp.IsOk() )
 327         return wxNullIcon;
 328
 329     wxIcon icon;
 330     icon.CopyFromBitmap(bmp);
 331     return icon;
 332 }
 333
 334 /* static */
 335 wxArtID wxArtProvider::GetMessageBoxIconId(int flags)
 336 {
 337     switch ( flags & wxICON_MASK )
 338     {
 339         default:
 340             wxFAIL_MSG(wxT("incorrect message box icon flags"));
 341             // fall through
 342
 343         case wxICON_ERROR:
 344             return wxART_ERROR;
 345
 346         case wxICON_INFORMATION:
 347             return wxART_INFORMATION;
 348
 349         case wxICON_WARNING:
 350             return wxART_WARNING;
 351
 352         case wxICON_QUESTION:
 353             return wxART_QUESTION;
 354     }
 355 }
 356
 357 /*static*/ wxSize wxArtProvider::GetSizeHint(const wxArtClient& client,
 358                                          bool platform_dependent)
 359 {
 360     if (!platform_dependent)
 361     {
 362         wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
 363         if (node)
 364             return node->GetData()->DoGetSizeHint(client);
 365     }
 366
 367     return GetNativeSizeHint(client);
 368 }
 369
 370 #ifndef wxHAS_NATIVE_ART_PROVIDER_IMPL
 371 /*static*/
 372 wxSize wxArtProvider::GetNativeSizeHint(const wxArtClient& WXUNUSED(client))
 373 {
 374     // rather than returning some arbitrary value that doesn't make much
 375     // sense (as 2.8 used to do), tell the caller that we don't have a clue:
 376     return wxDefaultSize;
 377 }
 378
 379 /*static*/
 380 void wxArtProvider::InitNativeProvider()
 381 {
 382 }
 383 #endif // !wxHAS_NATIVE_ART_PROVIDER_IMPL
 384
 385
 386 /* static */
 387 bool wxArtProvider::HasNativeProvider()
 388 {
 389 #ifdef __WXGTK20__
 390     return true;
 391 #else
 392     return false;
 393 #endif
 394 }
 395
 396 // ----------------------------------------------------------------------------
 397 // deprecated wxArtProvider methods
 398 // ----------------------------------------------------------------------------
 399
 400 #if WXWIN_COMPATIBILITY_2_6
 401
 402 /* static */ void wxArtProvider::PushProvider(wxArtProvider *provider)
 403 {
 404     Push(provider);
 405 }
 406
 407 /* static */ void wxArtProvider::InsertProvider(wxArtProvider *provider)
 408 {
 409     Insert(provider);
 410 }
 411
 412 /* static */ bool wxArtProvider::PopProvider()
 413 {
 414     return Pop();
 415 }
 416
 417 /* static */ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
 418 {
 419     // RemoveProvider() used to delete the provider being removed so this is
 420     // not a typo, we must call Delete() and not Remove() here
 421     return Delete(provider);
 422 }
 423
 424 #endif // WXWIN_COMPATIBILITY_2_6
 425
 426 #if WXWIN_COMPATIBILITY_2_8
 427 /* static */ void wxArtProvider::Insert(wxArtProvider *provider)
 428 {
 429     PushBack(provider);
 430 }
 431 #endif // WXWIN_COMPATIBILITY_2_8
 432
 433 // ============================================================================
 434 // wxArtProviderModule
 435 // ============================================================================
 436
 437 class wxArtProviderModule: public wxModule
 438 {
 439 public:
 440     bool OnInit()
 441     {
 442         wxArtProvider::InitStdProvider();
 443         wxArtProvider::InitNativeProvider();
 444         return true;
 445     }
 446     void OnExit()
 447     {
 448         wxArtProvider::CleanUpProviders();
 449     }
 450
 451     DECLARE_DYNAMIC_CLASS(wxArtProviderModule)
 452 };
 453
 454 IMPLEMENT_DYNAMIC_CLASS(wxArtProviderModule, wxModule)