File: post_message_receiver.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (105 lines) | stat: -rw-r--r-- 3,310 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef PDF_POST_MESSAGE_RECEIVER_H_
#define PDF_POST_MESSAGE_RECEIVER_H_

#include <memory>

#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/values.h"
#include "gin/interceptor.h"
#include "gin/public/wrapper_info.h"
#include "gin/wrappable.h"
#include "v8/include/v8.h"

namespace base {
class SequencedTaskRunner;
}  // namespace base

namespace gin {
class ObjectTemplateBuilder;
}  // namespace gin

namespace chrome_pdf {

class V8ValueConverter;

// Implements the `postMessage()` API exposed to the plugin embedder. The
// received messages are converted and forwarded to the `Client`.
// `PostMessageReceiver`'s lifetime is managed by the V8 garbage collector,
// meaning it can outlive the `Client`. Messages are dropped if the `Client` is
// destroyed.
class PostMessageReceiver final : public gin::Wrappable<PostMessageReceiver>,
                                  public gin::NamedPropertyInterceptor {
 public:
  // The interface for a plugin client that handles messages from its embedder.
  class Client {
   public:
    // Handles converted messages from the embedder.
    virtual void OnMessage(const base::Value::Dict& message) = 0;

   protected:
    Client() = default;
    ~Client() = default;
  };

  static gin::WrapperInfo kWrapperInfo;

  // Creates a scriptable object with an implemented `postMessage()` method.
  // Messages are posted asynchronously to `client` using `client_task_runner`.
  static v8::Local<v8::Object> Create(
      v8::Isolate* isolate,
      base::WeakPtr<V8ValueConverter> v8_value_converter,
      base::WeakPtr<Client> client,
      scoped_refptr<base::SequencedTaskRunner> client_task_runner);

  PostMessageReceiver(const PostMessageReceiver&) = delete;
  PostMessageReceiver& operator=(const PostMessageReceiver&) = delete;

 protected:
  ~PostMessageReceiver() override;

 private:
  PostMessageReceiver(
      v8::Isolate* isolate,
      base::WeakPtr<V8ValueConverter> v8_value_converter,
      base::WeakPtr<Client> client,
      scoped_refptr<base::SequencedTaskRunner> client_task_runner);

  // gin::Wrappable:
  gin::ObjectTemplateBuilder GetObjectTemplateBuilder(
      v8::Isolate* isolate) override;
  const char* GetTypeName() override;

  // gin::NamedPropertyInterceptor:
  v8::Local<v8::Value> GetNamedProperty(v8::Isolate* isolate,
                                        const std::string& property) override;
  std::vector<std::string> EnumerateNamedProperties(
      v8::Isolate* isolate) override;

  // Lazily creates and retrieves `function_template_`.
  v8::Local<v8::FunctionTemplate> GetFunctionTemplate();

  // Implements the `postMessage()` method called by the embedder.
  void PostMessage(v8::Local<v8::Value> message);

  base::WeakPtr<V8ValueConverter> v8_value_converter_;

  v8::Persistent<v8::FunctionTemplate> function_template_;

  raw_ptr<v8::Isolate> isolate_;

  base::WeakPtr<Client> client_;

  scoped_refptr<base::SequencedTaskRunner> client_task_runner_;

  base::WeakPtrFactory<PostMessageReceiver> weak_factory_{this};
};

}  // namespace chrome_pdf

#endif  // PDF_POST_MESSAGE_RECEIVER_H_