]> git.saurik.com Git - wxWidgets.git/blobdiff - src/html/m_image.cpp
Improve appearance of text with background colour in wxHTML.
[wxWidgets.git] / src / html / m_image.cpp
index 85e8f274d7810d4085d815d676d4b1dd76f43069..6394fa1b2bec48061ff04142f6f15e2a164c12b8 100644 (file)
@@ -1,36 +1,39 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        m_image.cpp
+// Name:        src/html/m_image.cpp
 // Purpose:     wxHtml module for displaying images
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik, Joel Lucsy
-// Licence:     wxWindows Licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "wx/wxprec.h"
 
-#include "wx/defs.h"
-#if wxUSE_HTML && wxUSE_STREAMS
-
-#ifdef __BORDLANDC__
-#pragma hdrstop
+#ifdef __BORLANDC__
+    #pragma hdrstop
 #endif
 
-#ifndef WXPRECOMP
+#if wxUSE_HTML && wxUSE_STREAMS
+
+#ifndef WX_PRECOMP
+    #include "wx/dynarray.h"
     #include "wx/dc.h"
+    #include "wx/scrolwin.h"
+    #include "wx/timer.h"
+    #include "wx/dcmemory.h"
+    #include "wx/log.h"
+    #include "wx/math.h"
+    #include "wx/image.h"
+    #include "wx/wxcrtvararg.h"
 #endif
 
 #include "wx/html/forcelnk.h"
 #include "wx/html/m_templ.h"
+#include "wx/html/htmlwin.h"
 
-#include "wx/image.h"
-#include "wx/dynarray.h"
+#include "wx/gifdecod.h"
+#include "wx/artprov.h"
 
-#include <math.h>
 #include <float.h>
 
 FORCE_LINK_ME(m_image)
@@ -40,14 +43,14 @@ FORCE_LINK_ME(m_image)
 
 WX_DECLARE_OBJARRAY(int, CoordArray);
 #include "wx/arrimpl.cpp" // this is a magic incantation which must be done!
-WX_DEFINE_OBJARRAY(CoordArray);
+WX_DEFINE_OBJARRAY(CoordArray)
 
 
-//--------------------------------------------------------------------------------
+// ---------------------------------------------------------------------------
 // wxHtmlImageMapAreaCell
-//                  0-width, 0-height cell that represents single area in imagemap
-//                  (it's GetLink is called from wxHtmlImageCell's)
-//--------------------------------------------------------------------------------
+//                  0-width, 0-height cell that represents single area in
+//                  imagemap (it's GetLink is called from wxHtmlImageCell's)
+// ---------------------------------------------------------------------------
 
 class wxHtmlImageMapAreaCell : public wxHtmlCell
 {
@@ -60,6 +63,13 @@ class wxHtmlImageMapAreaCell : public wxHtmlCell
     public:
         wxHtmlImageMapAreaCell( celltype t, wxString &coords, double pixel_scale = 1.0);
         virtual wxHtmlLinkInfo *GetLink( int x = 0, int y = 0 ) const;
+        void Draw(wxDC& WXUNUSED(dc),
+                  int WXUNUSED(x), int WXUNUSED(y),
+                  int WXUNUSED(view_y1), int WXUNUSED(view_y2),
+                  wxHtmlRenderingInfo& WXUNUSED(info)) {}
+
+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlImageMapAreaCell);
 };
 
 
@@ -72,7 +82,7 @@ wxHtmlImageMapAreaCell::wxHtmlImageMapAreaCell( wxHtmlImageMapAreaCell::celltype
     wxString x = incoords, y;
 
     type = t;
-    while ((i = x.Find( ',' )) != -1)
+    while ((i = x.Find( ',' )) != wxNOT_FOUND)
     {
         coords.Add( (int)(pixel_scale * (double)wxAtoi( x.Left( i ).c_str())) );
         x = x.Mid( i + 1 );
@@ -232,6 +242,12 @@ class wxHtmlImageMapCell : public wxHtmlCell
     public:
         virtual wxHtmlLinkInfo *GetLink( int x = 0, int y = 0 ) const;
         virtual const wxHtmlCell *Find( int cond, const void *param ) const;
+        void Draw(wxDC& WXUNUSED(dc),
+                  int WXUNUSED(x), int WXUNUSED(y),
+                  int WXUNUSED(view_y1), int WXUNUSED(view_y2),
+                  wxHtmlRenderingInfo& WXUNUSED(info)) {}
+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlImageMapCell);
 };
 
 
@@ -269,54 +285,279 @@ const wxHtmlCell *wxHtmlImageMapCell::Find( int cond, const void *param ) const
 
 class wxHtmlImageCell : public wxHtmlCell
 {
-    public:
-        wxBitmap *m_Image;
-        double m_Scale;
-        wxHtmlImageMapCell *m_ImageMap;
-        wxString m_MapName;
-
-        wxHtmlImageCell(wxFSFile *input, int w = -1, int h = -1, double scale = 1.0, int align = wxHTML_ALIGN_BOTTOM, wxString mapname = wxEmptyString);
-        ~wxHtmlImageCell() {if (m_Image) delete m_Image; }
-        void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
-        virtual wxHtmlLinkInfo *GetLink( int x = 0, int y = 0 ) const;
+public:
+    wxHtmlImageCell(wxHtmlWindowInterface *windowIface,
+                    wxFSFile *input,
+                    int w = wxDefaultCoord, bool wpercent = false,
+                    int h = wxDefaultCoord, bool hpresent = false,
+                    double scale = 1.0, int align = wxHTML_ALIGN_BOTTOM,
+                    const wxString& mapname = wxEmptyString);
+    virtual ~wxHtmlImageCell();
+    void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
+              wxHtmlRenderingInfo& info);
+    virtual wxHtmlLinkInfo *GetLink(int x = 0, int y = 0) const;
+
+    void SetImage(const wxImage& img);
+
+    // If "alt" text is set, it will be used when converting this cell to text.
+    void SetAlt(const wxString& alt);
+    virtual wxString ConvertToText(wxHtmlSelection *sel) const;
+
+#if wxUSE_GIF && wxUSE_TIMER
+    void AdvanceAnimation(wxTimer *timer);
+    virtual void Layout(int w);
+#endif
+
+private:
+    wxBitmap           *m_bitmap;
+    int                 m_align;
+    int                 m_bmpW, m_bmpH;
+    bool                m_bmpWpercent:1;
+    bool                m_bmpHpresent:1;
+    bool                m_showFrame:1;
+    wxHtmlWindowInterface *m_windowIface;
+#if wxUSE_GIF && wxUSE_TIMER
+    wxGIFDecoder       *m_gifDecoder;
+    wxTimer            *m_gifTimer;
+    int                 m_physX, m_physY;
+    size_t              m_nCurrFrame;
+#endif
+    double              m_scale;
+    wxHtmlImageMapCell *m_imageMap;
+    wxString            m_mapName;
+    wxString            m_alt;
+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlImageCell);
 };
 
+#if wxUSE_GIF && wxUSE_TIMER
+class wxGIFTimer : public wxTimer
+{
+    public:
+        wxGIFTimer(wxHtmlImageCell *cell) : m_cell(cell) {}
+        virtual void Notify()
+        {
+            m_cell->AdvanceAnimation(this);
+        }
 
+    private:
+        wxHtmlImageCell *m_cell;
 
+    wxDECLARE_NO_COPY_CLASS(wxGIFTimer);
+};
+#endif
 
-//--------------------------------------------------------------------------------
+
+//----------------------------------------------------------------------------
 // wxHtmlImageCell
-//--------------------------------------------------------------------------------
+//----------------------------------------------------------------------------
+
+
+wxHtmlImageCell::wxHtmlImageCell(wxHtmlWindowInterface *windowIface,
+                                 wxFSFile *input,
+                                 int w, bool wpercent, int h, bool hpresent, double scale, int align,
+                                 const wxString& mapname) : wxHtmlCell()
+{
+    m_windowIface = windowIface;
+    m_scale = scale;
+    m_showFrame = false;
+    m_bitmap = NULL;
+    m_bmpW   = w;
+    m_bmpH   = h;
+    m_align  = align;
+    m_bmpWpercent = wpercent;
+    m_bmpHpresent = hpresent;
+    m_imageMap = NULL;
+    m_mapName = mapname;
+    SetCanLiveOnPagebreak(false);
+#if wxUSE_GIF && wxUSE_TIMER
+    m_gifDecoder = NULL;
+    m_gifTimer = NULL;
+    m_physX = m_physY = wxDefaultCoord;
+    m_nCurrFrame = 0;
+#endif
+
+    if ( m_bmpW && m_bmpH )
+    {
+        if ( input )
+        {
+            wxInputStream *s = input->GetStream();
+
+            if ( s )
+            {
+#if wxUSE_GIF && wxUSE_TIMER
+                bool readImg = true;
+                if ( m_windowIface &&
+                     (input->GetLocation().Matches(wxT("*.gif")) ||
+                      input->GetLocation().Matches(wxT("*.GIF"))) )
+                {
+                    m_gifDecoder = new wxGIFDecoder();
+                    if ( m_gifDecoder->LoadGIF(*s) == wxGIF_OK )
+                    {
+                        wxImage img;
+                        if ( m_gifDecoder->ConvertToImage(0, &img) )
+                            SetImage(img);
+
+                        readImg = false;
+
+                        if ( m_gifDecoder->IsAnimation() )
+                        {
+                            m_gifTimer = new wxGIFTimer(this);
+                            long delay = m_gifDecoder->GetDelay(0);
+                            if ( delay == 0 )
+                                delay = 1;
+                            m_gifTimer->Start(delay, true);
+                        }
+                        else
+                        {
+                            wxDELETE(m_gifDecoder);
+                        }
+                    }
+                    else
+                    {
+                        wxDELETE(m_gifDecoder);
+                    }
+                }
+
+                if ( readImg )
+#endif // wxUSE_GIF && wxUSE_TIMER
+                {
+                    wxImage image(*s, wxBITMAP_TYPE_ANY);
+                    if ( image.IsOk() )
+                        SetImage(image);
+                }
+            }
+        }
+        else // input==NULL, use "broken image" bitmap
+        {
+            if ( m_bmpW == wxDefaultCoord && m_bmpH == wxDefaultCoord )
+            {
+                m_bmpW = 29;
+                m_bmpH = 31;
+            }
+            else
+            {
+                m_showFrame = true;
+                if ( m_bmpW == wxDefaultCoord ) m_bmpW = 31;
+                if ( m_bmpH == wxDefaultCoord ) m_bmpH = 33;
+            }
+            m_bitmap =
+                new wxBitmap(wxArtProvider::GetBitmap(wxART_MISSING_IMAGE));
+        }
+    }
+    //else: ignore the 0-sized images used sometimes on the Web pages
+
+ }
 
-wxHtmlImageCell::wxHtmlImageCell(wxFSFile *input, int w, int h, double scale, int align, wxString mapname) : wxHtmlCell()
+void wxHtmlImageCell::SetImage(const wxImage& img)
 {
-    wxImage *img;
-    int ww, hh, bw, bh;
-    wxInputStream *s = input->GetStream();
-
-    m_Scale = scale;
-    img = new wxImage(*s, wxBITMAP_TYPE_ANY);
-    m_Image = NULL;
-    if (img && (img->Ok()))
+#if !defined(__WXMSW__) || wxUSE_WXDIB
+    if ( img.IsOk() )
     {
-        ww = img->GetWidth();
-        hh = img->GetHeight();
-        if (w != -1) bw = w; else bw = ww;
-        if (h != -1) bh = h; else bh = hh;
+        delete m_bitmap;
 
-        m_Width = (int)(scale * (double)bw);
-        m_Height = (int)(scale * (double)bh);
+        int ww, hh;
+        ww = img.GetWidth();
+        hh = img.GetHeight();
 
-        if ((bw != ww) || (bh != hh))
+        if ( m_bmpW == wxDefaultCoord)
+            m_bmpW = ww;
+        if ( m_bmpH == wxDefaultCoord)
+            m_bmpH = hh;
+
+        // Only scale the bitmap at the rendering stage,
+        // so we don't lose quality twice
+/*
+        if ((m_bmpW != ww) || (m_bmpH != hh))
         {
-            wxImage img2 = img->Scale(bw, bh);
-            m_Image = new wxBitmap(img2.ConvertToBitmap());
+            wxImage img2 = img.Scale(m_bmpW, m_bmpH);
+            m_bitmap = new wxBitmap(img2);
         }
         else
-            m_Image = new wxBitmap(img->ConvertToBitmap());
-        delete img;
+*/
+            m_bitmap = new wxBitmap(img);
+    }
+#endif
+}
+
+void wxHtmlImageCell::SetAlt(const wxString& alt)
+{
+    m_alt = alt;
+}
+
+wxString wxHtmlImageCell::ConvertToText(wxHtmlSelection* WXUNUSED(sel)) const
+{
+    return m_alt;
+}
+
+#if wxUSE_GIF && wxUSE_TIMER
+void wxHtmlImageCell::AdvanceAnimation(wxTimer *timer)
+{
+    wxImage img;
+
+    // advance current frame
+    m_nCurrFrame++;
+    if (m_nCurrFrame == m_gifDecoder->GetFrameCount())
+        m_nCurrFrame = 0;
+
+    if ( m_physX == wxDefaultCoord )
+    {
+        m_physX = m_physY = 0;
+        for (wxHtmlCell *cell = this; cell; cell = cell->GetParent())
+        {
+            m_physX += cell->GetPosX();
+            m_physY += cell->GetPosY();
+        }
     }
-    switch (align)
+
+    wxWindow *win = m_windowIface->GetHTMLWindow();
+    wxPoint pos =
+        m_windowIface->HTMLCoordsToWindow(this, wxPoint(m_physX, m_physY));
+    wxRect rect(pos, wxSize(m_Width, m_Height));
+
+    if ( win->GetClientRect().Intersects(rect) &&
+         m_gifDecoder->ConvertToImage(m_nCurrFrame, &img) )
+    {
+#if !defined(__WXMSW__) || wxUSE_WXDIB
+        if ( m_gifDecoder->GetFrameSize(m_nCurrFrame) != wxSize(m_Width, m_Height) ||
+             m_gifDecoder->GetFramePosition(m_nCurrFrame) != wxPoint(0, 0) )
+        {
+            wxBitmap bmp(img);
+            wxMemoryDC dc;
+            dc.SelectObject(*m_bitmap);
+            dc.DrawBitmap(bmp, m_gifDecoder->GetFramePosition(m_nCurrFrame),
+                          true /* use mask */);
+        }
+        else
+#endif
+            SetImage(img);
+        win->Refresh(img.HasMask(), &rect);
+    }
+
+    long delay = m_gifDecoder->GetDelay(m_nCurrFrame);
+    if ( delay == 0 )
+        delay = 1;
+    timer->Start(delay, true);
+}
+
+void wxHtmlImageCell::Layout(int w)
+{
+    if (m_bmpWpercent)
+    {
+
+        m_Width = w*m_bmpW/100;
+
+        if (!m_bmpHpresent && m_bitmap != NULL)
+            m_Height = m_bitmap->GetHeight()*m_Width/m_bitmap->GetWidth();
+        else
+            m_Height = static_cast<int>(m_scale*m_bmpH);
+    } else
+    {
+        m_Width  = static_cast<int>(m_scale*m_bmpW);
+        m_Height = static_cast<int>(m_scale*m_bmpH);
+    }
+
+    switch (m_align)
     {
         case wxHTML_ALIGN_TOP :
             m_Descent = m_Height;
@@ -330,34 +571,59 @@ wxHtmlImageCell::wxHtmlImageCell(wxFSFile *input, int w, int h, double scale, in
             break;
     }
 
-    m_ImageMap = NULL;
-    m_MapName = mapname;
-    SetCanLiveOnPagebreak(FALSE);
+    wxHtmlCell::Layout(w);
+    m_physX = m_physY = wxDefaultCoord;
 }
 
+#endif
 
+wxHtmlImageCell::~wxHtmlImageCell()
+{
+    delete m_bitmap;
+#if wxUSE_GIF && wxUSE_TIMER
+    delete m_gifTimer;
+    delete m_gifDecoder;
+#endif
+}
 
-void wxHtmlImageCell::Draw(wxDC& dc, int x, int y, int view_y1, int view_y2)
+
+void wxHtmlImageCell::Draw(wxDC& dc, int x, int y,
+                           int WXUNUSED(view_y1), int WXUNUSED(view_y2),
+                           wxHtmlRenderingInfo& WXUNUSED(info))
 {
-    if (m_Image)
+    if ( m_showFrame )
+    {
+        dc.SetBrush(*wxTRANSPARENT_BRUSH);
+        dc.SetPen(*wxBLACK_PEN);
+        dc.DrawRectangle(x + m_PosX, y + m_PosY, m_Width, m_Height);
+        x++, y++;
+    }
+    if ( m_bitmap )
     {
+        // We add in the scaling from the desired bitmap width
+        // and height, so we only do the scaling once.
+        double imageScaleX = 1.0;
+        double imageScaleY = 1.0;
+        if (m_Width != m_bitmap->GetWidth())
+            imageScaleX = (double) m_Width / (double) m_bitmap->GetWidth();
+        if (m_Height != m_bitmap->GetHeight())
+            imageScaleY = (double) m_Height / (double) m_bitmap->GetHeight();
+
         double us_x, us_y;
         dc.GetUserScale(&us_x, &us_y);
-        dc.SetUserScale(us_x * m_Scale, us_y * m_Scale);
+        dc.SetUserScale(us_x * imageScaleX, us_y * imageScaleY);
 
-//      dc.DrawBitmap(*m_Image, x + m_PosX, y + m_PosY, (m_Image->GetMask() != (wxMask*) 0));
-        dc.DrawBitmap(*m_Image, (int) ((x + m_PosX) / m_Scale),
-                                (int) ((y + m_PosY) / m_Scale), TRUE);
+        dc.DrawBitmap(*m_bitmap, (int) ((x + m_PosX) / (imageScaleX)),
+                                 (int) ((y + m_PosY) / (imageScaleY)), true);
         dc.SetUserScale(us_x, us_y);
     }
-    wxHtmlCell::Draw(dc, x, y, view_y1, view_y2);
 }
 
 wxHtmlLinkInfo *wxHtmlImageCell::GetLink( int x, int y ) const
 {
-    if (m_MapName.IsEmpty())
+    if (m_mapName.empty())
         return wxHtmlCell::GetLink( x, y );
-    if (!m_ImageMap)
+    if (!m_imageMap)
     {
         wxHtmlContainerCell *p, *op;
         op = p = GetParent();
@@ -367,19 +633,20 @@ wxHtmlLinkInfo *wxHtmlImageCell::GetLink( int x, int y ) const
             p = p->GetParent();
         }
         p = op;
-        wxHtmlCell *cell = (wxHtmlCell*)p->Find( wxHTML_COND_ISIMAGEMAP, (const void*)(&m_MapName));
+        wxHtmlCell *cell = (wxHtmlCell*)p->Find(wxHTML_COND_ISIMAGEMAP,
+                                                (const void*)(&m_mapName));
         if (!cell)
         {
-            ((wxString&)m_MapName).Clear();
+            ((wxString&)m_mapName).Clear();
             return wxHtmlCell::GetLink( x, y );
         }
         {   // dirty hack, ask Joel why he fills m_ImageMap in this place
             // THE problem is that we're in const method and we can't modify m_ImageMap
-            wxHtmlImageMapCell **cx = (wxHtmlImageMapCell**)(&m_ImageMap);
+            wxHtmlImageMapCell **cx = (wxHtmlImageMapCell**)(&m_imageMap);
             *cx = (wxHtmlImageMapCell*)cell;
         }
     }
-    return m_ImageMap->GetLink( x, y );
+    return m_imageMap->GetLink(x, y);
 }
 
 
@@ -389,6 +656,7 @@ wxHtmlLinkInfo *wxHtmlImageCell::GetLink( int x, int y ) const
 //--------------------------------------------------------------------------------
 
 TAG_HANDLER_BEGIN(IMG, "IMG,MAP,AREA")
+    TAG_HANDLER_CONSTR(IMG) { }
 
     TAG_HANDLER_PROC(tag)
     {
@@ -396,17 +664,36 @@ TAG_HANDLER_BEGIN(IMG, "IMG,MAP,AREA")
         {
             if (tag.HasParam(wxT("SRC")))
             {
-                int w = -1, h = -1;
+                int w = wxDefaultCoord, h = wxDefaultCoord;
+                bool wpercent = false;
+                bool hpresent = false;
                 int al;
                 wxFSFile *str;
                 wxString tmp = tag.GetParam(wxT("SRC"));
                 wxString mn = wxEmptyString;
 
-                str = m_WParser->GetFS()->OpenFile(tmp);
+                str = m_WParser->OpenURL(wxHTML_URL_IMAGE, tmp);
+
                 if (tag.HasParam(wxT("WIDTH")))
-                    tag.GetParamAsInt(wxT("WIDTH"), &w);
+                {
+                    if (tag.GetParamAsIntOrPercent(wxT("WIDTH"), &w, wpercent))
+                    {
+                        if (wpercent)
+                        {
+                            if (w < 0)
+                                w = 0;
+                            else if (w > 100)
+                                w = 100;
+                        }
+                    }
+                }
+
                 if (tag.HasParam(wxT("HEIGHT")))
+                {
                     tag.GetParamAsInt(wxT("HEIGHT"), &h);
+                    hpresent = true;
+                }
+
                 al = wxHTML_ALIGN_BOTTOM;
                 if (tag.HasParam(wxT("ALIGN")))
                 {
@@ -420,19 +707,23 @@ TAG_HANDLER_BEGIN(IMG, "IMG,MAP,AREA")
                 if (tag.HasParam(wxT("USEMAP")))
                 {
                     mn = tag.GetParam( wxT("USEMAP") );
-                    if (mn.GetChar(0) == wxT('#'))
+                    if ( !mn.empty() && *mn.begin() == '#' )
                     {
                         mn = mn.Mid( 1 );
                     }
                 }
-                wxHtmlImageCell *cel = NULL;
+                wxHtmlImageCell *cel = new wxHtmlImageCell(
+                                          m_WParser->GetWindowInterface(),
+                                          str, w, wpercent, h, hpresent,
+                                          m_WParser->GetPixelScale(),
+                                          al, mn);
+                m_WParser->ApplyStateToCell(cel);
+                m_WParser->StopCollapsingSpaces();
+                cel->SetId(tag.GetParam(wxT("id"))); // may be empty
+                cel->SetAlt(tag.GetParam(wxT("alt")));
+                m_WParser->GetContainer()->InsertCell(cel);
                 if (str)
-                {
-                    cel = new wxHtmlImageCell(str, w, h, m_WParser->GetPixelScale(), al, mn);
-                    cel->SetLink(m_WParser->GetLink());
-                    m_WParser->GetContainer()->InsertCell(cel);
                     delete str;
-                }
             }
         }
         if (tag.GetName() == wxT("MAP"))
@@ -475,16 +766,17 @@ TAG_HANDLER_BEGIN(IMG, "IMG,MAP,AREA")
                 }
                 if (cel != NULL && tag.HasParam(wxT("HREF")))
                 {
-                    wxString tmp = tag.GetParam(wxT("HREF"));
-                    wxString target = wxEmptyString;
-                    if (tag.HasParam(wxT("TARGET"))) target = tag.GetParam(wxT("TARGET"));
-                    cel->SetLink( wxHtmlLinkInfo(tmp, target));
+                    wxString target;
+                    if (tag.HasParam(wxT("TARGET")))
+                        target = tag.GetParam(wxT("TARGET"));
+                    cel->SetLink(wxHtmlLinkInfo(tag.GetParam(wxT("HREF")), target));
                 }
-                if (cel != NULL) m_WParser->GetContainer()->InsertCell( cel );
+                if (cel != NULL)
+                    m_WParser->GetContainer()->InsertCell( cel );
             }
         }
 
-        return FALSE;
+        return false;
     }
 
 TAG_HANDLER_END(IMG)