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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
|
<!--
SPDX-FileCopyrightText: The WebKit GTK and WPE teams
SPDX-License-Identifier: BSD, LGPL-2.1
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>WebKitWebProcessExtension.WebProcessExtension</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:title" content="WebKitWebProcessExtension.WebProcessExtension"/>
<meta property="og:description" content="Reference for WebKitWebProcessExtension.WebProcessExtension"/>
<meta name="twitter:title" content="WebKitWebProcessExtension.WebProcessExtension"/>
<meta name="twitter:description" content="Reference for WebKitWebProcessExtension.WebProcessExtension"/>
<meta name="twitter:card" content="summary"/>
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="gtk4-urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">WebKitWebProcessExtension</a></h3>
<p>API Version: 6.0</p>
<p>Library Version: 2.50.1</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.WebProcessExtension.html#description">WebProcessExtension</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.WebProcessExtension.get_page.html">get_page</a>
<a class="method" href="method.WebProcessExtension.send_message_to_context.html">send_message_to_context</a>
<a class="method" href="method.WebProcessExtension.send_message_to_context_finish.html">send_message_to_context_finish</a>
</div>
</div>
<div class="section">
<h5>Signals</h5>
<div class="links">
<a class="signal" href="signal.WebProcessExtension.page-created.html">page-created</a>
<a class="signal" href="signal.WebProcessExtension.user-message-received.html">user-message-received</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.4</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">WebKitWebProcessExtension</a><span class="sep" role="presentation"></span>WebProcessExtension</h1>
</header>
<section>
<summary>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/WebKit/WebKit/tree/main/Source/WebKit/WebProcess/InjectedBundle/API/glib/WebKitWebProcessExtension.cpp#L39">[src]</a>
</h4>
<pre><code>final class WebKitWebProcessExtension.WebProcessExtension : GObject.Object
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Represents an extension of the web process.</p>
<p>WebKitWebProcessExtension is a loadable module for the web process. It allows you to execute code in the
web process and being able to use the <span class="caps">DOM</span> <span class="caps">API</span>, to change any request or to inject custom
JavaScript code, for example.</p>
<p>To create a WebKitWebProcessExtension you should write a module with an initialization function that could
be either <code>webkit_web_process_extension_initialize()</code> with prototype <code>WebKitWebProcessExtensionInitializeFunction</code> or
<code>webkit_web_process_extension_initialize_with_user_data()</code> with prototype <code>WebKitWebProcessExtensionInitializeWithUserDataFunction</code>.
This function has to be public and it has to use the #G_MODULE_EXPORT macro. It is called when the
web process is initialized.</p>
<div class="codehilite"><pre><span></span><code><span class="k">static</span><span class="w"> </span><span class="kt">void</span>
<span class="nf">web_page_created_callback</span><span class="w"> </span><span class="p">(</span><span class="n">WebKitWebProcessExtension</span><span class="w"> </span><span class="o">*</span><span class="n">extension</span><span class="p">,</span>
<span class="w"> </span><span class="n">WebKitWebPage</span><span class="w"> </span><span class="o">*</span><span class="n">web_page</span><span class="p">,</span>
<span class="w"> </span><span class="n">gpointer</span><span class="w"> </span><span class="n">user_data</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="n">g_print</span><span class="w"> </span><span class="p">(</span><span class="s">"Page %d created for %s</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span>
<span class="w"> </span><span class="n">webkit_web_page_get_id</span><span class="w"> </span><span class="p">(</span><span class="n">web_page</span><span class="p">),</span>
<span class="w"> </span><span class="n">webkit_web_page_get_uri</span><span class="w"> </span><span class="p">(</span><span class="n">web_page</span><span class="p">));</span>
<span class="p">}</span>
<span class="n">G_MODULE_EXPORT</span><span class="w"> </span><span class="kt">void</span>
<span class="n">webkit_web_process_extension_initialize</span><span class="w"> </span><span class="p">(</span><span class="n">WebKitWebProcessExtension</span><span class="w"> </span><span class="o">*</span><span class="n">extension</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="n">g_signal_connect</span><span class="w"> </span><span class="p">(</span><span class="n">extension</span><span class="p">,</span><span class="w"> </span><span class="s">"page-created"</span><span class="p">,</span>
<span class="w"> </span><span class="n">G_CALLBACK</span><span class="w"> </span><span class="p">(</span><span class="n">web_page_created_callback</span><span class="p">),</span>
<span class="w"> </span><span class="nb">NULL</span><span class="p">);</span>
<span class="p">}</span>
</code></pre></div>
<p>The previous piece of code shows a trivial example of an extension that notifies when
a <code>WebKitWebPage</code> is created.</p>
<p>WebKit has to know where it can find the created WebKitWebProcessExtension. To do so you
should use the <code>webkit_web_context_set_web_extensions_directory()</code> function. The signal
<code>WebKitWebContext::initialize-web-extensions</code> is the recommended place to call it.</p>
<p>To provide the initialization data used by the <code>webkit_web_process_extension_initialize_with_user_data()</code>
function, you have to call <code>webkit_web_context_set_web_extensions_initialization_user_data()</code> with
the desired data as parameter. You can see an example of this in the following piece of code:</p>
<div class="codehilite"><pre><span></span><code><span class="cp">#define WEB_EXTENSIONS_DIRECTORY </span><span class="c1">// ...</span>
<span class="k">static</span><span class="w"> </span><span class="kt">void</span>
<span class="nf">initialize_web_extensions</span><span class="w"> </span><span class="p">(</span><span class="n">WebKitWebContext</span><span class="w"> </span><span class="o">*</span><span class="n">context</span><span class="p">,</span>
<span class="w"> </span><span class="n">gpointer</span><span class="w"> </span><span class="n">user_data</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="c1">// Web Extensions get a different ID for each Web Process</span>
<span class="w"> </span><span class="k">static</span><span class="w"> </span><span class="n">guint32</span><span class="w"> </span><span class="n">unique_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
<span class="w"> </span><span class="n">webkit_web_context_set_web_extensions_directory</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">context</span><span class="p">,</span><span class="w"> </span><span class="n">WEB_EXTENSIONS_DIRECTORY</span><span class="p">);</span>
<span class="w"> </span><span class="n">webkit_web_context_set_web_extensions_initialization_user_data</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">context</span><span class="p">,</span><span class="w"> </span><span class="n">g_variant_new_uint32</span><span class="w"> </span><span class="p">(</span><span class="n">unique_id</span><span class="o">++</span><span class="p">));</span>
<span class="p">}</span>
<span class="kt">int</span><span class="w"> </span><span class="nf">main</span><span class="w"> </span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">argc</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="n">argv</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="n">g_signal_connect</span><span class="w"> </span><span class="p">(</span><span class="n">webkit_web_context_get_default</span><span class="w"> </span><span class="p">(),</span>
<span class="w"> </span><span class="s">"initialize-web-extensions"</span><span class="p">,</span>
<span class="w"> </span><span class="n">G_CALLBACK</span><span class="w"> </span><span class="p">(</span><span class="n">initialize_web_extensions</span><span class="p">),</span>
<span class="w"> </span><span class="nb">NULL</span><span class="p">);</span>
<span class="w"> </span><span class="n">GtkWidget</span><span class="w"> </span><span class="o">*</span><span class="n">view</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">webkit_web_view_new</span><span class="w"> </span><span class="p">();</span>
<span class="w"> </span><span class="c1">// ...</span>
<span class="p">}</span>
</code></pre></div>
</div>
<div class="docblock">
<p>Available since: 2.40</p>
</div>
</div>
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for WebKitWebProcessExtension.WebProcessExtension">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.42.4 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="234pt" height="116pt"
viewBox="0.00 0.00 234.00 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="WebKitWebProcessExtension">
<path fill="none" stroke="black" d="M214,-36C214,-36 12,-36 12,-36 6,-36 0,-30 0,-24 0,-24 0,-12 0,-12 0,-6 6,0 12,0 12,0 214,0 214,0 220,0 226,-6 226,-12 226,-12 226,-24 226,-24 226,-30 220,-36 214,-36"/>
<text text-anchor="middle" x="113" y="-14.3" font-family="Times,serif" font-size="14.00">WebKitWebProcessExtension</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M138,-108C138,-108 88,-108 88,-108 82,-108 76,-102 76,-96 76,-96 76,-84 76,-84 76,-78 82,-72 88,-72 88,-72 138,-72 138,-72 144,-72 150,-78 150,-84 150,-84 150,-96 150,-96 150,-102 144,-108 138,-108"/>
<text text-anchor="middle" x="113" y="-86.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_0--this -->
<g id="edge1" class="edge">
<title>ancestor_0--this</title>
<path fill="none" stroke="black" d="M113,-71.7C113,-60.85 113,-46.92 113,-36.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.WebProcessExtension.get_page.html">webkit_web_process_extension_get_page</a></h6>
<div class="docblock">
<p>Get the web page of the given <code>page_id</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
<div class="">
<h6><a href="method.WebProcessExtension.send_message_to_context.html">webkit_web_process_extension_send_message_to_context</a></h6>
<div class="docblock">
<p>Send <code>message</code> to the <code>WebKitWebContext</code> corresponding to <code>extension</code>. If <code>message</code> is floating, it’s consumed.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
<div class="">
<h6><a href="method.WebProcessExtension.send_message_to_context_finish.html">webkit_web_process_extension_send_message_to_context_finish</a></h6>
<div class="docblock">
<p>Finish an asynchronous operation started with webkit_web_process_extension_send_message_to_context().</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see <a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a> for a full list of methods.</em></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="signal.WebProcessExtension.page-created.html">WebKitWebProcessExtension.WebProcessExtension::page-created</a></h6>
<div class="docblock">
<p>This signal is emitted when a new <code>WebKitWebPage</code> is created in
the Web Process.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
<div class="">
<h6><a href="signal.WebProcessExtension.user-message-received.html">WebKitWebProcessExtension.WebProcessExtension::user-message-received</a></h6>
<div class="docblock">
<p>This signal is emitted when a <code>WebKitUserMessage</code> is received from the
<code>WebKitWebContext</code> corresponding to <code>extension</code>. Messages sent by <code>WebKitWebContext</code>
are always broadcasted to all web extensions and they can’t be
replied to. Calling <code>webkit_user_message_send_reply()</code> will do nothing.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et al.</p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct WebKitWebProcessExtensionWebProcessExtensionClass {
GObjectClass parent_class;
}</code></pre>
</div>
<div class="docblock">
<p>No description available.</p>
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: GObjectClass</code></dt>
<dd><p>No description available.</p></dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#signals"><span class="link-text">Signals</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>
|
