complete.el 37 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

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1990, 1991, 1992, 1993, 1999, 2000, 2001, 2002, 2003,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2004, 2005, 2006, 2007 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

(defcustom PC-first-char 'find-file
97
  "Control how the first character of a string is to be interpreted.
98 99 100 101 102 103 104 105
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
  :group 'partial-completion)

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

(defcustom PC-word-delimiters "-_. "
116
  "A string of characters treated as word delimiters for completion.
117 118 119 120
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
expression (not containing character ranges like `a-z')."
  :type 'string
  :group 'partial-completion)

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

(defcustom PC-disable-includes nil
133
  "If non-nil, include-file support in \\[find-file] is disabled."
134 135
  :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 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

(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)))))

186 187 188 189 190 191 192 193 194 195 196 197 198
;;;###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
199
other file in that directory begins with that sequence of characters.
200

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

Partial Completion mode extends the meaning of `completion-auto-help' (which
207 208 209
see), so that if it is neither nil nor t, Emacs shows the `*Completions*'
buffer only on the second attempt to complete.  That is, if TAB finds nothing
to complete, the first TAB just says \"Next char not unique\" and the
210
second TAB brings up the `*Completions*' buffer."
211
  :global t :group 'partial-completion
212 213 214 215
  ;; Deal with key bindings...
  (PC-bindings partial-completion-mode)
  ;; Deal with include file feature...
  (cond ((not partial-completion-mode)
216
	 (remove-hook 'find-file-not-found-functions 'PC-look-for-include-file))
217
	((not PC-disable-includes)
218
	 (add-hook 'find-file-not-found-functions 'PC-look-for-include-file)))
219
  ;; ... with some underhand redefining.
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
  (cond ((not partial-completion-mode)
         (ad-disable-advice 'read-file-name-internal 'around 'PC-include-file)
         (ad-activate 'read-file-name-internal))
	((not PC-disable-includes)
         (ad-enable-advice 'read-file-name-internal 'around 'PC-include-file)
         (ad-activate 'read-file-name-internal)))
  ;; Adjust the completion selection in *Completion* buffers to the way
  ;; we work.  The default minibuffer completion code only completes the
  ;; text before point and leaves the text after point alone (new in
  ;; Emacs-22).  In contrast we use the whole text and we even sometimes
  ;; move point to a place before EOB, to indicate the first position where
  ;; there's a difference, so when the user uses choose-completion, we have
  ;; to trick choose-completion into replacing the whole minibuffer text
  ;; rather than only the text before point.  --Stef
  (funcall
   (if partial-completion-mode 'add-hook 'remove-hook)
   'choose-completion-string-functions
237 238 239
   (lambda (choice buffer mini-p base-size)
     (if mini-p (goto-char (point-max)))
     nil))
240 241 242 243 244 245 246 247
  ;; Build the env-completion and mapping table.
  (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))))
248

249

Jim Blandy's avatar
Jim Blandy committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
(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)
265 266 267 268 269 270 271 272 273
    ;; 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)))
274
	  (with-current-buffer (window-buffer window)
275 276 277 278
	    (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
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 313 314 315 316 317 318 319 320 321 322


(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 ()
323
  (if (= (point-max) (minibuffer-prompt-end))  ; Duplicate the "bug" that Info-menu relies on...
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327 328 329
      (exit-minibuffer)
    (let ((flag (PC-do-completion 'exit)))
      (and flag
	   (if (or (eq flag 'complete)
		   (not minibuffer-completion-confirm))
	       (exit-minibuffer)
330
	     (PC-temp-minibuffer-message " [Confirm]"))))))
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356


(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)

357
(defvar PC-completion-as-file-name-predicate
358 359
  (lambda () minibuffer-completing-file-name)
  "A function testing whether a minibuffer completion now will work filename-style.
360 361
The function takes no arguments, and typically looks at the value
of `minibuffer-completion-table' and the minibuffer contents.")
362

363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
;; Returns the sequence of non-delimiter characters that follow regexp in string.
(defun PC-chunk-after (string regexp)
  (if (not (string-match regexp string))
      (let ((message (format "String %s didn't match regexp %s" string regexp)))
	(message message)
	(error message)))
  (let ((result (substring string (match-end 0))))
    ;; result may contain multiple chunks
    (if (string-match PC-delim-regex result)
	(setq result (substring result 0 (match-beginning 0))))
    result))

(defun test-completion-ignore-case (str table pred)
  "Like `test-completion', but ignores case when possible."
  ;; Binding completion-ignore-case to nil ensures, for compatibility with
  ;; standard completion, that the return value is exactly one of the
  ;; possibilities.  Do this binding only if pred is nil, out of paranoia;
  ;; perhaps it is safe even if pred is non-nil.
  (if pred
      (test-completion str table pred)
    (let ((completion-ignore-case nil))
      (test-completion str table pred))))

Jim Blandy's avatar
Jim Blandy committed
386
(defun PC-do-completion (&optional mode beg end)
387
  (or beg (setq beg (minibuffer-prompt-end)))
Jim Blandy's avatar
Jim Blandy committed
388 389 390
  (or end (setq end (point-max)))
  (let* ((table minibuffer-completion-table)
	 (pred minibuffer-completion-predicate)
391
	 (filename (funcall PC-completion-as-file-name-predicate))
392
	 (dirname nil)		; non-nil only if a filename is being completed
393
	 (dirlength 0)
Jim Blandy's avatar
Jim Blandy committed
394 395 396
	 (str (buffer-substring beg end))
	 (incname (and filename (string-match "<\\([^\"<>]*\\)>?$" str)))
	 (ambig nil)
397
	 basestr origstr
398
	 env-on
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403 404 405 406
	 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)
407 408 409 410 411 412 413 414 415
	     (test-completion str table pred))
	(progn
	  ;; If completion-ignore-case is non-nil, insert the
	  ;; completion string since that may have a different case.
	  (when completion-ignore-case
	    (setq str (try-completion str table pred))
	    (delete-region beg end)
	    (insert str))
	  'complete)
Jim Blandy's avatar
Jim Blandy committed
416 417 418

      ;; Do substitutions in directory names
      (and filename
419 420 421 422 423 424 425
           (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
426
	     (delete-region beg end)
427 428
	     (insert str)
	     (setq end (+ beg (length str)))))
429

Jim Blandy's avatar
Jim Blandy committed
430 431 432 433 434 435 436
      ;; 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)))

437
      ;; Add wildcards if necessary
438 439
      (and filename
           (let ((dir (file-name-directory str))
440 441 442
                 (file (file-name-nondirectory str))
		 ;; The base dir for file-completion is passed in `predicate'.
		 (default-directory (expand-file-name pred)))
443 444 445 446 447 448 449
             (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)))
450
             (setq origstr str str (concat dir file))))
451

Jim Blandy's avatar
Jim Blandy committed
452 453 454 455
      ;; Look for wildcard expansions in directory name
      (and filename
	   (string-match "\\*.*/" str)
	   (let ((pat str)
456 457
		 ;; The base dir for file-completion is passed in `predicate'.
		 (default-directory (expand-file-name pred))
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
		 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)))))
478 479 480 481 482 483 484 485
	       (if origstr
                   ;; If the wildcards were introduced by us, it's possible
                   ;; that read-file-name-internal (especially our
                   ;; PC-include-file advice) can still find matches for the
                   ;; original string even if we couldn't, so remove the
                   ;; added wildcards.
                   (setq str origstr)
		 (setq filename nil table nil pred nil)))))
Jim Blandy's avatar
Jim Blandy committed
486 487 488 489 490 491 492

      ;; 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)
493 494 495 496 497
		  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
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
	(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))

530 531 532 533 534 535
      (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
536 537 538 539 540 541 542
      ;; 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!
543 544
	  (setq poss (all-completions (if env-on
					  basestr str)
Jim Blandy's avatar
Jim Blandy committed
545 546 547 548 549
				      table
				      pred))

	;; Use all-completions to do an initial cull.  This is a big win,
	;; since all-completions is written in C!
550 551 552
	(let ((compl (all-completions (if env-on
					  (file-name-nondirectory (substring str 0 p))
					(substring str 0 p))
553 554
                                      table
                                      pred)))
Jim Blandy's avatar
Jim Blandy committed
555 556 557
	  (setq p compl)
	  (while p
	    (and (string-match regex (car p))
558 559 560
		 (progn
		   (set-text-properties 0 (length (car p)) '() (car p))
		   (setq poss (cons (car p) poss))))
Jim Blandy's avatar
Jim Blandy committed
561 562
	    (setq p (cdr p)))))

563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
      ;; 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)
                                "\\|")
                               "\\)\\'")))

             ;; Check if there are any without an ignored extension.
             ;; Also ignore `.' and `..'.
             (setq p nil)
             (while p2
               (or (string-match PC-ignored-regexp (car p2))
                   (string-match "\\(\\`\\|/\\)[.][.]?/?\\'" (car p2))
                   (setq p (cons (car p2) p)))
               (setq p2 (cdr p2)))

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

Jim Blandy's avatar
Jim Blandy committed
591 592 593 594 595 596 597 598 599 600 601 602
      ;; 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
603
					  " [Ambiguous dir name]"
Jim Blandy's avatar
Jim Blandy committed
604
					(if (eq mode 'help)
605 606
					    " [No completions]"
					  " [No match]")))
Jim Blandy's avatar
Jim Blandy committed
607 608 609 610 611 612 613 614 615
	  nil))

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

	;; Is the actual string one of the possible completions?
	(setq p (and (not (eq mode 'help)) poss))
	(while (and p
616
		    (not (string-equal (car p) basestr)))
Jim Blandy's avatar
Jim Blandy committed
617
	  (setq p (cdr p)))
618 619 620 621 622 623
	(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
624 625 626 627 628 629 630 631 632

	  ;; 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))
633 634
		     (setq prefix (try-completion (PC-chunk-after basestr skip)
                                                  poss)))
Jim Blandy's avatar
Jim Blandy committed
635
		(let ((first t) i)
636 637
		  ;; Retain capitalization of user input even if
		  ;; completion-ignore-case is set.
Jim Blandy's avatar
Jim Blandy committed
638 639 640 641
		  (if (eq mode 'word)
		      (setq prefix (PC-chop-word prefix basestr)))
		  (goto-char (+ beg (length dirname)))
		  (while (and (progn
642
				(setq i 0) ; index into prefix string
Jim Blandy's avatar
Jim Blandy committed
643 644
				(while (< i (length prefix))
				  (if (and (< (point) end)
645 646 647
					   (eq (downcase (aref prefix i))
					       (downcase (following-char))))
				      ;; same char (modulo case); no action
Jim Blandy's avatar
Jim Blandy committed
648 649
				      (forward-char 1)
				    (if (and (< (point) end)
650
					     (and (looking-at " ")
Jim Blandy's avatar
Jim Blandy committed
651
						      (memq (aref prefix i)
652 653
							PC-delims-list)))
					;; replace " " by the actual delimiter
Jim Blandy's avatar
Jim Blandy committed
654 655
					(progn
					  (delete-char 1)
656 657 658
					  (insert (substring prefix i (1+ i))))
				      ;; insert a new character
				      (progn
Jim Blandy's avatar
Jim Blandy committed
659 660 661 662
				      (and filename (looking-at "\\*")
					   (progn
					     (delete-char 1)
					     (setq end (1- end))))
663
					(setq improved t)
664
				    (insert (substring prefix i (1+ i)))
665
					(setq end (1+ end)))))
Jim Blandy's avatar
Jim Blandy committed
666
				  (setq i (1+ i)))
667
				(or pt (setq pt (point)))
Jim Blandy's avatar
Jim Blandy committed
668 669 670 671 672
				(looking-at PC-delim-regex))
			      (setq skip (concat skip
						 (regexp-quote prefix)
						 PC-ndelims-regex)
				    prefix (try-completion
673 674 675 676 677 678
					    (PC-chunk-after
					     ;; not basestr, because that does
					     ;; not reflect insertions
					     (buffer-substring
					      (+ beg (length dirname)) end)
					     skip)
Jim Blandy's avatar
Jim Blandy committed
679
					    (mapcar
680 681 682
                                             (lambda (x)
                                               (when (string-match skip x)
                                                 (substring x (match-end 0))))
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
					     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
698
		    (if (test-completion (buffer-substring 1 (1- end))
Jim Blandy's avatar
Jim Blandy committed
699 700 701 702 703 704 705
					  table pred)
			(delete-region (1- end) end)))

	      (if improved

		  ;; We changed it... enough to be complete?
		  (and (eq mode 'exit)
706
		       (test-completion-ignore-case (field-string) table pred))
Jim Blandy's avatar
Jim Blandy committed
707 708

		;; If totally ambiguous, display a list of completions
709 710 711
		(if (or (eq completion-auto-help t)
			(and completion-auto-help
			     (eq last-command this-command))
Jim Blandy's avatar
Jim Blandy committed
712
			(eq mode 'help))
713
		    (with-output-to-temp-buffer "*Completions*"
714
		      (display-completion-list (sort helpposs 'string-lessp))
715
		      (with-current-buffer standard-output
716 717 718 719
			;; 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)))
720
		  (PC-temp-minibuffer-message " [Next char not unique]"))
Jim Blandy's avatar
Jim Blandy committed
721 722 723 724
		nil)))))

       ;; Only one possible completion
       (t
725 726
	(if (and (equal basestr (car poss))
		 (not (and env-on filename)))
Jim Blandy's avatar
Jim Blandy committed
727
	    (if (null mode)
728
		(PC-temp-minibuffer-message " [Sole completion]"))
Jim Blandy's avatar
Jim Blandy committed
729
	  (delete-region beg end)
730 731 732 733
	  (insert (format "%s"
			  (if filename
			      (substitute-in-file-name (concat dirname (car poss)))
			    (car poss)))))
Jim Blandy's avatar
Jim Blandy committed
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
	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)

749
(defun PC-temp-minibuffer-message (message)
Jim Blandy's avatar
Jim Blandy committed
750
  "A Lisp version of `temp_minibuffer_message' from minibuf.c."
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
  (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
768 769 770 771 772 773 774 775 776 777 778 779 780


(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))
781 782 783 784 785 786
	 (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
787 788 789 790 791 792 793 794 795 796
	 (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)))

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
(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)))

812 813
;; Use the shell to do globbing.
;; This could now use file-expand-wildcards instead.
Jim Blandy's avatar
Jim Blandy committed
814 815

(defun PC-expand-many-files (name)
816
  (with-current-buffer (generate-new-buffer " *Glob Output*")
Jim Blandy's avatar
Jim Blandy committed
817
    (erase-buffer)
818 819 820 821 822 823
    (when (and (file-name-absolute-p name)
               (not (file-directory-p default-directory)))
      ;; If the current working directory doesn't exist `shell-command'
      ;; signals an error.  So if the file names we're looking for don't
      ;; depend on the working directory, switch to a valid directory first.
      (setq default-directory "/"))
Jim Blandy's avatar
Jim Blandy committed
824 825
    (shell-command (concat "echo " name) t)
    (goto-char (point-min))
826 827 828 829 830 831 832
    ;; CSH-style shells were known to output "No match", whereas
    ;; SH-style shells tend to simply output `name' when no match is found.
    (if (looking-at (concat ".*No match\\|\\(^\\| \\)\\("
			    (regexp-quote name)
			    "\\|"
			    (regexp-quote (expand-file-name name))
			    "\\)\\( \\|$\\)"))
Jim Blandy's avatar
Jim Blandy committed
833 834 835 836 837 838 839 840 841
	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))
842
      (let ((files (read (current-buffer))) (p nil))
Jim Blandy's avatar
Jim Blandy committed
843
	(kill-buffer (current-buffer))
844 845 846 847 848 849 850 851 852 853 854
	(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
855 856 857 858 859 860 861 862
          ;; This whole process of going through to shell, to echo, and
          ;; finally parsing the output is a hack.  It breaks as soon as
          ;; there are spaces in the file names or when the no-match
          ;; message changes.  To make up for it, we check that what we read
          ;; indeed exists, so we may miss some files, but we at least won't
          ;; list non-existent ones.
	  (or (not (file-exists-p (car files)))
	      (string-match PC-ignored-regexp (car files))
863 864 865
	      (setq p (cons (car files) p)))
	  (setq files (cdr files)))
	p))))
Jim Blandy's avatar
Jim Blandy committed
866

867 868 869
;; 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
870 871 872 873 874 875 876 877 878 879

(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 "")
880
	    (with-current-buffer (car (buffer-list))
Jim Blandy's avatar
Jim Blandy committed
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
	      (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"))))))
905
	(or (string-match "\\.[[:alnum:]]+$" name)
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909 910 911 912 913 914 915 916
	    (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)))
917
	  (let ((dir (with-current-buffer (car (buffer-list))
Jim Blandy's avatar
Jim Blandy committed
918 919 920
		       default-directory)))
	    (if (file-exists-p (concat dir name))
		(setq name (concat dir name))
921
	      (error "No such include file: `%s'" name))))
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925
	(setq new-buf (get-file-buffer name))
	(if new-buf
	    ;; no need to verify last-modified time for this!
	    (set-buffer new-buf)
926
	  (set-buffer (create-file-buffer name))
Jim Blandy's avatar
Jim Blandy committed
927 928
	  (erase-buffer)
	  (insert-file-contents name t))
929 930
	;; Returning non-nil with the new buffer current
	;; is sufficient to tell find-file to use it.
Jim Blandy's avatar
Jim Blandy committed
931 932 933 934 935 936 937 938 939 940 941 942 943 944
	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)))

945
;; This is adapted from lib-complete.el, by Mike Williams.
Jim Blandy's avatar
Jim Blandy committed
946 947
(defun PC-include-file-all-completions (file search-path &optional full)
  "Return all completions for FILE in any directory on SEARCH-PATH.
948
If optional third argument FULL is non-nil, returned pathnames should be
Jim Blandy's avatar
Jim Blandy committed
949 950
absolute rather than relative to some directory on the SEARCH-PATH."
  (setq search-path
951 952
	(mapcar (lambda (dir)
		  (if dir (file-name-as-directory dir) default-directory))
Jim Blandy's avatar
Jim Blandy committed
953 954 955 956 957
		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))
958
	(file-name-all-completions
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962 963 964 965
	 (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
966
		(mapcar (lambda (dir) (concat dir subdir))
Jim Blandy's avatar
Jim Blandy committed
967 968 969 970 971 972 973 974 975
			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
976
		      (cons
977
		       (mapcar (lambda (file) (concat subdir file))
978
			       (file-name-all-completions ndfile
Jim Blandy's avatar
Jim Blandy committed
979 980 981 982 983
							  (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)
984
			  (lambda (x y) (not (string-lessp x y)))))
Jim Blandy's avatar
Jim Blandy committed
985 986 987 988 989 990 991
	    compressed)
	(while sorted
	  (if (equal (car sorted) (car compressed)) nil
	    (setq compressed (cons (car sorted) compressed)))
	  (setq sorted (cdr sorted)))
	compressed))))

992 993 994 995
(defadvice read-file-name-internal (around PC-include-file disable)
  (if (string-match "<\\([^\"<>]*\\)>?\\'" (ad-get-arg 0))
      (let* ((string (ad-get-arg 0))
             (action (ad-get-arg 2))
996
             (name (substring string (match-beginning 1) (match-end 1)))
Jim Blandy's avatar
Jim Blandy committed
997 998
	     (str2 (substring string (match-beginning 0)))
	     (completion-table
999
	      (mapcar (lambda (x) (format "<%s>" x))
Jim Blandy's avatar
Jim Blandy committed
1000 1001
		      (PC-include-file-all-completions
		       name (PC-include-file-path)))))
1002 1003 1004 1005 1006 1007 1008
        (setq ad-return-value
              (cond
               ((not completion-table) nil)
               ((eq action 'lambda) (test-completion str2 completion-table nil))
               ((eq action nil) (try-completion str2 completion-table nil))
               ((eq action t) (all-completions str2 completion-table nil)))))
    ad-do-it))
Jim Blandy's avatar
Jim Blandy committed
1009

1010

Jim Blandy's avatar
Jim Blandy committed
1011 1012
(provide 'complete)

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