]> git.eshelyaron.com Git - emacs.git/commitdiff
Integrated Emacs 19.34 and XEmacs 19.15
authorKarl Heuer <kwzh@gnu.org>
Thu, 29 May 1997 18:18:23 +0000 (18:18 +0000)
committerKarl Heuer <kwzh@gnu.org>
Thu, 29 May 1997 18:18:23 +0000 (18:18 +0000)
corrections (typos, style, command revisions, etc).
Integrated hacked up XEmacs immediate keybindings display.  See
`icomplete-show-key-bindings', `icomplete-get-keys', and
`icomplete-completions'.  Doesn't work with mainline GNU
Emacs 19.34 (because the cmdloop doesn't set owindow, and the
current-local-map doesn't take optional buffer arg), so feature
is, by default, inhibited unless we're running in XEmacs.
(icomplete-get-keys): Return keys bound to func name in buffer
"owindow" - since "owindow" is calling-buffer history present
only in XEmacs, this function is only useful in XEmacs.
(icomplete-max-delay-chars, icomplete-compute-delay): New vars.
(icomplete-delay-completions-threshold): New var.
These customize the delay behavior, so that completions don't
intrude as quickly for short input.

lisp/icomplete.el

index 025af152a9d071e1d94f47a89a22512cbf0dab1d..f90100fd4d7aed4f2382608bd49ea6d9853b3861 100644 (file)
@@ -1,9 +1,9 @@
-;;; icomplete.el --- minibuffer completion incremental feedback
+;;;_. icomplete.el - minibuffer completion incremental feedback
 
 ;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
 
-;; Author: Ken Manheimer <klm@nist.gov>
-;; Maintainer: Ken Manheimer <klm@nist.gov>
+;; Author: Ken Manheimer <klm@python.org>
+;; Maintainer: Ken Manheimer <klm@python.org>
 ;; Created: Mar 1993 klm@nist.gov - first release to usenet
 ;; Keywords: help, abbrev
 
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+;; This file is also part of XEmacs.
+;; Hacked for XEmacs: David Hughes 7th September 1995
+;; With some integration and refinement by Ken Manheimer, May 1997
+
 ;;; Commentary:
 
 ;; Loading this package implements a more fine-grained minibuffer
 ;; can be enabled any time after the package is loaded by invoking
 ;; icomplete-mode without a prefix arg.
 
+;; This version of icomplete runs on Emacs 19.18 and later.  (It
+;; depends on the incorporation of minibuffer-setup-hook.)  The elisp
+;; archives, ftp://archive.cis.ohio-state.edu/pub/gnu/emacs/elisp-archive,
+;; probably still has a version that works in GNU Emacs v18.
+
 ;; Thanks to everyone for their suggestions for refinements of this
 ;; package.  I particularly have to credit Michael Cook, who
 ;; implemented an incremental completion style in his 'iswitch'
 (provide 'icomplete)
 
 ;;;_* User Customization variables
+(defvar icomplete-compute-delay .3
+  "*Completions-computation stall, used only with large-number
+completions - see `icomplete-delay-completions-threshold'.")
+(defvar icomplete-delay-completions-threshold 400
+  "*Pending-completions number over which to apply icomplete-compute-delay.")
+(defvar icomplete-max-delay-chars 3
+  "*Maximum number of initial chars to apply icomplete compute delay.")
 
 ;;;_* Initialization
 ;;;_  = icomplete-minibuffer-setup-hook
@@ -72,7 +88,7 @@ This hook is run during minibuffer setup iff icomplete will be active.
 It is intended for use in customizing icomplete for interoperation
 with other packages.  For instance:
 
-  \(add-hook 'icomplete-minibuffer-setup-hook 
+  \(add-hook 'icomplete-minibuffer-setup-hook
            \(function
             \(lambda ()
               \(make-local-variable 'resize-minibuffer-window-max-height)
@@ -107,6 +123,30 @@ Use `icomplete-mode' function to set it up properly for incremental
 minibuffer completion.")
 (add-hook 'icomplete-post-command-hook 'icomplete-exhibit)
 
+(defvar icomplete-show-key-bindings (string-match "XEmacs\\|Lucid"
+                                                 emacs-version)
+  "When non-nil show key bindings as well as completion when matching
+a command.  Currently working only for XEmacs - see `icomplete-get-keys'.")
+
+(defun icomplete-get-keys (func-name)
+  "Return the keys `func-name' is bound to as a string, or nil if none.
+  NOTE that this depends on `owindow' minbuf setting and `current-local-map'
+  taking arg, both present in XEmacs but not present in mainline GNU Emacs
+  19.34."
+  (when (commandp func-name)
+    (save-excursion
+      (let* ((sym (intern func-name))
+            (buf (set-buffer (window-buffer owindow)))
+            (keys (where-is-internal sym (current-local-map buf))))
+       (if keys
+           (concat "<"
+                   (mapconcat 'key-description
+                              (sort keys
+                                    #'(lambda (x y)
+                                        (< (length x) (length y))))
+                              ", ")
+                   ">"))))))
+
 ;;;_ > icomplete-mode (&optional prefix)
 ;;;###autoload
 (defun icomplete-mode (&optional prefix)
@@ -179,6 +219,7 @@ and `minibuffer-setup-hook'."
 ;;;_ > icomplete-exhibit ()
 (defun icomplete-exhibit ()
   "Insert icomplete completions display.
+
 Should be run via minibuffer `post-command-hook'.  See `icomplete-mode'
 and `minibuffer-setup-hook'."
   (if (icomplete-simple-completing-p)
@@ -194,7 +235,22 @@ and `minibuffer-setup-hook'."
              (make-local-variable 'icomplete-eoinput))
          (setq icomplete-eoinput (point))
                                         ; Insert the match-status information:
-         (if (> (point-max) 1)
+         (if (and (> (point-max) 1)
+                  (or
+                   ;; Don't bother with delay after certain number of chars:
+                   (> (point-max) icomplete-max-delay-chars)
+                   ;; Don't delay if alternatives number is small enough:
+                   (if minibuffer-completion-table
+                       (cond ((numberp minibuffer-completion-table)
+                              (< minibuffer-completion-table
+                                 icomplete-delay-completions-threshold))
+                             ((sequencep minibuffer-completion-table)
+                              (< (length minibuffer-completion-table)
+                                 icomplete-delay-completions-threshold))
+                             ))
+                   ;; Delay - give some grace time for next keystroke, before
+                   ;; embarking on computing completions:
+                   (sit-for icomplete-compute-delay)))
              (insert-string
               (icomplete-completions contents
                                      minibuffer-completion-table
@@ -219,7 +275,13 @@ one of \(), \[], or \{} pairs.  The choice of brackets is as follows:
 
 The displays for unambiguous matches have ` [Matched]' appended
 \(whether complete or not), or ` \[No matches]', if no eligible
-matches exist."
+matches exist.  \(In XEmacs, keybindings for matched commands, if any,
+are exhibited within the square braces.)"
+
+  ;; 'all-completions' doesn't like empty
+  ;; minibuffer-completion-table's (ie: (nil))
+  (if (and (listp candidates) (null (car candidates)))
+      (setq candidates nil))
 
   (let ((comps (all-completions name candidates predicate))
                                         ; "-determined" - only one candidate
@@ -229,47 +291,71 @@ matches exist."
         (open-bracket-prospects "{")
         (close-bracket-prospects "}")
         )
-    (cond ((null comps) (format " %sNo matches%s"
-                                open-bracket-determined
-                                close-bracket-determined))
-          ((null (cdr comps))           ;one match
-           (concat (if (and (> (length (car comps))
-                               (length name)))
-                       (concat open-bracket-determined
-                               (substring (car comps) (length name))
-                               close-bracket-determined)
-                     "")
-                   " [Matched]"))
-          (t                            ;multiple matches
-           (let* ((most (try-completion name candidates predicate))
-                  (most-len (length most))
-                  most-is-exact
-                  (alternatives
-                   (apply
-                    (function concat)
-                    (cdr (apply
-                         (function nconc)
-                         (mapcar '(lambda (com)
-                                    (if (= (length com) most-len)
-                                        ;; Most is one exact match,
-                                        ;; note that and leave out
-                                        ;; for later indication:
-                                        (progn
-                                          (setq most-is-exact t)
-                                          ())
-                                      (list ","
-                                            (substring com
-                                                       most-len))))
-                                 comps))))))
-             (concat (and (> most-len (length name))
-                          (concat open-bracket-determined
-                                  (substring most (length name))
-                                  close-bracket-determined))
-                     open-bracket-prospects
-                     (if most-is-exact
-                         (concat "," alternatives)
-                       alternatives)
-                     close-bracket-prospects))))))
+    (catch 'input
+      (cond ((null comps) (format " %sNo matches%s"
+                                 open-bracket-determined
+                                 close-bracket-determined))
+           ((null (cdr comps))         ;one match
+            (concat (if (and (> (length (car comps))
+                                (length name)))
+                        (concat open-bracket-determined
+                                (substring (car comps) (length name))
+                                close-bracket-determined)
+                      "")
+                    " [Matched"
+                    (let ((keys (and icomplete-show-key-bindings
+                                     (commandp (intern-soft (car comps)))
+                                     (icomplete-get-keys (car comps)))))
+                      (if keys
+                          (concat "; " keys)
+                        ""))
+                    "]"))
+           (t                          ;multiple matches
+            (let* ((most
+                    (try-completion name candidates
+                                    (and predicate
+                                         ;; Wrap predicate in impatience - ie,
+                                         ;; `throw' up when pending input is
+                                         ;; noticed.  Adds some overhead to
+                                         ;; predicate, but should be worth it.
+                                         (function
+                                          (lambda (item)
+                                            (if (input-pending-p)
+                                                (throw 'input "")
+                                              (apply predicate
+                                                     item nil)))))))
+                   (most-len (length most))
+                   most-is-exact
+                   (alternatives
+                    (substring
+                     (apply (function concat)
+                            (mapcar (function
+                                     (lambda (com)
+                                       (if (input-pending-p)
+                                           (throw 'input ""))
+                                       (if (= (length com) most-len)
+                                           ;; Most is one exact match,
+                                           ;; note that and leave out
+                                           ;; for later indication:
+                                           (progn
+                                             (setq most-is-exact t)
+                                             ())
+                                         (concat ","
+                                                 (substring com
+                                                            most-len)))))
+                                    comps))
+                     1)))
+              (concat (and (> most-len (length name))
+                           (concat open-bracket-determined
+                                   (substring most (length name))
+                                   close-bracket-determined))
+                      open-bracket-prospects
+                      (if most-is-exact
+                          ;; Add a ',' at the front to indicate "complete but
+                          ;; not unique":
+                          (concat "," alternatives)
+                        alternatives)
+                      close-bracket-prospects)))))))
 
 ;;;_ + Initialization
 ;;; If user hasn't setq-default icomplete-mode to nil, then setup for
@@ -284,4 +370,3 @@ matches exist."
 ;;;End:
 
 ;;; icomplete.el ends here
-