Exception is a JSCell, not a JSObject.
[WebKit-https.git] / Source / JavaScriptCore / runtime / ExceptionHelpers.h
1 /*
2  * Copyright (C) 2008-2019 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
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  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #include "ErrorInstance.h"
32 #include "Exception.h"
33 #include "JSObject.h"
34 #include "ThrowScope.h"
35
36 namespace JSC {
37
38 typedef JSObject* (*ErrorFactory)(ExecState*, const String&, ErrorInstance::SourceAppender);
39
40 String defaultSourceAppender(const String&, const String&, RuntimeType, ErrorInstance::SourceTextWhereErrorOccurred);
41
42 JSObject* createTerminatedExecutionException(VM*);
43 JS_EXPORT_PRIVATE bool isTerminatedExecutionException(VM&, Exception*);
44 JS_EXPORT_PRIVATE JSObject* createError(ExecState*, JSValue, const String&, ErrorInstance::SourceAppender);
45 JS_EXPORT_PRIVATE JSObject* createStackOverflowError(ExecState*);
46 JSObject* createStackOverflowError(ExecState*, JSGlobalObject*);
47 JSObject* createUndefinedVariableError(ExecState*, const Identifier&);
48 JSObject* createTDZError(ExecState*);
49 JSObject* createNotAnObjectError(ExecState*, JSValue);
50 JSObject* createInvalidFunctionApplyParameterError(ExecState*, JSValue);
51 JSObject* createInvalidInParameterError(ExecState*, JSValue);
52 JSObject* createInvalidInstanceofParameterErrorNotFunction(ExecState*, JSValue);
53 JSObject* createInvalidInstanceofParameterErrorHasInstanceValueNotFunction(ExecState*, JSValue);
54 JSObject* createNotAConstructorError(ExecState*, JSValue);
55 JSObject* createNotAFunctionError(ExecState*, JSValue);
56 JSObject* createErrorForInvalidGlobalAssignment(ExecState*, const String&);
57 JSString* errorDescriptionForValue(ExecState*, JSValue);
58
59 JS_EXPORT_PRIVATE Exception* throwOutOfMemoryError(ExecState*, ThrowScope&);
60 JS_EXPORT_PRIVATE Exception* throwStackOverflowError(ExecState*, ThrowScope&);
61 JS_EXPORT_PRIVATE Exception* throwTerminatedExecutionException(ExecState*, ThrowScope&);
62
63
64 class TerminatedExecutionError final : public JSNonFinalObject {
65 public:
66     typedef JSNonFinalObject Base;
67     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
68
69     static TerminatedExecutionError* create(VM& vm)
70     {
71         TerminatedExecutionError* error = new (NotNull, allocateCell<TerminatedExecutionError>(vm.heap)) TerminatedExecutionError(vm);
72         error->finishCreation(vm);
73         return error;
74     }
75
76     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
77     {
78         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
79     }
80
81     DECLARE_EXPORT_INFO;
82
83 private:
84     explicit TerminatedExecutionError(VM& vm)
85         : JSNonFinalObject(vm, vm.terminatedExecutionErrorStructure.get())
86     {
87     }
88
89     static JSValue defaultValue(const JSObject*, ExecState*, PreferredPrimitiveType);
90
91 };
92
93 } // namespace JSC