6b70b63402a926418317555aa225353a55894d3f
[WebKit-https.git] / Source / JavaScriptCore / runtime / ErrorInstance.h
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2008, 2016 Apple Inc. All rights reserved.
4  *
5  *  This library is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU Lesser General Public
7  *  License as published by the Free Software Foundation; either
8  *  version 2 of the License, or (at your option) any later version.
9  *
10  *  This library is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *  Lesser General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Lesser General Public
16  *  License along with this library; if not, write to the Free Software
17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18  *
19  */
20
21 #pragma once
22
23 #include "JSObject.h"
24 #include "RuntimeType.h"
25 #include "SourceProvider.h"
26
27 namespace JSC {
28
29 class ErrorInstance : public JSNonFinalObject {
30 public:
31     typedef JSNonFinalObject Base;
32
33     enum SourceTextWhereErrorOccurred { FoundExactSource, FoundApproximateSource };
34     typedef String (*SourceAppender) (const String& originalMessage, const String& sourceText, RuntimeType, SourceTextWhereErrorOccurred);
35
36     DECLARE_EXPORT_INFO;
37
38     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
39     {
40         return Structure::create(vm, globalObject, prototype, TypeInfo(ErrorInstanceType, StructureFlags), info());
41     }
42
43     static ErrorInstance* create(ExecState* exec, VM& vm, Structure* structure, const String& message, SourceAppender appender = nullptr, RuntimeType type = TypeNothing, bool useCurrentFrame = true)
44     {
45         ErrorInstance* instance = new (NotNull, allocateCell<ErrorInstance>(vm.heap)) ErrorInstance(vm, structure);
46         instance->m_sourceAppender = appender;
47         instance->m_runtimeTypeForCause = type;
48         instance->finishCreation(exec, vm, message, useCurrentFrame);
49         return instance;
50     }
51
52     static ErrorInstance* create(ExecState*, Structure*, JSValue message, SourceAppender = nullptr, RuntimeType = TypeNothing, bool useCurrentFrame = true);
53
54     static void addErrorInfo(ExecState*, VM&, JSObject*, bool = true);
55
56     bool hasSourceAppender() const { return !!m_sourceAppender; }
57     SourceAppender sourceAppender() const { return m_sourceAppender; }
58     void setSourceAppender(SourceAppender appender) { m_sourceAppender = appender; }
59     void clearSourceAppender() { m_sourceAppender = nullptr; }
60     void setRuntimeTypeForCause(RuntimeType type) { m_runtimeTypeForCause = type; }
61     RuntimeType runtimeTypeForCause() const { return m_runtimeTypeForCause; }
62     void clearRuntimeTypeForCause() { m_runtimeTypeForCause = TypeNothing; }
63
64     void setStackOverflowError() { m_stackOverflowError = true; }
65     bool isStackOverflowError() const { return m_stackOverflowError; }
66     void setOutOfMemoryError() { m_outOfMemoryError = true; }
67     bool isOutOfMemoryError() const { return m_outOfMemoryError; }
68
69     JS_EXPORT_PRIVATE String sanitizedToString(ExecState*);
70
71 protected:
72     explicit ErrorInstance(VM&, Structure*);
73
74     void finishCreation(ExecState*, VM&, const String&, bool useCurrentFrame = true);
75
76     SourceAppender m_sourceAppender { nullptr };
77     RuntimeType m_runtimeTypeForCause { TypeNothing };
78     bool m_stackOverflowError { false };
79     bool m_outOfMemoryError { false };
80 };
81
82 } // namespace JSC