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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
| | /* Support for embedding graphical components in a buffer.
Copyright (C) 2011-2018 Free Software Foundation, Inc.
This file is part of GNU Emacs.
GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
#include <config.h>
#include "xwidget.h"
#include "lisp.h"
#include "blockinput.h"
#include "frame.h"
#include "keyboard.h"
#include "gtkutil.h"
#include <webkit2/webkit2.h>
#include <JavaScriptCore/JavaScript.h>
static struct xwidget *
allocate_xwidget (void)
{
return ALLOCATE_PSEUDOVECTOR (struct xwidget, height, PVEC_XWIDGET);
}
static struct xwidget_view *
allocate_xwidget_view (void)
{
return ALLOCATE_PSEUDOVECTOR (struct xwidget_view, redisplayed,
PVEC_XWIDGET_VIEW);
}
#define XSETXWIDGET(a, b) XSETPSEUDOVECTOR (a, b, PVEC_XWIDGET)
#define XSETXWIDGET_VIEW(a, b) XSETPSEUDOVECTOR (a, b, PVEC_XWIDGET_VIEW)
static struct xwidget_view *xwidget_view_lookup (struct xwidget *,
struct window *);
static void webkit_view_load_changed_cb (WebKitWebView *,
WebKitLoadEvent,
gpointer);
static void webkit_javascript_finished_cb (GObject *,
GAsyncResult *,
gpointer);
static gboolean webkit_download_cb (WebKitWebContext *, WebKitDownload *, gpointer);
static gboolean
webkit_decide_policy_cb (WebKitWebView *,
WebKitPolicyDecision *,
WebKitPolicyDecisionType,
gpointer);
DEFUN ("make-xwidget",
Fmake_xwidget, Smake_xwidget,
5, 6, 0,
doc: /* Make an xwidget of TYPE.
If BUFFER is nil, use the current buffer.
If BUFFER is a string and no such buffer exists, create it.
TYPE is a symbol which can take one of the following values:
- webkit
Returns the newly constructed xwidget, or nil if construction fails. */)
(Lisp_Object type,
Lisp_Object title, Lisp_Object width, Lisp_Object height,
Lisp_Object arguments, Lisp_Object buffer)
{
CHECK_SYMBOL (type);
CHECK_NATNUM (width);
CHECK_NATNUM (height);
struct xwidget *xw = allocate_xwidget ();
Lisp_Object val;
xw->type = type;
xw->title = title;
xw->buffer = NILP (buffer) ? Fcurrent_buffer () : Fget_buffer_create (buffer);
xw->height = XFASTINT (height);
xw->width = XFASTINT (width);
xw->kill_without_query = false;
XSETXWIDGET (val, xw);
Vxwidget_list = Fcons (val, Vxwidget_list);
xw->widgetwindow_osr = NULL;
xw->widget_osr = NULL;
xw->plist = Qnil;
if (EQ (xw->type, Qwebkit))
{
block_input ();
xw->widgetwindow_osr = gtk_offscreen_window_new ();
gtk_window_resize (GTK_WINDOW (xw->widgetwindow_osr), xw->width,
xw->height);
if (EQ (xw->type, Qwebkit))
{
xw->widget_osr = webkit_web_view_new ();
}
gtk_widget_set_size_request (GTK_WIDGET (xw->widget_osr), xw->width,
xw->height);
if (EQ (xw->type, Qwebkit))
{
gtk_container_add (GTK_CONTAINER (xw->widgetwindow_osr),
GTK_WIDGET (WEBKIT_WEB_VIEW (xw->widget_osr)));
}
else
{
gtk_container_add (GTK_CONTAINER (xw->widgetwindow_osr),
xw->widget_osr);
}
gtk_widget_show (xw->widget_osr);
gtk_widget_show (xw->widgetwindow_osr);
/* Store some xwidget data in the gtk widgets for convenient
retrieval in the event handlers. */
g_object_set_data (G_OBJECT (xw->widget_osr), XG_XWIDGET, xw);
g_object_set_data (G_OBJECT (xw->widgetwindow_osr), XG_XWIDGET, xw);
/* signals */
if (EQ (xw->type, Qwebkit))
{
g_signal_connect (G_OBJECT (xw->widget_osr),
"load-changed",
G_CALLBACK (webkit_view_load_changed_cb), xw);
g_signal_connect (G_OBJECT (webkit_web_context_get_default ()),
"download-started",
G_CALLBACK (webkit_download_cb), xw);
g_signal_connect (G_OBJECT (xw->widget_osr),
"decide-policy",
G_CALLBACK
(webkit_decide_policy_cb),
xw);
}
unblock_input ();
}
return val;
}
DEFUN ("get-buffer-xwidgets", Fget_buffer_xwidgets, Sget_buffer_xwidgets,
1, 1, 0,
doc: /* Return a list of xwidgets associated with BUFFER.
BUFFER may be a buffer or the name of one. */)
(Lisp_Object buffer)
{
Lisp_Object xw, tail, xw_list;
if (NILP (buffer))
return Qnil;
buffer = Fget_buffer (buffer);
if (NILP (buffer))
return Qnil;
xw_list = Qnil;
for (tail = Vxwidget_list; CONSP (tail); tail = XCDR (tail))
{
xw = XCAR (tail);
if (XWIDGETP (xw) && EQ (Fxwidget_buffer (xw), buffer))
xw_list = Fcons (xw, xw_list);
}
return xw_list;
}
static bool
xwidget_hidden (struct xwidget_view *xv)
{
return xv->hidden;
}
static void
xwidget_show_view (struct xwidget_view *xv)
{
xv->hidden = false;
gtk_widget_show (xv->widgetwindow);
gtk_fixed_move (GTK_FIXED (xv->emacswindow),
xv->widgetwindow,
xv->x + xv->clip_left,
xv->y + xv->clip_top);
}
/* Hide an xwidget view. */
static void
xwidget_hide_view (struct xwidget_view *xv)
{
xv->hidden = true;
gtk_fixed_move (GTK_FIXED (xv->emacswindow), xv->widgetwindow,
10000, 10000);
}
/* When the off-screen webkit master view changes this signal is called.
It copies the bitmap from the off-screen instance. */
static gboolean
offscreen_damage_event (GtkWidget *widget, GdkEvent *event,
gpointer xv_widget)
{
/* Queue a redraw of onscreen widget.
There is a guard against receiving an invalid widget,
which should only happen if we failed to remove the
specific signal handler for the damage event. */
if (GTK_IS_WIDGET (xv_widget))
gtk_widget_queue_draw (GTK_WIDGET (xv_widget));
else
printf ("Warning, offscreen_damage_event received invalid xv pointer:%p\n",
xv_widget);
return FALSE;
}
static void
store_xwidget_event_string (struct xwidget *xw, const char *eventname,
const char *eventstr)
{
struct input_event event;
Lisp_Object xwl;
XSETXWIDGET (xwl, xw);
EVENT_INIT (event);
event.kind = XWIDGET_EVENT;
event.frame_or_window = Qnil;
event.arg = list3 (intern (eventname), xwl, build_string (eventstr));
kbd_buffer_store_event (&event);
}
static void
store_xwidget_js_callback_event (struct xwidget *xw,
Lisp_Object proc,
Lisp_Object argument)
{
struct input_event event;
Lisp_Object xwl;
XSETXWIDGET (xwl, xw);
EVENT_INIT (event);
event.kind = XWIDGET_EVENT;
event.frame_or_window = Qnil;
event.arg = list4 (intern ("javascript-callback"), xwl, proc, argument);
kbd_buffer_store_event (&event);
}
void
webkit_view_load_changed_cb (WebKitWebView *webkitwebview,
WebKitLoadEvent load_event,
gpointer data)
{
switch (load_event) {
case WEBKIT_LOAD_FINISHED:
{
struct xwidget *xw = g_object_get_data (G_OBJECT (webkitwebview),
XG_XWIDGET);
store_xwidget_event_string (xw, "load-changed", "");
break;
}
default:
break;
}
}
/* Recursively convert a JavaScript value to a Lisp value. */
static Lisp_Object
webkit_js_to_lisp (JSContextRef context, JSValueRef value)
{
switch (JSValueGetType (context, value))
{
case kJSTypeString:
{
JSStringRef js_str_value;
gchar *str_value;
gsize str_length;
js_str_value = JSValueToStringCopy (context, value, NULL);
str_length = JSStringGetMaximumUTF8CStringSize (js_str_value);
str_value = (gchar *)g_malloc (str_length);
JSStringGetUTF8CString (js_str_value, str_value, str_length);
JSStringRelease (js_str_value);
return build_string (str_value);
}
case kJSTypeBoolean:
return (JSValueToBoolean (context, value)) ? Qt : Qnil;
case kJSTypeNumber:
return make_number (JSValueToNumber (context, value, NULL));
case kJSTypeObject:
{
if (JSValueIsArray (context, value))
{
JSStringRef pname = JSStringCreateWithUTF8CString("length");
JSValueRef len = JSObjectGetProperty (context, (JSObjectRef) value, pname, NULL);
EMACS_INT n = JSValueToNumber (context, len, NULL);
JSStringRelease(pname);
Lisp_Object obj;
struct Lisp_Vector *p = allocate_vector (n);
for (ptrdiff_t i = 0; i < n; ++i)
{
p->contents[i] =
webkit_js_to_lisp (context,
JSObjectGetPropertyAtIndex (context,
(JSObjectRef) value,
i, NULL));
}
XSETVECTOR (obj, p);
return obj;
}
else
{
JSPropertyNameArrayRef properties =
JSObjectCopyPropertyNames (context, (JSObjectRef) value);
ptrdiff_t n = JSPropertyNameArrayGetCount (properties);
Lisp_Object obj;
/* TODO: can we use a regular list here? */
struct Lisp_Vector *p = allocate_vector (n);
for (ptrdiff_t i = 0; i < n; ++i)
{
JSStringRef name = JSPropertyNameArrayGetNameAtIndex (properties, i);
JSValueRef property = JSObjectGetProperty (context,
(JSObjectRef) value,
name, NULL);
gchar *str_name;
gsize str_length;
str_length = JSStringGetMaximumUTF8CStringSize (name);
str_name = (gchar *)g_malloc (str_length);
JSStringGetUTF8CString (name, str_name, str_length);
JSStringRelease (name);
p->contents[i] =
Fcons (build_string (str_name),
webkit_js_to_lisp (context, property));
}
JSPropertyNameArrayRelease (properties);
XSETVECTOR (obj, p);
return obj;
}
}
case kJSTypeUndefined:
case kJSTypeNull:
default:
return Qnil;
}
}
static void
webkit_javascript_finished_cb (GObject *webview,
GAsyncResult *result,
gpointer arg)
{
WebKitJavascriptResult *js_result;
JSValueRef value;
JSGlobalContextRef context;
GError *error = NULL;
struct xwidget *xw = g_object_get_data (G_OBJECT (webview),
XG_XWIDGET);
ptrdiff_t script_idx = (ptrdiff_t) arg;
Lisp_Object script_callback = AREF (xw->script_callbacks, script_idx);
ASET (xw->script_callbacks, script_idx, Qnil);
if (!NILP (script_callback))
xfree (XSAVE_POINTER (XCAR (script_callback), 0));
js_result = webkit_web_view_run_javascript_finish
(WEBKIT_WEB_VIEW (webview), result, &error);
if (!js_result)
{
g_warning ("Error running javascript: %s", error->message);
g_error_free (error);
return;
}
if (!NILP (script_callback) && !NILP (XCDR (script_callback)))
{
context = webkit_javascript_result_get_global_context (js_result);
value = webkit_javascript_result_get_value (js_result);
Lisp_Object lisp_value = webkit_js_to_lisp (context, value);
/* Register an xwidget event here, which then runs the callback.
This ensures that the callback runs in sync with the Emacs
event loop. */
store_xwidget_js_callback_event (xw, XCDR (script_callback), lisp_value);
}
webkit_javascript_result_unref (js_result);
}
gboolean
webkit_download_cb (WebKitWebContext *webkitwebcontext,
WebKitDownload *arg1,
gpointer data)
{
WebKitWebView *view = webkit_download_get_web_view(arg1);
WebKitURIRequest *request = webkit_download_get_request(arg1);
struct xwidget *xw = g_object_get_data (G_OBJECT (view),
XG_XWIDGET);
store_xwidget_event_string (xw, "download-started",
webkit_uri_request_get_uri(request));
return FALSE;
}
static gboolean
webkit_decide_policy_cb (WebKitWebView *webView,
WebKitPolicyDecision *decision,
WebKitPolicyDecisionType type,
gpointer user_data)
{
switch (type) {
case WEBKIT_POLICY_DECISION_TYPE_RESPONSE:
/* This function makes webkit send a download signal for all unknown
mime types. TODO: Defer the decision to Lisp, so that it's
possible to make Emacs handle mime text for instance. */
{
WebKitResponsePolicyDecision *response =
WEBKIT_RESPONSE_POLICY_DECISION (decision);
if (!webkit_response_policy_decision_is_mime_type_supported (response))
{
webkit_policy_decision_download (decision);
return TRUE;
}
else
return FALSE;
break;
}
case WEBKIT_POLICY_DECISION_TYPE_NEW_WINDOW_ACTION:
case WEBKIT_POLICY_DECISION_TYPE_NAVIGATION_ACTION:
{
WebKitNavigationPolicyDecision *navigation_decision =
WEBKIT_NAVIGATION_POLICY_DECISION (decision);
WebKitNavigationAction *navigation_action =
webkit_navigation_policy_decision_get_navigation_action (navigation_decision);
WebKitURIRequest *request =
webkit_navigation_action_get_request (navigation_action);
struct xwidget *xw = g_object_get_data (G_OBJECT (webView), XG_XWIDGET);
store_xwidget_event_string (xw, "decide-policy",
webkit_uri_request_get_uri (request));
return FALSE;
break;
}
default:
return FALSE;
}
}
/* For gtk3 offscreen rendered widgets. */
static gboolean
xwidget_osr_draw_cb (GtkWidget *widget, cairo_t *cr, gpointer data)
{
struct xwidget *xw = g_object_get_data (G_OBJECT (widget), XG_XWIDGET);
struct xwidget_view *xv = g_object_get_data (G_OBJECT (widget),
XG_XWIDGET_VIEW);
cairo_rectangle (cr, 0, 0, xv->clip_right, xv->clip_bottom);
cairo_clip (cr);
gtk_widget_draw (xw->widget_osr, cr);
return FALSE;
}
static gboolean
xwidget_osr_event_forward (GtkWidget *widget, GdkEvent *event,
gpointer user_data)
{
/* Copy events that arrive at the outer widget to the offscreen widget. */
struct xwidget *xw = g_object_get_data (G_OBJECT (widget), XG_XWIDGET);
GdkEvent *eventcopy = gdk_event_copy (event);
eventcopy->any.window = gtk_widget_get_window (xw->widget_osr);
/* TODO: This might leak events. They should be deallocated later,
perhaps in xwgir_event_cb. */
gtk_main_do_event (eventcopy);
/* Don't propagate this event further. */
return TRUE;
}
static gboolean
xwidget_osr_event_set_embedder (GtkWidget *widget, GdkEvent *event,
gpointer data)
{
struct xwidget_view *xv = data;
struct xwidget *xww = XXWIDGET (xv->model);
gdk_offscreen_window_set_embedder (gtk_widget_get_window
(xww->widgetwindow_osr),
gtk_widget_get_window (xv->widget));
return FALSE;
}
/* Initializes and does initial placement of an xwidget view on screen. */
static struct xwidget_view *
xwidget_init_view (struct xwidget *xww,
struct glyph_string *s,
int x, int y)
{
struct xwidget_view *xv = allocate_xwidget_view ();
Lisp_Object val;
XSETXWIDGET_VIEW (val, xv);
Vxwidget_view_list = Fcons (val, Vxwidget_view_list);
XSETWINDOW (xv->w, s->w);
XSETXWIDGET (xv->model, xww);
if (EQ (xww->type, Qwebkit))
{
xv->widget = gtk_drawing_area_new ();
/* Expose event handling. */
gtk_widget_set_app_paintable (xv->widget, TRUE);
gtk_widget_add_events (xv->widget, GDK_ALL_EVENTS_MASK);
/* Draw the view on damage-event. */
g_signal_connect (G_OBJECT (xww->widgetwindow_osr), "damage-event",
G_CALLBACK (offscreen_damage_event), xv->widget);
if (EQ (xww->type, Qwebkit))
{
g_signal_connect (G_OBJECT (xv->widget), "button-press-event",
G_CALLBACK (xwidget_osr_event_forward), NULL);
g_signal_connect (G_OBJECT (xv->widget), "button-release-event",
G_CALLBACK (xwidget_osr_event_forward), NULL);
g_signal_connect (G_OBJECT (xv->widget), "motion-notify-event",
G_CALLBACK (xwidget_osr_event_forward), NULL);
}
else
{
/* xwgir debug, orthogonal to forwarding. */
g_signal_connect (G_OBJECT (xv->widget), "enter-notify-event",
G_CALLBACK (xwidget_osr_event_set_embedder), xv);
}
g_signal_connect (G_OBJECT (xv->widget), "draw",
G_CALLBACK (xwidget_osr_draw_cb), NULL);
}
/* Widget realization.
Make container widget first, and put the actual widget inside the
container later. Drawing should crop container window if necessary
to handle case where xwidget is partially obscured by other Emacs
windows. Other containers than gtk_fixed where explored, but
gtk_fixed had the most predictable behavior so far. */
xv->emacswindow = FRAME_GTK_WIDGET (s->f);
xv->widgetwindow = gtk_fixed_new ();
gtk_widget_set_has_window (xv->widgetwindow, TRUE);
gtk_container_add (GTK_CONTAINER (xv->widgetwindow), xv->widget);
/* Store some xwidget data in the gtk widgets. */
g_object_set_data (G_OBJECT (xv->widget), XG_FRAME_DATA, s->f);
g_object_set_data (G_OBJECT (xv->widget), XG_XWIDGET, xww);
g_object_set_data (G_OBJECT (xv->widget), XG_XWIDGET_VIEW, xv);
g_object_set_data (G_OBJECT (xv->widgetwindow), XG_XWIDGET, xww);
g_object_set_data (G_OBJECT (xv->widgetwindow), XG_XWIDGET_VIEW, xv);
gtk_widget_set_size_request (GTK_WIDGET (xv->widget), xww->width,
xww->height);
gtk_widget_set_size_request (xv->widgetwindow, xww->width, xww->height);
gtk_fixed_put (GTK_FIXED (FRAME_GTK_WIDGET (s->f)), xv->widgetwindow, x, y);
xv->x = x;
xv->y = y;
gtk_widget_show_all (xv->widgetwindow);
return xv;
}
void
x_draw_xwidget_glyph_string (struct glyph_string *s)
{
/* This method is called by the redisplay engine and places the
xwidget on screen. Moving and clipping is done here. Also view
initialization. */
struct xwidget *xww = s->xwidget;
struct xwidget_view *xv = xwidget_view_lookup (xww, s->w);
int clip_right;
int clip_bottom;
int clip_top;
int clip_left;
int x = s->x;
int y = s->y + (s->height / 2) - (xww->height / 2);
/* Do initialization here in the display loop because there is no
other time to know things like window placement etc. Do not
create a new view if we have found one that is usable. */
if (!xv)
xv = xwidget_init_view (xww, s, x, y);
int text_area_x, text_area_y, text_area_width, text_area_height;
window_box (s->w, TEXT_AREA, &text_area_x, &text_area_y,
&text_area_width, &text_area_height);
clip_left = max (0, text_area_x - x);
clip_right = max (clip_left,
min (xww->width, text_area_x + text_area_width - x));
clip_top = max (0, text_area_y - y);
clip_bottom = max (clip_top,
min (xww->height, text_area_y + text_area_height - y));
/* We are concerned with movement of the onscreen area. The area
might sit still when the widget actually moves. This happens
when an Emacs window border moves across a widget window. So, if
any corner of the outer widget clipping window moves, that counts
as movement here, even if it looks like no movement happens
because the widget sits still inside the clipping area. The
widget can also move inside the clipping area, which happens
later. */
bool moved = (xv->x + xv->clip_left != x + clip_left
|| xv->y + xv->clip_top != y + clip_top);
xv->x = x;
xv->y = y;
/* Has it moved? */
if (moved)
gtk_fixed_move (GTK_FIXED (FRAME_GTK_WIDGET (s->f)),
xv->widgetwindow, x + clip_left, y + clip_top);
/* Clip the widget window if some parts happen to be outside
drawable area. An Emacs window is not a gtk window. A gtk window
covers the entire frame. Clipping might have changed even if we
haven't actually moved; try to figure out when we need to reclip
for real. */
if (xv->clip_right != clip_right
|| xv->clip_bottom != clip_bottom
|| xv->clip_top != clip_top || xv->clip_left != clip_left)
{
gtk_widget_set_size_request (xv->widgetwindow, clip_right - clip_left,
clip_bottom - clip_top);
gtk_fixed_move (GTK_FIXED (xv->widgetwindow), xv->widget, -clip_left,
-clip_top);
xv->clip_right = clip_right;
xv->clip_bottom = clip_bottom;
xv->clip_top = clip_top;
xv->clip_left = clip_left;
}
/* If emacs wants to repaint the area where the widget lives, queue
a redraw. It seems its possible to get out of sync with emacs
redraws so emacs background sometimes shows up instead of the
xwidgets background. It's just a visual glitch though. */
if (!xwidget_hidden (xv))
{
gtk_widget_queue_draw (xv->widgetwindow);
gtk_widget_queue_draw (xv->widget);
}
}
/* Macro that checks WEBKIT_IS_WEB_VIEW (xw->widget_osr) first. */
#define WEBKIT_FN_INIT() \
CHECK_XWIDGET (xwidget); \
struct xwidget *xw = XXWIDGET (xwidget); \
if (!xw->widget_osr || !WEBKIT_IS_WEB_VIEW (xw->widget_osr)) \
{ \
printf ("ERROR xw->widget_osr does not hold a webkit instance\n"); \
return Qnil; \
}
DEFUN ("xwidget-webkit-goto-uri",
Fxwidget_webkit_goto_uri, Sxwidget_webkit_goto_uri,
2, 2, 0,
doc: /* Make the xwidget webkit instance referenced by XWIDGET browse URI. */)
(Lisp_Object xwidget, Lisp_Object uri)
{
WEBKIT_FN_INIT ();
CHECK_STRING (uri);
uri = ENCODE_FILE (uri);
webkit_web_view_load_uri (WEBKIT_WEB_VIEW (xw->widget_osr), SSDATA (uri));
return Qnil;
}
DEFUN ("xwidget-webkit-zoom",
Fxwidget_webkit_zoom, Sxwidget_webkit_zoom,
2, 2, 0,
doc: /* Change the zoom factor of the xwidget webkit instance referenced by XWIDGET. */)
(Lisp_Object xwidget, Lisp_Object factor)
{
WEBKIT_FN_INIT ();
if (FLOATP (factor))
{
double zoom_change = XFLOAT_DATA (factor);
webkit_web_view_set_zoom_level
(WEBKIT_WEB_VIEW (xw->widget_osr),
webkit_web_view_get_zoom_level
(WEBKIT_WEB_VIEW (xw->widget_osr)) + zoom_change);
}
return Qnil;
}
/* Save script and fun in the script/callback save vector and return
its index. */
static ptrdiff_t
save_script_callback (struct xwidget *xw, Lisp_Object script, Lisp_Object fun)
{
ptrdiff_t script_bytes = STRING_BYTES (XSTRING (script));
char *script_data = xmalloc (script_bytes + 1);
memcpy (script_data, SSDATA (script), script_bytes + 1);
ptrdiff_t idx;
Lisp_Object cbs = xw->script_callbacks;
if (NILP (cbs))
xw->script_callbacks = cbs = Fmake_vector (make_number (32), Qnil);
/* Find first free index. */
for (idx = 0; ; idx++)
{
if (idx >= ASIZE (cbs))
{
/* Resize script/callback save vector. */
Lisp_Object new_cbs = Fmake_vector (make_number (idx + 32), Qnil);
ptrdiff_t n;
for (n = 0; n < idx; n++)
ASET (new_cbs, n, AREF (cbs, n));
xw->script_callbacks = cbs = new_cbs;
}
if (NILP (AREF (cbs, idx)))
{
ASET (cbs, idx, Fcons (make_save_ptr (script_data), fun));
break;
}
}
return idx;
}
DEFUN ("xwidget-webkit-execute-script",
Fxwidget_webkit_execute_script, Sxwidget_webkit_execute_script,
2, 3, 0,
doc: /* Make the Webkit XWIDGET execute JavaScript SCRIPT.
If FUN is provided, feed the JavaScript return value to the single
argument procedure FUN.*/)
(Lisp_Object xwidget, Lisp_Object script, Lisp_Object fun)
{
WEBKIT_FN_INIT ();
CHECK_STRING (script);
if (!NILP (fun) && !FUNCTIONP (fun))
wrong_type_argument (Qinvalid_function, fun);
script = ENCODE_SYSTEM (script);
/* Protect script and fun during GC. */
ptrdiff_t idx = save_script_callback (xw, script, fun);
/* JavaScript execution happens asynchronously. If an elisp
callback function is provided we pass it to the C callback
procedure that retrieves the return value. */
webkit_web_view_run_javascript (WEBKIT_WEB_VIEW (xw->widget_osr),
XSAVE_POINTER (XCAR (AREF (xw->script_callbacks, idx)), 0),
NULL, /* cancelable */
webkit_javascript_finished_cb,
(gpointer) idx);
return Qnil;
}
DEFUN ("xwidget-resize", Fxwidget_resize, Sxwidget_resize, 3, 3, 0,
doc: /* Resize XWIDGET to NEW_WIDTH, NEW_HEIGHT. */ )
(Lisp_Object xwidget, Lisp_Object new_width, Lisp_Object new_height)
{
CHECK_XWIDGET (xwidget);
CHECK_RANGED_INTEGER (new_width, 0, INT_MAX);
CHECK_RANGED_INTEGER (new_height, 0, INT_MAX);
struct xwidget *xw = XXWIDGET (xwidget);
int w = XFASTINT (new_width);
int h = XFASTINT (new_height);
xw->width = w;
xw->height = h;
/* If there is an offscreen widget resize it first. */
if (xw->widget_osr)
{
gtk_window_resize (GTK_WINDOW (xw->widgetwindow_osr), xw->width,
xw->height);
gtk_container_resize_children (GTK_CONTAINER (xw->widgetwindow_osr));
gtk_widget_set_size_request (GTK_WIDGET (xw->widget_osr), xw->width,
xw->height);
}
for (Lisp_Object tail = Vxwidget_view_list; CONSP (tail); tail = XCDR (tail))
{
if (XWIDGET_VIEW_P (XCAR (tail)))
{
struct xwidget_view *xv = XXWIDGET_VIEW (XCAR (tail));
if (XXWIDGET (xv->model) == xw)
gtk_widget_set_size_request (GTK_WIDGET (xv->widget), xw->width,
xw->height);
}
}
return Qnil;
}
DEFUN ("xwidget-size-request",
Fxwidget_size_request, Sxwidget_size_request,
1, 1, 0,
doc: /* Return the desired size of the XWIDGET.
This can be used to read the xwidget desired size, and resizes the
Emacs allocated area accordingly. */)
(Lisp_Object xwidget)
{
CHECK_XWIDGET (xwidget);
GtkRequisition requisition;
gtk_widget_size_request (XXWIDGET (xwidget)->widget_osr, &requisition);
return list2 (make_number (requisition.width),
make_number (requisition.height));
}
DEFUN ("xwidgetp",
Fxwidgetp, Sxwidgetp,
1, 1, 0,
doc: /* Return t if OBJECT is an xwidget. */)
(Lisp_Object object)
{
return XWIDGETP (object) ? Qt : Qnil;
}
DEFUN ("xwidget-view-p",
Fxwidget_view_p, Sxwidget_view_p,
1, 1, 0,
doc: /* Return t if OBJECT is an xwidget-view. */)
(Lisp_Object object)
{
return XWIDGET_VIEW_P (object) ? Qt : Qnil;
}
DEFUN ("xwidget-info",
Fxwidget_info, Sxwidget_info,
1, 1, 0,
doc: /* Return XWIDGET properties in a vector.
Currently [TYPE TITLE WIDTH HEIGHT]. */)
(Lisp_Object xwidget)
{
CHECK_XWIDGET (xwidget);
struct xwidget *xw = XXWIDGET (xwidget);
return CALLN (Fvector, xw->type, xw->title,
make_natnum (xw->width), make_natnum (xw->height));
}
DEFUN ("xwidget-view-info",
Fxwidget_view_info, Sxwidget_view_info,
1, 1, 0,
doc: /* Return properties of XWIDGET-VIEW in a vector.
Currently [X Y CLIP_RIGHT CLIP_BOTTOM CLIP_TOP CLIP_LEFT]. */)
(Lisp_Object xwidget_view)
{
CHECK_XWIDGET_VIEW (xwidget_view);
struct xwidget_view *xv = XXWIDGET_VIEW (xwidget_view);
return CALLN (Fvector, make_number (xv->x), make_number (xv->y),
make_number (xv->clip_right), make_number (xv->clip_bottom),
make_number (xv->clip_top), make_number (xv->clip_left));
}
DEFUN ("xwidget-view-model",
Fxwidget_view_model, Sxwidget_view_model,
1, 1, 0,
doc: /* Return the model associated with XWIDGET-VIEW. */)
(Lisp_Object xwidget_view)
{
CHECK_XWIDGET_VIEW (xwidget_view);
return XXWIDGET_VIEW (xwidget_view)->model;
}
DEFUN ("xwidget-view-window",
Fxwidget_view_window, Sxwidget_view_window,
1, 1, 0,
doc: /* Return the window of XWIDGET-VIEW. */)
(Lisp_Object xwidget_view)
{
CHECK_XWIDGET_VIEW (xwidget_view);
return XXWIDGET_VIEW (xwidget_view)->w;
}
DEFUN ("delete-xwidget-view",
Fdelete_xwidget_view, Sdelete_xwidget_view,
1, 1, 0,
doc: /* Delete the XWIDGET-VIEW. */)
(Lisp_Object xwidget_view)
{
CHECK_XWIDGET_VIEW (xwidget_view);
struct xwidget_view *xv = XXWIDGET_VIEW (xwidget_view);
gtk_widget_destroy (xv->widgetwindow);
Vxwidget_view_list = Fdelq (xwidget_view, Vxwidget_view_list);
/* xv->model still has signals pointing to the view. There can be
several views. Find the matching signals and delete them all. */
g_signal_handlers_disconnect_matched (XXWIDGET (xv->model)->widgetwindow_osr,
G_SIGNAL_MATCH_DATA,
0, 0, 0, 0,
xv->widget);
return Qnil;
}
DEFUN ("xwidget-view-lookup",
Fxwidget_view_lookup, Sxwidget_view_lookup,
1, 2, 0,
doc: /* Return the xwidget-view associated with XWIDGET in WINDOW.
If WINDOW is unspecified or nil, use the selected window.
Return nil if no association is found. */)
(Lisp_Object xwidget, Lisp_Object window)
{
CHECK_XWIDGET (xwidget);
if (NILP (window))
window = Fselected_window ();
CHECK_WINDOW (window);
for (Lisp_Object tail = Vxwidget_view_list; CONSP (tail);
tail = XCDR (tail))
{
Lisp_Object xwidget_view = XCAR (tail);
if (EQ (Fxwidget_view_model (xwidget_view), xwidget)
&& EQ (Fxwidget_view_window (xwidget_view), window))
return xwidget_view;
}
return Qnil;
}
DEFUN ("xwidget-plist",
Fxwidget_plist, Sxwidget_plist,
1, 1, 0,
doc: /* Return the plist of XWIDGET. */)
(Lisp_Object xwidget)
{
CHECK_XWIDGET (xwidget);
return XXWIDGET (xwidget)->plist;
}
DEFUN ("xwidget-buffer",
Fxwidget_buffer, Sxwidget_buffer,
1, 1, 0,
doc: /* Return the buffer of XWIDGET. */)
(Lisp_Object xwidget)
{
CHECK_XWIDGET (xwidget);
return XXWIDGET (xwidget)->buffer;
}
DEFUN ("set-xwidget-plist",
Fset_xwidget_plist, Sset_xwidget_plist,
2, 2, 0,
doc: /* Replace the plist of XWIDGET with PLIST.
Returns PLIST. */)
(Lisp_Object xwidget, Lisp_Object plist)
{
CHECK_XWIDGET (xwidget);
CHECK_LIST (plist);
XXWIDGET (xwidget)->plist = plist;
return plist;
}
DEFUN ("set-xwidget-query-on-exit-flag",
Fset_xwidget_query_on_exit_flag, Sset_xwidget_query_on_exit_flag,
2, 2, 0,
doc: /* Specify if query is needed for XWIDGET when Emacs is exited.
If the second argument FLAG is non-nil, Emacs will query the user before
exiting or killing a buffer if XWIDGET is running.
This function returns FLAG. */)
(Lisp_Object xwidget, Lisp_Object flag)
{
CHECK_XWIDGET (xwidget);
XXWIDGET (xwidget)->kill_without_query = NILP (flag);
return flag;
}
DEFUN ("xwidget-query-on-exit-flag",
Fxwidget_query_on_exit_flag, Sxwidget_query_on_exit_flag,
1, 1, 0,
doc: /* Return the current value of the query-on-exit flag for XWIDGET. */)
(Lisp_Object xwidget)
{
CHECK_XWIDGET (xwidget);
return (XXWIDGET (xwidget)->kill_without_query ? Qnil : Qt);
}
void
syms_of_xwidget (void)
{
defsubr (&Smake_xwidget);
defsubr (&Sxwidgetp);
DEFSYM (Qxwidgetp, "xwidgetp");
defsubr (&Sxwidget_view_p);
DEFSYM (Qxwidget_view_p, "xwidget-view-p");
defsubr (&Sxwidget_info);
defsubr (&Sxwidget_view_info);
defsubr (&Sxwidget_resize);
defsubr (&Sget_buffer_xwidgets);
defsubr (&Sxwidget_view_model);
defsubr (&Sxwidget_view_window);
defsubr (&Sxwidget_view_lookup);
defsubr (&Sxwidget_query_on_exit_flag);
defsubr (&Sset_xwidget_query_on_exit_flag);
defsubr (&Sxwidget_webkit_goto_uri);
defsubr (&Sxwidget_webkit_zoom);
defsubr (&Sxwidget_webkit_execute_script);
DEFSYM (Qwebkit, "webkit");
defsubr (&Sxwidget_size_request);
defsubr (&Sdelete_xwidget_view);
defsubr (&Sxwidget_plist);
defsubr (&Sxwidget_buffer);
defsubr (&Sset_xwidget_plist);
DEFSYM (Qxwidget, "xwidget");
DEFSYM (QCxwidget, ":xwidget");
DEFSYM (QCtitle, ":title");
/* Do not forget to update the docstring of make-xwidget if you add
new types. */
DEFSYM (Qvertical, "vertical");
DEFSYM (Qhorizontal, "horizontal");
DEFSYM (QCplist, ":plist");
DEFVAR_LISP ("xwidget-list", Vxwidget_list,
doc: /* xwidgets list. */);
Vxwidget_list = Qnil;
DEFVAR_LISP ("xwidget-view-list", Vxwidget_view_list,
doc: /* xwidget views list. */);
Vxwidget_view_list = Qnil;
Fprovide (intern ("xwidget-internal"), Qnil);
}
/* Value is non-zero if OBJECT is a valid Lisp xwidget specification. A
valid xwidget specification is a list whose car is the symbol
`xwidget', and whose rest is a property list. The property list must
contain a value for key `:type'. That value must be the name of a
supported xwidget type. The rest of the property list depends on the
xwidget type. */
bool
valid_xwidget_spec_p (Lisp_Object object)
{
return CONSP (object) && EQ (XCAR (object), Qxwidget);
}
/* Find a value associated with key in spec. */
static Lisp_Object
xwidget_spec_value (Lisp_Object spec, Lisp_Object key)
{
Lisp_Object tail;
eassert (valid_xwidget_spec_p (spec));
for (tail = XCDR (spec);
CONSP (tail) && CONSP (XCDR (tail)); tail = XCDR (XCDR (tail)))
{
if (EQ (XCAR (tail), key))
return XCAR (XCDR (tail));
}
return Qnil;
}
void
xwidget_view_delete_all_in_window (struct window *w)
{
struct xwidget_view *xv = NULL;
for (Lisp_Object tail = Vxwidget_view_list; CONSP (tail);
tail = XCDR (tail))
{
if (XWIDGET_VIEW_P (XCAR (tail)))
{
xv = XXWIDGET_VIEW (XCAR (tail));
if (XWINDOW (xv->w) == w)
{
Fdelete_xwidget_view (XCAR (tail));
}
}
}
}
static struct xwidget_view *
xwidget_view_lookup (struct xwidget *xw, struct window *w)
{
Lisp_Object xwidget, window, ret;
XSETXWIDGET (xwidget, xw);
XSETWINDOW (window, w);
ret = Fxwidget_view_lookup (xwidget, window);
return EQ (ret, Qnil) ? NULL : XXWIDGET_VIEW (ret);
}
struct xwidget *
lookup_xwidget (Lisp_Object spec)
{
/* When a xwidget lisp spec is found initialize the C struct that is
used in the C code. This is done by redisplay so values change
if the spec changes. So, take special care of one-shot events. */
Lisp_Object value;
struct xwidget *xw;
value = xwidget_spec_value (spec, QCxwidget);
xw = XXWIDGET (value);
return xw;
}
/* Set up detection of touched xwidget. */
static void
xwidget_start_redisplay (void)
{
for (Lisp_Object tail = Vxwidget_view_list; CONSP (tail);
tail = XCDR (tail))
{
if (XWIDGET_VIEW_P (XCAR (tail)))
XXWIDGET_VIEW (XCAR (tail))->redisplayed = false;
}
}
/* The xwidget was touched during redisplay, so it isn't a candidate
for hiding. */
static void
xwidget_touch (struct xwidget_view *xv)
{
xv->redisplayed = true;
}
static bool
xwidget_touched (struct xwidget_view *xv)
{
return xv->redisplayed;
}
/* Redisplay has ended, now we should hide untouched xwidgets. */
void
xwidget_end_redisplay (struct window *w, struct glyph_matrix *matrix)
{
int i;
int area;
xwidget_start_redisplay ();
/* Iterate desired glyph matrix of window here, hide gtk widgets
not in the desired matrix.
This only takes care of xwidgets in active windows. If a window
goes away from the screen, xwidget views must be deleted.
dump_glyph_matrix (matrix, 2); */
for (i = 0; i < matrix->nrows; ++i)
{
/* dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs); */
struct glyph_row *row;
row = MATRIX_ROW (matrix, i);
if (row->enabled_p)
for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
{
struct glyph *glyph = row->glyphs[area];
struct glyph *glyph_end = glyph + row->used[area];
for (; glyph < glyph_end; ++glyph)
if (glyph->type == XWIDGET_GLYPH)
{
/* The only call to xwidget_end_redisplay is in dispnew.
xwidget_end_redisplay (w->current_matrix); */
struct xwidget_view *xv
= xwidget_view_lookup (glyph->u.xwidget, w);
/* FIXME: Is it safe to assume xwidget_view_lookup
always succeeds here? If so, this comment can be removed.
If not, the code probably needs fixing. */
eassume (xv);
xwidget_touch (xv);
}
}
}
for (Lisp_Object tail = Vxwidget_view_list; CONSP (tail);
tail = XCDR (tail))
{
if (XWIDGET_VIEW_P (XCAR (tail)))
{
struct xwidget_view *xv = XXWIDGET_VIEW (XCAR (tail));
/* "touched" is only meaningful for the current window, so
disregard other views. */
if (XWINDOW (xv->w) == w)
{
if (xwidget_touched (xv))
xwidget_show_view (xv);
else
xwidget_hide_view (xv);
}
}
}
}
/* Kill all xwidget in BUFFER. */
void
kill_buffer_xwidgets (Lisp_Object buffer)
{
Lisp_Object tail, xwidget;
for (tail = Fget_buffer_xwidgets (buffer); CONSP (tail); tail = XCDR (tail))
{
xwidget = XCAR (tail);
Vxwidget_list = Fdelq (xwidget, Vxwidget_list);
/* TODO free the GTK things in xw. */
{
CHECK_XWIDGET (xwidget);
struct xwidget *xw = XXWIDGET (xwidget);
if (xw->widget_osr && xw->widgetwindow_osr)
{
gtk_widget_destroy (xw->widget_osr);
gtk_widget_destroy (xw->widgetwindow_osr);
}
if (!NILP (xw->script_callbacks))
{
ptrdiff_t idx;
for (idx = 0; idx < ASIZE (xw->script_callbacks); idx++)
{
if (!NILP (AREF (xw->script_callbacks, idx)))
xfree (XSAVE_POINTER (XCAR (AREF (xw->script_callbacks, idx)), 0));
ASET (xw->script_callbacks, idx, Qnil);
}
}
}
}
}
|