62cc38296206e97ec542cc4dd68982a1f06d2c6a
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSModuleLoader.h
1 /*
2  * Copyright (C) 2015 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2016 Yusuke Suzuki <utatane.tea@gmail.com>.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "JSObject.h"
30
31 namespace JSC {
32
33 class JSInternalPromise;
34 class JSModuleNamespaceObject;
35 class SourceCode;
36
37 class JSModuleLoader : public JSNonFinalObject {
38 private:
39     JSModuleLoader(VM&, Structure*);
40 public:
41     typedef JSNonFinalObject Base;
42
43     enum Status {
44         Fetch = 1,
45         Instantiate,
46         Satisfy,
47         Link,
48         Ready,
49     };
50
51     static JSModuleLoader* create(ExecState* exec, VM& vm, JSGlobalObject* globalObject, Structure* structure)
52     {
53         JSModuleLoader* object = new (NotNull, allocateCell<JSModuleLoader>(vm.heap)) JSModuleLoader(vm, structure);
54         object->finishCreation(exec, vm, globalObject);
55         return object;
56     }
57
58     DECLARE_INFO;
59
60     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
61     {
62         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
63     }
64
65     // APIs to control the module loader.
66     JSValue provide(ExecState*, JSValue key, Status, const SourceCode&);
67     JSInternalPromise* loadAndEvaluateModule(ExecState*, JSValue moduleName, JSValue referrer, JSValue initiator);
68     JSInternalPromise* loadModule(ExecState*, JSValue moduleName, JSValue referrer, JSValue initiator);
69     JSValue linkAndEvaluateModule(ExecState*, JSValue moduleKey, JSValue initiator);
70
71     // Platform dependent hooked APIs.
72     JSInternalPromise* importModule(ExecState*, JSString* moduleName, const SourceOrigin& referrer);
73     JSInternalPromise* resolve(ExecState*, JSValue name, JSValue referrer, JSValue initiator);
74     JSInternalPromise* fetch(ExecState*, JSValue key, JSValue initiator);
75     JSInternalPromise* instantiate(ExecState*, JSValue key, JSValue source, JSValue initiator);
76
77     // Additional platform dependent hooked APIs.
78     JSValue evaluate(ExecState*, JSValue key, JSValue moduleRecord, JSValue initiator);
79
80     // Utility functions.
81     JSModuleNamespaceObject* getModuleNamespaceObject(ExecState*, JSValue moduleRecord);
82
83 protected:
84     void finishCreation(ExecState*, VM&, JSGlobalObject*);
85 };
86
87 } // namespace JSC