bindings: Supports conditionally-enabled accessors.

Source/bindings/core/v8/V8DOMConfiguration.cpp

 /*
  * Copyright (C) 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
@@ skipping 19 matching lines @@
 #include "bindings/core/v8/V8DOMConfiguration.h"
 
 #include "bindings/core/v8/V8ObjectConstructor.h"
 #include "platform/TraceEvent.h"
 
 namespace blink {
 
 namespace {
 
 template<class ObjectOrTemplate>
-void installAttributeInternal(v8::Isolate* isolate, v8::Handle<ObjectOrTemplate> instanceTemplate, v8::Handle<ObjectOrTemplate> prototype, const V8DOMConfiguration::AttributeConfiguration& attribute, const DOMWrapperWorld& world)
+void installAttributeInternal(v8::Isolate* isolate, v8::Handle<ObjectOrTemplate> instanceOrTemplate, v8::Handle<ObjectOrTemplate> prototypeOrTemplate, const V8DOMConfiguration::AttributeConfiguration& attribute, const DOMWrapperWorld& world)

[haraken, 2015/02/28 15:14:00]

Not related to your CL, I'm not sure why we need to support Handle<Object> (I
guess Handle<ObjectTemplate> would be enough).

[Yuki, 2015/03/03 07:11:46]

Let me try if we can get rid of non-ObjectTemplate version.

 {
     if (attribute.exposeConfiguration == V8DOMConfiguration::OnlyExposedToPrivateScript
         && !world.isPrivateScriptIsolatedWorld())
         return;
 
     v8::AccessorGetterCallback getter = attribute.getter;
     v8::AccessorSetterCallback setter = attribute.setter;
     if (world.isMainWorld()) {
         if (attribute.getterForMainWorld)
             getter = attribute.getterForMainWorld;
         if (attribute.setterForMainWorld)
             setter = attribute.setterForMainWorld;
     }
     v8::Handle<ObjectOrTemplate> target =
         attribute.instanceOrPrototypeConfiguration == V8DOMConfiguration::OnPrototype ?
-        prototype :
-        instanceTemplate;
+        prototypeOrTemplate :
+        instanceOrTemplate;
     target->SetAccessor(
         v8AtomicString(isolate, attribute.name),
         getter,
         setter,
         v8::External::New(isolate, const_cast<WrapperTypeInfo*>(attribute.data)),
         attribute.settings,
         attribute.attribute);
 }
 
-void installAccessorInternal(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototype, v8::Handle<v8::Signature> signature, const V8DOMConfiguration::AccessorConfiguration& accessor, const DOMWrapperWorld& world)
+v8::Local<v8::FunctionTemplate> functionOrTemplate(v8::Isolate* isolate, v8::FunctionCallback callback, const WrapperTypeInfo* wrapperTypeInfo, v8::Local<v8::Signature> signature, v8::Handle<v8::ObjectTemplate> prototypeTemplateForOverloadResolution)

[haraken, 2015/02/28 15:14:00]

What's the point of calling this method function"Or"Template? This method
returns functionTemplate.

[bashi, 2015/03/02 03:00:08]

It seems that |prototypeTemplateForOverloadResolution| is not used. Are you
going to use this parameter in a follow-up CL?

[Yuki, 2015/03/03 07:11:47]

It's a trick.

We have two V8 APIs which take different parameter types.
v8::Object::SetAccessorProperty(v8::Function, ...)
v8::ObjectTemplate::SetAccessorProperty(v8::FunctionTemplate, ...)

So when ObjectTemplate is used, we want FunctionTemplate.  When Obejct is used,
we want Function.  functionOrTemplate returns a Function or a FunctionTemplate
depending on whether Object or ObjectTemplate is used.  With this trick, we can
simply write

    prototypeOrTemplate->SetAccessorProperty(
        functionOrTemplate(getterCallback),
        functionOrTemplate(setterCallback));

See line 98.

Anyway, I try to get rid of v8::Object version.

+{
+    v8::Local<v8::FunctionTemplate> functionTemplate;
+    if (callback) {
+        functionTemplate = v8::FunctionTemplate::New(isolate, callback, v8::External::New(isolate, const_cast<WrapperTypeInfo*>(wrapperTypeInfo)), signature);
+        if (!functionTemplate.IsEmpty())
+            functionTemplate->RemovePrototype();
+    }
+    return functionTemplate;
+}
+
+v8::Local<v8::Function> functionOrTemplate(v8::Isolate* isolate, v8::FunctionCallback callback, const WrapperTypeInfo*, v8::Local<v8::Signature>, v8::Handle<v8::Object> prototypeForOverloadResolution)

[haraken, 2015/02/28 15:14:00]

Ditto.

+{
+    return callback ? v8::Function::New(isolate, callback) : v8::Local<v8::Function>();
+}
+
+template<class ObjectOrTemplate>
+void installAccessorInternal(v8::Isolate* isolate, v8::Handle<ObjectOrTemplate> prototypeOrTemplate, v8::Handle<v8::Signature> signature, const V8DOMConfiguration::AccessorConfiguration& accessor, const DOMWrapperWorld& world)
 {
     if (accessor.exposeConfiguration == V8DOMConfiguration::OnlyExposedToPrivateScript
         && !world.isPrivateScriptIsolatedWorld())
         return;
 
     v8::FunctionCallback getterCallback = accessor.getter;
     v8::FunctionCallback setterCallback = accessor.setter;
     if (world.isMainWorld()) {
         if (accessor.getterForMainWorld)
             getterCallback = accessor.getterForMainWorld;
         if (accessor.setterForMainWorld)
             setterCallback = accessor.setterForMainWorld;
     }
-    v8::Local<v8::FunctionTemplate> getter;
-    if (getterCallback) {
-        getter = v8::FunctionTemplate::New(isolate, getterCallback, v8::External::New(isolate, const_cast<WrapperTypeInfo*>(accessor.data)), signature, 0);
-        getter->RemovePrototype();
-    }
-    v8::Local<v8::FunctionTemplate> setter;
-    if (setterCallback) {
-        setter = v8::FunctionTemplate::New(isolate, setterCallback, v8::External::New(isolate, const_cast<WrapperTypeInfo*>(accessor.data)), signature, 1);
-        setter->RemovePrototype();
-    }
-    prototype->SetAccessorProperty(
+    prototypeOrTemplate->SetAccessorProperty(
         v8AtomicString(isolate, accessor.name),
-        getter,
-        setter,
+        functionOrTemplate(isolate, getterCallback, accessor.data, signature, prototypeOrTemplate),
+        functionOrTemplate(isolate, setterCallback, accessor.data, signature, prototypeOrTemplate),
         accessor.attribute,
         accessor.settings);
 }
 
-void installConstantInternal(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::ObjectTemplate> prototype, const V8DOMConfiguration::ConstantConfiguration& constant)
+void installConstantInternal(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::ObjectTemplate> prototypeTemplate, const V8DOMConfiguration::ConstantConfiguration& constant)
 {
     v8::Handle<v8::String> constantName = v8AtomicString(isolate, constant.name);
     v8::PropertyAttribute attributes =
         static_cast<v8::PropertyAttribute>(v8::ReadOnly | v8::DontDelete);
     v8::Handle<v8::Primitive> value;
     switch (constant.type) {
     case V8DOMConfiguration::ConstantTypeShort:
     case V8DOMConfiguration::ConstantTypeLong:
     case V8DOMConfiguration::ConstantTypeUnsignedShort:
         value = v8::Integer::New(isolate, constant.ivalue);
         break;
     case V8DOMConfiguration::ConstantTypeUnsignedLong:
         value = v8::Integer::NewFromUnsigned(isolate, constant.ivalue);
         break;
     case V8DOMConfiguration::ConstantTypeFloat:
     case V8DOMConfiguration::ConstantTypeDouble:
         value = v8::Number::New(isolate, constant.dvalue);
         break;
     case V8DOMConfiguration::ConstantTypeString:
         value = v8::String::NewFromUtf8(isolate, constant.svalue);
         break;
     default:
         ASSERT_NOT_REACHED();
     }
     functionDescriptor->Set(constantName, value, attributes);
-    prototype->Set(constantName, value, attributes);
+    prototypeTemplate->Set(constantName, value, attributes);
 }
 
 void doInstallMethodInternal(v8::Handle<v8::ObjectTemplate> target, v8::Handle<v8::Name> name, v8::Handle<v8::FunctionTemplate> functionTemplate, v8::PropertyAttribute attribute)
 {
     target->Set(name, functionTemplate, attribute);
 }
 
 void doInstallMethodInternal(v8::Handle<v8::FunctionTemplate> target, v8::Handle<v8::Name> name, v8::Handle<v8::FunctionTemplate> functionTemplate, v8::PropertyAttribute attribute)
 {
     target->Set(name, functionTemplate, attribute);
 }
 
 template<class ObjectOrTemplate, class Configuration>
 void installMethodInternal(v8::Isolate* isolate, v8::Handle<ObjectOrTemplate> objectOrTemplate, v8::Handle<v8::Signature> signature, v8::PropertyAttribute attribute, const Configuration& callback, const DOMWrapperWorld& world)
 {
     if (callback.exposeConfiguration == V8DOMConfiguration::OnlyExposedToPrivateScript
         && !world.isPrivateScriptIsolatedWorld())
         return;
 
     v8::Local<v8::FunctionTemplate> functionTemplate = v8::FunctionTemplate::New(isolate, callback.callbackForWorld(world), v8Undefined(), signature, callback.length);
     functionTemplate->RemovePrototype();
     doInstallMethodInternal(objectOrTemplate, callback.methodName(isolate), functionTemplate, attribute);
 }
 
 } // namespace
 
-void V8DOMConfiguration::installAttributes(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> instanceTemplate, v8::Handle<v8::ObjectTemplate> prototype, const AttributeConfiguration* attributes, size_t attributeCount)
+void V8DOMConfiguration::installAttributes(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> instanceTemplate, v8::Handle<v8::ObjectTemplate> prototypeTemplate, const AttributeConfiguration* attributes, size_t attributeCount)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
     for (size_t i = 0; i < attributeCount; ++i)
-        installAttributeInternal(isolate, instanceTemplate, prototype, attributes[i], world);
+        installAttributeInternal(isolate, instanceTemplate, prototypeTemplate, attributes[i], world);
 }
 
-void V8DOMConfiguration::installAttribute(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> instanceTemplate, v8::Handle<v8::ObjectTemplate> prototype, const AttributeConfiguration& attribute)
+void V8DOMConfiguration::installAttribute(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> instanceTemplate, v8::Handle<v8::ObjectTemplate> prototypeTemplate, const AttributeConfiguration& attribute)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
-    installAttributeInternal(isolate, instanceTemplate, prototype, attribute, world);
+    installAttributeInternal(isolate, instanceTemplate, prototypeTemplate, attribute, world);
 }
 
-void V8DOMConfiguration::installAttribute(v8::Isolate* isolate, v8::Handle<v8::Object> instanceTemplate, v8::Handle<v8::Object> prototype, const AttributeConfiguration& attribute)
+void V8DOMConfiguration::installAttribute(v8::Isolate* isolate, v8::Handle<v8::Object> instance, v8::Handle<v8::Object> prototype, const AttributeConfiguration& attribute)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
-    installAttributeInternal(isolate, instanceTemplate, prototype, attribute, world);
+    installAttributeInternal(isolate, instance, prototype, attribute, world);
 }
 
-void V8DOMConfiguration::installAccessors(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototype, v8::Handle<v8::Signature> signature, const AccessorConfiguration* accessors, size_t accessorCount)
+void V8DOMConfiguration::installAccessors(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototypeTemplate, v8::Handle<v8::Signature> signature, const AccessorConfiguration* accessors, size_t accessorCount)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
     for (size_t i = 0; i < accessorCount; ++i)
-        installAccessorInternal(isolate, prototype, signature, accessors[i], world);
+        installAccessorInternal(isolate, prototypeTemplate, signature, accessors[i], world);
 }
 
-void V8DOMConfiguration::installAccessor(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototype, v8::Handle<v8::Signature> signature, const AccessorConfiguration& accessor)
+void V8DOMConfiguration::installAccessor(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototypeTemplate, v8::Handle<v8::Signature> signature, const AccessorConfiguration& accessor)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
-    installAccessorInternal(isolate, prototype, signature, accessor, world);
+    installAccessorInternal(isolate, prototypeTemplate, signature, accessor, world);
 }
 
-void V8DOMConfiguration::installConstants(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::ObjectTemplate> prototype, const ConstantConfiguration* constants, size_t constantCount)
+void V8DOMConfiguration::installAccessor(v8::Isolate* isolate, v8::Handle<v8::Object> prototype, const AccessorConfiguration& accessor)
+{
+    const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
+    installAccessorInternal(isolate, prototype, v8::Handle<v8::Signature>(), accessor, world);
+}
+
+void V8DOMConfiguration::installConstants(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::ObjectTemplate> prototypeTemplate, const ConstantConfiguration* constants, size_t constantCount)
 {
     for (size_t i = 0; i < constantCount; ++i)
-        installConstantInternal(isolate, functionDescriptor, prototype, constants[i]);
+        installConstantInternal(isolate, functionDescriptor, prototypeTemplate, constants[i]);
 }
 
-void V8DOMConfiguration::installConstant(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::ObjectTemplate> prototype, const ConstantConfiguration& constant)
+void V8DOMConfiguration::installConstant(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::ObjectTemplate> prototypeTemplate, const ConstantConfiguration& constant)
 {
-    installConstantInternal(isolate, functionDescriptor, prototype, constant);
+    installConstantInternal(isolate, functionDescriptor, prototypeTemplate, constant);
 }
 
-void V8DOMConfiguration::installConstantWithGetter(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::ObjectTemplate> prototype, const char* name, v8::AccessorGetterCallback getter)
+void V8DOMConfiguration::installConstantWithGetter(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::ObjectTemplate> prototypeTemplate, const char* name, v8::AccessorGetterCallback getter)
 {
     v8::Handle<v8::String> constantName = v8AtomicString(isolate, name);
     v8::PropertyAttribute attributes =
         static_cast<v8::PropertyAttribute>(v8::ReadOnly | v8::DontDelete);
     functionDescriptor->SetNativeDataProperty(constantName, getter, 0, v8::Handle<v8::Value>(), attributes);
-    prototype->SetNativeDataProperty(constantName, getter, 0, v8::Handle<v8::Value>(), attributes);
+    prototypeTemplate->SetNativeDataProperty(constantName, getter, 0, v8::Handle<v8::Value>(), attributes);
 }
 
-void V8DOMConfiguration::installMethods(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototype, v8::Handle<v8::Signature> signature, v8::PropertyAttribute attribute, const MethodConfiguration* callbacks, size_t callbackCount)
+void V8DOMConfiguration::installMethods(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototypeTemplate, v8::Handle<v8::Signature> signature, v8::PropertyAttribute attribute, const MethodConfiguration* callbacks, size_t callbackCount)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
     for (size_t i = 0; i < callbackCount; ++i)
-        installMethodInternal(isolate, prototype, signature, attribute, callbacks[i], world);
+        installMethodInternal(isolate, prototypeTemplate, signature, attribute, callbacks[i], world);
 }
 
 void V8DOMConfiguration::installMethod(v8::Isolate* isolate, v8::Handle<v8::FunctionTemplate> functionDescriptor, v8::Handle<v8::Signature> signature, v8::PropertyAttribute attribute, const MethodConfiguration& callback)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
     installMethodInternal(isolate, functionDescriptor, signature, attribute, callback, world);
 }
 
-void V8DOMConfiguration::installMethod(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototype, v8::Handle<v8::Signature> signature, v8::PropertyAttribute attribute, const MethodConfiguration& callback)
+void V8DOMConfiguration::installMethod(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototypeTemplate, v8::Handle<v8::Signature> signature, v8::PropertyAttribute attribute, const MethodConfiguration& callback)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
-    installMethodInternal(isolate, prototype, signature, attribute, callback, world);
+    installMethodInternal(isolate, prototypeTemplate, signature, attribute, callback, world);
 }
 
-void V8DOMConfiguration::installMethod(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototype, v8::Handle<v8::Signature> signature, v8::PropertyAttribute attribute, const SymbolKeyedMethodConfiguration& callback)
+void V8DOMConfiguration::installMethod(v8::Isolate* isolate, v8::Handle<v8::ObjectTemplate> prototypeTemplate, v8::Handle<v8::Signature> signature, v8::PropertyAttribute attribute, const SymbolKeyedMethodConfiguration& callback)
 {
     const DOMWrapperWorld& world = DOMWrapperWorld::current(isolate);
-    installMethodInternal(isolate, prototype, signature, attribute, callback, world);
+    installMethodInternal(isolate, prototypeTemplate, signature, attribute, callback, world);
 }
 
 v8::Local<v8::Signature> V8DOMConfiguration::installDOMClassTemplate(v8::Isolate* isolate, v8::Local<v8::FunctionTemplate> functionDescriptor, const char* interfaceName, v8::Handle<v8::FunctionTemplate> parentClass, size_t fieldCount,
     const AttributeConfiguration* attributes, size_t attributeCount,
     const AccessorConfiguration* accessors, size_t accessorCount,
     const MethodConfiguration* callbacks, size_t callbackCount)
 {
     functionDescriptor->SetClassName(v8AtomicString(isolate, interfaceName));
     v8::Local<v8::ObjectTemplate> instanceTemplate = functionDescriptor->InstanceTemplate();
+    v8::Local<v8::ObjectTemplate> prototypeTemplate = functionDescriptor->PrototypeTemplate();
     instanceTemplate->SetInternalFieldCount(fieldCount);
     if (!parentClass.IsEmpty()) {
         functionDescriptor->Inherit(parentClass);
         // Marks the prototype object as one of native-backed objects.
         // This is needed since bug 110436 asks WebKit to tell native-initiated prototypes from pure-JS ones.
         // This doesn't mark kinds "root" classes like Node, where setting this changes prototype chain structure.
-        v8::Local<v8::ObjectTemplate> prototype = functionDescriptor->PrototypeTemplate();
-        prototype->SetInternalFieldCount(v8PrototypeInternalFieldcount);
+        prototypeTemplate->SetInternalFieldCount(v8PrototypeInternalFieldcount);
     }
 
     v8::Local<v8::Signature> defaultSignature = v8::Signature::New(isolate, functionDescriptor);
     if (attributeCount)
-        installAttributes(isolate, instanceTemplate, functionDescriptor->PrototypeTemplate(), attributes, attributeCount);
+        installAttributes(isolate, instanceTemplate, prototypeTemplate, attributes, attributeCount);
     if (accessorCount)
-        installAccessors(isolate, functionDescriptor->PrototypeTemplate(), defaultSignature, accessors, accessorCount);
+        installAccessors(isolate, prototypeTemplate, defaultSignature, accessors, accessorCount);
     if (callbackCount)
-        installMethods(isolate, functionDescriptor->PrototypeTemplate(), defaultSignature, static_cast<v8::PropertyAttribute>(v8::None), callbacks, callbackCount);
+        installMethods(isolate, prototypeTemplate, defaultSignature, static_cast<v8::PropertyAttribute>(v8::None), callbacks, callbackCount);
     return defaultSignature;
 }
 
 v8::Handle<v8::FunctionTemplate> V8DOMConfiguration::domClassTemplate(v8::Isolate* isolate, WrapperTypeInfo* wrapperTypeInfo, void (*configureDOMClassTemplate)(v8::Local<v8::FunctionTemplate>, v8::Isolate*))
 {
     V8PerIsolateData* data = V8PerIsolateData::from(isolate);
     v8::Local<v8::FunctionTemplate> result = data->existingDOMTemplate(wrapperTypeInfo);
     if (!result.IsEmpty())
         return result;
 
     TRACE_EVENT_SCOPED_SAMPLING_STATE("blink", "BuildDOMTemplate");
     result = v8::FunctionTemplate::New(isolate, V8ObjectConstructor::isValidConstructorMode);
     configureDOMClassTemplate(result, isolate);
     data->setDOMTemplate(wrapperTypeInfo, result);
     return result;
 }
 
 } // namespace blink