[ES6] Add support for Symbol.toPrimitive
[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 #ifndef Error_h
24 #define Error_h
25
26 #include "ErrorInstance.h"
27 #include "InternalFunction.h"
28 #include "Interpreter.h"
29 #include "JSObject.h"
30 #include <stdint.h>
31
32
33 namespace JSC {
34
35 class ExecState;
36 class VM;
37 class JSGlobalObject;
38 class JSObject;
39 class SourceCode;
40 class Structure;
41
42 // ExecState wrappers.
43 JSObject* createError(ExecState*, const String&, ErrorInstance::SourceAppender);
44 JSObject* createEvalError(ExecState*, const String&, ErrorInstance::SourceAppender);
45 JSObject* createRangeError(ExecState*, const String&, ErrorInstance::SourceAppender);
46 JSObject* createReferenceError(ExecState*, const String&, ErrorInstance::SourceAppender);
47 JSObject* createSyntaxError(ExecState*, const String&, ErrorInstance::SourceAppender);
48 JSObject* createTypeError(ExecState*, const String&, ErrorInstance::SourceAppender, RuntimeType);
49 JSObject* createNotEnoughArgumentsError(ExecState*, ErrorInstance::SourceAppender);
50 JSObject* createURIError(ExecState*, const String&, ErrorInstance::SourceAppender);
51 JSObject* createOutOfMemoryError(ExecState*, ErrorInstance::SourceAppender);
52
53
54 JS_EXPORT_PRIVATE JSObject* createError(ExecState*, const String&);
55 JS_EXPORT_PRIVATE JSObject* createEvalError(ExecState*, const String&);
56 JS_EXPORT_PRIVATE JSObject* createRangeError(ExecState*, const String&);
57 JS_EXPORT_PRIVATE JSObject* createReferenceError(ExecState*, const String&);
58 JS_EXPORT_PRIVATE JSObject* createSyntaxError(ExecState*, const String&);
59 JS_EXPORT_PRIVATE JSObject* createTypeError(ExecState*);
60 JS_EXPORT_PRIVATE JSObject* createTypeError(ExecState*, const String&);
61 JS_EXPORT_PRIVATE JSObject* createNotEnoughArgumentsError(ExecState*);
62 JS_EXPORT_PRIVATE JSObject* createURIError(ExecState*, const String&);
63 JS_EXPORT_PRIVATE JSObject* createOutOfMemoryError(ExecState*);
64
65
66 bool addErrorInfoAndGetBytecodeOffset(ExecState*, VM&, JSObject*, bool, CallFrame*&, unsigned&);
67
68 bool hasErrorInfo(ExecState*, JSObject* error);
69 JS_EXPORT_PRIVATE void addErrorInfo(ExecState*, JSObject*, bool); 
70 JSObject* addErrorInfo(ExecState*, JSObject* error, int line, const SourceCode&);
71
72 // Methods to throw Errors.
73
74 // Convenience wrappers, create an throw an exception with a default message.
75 JS_EXPORT_PRIVATE JSObject* throwConstructorCannotBeCalledAsFunctionTypeError(ExecState*, const char* constructorName);
76 JS_EXPORT_PRIVATE JSObject* throwTypeError(ExecState*);
77 JS_EXPORT_PRIVATE JSObject* throwTypeError(ExecState*, const String& errorMessage);
78 JS_EXPORT_PRIVATE JSObject* throwSyntaxError(ExecState*);
79 JS_EXPORT_PRIVATE JSObject* throwSyntaxError(ExecState*, const String& errorMessage);
80 inline JSObject* throwRangeError(ExecState* state, const String& errorMessage) { return state->vm().throwException(state, createRangeError(state, errorMessage)); }
81
82 // Convenience wrappers, wrap result as an EncodedJSValue.
83 inline void throwVMError(ExecState* exec, Exception* exception) { exec->vm().throwException(exec, exception); }
84 inline EncodedJSValue throwVMError(ExecState* exec, JSValue error) { return JSValue::encode(exec->vm().throwException(exec, error)); }
85 inline EncodedJSValue throwVMTypeError(ExecState* exec) { return JSValue::encode(throwTypeError(exec)); }
86 inline EncodedJSValue throwVMTypeError(ExecState* exec, const String& errorMessage) { return JSValue::encode(throwTypeError(exec, errorMessage)); }
87 inline EncodedJSValue throwVMRangeError(ExecState* state, const String& errorMessage) { return JSValue::encode(throwRangeError(state, errorMessage)); }
88
89 class StrictModeTypeErrorFunction : public InternalFunction {
90 private:
91     StrictModeTypeErrorFunction(VM& vm, Structure* structure, const String& message)
92         : InternalFunction(vm, structure)
93         , m_message(message)
94     {
95     }
96
97     static void destroy(JSCell*);
98
99 public:
100     typedef InternalFunction Base;
101
102     static StrictModeTypeErrorFunction* create(VM& vm, Structure* structure, const String& message)
103     {
104         StrictModeTypeErrorFunction* function = new (NotNull, allocateCell<StrictModeTypeErrorFunction>(vm.heap)) StrictModeTypeErrorFunction(vm, structure, message);
105         function->finishCreation(vm, String());
106         return function;
107     }
108
109     static EncodedJSValue JSC_HOST_CALL constructThrowTypeError(ExecState* exec)
110     {
111         throwTypeError(exec, static_cast<StrictModeTypeErrorFunction*>(exec->callee())->m_message);
112         return JSValue::encode(jsNull());
113     }
114
115     static ConstructType getConstructData(JSCell*, ConstructData& constructData)
116     {
117         constructData.native.function = constructThrowTypeError;
118         return ConstructTypeHost;
119     }
120
121     static EncodedJSValue JSC_HOST_CALL callThrowTypeError(ExecState* exec)
122     {
123         throwTypeError(exec, static_cast<StrictModeTypeErrorFunction*>(exec->callee())->m_message);
124         return JSValue::encode(jsNull());
125     }
126
127     static CallType getCallData(JSCell*, CallData& callData)
128     {
129         callData.native.function = callThrowTypeError;
130         return CallTypeHost;
131     }
132
133     DECLARE_INFO;
134
135     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype) 
136     { 
137         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info()); 
138     }
139
140 private:
141     String m_message;
142 };
143
144 } // namespace JSC
145
146 #endif // Error_h