electron/shell/common/gin_helper/event_emitter.h

108 lines
3.6 KiB
C
Raw Normal View History

// Copyright (c) 2019 GitHub, Inc.
2014-04-25 09:49:37 +00:00
// Use of this source code is governed by the MIT license that can be
// found in the LICENSE file.
#ifndef SHELL_COMMON_GIN_HELPER_EVENT_EMITTER_H_
#define SHELL_COMMON_GIN_HELPER_EVENT_EMITTER_H_
refactor: use mojo for electron internal IPC (#17406) * refactor: use mojo for electron internal IPC * add sender_id, drop MessageSync * remove usages of AtomFrameMsg_Message * iwyu * first draft of renderer->browser direction * refactor to reuse a single ipc interface * implement TakeHeapSnapshot through mojo * the rest of the owl^WtakeHeapSnapshot mojofication * remove no-op overrides in AtomRendererClient * delete renderer-side ElectronApiServiceImpl when its pipe is destroyed * looks like we don't need to overlay the renderer manifest after all * don't try to send 2 replies to a sync rpc * undo changes to manifests.cc * unify sandboxed + unsandboxed ipc events * lint * register ElectronBrowser mojo service on devtools WebContents * fix takeHeapSnapshopt failure paths * {electron_api => atom}::mojom * add send_to_all to ElectronRenderer::Message * keep interface alive until callback is called * review comments * use GetContext from RendererClientBase * robustify a test that uses window.open * MessageSync posts a task to put sync messages in the same queue as async ones * add v8::MicrotasksScope and node::CallbackScope * iwyu * use weakptr to api::WebContents instead of Unretained * make MessageSync an asynchronous message & use non-associated interface * iwyu + comments * remove unused WeakPtrFactory * inline OnRendererMessage[Sync] * cleanups & comments * use helper methods instead of inline lambdas * remove unneeded async in test * add mojo to manifests deps * add gn check for //electron/manifests and mojo * don't register renderer side service until preload has been run * update gn check targets list * move interface registration back to RenderFrameCreated
2019-04-02 22:38:16 +00:00
#include <utility>
#include <vector>
refactor: use mojo for electron internal IPC (#17406) * refactor: use mojo for electron internal IPC * add sender_id, drop MessageSync * remove usages of AtomFrameMsg_Message * iwyu * first draft of renderer->browser direction * refactor to reuse a single ipc interface * implement TakeHeapSnapshot through mojo * the rest of the owl^WtakeHeapSnapshot mojofication * remove no-op overrides in AtomRendererClient * delete renderer-side ElectronApiServiceImpl when its pipe is destroyed * looks like we don't need to overlay the renderer manifest after all * don't try to send 2 replies to a sync rpc * undo changes to manifests.cc * unify sandboxed + unsandboxed ipc events * lint * register ElectronBrowser mojo service on devtools WebContents * fix takeHeapSnapshopt failure paths * {electron_api => atom}::mojom * add send_to_all to ElectronRenderer::Message * keep interface alive until callback is called * review comments * use GetContext from RendererClientBase * robustify a test that uses window.open * MessageSync posts a task to put sync messages in the same queue as async ones * add v8::MicrotasksScope and node::CallbackScope * iwyu * use weakptr to api::WebContents instead of Unretained * make MessageSync an asynchronous message & use non-associated interface * iwyu + comments * remove unused WeakPtrFactory * inline OnRendererMessage[Sync] * cleanups & comments * use helper methods instead of inline lambdas * remove unneeded async in test * add mojo to manifests deps * add gn check for //electron/manifests and mojo * don't register renderer side service until preload has been run * update gn check targets list * move interface registration back to RenderFrameCreated
2019-04-02 22:38:16 +00:00
#include "base/optional.h"
#include "electron/shell/common/api/api.mojom.h"
#include "shell/common/gin_helper/event_emitter_caller.h"
namespace gin_helper {
2016-04-25 01:17:54 +00:00
namespace internal {
v8::Local<v8::Object> CreateEventObject(v8::Isolate* isolate);
2018-04-18 01:44:10 +00:00
v8::Local<v8::Object> CreateCustomEvent(v8::Isolate* isolate,
v8::Local<v8::Object> object,
v8::Local<v8::Object> event);
2016-06-22 02:00:45 +00:00
v8::Local<v8::Object> CreateEventFromFlags(v8::Isolate* isolate, int flags);
2016-04-25 01:17:54 +00:00
} // namespace internal
// Provide helperers to emit event in JavaScript.
//
// TODO(zcbenz): Inherit from Wrappable directly after removing native_mate.
template <typename Base>
class EventEmitter : public Base {
public:
2015-05-22 11:11:22 +00:00
typedef std::vector<v8::Local<v8::Value>> ValueArray;
2016-04-25 01:17:54 +00:00
// Make the convinient methods visible:
// https://isocpp.org/wiki/faq/templates#nondependent-name-lookup-members
v8::Isolate* isolate() const { return Base::isolate(); }
v8::Local<v8::Object> GetWrapper() const { return Base::GetWrapper(); }
v8::MaybeLocal<v8::Object> GetWrapper(v8::Isolate* isolate) const {
return Base::GetWrapper(isolate);
}
2016-04-25 01:17:54 +00:00
// this.emit(name, event, args...);
2018-04-18 01:44:10 +00:00
template <typename... Args>
bool EmitCustomEvent(base::StringPiece name,
v8::Local<v8::Object> event,
Args&&... args) {
2016-04-25 01:17:54 +00:00
return EmitWithEvent(
2018-04-18 01:44:10 +00:00
name, internal::CreateCustomEvent(isolate(), GetWrapper(), event),
std::forward<Args>(args)...);
}
2016-06-22 02:00:45 +00:00
// this.emit(name, new Event(flags), args...);
2018-04-18 01:44:10 +00:00
template <typename... Args>
bool EmitWithFlags(base::StringPiece name, int flags, Args&&... args) {
return EmitCustomEvent(name,
internal::CreateEventFromFlags(isolate(), flags),
std::forward<Args>(args)...);
2016-06-22 02:00:45 +00:00
}
// this.emit(name, new Event(), args...);
2018-04-18 01:44:10 +00:00
template <typename... Args>
bool Emit(base::StringPiece name, Args&&... args) {
v8::Locker locker(isolate());
v8::HandleScope handle_scope(isolate());
2017-10-24 05:38:55 +00:00
v8::Local<v8::Object> wrapper = GetWrapper();
2017-10-24 05:58:43 +00:00
if (wrapper.IsEmpty()) {
2017-10-24 05:38:55 +00:00
return false;
2017-10-24 05:58:43 +00:00
}
v8::Local<v8::Object> event = internal::CreateEventObject(isolate());
event
->Set(isolate()->GetCurrentContext(),
gin::StringToV8(isolate(), "sender"), wrapper)
.IsJust();
return EmitWithEvent(name, event, std::forward<Args>(args)...);
}
protected:
2016-04-25 01:17:54 +00:00
EventEmitter() {}
private:
// this.emit(name, event, args...);
2018-04-18 01:44:10 +00:00
template <typename... Args>
bool EmitWithEvent(base::StringPiece name,
v8::Local<v8::Object> event,
Args&&... args) {
// It's possible that |this| will be deleted by EmitEvent, so save anything
// we need from |this| before calling EmitEvent.
auto* isolate = this->isolate();
v8::Locker locker(isolate);
v8::HandleScope handle_scope(isolate);
auto context = isolate->GetCurrentContext();
EmitEvent(isolate, GetWrapper(), name, event, std::forward<Args>(args)...);
v8::Local<v8::Value> defaultPrevented;
if (event->Get(context, gin::StringToV8(isolate, "defaultPrevented"))
.ToLocal(&defaultPrevented)) {
return defaultPrevented->BooleanValue(isolate);
}
return false;
}
DISALLOW_COPY_AND_ASSIGN(EventEmitter);
};
} // namespace gin_helper
#endif // SHELL_COMMON_GIN_HELPER_EVENT_EMITTER_H_