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