API/JSCallbackObject.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
   3  * Copyright (C) 2007 Eric Seidel <eric@webkit.org>
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef JSCallbackObject_h
  28 #define JSCallbackObject_h
  29
  30 #include "JSObjectRef.h"
  31 #include "JSValueRef.h"
  32 #include "JSObject.h"
  33
  34 namespace JSC {
  35
  36 template <class Base>
  37 class JSCallbackObject : public Base {
  38 public:
  39     JSCallbackObject(ExecState*, NonNullPassRefPtr<Structure>, JSClassRef, void* data);
  40     JSCallbackObject(JSClassRef);
  41     virtual ~JSCallbackObject();
  42
  43     void setPrivate(void* data);
  44     void* getPrivate();
  45
  46     static const ClassInfo info;
  47
  48     JSClassRef classRef() const { return m_callbackObjectData->jsClass; }
  49     bool inherits(JSClassRef) const;
  50
  51     static PassRefPtr<Structure> createStructure(JSValue proto)
  52     {
  53         return Structure::create(proto, TypeInfo(ObjectType, StructureFlags), Base::AnonymousSlotCount);
  54     }
  55
  56 protected:
  57     static const unsigned StructureFlags = OverridesGetOwnPropertySlot | ImplementsHasInstance | OverridesHasInstance | OverridesMarkChildren | OverridesGetPropertyNames | Base::StructureFlags;
  58
  59 private:
  60     virtual UString className() const;
  61
  62     virtual bool getOwnPropertySlot(ExecState*, const Identifier&, PropertySlot&);
  63     virtual bool getOwnPropertySlot(ExecState*, unsigned, PropertySlot&);
  64     virtual bool getOwnPropertyDescriptor(ExecState*, const Identifier&, PropertyDescriptor&);
  65
  66     virtual void put(ExecState*, const Identifier&, JSValue, PutPropertySlot&);
  67
  68     virtual bool deleteProperty(ExecState*, const Identifier&);
  69     virtual bool deleteProperty(ExecState*, unsigned);
  70
  71     virtual bool hasInstance(ExecState* exec, JSValue value, JSValue proto);
  72
  73     virtual void getOwnPropertyNames(ExecState*, PropertyNameArray&, EnumerationMode mode = ExcludeDontEnumProperties);
  74
  75     virtual double toNumber(ExecState*) const;
  76     virtual UString toString(ExecState*) const;
  77
  78     virtual ConstructType getConstructData(ConstructData&);
  79     virtual CallType getCallData(CallData&);
  80     virtual const ClassInfo* classInfo() const { return &info; }
  81
  82     void init(ExecState*);
  83
  84     static JSCallbackObject* asCallbackObject(JSValue);
  85
  86     static JSValue JSC_HOST_CALL call(ExecState*, JSObject* functionObject, JSValue thisValue, const ArgList&);
  87     static JSObject* construct(ExecState*, JSObject* constructor, const ArgList&);
  88
  89     static JSValue staticValueGetter(ExecState*, const Identifier&, const PropertySlot&);
  90     static JSValue staticFunctionGetter(ExecState*, const Identifier&, const PropertySlot&);
  91     static JSValue callbackGetter(ExecState*, const Identifier&, const PropertySlot&);
  92
  93     struct JSCallbackObjectData {
  94         JSCallbackObjectData(void* privateData, JSClassRef jsClass)
  95             : privateData(privateData)
  96             , jsClass(jsClass)
  97         {
  98             JSClassRetain(jsClass);
  99         }
 100
 101         ~JSCallbackObjectData()
 102         {
 103             JSClassRelease(jsClass);
 104         }
 105
 106         void* privateData;
 107         JSClassRef jsClass;
 108     };
 109
 110     OwnPtr<JSCallbackObjectData> m_callbackObjectData;
 111 };
 112
 113 } // namespace JSC
 114
 115 // include the actual template class implementation
 116 #include "JSCallbackObjectFunctions.h"
 117
 118 #endif // JSCallbackObject_h