correct bug with using uninitialized end variable (unused variable warnings are not...

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

diff --git a/src/common/iconbndl.cpp b/src/common/iconbndl.cpp
index 4cefbd84b4bb61d369557e1c16a39c83fb391deb..8fa0ccd441d5f665d6832fcb47305d5bf293a71a 100644 (file)
--- a/src/common/iconbndl.cpp
+++ b/src/common/iconbndl.cpp
@@ -1,17 +1,13 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxIconBundle
 // Purpose:     wxIconBundle

-// Author:      Mattia Barbon
+// Author:      Mattia Barbon, Vadim Zeitlin

 // Created:     23.03.2002
 // RCS-ID:      $Id$
 // Copyright:   (c) Mattia barbon
 // Created:     23.03.2002
 // RCS-ID:      $Id$
 // Copyright:   (c) Mattia barbon

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "iconbndl.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"
 


@@ -19,120 +15,256 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#include "wx/iconbndl.h"
+

 #ifndef WX_PRECOMP
     #include "wx/settings.h"
 #ifndef WX_PRECOMP
     #include "wx/settings.h"

-    #include "wx/icon.h"

     #include "wx/log.h"
     #include "wx/intl.h"
     #include "wx/bitmap.h"
     #include "wx/log.h"
     #include "wx/intl.h"
     #include "wx/bitmap.h"

-#endif
-
-#if wxUSE_IMAGE && !defined(_WX_IMAGE_H_)

     #include "wx/image.h"
     #include "wx/image.h"

+    #include "wx/stream.h"

 #endif
 
 #endif
 

-#include "wx/iconbndl.h"
-#include "wx/arrimpl.cpp"
+#include "wx/wfstream.h"

 
 

+#include "wx/arrimpl.cpp"

 WX_DEFINE_OBJARRAY(wxIconArray)
 
 WX_DEFINE_OBJARRAY(wxIconArray)
 

-const wxIconBundle& wxIconBundle::operator =( const wxIconBundle& ic )
+IMPLEMENT_DYNAMIC_CLASS(wxIconBundle, wxGDIObject)
+
+#define M_ICONBUNDLEDATA static_cast<wxIconBundleRefData*>(m_refData)
+
+// ----------------------------------------------------------------------------
+// wxIconBundleRefData
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxIconBundleRefData : public wxGDIRefData

 {
 {

-    if( this == &ic ) return *this;
+public:
+    // default and copy ctors and assignment operators are ok
+
+    virtual bool IsOk() const { return !m_icons.empty(); }
+
+    wxIconArray m_icons;
+};
+
+// ============================================================================
+// wxIconBundle implementation
+// ============================================================================

 
 

-    size_t i, max = ic.m_icons.GetCount();
+wxIconBundle::wxIconBundle()
+{
+}

 
 

-    DeleteIcons();
-    for( i = 0; i < max; ++i )
-        m_icons.Add( ic.m_icons[i] );
+wxIconBundle::wxIconBundle(const wxString& file, wxBitmapType type)
+            : wxGDIObject()
+{
+    AddIcon(file, type);
+}

 
 

-    return *this;
+#if wxUSE_STREAMS
+wxIconBundle::wxIconBundle(wxInputStream& stream, wxBitmapType type)
+            : wxGDIObject()
+{
+    AddIcon(stream, type);
+}
+#endif // wxUSE_STREAMS
+
+wxIconBundle::wxIconBundle(const wxIcon& icon)
+            : wxGDIObject()
+{
+    AddIcon(icon);
+}
+
+wxGDIRefData *wxIconBundle::CreateGDIRefData() const
+{
+    return new wxIconBundleRefData;
+}
+
+wxGDIRefData *wxIconBundle::CloneGDIRefData(const wxGDIRefData *data) const
+{
+    return new wxIconBundleRefData(*static_cast<const wxIconBundleRefData *>(data));

 }
 
 void wxIconBundle::DeleteIcons()
 {
 }
 
 void wxIconBundle::DeleteIcons()
 {

-    m_icons.Empty();
+    UnRef();

 }
 
 }
 

-#if wxUSE_IMAGE
-void wxIconBundle::AddIcon( const wxString& file, long type )
-#else
-void wxIconBundle::AddIcon( const wxString& WXUNUSED(file), long WXUNUSED(type) )
-#endif
+namespace
+{
+
+// Adds icon from 'input' to the bundle. Shows 'errorMessage' on failure
+// (it must contain "%d", because it is used to report # of image in the file
+// that failed to load):
+void DoAddIcon(wxIconBundle& bundle,
+               wxInputStream& input,
+               wxBitmapType type,
+               const wxString& errorMessage)

 {
 {

-#if wxUSE_IMAGE
-    size_t count = wxImage::GetImageCount( file, type );
-    size_t i;

     wxImage image;
 
     wxImage image;
 

-    for( i = 0; i < count; ++i )
+    const wxFileOffset posOrig = input.TellI();
+
+    const size_t count = wxImage::GetImageCount(input, type);
+    for ( size_t i = 0; i < count; ++i )

     {
     {

-        if( !image.LoadFile( file, type, i ) )
+        if ( i )

         {
         {

-            wxLogError( _("Failed to load image %d from file '%s'."),
-                        i, file.c_str() );
+            // the call to LoadFile() for the first sub-image updated the
+            // stream position but we need to start reading the subsequent
+            // sub-image at the image beginning too
+            input.SeekI(posOrig);
+        }
+
+        if ( !image.LoadFile(input, type, i) )
+        {
+            wxLogError(errorMessage, i);

             continue;
         }
 
             continue;
         }
 

-        wxIcon* tmp = new wxIcon();
-        tmp->CopyFromBitmap( wxBitmap( image ) );
-        AddIcon( *tmp );
-        delete tmp;
+        if ( type == wxBITMAP_TYPE_ANY )
+        {
+            // store the type so that we don't need to try all handlers again
+            // for the subsequent images, they should all be of the same type
+            type = image.GetType();
+        }
+
+        wxIcon tmp;
+        tmp.CopyFromBitmap(wxBitmap(image));
+        bundle.AddIcon(tmp);

     }
     }

-#endif

 }
 
 }
 

-const wxIcon& wxIconBundle::GetIcon( const wxSize& size ) const
-{
-    size_t i, max = m_icons.GetCount();
-    wxCoord sysX = wxSystemSettings::GetMetric( wxSYS_ICON_X ),
-            sysY = wxSystemSettings::GetMetric( wxSYS_ICON_Y );
+} // anonymous namespace

 
 

-    wxIcon *sysIcon = 0;
-    // temp. variable needed to fix Borland C++ 5.5.1 problem
-    // with passing a return value through two functions
-    wxIcon *tmp;
-
-    for( i = 0; i < max; i++ )
+void wxIconBundle::AddIcon(const wxString& file, wxBitmapType type)
+{
+#ifdef __WXMAC__
+    // Deal with standard icons
+    if ( type == wxBITMAP_TYPE_ICON_RESOURCE )

     {
     {

-        if( !m_icons[i].Ok() )
-            continue;
-        wxCoord sx = m_icons[i].GetWidth(), sy = m_icons[i].GetHeight();
-        // requested size
-        if( sx == size.x && sy == size.y )
+        wxIcon tmp(file, type);
+        if (tmp.Ok())

         {
         {

-            tmp = &m_icons[i]; // fix for broken BCC
-            return *tmp;
+            AddIcon(tmp);
+            return;

         }
         }

-        // keep track if there is a system-size icon
-        if( sx == sysX && sy == sysY )
-            sysIcon = &m_icons[i];

     }
     }

+#endif // __WXMAC__

 
 

-    // return the system-sized icon if we've got one
-    if( sysIcon ) return *sysIcon;
-    // return the first icon, if we have one
-    if( max > 0 ) // fix for broken BCC
-        tmp = &m_icons[0];
-    else
-        tmp = &wxNullIcon;
-    return *tmp;
+    wxFFileInputStream stream(file);
+    DoAddIcon
+    (
+        *this,
+        stream, type,
+        wxString::Format(_("Failed to load image %%d from file '%s'."), file)
+    );
+}
+
+#if wxUSE_STREAMS
+void wxIconBundle::AddIcon(wxInputStream& stream, wxBitmapType type)
+{
+    DoAddIcon(*this, stream, type, _("Failed to load image %d from stream."));

 }
 }

+#endif // wxUSE_STREAMS

 
 

-void wxIconBundle::AddIcon( const wxIcon& icon )
+wxIcon wxIconBundle::GetIcon(const wxSize& size) const

 {
 {

-    size_t i, max = m_icons.GetCount();
+    const size_t count = GetIconCount();

 
 

-    for( i = 0; i < max; ++i )
+    // optimize for the common case of icon bundles containing one icon only
+    wxIcon iconBest;
+    switch ( count )

     {
     {

-        wxIcon& tmp = m_icons[i];
-        if( tmp.Ok() && tmp.GetWidth() == icon.GetWidth() &&
-            tmp.GetHeight() == icon.GetHeight() )
+        case 0:
+            // nothing to do, iconBest is already invalid
+            break;
+
+        case 1:
+            iconBest = M_ICONBUNDLEDATA->m_icons[0];
+            break;
+
+        default:
+            // there is more than one icon, find the best match:
+            wxCoord sysX = wxSystemSettings::GetMetric( wxSYS_ICON_X ),
+                    sysY = wxSystemSettings::GetMetric( wxSYS_ICON_Y );
+
+            const wxIconArray& iconArray = M_ICONBUNDLEDATA->m_icons;
+            for ( size_t i = 0; i < count; i++ )
+            {
+                const wxIcon& icon = iconArray[i];
+                wxCoord sx = icon.GetWidth(),
+                        sy = icon.GetHeight();
+
+                // if we got an icon of exactly the requested size, we're done
+                if ( sx == size.x && sy == size.y )
+                {
+                    iconBest = icon;
+                    break;
+                }
+
+                // the best icon is by default (arbitrarily) the first one but
+                // if we find a system-sized icon, take it instead
+                if ((sx == sysX && sy == sysY) || !iconBest.IsOk())
+                    iconBest = icon;
+            }
+    }
+
+#if defined( __WXMAC__ ) && wxOSX_USE_CARBON
+    return wxIcon(iconBest.GetHICON(), size);
+#else
+    return iconBest;
+#endif
+}
+
+wxIcon wxIconBundle::GetIconOfExactSize(const wxSize& size) const
+{
+    wxIcon icon = GetIcon(size);
+    if ( icon.Ok() &&
+            (icon.GetWidth() != size.x || icon.GetHeight() != size.y) )
+    {
+        icon = wxNullIcon;
+    }
+
+    return icon;
+}
+
+void wxIconBundle::AddIcon(const wxIcon& icon)
+{
+    wxCHECK_RET( icon.IsOk(), _T("invalid icon") );
+
+    AllocExclusive();
+
+    wxIconArray& iconArray = M_ICONBUNDLEDATA->m_icons;
+
+    // replace existing icon with the same size if we already have it
+    const size_t count = iconArray.size();
+    for ( size_t i = 0; i < count; ++i )
+    {
+        wxIcon& tmp = iconArray[i];
+        if ( tmp.Ok() &&
+                tmp.GetWidth() == icon.GetWidth() &&
+                tmp.GetHeight() == icon.GetHeight() )

         {
             tmp = icon;
             return;
         }
     }
 
         {
             tmp = icon;
             return;
         }
     }
 

-    m_icons.Add( icon );
+    // if we don't, add an icon with new size
+    iconArray.Add(icon);
+}
+
+size_t wxIconBundle::GetIconCount() const
+{
+    return IsOk() ? M_ICONBUNDLEDATA->m_icons.size() : 0;
+}
+
+wxIcon wxIconBundle::GetIconByIndex(size_t n) const
+{
+    wxCHECK_MSG( n < GetIconCount(), wxNullIcon, _T("invalid index") );
+
+    return M_ICONBUNDLEDATA->m_icons[n];

 }
 }