code.delx.au - gnu-emacs/blob - lisp/xwidget.el

   1 ;;; xwidget.el --- api functions for xwidgets  -*- lexical-binding: t -*-
   2 ;;
   3 ;; Copyright (C) 2011-2016 Free Software Foundation, Inc.
   4 ;;
   5 ;; Author: Joakim Verona (joakim@verona.se)
   6 ;;
   7 ;; This file is part of GNU Emacs.
   8 ;;
   9 ;; GNU Emacs is free software: you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation, either version 3 of the License, or
  12 ;; (at your option) any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  21 ;;
  22 ;; --------------------------------------------------------------------
  23
  24 ;;; Commentary:
  25 ;;
  26 ;; See xwidget.c for more api functions
  27
  28 ;;TODO this breaks compilation when we dont have xwidgets
  29 ;;(require 'xwidget-internal)
  30
  31 ;;; Code:
  32
  33 (require 'cl-lib)
  34 (require 'reporter)
  35 (require 'bookmark)
  36
  37 (defcustom xwidget-webkit-scroll-behaviour 'native
  38   "Scroll behaviour of the webkit instance.
  39 'native or 'image."
  40   :group 'xwidgets)
  41
  42 (defun xwidget-insert (pos type title width height &optional args)
  43   "Insert an xwidget at POS.
  44 given ID, TYPE, TITLE WIDTH and
  45 HEIGHT in the current buffer.
  46
  47 Return ID
  48
  49 see `make-xwidget' for types suitable for TYPE.
  50 Optional argument ARGS usage depends on the xwidget."
  51   (goto-char pos)
  52   (let ((id (make-xwidget (point) (point)
  53                           type title width height args)))
  54     (put-text-property (point) (+ 1 (point))
  55                        'display (list 'xwidget ':xwidget id))
  56     id))
  57
  58 (defun xwidget-at (pos)
  59   "Return xwidget at POS."
  60   ;;TODO this function is a bit tedious because the C layer isnt well
  61   ;;protected yet and xwidgetp aparently doesnt work yet
  62   (let* ((disp (get-text-property pos 'display))
  63          (xw (car (cdr (cdr  disp)))))
  64     ;;(if ( xwidgetp  xw) xw nil)
  65     (if (equal 'xwidget (car disp)) xw)))
  66
  67
  68
  69 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  70 ;;; webkit support
  71 (require 'browse-url)
  72 (require 'image-mode);;for some image-mode alike functionality
  73
  74 ;;;###autoload
  75 (defun xwidget-webkit-browse-url (url &optional new-session)
  76   "Ask xwidget-webkit to browse URL.
  77 NEW-SESSION specifies whether to create a new xwidget-webkit session.  URL
  78 defaults to the string looking like a url around the cursor position."
  79   (interactive (progn
  80                  (require 'browse-url)
  81                  (browse-url-interactive-arg "xwidget-webkit URL: "
  82                                              ;;( xwidget-webkit-current-url)
  83                                              )))
  84   (when (stringp url)
  85     (if new-session
  86         (xwidget-webkit-new-session url)
  87       (xwidget-webkit-goto-url url))))
  88
  89
  90 ;;shims for adapting image mode code to the webkit browser window
  91 (defun xwidget-image-display-size  (spec &optional pixels frame)
  92   "Image code adaptor.  SPEC PIXELS FRAME like the corresponding
  93 `image-mode' fn."
  94   (let ((xwi (xwidget-info  (xwidget-at 1))))
  95     (cons (aref xwi 2)
  96           (aref xwi 3))))
  97
  98 (defadvice image-display-size (around image-display-size-for-xwidget
  99                                       (spec &optional pixels frame)
 100                                       activate)
 101   "Advice for re-using image mode for xwidget."
 102   (if (eq (car spec) 'xwidget)
 103       (setq ad-return-value (xwidget-image-display-size spec pixels frame))
 104     ad-do-it))
 105
 106 ;;todo.
 107 ;; - check that the webkit support is compiled in
 108 (defvar xwidget-webkit-mode-map
 109   (let ((map (make-sparse-keymap)))
 110     (define-key map "g" 'xwidget-webkit-browse-url)
 111     (define-key map "a" 'xwidget-webkit-adjust-size-dispatch)
 112     (define-key map "b" 'xwidget-webkit-back )
 113     (define-key map "r" 'xwidget-webkit-reload )
 114     (define-key map "t" (lambda () (interactive) (message "o")) )
 115     (define-key map "\C-m" 'xwidget-webkit-insert-string)
 116     (define-key map "w" 'xwidget-webkit-current-url)
 117
 118     ;;similar to image mode bindings
 119     (define-key map (kbd "SPC")                 'xwidget-webkit-scroll-up)
 120     (define-key map (kbd "DEL")                 'xwidget-webkit-scroll-down)
 121
 122     (define-key map [remap scroll-up]           'xwidget-webkit-scroll-up)
 123     (define-key map [remap scroll-up-command]   'xwidget-webkit-scroll-up)
 124
 125     (define-key map [remap scroll-down]         'xwidget-webkit-scroll-down)
 126     (define-key map [remap scroll-down-command] 'xwidget-webkit-scroll-down)
 127
 128     (define-key map [remap forward-char]        'xwidget-webkit-scroll-forward)
 129     (define-key map [remap backward-char]       'xwidget-webkit-scroll-backward)
 130     (define-key map [remap right-char]          'xwidget-webkit-scroll-forward)
 131     (define-key map [remap left-char]           'xwidget-webkit-scroll-backward)
 132     ;; (define-key map [remap previous-line]          'image-previous-line)
 133     ;; (define-key map [remap next-line]              'image-next-line)
 134
 135     ;; (define-key map [remap move-beginning-of-line] 'image-bol)
 136     ;; (define-key map [remap move-end-of-line]       'image-eol)
 137     ;; (define-key map [remap beginning-of-buffer]    'image-bob)
 138     ;; (define-key map [remap end-of-buffer]          'image-eob)
 139     map)
 140   "Keymap for `xwidget-webkit-mode'.")
 141
 142 (defun xwidget-webkit-scroll-up ()
 143   "Scroll webkit up,either native or like image mode."
 144   (interactive)
 145   (if (eq xwidget-webkit-scroll-behaviour 'native)
 146       (xwidget-set-adjustment (xwidget-webkit-last-session) 'vertical t 50)
 147     (image-scroll-up)))
 148
 149 (defun xwidget-webkit-scroll-down ()
 150   "Scroll webkit down,either native or like image mode."
 151   (interactive)
 152   (if (eq xwidget-webkit-scroll-behaviour 'native)
 153       (xwidget-set-adjustment (xwidget-webkit-last-session) 'vertical t -50)
 154     (image-scroll-down)))
 155
 156 (defun xwidget-webkit-scroll-forward ()
 157   "Scroll webkit forward,either native or like image mode."
 158   (interactive)
 159   (if (eq xwidget-webkit-scroll-behaviour 'native)
 160       (xwidget-set-adjustment (xwidget-webkit-last-session) 'horizontal t 50)
 161     (xwidget-webkit-scroll-forward)))
 162
 163 (defun xwidget-webkit-scroll-backward ()
 164   "Scroll webkit backward,either native or like image mode."
 165   (interactive)
 166   (if (eq xwidget-webkit-scroll-behaviour 'native)
 167       (xwidget-set-adjustment (xwidget-webkit-last-session) 'horizontal t -50)
 168     (xwidget-webkit-scroll-backward)))
 169
 170
 171 ;;the xwidget event needs to go into a higher level handler
 172 ;;since the xwidget can generate an event even if its offscreen
 173 ;;TODO this needs to use callbacks and consider different xw ev types
 174 (define-key (current-global-map) [xwidget-event] 'xwidget-event-handler)
 175 (defun xwidget-log ( &rest msg)
 176   "Log MSG to a buffer."
 177   (let ( (buf  (get-buffer-create "*xwidget-log*")))
 178     (save-excursion
 179       (buffer-disable-undo buf)
 180       (set-buffer buf)
 181       (insert (apply  'format msg))
 182       (insert "\n"))))
 183
 184 (defun xwidget-event-handler ()
 185   "Receive xwidget event."
 186   (interactive)
 187   (xwidget-log "stuff happened to xwidget %S" last-input-event)
 188   (let*
 189       ((xwidget-event-type (nth 1 last-input-event))
 190        (xwidget (nth 2 last-input-event))
 191        ;;(xwidget-callback (xwidget-get xwidget 'callback))
 192        ;;TODO stopped working for some reason
 193        )
 194     ;;(funcall  xwidget-callback xwidget xwidget-event-type)
 195     (message "xw callback %s" xwidget)
 196     (funcall  'xwidget-webkit-callback xwidget xwidget-event-type)))
 197
 198 (defun xwidget-webkit-callback (xwidget xwidget-event-type)
 199   "Callback for xwidgets.
 200 XWIDGET instance, XWIDGET-EVENT-TYPE depends on the originating xwidget."
 201   (save-excursion
 202     (cond ((buffer-live-p (xwidget-buffer xwidget))
 203            (set-buffer (xwidget-buffer xwidget))
 204            (let* ((strarg  (nth 3 last-input-event)))
 205              (cond ((eq xwidget-event-type 'document-load-finished)
 206                     (xwidget-log "webkit finished loading: '%s'"
 207                                  (xwidget-webkit-get-title xwidget))
 208                     ;;TODO - check the native/internal scroll
 209                     ;;(xwidget-adjust-size-to-content xwidget)
 210                     (xwidget-webkit-adjust-size-dispatch) ;;TODO xwidget arg
 211                     (rename-buffer (format "*xwidget webkit: %s *"
 212                                            (xwidget-webkit-get-title xwidget)))
 213                     (pop-to-buffer (current-buffer)))
 214                    ((eq xwidget-event-type
 215                         'navigation-policy-decision-requested)
 216                     (if (string-match ".*#\\(.*\\)" strarg)
 217                         (xwidget-webkit-show-id-or-named-element
 218                          xwidget
 219                          (match-string 1 strarg))))
 220                    (t (xwidget-log "unhandled event:%s" xwidget-event-type)))))
 221           (t (xwidget-log
 222               "error: callback called for xwidget with dead buffer")))))
 223
 224 (defvar bookmark-make-record-function)
 225 (define-derived-mode xwidget-webkit-mode
 226   special-mode "xwidget-webkit" "xwidget webkit view mode"
 227   (setq buffer-read-only t)
 228   (setq-local bookmark-make-record-function
 229               #'xwidget-webkit-bookmark-make-record)
 230   ;; Keep track of [vh]scroll when switching buffers
 231   (image-mode-setup-winprops))
 232
 233 (defun xwidget-webkit-bookmark-make-record ()
 234 "Integrate Emacs bookmarks with the webkit xwidget."
 235   (nconc (bookmark-make-record-default t t)
 236          `((page     . ,(xwidget-webkit-current-url))
 237            (handler  . (lambda (bmk) (browse-url
 238                                       (bookmark-prop-get bmk 'page)))))))
 239
 240
 241 (defvar xwidget-webkit-last-session-buffer nil)
 242
 243 (defun  xwidget-webkit-last-session ()
 244   "Last active webkit, or nil."
 245   (if (buffer-live-p xwidget-webkit-last-session-buffer)
 246       (with-current-buffer xwidget-webkit-last-session-buffer
 247         (xwidget-at 1))
 248     nil))
 249
 250 (defun xwidget-webkit-current-session ()
 251   "Either the webkit in the current buffer, or the last one used,
 252 which might be nil."
 253   (if (xwidget-at 1)
 254       (xwidget-at 1)
 255     (xwidget-webkit-last-session)))
 256
 257 (defun xwidget-adjust-size-to-content (xw)
 258   "Resize XW to content."
 259   ;;xwidgets doesnt support widgets that have their own opinions about
 260   ;;size well yet this reads the desired size and resizes the emacs
 261   ;;allocated area accordingly
 262   (let ((size (xwidget-size-request xw)))
 263     (xwidget-resize xw (car size) (cadr size))))
 264
 265
 266 (defvar xwidget-webkit-activeelement-js"
 267 function findactiveelement(doc){
 268 //alert(doc.activeElement.value);
 269    if(doc.activeElement.value != undefined){
 270       return doc.activeElement;
 271    }else{
 272         // recurse over the child documents:
 273         var frames = doc.getElementsByTagName('frame');
 274         for (var i = 0; i < frames.length; i++)
 275         {
 276                 var d = frames[i].contentDocument;
 277                  var rv = findactiveelement(d);
 278                  if(rv != undefined){
 279                     return rv;
 280                  }
 281         }
 282     }
 283     return undefined;
 284 };
 285
 286
 287 "
 288
 289   "javascript that finds the active element."
 290   ;;yes its ugly. because:
 291   ;; - there is aparently no way to find the active frame other than recursion
 292   ;; - the js "for each" construct missbehaved on the "frames" collection
 293   ;; - a window with no frameset still has frames.length == 1, but
 294   ;; frames[0].document.activeElement != document.activeElement
 295   ;;TODO the activeelement type needs to be examined, for iframe, etc.
 296   )
 297
 298 (defun xwidget-webkit-insert-string (xw str)
 299   "Insert string in the active field in the webkit.
 300 Argument XW webkit.
 301 Argument STR string."
 302   ;;read out the string in the field first and provide for edit
 303   (interactive
 304    (let* ((xww (xwidget-webkit-current-session))
 305
 306           (field-value
 307            (progn
 308              (xwidget-webkit-execute-script xww xwidget-webkit-activeelement-js)
 309              (xwidget-webkit-execute-script-rv
 310               xww
 311               "findactiveelement(document).value;" )))
 312           (field-type (xwidget-webkit-execute-script-rv
 313                        xww
 314                        "findactiveelement(document).type;" )))
 315      (list xww
 316            (cond ((equal "text" field-type)
 317                   (read-string "text:" field-value))
 318                  ((equal "password" field-type)
 319                   (read-passwd "password:" nil field-value))
 320                  ((equal "textarea" field-type)
 321                   (xwidget-webkit-begin-edit-textarea xww field-value))))))
 322   (xwidget-webkit-execute-script
 323    xw
 324    (format "findactiveelement(document).value='%s'" str)))
 325
 326 (defvar xwidget-xwbl)
 327 (defun xwidget-webkit-begin-edit-textarea (xw text)
 328   "Start editing of a webkit text area.
 329 XW is the xwidget identifier, TEXT is retrieved from the webkit."
 330   (switch-to-buffer
 331    (generate-new-buffer "textarea"))
 332
 333   (set (make-local-variable 'xwidget-xwbl) xw)
 334   (insert text))
 335
 336 (defun xwidget-webkit-end-edit-textarea ()
 337     "End editing of a webkit text area."
 338   (interactive)
 339   (goto-char (point-min))
 340   (while (search-forward "\n" nil t)
 341     (replace-match "\\n" nil t))
 342   (xwidget-webkit-execute-script
 343    xwidget-xwbl
 344    (format "findactiveelement(document).value='%s'"
 345            (buffer-substring (point-min) (point-max))))
 346   ;;TODO convert linefeed to \n
 347   )
 348
 349 (defun xwidget-webkit-show-named-element (xw element-name)
 350   "Make named-element show.  for instance an anchor.
 351 Argument XW is the xwidget.
 352 Argument ELEMENT-NAME is the element name to display in the webkit xwidget."
 353   (interactive (list (xwidget-webkit-current-session)
 354                      (read-string "element name:")))
 355   ;;TODO since an xwidget is an Emacs object, it is not trivial to do
 356   ;; some things that are taken for granted in a normal browser.
 357   ;; scrolling an anchor/named-element into view is one such thing.
 358   ;; This function implements a proof-of-concept for this.  Problems
 359   ;; remaining: - The selected window is scrolled but this is not
 360   ;; always correct - This needs to be interfaced into browse-url
 361   ;; somehow. the tricky part is that we need to do this in two steps:
 362   ;; A: load the base url, wait for load signal to arrive B: navigate
 363   ;; to the anchor when the base url is finished rendering
 364
 365   ;; This part figures out the Y coordinate of the element
 366   (let ((y (string-to-number
 367             (xwidget-webkit-execute-script-rv
 368              xw
 369              (format
 370               "document.getElementsByName('%s')[0].getBoundingClientRect().top"
 371               element-name)
 372              0))))
 373     ;; Now we need to tell emacs to scroll the element into view.
 374     (xwidget-log "scroll: %d" y)
 375     (set-window-vscroll (selected-window) y t)))
 376
 377 (defun xwidget-webkit-show-id-element (xw element-id)
 378   "Make id-element show.  for instance an anchor.
 379 Argument XW is the webkit xwidget.
 380 Argument ELEMENT-ID is the id of the element to show."
 381   (interactive (list (xwidget-webkit-current-session)
 382                      (read-string "element id:")))
 383   (let ((y (string-to-number
 384             (xwidget-webkit-execute-script-rv
 385              xw
 386              (format "document.getElementById('%s').getBoundingClientRect().top"
 387                      element-id)
 388              0))))
 389     ;; Now we need to tell emacs to scroll the element into view.
 390     (xwidget-log "scroll: %d" y)
 391     (set-window-vscroll (selected-window) y t)))
 392
 393 (defun xwidget-webkit-show-id-or-named-element (xw element-id)
 394   "Make id-element show.  for instance an anchor.
 395 Argument XW is the webkit xwidget.
 396 Argument ELEMENT-ID is either a name or an element id."
 397   (interactive (list (xwidget-webkit-current-session)
 398                      (read-string "element id:")))
 399   (let* ((y1 (string-to-number
 400               (xwidget-webkit-execute-script-rv
 401                xw
 402                (format "document.getElementsByName('%s')[0].getBoundingClientRect().top" element-id)
 403                "0")))
 404          (y2 (string-to-number
 405               (xwidget-webkit-execute-script-rv
 406                xw
 407                (format "document.getElementById('%s').getBoundingClientRect().top" element-id)
 408                                                 "0")))
 409          (y3 (max y1 y2)))
 410     ;; Now we need to tell emacs to scroll the element into view.
 411     (xwidget-log "scroll: %d" y3)
 412     (set-window-vscroll (selected-window) y3 t)))
 413
 414 (defun xwidget-webkit-adjust-size-to-content ()
 415   "Adjust webkit to content size."
 416   (interactive)
 417   (xwidget-adjust-size-to-content (xwidget-webkit-current-session)))
 418
 419 (defun xwidget-webkit-adjust-size-dispatch ()
 420   "Adjust size according to mode."
 421   (interactive)
 422   (if (eq xwidget-webkit-scroll-behaviour 'native)
 423       (xwidget-webkit-adjust-size-to-window)
 424     (xwidget-webkit-adjust-size-to-content))
 425   ;; The recenter is intended to correct a visual glitch.
 426   ;; It errors out if the buffer isn't visible, but then we dont get the glitch,
 427   ;; so silence errors
 428   (ignore-errors
 429     (recenter-top-bottom))
 430   )
 431
 432 (defun xwidget-webkit-adjust-size-to-window ()
 433   "Adjust webkit to window."
 434   (interactive)
 435   (xwidget-resize ( xwidget-webkit-current-session) (window-pixel-width)
 436                   (window-pixel-height)))
 437
 438 (defun xwidget-webkit-adjust-size (w h)
 439   "Manualy set webkit size.
 440 Argument W width.
 441 Argument H height."
 442   ;; TODO shouldn't be tied to the webkit xwidget
 443   (interactive "nWidth:\nnHeight:\n")
 444   (xwidget-resize ( xwidget-webkit-current-session) w h))
 445
 446 (defun xwidget-webkit-fit-width ()
 447   "Adjust width of webkit to window width."
 448   (interactive)
 449   (xwidget-webkit-adjust-size (- (nth 2 (window-inside-pixel-edges))
 450                                  (car (window-inside-pixel-edges)))
 451                               1000))
 452
 453 (defun xwidget-webkit-new-session (url)
 454   "Create a new webkit session buffer with URL."
 455   (let*
 456       ((bufname (generate-new-buffer-name "*xwidget-webkit*"))
 457        xw)
 458     (setq xwidget-webkit-last-session-buffer (switch-to-buffer
 459                                               (get-buffer-create bufname)))
 460     (insert " 'a' adjusts the xwidget size.")
 461     (setq xw (xwidget-insert 1 'webkit-osr  bufname 1000 1000))
 462     (xwidget-put xw 'callback 'xwidget-webkit-callback)
 463     (xwidget-webkit-mode)
 464     (xwidget-webkit-goto-uri (xwidget-webkit-last-session) url )))
 465
 466
 467 (defun xwidget-webkit-goto-url (url)
 468   "Goto URL."
 469   (if (xwidget-webkit-current-session)
 470       (progn
 471         (xwidget-webkit-goto-uri (xwidget-webkit-current-session) url))
 472     (xwidget-webkit-new-session url)))
 473
 474 (defun xwidget-webkit-back ()
 475   "Back in history."
 476   (interactive)
 477   (xwidget-webkit-execute-script (xwidget-webkit-current-session)
 478                                  "history.go(-1);"))
 479
 480 (defun xwidget-webkit-reload ()
 481   "Reload current url."
 482   (interactive)
 483   (xwidget-webkit-execute-script (xwidget-webkit-current-session)
 484                                  "history.go(0);"))
 485
 486 (defun xwidget-webkit-current-url ()
 487   "Get the webkit url.  place it on kill ring."
 488   (interactive)
 489   (let* ((rv (xwidget-webkit-execute-script-rv (xwidget-webkit-current-session)
 490                                                "document.URL"))
 491          (url (kill-new (or rv ""))))
 492     (message "url: %s" url )
 493     url))
 494
 495 (defun xwidget-webkit-execute-script-rv (xw script &optional default)
 496   "Same as 'xwidget-webkit-execute-script' but but with return value.
 497 XW is the webkit instance.  SCRIPT is the script to execut.
 498 DEFAULT is the defaultreturn value."
 499   ;; Notice the ugly "title" hack.  It is needed because the Webkit
 500   ;; API at the time of writing didn't support returning values.  This
 501   ;; is a wrapper for the title hack so its easy to remove should
 502   ;; Webkit someday support JS return values or we find some other way
 503   ;; to access the DOM.
 504
 505   ;; Reset webkit title. Not very nice.
 506   (let* ((emptytag "titlecantbewhitespaceohthehorror")
 507          title)
 508     (xwidget-webkit-execute-script xw (format "document.title=\"%s\";"
 509                                               (or default emptytag)))
 510     (xwidget-webkit-execute-script xw (format "document.title=%s;" script))
 511     (setq title (xwidget-webkit-get-title xw))
 512     (if (equal emptytag title)
 513         (setq title ""))
 514     (unless title
 515       (setq title default))
 516     title))
 517
 518
 519 ;; Use declare here?
 520 ;; (declare-function xwidget-resize-internal "xwidget.c" )
 521 ;; check-declare-function?
 522
 523 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 524 (defun xwidget-webkit-get-selection ()
 525   "Get the webkit selection."
 526   (xwidget-webkit-execute-script-rv (xwidget-webkit-current-session)
 527                                     "window.getSelection().toString();"))
 528
 529 (defun xwidget-webkit-copy-selection-as-kill ()
 530   "Get the webkit selection and put it on the kill ring."
 531   (interactive)
 532   (kill-new (xwidget-webkit-get-selection)))
 533
 534
 535 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 536 ;; Xwidget plist management(similar to the process plist functions)
 537
 538 (defun xwidget-get (xwidget propname)
 539   "Return the value of XWIDGET' PROPNAME property.
 540 This is the last value stored with `(xwidget-put XWIDGET PROPNAME VALUE)'."
 541   (plist-get (xwidget-plist xwidget) propname))
 542
 543 (defun xwidget-put (xwidget propname value)
 544   "Change XWIDGET' PROPNAME property to VALUE.
 545 It can be retrieved with `(xwidget-get XWIDGET PROPNAME)'."
 546   (set-xwidget-plist xwidget
 547                      (plist-put (xwidget-plist xwidget) propname value)))
 548
 549
 550 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 551
 552 (defun xwidget-delete-zombies ()
 553   "Helper for `xwidget-cleanup'."
 554   (dolist (xwidget-view xwidget-view-list)
 555     (when (or (not (window-live-p (xwidget-view-window xwidget-view)))
 556               (not (memq (xwidget-view-model xwidget-view)
 557                          xwidget-list)))
 558       (delete-xwidget-view xwidget-view))))
 559
 560 (defun xwidget-cleanup ()
 561   "Delete zombie xwidgets."
 562   ;; During development it was sometimes easy to wind up with zombie
 563   ;; xwidget instances.
 564   ;; This function tries to implement a workaround should it occur again.
 565   (interactive)
 566   ;; Kill xviews who should have been deleted but stull linger.
 567   (xwidget-delete-zombies)
 568   ;; Redraw display otherwise ghost of zombies will remain to haunt the screen
 569   (redraw-display))
 570
 571 ;; This would have felt better in C, but this seems to work well in
 572 ;; practice though.
 573 (add-hook 'window-configuration-change-hook 'xwidget-delete-zombies)
 574
 575 (defun xwidget-kill-buffer-query-function ()
 576   "Ask beforek illing a buffer that has xwidgets."
 577   (let ((xwidgets (get-buffer-xwidgets (current-buffer))))
 578     (or (not xwidgets)
 579         (not (memq t (mapcar 'xwidget-query-on-exit-flag xwidgets)))
 580         (yes-or-no-p
 581          (format "Buffer %S has xwidgets; kill it? "
 582                  (buffer-name (current-buffer)))))))
 583
 584 (add-hook 'kill-buffer-query-functions 'xwidget-kill-buffer-query-function)
 585
 586 (defun report-xwidget-bug ()
 587   "Report a bug in GNU Emacs about the XWidget branch.
 588 Prompts for bug subject.  Leaves you in a mail buffer."
 589   (interactive)
 590   (let ((reporter-prompt-for-summary-p t))
 591     (reporter-submit-bug-report "submit@debbugs.gnu.org" nil nil nil nil
 592                                 (format "Package: emacs-xwidgets
 593
 594 Please describe exactly what actions triggered the bug, and the
 595 precise symptoms of the bug.  If you can, give a recipe starting
 596 from `emacs -Q'.
 597
 598 If Emacs crashed, and you have the Emacs process in the gdb
 599 deubbger, please include the output from the following gdb
 600 commands:
 601     `bt full' and `xbacktrace'.
 602
 603 For information about debugging Emacs, please read the file
 604 %s" (expand-file-name "DEBUG" data-directory)))))
 605
 606 (provide 'xwidget)
 607
 608 ;;; xwidget.el ends here