1 ;;; lisp.el --- Lisp editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1994, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
7 ;; Keywords: lisp, languages
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; Lisp editing commands to go with Lisp major mode. More-or-less
29 ;; applicable in other modes too.
33 ;; Note that this variable is used by non-lisp modes too.
34 (defcustom defun-prompt-regexp nil
35 "*If non-nil, a regexp to ignore before a defun.
36 This is only necessary if the opening paren or brace is not in column 0.
37 See function `beginning-of-defun'."
38 :type
'(choice (const nil
)
41 (make-variable-buffer-local 'defun-prompt-regexp
)
43 (defcustom parens-require-spaces t
44 "If non-nil, `insert-parentheses' inserts whitespace as needed."
48 (defvar forward-sexp-function nil
49 "If non-nil, `forward-sexp' delegates to this function.
50 Should take the same arguments and behave similarly to `forward-sexp'.")
52 (defun forward-sexp (&optional arg
)
53 "Move forward across one balanced expression (sexp).
54 With ARG, do it that many times. Negative arg -N means
55 move backward across N balanced expressions."
58 (if forward-sexp-function
59 (funcall forward-sexp-function arg
)
60 (goto-char (or (scan-sexps (point) arg
) (buffer-end arg
)))
61 (if (< arg
0) (backward-prefix-chars))))
63 (defun backward-sexp (&optional arg
)
64 "Move backward across one balanced expression (sexp).
65 With ARG, do it that many times. Negative arg -N means
66 move forward across N balanced expressions."
69 (forward-sexp (- arg
)))
71 (defun mark-sexp (&optional arg allow-extend
)
72 "Set mark ARG sexps from point.
73 The place mark goes is the same place \\[forward-sexp] would
74 move to with the same argument.
75 Interactively, if this command is repeated
76 or (in Transient Mark mode) if the mark is active,
77 it marks the next ARG sexps after the ones already marked."
79 (cond ((and allow-extend
80 (or (and (eq last-command this-command
) (mark t
))
81 (and transient-mark-mode mark-active
)))
82 (setq arg
(if arg
(prefix-numeric-value arg
)
83 (if (< (mark) (point)) -
1 1)))
92 (forward-sexp (prefix-numeric-value arg
))
96 (defun forward-list (&optional arg
)
97 "Move forward across one balanced group of parentheses.
98 With ARG, do it that many times.
99 Negative arg -N means move backward across N groups of parentheses."
101 (or arg
(setq arg
1))
102 (goto-char (or (scan-lists (point) arg
0) (buffer-end arg
))))
104 (defun backward-list (&optional arg
)
105 "Move backward across one balanced group of parentheses.
106 With ARG, do it that many times.
107 Negative arg -N means move forward across N groups of parentheses."
109 (or arg
(setq arg
1))
110 (forward-list (- arg
)))
112 (defun down-list (&optional arg
)
113 "Move forward down one level of parentheses.
114 With ARG, do this that many times.
115 A negative argument means move backward but still go down a level."
117 (or arg
(setq arg
1))
118 (let ((inc (if (> arg
0) 1 -
1)))
120 (goto-char (or (scan-lists (point) inc -
1) (buffer-end arg
)))
121 (setq arg
(- arg inc
)))))
123 (defun backward-up-list (&optional arg
)
124 "Move backward out of one level of parentheses.
125 With ARG, do this that many times.
126 A negative argument means move forward but still to a less deep spot."
128 (up-list (- (or arg
1))))
130 (defun up-list (&optional arg
)
131 "Move forward out of one level of parentheses.
132 With ARG, do this that many times.
133 A negative argument means move backward but still to a less deep spot."
135 (or arg
(setq arg
1))
136 (let ((inc (if (> arg
0) 1 -
1)))
138 (goto-char (or (scan-lists (point) inc
1) (buffer-end arg
)))
139 (setq arg
(- arg inc
)))))
141 (defun kill-sexp (&optional arg
)
142 "Kill the sexp (balanced expression) following point.
143 With ARG, kill that many sexps after point.
144 Negative arg -N means kill N sexps before point."
146 (let ((opoint (point)))
147 (forward-sexp (or arg
1))
148 (kill-region opoint
(point))))
150 (defun backward-kill-sexp (&optional arg
)
151 "Kill the sexp (balanced expression) preceding point.
152 With ARG, kill that many sexps before point.
153 Negative arg -N means kill N sexps after point."
155 (kill-sexp (- (or arg
1))))
158 (defun kill-backward-up-list (&optional arg
)
159 "Kill the form containing the current sexp, leaving the sexp itself.
160 A prefix argument ARG causes the relevant number of surrounding
161 forms to be removed."
163 (let ((current-sexp (thing-at-point 'sexp
)))
166 (backward-up-list arg
)
168 (insert current-sexp
))
169 (error "Not at a sexp"))))
171 (defvar beginning-of-defun-function nil
172 "If non-nil, function for `beginning-of-defun-raw' to call.
173 This is used to find the beginning of the defun instead of using the
174 normal recipe (see `beginning-of-defun'). Major modes can define this
175 if defining `defun-prompt-regexp' is not sufficient to handle the mode's
178 The function takes the same argument as `beginning-of-defun' and should
179 behave similarly, returning non-nil if it found the beginning of a defun.
180 Ideally it should move to a point right before an open-paren which encloses
181 the body of the defun.")
183 (defun beginning-of-defun (&optional arg
)
184 "Move backward to the beginning of a defun.
185 With ARG, do it that many times. Negative arg -N
186 means move forward to Nth following beginning of defun.
187 Returns t unless search stops due to beginning or end of buffer.
189 If variable `beginning-of-defun-function' is non-nil, its value
190 is called as a function to find the defun's beginning.
192 Normally a defun is assumed to start where there is a char with
193 open-parenthesis syntax at the beginning of a line. If
194 `defun-prompt-regexp' is non-nil, then a string which matches
195 that regexp may precede the open-parenthesis, and point ends up
196 at the beginning of the line.
198 If `defun-prompt-regexp' and `open-paren-in-column-0-is-defun-start'
199 are both nil, the function instead finds an open-paren at the
202 (or (not (eq this-command
'beginning-of-defun
))
203 (eq last-command
'beginning-of-defun
)
204 (and transient-mark-mode mark-active
)
206 (and (beginning-of-defun-raw arg
)
207 (progn (beginning-of-line) t
)))
209 (defun beginning-of-defun-raw (&optional arg
)
210 "Move point to the character that starts a defun.
211 This is identical to function `beginning-of-defun', except that point
212 does not move to the beginning of the line when `defun-prompt-regexp'
215 If variable `beginning-of-defun-function' is non-nil, its value
216 is called as a function to find the defun's beginning."
217 (interactive "p") ; change this to "P", maybe, if we ever come to pass ARG
218 ; to beginning-of-defun-function.
219 (unless arg
(setq arg
1))
221 (beginning-of-defun-function
223 (funcall beginning-of-defun-function arg
)
224 ;; We used to define beginning-of-defun-function as taking no argument
225 ;; but that makes it impossible to implement correct forward motion:
226 ;; we used to use end-of-defun for that, but it's not supposed to do
227 ;; the same thing (it moves to the end of a defun not to the beginning
229 ;; In case the beginning-of-defun-function uses the old calling
230 ;; convention, fallback on the old implementation.
231 (wrong-number-of-arguments
234 (funcall beginning-of-defun-function
))
235 ;; Better not call end-of-defun-function directly, in case
237 (end-of-defun (- arg
))))))
239 ((or defun-prompt-regexp open-paren-in-column-0-is-defun-start
)
240 (and (< arg
0) (not (eobp)) (forward-char 1))
241 (and (re-search-backward (if defun-prompt-regexp
242 (concat (if open-paren-in-column-0-is-defun-start
244 "\\(?:" defun-prompt-regexp
"\\)\\s(")
247 (progn (goto-char (1- (match-end 0)))) t
))
249 ;; If open-paren-in-column-0-is-defun-start and defun-prompt-regexp
250 ;; are both nil, column 0 has no significance - so scan forward
251 ;; from BOB to see how nested point is, then carry on from there.
253 ;; It is generally not a good idea to land up here, because the
254 ;; call to scan-lists below can be extremely slow. This is because
255 ;; back_comment in syntax.c may have to scan from bob to find the
256 ;; beginning of each comment. Fixing this is not trivial -- cyd.
260 (let ((floor (point-min))
261 (ceiling (point-max))
265 (let ((ppss (let (syntax-begin-function
266 font-lock-beginning-of-syntax-function
)
268 ;; position of least enclosing paren, or nil.
270 ;; Back out of any comment/string, so that encl-pos will always
271 ;; become nil if we're at top-level.
273 (goto-char (nth 8 ppss
))
274 (setq ppss
(syntax-ppss))) ; should be fast, due to cache.
275 (setq encl-pos
(syntax-ppss-toplevel-pos ppss
))
276 (if encl-pos
(goto-char encl-pos
))
278 (and encl-pos arg-
+ve
(setq arg
(1- arg
)))
279 (and (not encl-pos
) (not arg-
+ve
) (not (looking-at "\\s("))
282 (condition-case nil
; to catch crazy parens.
284 (goto-char (scan-lists (point) (- arg
) 0))
286 (if (>= (point) floor
)
290 ;; forward to next (, or trigger the c-c
291 (goto-char (1- (scan-lists (point) 1 -
1)))
292 (if (<= (point) ceiling
)
297 (goto-char (if arg-
+ve floor ceiling
))
300 (defvar end-of-defun-function
#'forward-sexp
301 "Function for `end-of-defun' to call.
302 This is used to find the end of the defun.
303 It is called with no argument, right after calling `beginning-of-defun-raw'.
304 So the function can assume that point is at the beginning of the defun body.")
306 (defun buffer-end (arg)
307 "Return the \"far end\" position of the buffer, in direction ARG.
308 If ARG is positive, that's the end of the buffer.
309 Otherwise, that's the beginning of the buffer."
310 (if (> arg
0) (point-max) (point-min)))
312 (defun end-of-defun (&optional arg
)
313 "Move forward to next end of defun.
314 With argument, do it that many times.
315 Negative argument -N means move back to Nth preceding end of defun.
317 An end of a defun occurs right after the close-parenthesis that
318 matches the open-parenthesis that starts a defun; see function
319 `beginning-of-defun'.
321 If variable `end-of-defun-function' is non-nil, its value
322 is called as a function to find the defun's end."
324 (or (not (eq this-command
'end-of-defun
))
325 (eq last-command
'end-of-defun
)
326 (and transient-mark-mode mark-active
)
328 (if (or (null arg
) (= arg
0)) (setq arg
1))
332 (beginning-of-defun-raw 1)
333 (while (unless (eobp)
334 (funcall end-of-defun-function
)
335 (skip-chars-forward " \t")
336 (if (looking-at "\\s<\\|\n")
338 ;; If we started after the end of the previous function, then
339 ;; try again with the next one.
340 (when (<= (point) pos
)
341 (or (bobp) (forward-char -
1))
342 (beginning-of-defun-raw -
1)
347 (while (unless (bobp)
348 (beginning-of-line 1)
349 (beginning-of-defun-raw 1)
351 (funcall end-of-defun-function
)
352 (skip-chars-forward " \t")
353 (if (looking-at "\\s<\\|\n")
355 ;; If we started from within the function just found, then
356 ;; try again with the previous one.
357 (when (>= (point) pos
)
360 (setq arg
(1+ arg
))))
362 (defun mark-defun (&optional allow-extend
)
363 "Put mark at end of this defun, point at beginning.
364 The defun marked is the one that contains point or follows point.
366 Interactively, if this command is repeated
367 or (in Transient Mark mode) if the mark is active,
368 it marks the next defun after the ones already marked."
370 (cond ((and allow-extend
371 (or (and (eq last-command this-command
) (mark t
))
372 (and transient-mark-mode mark-active
)))
379 (let ((opoint (point))
382 ;; Try first in this order for the sake of languages with nested
383 ;; functions where several can end at the same place as with
384 ;; the offside rule, e.g. Python.
389 (while (looking-at "^\n")
391 (if (> (point) opoint
)
393 ;; We got the right defun.
394 (push-mark beg nil t
)
396 (exchange-point-and-mark))
397 ;; beginning-of-defun moved back one defun
398 ;; so we got the wrong one.
401 (push-mark (point) nil t
)
402 (beginning-of-defun))
403 (re-search-backward "^\n" (- (point) 1) t
)))))
405 (defun narrow-to-defun (&optional arg
)
406 "Make text outside current defun invisible.
407 The defun visible is the one that contains point or follows point.
408 Optional ARG is ignored."
412 (let ((opoint (point))
414 ;; Try first in this order for the sake of languages with nested
415 ;; functions where several can end at the same place as with
416 ;; the offside rule, e.g. Python.
421 (while (looking-at "^\n")
423 (unless (> (point) opoint
)
424 ;; beginning-of-defun moved back one defun
425 ;; so we got the wrong one.
432 (re-search-backward "^\n" (- (point) 1) t
)
433 (narrow-to-region beg end
))))
435 (defvar insert-pair-alist
436 '((?\
( ?\
)) (?\
[ ?\
]) (?\
{ ?\
}) (?\
< ?\
>) (?
\" ?
\") (?
\' ?
\') (?\
` ?
\'))
437 "Alist of paired characters inserted by `insert-pair'.
438 Each element looks like (OPEN-CHAR CLOSE-CHAR) or (COMMAND-CHAR
439 OPEN-CHAR CLOSE-CHAR). The characters OPEN-CHAR and CLOSE-CHAR
440 of the pair whose key is equal to the last input character with
441 or without modifiers, are inserted by `insert-pair'.")
443 (defun insert-pair (&optional arg open close
)
444 "Enclose following ARG sexps in a pair of OPEN and CLOSE characters.
445 Leave point after the first character.
446 A negative ARG encloses the preceding ARG sexps instead.
447 No argument is equivalent to zero: just insert characters
448 and leave point between.
449 If `parens-require-spaces' is non-nil, this command also inserts a space
450 before and after, depending on the surrounding characters.
451 If region is active, insert enclosing characters at region boundaries.
453 If arguments OPEN and CLOSE are nil, the character pair is found
454 from the variable `insert-pair-alist' according to the last input
455 character with or without modifiers. If no character pair is
456 found in the variable `insert-pair-alist', then the last input
457 character is inserted ARG times."
459 (if (not (and open close
))
460 (let ((pair (or (assq last-command-char insert-pair-alist
)
461 (assq (event-basic-type last-command-event
)
462 insert-pair-alist
))))
465 (setq open
(nth 1 pair
) close
(nth 2 pair
))
466 (setq open
(nth 0 pair
) close
(nth 1 pair
))))))
468 (if (and transient-mark-mode mark-active
)
470 (save-excursion (goto-char (region-end)) (insert close
))
471 (save-excursion (goto-char (region-beginning)) (insert open
)))
472 (if arg
(setq arg
(prefix-numeric-value arg
))
474 (cond ((> arg
0) (skip-chars-forward " \t"))
475 ((< arg
0) (forward-sexp arg
) (setq arg
(- arg
))))
476 (and parens-require-spaces
478 (memq (char-syntax (preceding-char)) (list ?w ?_
(char-syntax close
)))
482 (or (eq arg
0) (forward-sexp arg
))
484 (and parens-require-spaces
486 (memq (char-syntax (following-char)) (list ?w ?_
(char-syntax open
)))
488 (insert-char (event-basic-type last-command-event
)
489 (prefix-numeric-value arg
))))
491 (defun insert-parentheses (&optional arg
)
492 "Enclose following ARG sexps in parentheses.
493 Leave point after open-paren.
494 A negative ARG encloses the preceding ARG sexps instead.
495 No argument is equivalent to zero: just insert `()' and leave point between.
496 If `parens-require-spaces' is non-nil, this command also inserts a space
497 before and after, depending on the surrounding characters.
498 If region is active, insert enclosing characters at region boundaries."
500 (insert-pair arg ?\
( ?\
)))
502 (defun delete-pair ()
503 "Delete a pair of characters enclosing the sexp that follows point."
505 (save-excursion (forward-sexp 1) (delete-char -
1))
508 (defun raise-sexp (&optional arg
)
509 "Raise ARG sexps higher up the tree."
511 (let ((s (if (and transient-mark-mode mark-active
)
512 (buffer-substring (region-beginning) (region-end))
515 (save-excursion (forward-sexp arg
) (point))))))
517 (delete-region (point) (save-excursion (forward-sexp 1) (point)))
518 (save-excursion (insert s
))))
520 (defun move-past-close-and-reindent ()
521 "Move past next `)', delete indentation before it, then indent after it."
525 (while (save-excursion ; this is my contribution
526 (let ((before-paren (point)))
527 (back-to-indentation)
528 (and (= (point) before-paren
)
530 ;; Move to end of previous line.
533 ;; Verify it doesn't end within a string or comment.
537 ;; Get state at start of line.
538 (setq state
(list 0 nil nil
539 (null (calculate-lisp-indent))
542 ;; Parse state across the line to get state at end.
543 (setq state
(parse-partial-sexp (point) end nil nil
545 ;; Check not in string or comment.
546 (and (not (elt state
3)) (not (elt state
4))))))))
547 (delete-indentation))
549 (newline-and-indent))
551 (defun check-parens () ; lame name?
552 "Check for unbalanced parentheses in the current buffer.
553 More accurately, check the narrowed part of the buffer for unbalanced
554 expressions (\"sexps\") in general. This is done according to the
555 current syntax table and will find unbalanced brackets or quotes as
556 appropriate. (See Info node `(emacs)Parentheses'.) If imbalance is
557 found, an error is signaled and point is left at the first unbalanced
561 ;; Buffer can't have more than (point-max) sexps.
562 (scan-sexps (point-min) (point-max))
563 (scan-error (goto-char (nth 2 data
))
564 ;; Could print (nth 1 data), which is either
565 ;; "Containing expression ends prematurely" or
566 ;; "Unbalanced parentheses", but those may not be so
567 ;; accurate/helpful, e.g. quotes may actually be
569 (error "Unmatched bracket or quote"))))
571 (defun field-complete (table &optional predicate
)
572 (let* ((pattern (field-string-no-properties))
573 (completion (try-completion pattern table predicate
)))
574 (cond ((eq completion t
))
576 (message "Can't find completion for \"%s\"" pattern
)
578 ((not (string= pattern completion
))
579 (delete-region (field-beginning) (field-end))
581 ;; Don't leave around a completions buffer that's out of date.
582 (let ((win (get-buffer-window "*Completions*" 0)))
583 (if win
(with-selected-window win
(bury-buffer)))))
585 (let ((minibuf-is-in-use
586 (eq (minibuffer-window) (selected-window))))
587 (unless minibuf-is-in-use
588 (message "Making completion list..."))
589 (let ((list (all-completions pattern table predicate
)))
590 (setq list
(sort list
'string
<))
591 (or (eq predicate
'fboundp
)
594 (setq new
(cons (if (fboundp (intern (car list
)))
595 (list (car list
) " <f>")
598 (setq list
(cdr list
)))
599 (setq list
(nreverse new
))))
600 (if (> (length list
) 1)
601 (with-output-to-temp-buffer "*Completions*"
602 (display-completion-list list pattern
))
603 ;; Don't leave around a completions buffer that's
605 (let ((win (get-buffer-window "*Completions*" 0)))
606 (if win
(with-selected-window win
(bury-buffer))))))
607 (unless minibuf-is-in-use
608 (message "Making completion list...%s" "done")))))))
610 (defun lisp-complete-symbol (&optional predicate
)
611 "Perform completion on Lisp symbol preceding point.
612 Compare that symbol against the known Lisp symbols.
613 If no characters can be completed, display a list of possible completions.
614 Repeating the command at that point scrolls the list.
616 When called from a program, optional arg PREDICATE is a predicate
617 determining which symbols are considered, e.g. `commandp'.
618 If PREDICATE is nil, the context determines which symbols are
619 considered. If the symbol starts just after an open-parenthesis, only
620 symbols with function definitions are considered. Otherwise, all
621 symbols with function definitions, values or properties are
624 (let ((window (get-buffer-window "*Completions*" 0)))
625 (if (and (eq last-command this-command
)
626 window
(window-live-p window
) (window-buffer window
)
627 (buffer-name (window-buffer window
)))
628 ;; If this command was repeated, and
629 ;; there's a fresh completion window with a live buffer,
630 ;; and this command is repeated, scroll that window.
631 (with-current-buffer (window-buffer window
)
632 (if (pos-visible-in-window-p (point-max) window
)
633 (set-window-start window
(point-min))
634 (save-selected-window
635 (select-window window
)
640 (beg (with-syntax-table emacs-lisp-mode-syntax-table
643 (while (= (char-syntax (following-char)) ?
\')
646 (pattern (buffer-substring-no-properties beg end
))
651 (if (not (eq (char-before) ?\
())
652 (lambda (sym) ;why not just nil ? -sm
653 (or (boundp sym
) (fboundp sym
)
655 ;; Looks like a funcall position. Let's double check.
656 (if (condition-case nil
657 (progn (up-list -
2) (forward-char 1)
658 (eq (char-after) ?\
())
660 ;; If the first element of the parent list is an open
661 ;; parenthesis we are probably not in a funcall position.
662 ;; Maybe a `let' varlist or something.
664 ;; Else, we assume that a function name is expected.
666 (completion (try-completion pattern obarray predicate
)))
667 (cond ((eq completion t
))
669 (message "Can't find completion for \"%s\"" pattern
)
671 ((not (string= pattern completion
))
672 (delete-region beg end
)
674 ;; Don't leave around a completions buffer that's out of date.
675 (let ((win (get-buffer-window "*Completions*" 0)))
676 (if win
(with-selected-window win
(bury-buffer)))))
678 (let ((minibuf-is-in-use
679 (eq (minibuffer-window) (selected-window))))
680 (unless minibuf-is-in-use
681 (message "Making completion list..."))
682 (let ((list (all-completions pattern obarray predicate
)))
683 (setq list
(sort list
'string
<))
684 (or (eq predicate
'fboundp
)
687 (setq new
(cons (if (fboundp (intern (car list
)))
688 (list (car list
) " <f>")
691 (setq list
(cdr list
)))
692 (setq list
(nreverse new
))))
693 (if (> (length list
) 1)
694 (with-output-to-temp-buffer "*Completions*"
695 (display-completion-list list pattern
))
696 ;; Don't leave around a completions buffer that's
698 (let ((win (get-buffer-window "*Completions*" 0)))
699 (if win
(with-selected-window win
(bury-buffer))))))
700 (unless minibuf-is-in-use
701 (message "Making completion list...%s" "done")))))))))
703 ;; arch-tag: aa7fa8a4-2e6f-4e9b-9cd9-fef06340e67e
704 ;;; lisp.el ends here