1/*
2 * Copyright (C) 2015-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 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include "JSDestructibleObject.h"
29#include "StackFrame.h"
30#include <wtf/Vector.h>
31
32namespace JSC {
33
34class Exception final : public JSCell {
35public:
36 using Base = JSCell;
37 static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
38 static const bool needsDestruction = true;
39
40 enum StackCaptureAction {
41 CaptureStack,
42 DoNotCaptureStack
43 };
44 JS_EXPORT_PRIVATE static Exception* create(VM&, JSValue thrownValue, StackCaptureAction = CaptureStack);
45
46 static Structure* createStructure(VM&, JSGlobalObject*, JSValue prototype);
47
48 static void visitChildren(JSCell*, SlotVisitor&);
49
50 DECLARE_EXPORT_INFO;
51
52 static ptrdiff_t valueOffset()
53 {
54 return OBJECT_OFFSETOF(Exception, m_value);
55 }
56
57 JSValue value() const { return m_value.get(); }
58 const Vector<StackFrame>& stack() const { return m_stack; }
59
60 bool didNotifyInspectorOfThrow() const { return m_didNotifyInspectorOfThrow; }
61 void setDidNotifyInspectorOfThrow() { m_didNotifyInspectorOfThrow = true; }
62
63 ~Exception();
64
65private:
66 Exception(VM&);
67 void finishCreation(VM&, JSValue thrownValue, StackCaptureAction);
68 static void destroy(JSCell*);
69
70 WriteBarrier<Unknown> m_value;
71 Vector<StackFrame> m_stack;
72 bool m_didNotifyInspectorOfThrow { false };
73
74 friend class LLIntOffsetsExtractor;
75};
76
77} // namespace JSC
78