/* Support for embedding graphical components in a buffer. Copyright (C) 2011-2020 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 . */ #include #include "xwidget.h" #include "lisp.h" #include "blockinput.h" #include "dispextern.h" #include "frame.h" #include "keyboard.h" #include "gtkutil.h" #include "sysstdio.h" #include "termhooks.h" #include "window.h" /* Include xwidget bottom end headers. */ #ifdef USE_GTK #include #include #elif defined NS_IMPL_COCOA #include "nsxwidget.h" #endif static struct xwidget * allocate_xwidget (void) { return ALLOCATE_PSEUDOVECTOR (struct xwidget, script_callbacks, PVEC_XWIDGET); } static struct xwidget_view * allocate_xwidget_view (void) { return ALLOCATE_PSEUDOVECTOR (struct xwidget_view, w, 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 *); #ifdef USE_GTK 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); #endif 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) { #ifdef USE_GTK if (!xg_gtk_initialized) error ("make-xwidget: GTK has not been initialized"); #endif CHECK_SYMBOL (type); CHECK_FIXNAT (width); CHECK_FIXNAT (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, Qnil)); xw->height = XFIXNAT (height); xw->width = XFIXNAT (width); xw->kill_without_query = false; XSETXWIDGET (val, xw); Vxwidget_list = Fcons (val, Vxwidget_list); xw->plist = Qnil; #ifdef USE_GTK xw->widgetwindow_osr = NULL; xw->widget_osr = NULL; if (EQ (xw->type, Qwebkit)) { block_input (); WebKitWebContext *webkit_context = webkit_web_context_get_default (); # if WEBKIT_CHECK_VERSION (2, 26, 0) if (!webkit_web_context_get_sandbox_enabled (webkit_context)) webkit_web_context_set_sandbox_enabled (webkit_context, TRUE); # endif 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 (); /* webkitgtk uses GSubprocess which sets sigaction causing Emacs to not catch SIGCHLD with its usual handle setup in catch_child_signal(). This resets the SIGCHLD sigaction. */ struct sigaction old_action; sigaction (SIGCHLD, NULL, &old_action); webkit_web_view_load_uri(WEBKIT_WEB_VIEW (xw->widget_osr), "about:blank"); sigaction (SIGCHLD, &old_action, NULL); } 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_context), "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 (); } #elif defined NS_IMPL_COCOA nsxwidget_init (xw); #endif 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; } #ifdef USE_GTK 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 message ("Warning, offscreen_damage_event received invalid xv pointer:%p\n", xv_widget); return FALSE; } #endif /* USE_GTK */ 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); } void store_xwidget_download_callback_event (struct xwidget *xw, const char *url, const char *mimetype, const char *filename) { struct input_event event; Lisp_Object xwl; XSETXWIDGET (xwl, xw); EVENT_INIT (event); event.kind = XWIDGET_EVENT; event.frame_or_window = Qnil; event.arg = list5 (intern ("download-callback"), xwl, build_string (url), build_string (mimetype), build_string (filename)); kbd_buffer_store_event (&event); } 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); } #ifdef USE_GTK 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 (JSCValue *value) { if (jsc_value_is_string (value)) { gchar *str_value = jsc_value_to_string (value); Lisp_Object ret = build_string (str_value); g_free (str_value); return ret; } else if (jsc_value_is_boolean (value)) { return (jsc_value_to_boolean (value)) ? Qt : Qnil; } else if (jsc_value_is_number (value)) { return make_fixnum (jsc_value_to_int32 (value)); } else if (jsc_value_is_array (value)) { JSCValue *len = jsc_value_object_get_property (value, "length"); const gint32 dlen = jsc_value_to_int32 (len); Lisp_Object obj; if (! (0 <= dlen && dlen < PTRDIFF_MAX + 1.0)) memory_full (SIZE_MAX); ptrdiff_t n = dlen; struct Lisp_Vector *p = allocate_nil_vector (n); for (ptrdiff_t i = 0; i < n; ++i) { p->contents[i] = webkit_js_to_lisp (jsc_value_object_get_property_at_index (value, i)); } XSETVECTOR (obj, p); return obj; } else if (jsc_value_is_object (value)) { char **properties_names = jsc_value_object_enumerate_properties (value); guint n = g_strv_length (properties_names); Lisp_Object obj; if (PTRDIFF_MAX < n) memory_full (n); struct Lisp_Vector *p = allocate_nil_vector (n); for (ptrdiff_t i = 0; i < n; ++i) { const char *name = properties_names[i]; JSCValue *property = jsc_value_object_get_property (value, name); p->contents[i] = Fcons (build_string (name), webkit_js_to_lisp (property)); } g_strfreev (properties_names); XSETVECTOR (obj, p); return obj; } return Qnil; } static void webkit_javascript_finished_cb (GObject *webview, GAsyncResult *result, gpointer arg) { GError *error = NULL; struct xwidget *xw = g_object_get_data (G_OBJECT (webview), XG_XWIDGET); ptrdiff_t script_idx = (intptr_t) arg; Lisp_Object script_callback = AREF (xw->script_callbacks, script_idx); ASET (xw->script_callbacks, script_idx, Qnil); if (!NILP (script_callback)) xfree (xmint_pointer (XCAR (script_callback))); WebKitJavascriptResult *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))) { JSCValue *value = webkit_javascript_result_get_js_value (js_result); Lisp_Object lisp_value = webkit_js_to_lisp (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; } #endif /* USE_GTK */ /* 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) { #ifdef USE_GTK if (!xg_gtk_initialized) error ("xwidget_init_view: GTK has not been initialized"); #endif 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); #ifdef USE_GTK 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); #elif defined NS_IMPL_COCOA nsxwidget_init_view (xv, xww, s, x, y); nsxwidget_resize_view(xv, xww->width, xww->height); #endif 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 text_area_x, text_area_y, text_area_width, text_area_height; 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. */ #ifdef USE_GTK if (!xv) xv = xwidget_init_view (xww, s, x, y); #elif defined NS_IMPL_COCOA if (!xv) { /* Enforce 1 to 1, model and view for macOS Cocoa webkit2. */ if (xww->xv) { if (xwidget_hidden (xww->xv)) { Lisp_Object xvl; XSETXWIDGET_VIEW (xvl, xww->xv); Fdelete_xwidget_view (xvl); } else { message ("You can't share an xwidget (webkit2) among windows."); return; } } xv = xwidget_init_view (xww, s, x, y); } #endif window_box (s->w, TEXT_AREA, &text_area_x, &text_area_y, &text_area_width, &text_area_height); /* Resize xwidget webkit if its container window size is changed in some ways, for example, a buffer became hidden in small split window, then it can appear front in merged whole window. */ if (EQ (xww->type, Qwebkit) && (xww->width != text_area_width || xww->height != text_area_height)) { Lisp_Object xwl; XSETXWIDGET (xwl, xww); Fxwidget_resize (xwl, make_int (text_area_width), make_int (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) { #ifdef USE_GTK gtk_fixed_move (GTK_FIXED (FRAME_GTK_WIDGET (s->f)), xv->widgetwindow, x + clip_left, y + clip_top); #elif defined NS_IMPL_COCOA nsxwidget_move_view (xv, x + clip_left, y + clip_top); #endif } /* 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) { #ifdef USE_GTK 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); #elif defined NS_IMPL_COCOA nsxwidget_resize_view (xv, clip_right - clip_left, clip_bottom - clip_top); nsxwidget_move_widget_in_view (xv, -clip_left, -clip_top); #endif 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)) { #ifdef USE_GTK gtk_widget_queue_draw (xv->widgetwindow); gtk_widget_queue_draw (xv->widget); #elif defined NS_IMPL_COCOA nsxwidget_set_needsdisplay (xv); #endif } } static bool xwidget_is_web_view (struct xwidget *xw) { #ifdef USE_GTK return xw->widget_osr != NULL && WEBKIT_IS_WEB_VIEW (xw->widget_osr); #elif defined NS_IMPL_COCOA return nsxwidget_is_web_view (xw); #endif } /* Macro that checks xwidget hold webkit web view first. */ #define WEBKIT_FN_INIT() \ CHECK_XWIDGET (xwidget); \ struct xwidget *xw = XXWIDGET (xwidget); \ if (!xwidget_is_web_view (xw)) \ { \ fputs ("ERROR xw->widget_osr does not hold a webkit instance\n", \ stdout); \ return Qnil; \ } DEFUN ("xwidget-webkit-uri", Fxwidget_webkit_uri, Sxwidget_webkit_uri, 1, 1, 0, doc: /* Get the current URL of XWIDGET webkit. */) (Lisp_Object xwidget) { WEBKIT_FN_INIT (); #ifdef USE_GTK WebKitWebView *wkwv = WEBKIT_WEB_VIEW (xw->widget_osr); return build_string (webkit_web_view_get_uri (wkwv)); #elif defined NS_IMPL_COCOA return nsxwidget_webkit_uri (xw); #endif } DEFUN ("xwidget-webkit-title", Fxwidget_webkit_title, Sxwidget_webkit_title, 1, 1, 0, doc: /* Get the current title of XWIDGET webkit. */) (Lisp_Object xwidget) { WEBKIT_FN_INIT (); #ifdef USE_GTK WebKitWebView *wkwv = WEBKIT_WEB_VIEW (xw->widget_osr); const gchar *title = webkit_web_view_get_title (wkwv); return build_string (title ? title : ""); #elif defined NS_IMPL_COCOA return nsxwidget_webkit_title (xw); #endif } 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); #ifdef USE_GTK webkit_web_view_load_uri (WEBKIT_WEB_VIEW (xw->widget_osr), SSDATA (uri)); #elif defined NS_IMPL_COCOA nsxwidget_webkit_goto_uri (xw, SSDATA (uri)); #endif return Qnil; } DEFUN ("xwidget-webkit-goto-history", Fxwidget_webkit_goto_history, Sxwidget_webkit_goto_history, 2, 2, 0, doc: /* Make the XWIDGET webkit load REL-POS (-1, 0, 1) page in browse history. */) (Lisp_Object xwidget, Lisp_Object rel_pos) { WEBKIT_FN_INIT (); /* Should be one of -1, 0, 1 */ if (XFIXNUM (rel_pos) < -1 || XFIXNUM (rel_pos) > 1) args_out_of_range_3 (rel_pos, make_fixnum (-1), make_fixnum (1)); #ifdef USE_GTK WebKitWebView *wkwv = WEBKIT_WEB_VIEW (xw->widget_osr); switch (XFIXNAT (rel_pos)) { case -1: webkit_web_view_go_back (wkwv); break; case 0: webkit_web_view_reload (wkwv); break; case 1: webkit_web_view_go_forward (wkwv); break; } #elif defined NS_IMPL_COCOA nsxwidget_webkit_goto_history (xw, XFIXNAT (rel_pos)); #endif 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); #ifdef USE_GTK 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); #elif defined NS_IMPL_COCOA nsxwidget_webkit_zoom (xw, zoom_change); #endif } return Qnil; } #ifdef USE_GTK /* 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) { Lisp_Object cbs = xw->script_callbacks; if (NILP (cbs)) xw->script_callbacks = cbs = make_nil_vector (32); /* Find first free index. */ ptrdiff_t idx; for (idx = 0; !NILP (AREF (cbs, idx)); idx++) if (idx + 1 == ASIZE (cbs)) { xw->script_callbacks = cbs = larger_vector (cbs, 1, -1); break; } ASET (cbs, idx, Fcons (make_mint_ptr (xlispstrdup (script)), fun)); return idx; } #endif 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); #ifdef USE_GTK /* Protect script and fun during GC. */ intptr_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. */ gchar *script_string = xmint_pointer (XCAR (AREF (xw->script_callbacks, idx))); webkit_web_view_run_javascript (WEBKIT_WEB_VIEW (xw->widget_osr), script_string, NULL, /* cancelable */ webkit_javascript_finished_cb, (gpointer) idx); #elif defined NS_IMPL_COCOA nsxwidget_webkit_execute_script (xw, SSDATA (script), fun); #endif 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); int w = check_integer_range (new_width, 0, INT_MAX); int h = check_integer_range (new_height, 0, INT_MAX); struct xwidget *xw = XXWIDGET (xwidget); xw->width = w; xw->height = h; /* If there is an offscreen widget resize it first. */ #ifdef USE_GTK 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); } #elif defined NS_IMPL_COCOA nsxwidget_resize (xw); #endif 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) { #ifdef USE_GTK gtk_widget_set_size_request (GTK_WIDGET (xv->widget), xw->width, xw->height); #elif defined NS_IMPL_COCOA nsxwidget_resize_view(xv, xw->width, xw->height); #endif } } } 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); #ifdef USE_GTK GtkRequisition requisition; gtk_widget_size_request (XXWIDGET (xwidget)->widget_osr, &requisition); return list2i (requisition.width, requisition.height); #elif defined NS_IMPL_COCOA return nsxwidget_get_size (XXWIDGET (xwidget)); #endif } 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_fixed_natnum (xw->width), make_fixed_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_fixnum (xv->x), make_fixnum (xv->y), make_fixnum (xv->clip_right), make_fixnum (xv->clip_bottom), make_fixnum (xv->clip_top), make_fixnum (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); #ifdef USE_GTK gtk_widget_destroy (xv->widgetwindow); /* 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); #elif defined NS_IMPL_COCOA nsxwidget_delete_view (xv); #endif Vxwidget_view_list = Fdelq (xwidget_view, Vxwidget_view_list); 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_uri); defsubr (&Sxwidget_webkit_title); defsubr (&Sxwidget_webkit_goto_uri); defsubr (&Sxwidget_webkit_goto_history); 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 (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 NILP (ret) ? 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); #ifdef USE_GTK /* 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); #elif defined NS_IMPL_COCOA /* In NS xwidget, xv can be NULL for the second or later views for a model, the result of 1 to 1 model view relation enforcement. */ if (xv) xwidget_touch (xv); #endif } } } 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)) { #ifdef USE_GTK xwidget_show_view (xv); #elif defined NS_IMPL_COCOA nsxwidget_show_view (xv); #endif } else { #ifdef USE_GTK xwidget_hide_view (xv); #elif defined NS_IMPL_COCOA nsxwidget_hide_view (xv); #endif } } } } } /* 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); #ifdef USE_GTK if (xw->widget_osr && xw->widgetwindow_osr) { gtk_widget_destroy (xw->widget_osr); gtk_widget_destroy (xw->widgetwindow_osr); } if (!NILP (xw->script_callbacks)) for (ptrdiff_t idx = 0; idx < ASIZE (xw->script_callbacks); idx++) { Lisp_Object cb = AREF (xw->script_callbacks, idx); if (!NILP (cb)) xfree (xmint_pointer (XCAR (cb))); ASET (xw->script_callbacks, idx, Qnil); } #elif defined NS_IMPL_COCOA nsxwidget_kill (xw); #endif } } }