runtime/Exception.h

   1 /*
   2  * Copyright (C) 2015 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 #ifndef Exception_h
  27 #define Exception_h
  28
  29 #include "Interpreter.h"
  30 #include <wtf/RefCountedArray.h>
  31
  32 namespace JSC {
  33
  34 class Exception : public JSNonFinalObject {
  35 public:
  36     typedef JSNonFinalObject Base;
  37     static const unsigned StructureFlags = StructureIsImmortal | Base::StructureFlags;
  38
  39     enum StackCaptureAction {
  40         CaptureStack,
  41         DoNotCaptureStack
  42     };
  43     JS_EXPORT_PRIVATE static Exception* create(VM&, JSValue thrownValue, StackCaptureAction = CaptureStack);
  44
  45     static const bool needsDestruction = true;
  46     static void destroy(JSCell*);
  47
  48     static Structure* createStructure(VM&, JSGlobalObject*, JSValue prototype);
  49
  50     static void visitChildren(JSCell*, SlotVisitor&);
  51
  52     DECLARE_EXPORT_INFO;
  53
  54     static ptrdiff_t valueOffset()
  55     {
  56         return OBJECT_OFFSETOF(Exception, m_value);
  57     }
  58
  59     JSValue value() const { return m_value.get(); }
  60     const RefCountedArray<StackFrame>& stack() const { return m_stack; }
  61
  62     bool didNotifyInspectorOfThrow() const { return m_didNotifyInspectorOfThrow; }
  63     void setDidNotifyInspectorOfThrow() { m_didNotifyInspectorOfThrow = true; }
  64
  65     ~Exception();
  66
  67 private:
  68     Exception(VM&);
  69     void finishCreation(VM&, JSValue thrownValue, StackCaptureAction);
  70
  71     WriteBarrier<Unknown> m_value;
  72     RefCountedArray<StackFrame> m_stack;
  73     bool m_didNotifyInspectorOfThrow { false };
  74
  75     friend class LLIntOffsetsExtractor;
  76 };
  77
  78 } // namespace JSC
  79
  80 #endif // Exception_h