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 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-char ? )
 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-only)
 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    (t
 341     (let ((flag (PC-do-completion 'exit)))
 342       (and flag
 343            (if (or (eq flag 'complete)
 344                    (not minibuffer-completion-confirm))
 345                (exit-minibuffer)
 346              (PC-temp-minibuffer-message " [Confirm]")))))))
 347
 348
 349 (defun PC-completion-help ()
 350   "Like `minibuffer-completion-help', but allows \"b--di\"-style abbreviations.
 351 See `PC-complete' for details."
 352   (interactive)
 353   (if (eq (PC-was-meta-key) PC-meta-flag)
 354       (minibuffer-completion-help)
 355     (PC-do-completion 'help)))
 356
 357 (defun PC-was-meta-key ()
 358   (or (/= (length (this-command-keys)) 1)
 359       (let ((key (aref (this-command-keys) 0)))
 360         (if (integerp key)
 361             (>= key 128)
 362           (not (null (memq 'meta (event-modifiers key))))))))
 363
 364
 365 (defvar PC-ignored-extensions 'empty-cache)
 366 (defvar PC-delims 'empty-cache)
 367 (defvar PC-ignored-regexp nil)
 368 (defvar PC-word-failed-flag nil)
 369 (defvar PC-delim-regex nil)
 370 (defvar PC-ndelims-regex nil)
 371 (defvar PC-delims-list nil)
 372
 373 (defvar PC-completion-as-file-name-predicate
 374   (lambda () minibuffer-completing-file-name)
 375   "A function testing whether a minibuffer completion now will work filename-style.
 376 The function takes no arguments, and typically looks at the value
 377 of `minibuffer-completion-table' and the minibuffer contents.")
 378
 379 ;; Returns the sequence of non-delimiter characters that follow regexp in string.
 380 (defun PC-chunk-after (string regexp)
 381   (if (not (string-match regexp string))
 382       (let ((message "String %s didn't match regexp %s"))
 383         (message message string regexp)
 384         (error message string regexp)))
 385   (let ((result (substring string (match-end 0))))
 386     ;; result may contain multiple chunks
 387     (if (string-match PC-delim-regex result)
 388         (setq result (substring result 0 (match-beginning 0))))
 389     result))
 390
 391 (defun test-completion-ignore-case (str table pred)
 392   "Like `test-completion', but ignores case when possible."
 393   ;; Binding completion-ignore-case to nil ensures, for compatibility with
 394   ;; standard completion, that the return value is exactly one of the
 395   ;; possibilities.  Do this binding only if pred is nil, out of paranoia;
 396   ;; perhaps it is safe even if pred is non-nil.
 397   (if pred
 398       (test-completion str table pred)
 399     (let ((completion-ignore-case nil))
 400       (test-completion str table pred))))
 401
 402 ;; The following function is an attempt to work around two problems:
 403
 404 ;; (1) When complete.el was written, (try-completion "" '(("") (""))) used to
 405 ;; return the value "".  With a change from 2002-07-07 it returns t which caused
 406 ;; `PC-lisp-complete-symbol' to fail with a "Wrong type argument: sequencep, t"
 407 ;; error.  `PC-try-completion' returns STRING in this case.
 408
 409 ;; (2) (try-completion "" '((""))) returned t before the above-mentioned change.
 410 ;; Since `PC-chop-word' operates on the return value of `try-completion' this
 411 ;; case might have provoked a similar error as in (1).  `PC-try-completion'
 412 ;; returns "" instead.  I don't know whether this is a real problem though.
 413
 414 ;; Since `PC-try-completion' is not a guaranteed to fix these bugs reliably, you
 415 ;; should try to look at the following discussions when you encounter problems:
 416 ;; - emacs-pretest-bug ("Partial Completion" starting 2007-02-23),
 417 ;; - emacs-devel ("[address-of-OP: Partial completion]" starting 2007-02-24),
 418 ;; - emacs-devel ("[address-of-OP: EVAL and mouse selection in *Completions*]"
 419 ;;   starting 2007-03-05).
 420 (defun PC-try-completion (string alist &optional predicate)
 421   "Like `try-completion' but return STRING instead of t."
 422   (let ((result (try-completion string alist predicate)))
 423     (if (eq result t) string result)))
 424
 425 ;; TODO document MODE magic...
 426 (defun PC-do-completion (&optional mode beg end goto-end)
 427   "Internal function to do the work of partial completion.
 428 Text to be completed lies between BEG and END.  Normally when
 429 replacing text in the minibuffer, this function replaces up to
 430 point-max (as is appropriate for completing a file name).  If
 431 GOTO-END is non-nil, however, it instead replaces up to END."
 432   (or beg (setq beg (minibuffer-prompt-end)))
 433   (or end (setq end (point-max)))
 434   (let* ((table (if (eq minibuffer-completion-table 'read-file-name-internal)
 435                     'PC-read-file-name-internal
 436                     minibuffer-completion-table))
 437          (pred minibuffer-completion-predicate)
 438          (filename (funcall PC-completion-as-file-name-predicate))
 439          (dirname nil) ; non-nil only if a filename is being completed
 440          ;; The following used to be "(dirlength 0)" which caused the erasure of
 441          ;; the entire buffer text before `point' when inserting a completion
 442          ;; into a buffer.
 443          dirlength
 444          (str (buffer-substring beg end))
 445          (incname (and filename (string-match "<\\([^\"<>]*\\)>?$" str)))
 446          (ambig nil)
 447          basestr origstr
 448          env-on
 449          regex
 450          p offset
 451          abbreviated
 452          (poss nil)
 453          helpposs
 454          (case-fold-search completion-ignore-case))
 455
 456     ;; Check if buffer contents can already be considered complete
 457     (if (and (eq mode 'exit)
 458              (test-completion str table pred))
 459         (progn
 460           ;; If completion-ignore-case is non-nil, insert the
 461           ;; completion string since that may have a different case.
 462           (when completion-ignore-case
 463             (setq str (PC-try-completion str table pred))
 464             (delete-region beg end)
 465             (insert str))
 466           'complete)
 467
 468       ;; Do substitutions in directory names
 469       (and filename
 470            (setq basestr (or (file-name-directory str) ""))
 471            (setq dirlength (length basestr))
 472            ;; Do substitutions in directory names
 473            (setq p (substitute-in-file-name basestr))
 474            (not (string-equal basestr p))
 475            (setq str (concat p (file-name-nondirectory str)))
 476            (progn
 477              (delete-region beg end)
 478              (insert str)
 479              (setq end (+ beg (length str)))))
 480
 481       ;; Prepare various delimiter strings
 482       (or (equal PC-word-delimiters PC-delims)
 483           (setq PC-delims PC-word-delimiters
 484                 PC-delim-regex (concat "[" PC-delims "]")
 485                 PC-ndelims-regex (concat "[^" PC-delims "]*")
 486                 PC-delims-list (append PC-delims nil)))
 487
 488       ;; Add wildcards if necessary
 489       (and filename
 490            (let ((dir (file-name-directory str))
 491                  (file (file-name-nondirectory str))
 492                  ;; The base dir for file-completion was passed in `predicate'.
 493                  (default-directory (if (stringp pred) (expand-file-name pred)
 494                                       default-directory)))
 495              (while (and (stringp dir) (not (file-directory-p dir)))
 496                (setq dir (directory-file-name dir))
 497                (setq file (concat (replace-regexp-in-string
 498                                    PC-delim-regex "*\\&"
 499                                    (file-name-nondirectory dir))
 500                                   "*/" file))
 501                (setq dir (file-name-directory dir)))
 502              (setq origstr str str (concat dir file))))
 503
 504       ;; Look for wildcard expansions in directory name
 505       (and filename
 506            (string-match "\\*.*/" str)
 507            (let ((pat str)
 508                  ;; The base dir for file-completion was passed in `predicate'.
 509                  (default-directory (if (stringp pred) (expand-file-name pred)
 510                                       default-directory))
 511                  files)
 512              (setq p (1+ (string-match "/[^/]*\\'" pat)))
 513              (while (setq p (string-match PC-delim-regex pat p))
 514                (setq pat (concat (substring pat 0 p)
 515                                  "*"
 516                                  (substring pat p))
 517                      p (+ p 2)))
 518              (setq files (file-expand-wildcards (concat pat "*")))
 519              (if files
 520                  (let ((dir (file-name-directory (car files)))
 521                        (p files))
 522                    (while (and (setq p (cdr p))
 523                                (equal dir (file-name-directory (car p)))))
 524                    (if p
 525                        (setq filename nil table nil
 526                              pred (if (stringp pred) nil pred)
 527                              ambig t)
 528                      (delete-region beg end)
 529                      (setq str (concat dir (file-name-nondirectory str)))
 530                      (insert str)
 531                      (setq end (+ beg (length str)))))
 532                (if origstr
 533                        ;; If the wildcards were introduced by us, it's
 534                        ;; possible that PC-read-file-name-internal can
 535                        ;; still find matches for the original string
 536                        ;; even if we couldn't, so remove the added
 537                        ;; wildcards.
 538                    (setq str origstr)
 539                  (setq filename nil table nil
 540                        pred (if (stringp pred) nil pred))))))
 541
 542       ;; Strip directory name if appropriate
 543       (if filename
 544           (if incname
 545               (setq basestr (substring str incname)
 546                     dirname (substring str 0 incname))
 547             (setq basestr (file-name-nondirectory str)
 548                   dirname (file-name-directory str))
 549             ;; Make sure str is consistent with its directory and basename
 550             ;; parts.  This is important on DOZe'NT systems when str only
 551             ;; includes a drive letter, like in "d:".
 552             (setq str (concat dirname basestr)))
 553         (setq basestr str))
 554
 555       ;; Convert search pattern to a standard regular expression
 556       (setq regex (regexp-quote basestr)
 557             offset (if (and (> (length regex) 0)
 558                             (not (eq (aref basestr 0) ?\*))
 559                             (or (eq PC-first-char t)
 560                                 (and PC-first-char filename))) 1 0)
 561             p offset)
 562       (while (setq p (string-match PC-delim-regex regex p))
 563         (if (eq (aref regex p) ? )
 564             (setq regex (concat (substring regex 0 p)
 565                                 PC-ndelims-regex
 566                                 PC-delim-regex
 567                                 (substring regex (1+ p)))
 568                   p (+ p (length PC-ndelims-regex) (length PC-delim-regex)))
 569           (let ((bump (if (memq (aref regex p)
 570                                 '(?$ ?^ ?\. ?* ?+ ?? ?[ ?] ?\\))
 571                           -1 0)))
 572             (setq regex (concat (substring regex 0 (+ p bump))
 573                                 PC-ndelims-regex
 574                                 (substring regex (+ p bump)))
 575                   p (+ p (length PC-ndelims-regex) 1)))))
 576       (setq p 0)
 577       (if filename
 578           (while (setq p (string-match "\\\\\\*" regex p))
 579             (setq regex (concat (substring regex 0 p)
 580                                 "[^/]*"
 581                                 (substring regex (+ p 2))))))
 582       ;;(setq the-regex regex)
 583       (setq regex (concat "\\`" regex))
 584
 585       (and (> (length basestr) 0)
 586            (= (aref basestr 0) ?$)
 587            (setq env-on t
 588                  table PC-env-vars-alist
 589                  pred nil))
 590
 591       ;; Find an initial list of possible completions
 592         (unless (setq p (string-match (concat PC-delim-regex
 593                                              (if filename "\\|\\*" ""))
 594                                      str
 595                                       (+ (length dirname) offset)))
 596
 597           ;; Minibuffer contains no hyphens -- simple case!
 598           (setq poss (all-completions (if env-on basestr str)
 599                                       table
 600                                       pred))
 601           (unless (or poss (string-equal str ""))
 602             ;; Try completion as an abbreviation, e.g. "mvb" ->
 603             ;; "m-v-b" -> "multiple-value-bind", but only for
 604             ;; non-empty strings.
 605             (setq origstr str
 606                   abbreviated t)
 607             (if filename
 608                 (cond
 609                   ;; "alpha" or "/alpha" -> expand whole path.
 610                   ((string-match "^/?\\([A-Za-z0-9]+\\)$" str)
 611                    (setq
 612                     basestr ""
 613                     p nil
 614                     poss (file-expand-wildcards
 615                           (concat "/"
 616                                   (mapconcat #'list (match-string 1 str) "*/")
 617                                   "*"))
 618                     beg (1- beg)))
 619                   ;; Alphanumeric trailer -> expand trailing file
 620                   ((string-match "^\\(.+/\\)\\([A-Za-z0-9]+\\)$" str)
 621                    (setq regex (concat "\\`"
 622                                         (mapconcat #'list
 623                                                    (match-string 2 str)
 624                                                    "[A-Za-z0-9]*[^A-Za-z0-9]"))
 625                           p (1+ (length (match-string 1 str))))))
 626               (setq regex (concat "\\`" (mapconcat (lambda (c)
 627                                                      (regexp-quote (string c)))
 628                                                    str "[^-]*-"))
 629                     p 1))))
 630         (when p
 631         ;; Use all-completions to do an initial cull.  This is a big win,
 632         ;; since all-completions is written in C!
 633         (let ((compl (all-completions (if env-on
 634                                           (file-name-nondirectory (substring str 0 p))
 635                                         (substring str 0 p))
 636                                       table
 637                                       pred)))
 638           (setq p compl)
 639             (when (and compl abbreviated)
 640               (if filename
 641                   (progn
 642                     (setq p nil)
 643                     (dolist (x compl)
 644                       (when (string-match regex x)
 645                         (push x p)))
 646                     (setq basestr (try-completion "" p)))
 647                   (setq basestr (mapconcat 'list str "-"))
 648                   (delete-region beg end)
 649                   (setq end (+ beg (length basestr)))
 650                   (insert basestr))))
 651           (while p
 652             (and (string-match regex (car p))
 653                  (progn
 654                    (set-text-properties 0 (length (car p)) '() (car p))
 655                    (setq poss (cons (car p) poss))))
 656             (setq p (cdr p))))
 657
 658       ;; If table had duplicates, they can be here.
 659       (delete-dups poss)
 660
 661       ;; Handle completion-ignored-extensions
 662       (and filename
 663            (not (eq mode 'help))
 664            (let ((p2 poss))
 665
 666              ;; Build a regular expression representing the extensions list
 667              (or (equal completion-ignored-extensions PC-ignored-extensions)
 668                  (setq PC-ignored-regexp
 669                        (concat "\\("
 670                                (mapconcat
 671                                 'regexp-quote
 672                                 (setq PC-ignored-extensions
 673                                       completion-ignored-extensions)
 674                                 "\\|")
 675                                "\\)\\'")))
 676
 677              ;; Check if there are any without an ignored extension.
 678              ;; Also ignore `.' and `..'.
 679              (setq p nil)
 680              (while p2
 681                (or (string-match PC-ignored-regexp (car p2))
 682                    (string-match "\\(\\`\\|/\\)[.][.]?/?\\'" (car p2))
 683                    (setq p (cons (car p2) p)))
 684                (setq p2 (cdr p2)))
 685
 686              ;; If there are "good" names, use them
 687              (and p (setq poss p))))
 688
 689       ;; Now we have a list of possible completions
 690
 691       (cond
 692
 693        ;; No valid completions found
 694        ((null poss)
 695         (if (and (eq mode 'word)
 696                  (not PC-word-failed-flag))
 697             (let ((PC-word-failed-flag t))
 698               (delete-backward-char 1)
 699               (PC-do-completion 'word))
 700                (when abbreviated
 701                  (delete-region beg end)
 702                  (insert origstr))
 703           (beep)
 704           (PC-temp-minibuffer-message (if ambig
 705                                           " [Ambiguous dir name]"
 706                                         (if (eq mode 'help)
 707                                             " [No completions]"
 708                                           " [No match]")))
 709           nil))
 710
 711        ;; More than one valid completion found
 712        ((or (cdr (setq helpposs poss))
 713             (memq mode '(help word)))
 714
 715         ;; Is the actual string one of the possible completions?
 716         (setq p (and (not (eq mode 'help)) poss))
 717         (while (and p
 718                     (not (string-equal (car p) basestr)))
 719           (setq p (cdr p)))
 720         (and p (null mode)
 721              (PC-temp-minibuffer-message " [Complete, but not unique]"))
 722         (if (and p
 723                  (not (and (null mode)
 724                            (eq this-command last-command))))
 725             t
 726
 727           ;; If ambiguous, try for a partial completion
 728           (let ((improved nil)
 729                 prefix
 730                 (pt nil)
 731                 (skip "\\`"))
 732
 733             ;; Check if next few letters are the same in all cases
 734             (if (and (not (eq mode 'help))
 735                      (setq prefix (PC-try-completion
 736                                    (PC-chunk-after basestr skip) poss)))
 737                 (let ((first t) i)
 738                   ;; Retain capitalization of user input even if
 739                   ;; completion-ignore-case is set.
 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                                            (eq (downcase (aref prefix i))
 748                                                (downcase (following-char))))
 749                                       ;; same char (modulo case); no action
 750                                       (forward-char 1)
 751                                     (if (and (< (point) end)
 752                                              (and (looking-at " ")
 753                                                   (memq (aref prefix i)
 754                                                         PC-delims-list)))
 755                                         ;; replace " " by the actual delimiter
 756                                         (progn
 757                                           (delete-char 1)
 758                                           (insert (substring prefix i (1+ i))))
 759                                       ;; insert a new character
 760                                       (progn
 761                                         (and filename (looking-at "\\*")
 762                                              (progn
 763                                                (delete-char 1)
 764                                                (setq end (1- end))))
 765                                         (setq improved t)
 766                                         (insert (substring prefix i (1+ i)))
 767                                         (setq end (1+ end)))))
 768                                   (setq i (1+ i)))
 769                                 (or pt (setq pt (point)))
 770                                 (looking-at PC-delim-regex))
 771                               (setq skip (concat skip
 772                                                  (regexp-quote prefix)
 773                                                  PC-ndelims-regex)
 774                                     prefix (PC-try-completion
 775                                             (PC-chunk-after
 776                                              ;; not basestr, because that does
 777                                              ;; not reflect insertions
 778                                              (buffer-substring
 779                                               (+ beg (length dirname)) end)
 780                                              skip)
 781                                             (mapcar
 782                                              (lambda (x)
 783                                                (when (string-match skip x)
 784                                                  (substring x (match-end 0))))
 785                                              poss)))
 786                               (or (> i 0) (> (length prefix) 0))
 787                               (or (not (eq mode 'word))
 788                                   (and first (> (length prefix) 0)
 789                                        (setq first nil
 790                                              prefix (substring prefix 0 1))))))
 791                   (goto-char (if (eq mode 'word) end
 792                                (or pt beg)))))
 793
 794             (if (and (eq mode 'word)
 795                      (not PC-word-failed-flag))
 796
 797                 (if improved
 798
 799                     ;; We changed it... would it be complete without the space?
 800                     (if (test-completion (buffer-substring 1 (1- end))
 801                                          table pred)
 802                         (delete-region (1- end) end)))
 803
 804               (if improved
 805
 806                   ;; We changed it... enough to be complete?
 807                   (and (eq mode 'exit)
 808                        (test-completion-ignore-case (field-string) table pred))
 809
 810                 ;; If totally ambiguous, display a list of completions
 811                 (if (or (eq completion-auto-help t)
 812                         (and completion-auto-help
 813                              (eq last-command this-command))
 814                         (eq mode 'help))
 815                     (let ((prompt-end (minibuffer-prompt-end)))
 816                       (with-output-to-temp-buffer "*Completions*"
 817                         (display-completion-list (sort helpposs 'string-lessp))
 818                         (setq PC-do-completion-end end
 819                               PC-goto-end goto-end)
 820                         (with-current-buffer standard-output
 821                           ;; Record which part of the buffer we are completing
 822                           ;; so that choosing a completion from the list
 823                           ;; knows how much old text to replace.
 824                           ;; This was briefly nil in the non-dirname case.
 825                           ;; However, if one calls PC-lisp-complete-symbol
 826                           ;; on "(ne-f" with point on the hyphen, PC offers
 827                           ;; all completions starting with "(ne", some of
 828                           ;; which do not match the "-f" part (maybe it
 829                           ;; should not, but it does). In such cases,
 830                           ;; completion gets confused trying to figure out
 831                           ;; how much to replace, so we tell it explicitly
 832                           ;; (ie, the number of chars in the buffer before beg).
 833                           ;;
 834                           ;; Note that choose-completion-string-functions
 835                           ;; plays around with point.
 836                           (setq completion-base-size (if dirname
 837                                                          dirlength
 838                                                        (- beg prompt-end))))))
 839                              (PC-temp-minibuffer-message " [Next char not unique]"))
 840                          ;; Expansion of filenames is not reversible,
 841                          ;; so just keep the prefix.
 842            (when (and abbreviated filename)
 843              (delete-region (point) end))
 844                          nil)))))
 845
 846        ;; Only one possible completion
 847        (t
 848         (if (and (equal basestr (car poss))
 849                  (not (and env-on filename))
 850                  (not abbreviated))
 851             (if (null mode)
 852                 (PC-temp-minibuffer-message " [Sole completion]"))
 853           (delete-region beg end)
 854           (insert (format "%s"
 855                           (if filename
 856                               (substitute-in-file-name (concat dirname (car poss)))
 857                             (car poss)))))
 858         t)))))
 859
 860 (defun PC-chop-word (new old)
 861   (let ((i -1)
 862         (j -1))
 863     (while (and (setq i (string-match PC-delim-regex old (1+ i)))
 864                 (setq j (string-match PC-delim-regex new (1+ j)))))
 865     (if (and j
 866              (or (not PC-word-failed-flag)
 867                  (setq j (string-match PC-delim-regex new (1+ j)))))
 868         (substring new 0 (1+ j))
 869       new)))
 870
 871 (defvar PC-not-minibuffer nil)
 872
 873 (defun PC-temp-minibuffer-message (message)
 874   "A Lisp version of `temp_minibuffer_message' from minibuf.c."
 875   (cond (PC-not-minibuffer
 876          (message "%s" message)
 877          (sit-for 2)
 878          (message ""))
 879         ((fboundp 'temp-minibuffer-message)
 880          (temp-minibuffer-message message))
 881         (t
 882          (let ((point-max (point-max)))
 883            (save-excursion
 884              (goto-char point-max)
 885              (insert message))
 886            (let ((inhibit-quit t))
 887              (sit-for 2)
 888              (delete-region point-max (point-max))
 889              (when quit-flag
 890                (setq quit-flag nil
 891                      unread-command-events '(7))))))))
 892
 893 ;; Does not need to be buffer-local (?) because only used when one
 894 ;; PC-l-c-s immediately follows another.
 895 (defvar PC-lisp-complete-end nil
 896   "Internal variable used by `PC-lisp-complete-symbol'.")
 897
 898 (defun PC-lisp-complete-symbol ()
 899   "Perform completion on Lisp symbol preceding point.
 900 That symbol is compared against the symbols that exist
 901 and any additional characters determined by what is there
 902 are inserted.
 903 If the symbol starts just after an open-parenthesis,
 904 only symbols with function definitions are considered.
 905 Otherwise, all symbols with function definitions, values
 906 or properties are considered."
 907   (interactive)
 908   (let* ((end
 909           (save-excursion
 910             (with-syntax-table lisp-mode-syntax-table
 911               (skip-syntax-forward "_w")
 912               (point))))
 913          (beg (save-excursion
 914                 (with-syntax-table lisp-mode-syntax-table
 915                   (backward-sexp 1)
 916                   (while (= (char-syntax (following-char)) ?\')
 917                     (forward-char 1))
 918                   (point))))
 919          (minibuffer-completion-table obarray)
 920          (minibuffer-completion-predicate
 921           (if (eq (char-after (1- beg)) ?\()
 922               'fboundp
 923             (function (lambda (sym)
 924                         (or (boundp sym) (fboundp sym)
 925                             (symbol-plist sym))))))
 926          (PC-not-minibuffer t))
 927     ;; http://lists.gnu.org/archive/html/emacs-devel/2007-03/msg01211.html
 928     ;;
 929     ;; This deals with cases like running PC-l-c-s on "M-: (n-f".
 930     ;; The first call to PC-l-c-s expands this to "(ne-f", and moves
 931     ;; point to the hyphen [1]. If one calls PC-l-c-s immediately after,
 932     ;; then without the last-command check, one is offered all
 933     ;; completions of "(ne", which is presumably not what one wants.
 934     ;;
 935     ;; This is arguably (at least, it seems to be the existing intended
 936     ;; behaviour) what one _does_ want if point has been explicitly
 937     ;; positioned on the hyphen. Note that if PC-do-completion (qv) binds
 938     ;; completion-base-size to nil, then completion does not replace the
 939     ;; correct amount of text in such cases.
 940     ;;
 941     ;; Neither of these problems occur when using PC for filenames in the
 942     ;; minibuffer, because in that case PC-do-completion is called without
 943     ;; an explicit value for END, and so uses (point-max). This is fine for
 944     ;; a filename, because the end of the filename must be at the end of
 945     ;; the minibuffer. The same is not true for lisp symbols.
 946     ;;
 947     ;; [1] An alternate fix would be to not move point to the hyphen
 948     ;; in such cases, but that would make the behaviour different from
 949     ;; that for filenames. It seems PC moves point to the site of the
 950     ;; first difference between the possible completions.
 951     ;;
 952     ;; Alternatively alternatively, maybe end should be computed in
 953     ;; the same way as beg. That would change the behaviour though.
 954     (if (equal last-command 'PC-lisp-complete-symbol)
 955         (PC-do-completion nil beg PC-lisp-complete-end t)
 956       (if PC-lisp-complete-end
 957           (move-marker PC-lisp-complete-end end)
 958         (setq PC-lisp-complete-end (copy-marker end t)))
 959       (PC-do-completion nil beg end t))))
 960
 961 (defun PC-complete-as-file-name ()
 962    "Perform completion on file names preceding point.
 963  Environment vars are converted to their values."
 964    (interactive)
 965    (let* ((end (point))
 966           (beg (if (re-search-backward "[^\\][ \t\n\"\`\'][^ \t\n\"\`\']"
 967                                        (point-min) t)
 968                    (+ (point) 2)
 969                    (point-min)))
 970           (minibuffer-completion-table 'PC-read-file-name-internal)
 971           (minibuffer-completion-predicate nil)
 972           (PC-not-minibuffer t))
 973      (goto-char end)
 974      (PC-do-completion nil beg end)))
 975
 976 ;; Facilities for loading C header files.  This is independent from the
 977 ;; main completion code.  See also the variable `PC-include-file-path'
 978 ;; at top of this file.
 979
 980 (defun PC-look-for-include-file ()
 981   (if (string-match "[\"<]\\([^\"<>]*\\)[\">]?$" (buffer-file-name))
 982       (let ((name (substring (buffer-file-name)
 983                              (match-beginning 1) (match-end 1)))
 984             (punc (aref (buffer-file-name) (match-beginning 0)))
 985             (path nil)
 986             new-buf)
 987         (kill-buffer (current-buffer))
 988         (if (equal name "")
 989             (with-current-buffer (car (buffer-list))
 990               (save-excursion
 991                 (beginning-of-line)
 992                 (if (looking-at
 993                      "[ \t]*#[ \t]*include[ \t]+[<\"]\\(.+\\)[>\"][ \t]*[\n/]")
 994                     (setq name (buffer-substring (match-beginning 1)
 995                                                  (match-end 1))
 996                           punc (char-after (1- (match-beginning 1))))
 997                   ;; Suggested by Frank Siebenlist:
 998                   (if (or (looking-at
 999                            "[ \t]*([ \t]*load[ \t]+\"\\([^\"]+\\)\"")
1000                           (looking-at
1001                            "[ \t]*([ \t]*load-library[ \t]+\"\\([^\"]+\\)\"")
1002                           (looking-at
1003                            "[ \t]*([ \t]*require[ \t]+'\\([^\t )]+\\)[\t )]"))
1004                       (progn
1005                         (setq name (buffer-substring (match-beginning 1)
1006                                                      (match-end 1))
1007                               punc ?\<
1008                               path load-path)
1009                         (if (string-match "\\.elc$" name)
1010                             (setq name (substring name 0 -1))
1011                           (or (string-match "\\.el$" name)
1012                               (setq name (concat name ".el")))))
1013                     (error "Not on an #include line"))))))
1014         (or (string-match "\\.[[:alnum:]]+$" name)
1015             (setq name (concat name ".h")))
1016         (if (eq punc ?\<)
1017             (let ((path (or path (PC-include-file-path))))
1018               (while (and path
1019                           (not (file-exists-p
1020                                 (concat (file-name-as-directory (car path))
1021                                         name))))
1022                 (setq path (cdr path)))
1023               (if path
1024                   (setq name (concat (file-name-as-directory (car path)) name))
1025                 (error "No such include file: <%s>" name)))
1026           (let ((dir (with-current-buffer (car (buffer-list))
1027                        default-directory)))
1028             (if (file-exists-p (concat dir name))
1029                 (setq name (concat dir name))
1030               (error "No such include file: `%s'" name))))
1031         (setq new-buf (get-file-buffer name))
1032         (if new-buf
1033             ;; no need to verify last-modified time for this!
1034             (set-buffer new-buf)
1035           (set-buffer (create-file-buffer name))
1036           (erase-buffer)
1037           (insert-file-contents name t))
1038         ;; Returning non-nil with the new buffer current
1039         ;; is sufficient to tell find-file to use it.
1040         t)
1041     nil))
1042
1043 (defun PC-include-file-path ()
1044   (or PC-include-file-path
1045       (let ((env (getenv "INCPATH"))
1046             (path nil)
1047             pos)
1048         (or env (error "No include file path specified"))
1049         (while (setq pos (string-match ":[^:]+$" env))
1050           (setq path (cons (substring env (1+ pos)) path)
1051                 env (substring env 0 pos)))
1052         path)))
1053
1054 ;; This is adapted from lib-complete.el, by Mike Williams.
1055 (defun PC-include-file-all-completions (file search-path &optional full)
1056   "Return all completions for FILE in any directory on SEARCH-PATH.
1057 If optional third argument FULL is non-nil, returned pathnames should be
1058 absolute rather than relative to some directory on the SEARCH-PATH."
1059   (setq search-path
1060         (mapcar (lambda (dir)
1061                   (if dir (file-name-as-directory dir) default-directory))
1062                 search-path))
1063   (if (file-name-absolute-p file)
1064       ;; It's an absolute file name, so don't need search-path
1065       (progn
1066         (setq file (expand-file-name file))
1067         (file-name-all-completions
1068          (file-name-nondirectory file) (file-name-directory file)))
1069     (let ((subdir (file-name-directory file))
1070           (ndfile (file-name-nondirectory file))
1071           file-lists)
1072       ;; Append subdirectory part to each element of search-path
1073       (if subdir
1074           (setq search-path
1075                 (mapcar (lambda (dir) (concat dir subdir))
1076                         search-path)
1077                 file ))
1078       ;; Make list of completions in each directory on search-path
1079       (while search-path
1080         (let* ((dir (car search-path))
1081                (subdir (if full dir subdir)))
1082           (if (file-directory-p dir)
1083               (progn
1084                 (setq file-lists
1085                       (cons
1086                        (mapcar (lambda (file) (concat subdir file))
1087                                (file-name-all-completions ndfile
1088                                                           (car search-path)))
1089                        file-lists))))
1090           (setq search-path (cdr search-path))))
1091       ;; Compress out duplicates while building complete list (slloooow!)
1092       (let ((sorted (sort (apply 'nconc file-lists)
1093                           (lambda (x y) (not (string-lessp x y)))))
1094             compressed)
1095         (while sorted
1096           (if (equal (car sorted) (car compressed)) nil
1097             (setq compressed (cons (car sorted) compressed)))
1098           (setq sorted (cdr sorted)))
1099         compressed))))
1100
1101 (defun PC-read-file-name-internal (string pred action)
1102   "Extend `read-file-name-internal' to handle include files.
1103 This is only used by "
1104   (if (string-match "<\\([^\"<>]*\\)>?\\'" string)
1105       (let* ((name (match-string 1 string))
1106              (str2 (substring string (match-beginning 0)))
1107              (completion-table
1108               (mapcar (lambda (x)
1109                         (format (if (string-match "/\\'" x) "<%s" "<%s>") x))
1110                       (PC-include-file-all-completions
1111                        name (PC-include-file-path)))))
1112         (cond
1113          ((not completion-table) nil)
1114          ((eq action 'lambda) (test-completion str2 completion-table nil))
1115          ((eq action nil) (PC-try-completion str2 completion-table nil))
1116          ((eq action t) (all-completions str2 completion-table nil))))
1117     (read-file-name-internal string pred action)))
1118 \f
1119
1120 (provide 'complete)
1121
1122 ;; arch-tag: fc7e2768-ff44-4e22-b579-4d825b968458
1123 ;;; complete.el ends here