(update_one_menu_entry): When creating a pulldown
[emacs.git] / lisp / hippie-exp.el
blobddb896befdb8d3842510e902c141cdadcebab939
1 ;;; hippie-exp.el --- expand text trying various ways to find its expansion.
3 ;; Copyright (C) 1992 Free Software Foundation, Inc.
5 ;; Author: Anders Holst <aho@sans.kth.se>
6 ;; Last change: 6 August 1995
7 ;; Version: 1.4
8 ;; Keywords: abbrev
10 ;; This file is part of GNU Emacs.
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.
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.
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., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; `hippie-expand' is a single function for a lot of different kinds
30 ;; of completions and expansions. Called repeatedly it tries all
31 ;; possible completions in succession.
32 ;; Which kinds of completions to try, and in which order, is
33 ;; determined by the contents of `hippie-expand-try-functions-list'.
34 ;; Much customization of `hippie-expand' can be made by changing the
35 ;; order of, removing, or inserting new functions in this list.
36 ;; Given a positive numeric argument, `hippie-expand' jumps directly
37 ;; ARG functions forward in this list. Given some other argument
38 ;; (a negative argument or just Ctrl-U) it undoes the tried
39 ;; completion.
41 ;; If the variable `hippie-expand-verbose' is non-nil, `hippie-expand'
42 ;; outputs in a message which try-function in the list that is used
43 ;; currently (ie. was used currently and will be tried first the next
44 ;; time).
45 ;; The variable `hippie-expand-max-buffers' determines in how many
46 ;; buffers, apart from the current, to search for expansions in. It
47 ;; is used by the try-functions named "-all-buffers".
48 ;; The variable `hippie-expand-ignore-buffers' is a list of regexps
49 ;; matching buffer names (as strings) or major modes (as atoms) of
50 ;; buffers that should not be searched by the try-functions named
51 ;; "-all-buffers".
52 ;; See also the macro `make-hippie-expand-function' below.
53 ;;
54 ;; A short description of the current try-functions in this file:
55 ;; `try-complete-file-name' : very convenient to have in any buffer,
56 ;; and not just in the minibuffer or (some) shell-mode. It goes
57 ;; through all possible completions instead of just completing as
58 ;; much as is unique.
59 ;; `try-complete-file-name-partially' : To insert in the list just
60 ;; before `try-complete-file-name' for those who want first to get
61 ;; a file name completed only as many characters as is unique.
62 ;; `try-expand-all-abbrevs' : can be removed if you don't use abbrevs.
63 ;; Otherwise it looks through all abbrev-tables, starting with
64 ;; the local followed by the global.
65 ;; `try-expand-line' : Searches the buffer for an entire line that
66 ;; begins exactly as the current line. Convenient sometimes, for
67 ;; example as a substitute for (or complement to) the history
68 ;; list in shell-like buffers. At other times, only confusing.
69 ;; `try-expand-line-all-buffers' : Like `try-expand-line' but searches
70 ;; in all buffers (except the current). (This may be a little
71 ;; slow, don't use it unless you are really fond of `hippie-expand'.)
72 ;; `try-expand-list' : Tries to expand the text back to the nearest
73 ;; open delimiter, to a whole list from the buffer. Convenient for
74 ;; example when writing lisp or TeX.
75 ;; `try-expand-list-all-buffers' : Like `try-expand-list' but searches
76 ;; in all buffers (except the current).
77 ;; `try-expand-dabbrev' : works exactly as dabbrev-expand (but of
78 ;; course in a way compatible with the other try-functions).
79 ;; `try-expand-dabbrev-all-buffers' : perhaps the most useful of them,
80 ;; like `dabbrev-expand' but searches all Emacs buffers (except the
81 ;; current) for matching words. (No, I don't find this one
82 ;; particularly slow.)
83 ;; `try-expand-dabbrev-visible': Searches the currently visible parts of
84 ;; all windows. Can be put before `try-expand-dabbrev-all-buffers' to
85 ;; first try the expansions you can see.
86 ;; `try-expand-dabbrev-from-kill': Searches the kill ring for a suitable
87 ;; completion of the word. Good to have, just in case the word was not
88 ;; found elsewhere.
89 ;; `try-expand-whole-kill' : Tries to complete text with a whole entry
90 ;; from the kill ring. May be good if you don't know how far up in
91 ;; the kill-ring the required entry is, and don't want to mess with
92 ;; "Choose Next Paste".
93 ;; `try-complete-lisp-symbol' : like `lisp-complete-symbol', but goes
94 ;; through all possibilities instead of completing what is unique.
95 ;; Might be tedious (usually a lot of possible completions) and
96 ;; since its function is much like `lisp-complete-symbol', which
97 ;; already has a key of its own, you might want to remove this.
98 ;; `try-complete-lisp-symbol-partially' : To insert in the list just
99 ;; before `try-complete-lisp-symbol' for those who first want to get
100 ;; completion of what is unique in the name.
102 ;; Not all of the above functions are by default in
103 ;; `hippie-expand-try-functions-list'. This variable is better set
104 ;; in ".emacs" to make `hippie-expand' behave maximally convenient
105 ;; according to personal taste. Also, instead of loading the
106 ;; variable with all kinds of try-functions above, it might be an
107 ;; idea to use `make-hippie-expand-function' to construct different
108 ;; `hippie-expand'-like functions, with different try-lists and bound
109 ;; to different keys. It is also possible to make
110 ;; `hippie-expand-try-functions-list' a buffer local variable, and
111 ;; let it depend on the mode (by setting it in the mode-hooks).
113 ;; To write new try-functions, consider the following:
114 ;; Each try-function takes one argument OLD which is nil the first
115 ;; time the function is called and true in succeeding calls for the
116 ;; same string to complete. The first time the function has to
117 ;; extract the string before point to complete, and substitute the
118 ;; first completion alternative for it. On following calls it has to
119 ;; substitute the next possible completion for the last tried string.
120 ;; The try-function is to return t as long as it finds new
121 ;; possible completions. When there are no more alternatives it has
122 ;; to restore the text before point to its original contents, and
123 ;; return nil (don't beep or message or anything).
124 ;; The try-function can (should) use the following functions:
125 ;; `he-init-string' : Initializes the text to substitute to the
126 ;; contents of the region BEGIN to END. Also sets the variable
127 ;; `he-search-string' to the text to expand.
128 ;; `he-substitute-string' : substitutes STR into the region
129 ;; initialized with `he-init-string'. (An optional second argument
130 ;; TRANS-CASE non-nil, means transfer of case from the abbreviation
131 ;; to the expansion is ok if that is enabled in the buffer.)
132 ;; `he-reset-string' : Resets the initialized region to its original
133 ;; contents.
134 ;; There is also a variable: `he-tried-table' which is meant to contain
135 ;; all tried expansions so far. The try-function can check this
136 ;; variable to see whether an expansion has already been tried
137 ;; (hint: `he-string-member').
139 ;; Known bugs
141 ;; It may happen that some completion suggestion occurs twice, in
142 ;; spite of the use of `he-tried-table' to prevent that. This is
143 ;; because different try-functions may try to complete different
144 ;; lengths of text, and thus put different amounts of the
145 ;; text in `he-tried-table'. Anyway this seems to occur seldom enough
146 ;; not to be too disturbing. Also it should NOT be possible for the
147 ;; opposite situation to occur, that `hippie-expand' misses some
148 ;; suggestion because it thinks it has already tried it.
150 ;; Acknowledgement
152 ;; I want to thank Mikael Djurfeldt in discussions with whom the idea
153 ;; of this function took form.
154 ;; I am also grateful to all those who have given me suggestions on
155 ;; how to improve it, and all those who helped to find and remove bugs.
158 ;;; Code:
160 (defvar he-num -1)
162 (defvar he-string-beg (make-marker))
164 (defvar he-string-end (make-marker))
166 (defvar he-search-string ())
168 (defvar he-expand-list ())
170 (defvar he-tried-table ())
172 (defvar he-search-loc (make-marker))
174 (defvar he-search-loc2 ())
176 (defvar he-search-bw ())
178 (defvar he-search-bufs ())
180 (defvar he-searched-n-bufs ())
182 (defvar he-search-window ())
184 ;;;###autoload
185 (defvar hippie-expand-try-functions-list '(try-complete-file-name-partially
186 try-complete-file-name
187 try-expand-all-abbrevs
188 try-expand-list
189 try-expand-line
190 try-expand-dabbrev
191 try-expand-dabbrev-all-buffers
192 try-expand-dabbrev-from-kill
193 try-complete-lisp-symbol-partially
194 try-complete-lisp-symbol)
195 "The list of expansion functions tried in order by `hippie-expand'.
196 To change the behavior of `hippie-expand', remove, change the order of,
197 or insert functions in this list.")
199 ;;;###autoload
200 (defvar hippie-expand-verbose t
201 "*Non-nil makes `hippie-expand' output which function it is trying.")
203 ;;;###autoload
204 (defvar hippie-expand-max-buffers ()
205 "*The maximum number of buffers (apart from the current) searched.
206 If nil, all buffers are searched.")
208 ;;;###autoload
209 (defvar hippie-expand-ignore-buffers '("^ \\*.*\\*$" dired-mode)
210 "*A list specifying which buffers not to search (if not current).
211 Can contain both regexps matching buffer names (as strings) and major modes
212 \(as atoms)")
214 ;;;###autoload
215 (defun hippie-expand (arg)
216 "Try to expand text before point, using multiple methods.
217 The expansion functions in `hippie-expand-try-functions-list' are
218 tried in order, until a possible expansion is found. Repeated
219 application of `hippie-expand' inserts successively possible
220 expansions.
221 With a positive numeric argument, jumps directly to the ARG next
222 function in this list. With a negative argument or just \\[universal-argument],
223 undoes the expansion."
224 (interactive "P")
225 (if (or (not arg)
226 (and (integerp arg) (> arg 0)))
227 (let ((first (or (= he-num -1)
228 (not (equal this-command last-command)))))
229 (if first
230 (progn
231 (setq he-num -1)
232 (setq he-tried-table nil)))
233 (if arg
234 (if (not first) (he-reset-string))
235 (setq arg 0))
236 (let ((i (max (+ he-num arg) 0)))
237 (while (not (or (>= i (length hippie-expand-try-functions-list))
238 (apply (nth i hippie-expand-try-functions-list)
239 (list (= he-num i)))))
240 (setq i (1+ i)))
241 (setq he-num i))
242 (if (>= he-num (length hippie-expand-try-functions-list))
243 (progn
244 (setq he-num -1)
245 (if first
246 (message "No expansion found")
247 (message "No further expansions found"))
248 (ding))
249 (if (and hippie-expand-verbose
250 (not (window-minibuffer-p (selected-window))))
251 (message "Using %s"
252 (prin1-to-string (nth he-num
253 hippie-expand-try-functions-list))))))
254 (if (and (>= he-num 0)
255 (eq (marker-buffer he-string-beg) (current-buffer)))
256 (progn
257 (setq he-num -1)
258 (he-reset-string)
259 (if (and hippie-expand-verbose
260 (not (window-minibuffer-p (selected-window))))
261 (message "Undoing expansions"))))))
263 ;; Initializes the region to expand (to between BEG and END).
264 (defun he-init-string (beg end)
265 (set-marker he-string-beg beg)
266 (set-marker he-string-end end)
267 (setq he-search-string (buffer-substring beg end)))
269 ;; Resets the expanded region to its original contents.
270 (defun he-reset-string ()
271 (let ((newpos (point-marker)))
272 (goto-char he-string-beg)
273 (insert he-search-string)
274 (delete-region (point) he-string-end)
275 (goto-char newpos)))
277 ;; Substitutes an expansion STR into the correct region (the region
278 ;; initialized with `he-init-string').
279 ;; An optional argument TRANS-CASE means that it is ok to transfer case
280 ;; from the abbreviation to the expansion if that is possible, and is
281 ;; enabled in the buffer.
282 (defun he-substitute-string (str &optional trans-case)
283 (let ((trans-case (and trans-case
284 case-replace
285 case-fold-search))
286 (newpos (point-marker))
287 (subst ()))
288 (goto-char he-string-beg)
289 (setq subst (if trans-case (he-transfer-case he-search-string str) str))
290 (setq he-tried-table (cons subst he-tried-table))
291 (insert subst)
292 (delete-region (point) he-string-end)
293 (goto-char newpos)))
295 (defun he-capitalize-first (str)
296 (save-match-data
297 (if (string-match "\\Sw*\\(\\sw\\).*" str)
298 (let ((res (downcase str))
299 (no (match-beginning 1)))
300 (aset res no (upcase (aref str no)))
301 res)
302 str)))
304 (defun he-ordinary-case-p (str)
305 (or (string= str (downcase str))
306 (string= str (upcase str))
307 (string= str (capitalize str))
308 (string= str (he-capitalize-first str))))
310 (defun he-transfer-case (from-str to-str)
311 (cond ((string= from-str (substring to-str 0 (min (length from-str)
312 (length to-str))))
313 to-str)
314 ((not (he-ordinary-case-p to-str))
315 to-str)
316 ((string= from-str (downcase from-str))
317 (downcase to-str))
318 ((string= from-str (upcase from-str))
319 (upcase to-str))
320 ((string= from-str (he-capitalize-first from-str))
321 (he-capitalize-first to-str))
322 ((string= from-str (capitalize from-str))
323 (capitalize to-str))
325 to-str)))
328 ;; Check if STR is a member of LST.
329 ;; Transform to the final case if optional TRANS-CASE is non-NIL.
330 (defun he-string-member (str lst &optional trans-case)
331 (if str
332 (member (if (and trans-case
333 case-replace
334 case-fold-search)
335 (he-transfer-case he-search-string str)
336 str)
337 lst)))
339 ;; Check if STR matches any regexp in LST.
340 ;; Ignore possible non-strings in LST.
341 (defun he-regexp-member (str lst)
342 (while (and lst
343 (or (not (stringp (car lst)))
344 (not (string-match (car lst) str))))
345 (setq lst (cdr lst)))
346 lst)
348 ;; For the real hippie-expand enthusiast: A macro that makes it
349 ;; possible to use many functions like hippie-expand, but with
350 ;; different try-functions-lists.
351 ;; Usage is for example:
352 ;; (fset 'my-complete-file (make-hippie-expand-function
353 ;; '(try-complete-file-name-partially
354 ;; try-complete-file-name)))
355 ;; (fset 'my-complete-line (make-hippie-expand-function
356 ;; '(try-expand-line
357 ;; try-expand-line-all-buffers)))
359 ;;;###autoload
360 (defmacro make-hippie-expand-function (try-list &optional verbose)
361 "Construct a function similar to `hippie-expand'.
362 Make it use the expansion functions in TRY-LIST. An optional second
363 argument VERBOSE non-nil makes the function verbose."
364 (` (function (lambda (arg)
365 (, (concat
366 "Try to expand text before point, using the following functions: \n"
367 (mapconcat 'prin1-to-string (eval try-list) ", ")))
368 (interactive "P")
369 (let ((hippie-expand-try-functions-list (, try-list))
370 (hippie-expand-verbose (, verbose)))
371 (hippie-expand arg))))))
374 ;;; Here follows the try-functions and their requisites:
377 (defun try-complete-file-name (old)
378 "Try to complete text as a file name.
379 The argument OLD has to be nil the first call of this function, and t
380 for subsequent calls (for further possible completions of the same
381 string). It returns t if a new completion is found, nil otherwise."
382 (if (not old)
383 (progn
384 (he-init-string (he-file-name-beg) (point))
385 (let ((name-part (he-file-name-nondirectory he-search-string))
386 (dir-part (expand-file-name (or (he-file-name-directory
387 he-search-string) ""))))
388 (if (not (he-string-member name-part he-tried-table))
389 (setq he-tried-table (cons name-part he-tried-table)))
390 (if (and (not (equal he-search-string ""))
391 (he-file-directory-p dir-part))
392 (setq he-expand-list (sort (file-name-all-completions
393 name-part
394 dir-part)
395 'string-lessp))
396 (setq he-expand-list ())))))
398 (while (and he-expand-list
399 (he-string-member (car he-expand-list) he-tried-table))
400 (setq he-expand-list (cdr he-expand-list)))
401 (if (null he-expand-list)
402 (progn
403 (if old (he-reset-string))
405 (let ((filename (he-concat-directory-file-name
406 (he-file-name-directory he-search-string)
407 (car he-expand-list))))
408 (he-substitute-string filename)
409 (setq he-tried-table (cons (car he-expand-list) (cdr he-tried-table)))
410 (setq he-expand-list (cdr he-expand-list))
411 t)))
413 (defun try-complete-file-name-partially (old)
414 "Try to complete text as a file name, as many characters as unique.
415 The argument OLD has to be nil the first call of this function. It
416 returns t if a unique, possibly partial, completion is found, nil
417 otherwise."
418 (let ((expansion ()))
419 (if (not old)
420 (progn
421 (he-init-string (he-file-name-beg) (point))
422 (let ((name-part (he-file-name-nondirectory he-search-string))
423 (dir-part (expand-file-name (or (he-file-name-directory
424 he-search-string) ""))))
425 (if (and (not (equal he-search-string ""))
426 (he-file-directory-p dir-part))
427 (setq expansion (file-name-completion name-part
428 dir-part)))
429 (if (or (eq expansion t)
430 (string= expansion name-part)
431 (he-string-member expansion he-tried-table))
432 (setq expansion ())))))
434 (if (not expansion)
435 (progn
436 (if old (he-reset-string))
438 (let ((filename (he-concat-directory-file-name
439 (he-file-name-directory he-search-string)
440 expansion)))
441 (he-substitute-string filename)
442 (setq he-tried-table (cons expansion (cdr he-tried-table)))
443 t))))
445 (defvar he-file-name-chars
446 (cond ((memq system-type '(vax-vms axp-vms))
447 "-a-zA-Z0-9_/.,~^#$+=:\\[\\]")
448 ((memq system-type '(ms-dos windows-nt))
449 "-a-zA-Z0-9_/.,~^#$+=:\\\\")
450 (t ;; More strange file formats ?
451 "-a-zA-Z0-9_/.,~^#$+="))
452 "Characters that are considered part of the file name to expand.")
454 (defun he-file-name-beg ()
455 (save-excursion
456 (skip-chars-backward he-file-name-chars)
457 (point)))
459 ;; Thanks go to Richard Levitte <levitte@e.kth.se> who helped to make these
460 ;; work under VMS, and to David Hughes <ukchugd@ukpmr.cs.philips.nl> who
461 ;; helped to make it work on PC.
462 (defun he-file-name-nondirectory (file)
463 "Fix to make `file-name-nondirectory' work for hippie-expand under VMS."
464 (if (memq system-type '(axp-vms vax-vms))
465 (let ((n (file-name-nondirectory file)))
466 (if (string-match "^\\(\\[.*\\)\\.\\([^\\.]*\\)$" n)
467 (concat "[." (substring n (match-beginning 2) (match-end 2)))
469 (file-name-nondirectory file)))
471 (defun he-file-name-directory (file)
472 "Fix to make `file-name-directory' work for hippie-expand under VMS."
473 (if (memq system-type '(axp-vms vax-vms))
474 (let ((n (file-name-nondirectory file))
475 (d (file-name-directory file)))
476 (if (string-match "^\\(\\[.*\\)\\.\\([^\\.]*\\)$" n)
477 (concat d (substring n (match-beginning 1) (match-end 1)) "]")
479 (file-name-directory file)))
481 (defun he-file-directory-p (file)
482 "Fix to make `file-directory-p' work for hippie-expand under VMS."
483 (if (memq system-type '(vax-vms axp-vms))
484 (or (file-directory-p file)
485 (file-directory-p (concat file "[000000]")))
486 (file-directory-p file)))
488 (defun he-concat-directory-file-name (dir-part name-part)
489 "Try to slam together two parts of a file specification, system dependently."
490 (cond ((null dir-part) name-part)
491 ((memq system-type '(axp-vms vax-vms))
492 (if (and (string= (substring dir-part -1) "]")
493 (string= (substring name-part 0 2) "[."))
494 (concat (substring dir-part 0 -1) (substring name-part 1))
495 (concat dir-part name-part)))
496 ((memq system-type '(ms-dos ms-windows))
497 (if (and (string-match "\\\\" dir-part)
498 (not (string-match "/" dir-part))
499 (= (aref name-part (1- (length name-part))) ?/))
500 (aset name-part (1- (length name-part)) ?\\))
501 (concat dir-part name-part))
503 (concat dir-part name-part))))
505 (defun try-complete-lisp-symbol (old)
506 "Try to complete word as an Emacs Lisp symbol.
507 The argument OLD has to be nil the first call of this function, and t
508 for subsequent calls (for further possible completions of the same
509 string). It returns t if a new completion is found, nil otherwise."
510 (if (not old)
511 (progn
512 (he-init-string (he-lisp-symbol-beg) (point))
513 (if (not (he-string-member he-search-string he-tried-table))
514 (setq he-tried-table (cons he-search-string he-tried-table)))
515 (setq he-expand-list
516 (and (not (equal he-search-string ""))
517 (sort (all-completions he-search-string obarray
518 (function (lambda (sym)
519 (or (boundp sym)
520 (fboundp sym)
521 (symbol-plist sym)))))
522 'string-lessp)))))
523 (while (and he-expand-list
524 (he-string-member (car he-expand-list) he-tried-table))
525 (setq he-expand-list (cdr he-expand-list)))
526 (if (null he-expand-list)
527 (progn
528 (if old (he-reset-string))
530 (progn
531 (he-substitute-string (car he-expand-list))
532 (setq he-expand-list (cdr he-expand-list))
533 t)))
535 (defun try-complete-lisp-symbol-partially (old)
536 "Try to complete as an Emacs Lisp symbol, as many characters as unique.
537 The argument OLD has to be nil the first call of this function. It
538 returns t if a unique, possibly partial, completion is found, nil
539 otherwise."
540 (let ((expansion ()))
541 (if (not old)
542 (progn
543 (he-init-string (he-lisp-symbol-beg) (point))
544 (if (not (string= he-search-string ""))
545 (setq expansion
546 (try-completion he-search-string obarray
547 (function (lambda (sym)
548 (or (boundp sym)
549 (fboundp sym)
550 (symbol-plist sym)))))))
551 (if (or (eq expansion t)
552 (string= expansion he-search-string)
553 (he-string-member expansion he-tried-table))
554 (setq expansion ()))))
556 (if (not expansion)
557 (progn
558 (if old (he-reset-string))
560 (progn
561 (he-substitute-string expansion)
562 t))))
564 (defun he-lisp-symbol-beg ()
565 (let ((skips "-a-zA-Z0-9_."))
566 (save-excursion
567 (skip-chars-backward skips)
568 (point))))
570 (defun try-expand-line (old)
571 "Try to complete the current line to an entire line in the buffer.
572 The argument OLD has to be nil the first call of this function, and t
573 for subsequent calls (for further possible completions of the same
574 string). It returns t if a new completion is found, nil otherwise."
575 (let ((expansion ())
576 (strip-prompt (and (get-buffer-process (current-buffer))
577 comint-prompt-regexp)))
578 (if (not old)
579 (progn
580 (he-init-string (he-line-beg strip-prompt) (point))
581 (set-marker he-search-loc he-string-beg)
582 (setq he-search-bw t)))
584 (if (not (equal he-search-string ""))
585 (save-excursion
586 ;; Try looking backward unless inhibited.
587 (if he-search-bw
588 (progn
589 (goto-char he-search-loc)
590 (setq expansion (he-line-search he-search-string
591 strip-prompt t))
592 (set-marker he-search-loc (point))
593 (if (not expansion)
594 (progn
595 (set-marker he-search-loc he-string-end)
596 (setq he-search-bw ())))))
598 (if (not expansion) ; Then look forward.
599 (progn
600 (goto-char he-search-loc)
601 (setq expansion (he-line-search he-search-string
602 strip-prompt nil))
603 (set-marker he-search-loc (point))))))
605 (if (not expansion)
606 (progn
607 (if old (he-reset-string))
609 (progn
610 (he-substitute-string expansion t)
611 t))))
613 (defun try-expand-line-all-buffers (old)
614 "Try to complete the current line, searching all other buffers.
615 The argument OLD has to be nil the first call of this function, and t
616 for subsequent calls (for further possible completions of the same
617 string). It returns t if a new completion is found, nil otherwise."
618 (let ((expansion ())
619 (strip-prompt (and (get-buffer-process (current-buffer))
620 comint-prompt-regexp))
621 (buf (current-buffer))
622 (orig-case-fold-search case-fold-search))
623 (if (not old)
624 (progn
625 (he-init-string (he-line-beg strip-prompt) (point))
626 (setq he-search-bufs (buffer-list))
627 (setq he-searched-n-bufs 0)
628 (set-marker he-search-loc 1 (car he-search-bufs))))
630 (if (not (equal he-search-string ""))
631 (while (and he-search-bufs
632 (not expansion)
633 (or (not hippie-expand-max-buffers)
634 (< he-searched-n-bufs hippie-expand-max-buffers)))
635 (set-buffer (car he-search-bufs))
636 (if (and (not (eq (current-buffer) buf))
637 (not (memq major-mode hippie-expand-ignore-buffers))
638 (not (he-regexp-member (buffer-name)
639 hippie-expand-ignore-buffers)))
640 (save-excursion
641 (goto-char he-search-loc)
642 (setq strip-prompt (and (get-buffer-process (current-buffer))
643 comint-prompt-regexp))
644 (setq expansion (let ((case-fold-search orig-case-fold-search))
645 (he-line-search he-search-string
646 strip-prompt nil)))
647 (set-marker he-search-loc (point))
648 (if (not expansion)
649 (progn
650 (setq he-search-bufs (cdr he-search-bufs))
651 (setq he-searched-n-bufs (1+ he-searched-n-bufs))
652 (set-marker he-search-loc 1 (car he-search-bufs)))))
653 (setq he-search-bufs (cdr he-search-bufs))
654 (set-marker he-search-loc 1 (car he-search-bufs)))))
656 (set-buffer buf)
657 (if (not expansion)
658 (progn
659 (if old (he-reset-string))
661 (progn
662 (he-substitute-string expansion t)
663 t))))
665 (defun he-line-search (str strip-prompt reverse)
666 (let ((result ()))
667 (while (and (not result)
668 (if reverse
669 (re-search-backward
670 (he-line-search-regexp str strip-prompt)
671 nil t)
672 (re-search-forward
673 (he-line-search-regexp str strip-prompt)
674 nil t)))
675 (setq result (buffer-substring (match-beginning 2) (match-end 2)))
676 (if (he-string-member result he-tried-table t)
677 (setq result nil))) ; if already in table, ignore
678 result))
680 (defun he-line-beg (strip-prompt)
681 (save-excursion
682 (if (re-search-backward (he-line-search-regexp "" strip-prompt)
683 (save-excursion (beginning-of-line)
684 (point)) t)
685 (match-beginning 2)
686 (point))))
688 (defun he-line-search-regexp (pat strip-prompt)
689 (if strip-prompt
690 (concat "\\(" comint-prompt-regexp "\\|^\\s-*\\)\\("
691 (regexp-quote pat)
692 "[^\n]*[^ \t\n]\\)")
693 (concat "^\\(\\s-*\\)\\("
694 (regexp-quote pat)
695 "[^\n]*[^ \t\n]\\)")))
697 (defun try-expand-list (old)
698 "Try to complete the current beginning of a list.
699 The argument OLD has to be nil the first call of this function, and t
700 for subsequent calls (for further possible completions of the same
701 string). It returns t if a new completion is found, nil otherwise."
702 (let ((expansion ()))
703 (if (not old)
704 (progn
705 (he-init-string (he-list-beg) (point))
706 (set-marker he-search-loc he-string-beg)
707 (setq he-search-bw t)))
709 (if (not (equal he-search-string ""))
710 (save-excursion
711 ;; Try looking backward unless inhibited.
712 (if he-search-bw
713 (progn
714 (goto-char he-search-loc)
715 (setq expansion (he-list-search he-search-string t))
716 (set-marker he-search-loc (point))
717 (if (not expansion)
718 (progn
719 (set-marker he-search-loc he-string-end)
720 (setq he-search-bw ())))))
722 (if (not expansion) ; Then look forward.
723 (progn
724 (goto-char he-search-loc)
725 (setq expansion (he-list-search he-search-string nil))
726 (set-marker he-search-loc (point))))))
728 (if (not expansion)
729 (progn
730 (if old (he-reset-string))
732 (progn
733 (he-substitute-string expansion t)
734 t))))
736 (defun try-expand-list-all-buffers (old)
737 "Try to complete the current list, searching all other buffers.
738 The argument OLD has to be nil the first call of this function, and t
739 for subsequent calls (for further possible completions of the same
740 string). It returns t if a new completion is found, nil otherwise."
741 (let ((expansion ())
742 (buf (current-buffer))
743 (orig-case-fold-search case-fold-search))
744 (if (not old)
745 (progn
746 (he-init-string (he-list-beg) (point))
747 (setq he-search-bufs (buffer-list))
748 (setq he-searched-n-bufs 0)
749 (set-marker he-search-loc 1 (car he-search-bufs))))
751 (if (not (equal he-search-string ""))
752 (while (and he-search-bufs
753 (not expansion)
754 (or (not hippie-expand-max-buffers)
755 (< he-searched-n-bufs hippie-expand-max-buffers)))
756 (set-buffer (car he-search-bufs))
757 (if (and (not (eq (current-buffer) buf))
758 (not (memq major-mode hippie-expand-ignore-buffers))
759 (not (he-regexp-member (buffer-name)
760 hippie-expand-ignore-buffers)))
761 (save-excursion
762 (goto-char he-search-loc)
763 (setq expansion (let ((case-fold-search orig-case-fold-search))
764 (he-list-search he-search-string nil)))
765 (set-marker he-search-loc (point))
766 (if (not expansion)
767 (progn
768 (setq he-search-bufs (cdr he-search-bufs))
769 (setq he-searched-n-bufs (1+ he-searched-n-bufs))
770 (set-marker he-search-loc 1 (car he-search-bufs)))))
771 (setq he-search-bufs (cdr he-search-bufs))
772 (set-marker he-search-loc 1 (car he-search-bufs)))))
774 (set-buffer buf)
775 (if (not expansion)
776 (progn
777 (if old (he-reset-string))
779 (progn
780 (he-substitute-string expansion t)
781 t))))
783 (defun he-list-search (str reverse)
784 (let ((result ())
785 beg pos err)
786 (while (and (not result)
787 (if reverse
788 (search-backward str nil t)
789 (search-forward str nil t)))
790 (setq pos (point))
791 (setq beg (match-beginning 0))
792 (goto-char beg)
793 (setq err ())
794 (condition-case ()
795 (forward-list 1)
796 (error (setq err t)))
797 (if (and reverse
798 (> (point) he-string-beg))
799 (setq err t))
800 (if (not err)
801 (progn
802 (setq result (buffer-substring beg (point)))
803 (if (he-string-member result he-tried-table t)
804 (setq result nil)))) ; if already in table, ignore
805 (goto-char pos))
806 result))
808 (defun he-list-beg ()
809 (save-excursion
810 (condition-case ()
811 (backward-up-list 1)
812 (error ()))
813 (point)))
815 (defun try-expand-all-abbrevs (old)
816 "Try to expand word before point according to all abbrev tables.
817 The argument OLD has to be nil the first call of this function, and t
818 for subsequent calls (for further possible expansions of the same
819 string). It returns t if a new expansion is found, nil otherwise."
820 (if (not old)
821 (progn
822 (he-init-string (he-dabbrev-beg) (point))
823 (setq he-expand-list
824 (and (not (equal he-search-string ""))
825 (mapcar (function (lambda (sym)
826 (if (and (boundp sym) (vectorp (eval sym)))
827 (abbrev-expansion (downcase he-search-string)
828 (eval sym)))))
829 (append '(local-abbrev-table
830 global-abbrev-table)
831 abbrev-table-name-list))))))
832 (while (and he-expand-list
833 (or (not (car he-expand-list))
834 (he-string-member (car he-expand-list) he-tried-table t)))
835 (setq he-expand-list (cdr he-expand-list)))
836 (if (null he-expand-list)
837 (progn
838 (if old (he-reset-string))
840 (progn
841 (he-substitute-string (car he-expand-list) t)
842 (setq he-expand-list (cdr he-expand-list))
843 t)))
845 (defun try-expand-dabbrev (old)
846 "Try to expand word \"dynamically\", searching the current buffer.
847 The argument OLD has to be nil the first call of this function, and t
848 for subsequent calls (for further possible expansions of the same
849 string). It returns t if a new expansion is found, nil otherwise."
850 (let ((expansion ()))
851 (if (not old)
852 (progn
853 (he-init-string (he-dabbrev-beg) (point))
854 (set-marker he-search-loc he-string-beg)
855 (setq he-search-bw t)))
857 (if (not (equal he-search-string ""))
858 (save-excursion
859 ;; Try looking backward unless inhibited.
860 (if he-search-bw
861 (progn
862 (goto-char he-search-loc)
863 (setq expansion (he-dabbrev-search he-search-string t))
864 (set-marker he-search-loc (point))
865 (if (not expansion)
866 (progn
867 (set-marker he-search-loc he-string-end)
868 (setq he-search-bw ())))))
870 (if (not expansion) ; Then look forward.
871 (progn
872 (goto-char he-search-loc)
873 (setq expansion (he-dabbrev-search he-search-string nil))
874 (set-marker he-search-loc (point))))))
876 (if (not expansion)
877 (progn
878 (if old (he-reset-string))
880 (progn
881 (he-substitute-string expansion t)
882 t))))
884 (defun try-expand-dabbrev-all-buffers (old)
885 "Tries to expand word \"dynamically\", searching all other buffers.
886 The argument OLD has to be nil the first call of this function, and t
887 for subsequent calls (for further possible expansions of the same
888 string). It returns t if a new expansion is found, nil otherwise."
889 (let ((expansion ())
890 (buf (current-buffer))
891 (orig-case-fold-search case-fold-search))
892 (if (not old)
893 (progn
894 (he-init-string (he-dabbrev-beg) (point))
895 (setq he-search-bufs (buffer-list))
896 (setq he-searched-n-bufs 0)
897 (set-marker he-search-loc 1 (car he-search-bufs))))
899 (if (not (equal he-search-string ""))
900 (while (and he-search-bufs
901 (not expansion)
902 (or (not hippie-expand-max-buffers)
903 (< he-searched-n-bufs hippie-expand-max-buffers)))
904 (set-buffer (car he-search-bufs))
905 (if (and (not (eq (current-buffer) buf))
906 (not (memq major-mode hippie-expand-ignore-buffers))
907 (not (he-regexp-member (buffer-name)
908 hippie-expand-ignore-buffers)))
909 (save-excursion
910 (goto-char he-search-loc)
911 (setq expansion (let ((case-fold-search orig-case-fold-search))
912 (he-dabbrev-search he-search-string nil)))
913 (set-marker he-search-loc (point))
914 (if (not expansion)
915 (progn
916 (setq he-search-bufs (cdr he-search-bufs))
917 (setq he-searched-n-bufs (1+ he-searched-n-bufs))
918 (set-marker he-search-loc 1 (car he-search-bufs)))))
919 (setq he-search-bufs (cdr he-search-bufs))
920 (set-marker he-search-loc 1 (car he-search-bufs)))))
922 (set-buffer buf)
923 (if (not expansion)
924 (progn
925 (if old (he-reset-string))
927 (progn
928 (he-substitute-string expansion t)
929 t))))
931 ;; Thanks go to Jeff Dairiki <dairiki@faraday.apl.washington.edu> who
932 ;; suggested this one.
933 (defun try-expand-dabbrev-visible (old)
934 "Try to expand word \"dynamically\", searching visible window parts.
935 The argument OLD has to be nil the first call of this function, and t
936 for subsequent calls (for further possible expansions of the same
937 string). It returns t if a new expansion is found, nil otherwise."
938 (let ((expansion ())
939 (buf (current-buffer))
940 (flag (if (frame-visible-p (window-frame (selected-window)))
941 'visible t)))
942 (if (not old)
943 (progn
944 (he-init-string (he-dabbrev-beg) (point))
945 (setq he-search-window (selected-window))
946 (set-marker he-search-loc
947 (window-start he-search-window)
948 (window-buffer he-search-window))))
950 (while (and (not (equal he-search-string ""))
951 (marker-position he-search-loc)
952 (not expansion))
953 (save-excursion
954 (set-buffer (marker-buffer he-search-loc))
955 (goto-char he-search-loc)
956 (setq expansion (he-dabbrev-search he-search-string ()
957 (window-end he-search-window)))
958 (if (and expansion
959 (eq (marker-buffer he-string-beg) (current-buffer))
960 (eq (marker-position he-string-beg) (match-beginning 0)))
961 (setq expansion (he-dabbrev-search he-search-string ()
962 (window-end he-search-window))))
963 (set-marker he-search-loc (point) (current-buffer)))
964 (if (not expansion)
965 (progn
966 (setq he-search-window (next-window he-search-window nil flag))
967 (if (eq he-search-window (selected-window))
968 (set-marker he-search-loc nil)
969 (set-marker he-search-loc (window-start he-search-window)
970 (window-buffer he-search-window))))))
972 (set-buffer buf)
973 (if (not expansion)
974 (progn
975 (if old (he-reset-string))
977 (progn
978 (he-substitute-string expansion t)
979 t))))
981 (defun he-dabbrev-search (pattern &optional reverse limit)
982 (let ((result ())
983 (regpat (if (eq (char-syntax (aref pattern 0)) ?_)
984 (concat (regexp-quote pattern) "\\(\\sw\\|\\s_\\)+")
985 (concat "\\<" (regexp-quote pattern) "\\(\\sw\\|\\s_\\)+"))))
986 (while (and (not result)
987 (if reverse
988 (re-search-backward regpat limit t)
989 (re-search-forward regpat limit t)))
990 (setq result (buffer-substring (match-beginning 0) (match-end 0)))
991 (if (or (and (> (match-beginning 0) (point-min))
992 (memq (char-syntax (char-after (1- (match-beginning 0))))
993 '(?_ ?w)))
994 (he-string-member result he-tried-table t))
995 (setq result nil))) ; ignore if bad prefix or already in table
996 result))
998 (defvar he-dabbrev-skip-space ()
999 "Non-NIL means tolerate trailing spaces in the abbreviation to expand.")
1001 (defun he-dabbrev-beg ()
1002 (let ((op (point)))
1003 (save-excursion
1004 (if he-dabbrev-skip-space
1005 (skip-syntax-backward ". "))
1006 (if (= (skip-syntax-backward "w_") 0)
1008 (point)))))
1010 (defun try-expand-dabbrev-from-kill (old)
1011 "Try to expand word \"dynamically\", searching the kill ring.
1012 The argument OLD has to be nil the first call of this function, and t
1013 for subsequent calls (for further possible completions of the same
1014 string). It returns t if a new completion is found, nil otherwise."
1015 (let ((expansion ()))
1016 (if (not old)
1017 (progn
1018 (he-init-string (he-dabbrev-beg) (point))
1019 (setq he-expand-list
1020 (if (not (equal he-search-string ""))
1021 kill-ring))
1022 (setq he-search-loc2 0)))
1023 (if (not (equal he-search-string ""))
1024 (setq expansion (he-dabbrev-kill-search he-search-string)))
1025 (if (not expansion)
1026 (progn
1027 (if old (he-reset-string))
1029 (progn
1030 (he-substitute-string expansion t)
1031 t))))
1033 (defun he-dabbrev-kill-search (pattern)
1034 (let ((result ())
1035 (regpat (if (eq (char-syntax (aref pattern 0)) ?_)
1036 (concat (regexp-quote pattern) "\\(\\sw\\|\\s_\\)+")
1037 (concat "\\<" (regexp-quote pattern) "\\(\\sw\\|\\s_\\)+")))
1038 (killstr (car he-expand-list)))
1039 (while (and (not result)
1040 he-expand-list)
1041 (while (and (not result)
1042 (string-match regpat killstr he-search-loc2))
1043 (setq result (substring killstr (match-beginning 0) (match-end 0)))
1044 (setq he-search-loc2 (1+ (match-beginning 0)))
1045 (if (or (and (> (match-beginning 0) 0)
1046 (memq (char-syntax (aref killstr (1- (match-beginning 0))))
1047 '(?_ ?w)))
1048 (he-string-member result he-tried-table t))
1049 (setq result nil))) ; ignore if bad prefix or already in table
1050 (if (and (not result)
1051 he-expand-list)
1052 (progn
1053 (setq he-expand-list (cdr he-expand-list))
1054 (setq killstr (car he-expand-list))
1055 (setq he-search-loc2 0))))
1056 result))
1058 (defun try-expand-whole-kill (old)
1059 "Try to complete text with something from the kill ring.
1060 The argument OLD has to be nil the first call of this function, and t
1061 for subsequent calls (for further possible completions of the same
1062 string). It returns t if a new completion is found, nil otherwise."
1063 (let ((expansion ()))
1064 (if (not old)
1065 (progn
1066 (he-init-string (he-kill-beg) (point))
1067 (if (not (he-string-member he-search-string he-tried-table))
1068 (setq he-tried-table (cons he-search-string he-tried-table)))
1069 (setq he-expand-list
1070 (if (not (equal he-search-string ""))
1071 kill-ring))
1072 (setq he-search-loc2 ())))
1073 (if (not (equal he-search-string ""))
1074 (setq expansion (he-whole-kill-search he-search-string)))
1075 (if (not expansion)
1076 (progn
1077 (if old (he-reset-string))
1079 (progn
1080 (he-substitute-string expansion)
1081 t))))
1083 (defun he-whole-kill-search (str)
1084 (let ((case-fold-search ())
1085 (result ())
1086 (str (regexp-quote str))
1087 (killstr (car he-expand-list))
1088 (pos -1))
1089 (while (and (not result)
1090 he-expand-list)
1091 (if (not he-search-loc2)
1092 (while (setq pos (string-match str killstr (1+ pos)))
1093 (setq he-search-loc2 (cons pos he-search-loc2))))
1094 (while (and (not result)
1095 he-search-loc2)
1096 (setq pos (car he-search-loc2))
1097 (setq he-search-loc2 (cdr he-search-loc2))
1098 (save-excursion
1099 (goto-char he-string-beg)
1100 (if (and (>= (- (point) pos) (point-min)) ; avoid some string GC
1101 (eq (char-after (- (point) pos)) (aref killstr 0))
1102 (search-backward (substring killstr 0 pos)
1103 (- (point) pos) t))
1104 (setq result (substring killstr pos))))
1105 (if (and result
1106 (he-string-member result he-tried-table))
1107 (setq result nil))) ; ignore if already in table
1108 (if (and (not result)
1109 he-expand-list)
1110 (progn
1111 (setq he-expand-list (cdr he-expand-list))
1112 (setq killstr (car he-expand-list))
1113 (setq pos -1))))
1114 result))
1116 (defun he-kill-beg ()
1117 (let ((op (point)))
1118 (save-excursion
1119 (skip-syntax-backward "^w_")
1120 (if (= (skip-syntax-backward "w_") 0)
1122 (point)))))
1125 (provide 'hippie-exp)
1127 ;;; hippie-exp.el ends here