Changeset 15469

Timestamp:

07/16/06 15:17:04 (2 years ago)

Author:

ggaren

Message:

Reviewed by Maciej.

• Added names to functions.

• Removed GetPrivate/SetPrivate from callbackFunctions and callbackConstructors. The private data idiom is that a JS object stores its native implementation as private data. For functions and constructors, the native implementation is nothing more than the callback they already store, so supporting private data, too, confuses the idiom. If you *really* want, you can still create a custom function with private data.

• API/JSCallbackConstructor.cpp:
• API/JSCallbackConstructor.h:
• API/JSCallbackFunction.cpp: (KJS::JSCallbackFunction::JSCallbackFunction):
• API/JSCallbackFunction.h:
• API/JSCallbackObject.cpp: (KJS::JSCallbackObject::staticFunctionGetter):
• API/JSObjectRef.cpp: (JSObjectMakeFunction): (JSObjectMakeFunctionWithBody): (JSObjectGetPrivate): (JSObjectSetPrivate):
• API/JSObjectRef.h:
• API/minidom.c: (main):
• API/testapi.c: (main):

Location:

trunk/JavaScriptCore

Files:

• API/JSCallbackConstructor.cpp (modified) (1 diff)
• API/JSCallbackConstructor.h (modified) (2 diffs)
• API/JSCallbackFunction.cpp (modified) (2 diffs)
• API/JSCallbackFunction.h (modified) (2 diffs)
• API/JSCallbackObject.cpp (modified) (2 diffs)
• API/JSObjectRef.cpp (modified) (5 diffs)
• API/JSObjectRef.h (modified) (4 diffs)
• API/minidom.c (modified) (1 diff)
• API/testapi.c (modified) (2 diffs)
• ChangeLog (modified) (1 diff)

trunk/JavaScriptCore/API/JSCallbackConstructor.cpp

@@ -55 +55 @@
 }
 
-void JSCallbackConstructor::setPrivate(void* data)
-{
-    m_privateData = data;
-}
-
-void* JSCallbackConstructor::getPrivate()
-{
-    return m_privateData;
-}
-
 } // namespace KJS

trunk/JavaScriptCore/API/JSCallbackConstructor.h

@@ -41 +41 @@
     virtual JSObject* construct(ExecState*, const List &args);
 
-    void setPrivate(void* data);
-    void* getPrivate();
-
     virtual const ClassInfo *classInfo() const { return &info; }
     static const ClassInfo info;
@@ -51 +48 @@
     JSCallbackConstructor(const JSCallbackConstructor&);
     
-    void* m_privateData;
     JSObjectCallAsConstructorCallback m_callback;
 };

trunk/JavaScriptCore/API/JSCallbackFunction.cpp

@@ -34 +34 @@
 const ClassInfo JSCallbackFunction::info = { "CallbackFunction", &InternalFunctionImp::info, 0, 0 };
 
-JSCallbackFunction::JSCallbackFunction(ExecState* exec, JSObjectCallAsFunctionCallback callback)
-    : InternalFunctionImp(static_cast<FunctionPrototype*>(exec->lexicalInterpreter()->builtinFunctionPrototype()))
+JSCallbackFunction::JSCallbackFunction(ExecState* exec, JSObjectCallAsFunctionCallback callback, const Identifier& name)
+    : InternalFunctionImp(static_cast<FunctionPrototype*>(exec->lexicalInterpreter()->builtinFunctionPrototype()), name)
     , m_callback(callback)
 {
-}
-
-bool JSCallbackFunction::implementsCall() const
-{
-    return true;
 }
 
@@ -58 +53 @@
 }
 
-void JSCallbackFunction::setPrivate(void* data)
-{
-    m_privateData = data;
-}
-
-void* JSCallbackFunction::getPrivate()
-{
-    return m_privateData;
-}
-
 } // namespace KJS

trunk/JavaScriptCore/API/JSCallbackFunction.h

@@ -37 +37 @@
 {
 public:
-    JSCallbackFunction(ExecState* exec, JSObjectCallAsFunctionCallback callback);
+    JSCallbackFunction(ExecState* exec, JSObjectCallAsFunctionCallback callback, const Identifier& name);
 
-    virtual bool implementsCall() const;
     virtual JSValue* callAsFunction(ExecState*, JSObject* thisObj, const List &args);
-
-    void setPrivate(void* data);
-    void* getPrivate();
 
     virtual const ClassInfo *classInfo() const { return &info; }
@@ -52 +48 @@
     JSCallbackFunction(const JSCallbackFunction&);
     
-    void* m_privateData;
     JSObjectCallAsFunctionCallback m_callback;
 };

trunk/JavaScriptCore/API/JSCallbackObject.cpp

@@ -26 +26 @@
 
 #include "APICast.h"
+#include "JSCallbackFunction.h"
 #include "JSCallbackObject.h"
 #include "JSStringRef.h"
@@ -406 +407 @@
         if (__JSClass::StaticFunctionsTable* staticFunctions = jsClass->staticFunctions) {
             if (StaticFunctionEntry* entry = staticFunctions->get(propertyName.ustring().rep())) {
-                JSValue* v = toJS(JSObjectMakeFunction(toRef(exec), entry->callAsFunction));
-                thisObj->putDirect(propertyName, v, entry->attributes);
-                return v;
+                JSObject* o = new JSCallbackFunction(exec, entry->callAsFunction, propertyName);
+                thisObj->putDirect(propertyName, o, entry->attributes);
+                return o;
             }
         }

trunk/JavaScriptCore/API/JSObjectRef.cpp

@@ -76 +76 @@
 }
 
-JSObjectRef JSObjectMakeFunction(JSContextRef context, JSObjectCallAsFunctionCallback callAsFunction)
-{
-    JSLock lock;
-    ExecState* exec = toJS(context);
-    return toRef(new JSCallbackFunction(exec, callAsFunction));
+JSObjectRef JSObjectMakeFunction(JSContextRef context, JSStringRef name, JSObjectCallAsFunctionCallback callAsFunction)
+{
+    JSLock lock;
+    ExecState* exec = toJS(context);
+    Identifier nameID = name ? Identifier(toJS(name)) : Identifier("anonymous");
+    
+    return toRef(new JSCallbackFunction(exec, callAsFunction, nameID));
 }
 
@@ -95 +97 @@
     
     ExecState* exec = toJS(context);
-    UString::Rep* nameRep = name ? toJS(name) : &UString::Rep::null;
     UString::Rep* bodyRep = toJS(body);
     UString::Rep* sourceURLRep = sourceURL ? toJS(sourceURL) : &UString::Rep::null;
     
-    Identifier nameIdentifier = nameRep ? Identifier(nameRep) : Identifier("anonymous");
+    Identifier nameID = name ? Identifier(toJS(name)) : Identifier("anonymous");
     
     List args;
@@ -106 +107 @@
     args.append(jsString(UString(bodyRep)));
 
-    JSObject* result = exec->dynamicInterpreter()->builtinFunction()->construct(exec, args, nameIdentifier, UString(sourceURLRep), startingLineNumber);
+    JSObject* result = exec->dynamicInterpreter()->builtinFunction()->construct(exec, args, nameID, UString(sourceURLRep), startingLineNumber);
     if (exec->hadException()) {
         if (exception)
@@ -220 +221 @@
         return static_cast<JSCallbackObject*>(jsObject)->getPrivate();
     
-    if (jsObject->inherits(&JSCallbackFunction::info))
-        return static_cast<JSCallbackFunction*>(jsObject)->getPrivate();
-    
-    if (jsObject->inherits(&JSCallbackConstructor::info))
-        return static_cast<JSCallbackConstructor*>(jsObject)->getPrivate();
-    
     return 0;
 }
@@ -238 +233 @@
     }
         
-    if (jsObject->inherits(&JSCallbackFunction::info)) {
-        static_cast<JSCallbackFunction*>(jsObject)->setPrivate(data);
-        return true;
-    }
-        
-    if (jsObject->inherits(&JSCallbackConstructor::info)) {
-        static_cast<JSCallbackConstructor*>(jsObject)->setPrivate(data);
-        return true;
-    }
-    
     return false;
 }

trunk/JavaScriptCore/API/JSObjectRef.h

@@ -387 +387 @@
 @abstract Convenience method for creating a JavaScript function with a given callback as its implementation.
 @param context The execution context to use.
+@param name A JSString containing the function's name. This will be used when converting the function to string. Pass NULL to create an anonymous function.
 @param callAsFunction The JSObjectCallAsFunctionCallback to invoke when the function is called.
 @result A JSObject that is an anonymous function. The object's prototype will be the default function prototype.
 */
-JSObjectRef JSObjectMakeFunction(JSContextRef context, JSObjectCallAsFunctionCallback callAsFunction);
+JSObjectRef JSObjectMakeFunction(JSContextRef context, JSStringRef name, JSObjectCallAsFunctionCallback callAsFunction);
 /*!
 @function
@@ -404 +405 @@
 @abstract Creates a function with a given script as its body.
 @param context The execution context to use.
-@param name A JSString containing the function's name. Pass NULL to create an anonymous function.
+@param name A JSString containing the function's name. This will be used when converting the function to string. Pass NULL to create an anonymous function.
 @param parameterCount An integer count of the number of parameter names in parameterNames.
 @param parameterNames A JSString array containing the names of the function's parameters. Pass NULL if parameterCount is 0.
@@ -501 +502 @@
 @param object A JSObject whose private data you want to get.
 @result A void* that points to the object's private data, if the object has private data, otherwise NULL.
-@discussion JSObjectGetPrivate and JSObjectSetPrivate only work on objects created by JSObjectMake, JSObjectMakeFunction, and JSObjectMakeConstructor.
 */
 void* JSObjectGetPrivate(JSObjectRef object);
@@ -510 +510 @@
 @param object A JSObject whose private data you want to set.
 @param data A void* that points to the object's private data.
-@result true if the set operation succeeds, otherwise false.
-@discussion JSObjectGetPrivate and JSObjectSetPrivate only work on objects created by JSObjectMake, JSObjectMakeFunction, and JSObjectMakeConstructor.
+@result true if the object can store private data, otherwise false.
+@discussion Only custom objects created with a JSClass can store private data.
 */
 bool JSObjectSetPrivate(JSObjectRef object, void* data);

trunk/JavaScriptCore/API/minidom.c

@@ -41 +41 @@
     
     JSStringRef printIString = JSStringCreateWithUTF8CString("print");
-    JSObjectSetProperty(context, globalObject, printIString, JSObjectMakeFunction(context, print), kJSPropertyAttributeNone, NULL);
+    JSObjectSetProperty(context, globalObject, printIString, JSObjectMakeFunction(context, printIString, print), kJSPropertyAttributeNone, NULL);
     JSStringRelease(printIString);
     

trunk/JavaScriptCore/API/testapi.c

@@ -571 +571 @@
 
     JSStringRef print = JSStringCreateWithUTF8CString("print");
-    JSObjectRef printFunction = JSObjectMakeFunction(context, print_callAsFunction);
+    JSObjectRef printFunction = JSObjectMakeFunction(context, print, print_callAsFunction);
     JSObjectSetProperty(context, globalObject, print, printFunction, kJSPropertyAttributeNone, NULL); 
     JSStringRelease(print);
     
-    assert(JSObjectSetPrivate(printFunction, (void*)1));
-    assert(JSObjectGetPrivate(printFunction) == (void*)1);
+    assert(!JSObjectSetPrivate(printFunction, (void*)1));
+    assert(!JSObjectGetPrivate(printFunction));
 
     JSStringRef myConstructorIString = JSStringCreateWithUTF8CString("MyConstructor");
@@ -583 +583 @@
     JSStringRelease(myConstructorIString);
     
-    assert(JSObjectSetPrivate(myConstructor, (void*)1));
-    assert(JSObjectGetPrivate(myConstructor) == (void*)1);
+    assert(!JSObjectSetPrivate(myConstructor, (void*)1));
+    assert(!JSObjectGetPrivate(myConstructor));
     
     o = JSObjectMake(context, NULL, NULL);

trunk/JavaScriptCore/ChangeLog

@@ +1 @@
+2006-07-16  Geoffrey Garen  <ggaren@apple.com>
+
+        Reviewed by Maciej.
+        
+        - Added names to functions.
+        
+        - Removed GetPrivate/SetPrivate from callbackFunctions and callbackConstructors.
+        The private data idiom is that a JS object stores its native implementation
+        as private data. For functions and constructors, the native implementation is nothing
+        more than the callback they already store, so supporting private data, too,
+        confuses the idiom. If you *really* want, you can still create a custom 
+        function with private data.
+
+        * API/JSCallbackConstructor.cpp:
+        * API/JSCallbackConstructor.h:
+        * API/JSCallbackFunction.cpp:
+        (KJS::JSCallbackFunction::JSCallbackFunction):
+        * API/JSCallbackFunction.h:
+        * API/JSCallbackObject.cpp:
+        (KJS::JSCallbackObject::staticFunctionGetter):
+        * API/JSObjectRef.cpp:
+        (JSObjectMakeFunction):
+        (JSObjectMakeFunctionWithBody):
+        (JSObjectGetPrivate):
+        (JSObjectSetPrivate):
+        * API/JSObjectRef.h:
+        * API/minidom.c:
+        (main):
+        * API/testapi.c:
+        (main):
+
 2006-07-15  Maciej Stachowiak  <mjs@apple.com>