File: ScriptLoader.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (180 lines) | stat: -rw-r--r-- 6,146 bytes parent folder | download
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/*
 * Copyright (C) 2008 Nikolas Zimmermann <zimmermann@kde.org>
 *
 * 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 ScriptLoader_h
#define ScriptLoader_h

#include "core/CoreExport.h"
#include "core/dom/PendingScript.h"
#include "core/dom/ScriptRunner.h"
#include "core/fetch/FetchRequest.h"
#include "core/fetch/ResourceClient.h"
#include "core/loader/resource/ScriptResource.h"
#include "wtf/text/TextPosition.h"
#include "wtf/text/WTFString.h"

namespace blink {

class Element;
class ScriptLoaderClient;
class ScriptSourceCode;
class LocalFrame;

class CORE_EXPORT ScriptLoader : public GarbageCollectedFinalized<ScriptLoader>,
                                 public PendingScriptClient {
  USING_GARBAGE_COLLECTED_MIXIN(ScriptLoader);

 public:
  static ScriptLoader* create(Element* element,
                              bool createdByParser,
                              bool isEvaluated,
                              bool createdDuringDocumentWrite = false) {
    return new ScriptLoader(element, createdByParser, isEvaluated,
                            createdDuringDocumentWrite);
  }

  ~ScriptLoader() override;
  DECLARE_VIRTUAL_TRACE();

  Element* element() const { return m_element; }

  enum LegacyTypeSupport {
    DisallowLegacyTypeInTypeAttribute,
    AllowLegacyTypeInTypeAttribute
  };
  static bool isValidScriptTypeAndLanguage(
      const String& typeAttributeValue,
      const String& languageAttributeValue,
      LegacyTypeSupport supportLegacyTypes);

  bool prepareScript(
      const TextPosition& scriptStartPosition = TextPosition::minimumPosition(),
      LegacyTypeSupport = DisallowLegacyTypeInTypeAttribute);

  String scriptCharset() const { return m_characterEncoding; }
  String scriptContent() const;
  // Returns false if and only if execution was blocked.
  bool executeScript(const ScriptSourceCode&);
  virtual void execute();

  // XML parser calls these
  void dispatchLoadEvent();
  void dispatchErrorEvent();
  bool isScriptTypeSupported(LegacyTypeSupport) const;

  bool haveFiredLoadEvent() const { return m_haveFiredLoad; }
  bool willBeParserExecuted() const { return m_willBeParserExecuted; }
  bool readyToBeParserExecuted() const { return m_readyToBeParserExecuted; }
  bool willExecuteWhenDocumentFinishedParsing() const {
    return m_willExecuteWhenDocumentFinishedParsing;
  }
  ScriptResource* resource() { return m_resource.get(); }

  void setHaveFiredLoadEvent(bool haveFiredLoad) {
    m_haveFiredLoad = haveFiredLoad;
  }
  bool isParserInserted() const { return m_parserInserted; }
  bool alreadyStarted() const { return m_alreadyStarted; }
  bool forceAsync() const { return m_forceAsync; }

  // Helper functions used by our parent classes.
  void didNotifySubtreeInsertionsToDocument();
  void childrenChanged();
  void handleSourceAttribute(const String& sourceUrl);
  void handleAsyncAttribute();

  virtual bool isReady() const {
    return m_pendingScript && m_pendingScript->isReady();
  }
  bool errorOccurred() const {
    return m_pendingScript && m_pendingScript->errorOccurred();
  }

  // Clears the connection to the PendingScript (and Element and Resource).
  void detach();

  bool wasCreatedDuringDocumentWrite() { return m_createdDuringDocumentWrite; }

  bool disallowedFetchForDocWrittenScript() {
    return m_documentWriteIntervention ==
           DocumentWriteIntervention::DoNotFetchDocWrittenScript;
  }
  void setFetchDocWrittenScriptDeferIdle();

 protected:
  ScriptLoader(Element*,
               bool createdByParser,
               bool isEvaluated,
               bool createdDuringDocumentWrite);

 private:
  bool ignoresLoadRequest() const;
  bool isScriptForEventSupported() const;
  void logScriptMIMEType(LocalFrame*, ScriptResource*, const String&);

  bool fetchScript(const String& sourceUrl, FetchRequest::DeferOption);
  bool doExecuteScript(const ScriptSourceCode&);

  ScriptLoaderClient* client() const;

  // PendingScriptClient
  void pendingScriptFinished(PendingScript*) override;

  Member<Element> m_element;
  Member<ScriptResource> m_resource;
  WTF::OrdinalNumber m_startLineNumber;
  String m_characterEncoding;
  String m_fallbackCharacterEncoding;

  bool m_parserInserted : 1;
  bool m_isExternalScript : 1;
  bool m_alreadyStarted : 1;
  bool m_haveFiredLoad : 1;
  // Same as "The parser will handle executing the script."
  bool m_willBeParserExecuted : 1;
  bool m_readyToBeParserExecuted : 1;
  bool m_willExecuteWhenDocumentFinishedParsing : 1;
  bool m_forceAsync : 1;
  const bool m_createdDuringDocumentWrite : 1;

  ScriptRunner::AsyncExecutionType m_asyncExecType;
  enum DocumentWriteIntervention {
    DocumentWriteInterventionNone = 0,
    // Based on what shouldDisallowFetchForMainFrameScript() returns.
    // This script will be blocked if not present in http cache.
    DoNotFetchDocWrittenScript,
    // If a parser blocking doc.written script was not fetched and was not
    // present in the http cache, send a GET for it with an interventions
    // header to allow the server to know of the intervention. This fetch
    // will be using DeferOption::IdleLoad to keep it out of the critical
    // path.
    FetchDocWrittenScriptDeferIdle,
  };

  DocumentWriteIntervention m_documentWriteIntervention;

  Member<PendingScript> m_pendingScript;
};

ScriptLoader* toScriptLoaderIfPossible(Element*);

}  // namespace blink

#endif  // ScriptLoader_h