DevTools: extract common inspector bindigns code into InspectorWrapper

Source/bindings/core/v8/inspector/V8InjectedScriptHost.cpp

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "config.h"
 #include "bindings/core/v8/inspector/V8InjectedScriptHost.h"
 
 #include "bindings/core/v8/BindingSecurity.h"
 #include "bindings/core/v8/ExceptionState.h"
 #include "bindings/core/v8/ScriptValue.h"
 #include "bindings/core/v8/V8AbstractEventListener.h"
 #include "bindings/core/v8/V8Binding.h"
 #include "bindings/core/v8/V8DOMException.h"
 #include "bindings/core/v8/V8DOMTokenList.h"
 #include "bindings/core/v8/V8Debugger.h"
 #include "bindings/core/v8/V8Event.h"
 #include "bindings/core/v8/V8EventTarget.h"
 #include "bindings/core/v8/V8HTMLAllCollection.h"
 #include "bindings/core/v8/V8HTMLCollection.h"
 #include "bindings/core/v8/V8Node.h"
 #include "bindings/core/v8/V8NodeList.h"
 #include "bindings/core/v8/V8ScriptRunner.h"
+#include "bindings/core/v8/inspector/InspectorWrapper.h"
 #include "core/events/EventTarget.h"
 #include "core/inspector/EventListenerInfo.h"
 #include "core/inspector/InjectedScript.h"
 #include "core/inspector/InjectedScriptHost.h"
 #include "core/inspector/JavaScriptCallFrame.h"
 #include "platform/JSONValues.h"
 #include "wtf/RefPtr.h"
+#include "wtf/StdLibExtras.h"
+#include <algorithm>
 
 namespace blink {
 
 Node* InjectedScriptHost::scriptValueAsNode(ScriptState* scriptState, ScriptValue value)
 {
     ScriptState::Scope scope(scriptState);
     if (!value.isObject() || value.isNull())
         return 0;
     return V8Node::toImpl(v8::Local<v8::Object>::Cast(value.v8Value()));
 }
@@ skipping 22 matching lines @@
 EventTarget* InjectedScriptHost::scriptValueAsEventTarget(ScriptState* scriptState, ScriptValue value)
 {
     ScriptState::Scope scope(scriptState);
     if (value.isNull() || !value.isObject())
         return nullptr;
     return eventTargetFromScriptValue(scriptState->isolate(), value.v8Value());
 }
 
 void V8InjectedScriptHost::clearConsoleMessagesCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
-    InjectedScriptHost* impl = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* impl = V8InjectedScriptHost::unwrap(info.Holder());
     impl->clearConsoleMessages();
 }
 
 void V8InjectedScriptHost::inspectedObjectCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 1)
         return;
 
     if (!info[0]->IsInt32()) {
         V8ThrowException::throwTypeError(info.GetIsolate(), "argument has to be an integer");
         return;
     }
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     InjectedScriptHost::InspectableObject* object = host->inspectedObject(info[0].As<v8::Int32>()->Value());
     v8SetReturnValue(info, object->get(ScriptState::current(info.GetIsolate())).v8Value());
 }
 
 static v8::Local<v8::String> functionDisplayName(v8::Local<v8::Function> function)
 {
     v8::Local<v8::Value> value = function->GetDisplayName();
     if (value->IsString() && v8::Local<v8::String>::Cast(value)->Length())
         return v8::Local<v8::String>::Cast(value);
 
@@ skipping 130 matching lines @@
     location->Set(v8AtomicString(isolate, "scriptId"), v8::Integer::New(isolate, function->ScriptId())->ToString(isolate));
 
     v8::Local<v8::Object> result = v8::Object::New(isolate);
     result->Set(v8AtomicString(isolate, "location"), location);
 
     v8::Local<v8::String> name = functionDisplayName(function);
     result->Set(v8AtomicString(isolate, "functionName"), name.IsEmpty() ? v8AtomicString(isolate, "") : name);
 
     result->Set(v8AtomicString(isolate, "isGenerator"), v8::Boolean::New(isolate, function->IsGeneratorFunction()));
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     V8Debugger& debugger = host->debugger();
     v8::Local<v8::Value> scopes = debugger.functionScopes(function);
     if (!scopes.IsEmpty() && scopes->IsArray())
         result->Set(v8AtomicString(isolate, "rawScopes"), scopes);
 
     v8SetReturnValue(info, result);
 }
 
 void V8InjectedScriptHost::generatorObjectDetailsCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 1 || !info[0]->IsObject())
         return;
 
     v8::Local<v8::Object> object = v8::Local<v8::Object>::Cast(info[0]);
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     V8Debugger& debugger = host->debugger();
     v8SetReturnValue(info, debugger.generatorObjectDetails(object));
 }
 
 void V8InjectedScriptHost::collectionEntriesCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 1 || !info[0]->IsObject())
         return;
 
     v8::Local<v8::Object> object = v8::Local<v8::Object>::Cast(info[0]);
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     V8Debugger& debugger = host->debugger();
     v8SetReturnValue(info, debugger.collectionEntries(object));
 }
 
 void V8InjectedScriptHost::getInternalPropertiesCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 1 || !info[0]->IsObject())
         return;
 
     v8::Local<v8::Object> object = v8::Local<v8::Object>::Cast(info[0]);
@@ skipping 34 matching lines @@
 }
 
 void V8InjectedScriptHost::getEventListenersCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 1)
         return;
 
     EventTarget* target = eventTargetFromScriptValue(info.GetIsolate(), info[0]);
     if (!target)
         return;
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     Vector<EventListenerInfo> listenersArray;
     host->getEventListenersImpl(target, listenersArray);
 
     v8::Local<v8::Object> result = v8::Object::New(info.GetIsolate());
     for (size_t i = 0; i < listenersArray.size(); ++i) {
         v8::Local<v8::Array> listeners = getJSListenerFunctions(info.GetIsolate(), target->executionContext(), listenersArray[i]);
         if (!listeners->Length())
             continue;
         AtomicString eventType = listenersArray[i].eventType;
         result->Set(v8String(info.GetIsolate(), eventType), listeners);
     }
 
     v8SetReturnValue(info, result);
 }
 
 void V8InjectedScriptHost::inspectCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 2)
         return;
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     ScriptState* scriptState = ScriptState::current(info.GetIsolate());
     ScriptValue object(scriptState, info[0]);
     ScriptValue hints(scriptState, info[1]);
     host->inspectImpl(toJSONValue(object), toJSONValue(hints));
 }
 
 void V8InjectedScriptHost::evalCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     v8::Isolate* isolate = info.GetIsolate();
     if (info.Length() < 1) {
@@ skipping 63 matching lines @@
 void V8InjectedScriptHost::setFunctionVariableValueCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 4 || !info[0]->IsFunction() || !info[1]->IsInt32() || !info[2]->IsString())
         return;
 
     v8::Local<v8::Value> functionValue = info[0];
     int scopeIndex = info[1].As<v8::Int32>()->Value();
     String variableName = toCoreStringWithUndefinedOrNullCheck(info[2]);
     v8::Local<v8::Value> newValue = info[3];
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     V8Debugger& debugger = host->debugger();
     v8SetReturnValue(info, debugger.setFunctionVariableValue(functionValue, scopeIndex, variableName, newValue));
 }
 
 static bool getFunctionLocation(const v8::FunctionCallbackInfo<v8::Value>& info, String* scriptId, int* lineNumber, int* columnNumber)
 {
     if (info.Length() < 1 || !info[0]->IsFunction())
         return false;
     v8::Local<v8::Function> function = v8::Local<v8::Function>::Cast(info[0]);
     *lineNumber = function->GetScriptLineNumber();
     *columnNumber = function->GetScriptColumnNumber();
     if (*lineNumber == v8::Function::kLineOffsetNotFound || *columnNumber == v8::Function::kLineOffsetNotFound)
         return false;
     *scriptId = String::number(function->ScriptId());
     return true;
 }
 
 void V8InjectedScriptHost::debugFunctionCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     String scriptId;
     int lineNumber;
     int columnNumber;
     if (!getFunctionLocation(info, &scriptId, &lineNumber, &columnNumber))
         return;
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     host->debugFunction(scriptId, lineNumber, columnNumber);
 }
 
 void V8InjectedScriptHost::undebugFunctionCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     String scriptId;
     int lineNumber;
     int columnNumber;
     if (!getFunctionLocation(info, &scriptId, &lineNumber, &columnNumber))
         return;
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     host->undebugFunction(scriptId, lineNumber, columnNumber);
 }
 
 void V8InjectedScriptHost::monitorFunctionCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     String scriptId;
     int lineNumber;
     int columnNumber;
     if (!getFunctionLocation(info, &scriptId, &lineNumber, &columnNumber))
         return;
 
     v8::Local<v8::Value> name;
     if (info.Length() > 0 && info[0]->IsFunction()) {
         v8::Local<v8::Function> function = v8::Local<v8::Function>::Cast(info[0]);
         name = function->GetName();
         if (!name->IsString() || !v8::Local<v8::String>::Cast(name)->Length())
             name = function->GetInferredName();
     }
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     host->monitorFunction(scriptId, lineNumber, columnNumber, toCoreStringWithUndefinedOrNullCheck(name));
 }
 
 void V8InjectedScriptHost::unmonitorFunctionCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     String scriptId;
     int lineNumber;
     int columnNumber;
     if (!getFunctionLocation(info, &scriptId, &lineNumber, &columnNumber))
         return;
 
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     host->unmonitorFunction(scriptId, lineNumber, columnNumber);
 }
 
 void V8InjectedScriptHost::callFunctionCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 2 || info.Length() > 3 || !info[0]->IsFunction()) {
         ASSERT_NOT_REACHED();
         return;
     }
 
@@ skipping 18 matching lines @@
         if (!arguments->Get(info.GetIsolate()->GetCurrentContext(), v8::Integer::New(info.GetIsolate(), i)).ToLocal(&argv[i]))
             return;
     }
 
     v8::Local<v8::Value> result = function->Call(receiver, argc, argv.get());
     v8SetReturnValue(info, result);
 }
 
 void V8InjectedScriptHost::suppressWarningsAndCallFunctionCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
-    InjectedScriptHost* host = V8InjectedScriptHost::toImpl(info.Holder());
+    InjectedScriptHost* host = V8InjectedScriptHost::unwrap(info.Holder());
     host->client()->muteWarningsAndDeprecations();
 
     callFunctionCallback(info);
 
     host->client()->unmuteWarningsAndDeprecations();
 }
 
 void V8InjectedScriptHost::setNonEnumPropertyCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
 {
     if (info.Length() < 3 || !info[0]->IsObject() || !info[1]->IsString())
@@ skipping 38 matching lines @@
     if (!injectedScriptNative)
         return;
     int id = info[0].As<v8::Int32>()->Value();
     String groupName = injectedScriptNative->groupName(id);
     if (!groupName.isEmpty())
         info.GetReturnValue().Set(v8String(info.GetIsolate(), groupName));
 }
 
 namespace {
 
-struct V8MethodConfiguration {
-    const char* name;
-    v8::FunctionCallback callback;
-};
+char hiddenPropertyName[] = "v8inspector::InjectedScriptHost";
+char className[] = "V8InjectedScriptHost";
+using InjectedScriptHostWrapper = InspectorWrapper<InjectedScriptHost, hiddenPropertyName, className>;
 
-const V8MethodConfiguration V8InjectedScriptHostMethods[] = {
+const InjectedScriptHostWrapper::V8MethodConfiguration V8InjectedScriptHostMethods[] = {
     {"clearConsoleMessages", V8InjectedScriptHost::clearConsoleMessagesCallback},
     {"inspect", V8InjectedScriptHost::inspectCallback},
     {"inspectedObject", V8InjectedScriptHost::inspectedObjectCallback},
     {"internalConstructorName", V8InjectedScriptHost::internalConstructorNameCallback},
     {"isDOMWrapper", V8InjectedScriptHost::isDOMWrapperCallback},
     {"isHTMLAllCollection", V8InjectedScriptHost::isHTMLAllCollectionCallback},
     {"isTypedArray", V8InjectedScriptHost::isTypedArrayCallback},
     {"subtype", V8InjectedScriptHost::subtypeCallback},
     {"functionDetails", V8InjectedScriptHost::functionDetailsCallback},
     {"generatorObjectDetails", V8InjectedScriptHost::generatorObjectDetailsCallback},
     {"collectionEntries", V8InjectedScriptHost::collectionEntriesCallback},
     {"getInternalProperties", V8InjectedScriptHost::getInternalPropertiesCallback},
     {"getEventListeners", V8InjectedScriptHost::getEventListenersCallback},
     {"eval", V8InjectedScriptHost::evalCallback},
     {"evaluateWithExceptionDetails", V8InjectedScriptHost::evaluateWithExceptionDetailsCallback},
     {"debugFunction", V8InjectedScriptHost::debugFunctionCallback},
     {"undebugFunction", V8InjectedScriptHost::undebugFunctionCallback},
     {"monitorFunction", V8InjectedScriptHost::monitorFunctionCallback},
     {"unmonitorFunction", V8InjectedScriptHost::unmonitorFunctionCallback},
     {"callFunction", V8InjectedScriptHost::callFunctionCallback},
     {"suppressWarningsAndCallFunction", V8InjectedScriptHost::suppressWarningsAndCallFunctionCallback},
     {"setNonEnumProperty", V8InjectedScriptHost::setNonEnumPropertyCallback},
     {"setFunctionVariableValue", V8InjectedScriptHost::setFunctionVariableValueCallback},
     {"bind", V8InjectedScriptHost::bindCallback},
     {"objectForId", V8InjectedScriptHost::objectForIdCallback},
     {"idToObjectGroupName", V8InjectedScriptHost::idToObjectGroupNameCallback},
 };
 
-class WeakCallbackData final {
-public:
-    WeakCallbackData(v8::Isolate* isolate, PassRefPtrWillBeRawPtr<InjectedScriptHost> host, v8::Local<v8::Object> wrapper)
-        : m_host(host)
-        , m_persistent(isolate, wrapper)
-    {
-        m_persistent.SetWeak(this, &WeakCallbackData::weakCallback, v8::WeakCallbackType::kParameter);
-    }
-
-    // If kept as a strong Persistent<>, this back reference causes an Oilpan leak by
-    // way of v8. Sidestep by using a raw pointer; InjectedScriptHost is slated to
-    // become a non-Oilpan object.
-    GC_PLUGIN_IGNORE("466631")
-    RefPtrWillBeRawPtr<InjectedScriptHost> m_host;
-
-private:
-    static void weakCallback(const v8::WeakCallbackInfo<WeakCallbackData>& info)
-    {
-        delete info.GetParameter();
-    }
-
-    v8::Global<v8::Object> m_persistent;
-};
-
 } // namespace
 
 v8::Local<v8::FunctionTemplate> V8InjectedScriptHost::createWrapperTemplate(v8::Isolate* isolate)
 {
-    v8::Local<v8::FunctionTemplate> functionTemplate = v8::FunctionTemplate::New(isolate);
-
-    functionTemplate->SetClassName(v8::String::NewFromUtf8(isolate, "InjectedScriptHost", v8::NewStringType::kInternalized).ToLocalChecked());
-    v8::Local<v8::ObjectTemplate> instanceTemplate = functionTemplate->InstanceTemplate();
-
-    for (auto& config : V8InjectedScriptHostMethods) {
-        v8::Local<v8::Name> v8name = v8::String::NewFromUtf8(isolate, config.name, v8::NewStringType::kInternalized).ToLocalChecked();
-        v8::Local<v8::FunctionTemplate> functionTemplate = v8::FunctionTemplate::New(isolate, config.callback);
-        functionTemplate->RemovePrototype();
-        instanceTemplate->Set(v8name, functionTemplate, static_cast<v8::PropertyAttribute>(v8::DontDelete | v8::DontEnum | v8::ReadOnly));
-    }
-
-    return functionTemplate;
+    Vector<InspectorWrapperBase::V8MethodConfiguration> methods(WTF_ARRAY_LENGTH(V8InjectedScriptHostMethods));
+    std::copy(V8InjectedScriptHostMethods, V8InjectedScriptHostMethods + WTF_ARRAY_LENGTH(V8InjectedScriptHostMethods), methods.begin());
+    Vector<InspectorWrapperBase::V8AttributeConfiguration> attributes;
+    return InjectedScriptHostWrapper::createWrapperTemplate(isolate, methods, attributes);
 }
 
-v8::Local<v8::Object> V8InjectedScriptHost::wrap(v8::Isolate* isolate, v8::Local<v8::FunctionTemplate> constructorTemplate, PassRefPtrWillBeRawPtr<InjectedScriptHost> host)
+v8::Local<v8::Object> V8InjectedScriptHost::wrap(v8::Local<v8::FunctionTemplate> constructorTemplate, v8::Local<v8::Context> context, PassRefPtrWillBeRawPtr<InjectedScriptHost> host)
 {
-    RefPtrWillBeRawPtr<InjectedScriptHost> impl(host);
-    v8::Local<v8::Function> function;
-    if (!constructorTemplate->GetFunction(isolate->GetCurrentContext()).ToLocal(&function))
-        return v8::Local<v8::Object>();
-
-    // FIXME: don't depend on V8ScriptRunner
-    v8::MaybeLocal<v8::Object> maybeResult = V8ScriptRunner::instantiateObject(isolate, function);
-    v8::Local<v8::Object> result;
-    if (!maybeResult.ToLocal(&result))
-        return v8::Local<v8::Object>();
-
-    v8::Local<v8::External> objectReference = v8::External::New(isolate, new WeakCallbackData(isolate, impl, result));
-    result->SetHiddenValue(hiddenPropertyName(isolate), objectReference);
-
-    return result;
+    return InjectedScriptHostWrapper::wrap(constructorTemplate, context, host);
 }
 
-InjectedScriptHost* V8InjectedScriptHost::toImpl(v8::Local<v8::Object> object)
+InjectedScriptHost* V8InjectedScriptHost::unwrap(v8::Local<v8::Object> object)
 {
-    v8::Isolate* isolate = object->GetIsolate();
-    v8::Local<v8::Value> value = object->GetHiddenValue(hiddenPropertyName(isolate));
-    if (value.IsEmpty())
-        return nullptr;
-    if (!value->IsExternal())
-        return nullptr;
-    void* data = value.As<v8::External>()->Value();
-    return reinterpret_cast<WeakCallbackData*>(data)->m_host.get();
-}
-
-v8::Local<v8::String> V8InjectedScriptHost::hiddenPropertyName(v8::Isolate* isolate)
-{
-    return v8::String::NewFromUtf8(isolate, "v8inspector::InjectedScriptHost", v8::NewStringType::kInternalized).ToLocalChecked();
+    return InjectedScriptHostWrapper::unwrap(object);
 }
 
 } // namespace blink