don't generate an endless stream of asserts for the 0-sized images
[wxWidgets.git] / src / html / m_image.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: m_image.cpp
3 // Purpose: wxHtml module for displaying images
4 // Author: Vaclav Slavik
5 // RCS-ID: $Id$
6 // Copyright: (c) 1999 Vaclav Slavik, Joel Lucsy
7 // Licence: wxWindows Licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 #ifdef __GNUG__
11 #pragma implementation
12 #endif
13
14 #include "wx/wxprec.h"
15
16 #include "wx/defs.h"
17 #if wxUSE_HTML && wxUSE_STREAMS
18
19 #ifdef __BORDLANDC__
20 #pragma hdrstop
21 #endif
22
23 #ifndef WXPRECOMP
24 #include "wx/dc.h"
25 #include "wx/scrolwin.h"
26 #include "wx/timer.h"
27 #include "wx/dcmemory.h"
28 #endif
29
30 #include "wx/html/forcelnk.h"
31 #include "wx/html/m_templ.h"
32 #include "wx/html/htmlwin.h"
33
34 #include "wx/image.h"
35 #include "wx/gifdecod.h"
36 #include "wx/dynarray.h"
37
38 #include <math.h>
39 #include <float.h>
40
41 FORCE_LINK_ME(m_image)
42
43
44
45
46 WX_DECLARE_OBJARRAY(int, CoordArray);
47 #include "wx/arrimpl.cpp" // this is a magic incantation which must be done!
48 WX_DEFINE_OBJARRAY(CoordArray);
49
50
51 //--------------------------------------------------------------------------------
52 // wxHtmlImageMapAreaCell
53 // 0-width, 0-height cell that represents single area in imagemap
54 // (it's GetLink is called from wxHtmlImageCell's)
55 //--------------------------------------------------------------------------------
56
57 class wxHtmlImageMapAreaCell : public wxHtmlCell
58 {
59 public:
60 enum celltype { CIRCLE, RECT, POLY };
61 protected:
62 CoordArray coords;
63 celltype type;
64 int radius;
65 public:
66 wxHtmlImageMapAreaCell( celltype t, wxString &coords, double pixel_scale = 1.0);
67 virtual wxHtmlLinkInfo *GetLink( int x = 0, int y = 0 ) const;
68 };
69
70
71
72
73
74 wxHtmlImageMapAreaCell::wxHtmlImageMapAreaCell( wxHtmlImageMapAreaCell::celltype t, wxString &incoords, double pixel_scale )
75 {
76 int i;
77 wxString x = incoords, y;
78
79 type = t;
80 while ((i = x.Find( ',' )) != -1)
81 {
82 coords.Add( (int)(pixel_scale * (double)wxAtoi( x.Left( i ).c_str())) );
83 x = x.Mid( i + 1 );
84 }
85 coords.Add( (int)(pixel_scale * (double)wxAtoi( x.c_str())) );
86 }
87
88 wxHtmlLinkInfo *wxHtmlImageMapAreaCell::GetLink( int x, int y ) const
89 {
90 switch (type)
91 {
92 case RECT:
93 {
94 int l, t, r, b;
95
96 l = coords[ 0 ];
97 t = coords[ 1 ];
98 r = coords[ 2 ];
99 b = coords[ 3 ];
100 if (x >= l && x <= r && y >= t && y <= b)
101 {
102 return m_Link;
103 }
104 break;
105 }
106 case CIRCLE:
107 {
108 int l, t, r;
109 double d;
110
111 l = coords[ 0 ];
112 t = coords[ 1 ];
113 r = coords[ 2 ];
114 d = sqrt( (double) (((x - l) * (x - l)) + ((y - t) * (y - t))) );
115 if (d < (double)r)
116 {
117 return m_Link;
118 }
119 }
120 break;
121 case POLY:
122 {
123 if (coords.GetCount() >= 6)
124 {
125 int intersects = 0;
126 int wherex = x;
127 int wherey = y;
128 int totalv = coords.GetCount() / 2;
129 int totalc = totalv * 2;
130 int xval = coords[totalc - 2];
131 int yval = coords[totalc - 1];
132 int end = totalc;
133 int pointer = 1;
134
135 if ((yval >= wherey) != (coords[pointer] >= wherey))
136 {
137 if ((xval >= wherex) == (coords[0] >= wherex))
138 {
139 intersects += (xval >= wherex) ? 1 : 0;
140 }
141 else
142 {
143 intersects += ((xval - (yval - wherey) *
144 (coords[0] - xval) /
145 (coords[pointer] - yval)) >= wherex) ? 1 : 0;
146 }
147 }
148
149 while (pointer < end)
150 {
151 yval = coords[pointer];
152 pointer += 2;
153 if (yval >= wherey)
154 {
155 while ((pointer < end) && (coords[pointer] >= wherey))
156 {
157 pointer += 2;
158 }
159 if (pointer >= end)
160 {
161 break;
162 }
163 if ((coords[pointer - 3] >= wherex) ==
164 (coords[pointer - 1] >= wherex)) {
165 intersects += (coords[pointer - 3] >= wherex) ? 1 : 0;
166 }
167 else
168 {
169 intersects +=
170 ((coords[pointer - 3] - (coords[pointer - 2] - wherey) *
171 (coords[pointer - 1] - coords[pointer - 3]) /
172 (coords[pointer] - coords[pointer - 2])) >= wherex) ? 1 : 0;
173 }
174 }
175 else
176 {
177 while ((pointer < end) && (coords[pointer] < wherey))
178 {
179 pointer += 2;
180 }
181 if (pointer >= end)
182 {
183 break;
184 }
185 if ((coords[pointer - 3] >= wherex) ==
186 (coords[pointer - 1] >= wherex))
187 {
188 intersects += (coords[pointer - 3] >= wherex) ? 1 : 0;
189 }
190 else
191 {
192 intersects +=
193 ((coords[pointer - 3] - (coords[pointer - 2] - wherey) *
194 (coords[pointer - 1] - coords[pointer - 3]) /
195 (coords[pointer] - coords[pointer - 2])) >= wherex) ? 1 : 0;
196 }
197 }
198 }
199 if ((intersects & 1) != 0)
200 {
201 return m_Link;
202 }
203 }
204 }
205 break;
206 }
207
208 if (m_Next)
209 {
210 wxHtmlImageMapAreaCell *a = (wxHtmlImageMapAreaCell*)m_Next;
211 return a->GetLink( x, y );
212 }
213 return NULL;
214 }
215
216
217
218
219
220
221
222
223 //--------------------------------------------------------------------------------
224 // wxHtmlImageMapCell
225 // 0-width, 0-height cell that represents map from imagemaps
226 // it is always placed before wxHtmlImageMapAreaCells
227 // It responds to Find(wxHTML_COND_ISIMAGEMAP)
228 //--------------------------------------------------------------------------------
229
230
231 class wxHtmlImageMapCell : public wxHtmlCell
232 {
233 public:
234 wxHtmlImageMapCell( wxString &name );
235 protected:
236 wxString m_Name;
237 public:
238 virtual wxHtmlLinkInfo *GetLink( int x = 0, int y = 0 ) const;
239 virtual const wxHtmlCell *Find( int cond, const void *param ) const;
240 };
241
242
243 wxHtmlImageMapCell::wxHtmlImageMapCell( wxString &name )
244 {
245 m_Name = name ;
246 }
247
248 wxHtmlLinkInfo *wxHtmlImageMapCell::GetLink( int x, int y ) const
249 {
250 wxHtmlImageMapAreaCell *a = (wxHtmlImageMapAreaCell*)m_Next;
251 if (a)
252 return a->GetLink( x, y );
253 return wxHtmlCell::GetLink( x, y );
254 }
255
256 const wxHtmlCell *wxHtmlImageMapCell::Find( int cond, const void *param ) const
257 {
258 if (cond == wxHTML_COND_ISIMAGEMAP)
259 {
260 if (m_Name == *((wxString*)(param)))
261 return this;
262 }
263 return wxHtmlCell::Find(cond, param);
264 }
265
266
267
268
269
270 //--------------------------------------------------------------------------------
271 // wxHtmlImageCell
272 // Image/bitmap
273 //--------------------------------------------------------------------------------
274
275 class wxHtmlImageCell : public wxHtmlCell
276 {
277 public:
278 wxHtmlImageCell(wxWindow *window,
279 wxFSFile *input, int w = -1, int h = -1,
280 double scale = 1.0, int align = wxHTML_ALIGN_BOTTOM,
281 const wxString& mapname = wxEmptyString);
282 ~wxHtmlImageCell();
283 void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
284 virtual wxHtmlLinkInfo *GetLink(int x = 0, int y = 0) const;
285
286 void SetImage(const wxImage& img);
287 #if wxUSE_GIF && wxUSE_TIMER
288 void AdvanceAnimation(wxTimer *timer);
289 virtual void Layout(int w);
290 #endif
291
292 private:
293 wxBitmap *m_bitmap;
294 int m_bmpW, m_bmpH;
295 bool m_showFrame:1;
296 wxScrolledWindow *m_window;
297 #if wxUSE_GIF && wxUSE_TIMER
298 wxGIFDecoder *m_gifDecoder;
299 wxTimer *m_gifTimer;
300 int m_physX, m_physY;
301 #endif
302 double m_scale;
303 wxHtmlImageMapCell *m_imageMap;
304 wxString m_mapName;
305 };
306
307 #if wxUSE_GIF && wxUSE_TIMER
308 class wxGIFTimer : public wxTimer
309 {
310 public:
311 wxGIFTimer(wxHtmlImageCell *cell) : m_cell(cell) {}
312 virtual void Notify()
313 {
314 m_cell->AdvanceAnimation(this);
315 }
316
317 private:
318 wxHtmlImageCell *m_cell;
319 };
320 #endif
321
322
323 //--------------------------------------------------------------------------------
324 // wxHtmlImageCell
325 //--------------------------------------------------------------------------------
326
327 /* XPM */
328 static const char * broken_image_xpm[] = {
329 "29 31 7 1",
330 " c None",
331 ". c #808080",
332 "+ c #FFFFFF",
333 "@ c #C0C0C0",
334 "# c #000000",
335 "$ c #333366",
336 "% c #B2B2B2",
337 "..................... ",
338 ".+++++++++++++++++++.. ",
339 ".+++++++++++++++++++.@. ",
340 ".++@@@@@@@@@@@@@@@@@.+@. ",
341 ".++@@@@@@@@@@@@@@@@@.++@. ",
342 ".++@@@@@.@@@@.@@@@@@.+++@. ",
343 ".++@@@@@@@@@@@@@@@@@.++++@. ",
344 ".++@@@@@@@@@@@@@@@@@.+++++@. ",
345 ".++@@.@@@@@@@@@@.@@@######## ",
346 ".++@@@@@@@@@@@@@@@@@@$$$$$$#.",
347 ".######@@@@@@@@@@@@@@@.....#.",
348 " ###@@@@@@@@@@@@@@@++#.",
349 " #####@@@@@@@@@@++#.",
350 " #@.@@@@@@@@++#.",
351 ".. ###@@@@@@@++#.",
352 ".+.... #@@@@@@++#.",
353 ".++@@@... ####@@++#.",
354 ".++@@@@@@.. #####.",
355 ".++@@@@@@@@... ",
356 ".++@@@@@@%%%%@. ",
357 ".++@@@@@@%%%%@@.... ",
358 ".++@@@@@@%%%%@@@@@@.... ",
359 ".++@@@@@@%%%%@@@@@@@@@@.... ",
360 ".++@@@@@@@@@@@@@@@@@@@@@@++#.",
361 ".++@@@@@@@@@@@@@@@@@@@@@@++#.",
362 ".++@@@@@@@@@@@@@@@@@@@@@@++#.",
363 ".++@@@@@@@@@@@@@@@@@@@@@@++#.",
364 ".++@@@@@@@@@@@@@@@@@@@@@@++#.",
365 ".++++++++++++++++++++++++++#.",
366 ".++++++++++++++++++++++++++#.",
367 "############################."};
368
369 wxHtmlImageCell::wxHtmlImageCell(wxWindow *window, wxFSFile *input,
370 int w, int h, double scale, int align,
371 const wxString& mapname) : wxHtmlCell()
372 {
373 m_window = window ? wxStaticCast(window, wxScrolledWindow) : NULL;
374 m_scale = scale;
375 m_showFrame = FALSE;
376 m_bitmap = NULL;
377 m_bmpW = w;
378 m_bmpH = h;
379 m_imageMap = NULL;
380 m_mapName = mapname;
381 SetCanLiveOnPagebreak(FALSE);
382 #if wxUSE_GIF && wxUSE_TIMER
383 m_gifDecoder = NULL;
384 m_gifTimer = NULL;
385 m_physX = m_physY = -1;
386 #endif
387
388 if ( m_bmpW && m_bmpH )
389 {
390 if ( input )
391 {
392 wxInputStream *s = input->GetStream();
393
394 if ( s )
395 {
396 bool readImg = TRUE;
397
398 #if wxUSE_GIF && wxUSE_TIMER
399 if ( (input->GetLocation().Matches(wxT("*.gif")) ||
400 input->GetLocation().Matches(wxT("*.GIF"))) && m_window )
401 {
402 m_gifDecoder = new wxGIFDecoder(s, TRUE);
403 if ( m_gifDecoder->ReadGIF() == wxGIF_OK )
404 {
405 wxImage img;
406 if ( m_gifDecoder->ConvertToImage(&img) )
407 SetImage(img);
408
409 readImg = FALSE;
410
411 if ( m_gifDecoder->IsAnimation() )
412 {
413 m_gifTimer = new wxGIFTimer(this);
414 m_gifTimer->Start(m_gifDecoder->GetDelay(), TRUE);
415 }
416 else
417 {
418 wxDELETE(m_gifDecoder);
419 }
420 }
421 else
422 {
423 wxDELETE(m_gifDecoder);
424 }
425 }
426
427 if ( readImg )
428 #endif // wxUSE_GIF && wxUSE_TIMER
429 {
430 wxImage image(*s, wxBITMAP_TYPE_ANY);
431 if ( image.Ok() )
432 SetImage(image);
433 }
434 }
435 }
436 else // input==NULL, use "broken image" bitmap
437 {
438 if ( m_bmpW == -1 && m_bmpH == -1 )
439 {
440 m_bmpW = 29;
441 m_bmpH = 31;
442 }
443 else
444 {
445 m_showFrame = TRUE;
446 if ( m_bmpW == -1 ) m_bmpW = 31;
447 if ( m_bmpH == -1 ) m_bmpH = 33;
448 }
449 m_bitmap = new wxBitmap(broken_image_xpm);
450 }
451 }
452 //else: ignore the 0-sized images used sometimes on the Web pages
453
454 m_Width = (int)(scale * (double)m_bmpW);
455 m_Height = (int)(scale * (double)m_bmpH);
456
457 switch (align)
458 {
459 case wxHTML_ALIGN_TOP :
460 m_Descent = m_Height;
461 break;
462 case wxHTML_ALIGN_CENTER :
463 m_Descent = m_Height / 2;
464 break;
465 case wxHTML_ALIGN_BOTTOM :
466 default :
467 m_Descent = 0;
468 break;
469 }
470 }
471
472 void wxHtmlImageCell::SetImage(const wxImage& img)
473 {
474 if ( img.Ok() )
475 {
476 delete m_bitmap;
477
478 int ww, hh;
479 ww = img.GetWidth();
480 hh = img.GetHeight();
481
482 if ( m_bmpW == -1 )
483 m_bmpW = ww;
484 if ( m_bmpH == -1 )
485 m_bmpH = hh;
486
487 if ((m_bmpW != ww) || (m_bmpH != hh))
488 {
489 wxImage img2 = img.Scale(m_bmpW, m_bmpH);
490 m_bitmap = new wxBitmap(img2);
491 }
492 else
493 m_bitmap = new wxBitmap(img);
494 }
495 }
496
497 #if wxUSE_GIF && wxUSE_TIMER
498 void wxHtmlImageCell::AdvanceAnimation(wxTimer *timer)
499 {
500 wxImage img;
501
502 m_gifDecoder->GoNextFrame(TRUE);
503
504 if ( m_physX == -1 )
505 {
506 m_physX = m_physY = 0;
507 for (wxHtmlCell *cell = this; cell; cell = cell->GetParent())
508 {
509 m_physX += cell->GetPosX();
510 m_physY += cell->GetPosY();
511 }
512 }
513
514 int x, y;
515 m_window->CalcScrolledPosition(m_physX, m_physY, &x, &y);
516 wxRect rect(x, y, m_Width, m_Height);
517
518 if ( m_window->GetClientRect().Intersects(rect) &&
519 m_gifDecoder->ConvertToImage(&img) )
520 {
521 if ( (int)m_gifDecoder->GetWidth() != m_Width ||
522 (int)m_gifDecoder->GetHeight() != m_Height ||
523 m_gifDecoder->GetLeft() != 0 || m_gifDecoder->GetTop() != 0 )
524 {
525 wxBitmap bmp(img);
526 wxMemoryDC dc;
527 dc.SelectObject(*m_bitmap);
528 dc.DrawBitmap(bmp, m_gifDecoder->GetLeft(), m_gifDecoder->GetTop());
529 }
530 else
531 SetImage(img);
532 m_window->Refresh(img.HasMask(), &rect);
533 }
534
535 timer->Start(m_gifDecoder->GetDelay(), TRUE);
536 }
537
538 void wxHtmlImageCell::Layout(int w)
539 {
540 wxHtmlCell::Layout(w);
541 m_physX = m_physY = -1;
542 }
543
544 #endif
545
546 wxHtmlImageCell::~wxHtmlImageCell()
547 {
548 delete m_bitmap;
549 #if wxUSE_GIF && wxUSE_TIMER
550 delete m_gifTimer;
551 delete m_gifDecoder;
552 #endif
553 }
554
555
556 void wxHtmlImageCell::Draw(wxDC& dc, int x, int y, int WXUNUSED(view_y1), int WXUNUSED(view_y2))
557 {
558 if ( m_showFrame )
559 {
560 dc.SetBrush(*wxTRANSPARENT_BRUSH);
561 dc.SetPen(*wxBLACK_PEN);
562 dc.DrawRectangle(x + m_PosX, y + m_PosY, m_Width, m_Height);
563 x++, y++;
564 }
565 if ( m_bitmap )
566 {
567 double us_x, us_y;
568 dc.GetUserScale(&us_x, &us_y);
569 dc.SetUserScale(us_x * m_scale, us_y * m_scale);
570
571 dc.DrawBitmap(*m_bitmap, (int) ((x + m_PosX) / m_scale),
572 (int) ((y + m_PosY) / m_scale), TRUE);
573 dc.SetUserScale(us_x, us_y);
574 }
575 }
576
577 wxHtmlLinkInfo *wxHtmlImageCell::GetLink( int x, int y ) const
578 {
579 if (m_mapName.IsEmpty())
580 return wxHtmlCell::GetLink( x, y );
581 if (!m_imageMap)
582 {
583 wxHtmlContainerCell *p, *op;
584 op = p = GetParent();
585 while (p)
586 {
587 op = p;
588 p = p->GetParent();
589 }
590 p = op;
591 wxHtmlCell *cell = (wxHtmlCell*)p->Find(wxHTML_COND_ISIMAGEMAP,
592 (const void*)(&m_mapName));
593 if (!cell)
594 {
595 ((wxString&)m_mapName).Clear();
596 return wxHtmlCell::GetLink( x, y );
597 }
598 { // dirty hack, ask Joel why he fills m_ImageMap in this place
599 // THE problem is that we're in const method and we can't modify m_ImageMap
600 wxHtmlImageMapCell **cx = (wxHtmlImageMapCell**)(&m_imageMap);
601 *cx = (wxHtmlImageMapCell*)cell;
602 }
603 }
604 return m_imageMap->GetLink(x, y);
605 }
606
607
608
609 //--------------------------------------------------------------------------------
610 // tag handler
611 //--------------------------------------------------------------------------------
612
613 TAG_HANDLER_BEGIN(IMG, "IMG,MAP,AREA")
614
615 TAG_HANDLER_PROC(tag)
616 {
617 if (tag.GetName() == wxT("IMG"))
618 {
619 if (tag.HasParam(wxT("SRC")))
620 {
621 int w = -1, h = -1;
622 int al;
623 wxFSFile *str;
624 wxString tmp = tag.GetParam(wxT("SRC"));
625 wxString mn = wxEmptyString;
626
627 str = m_WParser->OpenURL(wxHTML_URL_IMAGE, tmp);
628
629 if (tag.HasParam(wxT("WIDTH")))
630 tag.GetParamAsInt(wxT("WIDTH"), &w);
631 if (tag.HasParam(wxT("HEIGHT")))
632 tag.GetParamAsInt(wxT("HEIGHT"), &h);
633 al = wxHTML_ALIGN_BOTTOM;
634 if (tag.HasParam(wxT("ALIGN")))
635 {
636 wxString alstr = tag.GetParam(wxT("ALIGN"));
637 alstr.MakeUpper(); // for the case alignment was in ".."
638 if (alstr == wxT("TEXTTOP"))
639 al = wxHTML_ALIGN_TOP;
640 else if ((alstr == wxT("CENTER")) || (alstr == wxT("ABSCENTER")))
641 al = wxHTML_ALIGN_CENTER;
642 }
643 if (tag.HasParam(wxT("USEMAP")))
644 {
645 mn = tag.GetParam( wxT("USEMAP") );
646 if (mn.GetChar(0) == wxT('#'))
647 {
648 mn = mn.Mid( 1 );
649 }
650 }
651 wxHtmlImageCell *cel = new wxHtmlImageCell(
652 m_WParser->GetWindow(),
653 str, w, h,
654 m_WParser->GetPixelScale(),
655 al, mn);
656 cel->SetLink(m_WParser->GetLink());
657 cel->SetId(tag.GetParam(wxT("id"))); // may be empty
658 m_WParser->GetContainer()->InsertCell(cel);
659 if (str)
660 delete str;
661 }
662 }
663 if (tag.GetName() == wxT("MAP"))
664 {
665 m_WParser->CloseContainer();
666 m_WParser->OpenContainer();
667 if (tag.HasParam(wxT("NAME")))
668 {
669 wxString tmp = tag.GetParam(wxT("NAME"));
670 wxHtmlImageMapCell *cel = new wxHtmlImageMapCell( tmp );
671 m_WParser->GetContainer()->InsertCell( cel );
672 }
673 ParseInner( tag );
674 m_WParser->CloseContainer();
675 m_WParser->OpenContainer();
676 }
677 if (tag.GetName() == wxT("AREA"))
678 {
679 if (tag.HasParam(wxT("SHAPE")))
680 {
681 wxString tmp = tag.GetParam(wxT("SHAPE"));
682 wxString coords = wxEmptyString;
683 tmp.MakeUpper();
684 wxHtmlImageMapAreaCell *cel = NULL;
685 if (tag.HasParam(wxT("COORDS")))
686 {
687 coords = tag.GetParam(wxT("COORDS"));
688 }
689 if (tmp == wxT("POLY"))
690 {
691 cel = new wxHtmlImageMapAreaCell( wxHtmlImageMapAreaCell::POLY, coords, m_WParser->GetPixelScale() );
692 }
693 else if (tmp == wxT("CIRCLE"))
694 {
695 cel = new wxHtmlImageMapAreaCell( wxHtmlImageMapAreaCell::CIRCLE, coords, m_WParser->GetPixelScale() );
696 }
697 else if (tmp == wxT("RECT"))
698 {
699 cel = new wxHtmlImageMapAreaCell( wxHtmlImageMapAreaCell::RECT, coords, m_WParser->GetPixelScale() );
700 }
701 if (cel != NULL && tag.HasParam(wxT("HREF")))
702 {
703 wxString tmp = tag.GetParam(wxT("HREF"));
704 wxString target = wxEmptyString;
705 if (tag.HasParam(wxT("TARGET"))) target = tag.GetParam(wxT("TARGET"));
706 cel->SetLink( wxHtmlLinkInfo(tmp, target));
707 }
708 if (cel != NULL) m_WParser->GetContainer()->InsertCell( cel );
709 }
710 }
711
712 return FALSE;
713 }
714
715 TAG_HANDLER_END(IMG)
716
717
718
719 TAGS_MODULE_BEGIN(Image)
720
721 TAGS_MODULE_ADD(IMG)
722
723 TAGS_MODULE_END(Image)
724
725
726 #endif