lisp/complete.el

   1 ;;; complete.el --- partial completion mechanism plus other goodies
   2
   3 ;; Copyright (C) 1990, 1991, 1992, 1993, 1999, 2000, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
   5
   6 ;; Author: Dave Gillespie <daveg@synaptics.com>
   7 ;; Keywords: abbrev convenience
   8 ;; Special thanks to Hallvard Furuseth for his many ideas and contributions.
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; Extended completion for the Emacs minibuffer.
  28 ;;
  29 ;; The basic idea is that the command name or other completable text is
  30 ;; divided into words and each word is completed separately, so that
  31 ;; "M-x p-b" expands to "M-x print-buffer".  If the entry is ambiguous
  32 ;; each word is completed as much as possible and then the cursor is
  33 ;; left at the first position where typing another letter will resolve
  34 ;; the ambiguity.
  35 ;;
  36 ;; Word separators for this purpose are hyphen, space, and period.
  37 ;; These would most likely occur in command names, Info menu items,
  38 ;; and file names, respectively.  But all word separators are treated
  39 ;; alike at all times.
  40 ;;
  41 ;; This completion package replaces the old-style completer's key
  42 ;; bindings for TAB, SPC, RET, and `?'.  The old completer is still
  43 ;; available on the Meta versions of those keys.  If you set
  44 ;; PC-meta-flag to nil, the old completion keys will be left alone
  45 ;; and the partial completer will use the Meta versions of the keys.
  46
  47
  48 ;; Usage:  M-x partial-completion-mode.  During completable minibuffer entry,
  49 ;;
  50 ;;     TAB    means to do a partial completion;
  51 ;;     SPC    means to do a partial complete-word;
  52 ;;     RET    means to do a partial complete-and-exit;
  53 ;;     ?      means to do a partial completion-help.
  54 ;;
  55 ;; If you set PC-meta-flag to nil, then TAB, SPC, RET, and ? perform
  56 ;; original Emacs completions, and M-TAB etc. do partial completion.
  57 ;; To do this, put the command,
  58 ;;
  59 ;;       (setq PC-meta-flag nil)
  60 ;;
  61 ;; in your .emacs file.  To load partial completion automatically, put
  62 ;;
  63 ;;       (partial-completion-mode t)
  64 ;;
  65 ;; in your .emacs file, too.  Things will be faster if you byte-compile
  66 ;; this file when you install it.
  67 ;;
  68 ;; As an extra feature, in cases where RET would not normally
  69 ;; complete (such as `C-x b'), the M-RET key will always do a partial
  70 ;; complete-and-exit.  Thus `C-x b f.c RET' will select or create a
  71 ;; buffer called "f.c", but `C-x b f.c M-RET' will select the existing
  72 ;; buffer whose name matches that pattern (perhaps "filing.c").
  73 ;; (PC-meta-flag does not affect this behavior; M-RET used to be
  74 ;; undefined in this situation.)
  75 ;;
  76 ;; The regular M-TAB (lisp-complete-symbol) command also supports
  77 ;; partial completion in this package.
  78
  79 ;; In addition, this package includes a feature for accessing include
  80 ;; files.  For example, `C-x C-f <sys/time.h> RET' reads the file
  81 ;; /usr/include/sys/time.h.  The variable PC-include-file-path is a
  82 ;; list of directories in which to search for include files.  Completion
  83 ;; is supported in include file names.
  84
  85
  86 ;;; Code:
  87
  88 (defgroup partial-completion nil
  89   "Partial Completion of items."
  90   :prefix "pc-"
  91   :group 'minibuffer
  92   :group 'convenience)
  93
  94 (defcustom PC-first-char 'find-file
  95   "Control how the first character of a string is to be interpreted.
  96 If nil, the first character of a string is not taken literally if it is a word
  97 delimiter, so that \".e\" matches \"*.e*\".
  98 If t, the first character of a string is always taken literally even if it is a
  99 word delimiter, so that \".e\" matches \".e*\".
 100 If non-nil and non-t, the first character is taken literally only for file name
 101 completion."
 102   :type '(choice (const :tag "delimiter" nil)
 103                  (const :tag "literal" t)
 104                  (other :tag "find-file" find-file))
 105   :group 'partial-completion)
 106
 107 (defcustom PC-meta-flag t
 108   "If non-nil, TAB means PC completion and M-TAB means normal completion.
 109 Otherwise, TAB means normal completion and M-TAB means Partial Completion."
 110   :type 'boolean
 111   :group 'partial-completion)
 112
 113 (defcustom PC-word-delimiters "-_. "
 114   "A string of characters treated as word delimiters for completion.
 115 Some arcane rules:
 116 If `]' is in this string, it must come first.
 117 If `^' is in this string, it must not come first.
 118 If `-' is in this string, it must come first or right after `]'.
 119 In other words, if S is this string, then `[S]' must be a valid Emacs regular
 120 expression (not containing character ranges like `a-z')."
 121   :type 'string
 122   :group 'partial-completion)
 123
 124 (defcustom PC-include-file-path '("/usr/include" "/usr/local/include")
 125   "A list of directories in which to look for include files.
 126 If nil, means use the colon-separated path in the variable $INCPATH instead."
 127   :type '(repeat directory)
 128   :group 'partial-completion)
 129
 130 (defcustom PC-disable-includes nil
 131   "If non-nil, include-file support in \\[find-file] is disabled."
 132   :type 'boolean
 133   :group 'partial-completion)
 134
 135 (defvar PC-default-bindings t
 136   "If non-nil, default partial completion key bindings are suppressed.")
 137
 138 (defvar PC-env-vars-alist nil
 139   "A list of the environment variable names and values.")
 140
 141 \f
 142 (defun PC-bindings (bind)
 143   (let ((completion-map minibuffer-local-completion-map)
 144         (must-match-map minibuffer-local-must-match-map))
 145     (cond ((not bind)
 146            ;; These bindings are the default bindings.  It would be better to
 147            ;; restore the previous bindings.
 148            (define-key read-expression-map "\e\t" 'lisp-complete-symbol)
 149
 150            (define-key completion-map "\t"      'minibuffer-complete)
 151            (define-key completion-map " "       'minibuffer-complete-word)
 152            (define-key completion-map "?"       'minibuffer-completion-help)
 153
 154            (define-key must-match-map "\r"      'minibuffer-complete-and-exit)
 155            (define-key must-match-map "\n"      'minibuffer-complete-and-exit)
 156
 157            (define-key global-map [remap lisp-complete-symbol]  nil))
 158           (PC-default-bindings
 159            (define-key read-expression-map "\e\t" 'PC-lisp-complete-symbol)
 160
 161            (define-key completion-map "\t"      'PC-complete)
 162            (define-key completion-map " "       'PC-complete-word)
 163            (define-key completion-map "?"       'PC-completion-help)
 164
 165            (define-key completion-map "\e\t"    'PC-complete)
 166            (define-key completion-map "\e "     'PC-complete-word)
 167            (define-key completion-map "\e\r"    'PC-force-complete-and-exit)
 168            (define-key completion-map "\e\n"    'PC-force-complete-and-exit)
 169            (define-key completion-map "\e?"     'PC-completion-help)
 170
 171            (define-key must-match-map "\r"      'PC-complete-and-exit)
 172            (define-key must-match-map "\n"      'PC-complete-and-exit)
 173
 174            (define-key must-match-map "\e\r"    'PC-complete-and-exit)
 175            (define-key must-match-map "\e\n"    'PC-complete-and-exit)
 176
 177            (define-key global-map [remap lisp-complete-symbol]  'PC-lisp-complete-symbol)))))
 178
 179 (defvar PC-do-completion-end nil
 180   "Internal variable used by `PC-do-completion'.")
 181
 182 (make-variable-buffer-local 'PC-do-completion-end)
 183
 184 (defvar PC-goto-end nil
 185    "Internal variable set in `PC-do-completion', used in
 186 `choose-completion-string-functions'.")
 187
 188 (make-variable-buffer-local 'PC-goto-end)
 189
 190 ;;;###autoload
 191 (define-minor-mode partial-completion-mode
 192   "Toggle Partial Completion mode.
 193 With prefix ARG, turn Partial Completion mode on if ARG is positive.
 194
 195 When Partial Completion mode is enabled, TAB (or M-TAB if `PC-meta-flag' is
 196 nil) is enhanced so that if some string is divided into words and each word is
 197 delimited by a character in `PC-word-delimiters', partial words are completed
 198 as much as possible and `*' characters are treated likewise in file names.
 199
 200 For example, M-x p-c-m expands to M-x partial-completion-mode since no other
 201 command begins with that sequence of characters, and
 202 \\[find-file] f_b.c TAB might complete to foo_bar.c if that file existed and no
 203 other file in that directory begins with that sequence of characters.
 204
 205 Unless `PC-disable-includes' is non-nil, the `<...>' sequence is interpreted
 206 specially in \\[find-file].  For example,
 207 \\[find-file] <sys/time.h> RET finds the file `/usr/include/sys/time.h'.
 208 See also the variable `PC-include-file-path'.
 209
 210 Partial Completion mode extends the meaning of `completion-auto-help' (which
 211 see), so that if it is neither nil nor t, Emacs shows the `*Completions*'
 212 buffer only on the second attempt to complete.  That is, if TAB finds nothing
 213 to complete, the first TAB just says \"Next char not unique\" and the
 214 second TAB brings up the `*Completions*' buffer."
 215   :global t :group 'partial-completion
 216   ;; Deal with key bindings...
 217   (PC-bindings partial-completion-mode)
 218   ;; Deal with include file feature...
 219   (cond ((not partial-completion-mode)
 220          (remove-hook 'find-file-not-found-functions 'PC-look-for-include-file))
 221         ((not PC-disable-includes)
 222          (add-hook 'find-file-not-found-functions 'PC-look-for-include-file)))
 223   ;; Adjust the completion selection in *Completion* buffers to the way
 224   ;; we work.  The default minibuffer completion code only completes the
 225   ;; text before point and leaves the text after point alone (new in
 226   ;; Emacs-22).  In contrast we use the whole text and we even sometimes
 227   ;; move point to a place before EOB, to indicate the first position where
 228   ;; there's a difference, so when the user uses choose-completion, we have
 229   ;; to trick choose-completion into replacing the whole minibuffer text
 230   ;; rather than only the text before point.  --Stef
 231   (funcall
 232    (if partial-completion-mode 'add-hook 'remove-hook)
 233    'choose-completion-string-functions
 234    (lambda (choice buffer mini-p base-size)
 235      ;; When completing M-: (lisp- ) with point before the ), it is
 236      ;; not appropriate to go to point-max (unlike the filename case).
 237      (if (and (not PC-goto-end)
 238               mini-p)
 239          (goto-char (point-max))
 240        ;; Need a similar hack for the non-minibuffer-case -- gm.
 241        (when PC-do-completion-end
 242          (goto-char PC-do-completion-end)
 243          (setq PC-do-completion-end nil)))
 244      (setq PC-goto-end nil)
 245      nil))
 246   ;; Build the env-completion and mapping table.
 247   (when (and partial-completion-mode (null PC-env-vars-alist))
 248     (setq PC-env-vars-alist
 249           (mapcar (lambda (string)
 250                     (let ((d (string-match "=" string)))
 251                       (cons (concat "$" (substring string 0 d))
 252                             (and d (substring string (1+ d))))))
 253                   process-environment))))
 254
 255 \f
 256 (defun PC-complete ()
 257   "Like minibuffer-complete, but allows \"b--di\"-style abbreviations.
 258 For example, \"M-x b--di\" would match `byte-recompile-directory', or any
 259 name which consists of three or more words, the first beginning with \"b\"
 260 and the third beginning with \"di\".
 261
 262 The pattern \"b--d\" is ambiguous for `byte-recompile-directory' and
 263 `beginning-of-defun', so this would produce a list of completions
 264 just like when normal Emacs completions are ambiguous.
 265
 266 Word-delimiters for the purposes of Partial Completion are \"-\", \"_\",
 267 \".\", and SPC."
 268   (interactive)
 269   (if (PC-was-meta-key)
 270       (minibuffer-complete)
 271     ;; If the previous command was not this one,
 272     ;; never scroll, always retry completion.
 273     (or (eq last-command this-command)
 274         (setq minibuffer-scroll-window nil))
 275     (let ((window minibuffer-scroll-window))
 276       ;; If there's a fresh completion window with a live buffer,
 277       ;; and this command is repeated, scroll that window.
 278       (if (and window (window-buffer window)
 279                (buffer-name (window-buffer window)))
 280           (with-current-buffer (window-buffer window)
 281             (if (pos-visible-in-window-p (point-max) window)
 282                 (set-window-start window (point-min) nil)
 283               (scroll-other-window)))
 284         (PC-do-completion nil)))))
 285
 286
 287 (defun PC-complete-word ()
 288   "Like `minibuffer-complete-word', but allows \"b--di\"-style abbreviations.
 289 See `PC-complete' for details.
 290 This can be bound to other keys, like `-' and `.', if you wish."
 291   (interactive)
 292   (if (eq (PC-was-meta-key) PC-meta-flag)
 293       (if (eq last-command-event ? )
 294           (minibuffer-complete-word)
 295         (self-insert-command 1))
 296     (self-insert-command 1)
 297     (if (eobp)
 298         (PC-do-completion 'word))))
 299
 300
 301 (defun PC-complete-space ()
 302   "Like `minibuffer-complete-word', but allows \"b--di\"-style abbreviations.
 303 See `PC-complete' for details.
 304 This is suitable for binding to other keys which should act just like SPC."
 305   (interactive)
 306   (if (eq (PC-was-meta-key) PC-meta-flag)
 307       (minibuffer-complete-word)
 308     (insert " ")
 309     (if (eobp)
 310         (PC-do-completion 'word))))
 311
 312
 313 (defun PC-complete-and-exit ()
 314   "Like `minibuffer-complete-and-exit', but allows \"b--di\"-style abbreviations.
 315 See `PC-complete' for details."
 316   (interactive)
 317   (if (eq (PC-was-meta-key) PC-meta-flag)
 318       (minibuffer-complete-and-exit)
 319     (PC-do-complete-and-exit)))
 320
 321 (defun PC-force-complete-and-exit ()
 322   "Like `minibuffer-complete-and-exit', but allows \"b--di\"-style abbreviations.
 323 See `PC-complete' for details."
 324   (interactive)
 325   (let ((minibuffer-completion-confirm nil))
 326     (PC-do-complete-and-exit)))
 327
 328 (defun PC-do-complete-and-exit ()
 329   (cond
 330    ((= (point-max) (minibuffer-prompt-end))
 331     ;; Duplicate the "bug" that Info-menu relies on...
 332     (exit-minibuffer))
 333    ((eq minibuffer-completion-confirm 'confirm)
 334     (if (or (eq last-command this-command)
 335             (test-completion (field-string)
 336                              minibuffer-completion-table
 337                              minibuffer-completion-predicate))
 338         (exit-minibuffer)
 339       (PC-temp-minibuffer-message " [Confirm]")))
 340    ((eq minibuffer-completion-confirm 'confirm-after-completion)
 341     ;; Similar to the above, but only if trying to exit immediately
 342     ;; after typing TAB (this catches most minibuffer typos).
 343     (if (and (memq last-command minibuffer-confirm-exit-commands)
 344              (not (test-completion (field-string)
 345                                    minibuffer-completion-table
 346                                    minibuffer-completion-predicate)))
 347         (PC-temp-minibuffer-message " [Confirm]")
 348       (exit-minibuffer)))
 349    (t
 350     (let ((flag (PC-do-completion 'exit)))
 351       (and flag
 352            (if (or (eq flag 'complete)
 353                    (not minibuffer-completion-confirm))
 354                (exit-minibuffer)
 355              (PC-temp-minibuffer-message " [Confirm]")))))))
 356
 357
 358 (defun PC-completion-help ()
 359   "Like `minibuffer-completion-help', but allows \"b--di\"-style abbreviations.
 360 See `PC-complete' for details."
 361   (interactive)
 362   (if (eq (PC-was-meta-key) PC-meta-flag)
 363       (minibuffer-completion-help)
 364     (PC-do-completion 'help)))
 365
 366 (defun PC-was-meta-key ()
 367   (or (/= (length (this-command-keys)) 1)
 368       (let ((key (aref (this-command-keys) 0)))
 369         (if (integerp key)
 370             (>= key 128)
 371           (not (null (memq 'meta (event-modifiers key))))))))
 372
 373
 374 (defvar PC-ignored-extensions 'empty-cache)
 375 (defvar PC-delims 'empty-cache)
 376 (defvar PC-ignored-regexp nil)
 377 (defvar PC-word-failed-flag nil)
 378 (defvar PC-delim-regex nil)
 379 (defvar PC-ndelims-regex nil)
 380 (defvar PC-delims-list nil)
 381
 382 (defvar PC-completion-as-file-name-predicate
 383   (lambda () minibuffer-completing-file-name)
 384   "A function testing whether a minibuffer completion now will work filename-style.
 385 The function takes no arguments, and typically looks at the value
 386 of `minibuffer-completion-table' and the minibuffer contents.")
 387
 388 ;; Returns the sequence of non-delimiter characters that follow regexp in string.
 389 (defun PC-chunk-after (string regexp)
 390   (if (not (string-match regexp string))
 391       (let ((message "String %s didn't match regexp %s"))
 392         (message message string regexp)
 393         (error message string regexp)))
 394   (let ((result (substring string (match-end 0))))
 395     ;; result may contain multiple chunks
 396     (if (string-match PC-delim-regex result)
 397         (setq result (substring result 0 (match-beginning 0))))
 398     result))
 399
 400 (defun test-completion-ignore-case (str table pred)
 401   "Like `test-completion', but ignores case when possible."
 402   ;; Binding completion-ignore-case to nil ensures, for compatibility with
 403   ;; standard completion, that the return value is exactly one of the
 404   ;; possibilities.  Do this binding only if pred is nil, out of paranoia;
 405   ;; perhaps it is safe even if pred is non-nil.
 406   (if pred
 407       (test-completion str table pred)
 408     (let ((completion-ignore-case nil))
 409       (test-completion str table pred))))
 410
 411 ;; The following function is an attempt to work around two problems:
 412
 413 ;; (1) When complete.el was written, (try-completion "" '(("") (""))) used to
 414 ;; return the value "".  With a change from 2002-07-07 it returns t which caused
 415 ;; `PC-lisp-complete-symbol' to fail with a "Wrong type argument: sequencep, t"
 416 ;; error.  `PC-try-completion' returns STRING in this case.
 417
 418 ;; (2) (try-completion "" '((""))) returned t before the above-mentioned change.
 419 ;; Since `PC-chop-word' operates on the return value of `try-completion' this
 420 ;; case might have provoked a similar error as in (1).  `PC-try-completion'
 421 ;; returns "" instead.  I don't know whether this is a real problem though.
 422
 423 ;; Since `PC-try-completion' is not a guaranteed to fix these bugs reliably, you
 424 ;; should try to look at the following discussions when you encounter problems:
 425 ;; - emacs-pretest-bug ("Partial Completion" starting 2007-02-23),
 426 ;; - emacs-devel ("[address-of-OP: Partial completion]" starting 2007-02-24),
 427 ;; - emacs-devel ("[address-of-OP: EVAL and mouse selection in *Completions*]"
 428 ;;   starting 2007-03-05).
 429 (defun PC-try-completion (string alist &optional predicate)
 430   "Like `try-completion' but return STRING instead of t."
 431   (let ((result (try-completion string alist predicate)))
 432     (if (eq result t) string result)))
 433
 434 ;; TODO document MODE magic...
 435 (defun PC-do-completion (&optional mode beg end goto-end)
 436   "Internal function to do the work of partial completion.
 437 Text to be completed lies between BEG and END.  Normally when
 438 replacing text in the minibuffer, this function replaces up to
 439 point-max (as is appropriate for completing a file name).  If
 440 GOTO-END is non-nil, however, it instead replaces up to END."
 441   (or beg (setq beg (minibuffer-prompt-end)))
 442   (or end (setq end (point-max)))
 443   (let* ((table (if (eq minibuffer-completion-table 'read-file-name-internal)
 444                     'PC-read-file-name-internal
 445                     minibuffer-completion-table))
 446          (pred minibuffer-completion-predicate)
 447          (filename (funcall PC-completion-as-file-name-predicate))
 448          (dirname nil) ; non-nil only if a filename is being completed
 449          ;; The following used to be "(dirlength 0)" which caused the erasure of
 450          ;; the entire buffer text before `point' when inserting a completion
 451          ;; into a buffer.
 452          dirlength
 453          (str (buffer-substring beg end))
 454          (incname (and filename (string-match "<\\([^\"<>]*\\)>?$" str)))
 455          (ambig nil)
 456          basestr origstr
 457          env-on
 458          regex
 459          p offset
 460          abbreviated
 461          (poss nil)
 462          helpposs
 463          (case-fold-search completion-ignore-case))
 464
 465     ;; Check if buffer contents can already be considered complete
 466     (if (and (eq mode 'exit)
 467              (test-completion str table pred))
 468         'complete
 469
 470       ;; Do substitutions in directory names
 471       (and filename
 472            (setq basestr (or (file-name-directory str) ""))
 473            (setq dirlength (length basestr))
 474            ;; Do substitutions in directory names
 475            (setq p (substitute-in-file-name basestr))
 476            (not (string-equal basestr p))
 477            (setq str (concat p (file-name-nondirectory str)))
 478            (progn
 479              (delete-region beg end)
 480              (insert str)
 481              (setq end (+ beg (length str)))))
 482
 483       ;; Prepare various delimiter strings
 484       (or (equal PC-word-delimiters PC-delims)
 485           (setq PC-delims PC-word-delimiters
 486                 PC-delim-regex (concat "[" PC-delims "]")
 487                 PC-ndelims-regex (concat "[^" PC-delims "]*")
 488                 PC-delims-list (append PC-delims nil)))
 489
 490       ;; Add wildcards if necessary
 491       (and filename
 492            (let ((dir (file-name-directory str))
 493                  (file (file-name-nondirectory str))
 494                  ;; The base dir for file-completion was passed in `predicate'.
 495                  (default-directory (if (stringp pred) (expand-file-name pred)
 496                                       default-directory)))
 497              (while (and (stringp dir) (not (file-directory-p dir)))
 498                (setq dir (directory-file-name dir))
 499                (setq file (concat (replace-regexp-in-string
 500                                    PC-delim-regex "*\\&"
 501                                    (file-name-nondirectory dir))
 502                                   "*/" file))
 503                (setq dir (file-name-directory dir)))
 504              (setq origstr str str (concat dir file))))
 505
 506       ;; Look for wildcard expansions in directory name
 507       (and filename
 508            (string-match "\\*.*/" str)
 509            (let ((pat str)
 510                  ;; The base dir for file-completion was passed in `predicate'.
 511                  (default-directory (if (stringp pred) (expand-file-name pred)
 512                                       default-directory))
 513                  files)
 514              (setq p (1+ (string-match "/[^/]*\\'" pat)))
 515              (while (setq p (string-match PC-delim-regex pat p))
 516                (setq pat (concat (substring pat 0 p)
 517                                  "*"
 518                                  (substring pat p))
 519                      p (+ p 2)))
 520              (setq files (file-expand-wildcards (concat pat "*")))
 521              (if files
 522                  (let ((dir (file-name-directory (car files)))
 523                        (p files))
 524                    (while (and (setq p (cdr p))
 525                                (equal dir (file-name-directory (car p)))))
 526                    (if p
 527                        (setq filename nil table nil
 528                              pred (if (stringp pred) nil pred)
 529                              ambig t)
 530                      (delete-region beg end)
 531                      (setq str (concat dir (file-name-nondirectory str)))
 532                      (insert str)
 533                      (setq end (+ beg (length str)))))
 534                (if origstr
 535                        ;; If the wildcards were introduced by us, it's
 536                        ;; possible that PC-read-file-name-internal can
 537                        ;; still find matches for the original string
 538                        ;; even if we couldn't, so remove the added
 539                        ;; wildcards.
 540                    (setq str origstr)
 541                  (setq filename nil table nil
 542                        pred (if (stringp pred) nil pred))))))
 543
 544       ;; Strip directory name if appropriate
 545       (if filename
 546           (if incname
 547               (setq basestr (substring str incname)
 548                     dirname (substring str 0 incname))
 549             (setq basestr (file-name-nondirectory str)
 550                   dirname (file-name-directory str))
 551             ;; Make sure str is consistent with its directory and basename
 552             ;; parts.  This is important on DOZe'NT systems when str only
 553             ;; includes a drive letter, like in "d:".
 554             (setq str (concat dirname basestr)))
 555         (setq basestr str))
 556
 557       ;; Convert search pattern to a standard regular expression
 558       (setq regex (regexp-quote basestr)
 559             offset (if (and (> (length regex) 0)
 560                             (not (eq (aref basestr 0) ?\*))
 561                             (or (eq PC-first-char t)
 562                                 (and PC-first-char filename))) 1 0)
 563             p offset)
 564       (while (setq p (string-match PC-delim-regex regex p))
 565         (if (eq (aref regex p) ? )
 566             (setq regex (concat (substring regex 0 p)
 567                                 PC-ndelims-regex
 568                                 PC-delim-regex
 569                                 (substring regex (1+ p)))
 570                   p (+ p (length PC-ndelims-regex) (length PC-delim-regex)))
 571           (let ((bump (if (memq (aref regex p)
 572                                 '(?$ ?^ ?\. ?* ?+ ?? ?[ ?] ?\\))
 573                           -1 0)))
 574             (setq regex (concat (substring regex 0 (+ p bump))
 575                                 PC-ndelims-regex
 576                                 (substring regex (+ p bump)))
 577                   p (+ p (length PC-ndelims-regex) 1)))))
 578       (setq p 0)
 579       (if filename
 580           (while (setq p (string-match "\\\\\\*" regex p))
 581             (setq regex (concat (substring regex 0 p)
 582                                 "[^/]*"
 583                                 (substring regex (+ p 2))))))
 584       ;;(setq the-regex regex)
 585       (setq regex (concat "\\`" regex))
 586
 587       (and (> (length basestr) 0)
 588            (= (aref basestr 0) ?$)
 589            (setq env-on t
 590                  table PC-env-vars-alist
 591                  pred nil))
 592
 593       ;; Find an initial list of possible completions
 594         (unless (setq p (string-match (concat PC-delim-regex
 595                                              (if filename "\\|\\*" ""))
 596                                      str
 597                                       (+ (length dirname) offset)))
 598
 599           ;; Minibuffer contains no hyphens -- simple case!
 600           (setq poss (all-completions (if env-on basestr str)
 601                                       table
 602                                       pred))
 603           (unless (or poss (string-equal str ""))
 604             ;; Try completion as an abbreviation, e.g. "mvb" ->
 605             ;; "m-v-b" -> "multiple-value-bind", but only for
 606             ;; non-empty strings.
 607             (setq origstr str
 608                   abbreviated t)
 609             (if filename
 610                 (cond
 611                   ;; "alpha" or "/alpha" -> expand whole path.
 612                   ((string-match "^/?\\([A-Za-z0-9]+\\)$" str)
 613                    (setq
 614                     basestr ""
 615                     p nil
 616                     poss (file-expand-wildcards
 617                           (concat "/"
 618                                   (mapconcat #'list (match-string 1 str) "*/")
 619                                   "*"))
 620                     beg (1- beg)))
 621                   ;; Alphanumeric trailer -> expand trailing file
 622                   ((string-match "^\\(.+/\\)\\([A-Za-z0-9]+\\)$" str)
 623                    (setq regex (concat "\\`"
 624                                         (mapconcat #'list
 625                                                    (match-string 2 str)
 626                                                    "[A-Za-z0-9]*[^A-Za-z0-9]"))
 627                           p (1+ (length (match-string 1 str))))))
 628               (setq regex (concat "\\`" (mapconcat (lambda (c)
 629                                                      (regexp-quote (string c)))
 630                                                    str "[^-]*-"))
 631                     p 1))))
 632         (when p
 633         ;; Use all-completions to do an initial cull.  This is a big win,
 634         ;; since all-completions is written in C!
 635         (let ((compl (all-completions (if env-on
 636                                           (file-name-nondirectory (substring str 0 p))
 637                                         (substring str 0 p))
 638                                       table
 639                                       pred)))
 640           (setq p compl)
 641             (when (and compl abbreviated)
 642               (if filename
 643                   (progn
 644                     (setq p nil)
 645                     (dolist (x compl)
 646                       (when (string-match regex x)
 647                         (push x p)))
 648                     (setq basestr (try-completion "" p)))
 649                   (setq basestr (mapconcat 'list str "-"))
 650                   (delete-region beg end)
 651                   (setq end (+ beg (length basestr)))
 652                   (insert basestr))))
 653           (while p
 654             (and (string-match regex (car p))
 655                  (progn
 656                    (set-text-properties 0 (length (car p)) '() (car p))
 657                    (setq poss (cons (car p) poss))))
 658             (setq p (cdr p))))
 659
 660       ;; If table had duplicates, they can be here.
 661       (delete-dups poss)
 662
 663       ;; Handle completion-ignored-extensions
 664       (and filename
 665            (not (eq mode 'help))
 666            (let ((p2 poss))
 667
 668              ;; Build a regular expression representing the extensions list
 669              (or (equal completion-ignored-extensions PC-ignored-extensions)
 670                  (setq PC-ignored-regexp
 671                        (concat "\\("
 672                                (mapconcat
 673                                 'regexp-quote
 674                                 (setq PC-ignored-extensions
 675                                       completion-ignored-extensions)
 676                                 "\\|")
 677                                "\\)\\'")))
 678
 679              ;; Check if there are any without an ignored extension.
 680              ;; Also ignore `.' and `..'.
 681              (setq p nil)
 682              (while p2
 683                (or (string-match PC-ignored-regexp (car p2))
 684                    (string-match "\\(\\`\\|/\\)[.][.]?/?\\'" (car p2))
 685                    (setq p (cons (car p2) p)))
 686                (setq p2 (cdr p2)))
 687
 688              ;; If there are "good" names, use them
 689              (and p (setq poss p))))
 690
 691       ;; Now we have a list of possible completions
 692
 693       (cond
 694
 695        ;; No valid completions found
 696        ((null poss)
 697         (if (and (eq mode 'word)
 698                  (not PC-word-failed-flag))
 699             (let ((PC-word-failed-flag t))
 700               (delete-backward-char 1)
 701               (PC-do-completion 'word))
 702                (when abbreviated
 703                  (delete-region beg end)
 704                  (insert origstr))
 705           (beep)
 706           (PC-temp-minibuffer-message (if ambig
 707                                           " [Ambiguous dir name]"
 708                                         (if (eq mode 'help)
 709                                             " [No completions]"
 710                                           " [No match]")))
 711           nil))
 712
 713        ;; More than one valid completion found
 714        ((or (cdr (setq helpposs poss))
 715             (memq mode '(help word)))
 716
 717         ;; Is the actual string one of the possible completions?
 718         (setq p (and (not (eq mode 'help)) poss))
 719         (while (and p
 720                     (not (string-equal (car p) basestr)))
 721           (setq p (cdr p)))
 722         (and p (null mode)
 723              (PC-temp-minibuffer-message " [Complete, but not unique]"))
 724         (if (and p
 725                  (not (and (null mode)
 726                            (eq this-command last-command))))
 727             t
 728
 729           ;; If ambiguous, try for a partial completion
 730           (let ((improved nil)
 731                 prefix
 732                 (pt nil)
 733                 (skip "\\`"))
 734
 735             ;; Check if next few letters are the same in all cases
 736             (if (and (not (eq mode 'help))
 737                      (setq prefix (PC-try-completion
 738                                    (PC-chunk-after basestr skip) poss)))
 739                 (let ((first t) i)
 740                   (if (eq mode 'word)
 741                       (setq prefix (PC-chop-word prefix basestr)))
 742                   (goto-char (+ beg (length dirname)))
 743                   (while (and (progn
 744                                 (setq i 0) ; index into prefix string
 745                                 (while (< i (length prefix))
 746                                   (if (and (< (point) end)
 747                                            (or (eq (downcase (aref prefix i))
 748                                                    (downcase (following-char)))
 749                                                (and (looking-at " ")
 750                                                     (memq (aref prefix i)
 751                                                           PC-delims-list))))
 752                                       ;; replace " " by the actual delimiter
 753                                       ;; or input char by prefix char
 754                                       (progn
 755                                         (delete-char 1)
 756                                         (insert (substring prefix i (1+ i))))
 757                                     ;; insert a new character
 758                                     (progn
 759                                       (and filename (looking-at "\\*")
 760                                            (progn
 761                                              (delete-char 1)
 762                                              (setq end (1- end))))
 763                                       (setq improved t)
 764                                       (insert (substring prefix i (1+ i)))
 765                                       (setq end (1+ end))))
 766                                   (setq i (1+ i)))
 767                                 (or pt (setq pt (point)))
 768                                 (looking-at PC-delim-regex))
 769                               (setq skip (concat skip
 770                                                  (regexp-quote prefix)
 771                                                  PC-ndelims-regex)
 772                                     prefix (PC-try-completion
 773                                             (PC-chunk-after
 774                                              ;; not basestr, because that does
 775                                              ;; not reflect insertions
 776                                              (buffer-substring
 777                                               (+ beg (length dirname)) end)
 778                                              skip)
 779                                             (mapcar
 780                                              (lambda (x)
 781                                                (when (string-match skip x)
 782                                                  (substring x (match-end 0))))
 783                                              poss)))
 784                               (or (> i 0) (> (length prefix) 0))
 785                               (or (not (eq mode 'word))
 786                                   (and first (> (length prefix) 0)
 787                                        (setq first nil
 788                                              prefix (substring prefix 0 1))))))
 789                   (goto-char (if (eq mode 'word) end
 790                                (or pt beg)))))
 791
 792             (if (and (eq mode 'word)
 793                      (not PC-word-failed-flag))
 794
 795                 (if improved
 796
 797                     ;; We changed it... would it be complete without the space?
 798                     (if (test-completion (buffer-substring
 799                                           (field-beginning) (1- end))
 800                                          table pred)
 801                         (delete-region (1- end) end)))
 802
 803               (if improved
 804
 805                   ;; We changed it... enough to be complete?
 806                   (and (eq mode 'exit)
 807                        (test-completion-ignore-case (field-string) table pred))
 808
 809                 ;; If totally ambiguous, display a list of completions
 810                 (if (or (eq completion-auto-help t)
 811                         (and completion-auto-help
 812                              (eq last-command this-command))
 813                         (eq mode 'help))
 814                     (let ((prompt-end (minibuffer-prompt-end)))
 815                       (with-output-to-temp-buffer "*Completions*"
 816                         (display-completion-list (sort helpposs 'string-lessp))
 817                         (setq PC-do-completion-end end
 818                               PC-goto-end goto-end)
 819                         (with-current-buffer standard-output
 820                           ;; Record which part of the buffer we are completing
 821                           ;; so that choosing a completion from the list
 822                           ;; knows how much old text to replace.
 823                           ;; This was briefly nil in the non-dirname case.
 824                           ;; However, if one calls PC-lisp-complete-symbol
 825                           ;; on "(ne-f" with point on the hyphen, PC offers
 826                           ;; all completions starting with "(ne", some of
 827                           ;; which do not match the "-f" part (maybe it
 828                           ;; should not, but it does). In such cases,
 829                           ;; completion gets confused trying to figure out
 830                           ;; how much to replace, so we tell it explicitly
 831                           ;; (ie, the number of chars in the buffer before beg).
 832                           ;;
 833                           ;; Note that choose-completion-string-functions
 834                           ;; plays around with point.
 835                           (setq completion-base-size (if dirname
 836                                                          dirlength
 837                                                        (- beg prompt-end))))))
 838                              (PC-temp-minibuffer-message " [Next char not unique]"))
 839                          ;; Expansion of filenames is not reversible,
 840                          ;; so just keep the prefix.
 841            (when (and abbreviated filename)
 842              (delete-region (point) end))
 843                          nil)))))
 844
 845        ;; Only one possible completion
 846        (t
 847         (if (and (equal basestr (car poss))
 848                  (not (and env-on filename))
 849                  (not abbreviated))
 850             (if (null mode)
 851                 (PC-temp-minibuffer-message " [Sole completion]"))
 852           (delete-region beg end)
 853           (insert (format "%s"
 854                           (if filename
 855                               (substitute-in-file-name (concat dirname (car poss)))
 856                             (car poss)))))
 857         t)))))
 858
 859 (defun PC-chop-word (new old)
 860   (let ((i -1)
 861         (j -1))
 862     (while (and (setq i (string-match PC-delim-regex old (1+ i)))
 863                 (setq j (string-match PC-delim-regex new (1+ j)))))
 864     (if (and j
 865              (or (not PC-word-failed-flag)
 866                  (setq j (string-match PC-delim-regex new (1+ j)))))
 867         (substring new 0 (1+ j))
 868       new)))
 869
 870 (defvar PC-not-minibuffer nil)
 871
 872 (defun PC-temp-minibuffer-message (message)
 873   "A Lisp version of `temp_minibuffer_message' from minibuf.c."
 874   (cond (PC-not-minibuffer
 875          (message "%s" message)
 876          (sit-for 2)
 877          (message ""))
 878         ((fboundp 'temp-minibuffer-message)
 879          (temp-minibuffer-message message))
 880         (t
 881          (let ((point-max (point-max)))
 882            (save-excursion
 883              (goto-char point-max)
 884              (insert message))
 885            (let ((inhibit-quit t))
 886              (sit-for 2)
 887              (delete-region point-max (point-max))
 888              (when quit-flag
 889                (setq quit-flag nil
 890                      unread-command-events '(7))))))))
 891
 892 ;; Does not need to be buffer-local (?) because only used when one
 893 ;; PC-l-c-s immediately follows another.
 894 (defvar PC-lisp-complete-end nil
 895   "Internal variable used by `PC-lisp-complete-symbol'.")
 896
 897 (defun PC-lisp-complete-symbol ()
 898   "Perform completion on Lisp symbol preceding point.
 899 That symbol is compared against the symbols that exist
 900 and any additional characters determined by what is there
 901 are inserted.
 902 If the symbol starts just after an open-parenthesis,
 903 only symbols with function definitions are considered.
 904 Otherwise, all symbols with function definitions, values
 905 or properties are considered."
 906   (interactive)
 907   (let* ((end
 908           (save-excursion
 909             (with-syntax-table lisp-mode-syntax-table
 910               (skip-syntax-forward "_w")
 911               (point))))
 912          (beg (save-excursion
 913                 (with-syntax-table lisp-mode-syntax-table
 914                   (backward-sexp 1)
 915                   (while (= (char-syntax (following-char)) ?\')
 916                     (forward-char 1))
 917                   (point))))
 918          (minibuffer-completion-table obarray)
 919          (minibuffer-completion-predicate
 920           (if (eq (char-after (1- beg)) ?\()
 921               'fboundp
 922             (function (lambda (sym)
 923                         (or (boundp sym) (fboundp sym)
 924                             (symbol-plist sym))))))
 925          (PC-not-minibuffer t))
 926     ;; http://lists.gnu.org/archive/html/emacs-devel/2007-03/msg01211.html
 927     ;;
 928     ;; This deals with cases like running PC-l-c-s on "M-: (n-f".
 929     ;; The first call to PC-l-c-s expands this to "(ne-f", and moves
 930     ;; point to the hyphen [1]. If one calls PC-l-c-s immediately after,
 931     ;; then without the last-command check, one is offered all
 932     ;; completions of "(ne", which is presumably not what one wants.
 933     ;;
 934     ;; This is arguably (at least, it seems to be the existing intended
 935     ;; behavior) what one _does_ want if point has been explicitly
 936     ;; positioned on the hyphen. Note that if PC-do-completion (qv) binds
 937     ;; completion-base-size to nil, then completion does not replace the
 938     ;; correct amount of text in such cases.
 939     ;;
 940     ;; Neither of these problems occur when using PC for filenames in the
 941     ;; minibuffer, because in that case PC-do-completion is called without
 942     ;; an explicit value for END, and so uses (point-max). This is fine for
 943     ;; a filename, because the end of the filename must be at the end of
 944     ;; the minibuffer. The same is not true for lisp symbols.
 945     ;;
 946     ;; [1] An alternate fix would be to not move point to the hyphen
 947     ;; in such cases, but that would make the behavior different from
 948     ;; that for filenames. It seems PC moves point to the site of the
 949     ;; first difference between the possible completions.
 950     ;;
 951     ;; Alternatively alternatively, maybe end should be computed in
 952     ;; the same way as beg. That would change the behavior though.
 953     (if (equal last-command 'PC-lisp-complete-symbol)
 954         (PC-do-completion nil beg PC-lisp-complete-end t)
 955       (if PC-lisp-complete-end
 956           (move-marker PC-lisp-complete-end end)
 957         (setq PC-lisp-complete-end (copy-marker end t)))
 958       (PC-do-completion nil beg end t))))
 959
 960 (defun PC-complete-as-file-name ()
 961    "Perform completion on file names preceding point.
 962  Environment vars are converted to their values."
 963    (interactive)
 964    (let* ((end (point))
 965           (beg (if (re-search-backward "[^\\][ \t\n\"\`\'][^ \t\n\"\`\']"
 966                                        (point-min) t)
 967                    (+ (point) 2)
 968                    (point-min)))
 969           (minibuffer-completion-table 'PC-read-file-name-internal)
 970           (minibuffer-completion-predicate nil)
 971           (PC-not-minibuffer t))
 972      (goto-char end)
 973      (PC-do-completion nil beg end)))
 974
 975 ;; Facilities for loading C header files.  This is independent from the
 976 ;; main completion code.  See also the variable `PC-include-file-path'
 977 ;; at top of this file.
 978
 979 (defun PC-look-for-include-file ()
 980   (if (string-match "[\"<]\\([^\"<>]*\\)[\">]?$" (buffer-file-name))
 981       (let ((name (substring (buffer-file-name)
 982                              (match-beginning 1) (match-end 1)))
 983             (punc (aref (buffer-file-name) (match-beginning 0)))
 984             (path nil)
 985             new-buf)
 986         (kill-buffer (current-buffer))
 987         (if (equal name "")
 988             (with-current-buffer (car (buffer-list))
 989               (save-excursion
 990                 (beginning-of-line)
 991                 (if (looking-at
 992                      "[ \t]*#[ \t]*include[ \t]+[<\"]\\(.+\\)[>\"][ \t]*[\n/]")
 993                     (setq name (buffer-substring (match-beginning 1)
 994                                                  (match-end 1))
 995                           punc (char-after (1- (match-beginning 1))))
 996                   ;; Suggested by Frank Siebenlist:
 997                   (if (or (looking-at
 998                            "[ \t]*([ \t]*load[ \t]+\"\\([^\"]+\\)\"")
 999                           (looking-at
1000                            "[ \t]*([ \t]*load-library[ \t]+\"\\([^\"]+\\)\"")
1001                           (looking-at
1002                            "[ \t]*([ \t]*require[ \t]+'\\([^\t )]+\\)[\t )]"))
1003                       (progn
1004                         (setq name (buffer-substring (match-beginning 1)
1005                                                      (match-end 1))
1006                               punc ?\<
1007                               path load-path)
1008                         (if (string-match "\\.elc$" name)
1009                             (setq name (substring name 0 -1))
1010                           (or (string-match "\\.el$" name)
1011                               (setq name (concat name ".el")))))
1012                     (error "Not on an #include line"))))))
1013         (or (string-match "\\.[[:alnum:]]+$" name)
1014             (setq name (concat name ".h")))
1015         (if (eq punc ?\<)
1016             (let ((path (or path (PC-include-file-path))))
1017               (while (and path
1018                           (not (file-exists-p
1019                                 (concat (file-name-as-directory (car path))
1020                                         name))))
1021                 (setq path (cdr path)))
1022               (if path
1023                   (setq name (concat (file-name-as-directory (car path)) name))
1024                 (error "No such include file: <%s>" name)))
1025           (let ((dir (with-current-buffer (car (buffer-list))
1026                        default-directory)))
1027             (if (file-exists-p (concat dir name))
1028                 (setq name (concat dir name))
1029               (error "No such include file: `%s'" name))))
1030         (setq new-buf (get-file-buffer name))
1031         (if new-buf
1032             ;; no need to verify last-modified time for this!
1033             (set-buffer new-buf)
1034           (set-buffer (create-file-buffer name))
1035           (erase-buffer)
1036           (insert-file-contents name t))
1037         ;; Returning non-nil with the new buffer current
1038         ;; is sufficient to tell find-file to use it.
1039         t)
1040     nil))
1041
1042 (defun PC-include-file-path ()
1043   (or PC-include-file-path
1044       (let ((env (getenv "INCPATH"))
1045             (path nil)
1046             pos)
1047         (or env (error "No include file path specified"))
1048         (while (setq pos (string-match ":[^:]+$" env))
1049           (setq path (cons (substring env (1+ pos)) path)
1050                 env (substring env 0 pos)))
1051         path)))
1052
1053 ;; This is adapted from lib-complete.el, by Mike Williams.
1054 (defun PC-include-file-all-completions (file search-path &optional full)
1055   "Return all completions for FILE in any directory on SEARCH-PATH.
1056 If optional third argument FULL is non-nil, returned pathnames should be
1057 absolute rather than relative to some directory on the SEARCH-PATH."
1058   (setq search-path
1059         (mapcar (lambda (dir)
1060                   (if dir (file-name-as-directory dir) default-directory))
1061                 search-path))
1062   (if (file-name-absolute-p file)
1063       ;; It's an absolute file name, so don't need search-path
1064       (progn
1065         (setq file (expand-file-name file))
1066         (file-name-all-completions
1067          (file-name-nondirectory file) (file-name-directory file)))
1068     (let ((subdir (file-name-directory file))
1069           (ndfile (file-name-nondirectory file))
1070           file-lists)
1071       ;; Append subdirectory part to each element of search-path
1072       (if subdir
1073           (setq search-path
1074                 (mapcar (lambda (dir) (concat dir subdir))
1075                         search-path)
1076                 file ))
1077       ;; Make list of completions in each directory on search-path
1078       (while search-path
1079         (let* ((dir (car search-path))
1080                (subdir (if full dir subdir)))
1081           (if (file-directory-p dir)
1082               (progn
1083                 (setq file-lists
1084                       (cons
1085                        (mapcar (lambda (file) (concat subdir file))
1086                                (file-name-all-completions ndfile
1087                                                           (car search-path)))
1088                        file-lists))))
1089           (setq search-path (cdr search-path))))
1090       ;; Compress out duplicates while building complete list (slloooow!)
1091       (let ((sorted (sort (apply 'nconc file-lists)
1092                           (lambda (x y) (not (string-lessp x y)))))
1093             compressed)
1094         (while sorted
1095           (if (equal (car sorted) (car compressed)) nil
1096             (setq compressed (cons (car sorted) compressed)))
1097           (setq sorted (cdr sorted)))
1098         compressed))))
1099
1100 (defun PC-read-file-name-internal (string pred action)
1101   "Extend `read-file-name-internal' to handle include files.
1102 This is only used by "
1103   (if (string-match "<\\([^\"<>]*\\)>?\\'" string)
1104       (let* ((name (match-string 1 string))
1105              (str2 (substring string (match-beginning 0)))
1106              (completion-table
1107               (mapcar (lambda (x)
1108                         (format (if (string-match "/\\'" x) "<%s" "<%s>") x))
1109                       (PC-include-file-all-completions
1110                        name (PC-include-file-path)))))
1111         (cond
1112          ((not completion-table) nil)
1113          ((eq action 'lambda) (test-completion str2 completion-table nil))
1114          ((eq action nil) (PC-try-completion str2 completion-table nil))
1115          ((eq action t) (all-completions str2 completion-table nil))))
1116     (read-file-name-internal string pred action)))
1117 \f
1118
1119 (provide 'complete)
1120
1121 ;; arch-tag: fc7e2768-ff44-4e22-b579-4d825b968458
1122 ;;; complete.el ends here