complete.el 32.7 KB
Newer Older
Erik Naggum's avatar
Erik Naggum committed
1
;;; complete.el --- partial completion mechanism plus other goodies
Jim Blandy's avatar
Jim Blandy committed
2

3 4
;; Copyright (C) 1990, 1991, 1992, 1993, 1999, 2000, 2002, 2003, 2004,
;;   2005 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6

;; Author: Dave Gillespie <daveg@synaptics.com>
Dan Nicolaescu's avatar
Dan Nicolaescu committed
7
;; Keywords: abbrev convenience
Jim Blandy's avatar
Jim Blandy committed
8 9 10 11
;; Special thanks to Hallvard Furuseth for his many ideas and contributions.

;; This file is part of GNU Emacs.

12 13 14 15 16
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

Jim Blandy's avatar
Jim Blandy committed
17
;; GNU Emacs is distributed in the hope that it will be useful,
18 19 20
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
Jim Blandy's avatar
Jim Blandy committed
21

22
;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Jim Blandy's avatar
Jim Blandy committed
26

Richard M. Stallman's avatar
Richard M. Stallman committed
27
;;; Commentary:
Jim Blandy's avatar
Jim Blandy committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

;; Extended completion for the Emacs minibuffer.
;;
;; The basic idea is that the command name or other completable text is
;; divided into words and each word is completed separately, so that
;; "M-x p-b" expands to "M-x print-buffer".  If the entry is ambiguous
;; each word is completed as much as possible and then the cursor is
;; left at the first position where typing another letter will resolve
;; the ambiguity.
;;
;; Word separators for this purpose are hyphen, space, and period.
;; These would most likely occur in command names, Info menu items,
;; and file names, respectively.  But all word separators are treated
;; alike at all times.
;;
;; This completion package replaces the old-style completer's key
;; bindings for TAB, SPC, RET, and `?'.  The old completer is still
;; available on the Meta versions of those keys.  If you set
;; PC-meta-flag to nil, the old completion keys will be left alone
;; and the partial completer will use the Meta versions of the keys.


Richard M. Stallman's avatar
Richard M. Stallman committed
50
;; Usage:  M-x partial-completion-mode.  During completable minibuffer entry,
Jim Blandy's avatar
Jim Blandy committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64
;;
;;     TAB    means to do a partial completion;
;;     SPC    means to do a partial complete-word;
;;     RET    means to do a partial complete-and-exit;
;;     ?      means to do a partial completion-help.
;;
;; If you set PC-meta-flag to nil, then TAB, SPC, RET, and ? perform
;; original Emacs completions, and M-TAB etc. do partial completion.
;; To do this, put the command,
;;
;;       (setq PC-meta-flag nil)
;;
;; in your .emacs file.  To load partial completion automatically, put
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
65
;;       (partial-completion-mode t)
Jim Blandy's avatar
Jim Blandy committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
;;
;; in your .emacs file, too.  Things will be faster if you byte-compile
;; this file when you install it.
;;
;; As an extra feature, in cases where RET would not normally
;; complete (such as `C-x b'), the M-RET key will always do a partial
;; complete-and-exit.  Thus `C-x b f.c RET' will select or create a
;; buffer called "f.c", but `C-x b f.c M-RET' will select the existing
;; buffer whose name matches that pattern (perhaps "filing.c").
;; (PC-meta-flag does not affect this behavior; M-RET used to be
;; undefined in this situation.)
;;
;; The regular M-TAB (lisp-complete-symbol) command also supports
;; partial completion in this package.

;; In addition, this package includes a feature for accessing include
;; files.  For example, `C-x C-f <sys/time.h> RET' reads the file
;; /usr/include/sys/time.h.  The variable PC-include-file-path is a
;; list of directories in which to search for include files.  Completion
;; is supported in include file names.


Richard M. Stallman's avatar
Richard M. Stallman committed
88
;;; Code:
Jim Blandy's avatar
Jim Blandy committed
89

90 91 92
(defgroup partial-completion nil
  "Partial Completion of items."
  :prefix "pc-"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
93 94
  :group 'minibuffer
  :group 'convenience)
95 96 97 98 99 100 101 102 103 104 105

(defcustom PC-first-char 'find-file
  "*Control how the first character of a string is to be interpreted.
If nil, the first character of a string is not taken literally if it is a word
delimiter, so that \".e\" matches \"*.e*\".
If t, the first character of a string is always taken literally even if it is a
word delimiter, so that \".e\" matches \".e*\".
If non-nil and non-t, the first character is taken literally only for file name
completion."
  :type '(choice (const :tag "delimiter" nil)
		 (const :tag "literal" t)
106
		 (other :tag "find-file" find-file))
107 108 109 110 111 112 113 114 115 116 117 118 119 120
  :group 'partial-completion)

(defcustom PC-meta-flag t
  "*If non-nil, TAB means PC completion and M-TAB means normal completion.
Otherwise, TAB means normal completion and M-TAB means Partial Completion."
  :type 'boolean
  :group 'partial-completion)

(defcustom PC-word-delimiters "-_. "
  "*A string of characters treated as word delimiters for completion.
Some arcane rules:
If `]' is in this string, it must come first.
If `^' is in this string, it must not come first.
If `-' is in this string, it must come first or right after `]'.
121
In other words, if S is this string, then `[S]' must be a valid Emacs regular
122 123 124 125 126 127 128 129 130 131 132 133 134 135
expression (not containing character ranges like `a-z')."
  :type 'string
  :group 'partial-completion)

(defcustom PC-include-file-path '("/usr/include" "/usr/local/include")
  "*A list of directories in which to look for include files.
If nil, means use the colon-separated path in the variable $INCPATH instead."
  :type '(repeat directory)
  :group 'partial-completion)

(defcustom PC-disable-includes nil
  "*If non-nil, include-file support in \\[find-file] is disabled."
  :type 'boolean
  :group 'partial-completion)
Jim Blandy's avatar
Jim Blandy committed
136 137

(defvar PC-default-bindings t
138
  "If non-nil, default partial completion key bindings are suppressed.")
139 140 141 142

(defvar PC-env-vars-alist nil
  "A list of the environment variable names and values.")

143 144

(defvar PC-old-read-file-name-internal nil)
Jim Blandy's avatar
Jim Blandy committed
145

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
(defun PC-bindings (bind)
  (let ((completion-map minibuffer-local-completion-map)
	(must-match-map minibuffer-local-must-match-map))
    (cond ((not bind)
	   ;; These bindings are the default bindings.  It would be better to
	   ;; restore the previous bindings.
	   (define-key completion-map "\t"	'minibuffer-complete)
	   (define-key completion-map " "	'minibuffer-complete-word)
	   (define-key completion-map "?"	'minibuffer-completion-help)

	   (define-key must-match-map "\t"	'minibuffer-complete)
	   (define-key must-match-map " "	'minibuffer-complete-word)
	   (define-key must-match-map "\r"	'minibuffer-complete-and-exit)
	   (define-key must-match-map "\n"	'minibuffer-complete-and-exit)
	   (define-key must-match-map "?"	'minibuffer-completion-help)

	   (define-key global-map "\e\t"	'complete-symbol))
	  (PC-default-bindings
	   (define-key completion-map "\t"	'PC-complete)
	   (define-key completion-map " "	'PC-complete-word)
	   (define-key completion-map "?"	'PC-completion-help)

	   (define-key completion-map "\e\t"	'PC-complete)
	   (define-key completion-map "\e "	'PC-complete-word)
	   (define-key completion-map "\e\r"	'PC-force-complete-and-exit)
	   (define-key completion-map "\e\n"	'PC-force-complete-and-exit)
	   (define-key completion-map "\e?"	'PC-completion-help)

	   (define-key must-match-map "\t"	'PC-complete)
	   (define-key must-match-map " "	'PC-complete-word)
	   (define-key must-match-map "\r"	'PC-complete-and-exit)
	   (define-key must-match-map "\n"	'PC-complete-and-exit)
	   (define-key must-match-map "?"	'PC-completion-help)

	   (define-key must-match-map "\e\t"	'PC-complete)
	   (define-key must-match-map "\e "	'PC-complete-word)
	   (define-key must-match-map "\e\r"	'PC-complete-and-exit)
	   (define-key must-match-map "\e\n"	'PC-complete-and-exit)
	   (define-key must-match-map "\e?"	'PC-completion-help)

	   (define-key global-map "\e\t"	'PC-lisp-complete-symbol)))))

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
;;;###autoload
(define-minor-mode partial-completion-mode
  "Toggle Partial Completion mode.
With prefix ARG, turn Partial Completion mode on if ARG is positive.

When Partial Completion mode is enabled, TAB (or M-TAB if `PC-meta-flag' is
nil) is enhanced so that if some string is divided into words and each word is
delimited by a character in `PC-word-delimiters', partial words are completed
as much as possible and `*' characters are treated likewise in file names.

For example, M-x p-c-m expands to M-x partial-completion-mode since no other
command begins with that sequence of characters, and
\\[find-file] f_b.c TAB might complete to foo_bar.c if that file existed and no
other file in that directory begin with that sequence of characters.

203
Unless `PC-disable-includes' is non-nil, the `<...>' sequence is interpreted
204
specially in \\[find-file].  For example,
205
\\[find-file] <sys/time.h> RET finds the file `/usr/include/sys/time.h'.
206 207 208 209 210 211 212 213
See also the variable `PC-include-file-path'.

Partial Completion mode extends the meaning of `completion-auto-help' (which
see) so that if it is neither nil nor t, Emacs will show the  *Completions*
buffer only on the second attempt to complete.  I.e. if TAB finds nothing
to complete, the first TAB will just say \"Next char not unique\" without
bringing up the *Completions* buffer, and the second TAB will then bring up
the *Completions* buffer."
214
  :global t :group 'partial-completion
215 216 217 218
  ;; Deal with key bindings...
  (PC-bindings partial-completion-mode)
  ;; Deal with include file feature...
  (cond ((not partial-completion-mode)
219
	 (remove-hook 'find-file-not-found-functions 'PC-look-for-include-file))
220
	((not PC-disable-includes)
221
	 (add-hook 'find-file-not-found-functions 'PC-look-for-include-file)))
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
  ;; ... with some underhand redefining.
  (cond ((and (not partial-completion-mode)
	      (functionp PC-old-read-file-name-internal))
	 (fset 'read-file-name-internal PC-old-read-file-name-internal))
	((and (not PC-disable-includes) (not PC-old-read-file-name-internal))
	 (setq PC-old-read-file-name-internal
	       (symbol-function 'read-file-name-internal))
	 (fset 'read-file-name-internal
	       'PC-read-include-file-name-internal)))
    (when (and partial-completion-mode (null PC-env-vars-alist))
      (setq PC-env-vars-alist
	    (mapcar (lambda (string)
		      (let ((d (string-match "=" string)))
			(cons (concat "$" (substring string 0 d))
			      (and d (substring string (1+ d))))))
		    process-environment))))

239

Jim Blandy's avatar
Jim Blandy committed
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
(defun PC-complete ()
  "Like minibuffer-complete, but allows \"b--di\"-style abbreviations.
For example, \"M-x b--di\" would match `byte-recompile-directory', or any
name which consists of three or more words, the first beginning with \"b\"
and the third beginning with \"di\".

The pattern \"b--d\" is ambiguous for `byte-recompile-directory' and
`beginning-of-defun', so this would produce a list of completions
just like when normal Emacs completions are ambiguous.

Word-delimiters for the purposes of Partial Completion are \"-\", \"_\",
\".\", and SPC."
  (interactive)
  (if (PC-was-meta-key)
      (minibuffer-complete)
255 256 257 258 259 260 261 262 263
    ;; If the previous command was not this one,
    ;; never scroll, always retry completion.
    (or (eq last-command this-command)
	(setq minibuffer-scroll-window nil))
    (let ((window minibuffer-scroll-window))
      ;; If there's a fresh completion window with a live buffer,
      ;; and this command is repeated, scroll that window.
      (if (and window (window-buffer window)
	       (buffer-name (window-buffer window)))
264
	  (with-current-buffer (window-buffer window)
265 266 267 268
	    (if (pos-visible-in-window-p (point-max) window)
		(set-window-start window (point-min) nil)
	      (scroll-other-window)))
	(PC-do-completion nil)))))
Jim Blandy's avatar
Jim Blandy committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312


(defun PC-complete-word ()
  "Like `minibuffer-complete-word', but allows \"b--di\"-style abbreviations.
See `PC-complete' for details.
This can be bound to other keys, like `-' and `.', if you wish."
  (interactive)
  (if (eq (PC-was-meta-key) PC-meta-flag)
      (if (eq last-command-char ? )
	  (minibuffer-complete-word)
	(self-insert-command 1))
    (self-insert-command 1)
    (if (eobp)
	(PC-do-completion 'word))))


(defun PC-complete-space ()
  "Like `minibuffer-complete-word', but allows \"b--di\"-style abbreviations.
See `PC-complete' for details.
This is suitable for binding to other keys which should act just like SPC."
  (interactive)
  (if (eq (PC-was-meta-key) PC-meta-flag)
      (minibuffer-complete-word)
    (insert " ")
    (if (eobp)
	(PC-do-completion 'word))))


(defun PC-complete-and-exit ()
  "Like `minibuffer-complete-and-exit', but allows \"b--di\"-style abbreviations.
See `PC-complete' for details."
  (interactive)
  (if (eq (PC-was-meta-key) PC-meta-flag)
      (minibuffer-complete-and-exit)
    (PC-do-complete-and-exit)))

(defun PC-force-complete-and-exit ()
  "Like `minibuffer-complete-and-exit', but allows \"b--di\"-style abbreviations.
See `PC-complete' for details."
  (interactive)
  (let ((minibuffer-completion-confirm nil))
    (PC-do-complete-and-exit)))

(defun PC-do-complete-and-exit ()
313
  (if (= (point-max) (minibuffer-prompt-end))  ; Duplicate the "bug" that Info-menu relies on...
Jim Blandy's avatar
Jim Blandy committed
314 315 316 317 318 319
      (exit-minibuffer)
    (let ((flag (PC-do-completion 'exit)))
      (and flag
	   (if (or (eq flag 'complete)
		   (not minibuffer-completion-confirm))
	       (exit-minibuffer)
320
	     (PC-temp-minibuffer-message " [Confirm]"))))))
Jim Blandy's avatar
Jim Blandy committed
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346


(defun PC-completion-help ()
  "Like `minibuffer-completion-help', but allows \"b--di\"-style abbreviations.
See `PC-complete' for details."
  (interactive)
  (if (eq (PC-was-meta-key) PC-meta-flag)
      (minibuffer-completion-help)
    (PC-do-completion 'help)))

(defun PC-was-meta-key ()
  (or (/= (length (this-command-keys)) 1)
      (let ((key (aref (this-command-keys) 0)))
	(if (integerp key)
	    (>= key 128)
	  (not (null (memq 'meta (event-modifiers key))))))))


(defvar PC-ignored-extensions 'empty-cache)
(defvar PC-delims 'empty-cache)
(defvar PC-ignored-regexp nil)
(defvar PC-word-failed-flag nil)
(defvar PC-delim-regex nil)
(defvar PC-ndelims-regex nil)
(defvar PC-delims-list nil)

347
(defvar PC-completion-as-file-name-predicate
348 349
  (lambda () minibuffer-completing-file-name)
  "A function testing whether a minibuffer completion now will work filename-style.
350 351
The function takes no arguments, and typically looks at the value
of `minibuffer-completion-table' and the minibuffer contents.")
352

Jim Blandy's avatar
Jim Blandy committed
353
(defun PC-do-completion (&optional mode beg end)
354
  (or beg (setq beg (minibuffer-prompt-end)))
Jim Blandy's avatar
Jim Blandy committed
355 356 357
  (or end (setq end (point-max)))
  (let* ((table minibuffer-completion-table)
	 (pred minibuffer-completion-predicate)
358
	 (filename (funcall PC-completion-as-file-name-predicate))
Jim Blandy's avatar
Jim Blandy committed
359
	 (dirname nil)
360
	 (dirlength 0)
Jim Blandy's avatar
Jim Blandy committed
361 362 363 364
	 (str (buffer-substring beg end))
	 (incname (and filename (string-match "<\\([^\"<>]*\\)>?$" str)))
	 (ambig nil)
	 basestr
365
	 env-on
Jim Blandy's avatar
Jim Blandy committed
366 367 368 369 370 371 372 373
	 regex
	 p offset
	 (poss nil)
	 helpposs
	 (case-fold-search completion-ignore-case))

    ;; Check if buffer contents can already be considered complete
    (if (and (eq mode 'exit)
Luc Teirlinck's avatar
Luc Teirlinck committed
374
	     (test-completion str table pred))
Jim Blandy's avatar
Jim Blandy committed
375 376 377 378
	'complete

      ;; Do substitutions in directory names
      (and filename
379 380 381 382 383 384 385
           (setq basestr (or (file-name-directory str) ""))
           (setq dirlength (length basestr))
	   ;; Do substitutions in directory names
           (setq p (substitute-in-file-name basestr))
           (not (string-equal basestr p))
           (setq str (concat p (file-name-nondirectory str)))
           (progn
Jim Blandy's avatar
Jim Blandy committed
386
	     (delete-region beg end)
387 388
	     (insert str)
	     (setq end (+ beg (length str)))))
389

Jim Blandy's avatar
Jim Blandy committed
390 391 392 393 394 395 396
      ;; Prepare various delimiter strings
      (or (equal PC-word-delimiters PC-delims)
	  (setq PC-delims PC-word-delimiters
		PC-delim-regex (concat "[" PC-delims "]")
		PC-ndelims-regex (concat "[^" PC-delims "]*")
		PC-delims-list (append PC-delims nil)))

397
      ;; Add wildcards if necessary
398 399
      (and filename
           (let ((dir (file-name-directory str))
400 401 402
                 (file (file-name-nondirectory str))
		 ;; The base dir for file-completion is passed in `predicate'.
		 (default-directory (expand-file-name pred)))
403 404 405 406 407 408 409 410 411
             (while (and (stringp dir) (not (file-directory-p dir)))
               (setq dir (directory-file-name dir))
               (setq file (concat (replace-regexp-in-string
                                   PC-delim-regex "*\\&"
                                   (file-name-nondirectory dir))
                                  "*/" file))
               (setq dir (file-name-directory dir)))
             (setq str (concat dir file))))

Jim Blandy's avatar
Jim Blandy committed
412 413 414 415
      ;; Look for wildcard expansions in directory name
      (and filename
	   (string-match "\\*.*/" str)
	   (let ((pat str)
416 417
		 ;; The base dir for file-completion is passed in `predicate'.
		 (default-directory (expand-file-name pred))
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
		 files)
	     (setq p (1+ (string-match "/[^/]*\\'" pat)))
	     (while (setq p (string-match PC-delim-regex pat p))
	       (setq pat (concat (substring pat 0 p)
				 "*"
				 (substring pat p))
		     p (+ p 2)))
	     (setq files (PC-expand-many-files (concat pat "*")))
	     (if files
		 (let ((dir (file-name-directory (car files)))
		       (p files))
		   (while (and (setq p (cdr p))
			       (equal dir (file-name-directory (car p)))))
		   (if p
		       (setq filename nil table nil pred nil
			     ambig t)
		     (delete-region beg end)
		     (setq str (concat dir (file-name-nondirectory str)))
		     (insert str)
		     (setq end (+ beg (length str)))))
	       (setq filename nil table nil pred nil))))

      ;; Strip directory name if appropriate
      (if filename
	  (if incname
	      (setq basestr (substring str incname)
		    dirname (substring str 0 incname))
	    (setq basestr (file-name-nondirectory str)
446 447 448 449 450
		  dirname (file-name-directory str))
	    ;; Make sure str is consistent with its directory and basename
	    ;; parts.  This is important on DOZe'NT systems when str only
	    ;; includes a drive letter, like in "d:".
	    (setq str (concat dirname basestr)))
Jim Blandy's avatar
Jim Blandy committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
	(setq basestr str))

      ;; Convert search pattern to a standard regular expression
      (setq regex (regexp-quote basestr)
	    offset (if (and (> (length regex) 0)
			    (not (eq (aref basestr 0) ?\*))
			    (or (eq PC-first-char t)
				(and PC-first-char filename))) 1 0)
	    p offset)
      (while (setq p (string-match PC-delim-regex regex p))
	(if (eq (aref regex p) ? )
	    (setq regex (concat (substring regex 0 p)
				PC-ndelims-regex
				PC-delim-regex
				(substring regex (1+ p)))
		  p (+ p (length PC-ndelims-regex) (length PC-delim-regex)))
	  (let ((bump (if (memq (aref regex p)
				'(?$ ?^ ?\. ?* ?+ ?? ?[ ?] ?\\))
			  -1 0)))
	    (setq regex (concat (substring regex 0 (+ p bump))
				PC-ndelims-regex
				(substring regex (+ p bump)))
		  p (+ p (length PC-ndelims-regex) 1)))))
      (setq p 0)
      (if filename
	  (while (setq p (string-match "\\\\\\*" regex p))
	    (setq regex (concat (substring regex 0 p)
				"[^/]*"
				(substring regex (+ p 2))))))
      ;;(setq the-regex regex)
      (setq regex (concat "\\`" regex))

483 484 485 486 487 488
      (and (> (length basestr) 0)
           (= (aref basestr 0) ?$)
           (setq env-on t
                 table PC-env-vars-alist
                 pred nil))

Jim Blandy's avatar
Jim Blandy committed
489 490 491 492 493 494 495
      ;; Find an initial list of possible completions
      (if (not (setq p (string-match (concat PC-delim-regex
					     (if filename "\\|\\*" ""))
				     str
				     (+ (length dirname) offset))))

	  ;; Minibuffer contains no hyphens -- simple case!
496 497
	  (setq poss (all-completions (if env-on
					  basestr str)
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502
				      table
				      pred))

	;; Use all-completions to do an initial cull.  This is a big win,
	;; since all-completions is written in C!
503 504 505 506 507
	(let ((compl (all-completions (if env-on
					  (file-name-nondirectory (substring str 0 p))
					(substring str 0 p))
                                        table
                                        pred)))
Jim Blandy's avatar
Jim Blandy committed
508 509 510
	  (setq p compl)
	  (while p
	    (and (string-match regex (car p))
511 512 513
		 (progn
		   (set-text-properties 0 (length (car p)) '() (car p))
		   (setq poss (cons (car p) poss))))
Jim Blandy's avatar
Jim Blandy committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527
	    (setq p (cdr p)))))

      ;; Now we have a list of possible completions
      (cond

       ;; No valid completions found
       ((null poss)
	(if (and (eq mode 'word)
		 (not PC-word-failed-flag))
	    (let ((PC-word-failed-flag t))
	      (delete-backward-char 1)
	      (PC-do-completion 'word))
	  (beep)
	  (PC-temp-minibuffer-message (if ambig
528
					  " [Ambiguous dir name]"
Jim Blandy's avatar
Jim Blandy committed
529
					(if (eq mode 'help)
530 531
					    " [No completions]"
					  " [No match]")))
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
	  nil))

       ;; More than one valid completion found
       ((or (cdr (setq helpposs poss))
	    (memq mode '(help word)))

	;; Handle completion-ignored-extensions
	(and filename
	     (not (eq mode 'help))
	     (let ((p2 poss))

	       ;; Build a regular expression representing the extensions list
	       (or (equal completion-ignored-extensions PC-ignored-extensions)
		   (setq PC-ignored-regexp
			 (concat "\\("
				 (mapconcat
				  'regexp-quote
				  (setq PC-ignored-extensions
					completion-ignored-extensions)
				  "\\|")
				 "\\)\\'")))

554 555
	       ;; Check if there are any without an ignored extension.
	       ;; Also ignore `.' and `..'.
Jim Blandy's avatar
Jim Blandy committed
556 557 558
	       (setq p nil)
	       (while p2
		 (or (string-match PC-ignored-regexp (car p2))
559
		     (string-match "\\(\\`\\|/\\)[.][.]?/?\\'" (car p2))
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564 565 566 567 568
		     (setq p (cons (car p2) p)))
		 (setq p2 (cdr p2)))

	       ;; If there are "good" names, use them
	       (and p (setq poss p))))

	;; Is the actual string one of the possible completions?
	(setq p (and (not (eq mode 'help)) poss))
	(while (and p
569
		    (not (string-equal (car p) basestr)))
Jim Blandy's avatar
Jim Blandy committed
570
	  (setq p (cdr p)))
571 572 573 574 575 576
	(and p (null mode)
	     (PC-temp-minibuffer-message " [Complete, but not unique]"))
	(if (and p
		 (not (and (null mode)
			   (eq this-command last-command))))
	    t
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612

	  ;; If ambiguous, try for a partial completion
	  (let ((improved nil)
		prefix
		(pt nil)
		(skip "\\`"))

	    ;; Check if next few letters are the same in all cases
	    (if (and (not (eq mode 'help))
		     (setq prefix (try-completion "" (mapcar 'list poss))))
		(let ((first t) i)
		  (if (eq mode 'word)
		      (setq prefix (PC-chop-word prefix basestr)))
		  (goto-char (+ beg (length dirname)))
		  (while (and (progn
				(setq i 0)
				(while (< i (length prefix))
				  (if (and (< (point) end)
					   (eq (aref prefix i)
					       (following-char)))
				      (forward-char 1)
				    (if (and (< (point) end)
					     (or (and (looking-at " ")
						      (memq (aref prefix i)
							    PC-delims-list))
						 (eq (downcase (aref prefix i))
						     (downcase
						      (following-char)))))
					(progn
					  (delete-char 1)
					  (setq end (1- end)))
				      (and filename (looking-at "\\*")
					   (progn
					     (delete-char 1)
					     (setq end (1- end))))
				      (setq improved t))
613
				    (insert (substring prefix i (1+ i)))
Jim Blandy's avatar
Jim Blandy committed
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
				    (setq end (1+ end)))
				  (setq i (1+ i)))
				(or pt (equal (point) beg)
				    (setq pt (point)))
				(looking-at PC-delim-regex))
			      (setq skip (concat skip
						 (regexp-quote prefix)
						 PC-ndelims-regex)
				    prefix (try-completion
					    ""
					    (mapcar
					     (function
					      (lambda (x)
						(list
						 (and (string-match skip x)
						      (substring
						       x
						       (match-end 0))))))
					     poss)))
			      (or (> i 0) (> (length prefix) 0))
			      (or (not (eq mode 'word))
				  (and first (> (length prefix) 0)
				       (setq first nil
					     prefix (substring prefix 0 1))))))
		  (goto-char (if (eq mode 'word) end
			       (or pt beg)))))

	    (if (and (eq mode 'word)
		     (not PC-word-failed-flag))

		(if improved

		    ;; We changed it... would it be complete without the space?
Luc Teirlinck's avatar
Luc Teirlinck committed
647
		    (if (test-completion (buffer-substring 1 (1- end))
Jim Blandy's avatar
Jim Blandy committed
648 649 650 651 652 653 654
					  table pred)
			(delete-region (1- end) end)))

	      (if improved

		  ;; We changed it... enough to be complete?
		  (and (eq mode 'exit)
Luc Teirlinck's avatar
Luc Teirlinck committed
655
		       (test-completion (field-string) table pred))
Jim Blandy's avatar
Jim Blandy committed
656 657

		;; If totally ambiguous, display a list of completions
658 659 660
		(if (or (eq completion-auto-help t)
			(and completion-auto-help
			     (eq last-command this-command))
Jim Blandy's avatar
Jim Blandy committed
661
			(eq mode 'help))
662
		    (with-output-to-temp-buffer "*Completions*"
663
		      (display-completion-list (sort helpposs 'string-lessp))
664
		      (with-current-buffer standard-output
665 666 667 668
			;; Record which part of the buffer we are completing
			;; so that choosing a completion from the list
			;; knows how much old text to replace.
			(setq completion-base-size dirlength)))
669
		  (PC-temp-minibuffer-message " [Next char not unique]"))
Jim Blandy's avatar
Jim Blandy committed
670 671 672 673
		nil)))))

       ;; Only one possible completion
       (t
674 675
	(if (and (equal basestr (car poss))
		 (not (and env-on filename)))
Jim Blandy's avatar
Jim Blandy committed
676
	    (if (null mode)
677
		(PC-temp-minibuffer-message " [Sole completion]"))
Jim Blandy's avatar
Jim Blandy committed
678
	  (delete-region beg end)
679 680 681 682
	  (insert (format "%s"
			  (if filename
			      (substitute-in-file-name (concat dirname (car poss)))
			    (car poss)))))
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
	t)))))

(defun PC-chop-word (new old)
  (let ((i -1)
	(j -1))
    (while (and (setq i (string-match PC-delim-regex old (1+ i)))
		(setq j (string-match PC-delim-regex new (1+ j)))))
    (if (and j
	     (or (not PC-word-failed-flag)
		 (setq j (string-match PC-delim-regex new (1+ j)))))
	(substring new 0 (1+ j))
      new)))

(defvar PC-not-minibuffer nil)

698
(defun PC-temp-minibuffer-message (message)
Jim Blandy's avatar
Jim Blandy committed
699
  "A Lisp version of `temp_minibuffer_message' from minibuf.c."
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
  (cond (PC-not-minibuffer
	 (message message)
	 (sit-for 2)
	 (message ""))
	((fboundp 'temp-minibuffer-message)
	 (temp-minibuffer-message message))
	(t
	 (let ((point-max (point-max)))
	   (save-excursion
	     (goto-char point-max)
	     (insert message))
	   (let ((inhibit-quit t))
	     (sit-for 2)
	     (delete-region point-max (point-max))
	     (when quit-flag
	       (setq quit-flag nil
		     unread-command-events '(7))))))))
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721 722 723 724 725 726 727 728 729


(defun PC-lisp-complete-symbol ()
  "Perform completion on Lisp symbol preceding point.
That symbol is compared against the symbols that exist
and any additional characters determined by what is there
are inserted.
If the symbol starts just after an open-parenthesis,
only symbols with function definitions are considered.
Otherwise, all symbols with function definitions, values
or properties are considered."
  (interactive)
  (let* ((end (point))
730 731 732 733 734 735
	 (beg (save-excursion
                (with-syntax-table lisp-mode-syntax-table
                  (backward-sexp 1)
                  (while (= (char-syntax (following-char)) ?\')
                    (forward-char 1))
                  (point))))
Jim Blandy's avatar
Jim Blandy committed
736 737 738 739 740 741 742 743 744 745
	 (minibuffer-completion-table obarray)
	 (minibuffer-completion-predicate
	  (if (eq (char-after (1- beg)) ?\()
	      'fboundp
	    (function (lambda (sym)
			(or (boundp sym) (fboundp sym)
			    (symbol-plist sym))))))
	 (PC-not-minibuffer t))
    (PC-do-completion nil beg end)))

746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
(defun PC-complete-as-file-name ()
   "Perform completion on file names preceding point.
 Environment vars are converted to their values."
   (interactive)
   (let* ((end (point))
          (beg (if (re-search-backward "[^\\][ \t\n\"\`\'][^ \t\n\"\`\']"
				       (point-min) t)
                   (+ (point) 2)
                   (point-min)))
          (minibuffer-completion-table 'read-file-name-internal)
          (minibuffer-completion-predicate "")
          (PC-not-minibuffer t))
     (goto-char end)
     (PC-do-completion nil beg end)))

761 762
;; Use the shell to do globbing.
;; This could now use file-expand-wildcards instead.
Jim Blandy's avatar
Jim Blandy committed
763 764

(defun PC-expand-many-files (name)
765
  (with-current-buffer (generate-new-buffer " *Glob Output*")
Jim Blandy's avatar
Jim Blandy committed
766 767 768 769 770 771 772 773 774 775 776 777 778
    (erase-buffer)
    (shell-command (concat "echo " name) t)
    (goto-char (point-min))
    (if (looking-at ".*No match")
	nil
      (insert "(\"")
      (while (search-forward " " nil t)
	(delete-backward-char 1)
	(insert "\" \""))
      (goto-char (point-max))
      (delete-backward-char 1)
      (insert "\")")
      (goto-char (point-min))
779
      (let ((files (read (current-buffer))) (p nil))
Jim Blandy's avatar
Jim Blandy committed
780
	(kill-buffer (current-buffer))
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
	(or (equal completion-ignored-extensions PC-ignored-extensions)
	    (setq PC-ignored-regexp
		  (concat "\\("
			  (mapconcat
			   'regexp-quote
			   (setq PC-ignored-extensions
				 completion-ignored-extensions)
			   "\\|")
			  "\\)\\'")))
	(setq p nil)
	(while files
	  (or (string-match PC-ignored-regexp (car files))
	      (setq p (cons (car files) p)))
	  (setq files (cdr files)))
	p))))
Jim Blandy's avatar
Jim Blandy committed
796

797 798 799
;; Facilities for loading C header files.  This is independent from the
;; main completion code.  See also the variable `PC-include-file-path'
;; at top of this file.
Jim Blandy's avatar
Jim Blandy committed
800 801 802 803 804 805 806 807 808 809

(defun PC-look-for-include-file ()
  (if (string-match "[\"<]\\([^\"<>]*\\)[\">]?$" (buffer-file-name))
      (let ((name (substring (buffer-file-name)
			     (match-beginning 1) (match-end 1)))
	    (punc (aref (buffer-file-name) (match-beginning 0)))
	    (path nil)
	    new-buf)
	(kill-buffer (current-buffer))
	(if (equal name "")
810
	    (with-current-buffer (car (buffer-list))
Jim Blandy's avatar
Jim Blandy committed
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
	      (save-excursion
		(beginning-of-line)
		(if (looking-at
		     "[ \t]*#[ \t]*include[ \t]+[<\"]\\(.+\\)[>\"][ \t]*[\n/]")
		    (setq name (buffer-substring (match-beginning 1)
						 (match-end 1))
			  punc (char-after (1- (match-beginning 1))))
		  ;; Suggested by Frank Siebenlist:
		  (if (or (looking-at
			   "[ \t]*([ \t]*load[ \t]+\"\\([^\"]+\\)\"")
			  (looking-at
			   "[ \t]*([ \t]*load-library[ \t]+\"\\([^\"]+\\)\"")
			  (looking-at
			   "[ \t]*([ \t]*require[ \t]+'\\([^\t )]+\\)[\t )]"))
		      (progn
			(setq name (buffer-substring (match-beginning 1)
						     (match-end 1))
			      punc ?\<
			      path load-path)
			(if (string-match "\\.elc$" name)
			    (setq name (substring name 0 -1))
			  (or (string-match "\\.el$" name)
			      (setq name (concat name ".el")))))
		    (error "Not on an #include line"))))))
835
	(or (string-match "\\.[[:alnum:]]+$" name)
Jim Blandy's avatar
Jim Blandy committed
836 837 838 839 840 841 842 843 844 845 846
	    (setq name (concat name ".h")))
	(if (eq punc ?\<)
	    (let ((path (or path (PC-include-file-path))))
	      (while (and path
			  (not (file-exists-p
				(concat (file-name-as-directory (car path))
					name))))
		(setq path (cdr path)))
	      (if path
		  (setq name (concat (file-name-as-directory (car path)) name))
		(error "No such include file: <%s>" name)))
847
	  (let ((dir (with-current-buffer (car (buffer-list))
Jim Blandy's avatar
Jim Blandy committed
848 849 850
		       default-directory)))
	    (if (file-exists-p (concat dir name))
		(setq name (concat dir name))
851
	      (error "No such include file: `%s'" name))))
Jim Blandy's avatar
Jim Blandy committed
852 853 854 855
	(setq new-buf (get-file-buffer name))
	(if new-buf
	    ;; no need to verify last-modified time for this!
	    (set-buffer new-buf)
856
	  (set-buffer (create-file-buffer name))
Jim Blandy's avatar
Jim Blandy committed
857 858
	  (erase-buffer)
	  (insert-file-contents name t))
859 860
	;; Returning non-nil with the new buffer current
	;; is sufficient to tell find-file to use it.
Jim Blandy's avatar
Jim Blandy committed
861 862 863 864 865 866 867 868 869 870 871 872 873 874
	t)
    nil))

(defun PC-include-file-path ()
  (or PC-include-file-path
      (let ((env (getenv "INCPATH"))
	    (path nil)
	    pos)
	(or env (error "No include file path specified"))
	(while (setq pos (string-match ":[^:]+$" env))
	  (setq path (cons (substring env (1+ pos)) path)
		env (substring env 0 pos)))
	path)))

875
;; This is adapted from lib-complete.el, by Mike Williams.
Jim Blandy's avatar
Jim Blandy committed
876 877
(defun PC-include-file-all-completions (file search-path &optional full)
  "Return all completions for FILE in any directory on SEARCH-PATH.
878
If optional third argument FULL is non-nil, returned pathnames should be
Jim Blandy's avatar
Jim Blandy committed
879 880
absolute rather than relative to some directory on the SEARCH-PATH."
  (setq search-path
881 882
	(mapcar (lambda (dir)
		  (if dir (file-name-as-directory dir) default-directory))
Jim Blandy's avatar
Jim Blandy committed
883 884 885 886 887
		search-path))
  (if (file-name-absolute-p file)
      ;; It's an absolute file name, so don't need search-path
      (progn
	(setq file (expand-file-name file))
888
	(file-name-all-completions
Jim Blandy's avatar
Jim Blandy committed
889 890 891 892 893 894 895
	 (file-name-nondirectory file) (file-name-directory file)))
    (let ((subdir (file-name-directory file))
	  (ndfile (file-name-nondirectory file))
	  file-lists)
      ;; Append subdirectory part to each element of search-path
      (if subdir
	  (setq search-path
896
		(mapcar (lambda (dir) (concat dir subdir))
Jim Blandy's avatar
Jim Blandy committed
897 898 899 900 901 902 903 904 905
			search-path)
		file ))
      ;; Make list of completions in each directory on search-path
      (while search-path
	(let* ((dir (car search-path))
	       (subdir (if full dir subdir)))
	  (if (file-directory-p dir)
	      (progn
		(setq file-lists
906
		      (cons
907
		       (mapcar (lambda (file) (concat subdir file))
908
			       (file-name-all-completions ndfile
Jim Blandy's avatar
Jim Blandy committed
909 910 911 912 913
							  (car search-path)))
		       file-lists))))
	  (setq search-path (cdr search-path))))
      ;; Compress out duplicates while building complete list (slloooow!)
      (let ((sorted (sort (apply 'nconc file-lists)
914
			  (lambda (x y) (not (string-lessp x y)))))
Jim Blandy's avatar
Jim Blandy committed
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
	    compressed)
	(while sorted
	  (if (equal (car sorted) (car compressed)) nil
	    (setq compressed (cons (car sorted) compressed)))
	  (setq sorted (cdr sorted)))
	compressed))))

(defun PC-read-include-file-name-internal (string dir action)
  (if (string-match "<\\([^\"<>]*\\)>?$" string)
      (let* ((name (substring string (match-beginning 1) (match-end 1)))
	     (str2 (substring string (match-beginning 0)))
	     (completion-table
	      (mapcar (function (lambda (x) (list (format "<%s>" x))))
		      (PC-include-file-all-completions
		       name (PC-include-file-path)))))
	(cond
	 ((not completion-table) nil)
	 ((eq action nil) (try-completion str2 completion-table nil))
	 ((eq action t) (all-completions str2 completion-table nil))
934
	 ((eq action 'lambda) (test-completion str2 completion-table nil))))
Jim Blandy's avatar
Jim Blandy committed
935 936
    (funcall PC-old-read-file-name-internal string dir action)))

937

Jim Blandy's avatar
Jim Blandy committed
938 939
(provide 'complete)

940
;; arch-tag: fc7e2768-ff44-4e22-b579-4d825b968458
941
;;; complete.el ends here