summaryrefslogtreecommitdiffstats
path: root/third_party/WebKit/Source/core/layout/LayoutImage.h
blob: c81ed4e2db0dfa6f6496350d2e2563828bcb5cd7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
 *           (C) 2006 Allan Sandfeld Jensen (kde@carewolf.com)
 *           (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
 * Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010, 2011 Apple Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef LayoutImage_h
#define LayoutImage_h

#include "core/CoreExport.h"
#include "core/fetch/ResourceClient.h"
#include "core/layout/LayoutImageResource.h"
#include "core/layout/LayoutReplaced.h"

namespace blink {

class HTMLAreaElement;
class HTMLMapElement;

// LayoutImage is used to display any image type.
//
// There is 2 types of images:
// * normal images, e.g. <image>, <picture>.
// * content images with "content: url(path/to/image.png)".
// We store the type inside  m_isGeneratedContent.
//
// The class is image type agnostic as it only manipulates decoded images.
// See LayoutImageResource that holds this image.
class CORE_EXPORT LayoutImage : public LayoutReplaced, public ResourceClient {
public:
    // These are the paddings to use when displaying either alt text or an image.
    static const unsigned short paddingWidth = 4;
    static const unsigned short paddingHeight = 4;

    LayoutImage(Element*);
    ~LayoutImage() override;

    static LayoutImage* createAnonymous(Document*);

    void setImageResource(PassOwnPtrWillBeRawPtr<LayoutImageResource>);

    LayoutImageResource* imageResource() { return m_imageResource.get(); }
    const LayoutImageResource* imageResource() const { return m_imageResource.get(); }
    ImageResource* cachedImage() const { return m_imageResource ? m_imageResource->cachedImage() : 0; }

    HTMLMapElement* imageMap() const;
    void areaElementFocusChanged(HTMLAreaElement*);

    void setIsGeneratedContent(bool generated = true) { m_isGeneratedContent = generated; }

    bool isGeneratedContent() const { return m_isGeneratedContent; }

    inline void setImageDevicePixelRatio(float factor) { m_imageDevicePixelRatio = factor; }
    float imageDevicePixelRatio() const { return m_imageDevicePixelRatio; }

    void intrinsicSizeChanged() override
    {
        if (m_imageResource)
            imageChanged(m_imageResource->imagePtr());
    }

    const char* name() const override { return "LayoutImage"; }
    String debugName() const final { return LayoutObject::debugName(); }

protected:
    bool needsPreferredWidthsRecalculation() const final;
    LayoutReplaced* embeddedReplacedContent() const final;
    void computeIntrinsicSizingInfo(IntrinsicSizingInfo&) const final;

    void imageChanged(WrappedImagePtr, const IntRect* = nullptr) override;

    void paint(const PaintInfo&, const LayoutPoint&) const final;

    bool isOfType(LayoutObjectType type) const override { return type == LayoutObjectLayoutImage || LayoutReplaced::isOfType(type); }

    void willBeDestroyed() override;

    void styleDidChange(StyleDifference, const ComputedStyle* oldStyle) override;

private:
    bool isImage() const override { return true; }

    void paintReplaced(const PaintInfo&, const LayoutPoint&) const override;

    bool foregroundIsKnownToBeOpaqueInRect(const LayoutRect& localRect, unsigned maxDepthToTest) const final;
    bool computeBackgroundIsKnownToBeObscured() const final;

    bool backgroundShouldAlwaysBeClipped() const override { return true; }

    LayoutUnit minimumReplacedHeight() const override;

    void notifyFinished(Resource*) final;
    bool nodeAtPoint(HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) final;

    bool boxShadowShouldBeAppliedToBackground(BackgroundBleedAvoidance, const InlineFlowBox*) const final;

    void invalidatePaintAndMarkForLayoutIfNeeded();
    void updateIntrinsicSizeIfNeeded(const LayoutSize&);

    // This member wraps the associated decoded image.
    //
    // This field is set using setImageResource above which can be called in
    // several ways:
    // * For normal images, from the network stack (ImageLoader) once we have
    // some image data.
    // * For generated content, the resource is loaded during style resolution
    // and thus is stored in ComputedStyle (see ContentData::image) that gets
    // propagated to the anonymous LayoutImage in LayoutObject::createObject.
    OwnPtrWillBePersistent<LayoutImageResource> m_imageResource;
    bool m_didIncrementVisuallyNonEmptyPixelCount;

    // This field stores whether this image is generated with 'content'.
    bool m_isGeneratedContent;
    float m_imageDevicePixelRatio;
};

DEFINE_LAYOUT_OBJECT_TYPE_CASTS(LayoutImage, isLayoutImage());

} // namespace blink

#endif // LayoutImage_h