inspector/JSJavaScriptCallFrame.h

   1 /*
   2  * Copyright (C) 2014 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 JSJavaScriptCallFrame_h
  27 #define JSJavaScriptCallFrame_h
  28
  29 #include "JSDestructibleObject.h"
  30 #include "JavaScriptCallFrame.h"
  31
  32 namespace Inspector {
  33
  34 class JSJavaScriptCallFrame : public JSC::JSDestructibleObject {
  35 public:
  36     typedef JSC::JSDestructibleObject Base;
  37     static const unsigned StructureFlags = Base::StructureFlags;
  38
  39     DECLARE_INFO;
  40
  41     static JSC::Structure* createStructure(JSC::VM& vm, JSC::JSGlobalObject* globalObject, JSC::JSValue prototype)
  42     {
  43         return JSC::Structure::create(vm, globalObject, prototype, JSC::TypeInfo(JSC::ObjectType, StructureFlags), info());
  44     }
  45
  46     static JSJavaScriptCallFrame* create(JSC::VM& vm, JSC::Structure* structure, PassRefPtr<JavaScriptCallFrame> impl)
  47     {
  48         JSJavaScriptCallFrame* instance = new (NotNull, JSC::allocateCell<JSJavaScriptCallFrame>(vm.heap)) JSJavaScriptCallFrame(vm, structure, impl);
  49         instance->finishCreation(vm);
  50         return instance;
  51     }
  52
  53     static JSC::JSObject* createPrototype(JSC::VM&, JSC::JSGlobalObject*);
  54     static void destroy(JSC::JSCell*);
  55
  56     JavaScriptCallFrame& impl() const { return *m_impl; }
  57     void releaseImpl();
  58
  59     // Functions.
  60     JSC::JSValue evaluate(JSC::ExecState*);
  61     JSC::JSValue scopeType(JSC::ExecState*);
  62
  63     // Attributes.
  64     JSC::JSValue caller(JSC::ExecState*) const;
  65     JSC::JSValue sourceID(JSC::ExecState*) const;
  66     JSC::JSValue line(JSC::ExecState*) const;
  67     JSC::JSValue column(JSC::ExecState*) const;
  68     JSC::JSValue functionName(JSC::ExecState*) const;
  69     JSC::JSValue scopeChain(JSC::ExecState*) const;
  70     JSC::JSValue thisObject(JSC::ExecState*) const;
  71     JSC::JSValue type(JSC::ExecState*) const;
  72
  73     // Constants.
  74     static const unsigned short GLOBAL_SCOPE = 0;
  75     static const unsigned short LOCAL_SCOPE = 1;
  76     static const unsigned short WITH_SCOPE = 2;
  77     static const unsigned short CLOSURE_SCOPE = 3;
  78     static const unsigned short CATCH_SCOPE = 4;
  79     static const unsigned short FUNCTION_NAME_SCOPE = 5;
  80
  81 protected:
  82     void finishCreation(JSC::VM&);
  83
  84 private:
  85     JSJavaScriptCallFrame(JSC::VM&, JSC::Structure*, PassRefPtr<JavaScriptCallFrame>);
  86     ~JSJavaScriptCallFrame();
  87
  88     JavaScriptCallFrame* m_impl;
  89 };
  90
  91 JSC::JSValue toJS(JSC::ExecState*, JSC::JSGlobalObject*, JavaScriptCallFrame*);
  92 JSJavaScriptCallFrame* toJSJavaScriptCallFrame(JSC::JSValue);
  93
  94 } // namespace Inspector
  95
  96 #endif // !defined(JSJavaScriptCallFrame_h)