// Copyright (c) 2015 GitHub, Inc. All rights reserved. // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. #ifndef SHELL_COMMON_NATIVE_MATE_CONVERTERS_CALLBACK_H_ #define SHELL_COMMON_NATIVE_MATE_CONVERTERS_CALLBACK_H_ #include <utility> #include <vector> #include "base/bind.h" #include "base/callback.h" #include "base/memory/weak_ptr.h" #include "base/message_loop/message_loop.h" #include "native_mate/function_template.h" #include "native_mate/scoped_persistent.h" #include "shell/common/api/locker.h" namespace mate { namespace internal { template <typename T> class RefCountedGlobal; // Manages the V8 function with RAII. class SafeV8Function { public: SafeV8Function(v8::Isolate* isolate, v8::Local<v8::Value> value); SafeV8Function(const SafeV8Function& other); ~SafeV8Function(); bool IsAlive() const; v8::Local<v8::Function> NewHandle(v8::Isolate* isolate) const; private: scoped_refptr<RefCountedGlobal<v8::Function>> v8_function_; }; // Helper to invoke a V8 function with C++ parameters. template <typename Sig> struct V8FunctionInvoker {}; template <typename... ArgTypes> struct V8FunctionInvoker<v8::Local<v8::Value>(ArgTypes...)> { static v8::Local<v8::Value> Go(v8::Isolate* isolate, const SafeV8Function& function, ArgTypes... raw) { Locker locker(isolate); v8::EscapableHandleScope handle_scope(isolate); if (!function.IsAlive()) return v8::Null(isolate); v8::MicrotasksScope script_scope(isolate, v8::MicrotasksScope::kRunMicrotasks); v8::Local<v8::Function> holder = function.NewHandle(isolate); v8::Local<v8::Context> context = holder->CreationContext(); v8::Context::Scope context_scope(context); std::vector<v8::Local<v8::Value>> args{ ConvertToV8(isolate, std::forward<ArgTypes>(raw))...}; v8::MaybeLocal<v8::Value> ret = holder->Call( context, holder, args.size(), args.empty() ? nullptr : &args.front()); if (ret.IsEmpty()) return v8::Undefined(isolate); else return handle_scope.Escape(ret.ToLocalChecked()); } }; template <typename... ArgTypes> struct V8FunctionInvoker<void(ArgTypes...)> { static void Go(v8::Isolate* isolate, const SafeV8Function& function, ArgTypes... raw) { Locker locker(isolate); v8::HandleScope handle_scope(isolate); if (!function.IsAlive()) return; v8::MicrotasksScope script_scope(isolate, v8::MicrotasksScope::kRunMicrotasks); v8::Local<v8::Function> holder = function.NewHandle(isolate); v8::Local<v8::Context> context = holder->CreationContext(); v8::Context::Scope context_scope(context); std::vector<v8::Local<v8::Value>> args{ ConvertToV8(isolate, std::forward<ArgTypes>(raw))...}; holder ->Call(context, holder, args.size(), args.empty() ? nullptr : &args.front()) .IsEmpty(); } }; template <typename ReturnType, typename... ArgTypes> struct V8FunctionInvoker<ReturnType(ArgTypes...)> { static ReturnType Go(v8::Isolate* isolate, const SafeV8Function& function, ArgTypes... raw) { Locker locker(isolate); v8::HandleScope handle_scope(isolate); ReturnType ret = ReturnType(); if (!function.IsAlive()) return ret; v8::MicrotasksScope script_scope(isolate, v8::MicrotasksScope::kRunMicrotasks); v8::Local<v8::Function> holder = function.NewHandle(isolate); v8::Local<v8::Context> context = holder->CreationContext(); v8::Context::Scope context_scope(context); std::vector<v8::Local<v8::Value>> args{ ConvertToV8(isolate, std::forward<ArgTypes>(raw))...}; v8::Local<v8::Value> result; auto maybe_result = holder->Call(context, holder, args.size(), args.empty() ? nullptr : &args.front()); if (maybe_result.ToLocal(&result)) Converter<ReturnType>::FromV8(isolate, result, &ret); return ret; } }; // Helper to pass a C++ funtion to JavaScript. using Translater = base::Callback<void(Arguments* args)>; v8::Local<v8::Value> CreateFunctionFromTranslater(v8::Isolate* isolate, const Translater& translater, bool one_time); v8::Local<v8::Value> BindFunctionWith(v8::Isolate* isolate, v8::Local<v8::Context> context, v8::Local<v8::Function> func, v8::Local<v8::Value> arg1, v8::Local<v8::Value> arg2); // Calls callback with Arguments. template <typename Sig> struct NativeFunctionInvoker {}; template <typename ReturnType, typename... ArgTypes> struct NativeFunctionInvoker<ReturnType(ArgTypes...)> { static void Go(base::Callback<ReturnType(ArgTypes...)> val, Arguments* args) { using Indices = typename IndicesGenerator<sizeof...(ArgTypes)>::type; Invoker<Indices, ArgTypes...> invoker(args, 0); if (invoker.IsOK()) invoker.DispatchToCallback(val); } }; } // namespace internal template <typename Sig> struct Converter<base::RepeatingCallback<Sig>> { static v8::Local<v8::Value> ToV8(v8::Isolate* isolate, const base::RepeatingCallback<Sig>& val) { // We don't use CreateFunctionTemplate here because it creates a new // FunctionTemplate everytime, which is cached by V8 and causes leaks. internal::Translater translater = base::Bind(&internal::NativeFunctionInvoker<Sig>::Go, val); // To avoid memory leak, we ensure that the callback can only be called // for once. return internal::CreateFunctionFromTranslater(isolate, translater, true); } static bool FromV8(v8::Isolate* isolate, v8::Local<v8::Value> val, base::RepeatingCallback<Sig>* out) { if (!val->IsFunction()) return false; *out = base::BindRepeating(&internal::V8FunctionInvoker<Sig>::Go, isolate, internal::SafeV8Function(isolate, val)); return true; } }; // Convert a callback to V8 without the call number limitation, this can easily // cause memory leaks so use it with caution. template <typename Sig> v8::Local<v8::Value> CallbackToV8(v8::Isolate* isolate, const base::Callback<Sig>& val) { internal::Translater translater = base::Bind(&internal::NativeFunctionInvoker<Sig>::Go, val); return internal::CreateFunctionFromTranslater(isolate, translater, false); } } // namespace mate #endif // SHELL_COMMON_NATIVE_MATE_CONVERTERS_CALLBACK_H_