4fed24ce775d8db34feb4403cf9c186fd2943162
[WebKit-https.git] / Source / WebCore / dom / ScriptElement.h
1 /*
2  * Copyright (C) 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2009-2017 Apple Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #pragma once
23
24 #include "ContainerNode.h"
25 #include "LoadableScript.h"
26 #include "ReferrerPolicy.h"
27 #include "UserGestureIndicator.h"
28 #include <wtf/MonotonicTime.h>
29 #include <wtf/text/TextPosition.h>
30
31 namespace WebCore {
32
33 class CachedScript;
34 class ContainerNode;
35 class Element;
36 class LoadableModuleScript;
37 class PendingScript;
38 class ScriptSourceCode;
39
40 class ScriptElement {
41 public:
42     virtual ~ScriptElement() = default;
43
44     Element& element() { return m_element; }
45     const Element& element() const { return m_element; }
46
47     enum LegacyTypeSupport { DisallowLegacyTypeInTypeAttribute, AllowLegacyTypeInTypeAttribute };
48     bool prepareScript(const TextPosition& scriptStartPosition = TextPosition(), LegacyTypeSupport = DisallowLegacyTypeInTypeAttribute);
49
50     String scriptCharset() const { return m_characterEncoding; }
51     WEBCORE_EXPORT String scriptContent() const;
52     void executeClassicScript(const ScriptSourceCode&);
53     void executeModuleScript(LoadableModuleScript&);
54
55     void executePendingScript(PendingScript&);
56
57     // XML parser calls these
58     virtual void dispatchLoadEvent() = 0;
59     void dispatchErrorEvent();
60
61     bool haveFiredLoadEvent() const { return m_haveFiredLoad; }
62     bool willBeParserExecuted() const { return m_willBeParserExecuted; }
63     bool readyToBeParserExecuted() const { return m_readyToBeParserExecuted; }
64     bool willExecuteWhenDocumentFinishedParsing() const { return m_willExecuteWhenDocumentFinishedParsing; }
65     bool willExecuteInOrder() const { return m_willExecuteInOrder; }
66     LoadableScript* loadableScript() { return m_loadableScript.get(); }
67
68     // https://html.spec.whatwg.org/multipage/scripting.html#concept-script-type
69     enum class ScriptType { Classic, Module };
70     ScriptType scriptType() const { return m_isModuleScript ? ScriptType::Module : ScriptType::Classic; }
71
72     void ref();
73     void deref();
74
75 protected:
76     ScriptElement(Element&, bool createdByParser, bool isEvaluated);
77
78     void setHaveFiredLoadEvent(bool haveFiredLoad) { m_haveFiredLoad = haveFiredLoad; }
79     bool isParserInserted() const { return m_parserInserted; }
80     bool alreadyStarted() const { return m_alreadyStarted; }
81     bool forceAsync() const { return m_forceAsync; }
82
83     // Helper functions used by our parent classes.
84     Node::InsertedIntoAncestorResult insertedIntoAncestor(Node::InsertionType insertionType, ContainerNode&) const
85     {
86         if (insertionType.connectedToDocument && !m_parserInserted)
87             return Node::InsertedIntoAncestorResult::NeedsPostInsertionCallback;
88         return Node::InsertedIntoAncestorResult::Done;
89     }
90
91     void didFinishInsertingNode();
92     void childrenChanged(const ContainerNode::ChildChange&);
93     void handleSourceAttribute(const String& sourceURL);
94     void handleAsyncAttribute();
95
96 private:
97     void executeScriptAndDispatchEvent(LoadableScript&);
98
99     Optional<ScriptType> determineScriptType(LegacyTypeSupport) const;
100     bool ignoresLoadRequest() const;
101     bool isScriptForEventSupported() const;
102     void dispatchLoadEventRespectingUserGestureIndicator();
103
104     bool requestClassicScript(const String& sourceURL);
105     bool requestModuleScript(const TextPosition& scriptStartPosition);
106
107     virtual String sourceAttributeValue() const = 0;
108     virtual String charsetAttributeValue() const = 0;
109     virtual String typeAttributeValue() const = 0;
110     virtual String languageAttributeValue() const = 0;
111     virtual String forAttributeValue() const = 0;
112     virtual String eventAttributeValue() const = 0;
113     virtual bool hasAsyncAttribute() const = 0;
114     virtual bool hasDeferAttribute() const = 0;
115     virtual bool hasSourceAttribute() const = 0;
116     virtual bool hasNoModuleAttribute() const = 0;
117     virtual ReferrerPolicy referrerPolicy() const = 0;
118
119     Element& m_element;
120     WTF::OrdinalNumber m_startLineNumber;
121     bool m_parserInserted : 1;
122     bool m_isExternalScript : 1;
123     bool m_alreadyStarted : 1;
124     bool m_haveFiredLoad : 1;
125     bool m_willBeParserExecuted : 1; // Same as "The parser will handle executing the script."
126     bool m_readyToBeParserExecuted : 1;
127     bool m_willExecuteWhenDocumentFinishedParsing : 1;
128     bool m_forceAsync : 1;
129     bool m_willExecuteInOrder : 1;
130     bool m_isModuleScript : 1;
131     String m_characterEncoding;
132     String m_fallbackCharacterEncoding;
133     RefPtr<LoadableScript> m_loadableScript;
134
135     MonotonicTime m_creationTime;
136     RefPtr<UserGestureToken> m_userGestureToken;
137 };
138
139 // FIXME: replace with is/downcast<ScriptElement>.
140 bool isScriptElement(Element&);
141 ScriptElement& downcastScriptElement(Element&);
142
143 }