We should support CreateThis in the FTL
[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 JS_EXPORT_PRIVATE JSObject* createOutOfMemoryError(ExecState*, const String&);
75
76 JS_EXPORT_PRIVATE JSObject* createError(ExecState*, ErrorType, const String&);
77
78 std::unique_ptr<Vector<StackFrame>> getStackTrace(ExecState*, VM&, JSObject*, bool useCurrentFrame);
79 void getBytecodeOffset(ExecState*, VM&, Vector<StackFrame>*, CallFrame*&, unsigned& bytecodeOffset);
80 bool getLineColumnAndSource(Vector<StackFrame>* stackTrace, unsigned& line, unsigned& column, String& sourceURL);
81 bool addErrorInfo(VM&, Vector<StackFrame>*, JSObject*);
82 JS_EXPORT_PRIVATE void addErrorInfo(ExecState*, JSObject*, bool);
83 JSObject* addErrorInfo(ExecState*, JSObject* error, int line, const SourceCode&);
84
85 // Methods to throw Errors.
86
87 // Convenience wrappers, create an throw an exception with a default message.
88 JS_EXPORT_PRIVATE JSObject* throwConstructorCannotBeCalledAsFunctionTypeError(ExecState*, ThrowScope&, const char* constructorName);
89 JS_EXPORT_PRIVATE JSObject* throwTypeError(ExecState*, ThrowScope&);
90 JS_EXPORT_PRIVATE JSObject* throwTypeError(ExecState*, ThrowScope&, ASCIILiteral errorMessage);
91 JS_EXPORT_PRIVATE JSObject* throwTypeError(ExecState*, ThrowScope&, const String& errorMessage);
92 JS_EXPORT_PRIVATE JSObject* throwSyntaxError(ExecState*, ThrowScope&);
93 JS_EXPORT_PRIVATE JSObject* throwSyntaxError(ExecState*, ThrowScope&, const String& errorMessage);
94 inline JSObject* throwRangeError(ExecState* state, ThrowScope& scope, const String& errorMessage) { return throwException(state, scope, createRangeError(state, errorMessage)); }
95 JS_EXPORT_PRIVATE JSValue throwDOMAttributeGetterTypeError(ExecState*, ThrowScope&, const ClassInfo*, PropertyName);
96
97 // Convenience wrappers, wrap result as an EncodedJSValue.
98 inline void throwVMError(ExecState* exec, ThrowScope& scope, Exception* exception) { throwException(exec, scope, exception); }
99 inline EncodedJSValue throwVMError(ExecState* exec, ThrowScope& scope, JSValue error) { return JSValue::encode(throwException(exec, scope, error)); }
100 inline EncodedJSValue throwVMError(ExecState* exec, ThrowScope& scope, const char* errorMessage) { return JSValue::encode(throwException(exec, scope, createError(exec, errorMessage))); }
101 inline EncodedJSValue throwVMTypeError(ExecState* exec, ThrowScope& scope) { return JSValue::encode(throwTypeError(exec, scope)); }
102 inline EncodedJSValue throwVMTypeError(ExecState* exec, ThrowScope& scope, ASCIILiteral errorMessage) { return JSValue::encode(throwTypeError(exec, scope, errorMessage)); }
103 inline EncodedJSValue throwVMTypeError(ExecState* exec, ThrowScope& scope, const String& errorMessage) { return JSValue::encode(throwTypeError(exec, scope, errorMessage)); }
104 inline EncodedJSValue throwVMRangeError(ExecState* state, ThrowScope& scope, const String& errorMessage) { return JSValue::encode(throwRangeError(state, scope, errorMessage)); }
105 inline EncodedJSValue throwVMDOMAttributeGetterTypeError(ExecState* state, ThrowScope& scope, const ClassInfo* classInfo, PropertyName propertyName) { return JSValue::encode(throwDOMAttributeGetterTypeError(state, scope, classInfo, propertyName)); }
106
107 class StrictModeTypeErrorFunction final : public InternalFunction {
108 private:
109     StrictModeTypeErrorFunction(VM& vm, Structure* structure, const String& message)
110         : InternalFunction(vm, structure, callThrowTypeError, constructThrowTypeError)
111         , m_message(message)
112     {
113     }
114
115     static void destroy(JSCell*);
116
117 public:
118     typedef InternalFunction Base;
119     
120     template<typename CellType>
121     static IsoSubspace* subspaceFor(VM& vm)
122     {
123         return &vm.strictModeTypeErrorFunctionSpace;
124     }
125
126     static StrictModeTypeErrorFunction* create(VM& vm, Structure* structure, const String& message)
127     {
128         StrictModeTypeErrorFunction* function = new (NotNull, allocateCell<StrictModeTypeErrorFunction>(vm.heap)) StrictModeTypeErrorFunction(vm, structure, message);
129         function->finishCreation(vm, String());
130         return function;
131     }
132
133     static EncodedJSValue JSC_HOST_CALL constructThrowTypeError(ExecState* exec)
134     {
135         VM& vm = exec->vm();
136         auto scope = DECLARE_THROW_SCOPE(vm);
137         throwTypeError(exec, scope, static_cast<StrictModeTypeErrorFunction*>(exec->jsCallee())->m_message);
138         return JSValue::encode(jsNull());
139     }
140
141     static EncodedJSValue JSC_HOST_CALL callThrowTypeError(ExecState* exec)
142     {
143         VM& vm = exec->vm();
144         auto scope = DECLARE_THROW_SCOPE(vm);
145         throwTypeError(exec, scope, static_cast<StrictModeTypeErrorFunction*>(exec->jsCallee())->m_message);
146         return JSValue::encode(jsNull());
147     }
148
149     DECLARE_INFO;
150
151     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype) 
152     { 
153         return Structure::create(vm, globalObject, prototype, TypeInfo(InternalFunctionType, StructureFlags), info()); 
154     }
155
156 private:
157     String m_message;
158 };
159
160 } // namespace JSC
161
162 namespace WTF {
163
164 class PrintStream;
165
166 void printInternal(PrintStream&, JSC::ErrorType);
167
168 } // namespace WTF