Basic child obscuration test for backgrounds
[WebKit-https.git] / Source / WebCore / rendering / RenderImage.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2006 Allan Sandfeld Jensen (kde@carewolf.com) 
5  *           (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
6  * Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010, 2011 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef RenderImage_h
26 #define RenderImage_h
27
28 #include "RenderImageResource.h"
29 #include "RenderReplaced.h"
30
31 namespace WebCore {
32
33 class HTMLAreaElement;
34 class HTMLMapElement;
35
36 class RenderImage : public RenderReplaced {
37 public:
38     RenderImage(Element*);
39     virtual ~RenderImage();
40
41     static RenderImage* createAnonymous(Document*);
42
43     void setImageResource(PassOwnPtr<RenderImageResource>);
44
45     RenderImageResource* imageResource() { return m_imageResource.get(); }
46     const RenderImageResource* imageResource() const { return m_imageResource.get(); }
47     CachedImage* cachedImage() const { return m_imageResource ? m_imageResource->cachedImage() : 0; }
48
49     bool setImageSizeForAltText(CachedImage* newImage = 0);
50
51     void updateAltText();
52
53     HTMLMapElement* imageMap() const;
54     void areaElementFocusChanged(HTMLAreaElement*);
55
56     void highQualityRepaintTimerFired(Timer<RenderImage>*);
57
58     void setIsGeneratedContent(bool generated = true) { m_isGeneratedContent = generated; }
59
60     bool isGeneratedContent() const { return m_isGeneratedContent; }
61
62 protected:
63     virtual bool needsPreferredWidthsRecalculation() const;
64     virtual RenderBox* embeddedContentBox() const;
65     virtual void computeIntrinsicRatioInformation(FloatSize& intrinsicSize, double& intrinsicRatio, bool& isPercentageIntrinsicSize) const;
66
67     virtual void styleDidChange(StyleDifference, const RenderStyle*);
68
69     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0);
70
71     virtual void paintIntoRect(GraphicsContext*, const LayoutRect&);
72     virtual void paint(PaintInfo&, const LayoutPoint&);
73     virtual void layout();
74
75     virtual void intrinsicSizeChanged()
76     {
77         if (m_imageResource)
78             imageChanged(m_imageResource->imagePtr());
79     }
80
81 private:
82     virtual const char* renderName() const { return "RenderImage"; }
83
84     virtual bool isImage() const { return true; }
85     virtual bool isRenderImage() const { return true; }
86
87     virtual void paintReplaced(PaintInfo&, const LayoutPoint&);
88
89     virtual bool backgroundIsObscured() const OVERRIDE;
90
91     virtual LayoutUnit minimumReplacedHeight() const OVERRIDE;
92
93     virtual void notifyFinished(CachedResource*);
94     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;
95
96     virtual bool boxShadowShouldBeAppliedToBackground(BackgroundBleedAvoidance, InlineFlowBox*) const OVERRIDE;
97
98     IntSize imageSizeForError(CachedImage*) const;
99     void imageDimensionsChanged(bool imageSizeChanged, const IntRect* = 0);
100     bool updateIntrinsicSizeIfNeeded(const LayoutSize&, bool imageSizeChanged);
101
102     void paintAreaElementFocusRing(PaintInfo&);
103
104     // Text to display as long as the image isn't available.
105     String m_altText;
106     OwnPtr<RenderImageResource> m_imageResource;
107     bool m_needsToSetSizeForAltText;
108     bool m_didIncrementVisuallyNonEmptyPixelCount;
109     bool m_isGeneratedContent;
110
111     friend class RenderImageScaleObserver;
112 };
113
114 inline RenderImage* toRenderImage(RenderObject* object)
115 {
116     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderImage());
117     return static_cast<RenderImage*>(object);
118 }
119
120 inline const RenderImage* toRenderImage(const RenderObject* object)
121 {
122     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderImage());
123     return static_cast<const RenderImage*>(object);
124 }
125
126 // This will catch anyone doing an unnecessary cast.
127 void toRenderImage(const RenderImage*);
128
129 } // namespace WebCore
130
131 #endif // RenderImage_h