feature/completions-highlight-modifications 54c5650 1/6: Insert some modifications to implement completions highlighting.

[Jimmy Aguilar Mena]

branch: feature/completions-highlight-modifications
commit 54c5650e6df2a8eae7310e8e74b9816daad88d29
Author: Jimmy Aguilar Mena <spacibba@aol.com>
Commit: Jimmy Aguilar Mena <spacibba@aol.com>

    Insert some modifications to implement completions highlighting.
    
    This are changes needed in the minibuffer API to do highlighting from a
    different package.
    
    * lisp/minibuffer.el (minibuffer-tab-through-completions-function) : New
    variable containing the action to do when pressing tab in minibuffer
    and *Completions* are shown.
    (minibuffer-tab-through-completions-default) : Default function value
    for minibuffer-tab-through-completions-function.
    (completion--in-region-1) : Modification to funcall
    minibuffer-tab-through-completions-function.
    (minibuffer-hide-completions-hook) : New hook to call after
    closing *Completions* buffer.
    (minibuffer-hide-completions) : Modify to run hook
    minibuffer-hide-completions-hook.
---
 lisp/minibuffer.el | 44 +++++++++++++++++++++++++++++++++-----------
 1 file changed, 33 insertions(+), 11 deletions(-)

diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el
index 62a33f3..0e56f3b 100644
--- a/lisp/minibuffer.el
+++ b/lisp/minibuffer.el
@@ -1271,6 +1271,27 @@ scroll the window of possible completions."
                           minibuffer-completion-table
                           minibuffer-completion-predicate)))
 
+
+(defun minibuffer-tab-through-completions-default ()
+  "Default action in `minibuffer-scroll-window' WINDOW.
+This is called when *Completions* window is already visible."
+  (let ((window minibuffer-scroll-window))
+    (with-current-buffer (window-buffer window)
+      (if (pos-visible-in-window-p (point-max) window)
+          ;; If end is in view, scroll up to the beginning.
+          (set-window-start window (point-min) nil)
+        ;; Else scroll down one screen.
+        (with-selected-window window
+         (scroll-up)))
+      nil)))
+
+(defvar minibuffer-tab-through-completions-function
+  #'minibuffer-tab-through-completions-default
+  "Function to execute when requested completion.
+This is used when *Completions* frame is already visible and the
+completions command is called again.  This function receives the
+window to execute commands as a paramenter.")
+
 (defun completion--in-region-1 (beg end)
   ;; If the previous command was not this,
   ;; mark the completion buffer obsolete.
@@ -1278,21 +1299,14 @@ scroll the window of possible completions."
   (unless (eq 'completion-at-point last-command)
     (completion--flush-all-sorted-completions)
     (setq minibuffer-scroll-window nil))
-
   (cond
    ;; If there's a fresh completion window with a live buffer,
    ;; and this command is repeated, scroll that window.
    ((and (window-live-p minibuffer-scroll-window)
          (eq t (frame-visible-p (window-frame minibuffer-scroll-window))))
-    (let ((window minibuffer-scroll-window))
-      (with-current-buffer (window-buffer window)
-        (if (pos-visible-in-window-p (point-max) window)
-            ;; If end is in view, scroll up to the beginning.
-            (set-window-start window (point-min) nil)
-          ;; Else scroll down one screen.
-          (with-selected-window window
-           (scroll-up)))
-        nil)))
+    ;; Action to perform when pressing tab and completions are shown.
+    (funcall minibuffer-tab-through-completions-function)
+    nil)
    ;; If we're cycling, keep on cycling.
    ((and completion-cycling completion-all-sorted-completions)
     (minibuffer-force-complete beg end)
@@ -2039,12 +2053,20 @@ variables.")
           nil)))
     nil))
 
+(defvar minibuffer-hide-completions-hook nil
+  "Normal hook run at the end of completion-hide-completions.
+The hook is called from the minibuffer after hide completions.
+When this hook is run, the current buffer is the minibuffer and
+the *Completions* buffer is already hidden.")
+
 (defun minibuffer-hide-completions ()
   "Get rid of an out-of-date *Completions* buffer."
   ;; FIXME: We could/should use minibuffer-scroll-window here, but it
   ;; can also point to the minibuffer-parent-window, so it's a bit tricky.
   (let ((win (get-buffer-window "*Completions*" 0)))
-    (if win (with-selected-window win (bury-buffer)))))
+    (when win
+      (with-selected-window win (bury-buffer))
+      (run-hooks 'minibuffer-hide-completions-hook))))
 
 (defun exit-minibuffer ()
   "Terminate this minibuffer argument."