cleanups

3 files changed, 99 insertions, 42 deletions

diff --git a/README.xwidget b/README.xwidget
index 710c10ed7f3..3673209664a 100644
--- a/README.xwidget
+++ b/README.xwidget
@@ -895,11 +895,27 @@ because one might need tell set a title and sizes and things when it loads.
 **** TODO event bug
 Debugger entered--Lisp error: (error "Two bases given in one event")
 
-for some reason hapens sometimes with xwidget events.
+hapens sometimes with xwidget events. appears to be when the
+originating xwidget is offscreen so that the event doesn't get caught
+by the correct emacs event map.
 
-maybe I need to set the originating window?
+maybe I need to set the originating window in the event structure.
   event.frame_or_window = Qnil; //frame; //how to get the frame here? //TODO i store it in the xwidget now
 
+since its an offscreen xwidget the buffer local keymap isnt the right
+place for the handler. some global map should be used.
+
+onscreen widgets don't have the same issue.
+
+anyway, seems it'll turn out like this:
+- xwidget-osr stores a callback and user data
+- the event is an implementation detail only and get caught in the
+  topmost event map
+- the event map calls the callback in the xw with the right args.
+
+we need the event handler at some level because we can't call lisp
+asynchronously. 
+
 *** TODO console messages
 http://webkitgtk.org/reference/webkitgtk-webkitwebview.html#WebKitWebView-console-message
 http://getfirebug.com/wiki/index.php/Console_API#console.count.28.5Btitle.5D.29
diff --git a/lisp/xwidget.el b/lisp/xwidget.el
index df6e77b708b..97dbe11fed9 100644
--- a/lisp/xwidget.el
+++ b/lisp/xwidget.el
@@ -1,15 +1,20 @@
-;; xwidget.el - api functions for xwidgets
+;;; xwidget.el --- api functions for xwidgets
 ;;  see xwidget.c for more api functions
 
+
+;;; Commentary:
+;; 
+
 (require 'xwidget-internal)
 
 ;;TODO model after make-text-button instead!
+;;; Code:
+
 (defun xwidget-insert (pos type title width height)
   "Insert an xwidget at POS, given ID, TYPE, TITLE WIDTH and HEIGHT.
 Return ID
 
-see xwidget.c for types suitable for TYPE.
-"
+see xwidget.c for types suitable for TYPE."
   (goto-char pos)
   (let ((id (make-xwidget (point) (point)  type  title  width  height nil)))
     (put-text-property (point)
@@ -19,7 +24,8 @@ see xwidget.c for types suitable for TYPE.
 
 
 (defun xwidget-at (pos)
-  ;;this function is a bit tedious because the C layer isnt well protected yet and
+  "Return xwidget at POS."
+  ;;TODO this function is a bit tedious because the C layer isnt well protected yet and
   ;;xwidgetp aparently doesnt work yet
   (let* ((disp (get-text-property pos 'display))
          (xw (car (cdr (cdr  disp)))))
@@ -31,7 +37,7 @@ see xwidget.c for types suitable for TYPE.
 
 
 (defun xwidget-socket-handler ()
-  "creates plug for socket. TODO"
+  "Create plug for socket.  TODO."
   (interactive)
   (message "socket handler xwidget %S" last-input-event)
   (let*
@@ -75,16 +81,19 @@ defaults to the string looking like a url around the cursor position."
 
 ;;shims for adapting image mode code to the webkit browser window
 (defun xwidget-image-display-size  (spec &optional pixels frame)
+  "Image code adaptor.  SPEC PIXELS FRAME like the corresponding `image-mode' fn."
   (let ((xwi (xwidget-info  (xwidget-at 1))))
     (cons (aref xwi 2)
           (aref xwi 3))))
 
 (defmacro xwidget-image-mode-navigation-adaptor (fn)
+  "Image code adaptor.  `image-mode' FN is called."
   `(lambda () (interactive)
      (flet ((image-display-size (spec) (xwidget-image-display-size spec)))
        (funcall ,fn ))))
 
 (defmacro xwidget-image-mode-navigation-adaptor-p (fn)
+    "Image code adaptor.  `image-mode' FN is called with interactive arg."
   `(lambda (n) (interactive "p")
      (flet ((image-display-size (spec) (xwidget-image-display-size spec)))
        (funcall ,fn n))))
@@ -98,9 +107,9 @@ defaults to the string looking like a url around the cursor position."
     (define-key map "a" 'xwidget-webkit-adjust-size-to-content)
     (define-key map "b" 'xwidget-webkit-back )
     (define-key map "r" 'xwidget-webkit-reload )
-    (define-key map "t" (lambda () (interactive) (message "o")) )    
+    (define-key map "t" (lambda () (interactive) (message "o")) )
     (define-key map "\C-m" 'xwidget-webkit-insert-string)
-    (define-key map [xwidget-event] 'xwidget-webkit-event-handler)
+    (define-key map [xwidget-event] 'xwidget-webkit-event-handler);;TODO needs to go into a higher level handler
 
     ;;similar to image mode bindings
     ;;TODO theres something wrong with the macro
@@ -134,6 +143,7 @@ defaults to the string looking like a url around the cursor position."
 
 
 (defun xwidget-webkit-event-handler ()
+  "Receive webkit event."
   (interactive)
   (message "stuff happened to webkit xwidget %S" last-input-event)
   (let*
@@ -155,7 +165,7 @@ defaults to the string looking like a url around the cursor position."
 (defvar xwidget-webkit-last-session-buffer nil)
 
 (defun  xwidget-webkit-last-session ()
-  "last active webkit, or a new one"
+  "Last active webkit, or a new one."
   (if (buffer-live-p xwidget-webkit-last-session-buffer)
       (save-excursion
         (set-buffer xwidget-webkit-last-session-buffer)
@@ -163,34 +173,44 @@ defaults to the string looking like a url around the cursor position."
     nil))
 
 (defun xwidget-webkit-current-session ()
-  "either the webkit in the current buffer, or the last one used"
+  "Either the webkit in the current buffer, or the last one used, which might be nil."
   (if (xwidget-at 1)
       (xwidget-at 1)
     (xwidget-webkit-last-session)))
 
 (defun xwidget-adjust-size-to-content (xw)
-  ;;xwidgets doesnt support widgets that have thoir own opinions about size well yet
-  ;;this reads the size and sets it back
+  "Resize XW to content."
+  ;;xwidgets doesnt support widgets that have their own opinions about size well yet
+  ;;this reads the desired size and resizes the emacs allocated area accordingly
   (let ((size (xwidget-size-request xw)))
     (xwidget-resize xw (car size) (cadr size))))
 
 
 (defun xwidget-webkit-insert-string (xw str)
+  "Insert string in the active field in the webkit.
+Argument XW webkit.
+Argument STR string."
+  ;;TODO read out the string in the field first and provide for edit
   (interactive (list (xwidget-webkit-current-session)
                      (read-string "string:")))
   (xwidget-webkit-execute-script xw (format "document.activeElement.value='%s'" str)))
 
 (defun xwidget-webkit-adjust-size-to-content ()
+  "Adjust webkit to content size."
   (interactive)
   ( xwidget-adjust-size-to-content ( xwidget-webkit-current-session)))
 
 (defun xwidget-webkit-adjust-size (w h)
+  "Manualy set webkit size.
+Argument W width.
+Argument H height."
+  ;;TODO shouldnt be tied to the webkit xwidget
   (interactive "nWidth:\nnHeight:\n")
   ( xwidget-resize ( xwidget-webkit-current-session) w h))
 
 
 (defun xwidget-webkit-new-session (url)
-
+"Create a new webkit session buffer with URL."
   (let*
       ((bufname (generate-new-buffer-name "*xwidget-webkit*"))
        )
@@ -202,23 +222,27 @@ defaults to the string looking like a url around the cursor position."
 
 
 (defun xwidget-webkit-goto-url (url)
+  "Goto URL."
   (if ( xwidget-webkit-current-session)
       (progn
         (xwidget-webkit-goto-uri ( xwidget-webkit-current-session) url))
     ( xwidget-webkit-new-session url)))
 
 (defun xwidget-webkit-back ()
+  "Back in history."
   (interactive)
   (xwidget-webkit-execute-script ( xwidget-webkit-current-session)  "history.go(-1);"))
 
 (defun xwidget-webkit-reload ()
+  "Reload current url."
   (interactive)
   (xwidget-webkit-execute-script ( xwidget-webkit-current-session)  "history.go(0);"))
 
 (defun xwidget-current-url ()
-  "get the webkit url"
+  "Get the webkit url."
   ;;notice the fugly "title" hack. it is needed because the webkit api doesnt support returning values.
   ;;TODO make a wrapper for the title hack so its easy to remove should webkit someday support JS return values
+  ;;or we find some other way to access the DOM
   (xwidget-webkit-execute-script (xwidget-webkit-current-session) "document.title=document.URL;")
   (xwidget-webkit-get-title (xwidget-webkit-current-session)))
 
@@ -230,6 +254,7 @@ defaults to the string looking like a url around the cursor position."
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 (defun xwidget-cleanup ()
+  "Delete zombie xwidgets."
   ;;its still pretty easy to trigger bugs with xwidgets.
   ;;this function tries to implement a workaround
   (interactive)
@@ -240,11 +265,16 @@ defaults to the string looking like a url around the cursor position."
 
 
 ;;this is a workaround because I cant find the right place to put it in C
+;;seems to work well in practice though
 (add-hook 'window-configuration-change-hook 'xwidget-cleanup)
 
-;;killflash is sadly not reliable yet. 
+;;killflash is sadly not reliable yet.
 (defvar xwidget-webkit-kill-flash-oneshot t)
 (defun xwidget-webkit-kill-flash ()
+  "Disable the flash plugin in webkit.
+This is needed because Flash is non-free and doesnt work reliably
+on 64 bit systems and offscreen rendering.  Sadly not reliable
+yet, so deinstall Flash instead for now."
   ;;you can only call this once or webkit crashes and takes emacs with it. odd.
   (unless xwidget-webkit-kill-flash-oneshot
     (xwidget-disable-plugin-for-mime "application/x-shockwave-flash")
@@ -253,3 +283,7 @@ defaults to the string looking like a url around the cursor position."
 (xwidget-webkit-kill-flash)
 
 (provide 'xwidget)
+
+(provide 'xwidget)
+
+;;; xwidget.el ends here
diff --git a/src/xwidget.c b/src/xwidget.c
index 0a5ce3c6f0c..a25dd170731 100644
--- a/src/xwidget.c
+++ b/src/xwidget.c
@@ -701,6 +701,34 @@ DEFUN ("xwidget-webkit-get-title", Fxwidget_webkit_get_title,  Sxwidget_webkit_g
   return make_string_from_bytes(str, wcslen((const wchar_t *)str), strlen(str));
 }
 
+//TODO missnamed
+DEFUN("xwidget-disable-plugin-for-mime", Fxwidget_disable_plugin_for_mime , Sxwidget_disable_plugin_for_mime, 1,1,0, doc: /* */)
+  (Lisp_Object mime)
+{
+  WebKitWebPlugin *wp = webkit_web_plugin_database_get_plugin_for_mimetype
+    (webkit_get_web_plugin_database(),  SDATA(mime));
+  if(wp == NULL) return Qnil;
+  if(webkit_web_plugin_get_enabled (wp)){
+    webkit_web_plugin_set_enabled  (wp, FALSE);
+    return Qt;
+  }
+  return Qnil;
+}
+
+
+//attempting a workaround for a webkit offscreen bug
+//TODO verify its still needed
+void                gtk_window_get_position             (GtkWindow *window,
+                                                         gint *root_x,
+                                                         gint *root_y){
+  printf("my getsize\n");
+  *root_x = 0;
+  *root_y = 0;
+}
+
+
+
+
 #endif
 
 
@@ -852,18 +880,6 @@ DEFUN("xwidget-delete-zombies", Fxwidget_delete_zombies , Sxwidget_delete_zombie
   }
 }
 
-DEFUN("xwidget-disable-plugin-for-mime", Fxwidget_disable_plugin_for_mime , Sxwidget_disable_plugin_for_mime, 1,1,0, doc: /* */)
-  (Lisp_Object mime)
-{
-  WebKitWebPlugin *wp = webkit_web_plugin_database_get_plugin_for_mimetype
-    (webkit_get_web_plugin_database(),  SDATA(mime));
-  if(wp == NULL) return Qnil;
-  if(webkit_web_plugin_get_enabled (wp)){
-    webkit_web_plugin_set_enabled  (wp, FALSE);
-    return Qt;
-  }
-  return Qnil;
-}
 
 void
 syms_of_xwidget (void)
@@ -876,10 +892,13 @@ syms_of_xwidget (void)
   defsubr (&Sxwidget_view_info);
   defsubr (&Sxwidget_resize);
 
-
+#ifdef HAVE_WEBKIT_OSR
   defsubr (&Sxwidget_webkit_goto_uri);
   defsubr (&Sxwidget_webkit_execute_script);
   defsubr (&Sxwidget_webkit_get_title);
+  DEFSYM (Qwebkit_osr ,"webkit-osr");
+#endif
+  
   defsubr (&Sxwidget_size_request  );
   defsubr (&Sxwidget_delete_zombies);
   defsubr (&Sxwidget_disable_plugin_for_mime);
@@ -896,7 +915,7 @@ syms_of_xwidget (void)
   DEFSYM (Qsocket, "socket");
   DEFSYM (Qsocket_osr, "socket-osr");
   DEFSYM (Qcairo, "cairo");
-  DEFSYM (Qwebkit_osr ,"webkit-osr");
+
   DEFSYM (QCplist, ":plist");
 
    DEFVAR_LISP ("xwidget-alist", Vxwidget_alist, doc: /*xwidgets list*/);
@@ -1000,18 +1019,6 @@ struct xwidget_view* xwidget_view_lookup(struct xwidget* xw,     struct window *
   }
 }
 
-//attempting a workaround for a webkit offscreen bug
-//TODO verify its still needed
-void                gtk_window_get_position             (GtkWindow *window,
-                                                         gint *root_x,
-                                                         gint *root_y){
-  printf("my getsize\n");
-  *root_x = 0;
-  *root_y = 0;
-}
-
-
-
 struct xwidget*
 lookup_xwidget (Lisp_Object  spec)
 {