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