event_emitter_mixin.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. // Copyright (c) 2019 Slack Technologies, Inc.
  2. // Use of this source code is governed by the MIT license that can be
  3. // found in the LICENSE file.
  4. #ifndef SHELL_BROWSER_EVENT_EMITTER_MIXIN_H_
  5. #define SHELL_BROWSER_EVENT_EMITTER_MIXIN_H_
  6. #include <utility>
  7. #include "gin/object_template_builder.h"
  8. #include "shell/browser/javascript_environment.h"
  9. #include "shell/common/gin_helper/event_emitter.h"
  10. namespace gin_helper {
  11. namespace internal {
  12. v8::Local<v8::FunctionTemplate> GetEventEmitterTemplate(v8::Isolate* isolate);
  13. } // namespace internal
  14. template <typename T>
  15. class EventEmitterMixin {
  16. public:
  17. // this.emit(name, new Event(), args...);
  18. // Returns true if event.preventDefault() was called during processing.
  19. template <typename... Args>
  20. bool Emit(base::StringPiece name, Args&&... args) {
  21. v8::Isolate* isolate = electron::JavascriptEnvironment::GetIsolate();
  22. v8::Locker locker(isolate);
  23. v8::HandleScope handle_scope(isolate);
  24. v8::Local<v8::Object> wrapper;
  25. if (!static_cast<T*>(this)->GetWrapper(isolate).ToLocal(&wrapper))
  26. return false;
  27. v8::Local<v8::Object> event = internal::CreateCustomEvent(isolate, wrapper);
  28. return EmitWithEvent(isolate, wrapper, name, event,
  29. std::forward<Args>(args)...);
  30. }
  31. // this.emit(name, event, args...);
  32. template <typename... Args>
  33. bool EmitCustomEvent(base::StringPiece name,
  34. v8::Local<v8::Object> custom_event,
  35. Args&&... args) {
  36. v8::Isolate* isolate = electron::JavascriptEnvironment::GetIsolate();
  37. v8::HandleScope scope(isolate);
  38. v8::Local<v8::Object> wrapper;
  39. if (!static_cast<T*>(this)->GetWrapper(isolate).ToLocal(&wrapper))
  40. return false;
  41. return EmitWithEvent(isolate, wrapper, name, custom_event,
  42. std::forward<Args>(args)...);
  43. }
  44. protected:
  45. EventEmitterMixin() = default;
  46. gin::ObjectTemplateBuilder GetObjectTemplateBuilder(v8::Isolate* isolate) {
  47. gin::PerIsolateData* data = gin::PerIsolateData::From(isolate);
  48. auto* wrapper_info = &(static_cast<T*>(this)->kWrapperInfo);
  49. v8::Local<v8::FunctionTemplate> constructor =
  50. data->GetFunctionTemplate(wrapper_info);
  51. if (constructor.IsEmpty()) {
  52. constructor = v8::FunctionTemplate::New(isolate);
  53. constructor->SetClassName(
  54. gin::StringToV8(isolate, static_cast<T*>(this)->GetTypeName()));
  55. constructor->Inherit(internal::GetEventEmitterTemplate(isolate));
  56. data->SetFunctionTemplate(wrapper_info, constructor);
  57. }
  58. return gin::ObjectTemplateBuilder(isolate,
  59. static_cast<T*>(this)->GetTypeName(),
  60. constructor->InstanceTemplate());
  61. }
  62. private:
  63. // this.emit(name, event, args...);
  64. template <typename... Args>
  65. static bool EmitWithEvent(v8::Isolate* isolate,
  66. v8::Local<v8::Object> wrapper,
  67. base::StringPiece name,
  68. v8::Local<v8::Object> event,
  69. Args&&... args) {
  70. auto context = isolate->GetCurrentContext();
  71. gin_helper::EmitEvent(isolate, wrapper, name, event,
  72. std::forward<Args>(args)...);
  73. v8::Local<v8::Value> defaultPrevented;
  74. if (event->Get(context, gin::StringToV8(isolate, "defaultPrevented"))
  75. .ToLocal(&defaultPrevented)) {
  76. return defaultPrevented->BooleanValue(isolate);
  77. }
  78. return false;
  79. }
  80. DISALLOW_COPY_AND_ASSIGN(EventEmitterMixin);
  81. };
  82. } // namespace gin_helper
  83. #endif // SHELL_BROWSER_EVENT_EMITTER_MIXIN_H_