8de113e68249999ae72bf555441c79329b629075
[WebKit-https.git] / Source / JavaScriptCore / runtime / Exception.h
1 /*
2  * Copyright (C) 2015-2017 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
32 namespace JSC {
33     
34 class Exception final : public JSDestructibleObject {
35 public:
36     typedef JSDestructibleObject Base;
37     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
38
39     enum StackCaptureAction {
40         CaptureStack,
41         DoNotCaptureStack
42     };
43     JS_EXPORT_PRIVATE static Exception* create(VM&, JSValue thrownValue, StackCaptureAction = CaptureStack);
44
45     static Structure* createStructure(VM&, JSGlobalObject*, JSValue prototype);
46
47     static void visitChildren(JSCell*, SlotVisitor&);
48
49     DECLARE_EXPORT_INFO;
50
51     static ptrdiff_t valueOffset()
52     {
53         return OBJECT_OFFSETOF(Exception, m_value);
54     }
55
56     JSValue value() const { return m_value.get(); }
57     const Vector<StackFrame>& stack() const { return m_stack; }
58
59     bool didNotifyInspectorOfThrow() const { return m_didNotifyInspectorOfThrow; }
60     void setDidNotifyInspectorOfThrow() { m_didNotifyInspectorOfThrow = true; }
61
62     ~Exception();
63
64 private:
65     Exception(VM&);
66     void finishCreation(VM&, JSValue thrownValue, StackCaptureAction);
67     static void destroy(JSCell*);
68
69     WriteBarrier<Unknown> m_value;
70     Vector<StackFrame> m_stack;
71     bool m_didNotifyInspectorOfThrow { false };
72
73     friend class LLIntOffsetsExtractor;
74 };
75
76 } // namespace JSC