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

   1 ;;; xwidget.el --- api functions for xwidgets
   2 ;;  see xwidget.c for more api functions
   3
   4
   5 ;;; Commentary:
   6 ;;
   7
   8 (require 'xwidget-internal)
   9
  10 ;;TODO model after make-text-button instead!
  11 ;;; Code:
  12
  13 (defun xwidget-insert (pos type title width height)
  14   "Insert an xwidget at POS, given ID, TYPE, TITLE WIDTH and HEIGHT.
  15 Return ID
  16
  17 see xwidget.c for types suitable for TYPE."
  18   (goto-char pos)
  19   (let ((id (make-xwidget (point) (point)  type  title  width  height nil)))
  20     (put-text-property (point)
  21                        (+ 1 (point)) 'display (list 'xwidget ':xwidget id))
  22
  23     id))
  24
  25
  26 (defun xwidget-at (pos)
  27   "Return xwidget at POS."
  28   ;;TODO this function is a bit tedious because the C layer isnt well protected yet and
  29   ;;xwidgetp aparently doesnt work yet
  30   (let* ((disp (get-text-property pos 'display))
  31          (xw (car (cdr (cdr  disp)))))
  32     ;;(if ( xwidgetp  xw) xw nil)
  33     (if (equal 'xwidget (car disp)) xw)
  34     ))
  35
  36
  37
  38
  39 ;; (defun xwidget-socket-handler ()
  40 ;;   "Create plug for socket.  TODO."
  41 ;;   (interactive)
  42 ;;   (message "socket handler xwidget %S" last-input-event)
  43 ;;   (let*
  44 ;;       ((xwidget-event-type (nth 2 last-input-event))
  45 ;;        (xwidget-id (nth 1 last-input-event)))
  46 ;;     (cond ( (eq xwidget-event-type 'xembed-ready)
  47 ;;             (let*
  48 ;;                 ((xembed-id (nth 3 last-input-event)))
  49 ;;               (message "xembed ready  event: %S xw-id:%s" xembed-id xwidget-id)
  50 ;;               ;;TODO fetch process data from the xwidget. create it, store process info
  51 ;;               ;;will start emacs/uzbl in a xembed socket when its ready
  52 ;;               ;; (cond
  53 ;;               ;;  ((eq 3 xwidget-id)
  54 ;;               ;;   (start-process "xembed" "*xembed*" (format "%ssrc/emacs" default-directory) "-q" "--parent-id" (number-to-string xembed-id) ) )
  55 ;;               ;;  ((eq 5 xwidget-id)
  56 ;;               ;;   (start-process "xembed2" "*xembed2*" "uzbl-core"  "-s" (number-to-string xembed-id)  "http://www.fsf.org" )  )
  57 ;;               )))))
  58
  59
  60
  61
  62 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  63 ;;; webkit support
  64 (require 'browse-url)
  65 (require 'image-mode);;for some image-mode alike functinoality
  66 (require 'cl);;for flet
  67
  68 ;;;###autoload
  69 (defun xwidget-webkit-browse-url (url &optional new-session)
  70   "Ask xwidget-webkit to browse URL.
  71 NEW-SESSION specifies whether to create a new xwidget-webkit session.  URL
  72 defaults to the string looking like a url around the cursor position."
  73   (interactive (progn
  74                  (require 'browse-url)
  75                  (browse-url-interactive-arg "xwidget-webkit URL: ")))
  76   (when (stringp url)
  77     (setq url (url-tidy url))
  78     (if new-session
  79         (xwidget-webkit-new-session url)
  80       (xwidget-webkit-goto-url url))))
  81
  82
  83 ;;shims for adapting image mode code to the webkit browser window
  84 (defun xwidget-image-display-size  (spec &optional pixels frame)
  85   "Image code adaptor.  SPEC PIXELS FRAME like the corresponding `image-mode' fn."
  86   (let ((xwi (xwidget-info  (xwidget-at 1))))
  87     (cons (aref xwi 2)
  88           (aref xwi 3))))
  89
  90 (defmacro xwidget-image-mode-navigation-adaptor (fn)
  91   "Image code adaptor.  `image-mode' FN is called."
  92   `(lambda () (interactive)
  93      (flet ((image-display-size (spec) (xwidget-image-display-size spec)))
  94        (funcall ,fn ))))
  95
  96 (defmacro xwidget-image-mode-navigation-adaptor-p (fn)
  97     "Image code adaptor.  `image-mode' FN is called with interactive arg."
  98   `(lambda (n) (interactive "p")
  99      (flet ((image-display-size (spec) (xwidget-image-display-size spec)))
 100        (funcall ,fn n))))
 101
 102
 103 ;;todo.
 104 ;; - check that the webkit support is compiled in
 105 (defvar xwidget-webkit-mode-map
 106   (let ((map (make-sparse-keymap)))
 107     (define-key map "g" 'xwidget-webkit-browse-url)
 108     (define-key map "a" 'xwidget-webkit-adjust-size-to-content)
 109     (define-key map "b" 'xwidget-webkit-back )
 110     (define-key map "r" 'xwidget-webkit-reload )
 111     (define-key map "t" (lambda () (interactive) (message "o")) )
 112     (define-key map "\C-m" 'xwidget-webkit-insert-string)
 113     (define-key map "w" 'xwidget-webkit-current-url)
 114
 115     ;;similar to image mode bindings
 116     (define-key map (kbd "SPC")       (xwidget-image-mode-navigation-adaptor   'image-scroll-up))
 117     (define-key map (kbd "DEL")       (xwidget-image-mode-navigation-adaptor   'image-scroll-down))
 118
 119     (define-key map [remap scroll-up]          (xwidget-image-mode-navigation-adaptor 'image-scroll-up))
 120     (define-key map [remap scroll-up-command]  (xwidget-image-mode-navigation-adaptor 'image-scroll-up))
 121
 122     (define-key map [remap scroll-down]       (xwidget-image-mode-navigation-adaptor  'image-scroll-down))
 123     (define-key map [remap scroll-down-command]       (xwidget-image-mode-navigation-adaptor  'image-scroll-down))
 124
 125     (define-key map [remap forward-char]       (xwidget-image-mode-navigation-adaptor-p  'image-forward-hscroll))
 126     (define-key map [remap backward-char]       (xwidget-image-mode-navigation-adaptor-p  'image-backward-hscroll))
 127     (define-key map [remap right-char]       (xwidget-image-mode-navigation-adaptor-p  'image-forward-hscroll))
 128     (define-key map [remap left-char]       (xwidget-image-mode-navigation-adaptor-p  'image-backward-hscroll))
 129     (define-key map [remap previous-line]       (xwidget-image-mode-navigation-adaptor-p  'image-previous-line))
 130     (define-key map [remap next-line]       (xwidget-image-mode-navigation-adaptor-p  'image-next-line))
 131
 132     (define-key map [remap move-beginning-of-line]       (xwidget-image-mode-navigation-adaptor-p  'image-bol))
 133     (define-key map [remap move-end-of-line]       (xwidget-image-mode-navigation-adaptor-p  'image-eol))
 134     (define-key map [remap beginning-of-buffer]       (xwidget-image-mode-navigation-adaptor  'image-bob))
 135     (define-key map [remap end-of-buffer]       (xwidget-image-mode-navigation-adaptor  'image-eob))
 136     map)
 137   "Keymap for `xwidget-webkit-mode'.")
 138
 139 ;;the xwidget event needs to go into a higher level handler
 140 ;;since the xwidget can generate an event even if its offscreen
 141 ;;TODO this needs to use callbacks and consider different xw ev types
 142 (define-key (current-global-map) [xwidget-event] 'xwidget-event-handler)
 143
 144 (defun xwidget-event-handler ()
 145   "Receive xwidget event."
 146   (interactive)
 147   (message "stuff happened to xwidget %S" last-input-event)
 148   (let*
 149       ((xwidget-event-type (nth 1 last-input-event))
 150        (xwidget (nth 2 last-input-event))
 151        ;(xwidget-callback (xwidget-get xwidget 'callback));;TODO stopped working for some reason
 152        )
 153     ;(funcall  xwidget-callback xwidget xwidget-event-type)
 154     (funcall  'xwidget-webkit-callback xwidget xwidget-event-type)
 155     ))
 156
 157 (defun xwidget-webkit-callback (xwidget xwidget-event-type)
 158   (save-excursion
 159     (set-buffer (xwidget-buffer xwidget))
 160     (let* ( (strarg  (nth 3 last-input-event)))
 161       (cond ((eq xwidget-event-type 'document-load-finished)
 162              (message "webkit finished loading: '%s'" (xwidget-webkit-get-title xwidget))
 163              (xwidget-adjust-size-to-content xwidget)
 164              (rename-buffer (format "*xwidget webkit: %s *" (xwidget-webkit-get-title xwidget)))
 165              (pop-to-buffer (current-buffer))
 166              )
 167
 168             ((eq xwidget-event-type 'navigation-policy-decision-requested)
 169              (let ((elmid (progn                   (string-match ".*#\\(.*\\)" strarg)(match-string 1 strarg))))
 170                    (message "navigation-policy-decision-requested: '%s' %s"  strarg  elmid       )
 171
 172                    (if elmid (xwidget-webkit-show-id-element xwidget elmid))
 173                    )
 174
 175              )
 176             ))))
 177
 178 (define-derived-mode xwidget-webkit-mode
 179   special-mode "xwidget-webkit" "xwidget webkit view mode"
 180   (setq buffer-read-only t)
 181   ;; Keep track of [vh]scroll when switching buffers
 182   (image-mode-setup-winprops)
 183
 184   )
 185
 186 (defvar xwidget-webkit-last-session-buffer nil)
 187
 188 (defun  xwidget-webkit-last-session ()
 189   "Last active webkit, or a new one."
 190   (if (buffer-live-p xwidget-webkit-last-session-buffer)
 191       (save-excursion
 192         (set-buffer xwidget-webkit-last-session-buffer)
 193         (xwidget-at 1))
 194     nil))
 195
 196 (defun xwidget-webkit-current-session ()
 197   "Either the webkit in the current buffer, or the last one used, which might be nil."
 198   (if (xwidget-at 1)
 199       (xwidget-at 1)
 200     (xwidget-webkit-last-session)))
 201
 202 (defun xwidget-adjust-size-to-content (xw)
 203   "Resize XW to content."
 204   ;;xwidgets doesnt support widgets that have their own opinions about size well yet
 205   ;;this reads the desired size and resizes the emacs allocated area accordingly
 206   (let ((size (xwidget-size-request xw)))
 207     (xwidget-resize xw (car size) (cadr size))))
 208
 209
 210 (defvar xwidget-webkit-activeelement-js"
 211 function findactiveelement(doc){
 212 //alert(doc.activeElement.value);
 213    if(doc.activeElement.value != undefined){
 214       return doc.activeElement;
 215    }else{
 216         // recurse over the child documents:
 217         var frames = doc.getElementsByTagName('frame');
 218         for (var i = 0; i < frames.length; i++)
 219         {
 220                 var d = frames[i].contentDocument;
 221                  var rv = findactiveelement(d);
 222                  if(rv != undefined){
 223                     return rv;
 224                  }
 225         }
 226     }
 227     return undefined;
 228 };
 229
 230
 231 "
 232
 233 "javascript that finds the active element."
 234 ;;yes its ugly. because:
 235 ;; - there is aparently no way to find the active frame other than recursion
 236 ;; - the js "for each" construct missbehaved on the "frames" collection
 237 ;; - a window with no frameset still has frames.length == 1, but frames[0].document.activeElement != document.activeElement
 238 ;;TODO the activeelement type needs to be examined, for iframe, etc. sucks.
 239 )
 240
 241 (defun xwidget-webkit-insert-string (xw str)
 242   "Insert string in the active field in the webkit.
 243 Argument XW webkit.
 244 Argument STR string."
 245   ;;read out the string in the field first and provide for edit
 246   (interactive
 247    (let* ((xww (xwidget-webkit-current-session))
 248
 249           (field-value
 250            (progn
 251              (xwidget-webkit-execute-script xww xwidget-webkit-activeelement-js)
 252              (xwidget-webkit-execute-script-rv xww "findactiveelement(document).value;" ))))
 253      (list xww
 254            (read-string "string:" field-value))))
 255   (xwidget-webkit-execute-script xw (format "findactiveelement(document).value='%s'" str)))
 256
 257
 258 (defun xwidget-webkit-show-named-element (xw element-name)
 259   "make named-element show. for instance an anchor."
 260   (interactive (list (xwidget-webkit-current-session) (read-string "element name:")))
 261   ;;TODO
 262   ;; since an xwidget is an Emacs object, it is not trivial to do some things that are taken for granted in a normal browser.
 263   ;; scrolling an anchor/named-element into view is one such thing.
 264   ;; this function implements a proof-of-concept for this.
 265   ;; problems remaining:
 266   ;; - the selected window is scrolled but this is not always correct
 267   ;; - this needs to be interfaced into browse-url somehow. the tricky part is that we need to do this in two steps:
 268   ;;   A: load the base url, wait for load signal to arrive B: navigate to the anchor when the base url is finished rendering
 269
 270   ;;this part figures out the Y coordinate of the element
 271   (let ((y
 272          (string-to-number (xwidget-webkit-execute-script-rv xw (format "document.getElementsByName('%s')[0].getBoundingClientRect().top" element-name) 0))))
 273     ;;now we need to tell emacs to scroll the element into view.
 274     (message "scroll: %d" y)
 275     (set-window-vscroll (selected-window) y t))
 276   )
 277
 278 (defun xwidget-webkit-show-id-element (xw element-id)
 279   "make id-element show. for instance an anchor."
 280   (interactive (list (xwidget-webkit-current-session) (read-string "element id:")))
 281   (let ((y
 282          (string-to-number (xwidget-webkit-execute-script-rv xw (format "document.getElementById('%s').getBoundingClientRect().top" element-id) 0))))
 283     ;;now we need to tell emacs to scroll the element into view.
 284     (message "scroll: %d" y)
 285     (set-window-vscroll (selected-window) y t))
 286   )
 287
 288 (defun xwidget-webkit-adjust-size-to-content ()
 289   "Adjust webkit to content size."
 290   (interactive)
 291   ( xwidget-adjust-size-to-content ( xwidget-webkit-current-session)))
 292
 293 (defun xwidget-webkit-adjust-size (w h)
 294   "Manualy set webkit size.
 295 Argument W width.
 296 Argument H height."
 297   ;;TODO shouldnt be tied to the webkit xwidget
 298   (interactive "nWidth:\nnHeight:\n")
 299   ( xwidget-resize ( xwidget-webkit-current-session) w h))
 300
 301 (defun xwidget-webkit-fit-width ()
 302   (interactive)
 303   (xwidget-webkit-adjust-size
 304    (- (caddr (window-inside-pixel-edges)) (car (window-inside-pixel-edges)))
 305    1000))
 306
 307 (defun xwidget-webkit-new-session (url)
 308 "Create a new webkit session buffer with URL."
 309   (let*
 310       ((bufname (generate-new-buffer-name "*xwidget-webkit*"))
 311        xw)
 312     (setq xwidget-webkit-last-session-buffer (switch-to-buffer (get-buffer-create bufname)))
 313     (insert " ")
 314     (setq xw (xwidget-insert 1 'webkit-osr  bufname 1000 1000))
 315     (xwidget-put xw 'callback 'xwidget-webkit-callback)
 316     (xwidget-webkit-mode)
 317     (xwidget-webkit-goto-uri ( xwidget-webkit-last-session) url )))
 318
 319
 320 (defun xwidget-webkit-goto-url (url)
 321   "Goto URL."
 322   (if ( xwidget-webkit-current-session)
 323       (progn
 324         (xwidget-webkit-goto-uri ( xwidget-webkit-current-session) url))
 325     ( xwidget-webkit-new-session url)))
 326
 327 (defun xwidget-webkit-back ()
 328   "Back in history."
 329   (interactive)
 330   (xwidget-webkit-execute-script ( xwidget-webkit-current-session)  "history.go(-1);"))
 331
 332 (defun xwidget-webkit-reload ()
 333   "Reload current url."
 334   (interactive)
 335   (xwidget-webkit-execute-script ( xwidget-webkit-current-session)  "history.go(0);"))
 336
 337 (defun xwidget-webkit-current-url ()
 338   "Get the webkit url. place it on kill ring."
 339   (interactive)
 340   (message "url: %s" (kill-new   (xwidget-webkit-execute-script-rv (xwidget-webkit-current-session) "document.URL"))))
 341
 342 (defun xwidget-webkit-execute-script-rv (xw script &optional default)
 343   "same as xwidget-webkit-execute-script but also wraps an ugly hack to return a value"
 344   ;;notice the fugly "title" hack. it is needed because the webkit api doesnt support returning values.
 345   ;;this is a wrapper for the title hack so its easy to remove should webkit someday support JS return values
 346   ;;or we find some other way to access the DOM
 347
 348   ;;reset webkit title. fugly.
 349   (let* (          (emptytag "titlecantbewhitespaceohthehorror")
 350                    title)
 351     (xwidget-webkit-execute-script xw (format "document.title=\"%s\";" (if default default emptytag)))
 352     (xwidget-webkit-execute-script xw (format "document.title=%s;" script))
 353     (setq title (xwidget-webkit-get-title xw))
 354     (if (equal emptytag title) (setq title ""))
 355     title))
 356
 357
 358 ;; use declare here?
 359 ;; (declare-function xwidget-resize-internal "xwidget.c" )
 360 ;; check-declare-function?
 361
 362 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 363 ;; xwidget plist management(similar to the process plist functions)
 364
 365 (defun xwidget-get (xwidget propname)
 366   "Return the value of XWIDGET' PROPNAME property.
 367 This is the last value stored with `(xwidget-put XWIDGET PROPNAME VALUE)'."
 368   (plist-get (xwidget-plist xwidget) propname))
 369
 370 (defun xwidget-put (xwidget propname value)
 371   "Change XWIDGET' PROPNAME property to VALUE.
 372 It can be retrieved with `(xwidget-get XWIDGET PROPNAME)'."
 373   (set-xwidget-plist xwidget
 374                      (plist-put (xwidget-plist xwidget) propname value)))
 375
 376
 377 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 378 (defun xwidget-cleanup ()
 379   "Delete zombie xwidgets."
 380   ;;its still pretty easy to trigger bugs with xwidgets.
 381   ;;this function tries to implement a workaround
 382   (interactive)
 383   (xwidget-delete-zombies) ;;kill xviews who should have been deleted but stull linger
 384   (redraw-display);;redraw display otherwise ghost of zombies  will remain to haunt the screen
 385   )
 386
 387
 388
 389 ;;this is a workaround because I cant find the right place to put it in C
 390 ;;seems to work well in practice though
 391 ;;(add-hook 'window-configuration-change-hook 'xwidget-cleanup)
 392 (add-hook 'window-configuration-change-hook 'xwidget-delete-zombies)
 393
 394 ;;killflash is sadly not reliable yet.
 395 (defvar xwidget-webkit-kill-flash-oneshot t)
 396 (defun xwidget-webkit-kill-flash ()
 397   "Disable the flash plugin in webkit.
 398 This is needed because Flash is non-free and doesnt work reliably
 399 on 64 bit systems and offscreen rendering.  Sadly not reliable
 400 yet, so deinstall Flash instead for now."
 401   ;;you can only call this once or webkit crashes and takes emacs with it. odd.
 402   (unless xwidget-webkit-kill-flash-oneshot
 403     (xwidget-disable-plugin-for-mime "application/x-shockwave-flash")
 404     (setq xwidget-webkit-kill-flash-oneshot t)))
 405
 406 (xwidget-webkit-kill-flash)
 407
 408 (provide 'xwidget)
 409
 410 (provide 'xwidget)
 411
 412 ;;; xwidget.el ends here