eww.el: Use `track-changes`

* lisp/net/eww.el: Require `track-changes`.
(eww-display-document): Don't `inhibit-modification-hooks` any more.
Use `track-changes-register` *at the end* instead.
(eww-mode): Don't use `after-change-functions` any more.
(eww--track-changes): New function.
(eww--process-text-input): Rename from `eww-process-text-input`.
Try and be more careful: don't presume `point` is near
the modification.  Check for a form both at BEG and at END.
Don't rely on `:start/:end` pointing to the right places.
Use `:length` instead and shrink the field back to its original length
when possible.
(eww-size-text-inputs): Set `:length` rather than `:start/:end`.

(cherry picked from commit 168b67b1eeb2e2b79d2e5f3712d8ebfda31fd753)

diff --git a/lisp/net/eww.el b/lisp/net/eww.el
index caf1e422462b802627dfacaca0ce18746f58bcc7..ae4c32481531327d18d5fcc0f1d35ce8cf5a926d 100644 (file)
--- a/lisp/net/eww.el
+++ b/lisp/net/eww.el
@@ -35,6 +35,7 @@
 (require 'url-file)
 (require 'vtable)
 (require 'xdg)
+(require 'track-changes)
 (eval-when-compile (require 'subr-x))
 
 (defgroup eww nil
@@ -786,7 +787,6 @@ This replaces the region with the preprocessed HTML."
       (setq bidi-paragraph-direction nil)
       (plist-put eww-data :dom document)
       (let ((inhibit-read-only t)
-           (inhibit-modification-hooks t)
             ;; Possibly set by the caller, e.g., `eww-render' which
             ;; preserves the old URL #target before chasing redirects.
             (shr-target-id (or shr-target-id
@@ -822,6 +822,10 @@ This replaces the region with the preprocessed HTML."
          (while (and (not (eobp))
                      (get-text-property (point) 'eww-form))
            (forward-line 1)))))
+      ;; We used to enable this in `eww-mode', but it cause tracking
+      ;; of changes while we insert the document, whereas we only care about
+      ;; changes performed afterwards.
+      (track-changes-register #'eww--track-changes :nobefore t)
       (eww-size-text-inputs))))
 
 (defun eww-display-html (charset url &optional document point buffer)
@@ -1324,14 +1328,11 @@ within text input fields."
 ;; Autoload cookie needed by desktop.el.
 ;;;###autoload
 (define-derived-mode eww-mode special-mode "eww"
-  "Mode for browsing the web.
-
-\\{eww-mode-map}"
+  "Mode for browsing the web."
   :interactive nil
   (setq-local eww-data (list :title ""))
   (setq-local browse-url-browser-function #'eww-browse-url)
-  (add-hook 'after-change-functions #'eww-process-text-input nil t)
-  (add-hook 'context-menu-functions 'eww-context-menu 5 t)
+  (add-hook 'context-menu-functions #'eww-context-menu 5 t)
   (setq-local eww-history nil)
   (setq-local eww-history-position 0)
   (when (boundp 'tool-bar-map)
@@ -1459,7 +1460,6 @@ instead of `browse-url-new-window-flag'."
 
 (defun eww-restore-history (elem)
   (let ((inhibit-read-only t)
-       (inhibit-modification-hooks t)
        (text (plist-get elem :text)))
     (setq eww-data elem)
     (if (null text)
@@ -1730,16 +1730,34 @@ Interactively, EVENT is the value of `last-nonmenu-event'."
   "List of input types which represent a text input.
 See URL `https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input'.")
 
-(defun eww-process-text-input (beg end replace-length)
-  (when-let* ((pos (field-beginning (point))))
-    (let* ((form (get-text-property pos 'eww-form))
-          (properties (text-properties-at pos))
+(defun eww--track-changes (tracker-id)
+  (track-changes-fetch
+   tracker-id
+   (lambda (beg end len)
+     (eww--process-text-input beg end len)
+     ;; Disregard our own changes.
+     (track-changes-fetch tracker-id #'ignore))))
+
+(defun eww--process-text-input (beg end replace-length)
+  (when-let* ((_ (integerp replace-length))
+              (pos end)
+              (form (or (get-text-property pos 'eww-form)
+                        (progn
+                          (setq pos (max (point-min) (1- beg)))
+                          (get-text-property pos 'eww-form)))))
+    (let* ((properties (text-properties-at pos))
            (buffer-undo-list t)
           (inhibit-read-only t)
           (length (- end beg replace-length))
           (type (plist-get form :type)))
-      (when (and form
-                (member type eww-text-input-types))
+      (when (member type eww-text-input-types)
+       ;; Make sure the new text has the right properties, which also
+       ;; integrates the new text into the "current field".
+       (set-text-properties beg end properties)
+       ;; FIXME: This tries to preserve the "length" of the input field,
+        ;; but we should try to preserve the *width* instead.
+        ;; FIXME: Maybe instead of inserting/deleting spaces, we should
+        ;; have a single stretch-space character at the end.
        (cond
         ((> length 0)
          ;; Delete some space at the end.
@@ -1755,18 +1773,21 @@ See URL `https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input'.")
         ((< length 0)
          ;; Add padding.
          (save-excursion
-           (goto-char end)
-           (goto-char
-            (if (equal type "textarea")
-                (1- (line-end-position))
-              (1+ (eww-end-of-field))))
-           (let ((start (point)))
-              (insert (make-string (abs length) ? ))
-             (set-text-properties start (point) properties))
-           (goto-char (1- end)))))
-       (set-text-properties (cdr (assq :start form))
-                             (cdr (assq :end form))
-                            properties)
+           (goto-char pos)
+           (let* ((field-length (- (eww-end-of-field)
+                                    (eww-beginning-of-field)))
+                   (ideal-length (cdr (assq :length form))))
+              ;; FIXME: This test isn't right for multiline fields.
+              (when (or (null ideal-length) (> ideal-length field-length))
+               (goto-char
+                (if (equal type "textarea")
+                    (1- (line-end-position))
+                  (1+ (eww-end-of-field))))
+               (let ((start (point)))
+                 (insert (make-string (min (abs length)
+                                           (- ideal-length field-length))
+                                      ? ))
+                 (set-text-properties start (point) properties)))))))
        (let ((value (buffer-substring-no-properties
                      (eww-beginning-of-field)
                      (eww-end-of-field))))
@@ -1988,11 +2009,11 @@ Interactively, EVENT is the value of `last-nonmenu-event'."
                (< start (point-max)))
       (when (or (get-text-property start 'eww-form)
                (setq start (next-single-property-change start 'eww-form)))
-       (let ((props (get-text-property start 'eww-form)))
-          (nconc props (list (cons :start start)))
+       (let ((props (get-text-property start 'eww-form))
+              (beg start))
           (setq start (next-single-property-change
                        start 'eww-form nil (point-max)))
-          (nconc props (list (cons :end start))))))))
+          (nconc props (list (cons :length (- start beg)))))))))
 
 (defun eww-input-value (input)
   (let ((type (plist-get input :type))