WebAssembly: perform stack checks
[WebKit-https.git] / Source / JavaScriptCore / runtime / Error.h
1 /*
2  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Library General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Library General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Library General Public License
17  *  along with this library; see the file COPYING.LIB.  If not, write to
18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #pragma once
24
25 #include "ErrorInstance.h"
26 #include "InternalFunction.h"
27 #include "JSObject.h"
28 #include "ThrowScope.h"
29 #include <stdint.h>
30
31
32 namespace JSC {
33
34 class ExecState;
35 class VM;
36 class JSGlobalObject;
37 class JSObject;
38 class SourceCode;
39 class Structure;
40
41 enum class ErrorType : uint8_t {
42     Error,
43     EvalError,
44     RangeError,
45     ReferenceError,
46     SyntaxError,
47     TypeError,
48     URIError,
49 };
50
51 // ExecState wrappers.
52 JSObject* createError(ExecState*, const String&, ErrorInstance::SourceAppender);
53 JSObject* createEvalError(ExecState*, const String&, ErrorInstance::SourceAppender);
54 JSObject* createRangeError(ExecState*, const String&, ErrorInstance::SourceAppender);
55 JSObject* createRangeError(ExecState*, JSGlobalObject*, const String&, ErrorInstance::SourceAppender);
56 JSObject* createReferenceError(ExecState*, const String&, ErrorInstance::SourceAppender);
57 JSObject* createSyntaxError(ExecState*, const String&, ErrorInstance::SourceAppender);
58 JSObject* createTypeError(ExecState*, const String&, ErrorInstance::SourceAppender, RuntimeType);
59 JSObject* createNotEnoughArgumentsError(ExecState*, ErrorInstance::SourceAppender);
60 JSObject* createURIError(ExecState*, const String&, ErrorInstance::SourceAppender);
61
62
63 JS_EXPORT_PRIVATE JSObject* createError(ExecState*, const String&);
64 JS_EXPORT_PRIVATE JSObject* createEvalError(ExecState*, const String&);
65 JS_EXPORT_PRIVATE JSObject* createRangeError(ExecState*, const String&);
66 JS_EXPORT_PRIVATE JSObject* createRangeError(ExecState*, JSGlobalObject*, const String&);
67 JS_EXPORT_PRIVATE JSObject* createReferenceError(ExecState*, const String&);
68 JS_EXPORT_PRIVATE JSObject* createSyntaxError(ExecState*, const String&);
69 JS_EXPORT_PRIVATE JSObject* createTypeError(ExecState*);
70 JS_EXPORT_PRIVATE JSObject* createTypeError(ExecState*, const String&);
71 JS_EXPORT_PRIVATE JSObject* createNotEnoughArgumentsError(ExecState*);
72 JS_EXPORT_PRIVATE JSObject* createURIError(ExecState*, const String&);
73 JS_EXPORT_PRIVATE JSObject* createOutOfMemoryError(ExecState*);
74
75 JS_EXPORT_PRIVATE JSObject* createError(ExecState*, ErrorType, const String&);
76
77
78 bool addErrorInfoAndGetBytecodeOffset(ExecState*, VM&, JSObject*, bool, CallFrame*&, unsigned* = nullptr);
79
80 JS_EXPORT_PRIVATE void addErrorInfo(ExecState*, JSObject*, bool); 
81 JSObject* addErrorInfo(ExecState*, JSObject* error, int line, const SourceCode&);
82
83 // Methods to throw Errors.
84
85 // Convenience wrappers, create an throw an exception with a default message.
86 JS_EXPORT_PRIVATE JSObject* throwConstructorCannotBeCalledAsFunctionTypeError(ExecState*, ThrowScope&, const char* constructorName);
87 JS_EXPORT_PRIVATE JSObject* throwTypeError(ExecState*, ThrowScope&);
88 JS_EXPORT_PRIVATE JSObject* throwTypeError(ExecState*, ThrowScope&, ASCIILiteral errorMessage);
89 JS_EXPORT_PRIVATE JSObject* throwTypeError(ExecState*, ThrowScope&, const String& errorMessage);
90 JS_EXPORT_PRIVATE JSObject* throwSyntaxError(ExecState*, ThrowScope&);
91 JS_EXPORT_PRIVATE JSObject* throwSyntaxError(ExecState*, ThrowScope&, const String& errorMessage);
92 inline JSObject* throwRangeError(ExecState* state, ThrowScope& scope, const String& errorMessage) { return throwException(state, scope, createRangeError(state, errorMessage)); }
93
94 // Convenience wrappers, wrap result as an EncodedJSValue.
95 inline void throwVMError(ExecState* exec, ThrowScope& scope, Exception* exception) { throwException(exec, scope, exception); }
96 inline EncodedJSValue throwVMError(ExecState* exec, ThrowScope& scope, JSValue error) { return JSValue::encode(throwException(exec, scope, error)); }
97 inline EncodedJSValue throwVMError(ExecState* exec, ThrowScope& scope, const char* errorMessage) { return JSValue::encode(throwException(exec, scope, createError(exec, ASCIILiteral(errorMessage)))); }
98 inline EncodedJSValue throwVMTypeError(ExecState* exec, ThrowScope& scope) { return JSValue::encode(throwTypeError(exec, scope)); }
99 inline EncodedJSValue throwVMTypeError(ExecState* exec, ThrowScope& scope, ASCIILiteral errorMessage) { return JSValue::encode(throwTypeError(exec, scope, errorMessage)); }
100 inline EncodedJSValue throwVMTypeError(ExecState* exec, ThrowScope& scope, const String& errorMessage) { return JSValue::encode(throwTypeError(exec, scope, errorMessage)); }
101 inline EncodedJSValue throwVMRangeError(ExecState* state, ThrowScope& scope, const String& errorMessage) { return JSValue::encode(throwRangeError(state, scope, errorMessage)); }
102
103 class StrictModeTypeErrorFunction : public InternalFunction {
104 private:
105     StrictModeTypeErrorFunction(VM& vm, Structure* structure, const String& message)
106         : InternalFunction(vm, structure)
107         , m_message(message)
108     {
109     }
110
111     static void destroy(JSCell*);
112
113 public:
114     typedef InternalFunction Base;
115
116     static StrictModeTypeErrorFunction* create(VM& vm, Structure* structure, const String& message)
117     {
118         StrictModeTypeErrorFunction* function = new (NotNull, allocateCell<StrictModeTypeErrorFunction>(vm.heap)) StrictModeTypeErrorFunction(vm, structure, message);
119         function->finishCreation(vm, String());
120         return function;
121     }
122
123     static EncodedJSValue JSC_HOST_CALL constructThrowTypeError(ExecState* exec)
124     {
125         VM& vm = exec->vm();
126         auto scope = DECLARE_THROW_SCOPE(vm);
127         throwTypeError(exec, scope, static_cast<StrictModeTypeErrorFunction*>(exec->jsCallee())->m_message);
128         return JSValue::encode(jsNull());
129     }
130
131     static ConstructType getConstructData(JSCell*, ConstructData& constructData)
132     {
133         constructData.native.function = constructThrowTypeError;
134         return ConstructType::Host;
135     }
136
137     static EncodedJSValue JSC_HOST_CALL callThrowTypeError(ExecState* exec)
138     {
139         VM& vm = exec->vm();
140         auto scope = DECLARE_THROW_SCOPE(vm);
141         throwTypeError(exec, scope, static_cast<StrictModeTypeErrorFunction*>(exec->jsCallee())->m_message);
142         return JSValue::encode(jsNull());
143     }
144
145     static CallType getCallData(JSCell*, CallData& callData)
146     {
147         callData.native.function = callThrowTypeError;
148         return CallType::Host;
149     }
150
151     DECLARE_INFO;
152
153     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype) 
154     { 
155         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info()); 
156     }
157
158 private:
159     String m_message;
160 };
161
162 } // namespace JSC
163
164 namespace WTF {
165
166 class PrintStream;
167
168 void printInternal(PrintStream&, JSC::ErrorType);
169
170 } // namespace WTF