---END PERSONAL NOPUSH DIVIDER---

--
2.42.0

lisp/org-latex-preview.el

@@ -34,6 +34,7 @@
 (declare-function org-persist-read "org-persist")
 (declare-function org-persist-register "org-persist")
 (declare-function org-persist-unregister "org-persist")
+(declare-function eldoc--invoke-strategy "eldoc")
 
 (defvar org-src-mode-hook nil)
 (defvar org-src--beg-marker nil)
@@ -540,12 +541,12 @@ overlay face is set to `org-latex-preview-processing-face'."
     ;; This is a temporary measure until a more sophisticated
     ;; interface for errors is available in Org.
     (when errors
-        (overlay-put
-         ov 'help-echo
-         (if (bound-and-true-p tooltip-mode)
-             errors
-           (concat (propertize "! " 'face '(bold error))
-                   (substring (replace-regexp-in-string "[\n\r\t ]+" " " errors) 2)))))
+      (overlay-put
+       ov 'help-echo
+       (if (bound-and-true-p tooltip-mode)
+           errors
+         (concat (propertize "! " 'face '(bold error))
+                 (substring (replace-regexp-in-string "[\n\r\t ]+" " " errors) 2)))))
     (unless (overlay-get ov 'view-text) ;Live previewing this element, update in background
       (when image-display (overlay-put ov 'display image-display))
       (overlay-put ov 'face (overlay-get ov 'hidden-face)))
@@ -894,6 +895,7 @@ customize the variable `org-latex-preview-live'."
       (progn
         (setq org-latex-preview-auto--marker (make-marker))
         (add-hook 'pre-command-hook #'org-latex-preview-auto--handle-pre-cursor nil 'local)
+        (org-latex-preview-auto--handle-pre-cursor) ; Invoke setup before the hook even fires.
         (add-hook 'post-command-hook #'org-latex-preview-auto--handle-post-cursor nil 'local)
         (add-hook 'after-change-functions #'org-latex-preview-auto--detect-fragments-in-change nil 'local)
         (when org-latex-preview-live
@@ -922,7 +924,7 @@ customize the variable `org-latex-preview-live'."
 ;;   show the existing preview image.
 ;;
 ;; - A handler is added to `after-change-functions' to regenerate the
-;;   preview for the fragment.
+;;   preview for the fragment when its contents change.
 ;;
 ;; - When the preview is regenerated, the `after-string' property of
 ;;   the preview overlay is updated to show the new image.  This
@@ -1002,27 +1004,38 @@ updated no more than once in this interval of time.
 Its value is updated dynamically based on the average fragment
 preview time.")
 
-(defvar-local org-latex-preview--live-preview-times
+(defvar-local org-latex-preview-live--preview-times
     (make-vector 3 1.0)
   "Vector containing the last three preview run times in this buffer")
-(defvar-local org-latex-preview--live-preview-times-index 0)
+(defvar-local org-latex-preview-live--preview-times-index 0)
 
-(defun org-latex-preview--live-update-times (latest-duration)
+(defun org-latex-preview-live--update-times (latest-duration)
   "Update preview times given the last preview took LATEST-DURATION seconds."
-  (aset org-latex-preview--live-preview-times
-        (% (cl-incf org-latex-preview--live-preview-times-index) 3)
+  (aset org-latex-preview-live--preview-times
+        (% (cl-incf org-latex-preview-live--preview-times-index) 3)
         latest-duration)
   (setq-local org-latex-preview-live-throttle
-              (/ (apply #'+ (append org-latex-preview--live-preview-times nil))
+              (/ (apply #'+ (append org-latex-preview-live--preview-times nil))
                  3)))
 
-(defun org-latex-preview--live-record-hook (exit-code _buf extended-info)
+(defun org-latex-preview-live--record-hook (exit-code _buf extended-info)
   "A hook for `org-latex-preview-process-finish-functions' to track preview time.
 Called with EXIT-CODE and EXTENDED-INFO from the async process."
   (when (= exit-code 0)
-    (org-latex-preview--live-update-times
+    (org-latex-preview-live--update-times
      (- (float-time) (plist-get extended-info :start-time)))))
 
+(defconst org-latex-preview-live-display-type 'buffer
+  "How to display live-updating previews of LaTeX snippets.
+
+This option is meaningful when live previews are enabled, by
+setting `org-latex-preview-auto-generate' to `live' and enabling
+`org-latex-preview-auto-mode'.
+
+The only currently supported option is the symbol buffer, to
+ display live previews next to or under the LaTeX fragment in the
+ Org buffer.")
+
 (defun org-latex-preview-live--debounce (func duration)
   "Return a debounced FUNC with DURATION applied."
   (let ((debounce-timer))
@@ -1122,30 +1135,6 @@ BOX-FACE is the face to apply in addition."
             (overlay-put ov 'after-string org-latex-preview-live--docstring)))
         (org-latex-preview-live--update-props image '(:box t))))))
 
-;; TODO: Add this to the live preview mode setup?
-;;
-;; Currently not used.  Adding this function to
-;; `org-latex-preview-process-finish-functions' is potentially more
-;; efficient than adding a function to
-;; `org-latex-preview-overlay-update-functions' on LaTeX runs with
-;; many fragments, but for some reason the image display fails to
-;; update until a full redisplay/the user runs a command.  This needs
-;; to be investigated.
-(defun org-latex-preview-live--update-overlay-run (exit-code _buf extended-info)
-  "TODO."
-  (when-let* (((= exit-code 0))
-              (ov
-               (thread-first
-                 (plist-get extended-info :fragments)
-                 (car)
-                 (plist-get :overlay)))
-              ((overlay-get ov 'after-string)))
-    (when (memq ov (overlays-at (point)))
-      (org-latex-preview-live--update-props
-       (overlay-get ov 'preview-image)))))
-
-;; TODO: Replace with `org-latex-preview-live--update-overlay-run',
-;; which see.
 (defun org-latex-preview-live--update-overlay (ov)
   "Update the live LaTeX preview for overlay OV."
   (when (and (memq ov (overlays-at (point)))
@@ -1180,7 +1169,7 @@ This is meant to be called via `org-src-mode-hook'."
     (let* ((org-buf (marker-buffer org-src--beg-marker))
            (src-buf (current-buffer))
            (org-buf-visible-p (window-live-p (get-buffer-window org-buf)))
-              ;; Do not use (org-element-property :begin element) to
+           ;; Do not use (org-element-property :begin element) to
            ;; find the bounds -- this is fragile under typos.
            (beg (save-excursion (goto-char (point-min))
                                 (skip-chars-forward "\n \t\r")
@@ -1190,6 +1179,9 @@ This is meant to be called via `org-src-mode-hook'."
                                 (point)))
            preamble element skip-env-p numbering-offsets ov orig-ov)
       (setq org-latex-preview-auto--marker (point-marker))
+      ;; Copy the LaTeX preview overlay from the source Org buffer
+      ;; into the org-src buffer and show a preview image over the
+      ;; former:
       (with-current-buffer org-buf
         (setq element (org-element-context))
         (when (eq (org-element-type element) 'latex-environment)
@@ -1215,7 +1207,7 @@ This is meant to be called via `org-src-mode-hook'."
         (org-latex-preview-auto--close-previous-overlay))
       (unless skip-env-p
         (or ov (setq ov (org-latex-preview--ensure-overlay beg end)))
-        ;; Adjust numbering
+        ;; Adjust numbering if required
         (when (and org-latex-preview-numbered
                    (eq (org-element-type element) 'latex-environment))
           (with-current-buffer org-buf
@@ -1224,7 +1216,8 @@ This is meant to be called via `org-src-mode-hook'."
 
         (when (buffer-local-value 'org-latex-preview-live org-buf)
           (if org-buf-visible-p
-              ;; Display live previews in original org buffer
+              ;; Source Org buffer is visible: display live previews
+              ;; over the fragment there
               (progn
                 (setq-local org-latex-preview-live--generator
                             (thread-first
@@ -1244,8 +1237,18 @@ This is meant to be called via `org-src-mode-hook'."
                                org-latex-preview-live-debounce)))
                 (add-hook 'after-change-functions org-latex-preview-live--generator 90 'local))
 
-            ;; Or display live previews in org-src buffer
+            ;; Source Org buffer not visible: display live previews in org-src buffer
+            ;; Set the element type ahead of time since we cannot call
+            ;; org-element-context in the org-src buffer
+            (setq org-latex-preview-live--element-type
+                  (with-current-buffer org-buf
+                    (or (and (string-prefix-p
+                              "\\[" (org-element-property :value element))
+                             'latex-environment)
+                        (org-element-type element))))
+            ;; Show live preview if available
             (org-latex-preview-live--ensure-overlay ov)
+            ;; Set up hooks for live preview updates in the org-src buffer
             (add-hook 'org-latex-preview-overlay-update-functions
                       #'org-latex-preview-live--update-overlay
                       nil 'local)
@@ -1264,10 +1267,10 @@ This is meant to be called via `org-src-mode-hook'."
                           (org-latex-preview-live--throttle)
                           (org-latex-preview-live--debounce
                            org-latex-preview-live-debounce)))
-            (add-hook 'org-latex-preview-open-functions #'org-latex-preview-live--ensure-overlay nil 'local)
-            (add-hook 'org-latex-preview-close-functions #'org-latex-preview-live--clearout nil 'local)
+            (add-hook 'org-latex-preview-overlay-open-functions #'org-latex-preview-live--ensure-overlay nil 'local)
+            (add-hook 'org-latex-preview-overlay-close-functions #'org-latex-preview-live--clearout nil 'local)
             (add-hook 'after-change-functions org-latex-preview-live--generator 90 'local)))
-        ;; auto-mode in the src buffer
+        ;; Turn on auto-mode behavior in the org-src buffer
         (add-hook 'pre-command-hook #'org-latex-preview-auto--handle-pre-cursor nil 'local)
         (add-hook 'post-command-hook #'org-latex-preview-auto--handle-post-cursor nil 'local)))))
 
@@ -1303,7 +1306,7 @@ See `org-latex-preview-live' for details."
   (add-hook 'org-latex-preview-overlay-close-functions #'org-latex-preview-live--clearout nil 'local)
   (add-hook 'org-latex-preview-overlay-open-functions #'org-latex-preview-live--ensure-overlay nil 'local)
   (add-hook 'after-change-functions org-latex-preview-live--generator 90 'local)
-  (add-hook 'org-latex-preview-process-finish-functions #'org-latex-preview--live-record-hook nil 'local)
+  (add-hook 'org-latex-preview-process-finish-functions #'org-latex-preview-live--record-hook nil 'local)
   (add-hook 'org-latex-preview-overlay-update-functions #'org-latex-preview-live--update-overlay nil 'local))
 
 (defun org-latex-preview-live--teardown ()
@@ -1321,7 +1324,7 @@ See `org-latex-preview-live' for details."
   (remove-hook 'org-latex-preview-overlay-open-functions #'org-latex-preview-live--ensure-overlay 'local)
   (remove-hook 'after-change-functions org-latex-preview-live--generator 'local)
   (remove-hook 'org-latex-preview-overlay-update-functions #'org-latex-preview-live--update-overlay 'local)
-  (remove-hook 'org-latex-preview-process-finish-functions #'org-latex-preview--live-record-hook 'local)
+  (remove-hook 'org-latex-preview-process-finish-functions #'org-latex-preview-live--record-hook 'local)
   (setq-local org-latex-preview-live--generator nil))
 
 (defun org-latex-preview-clear-overlays (&optional beg end)
@@ -2026,23 +2029,28 @@ previews."
                              (search-forward ": No such file or directory" nil t))))))
                (propertize org-latex-preview--latex-log 'face 'warning)
              (propertize org-latex-preview--image-log 'face 'warning)))
-  (cl-loop for fragment in (plist-get extended-info :fragments)
-           for path = (plist-get fragment :path)
-           when (not path)
-           for ov = (plist-get fragment :overlay)
-           when ov do
-           ;; ;TODO: Other options here include:
-           ;; ;Fringe marker
-           ;; (overlay-put ov 'before-string
-           ;;              (propertize "!" 'display
-           ;;                          `(left-fringe exclamation-mark
-           ;;                            warning)))
-           ;; ;Special face
-           ;; (unless (overlay-get ov 'face)
-           ;;   (overlay-put ov 'face 'org-latex-preview-processing-face))
-           ;;
-           ;; ;Note: ov has buffer extended-info, no need to set current-buffer
-           (delete-overlay ov)))
+  (with-current-buffer (plist-get extended-info :org-buffer)
+    (cl-loop for fragment in (plist-get extended-info :fragments)
+             for path = (plist-get fragment :path)
+             when (not path)
+             for ov = (plist-get fragment :overlay)
+             when ov do
+             ;; ;TODO: Other options here include:
+             ;; ;Fringe marker
+             ;; (overlay-put ov 'before-string
+             ;;              (propertize "!" 'display
+             ;;                          `(left-fringe exclamation-mark
+             ;;                            warning)))
+             ;; ;Special face
+             ;; (unless (overlay-get ov 'face)
+             ;;   (overlay-put ov 'face 'org-latex-preview-processing-face))
+             ;;
+             ;; ;Note: ov has buffer extended-info, no need to set current-buffer
+             (let ((start (overlay-start ov))
+                   (end (overlay-end ov)))
+               (delete-overlay ov)
+               (when org-latex-preview-auto-mode
+                 (org-latex-preview--ensure-overlay start end))))))
 
 (defvar-local org-latex-preview--preamble-content nil
   "Cache of the LaTeX preamble for snippet preview.")
@@ -2378,17 +2386,17 @@ fragments are regenerated."
            (plist-get bad-fragment :key))
           (if (plist-get extended-info :place-preview-p)
               (org-latex-preview--update-overlay
-                   (plist-get bad-fragment :overlay)
-                   (org-latex-preview--cache-image
-               (plist-get bad-fragment :key)
-               (plist-get bad-fragment :path)
-               (org-latex-preview--display-info
-                extended-info bad-fragment)))
+               (plist-get bad-fragment :overlay)
+               (org-latex-preview--cache-image
+                (plist-get bad-fragment :key)
+                (plist-get bad-fragment :path)
+                (org-latex-preview--display-info
+                 extended-info bad-fragment)))
             (org-latex-preview--cache-image
-                   (plist-get bad-fragment :key)
-                   (plist-get bad-fragment :path)
-                   (org-latex-preview--display-info
-                extended-info bad-fragment))))
+             (plist-get bad-fragment :key)
+             (plist-get bad-fragment :path)
+             (org-latex-preview--display-info
+              extended-info bad-fragment))))
         ;; Re-generate the remaining fragments.
         (org-latex-preview--create-image-async
          (plist-get extended-info :processor)
@@ -2408,7 +2416,7 @@ fragments are regenerated."
     (plist-put info :errors (plist-get fragment-info :errors))
     info))
 
-;TODO: Figure out why this factor is needed.
+;; TODO: Figure out why this factor is needed.
 (defconst org-latex-preview--shameful-magic-tex-scaling-factor
   1.01659593
   "Extra factor for aligning preview image baselines.