b396bfd6d8798b9b839f8273e441b89ac3510a34
[WebKit-https.git] / Source / WebCore / html / HTMLImageElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2004, 2008, 2010 Apple Inc. All rights reserved.
5  * Copyright (C) 2010 Google Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #pragma once
25
26 #include "DecodingOptions.h"
27 #include "FormNamedItem.h"
28 #include "GraphicsTypes.h"
29 #include "HTMLElement.h"
30 #include "HTMLImageLoader.h"
31
32 namespace WebCore {
33
34 class HTMLFormElement;
35
36 struct ImageCandidate;
37
38 class HTMLImageElement : public HTMLElement, public FormNamedItem {
39     WTF_MAKE_ISO_ALLOCATED(HTMLImageElement);
40     friend class HTMLFormElement;
41 public:
42     static Ref<HTMLImageElement> create(Document&);
43     static Ref<HTMLImageElement> create(const QualifiedName&, Document&, HTMLFormElement*);
44     static Ref<HTMLImageElement> createForJSConstructor(Document&, std::optional<unsigned> width, std::optional<unsigned> height);
45
46     virtual ~HTMLImageElement();
47
48     WEBCORE_EXPORT unsigned width(bool ignorePendingStylesheets = false);
49     WEBCORE_EXPORT unsigned height(bool ignorePendingStylesheets = false);
50
51     WEBCORE_EXPORT int naturalWidth() const;
52     WEBCORE_EXPORT int naturalHeight() const;
53     const AtomicString& currentSrc() const { return m_currentSrc; }
54
55     bool isServerMap() const;
56
57     const AtomicString& altText() const;
58
59     CompositeOperator compositeOperator() const { return m_compositeOperator; }
60
61     CachedImage* cachedImage() const { return m_imageLoader.image(); }
62
63     void setLoadManually(bool loadManually) { m_imageLoader.setLoadManually(loadManually); }
64
65     bool matchesUsemap(const AtomicStringImpl&) const;
66
67     WEBCORE_EXPORT const AtomicString& alt() const;
68
69     WEBCORE_EXPORT void setHeight(unsigned);
70
71     URL src() const;
72     void setSrc(const String&);
73
74     WEBCORE_EXPORT void setCrossOrigin(const AtomicString&);
75     WEBCORE_EXPORT String crossOrigin() const;
76
77     WEBCORE_EXPORT void setWidth(unsigned);
78
79     WEBCORE_EXPORT int x() const;
80     WEBCORE_EXPORT int y() const;
81
82     WEBCORE_EXPORT bool complete() const;
83
84     DecodingMode decodingMode() const;
85     
86     WEBCORE_EXPORT void decode(Ref<DeferredPromise>&&);
87
88 #if PLATFORM(IOS)
89     bool willRespondToMouseClickEvents() override;
90 #endif
91
92     bool hasPendingActivity() const { return m_imageLoader.hasPendingActivity(); }
93
94     bool canContainRangeEndPoint() const override { return false; }
95
96     const AtomicString& imageSourceURL() const override;
97
98     bool hasShadowControls() const { return m_experimentalImageMenuEnabled; }
99     
100     HTMLPictureElement* pictureElement() const;
101     void setPictureElement(HTMLPictureElement*);
102
103 protected:
104     HTMLImageElement(const QualifiedName&, Document&, HTMLFormElement* = 0);
105
106     void didMoveToNewDocument(Document& oldDocument, Document& newDocument) override;
107
108 private:
109     void parseAttribute(const QualifiedName&, const AtomicString&) override;
110     bool isPresentationAttribute(const QualifiedName&) const override;
111     void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) override;
112
113     void didAttachRenderers() override;
114     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
115     void setBestFitURLAndDPRFromImageCandidate(const ImageCandidate&);
116
117     bool canStartSelection() const override;
118
119     bool isURLAttribute(const Attribute&) const override;
120     bool attributeContainsURL(const Attribute&) const override;
121     String completeURLsInAttributeValue(const URL& base, const Attribute&) const override;
122
123     bool draggable() const override;
124
125     void addSubresourceAttributeURLs(ListHashSet<URL>&) const override;
126
127     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
128     void removedFromAncestor(RemovalType, ContainerNode&) override;
129
130     bool isFormAssociatedElement() const final { return false; }
131     FormNamedItem* asFormNamedItem() final { return this; }
132     HTMLImageElement& asHTMLElement() final { return *this; }
133     const HTMLImageElement& asHTMLElement() const final { return *this; }
134
135     void selectImageSource();
136
137     ImageCandidate bestFitSourceFromPictureElement();
138
139     HTMLImageLoader m_imageLoader;
140     HTMLFormElement* m_form;
141     HTMLFormElement* m_formSetByParser;
142
143     CompositeOperator m_compositeOperator;
144     AtomicString m_bestFitImageURL;
145     AtomicString m_currentSrc;
146     AtomicString m_parsedUsemap;
147     float m_imageDevicePixelRatio;
148     bool m_experimentalImageMenuEnabled;
149     bool m_hadNameBeforeAttributeChanged { false }; // FIXME: We only need this because parseAttribute() can't see the old value.
150
151 #if ENABLE(SERVICE_CONTROLS)
152     void updateImageControls();
153     void tryCreateImageControls();
154     void destroyImageControls();
155     bool hasImageControls() const;
156     bool childShouldCreateRenderer(const Node&) const override;
157 #endif
158
159     friend class HTMLPictureElement;
160 };
161
162 } //namespace