[JSC] Unify how we throw TypeError from C++
[WebKit-https.git] / Source / JavaScriptCore / runtime / Error.cpp
1 /*
2  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003-2006, 2008, 2016 Apple Inc. All rights reserved.
5  *  Copyright (C) 2007 Eric Seidel (eric@webkit.org)
6  *
7  *  This library is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU Library General Public
9  *  License as published by the Free Software Foundation; either
10  *  version 2 of the License, or (at your option) any later version.
11  *
12  *  This library is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  Library General Public License for more details.
16  *
17  *  You should have received a copy of the GNU Library General Public License
18  *  along with this library; see the file COPYING.LIB.  If not, write to
19  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  *  Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #include "config.h"
25 #include "Error.h"
26
27 #include "ConstructData.h"
28 #include "ErrorConstructor.h"
29 #include "ExceptionHelpers.h"
30 #include "FunctionPrototype.h"
31 #include "JSArray.h"
32 #include "JSFunction.h"
33 #include "JSGlobalObject.h"
34 #include "JSObject.h"
35 #include "JSString.h"
36 #include "NativeErrorConstructor.h"
37 #include "JSCInlines.h"
38 #include "SourceCode.h"
39
40 #include <wtf/text/StringBuilder.h>
41
42 namespace JSC {
43
44 static const char* linePropertyName = "line";
45 static const char* sourceURLPropertyName = "sourceURL";
46
47 JSObject* createError(ExecState* exec, const String& message, ErrorInstance::SourceAppender appender)
48 {
49     ASSERT(!message.isEmpty());
50     JSGlobalObject* globalObject = exec->lexicalGlobalObject();
51     return ErrorInstance::create(exec, globalObject->vm(), globalObject->errorStructure(), message, appender, TypeNothing, true);
52 }
53
54 JSObject* createEvalError(ExecState* exec, const String& message, ErrorInstance::SourceAppender appender)
55 {
56     ASSERT(!message.isEmpty());
57     JSGlobalObject* globalObject = exec->lexicalGlobalObject();
58     return ErrorInstance::create(exec, globalObject->vm(), globalObject->evalErrorConstructor()->errorStructure(), message, appender, TypeNothing, true);
59 }
60
61 JSObject* createRangeError(ExecState* exec, const String& message, ErrorInstance::SourceAppender appender)
62 {
63     ASSERT(!message.isEmpty());
64     JSGlobalObject* globalObject = exec->lexicalGlobalObject();
65     return ErrorInstance::create(exec, globalObject->vm(), globalObject->rangeErrorConstructor()->errorStructure(), message, appender, TypeNothing, true);
66 }
67
68 JSObject* createReferenceError(ExecState* exec, const String& message, ErrorInstance::SourceAppender appender)
69 {
70     ASSERT(!message.isEmpty());
71     JSGlobalObject* globalObject = exec->lexicalGlobalObject();
72     return ErrorInstance::create(exec, globalObject->vm(), globalObject->referenceErrorConstructor()->errorStructure(), message, appender, TypeNothing, true);
73 }
74
75 JSObject* createSyntaxError(ExecState* exec, const String& message, ErrorInstance::SourceAppender appender)
76 {
77     ASSERT(!message.isEmpty());
78     JSGlobalObject* globalObject = exec->lexicalGlobalObject();
79     return ErrorInstance::create(exec, globalObject->vm(), globalObject->syntaxErrorConstructor()->errorStructure(), message, appender, TypeNothing, true);
80 }
81
82 JSObject* createTypeError(ExecState* exec, const String& message, ErrorInstance::SourceAppender appender, RuntimeType type)
83 {
84     ASSERT(!message.isEmpty());
85     JSGlobalObject* globalObject = exec->lexicalGlobalObject();
86     return ErrorInstance::create(exec, globalObject->vm(), globalObject->typeErrorConstructor()->errorStructure(), message, appender, type, true);
87 }
88
89 JSObject* createNotEnoughArgumentsError(ExecState* exec, ErrorInstance::SourceAppender appender)
90 {
91     return createTypeError(exec, ASCIILiteral("Not enough arguments"), appender, TypeNothing);
92 }
93
94 JSObject* createURIError(ExecState* exec, const String& message, ErrorInstance::SourceAppender appender)
95 {
96     ASSERT(!message.isEmpty());
97     JSGlobalObject* globalObject = exec->lexicalGlobalObject();
98     return ErrorInstance::create(exec, globalObject->vm(), globalObject->URIErrorConstructor()->errorStructure(), message, appender, TypeNothing, true);
99 }
100
101 JSObject* createOutOfMemoryError(ExecState* exec, ErrorInstance::SourceAppender appender) 
102 {
103     return createError(exec, ASCIILiteral("Out of memory"), appender);
104 }
105
106
107 class FindFirstCallerFrameWithCodeblockFunctor {
108 public:
109     FindFirstCallerFrameWithCodeblockFunctor(CallFrame* startCallFrame)
110         : m_startCallFrame(startCallFrame)
111         , m_foundCallFrame(nullptr)
112         , m_foundStartCallFrame(false)
113         , m_index(0)
114     { }
115
116     StackVisitor::Status operator()(StackVisitor& visitor) const
117     {
118         if (!m_foundStartCallFrame && (visitor->callFrame() == m_startCallFrame))
119             m_foundStartCallFrame = true;
120
121         if (m_foundStartCallFrame) {
122             if (visitor->callFrame()->codeBlock()) {
123                 m_foundCallFrame = visitor->callFrame();
124                 return StackVisitor::Done;
125             }
126             m_index++;
127         }
128
129         return StackVisitor::Continue;
130     }
131
132     CallFrame* foundCallFrame() const { return m_foundCallFrame; }
133     unsigned index() const { return m_index; }
134
135 private:
136     CallFrame* m_startCallFrame;
137     mutable CallFrame* m_foundCallFrame;
138     mutable bool m_foundStartCallFrame;
139     mutable unsigned m_index;
140 };
141
142 bool addErrorInfoAndGetBytecodeOffset(ExecState* exec, VM& vm, JSObject* obj, bool useCurrentFrame, CallFrame*& callFrame, unsigned* bytecodeOffset)
143 {
144     Vector<StackFrame> stackTrace = Vector<StackFrame>();
145
146     size_t framesToSkip = useCurrentFrame ? 0 : 1;
147     vm.interpreter->getStackTrace(stackTrace, framesToSkip);
148     if (!stackTrace.isEmpty()) {
149
150         ASSERT(exec == vm.topCallFrame || exec == exec->lexicalGlobalObject()->globalExec() || exec == exec->vmEntryGlobalObject()->globalExec());
151
152         StackFrame* firstNonNativeFrame;
153         for (unsigned i = 0 ; i < stackTrace.size(); ++i) {
154             firstNonNativeFrame = &stackTrace.at(i);
155             if (!firstNonNativeFrame->isNative())
156                 break;
157         }
158
159         if (bytecodeOffset) {
160             FindFirstCallerFrameWithCodeblockFunctor functor(exec);
161             vm.topCallFrame->iterate(functor);
162             callFrame = functor.foundCallFrame();
163             unsigned stackIndex = functor.index();
164             *bytecodeOffset = stackTrace.at(stackIndex).bytecodeOffset;
165         }
166         
167         unsigned line;
168         unsigned column;
169         firstNonNativeFrame->computeLineAndColumn(line, column);
170         obj->putDirect(vm, vm.propertyNames->line, jsNumber(line), ReadOnly | DontDelete);
171         obj->putDirect(vm, vm.propertyNames->column, jsNumber(column), ReadOnly | DontDelete);
172
173         String frameSourceURL = firstNonNativeFrame->sourceURL();
174         if (!frameSourceURL.isEmpty())
175             obj->putDirect(vm, vm.propertyNames->sourceURL, jsString(&vm, frameSourceURL), ReadOnly | DontDelete);
176
177         obj->putDirect(vm, vm.propertyNames->stack, Interpreter::stackTraceAsString(vm, stackTrace), DontEnum);
178
179         return true;
180     }
181     return false;
182 }
183
184 void addErrorInfo(ExecState* exec, JSObject* obj, bool useCurrentFrame)
185 {
186     CallFrame* callFrame = nullptr;
187     addErrorInfoAndGetBytecodeOffset(exec, exec->vm(), obj, useCurrentFrame, callFrame);
188 }
189
190 JSObject* addErrorInfo(CallFrame* callFrame, JSObject* error, int line, const SourceCode& source)
191 {
192     VM* vm = &callFrame->vm();
193     const String& sourceURL = source.provider()->url();
194
195     if (line != -1)
196         error->putDirect(*vm, Identifier::fromString(vm, linePropertyName), jsNumber(line), ReadOnly | DontDelete);
197     if (!sourceURL.isNull())
198         error->putDirect(*vm, Identifier::fromString(vm, sourceURLPropertyName), jsString(vm, sourceURL), ReadOnly | DontDelete);
199     return error;
200 }
201
202
203 bool hasErrorInfo(ExecState* exec, JSObject* error)
204 {
205     return error->hasProperty(exec, Identifier::fromString(exec, linePropertyName))
206         || error->hasProperty(exec, Identifier::fromString(exec, sourceURLPropertyName));
207 }
208
209 JSObject* throwConstructorCannotBeCalledAsFunctionTypeError(ExecState* exec, const char* constructorName)
210 {
211     return throwTypeError(exec, makeString("calling ", constructorName, " constructor without new is invalid"));
212 }
213
214 JSObject* throwTypeError(ExecState* exec)
215 {
216     return exec->vm().throwException(exec, createTypeError(exec));
217 }
218
219 JSObject* throwTypeError(ExecState* exec, ASCIILiteral errorMessage)
220 {
221     return throwTypeError(exec, String(errorMessage));
222 }
223
224 JSObject* throwTypeError(ExecState* exec, const String& message)
225 {
226     return exec->vm().throwException(exec, createTypeError(exec, message));
227 }
228
229 JSObject* throwSyntaxError(ExecState* exec)
230 {
231     return exec->vm().throwException(exec, createSyntaxError(exec, ASCIILiteral("Syntax error")));
232 }
233
234 JSObject* throwSyntaxError(ExecState* exec, const String& message)
235 {
236     return exec->vm().throwException(exec, createSyntaxError(exec, message));
237 }
238
239 JSObject* createError(ExecState* exec, const String& message)
240 {
241     return createError(exec, message, nullptr);
242 }
243
244 JSObject* createEvalError(ExecState* exec, const String& message)
245 {
246     return createEvalError(exec, message, nullptr);
247 }
248
249 JSObject* createRangeError(ExecState* exec, const String& message)
250 {
251     return createRangeError(exec, message, nullptr);
252 }
253
254 JSObject* createReferenceError(ExecState* exec, const String& message)
255 {
256     return createReferenceError(exec, message, nullptr);
257 }
258
259 JSObject* createSyntaxError(ExecState* exec, const String& message)
260 {
261     return createSyntaxError(exec, message, nullptr);
262 }
263
264 JSObject* createTypeError(ExecState* exec)
265 {
266     return createTypeError(exec, ASCIILiteral("Type error"));
267 }
268
269 JSObject* createTypeError(ExecState* exec, const String& message)
270 {
271     return createTypeError(exec, message, nullptr, TypeNothing);
272 }
273
274 JSObject* createNotEnoughArgumentsError(ExecState* exec)
275 {
276     return createNotEnoughArgumentsError(exec, nullptr);
277 }
278
279 JSObject* createURIError(ExecState* exec, const String& message)
280 {
281     return createURIError(exec, message, nullptr);
282 }
283
284 JSObject* createOutOfMemoryError(ExecState* exec)
285 {
286     return createOutOfMemoryError(exec, nullptr);
287 }
288
289
290 const ClassInfo StrictModeTypeErrorFunction::s_info = { "Function", &Base::s_info, 0, CREATE_METHOD_TABLE(StrictModeTypeErrorFunction) };
291
292 void StrictModeTypeErrorFunction::destroy(JSCell* cell)
293 {
294     static_cast<StrictModeTypeErrorFunction*>(cell)->StrictModeTypeErrorFunction::~StrictModeTypeErrorFunction();
295 }
296
297 } // namespace JSC