1 ;;; lisp.el --- Lisp editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1994, 2000, 2002, 2003, 2004,
4 ;; 2005 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 2, 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 (of no args) should go to the line on which the current
179 defun starts, and return non-nil, or should return nil if it can't
180 find the beginning.")
182 (defun beginning-of-defun (&optional arg
)
183 "Move backward to the beginning of a defun.
184 With ARG, do it that many times. Negative arg -N
185 means move forward to Nth following beginning of defun.
186 Returns t unless search stops due to beginning or end of buffer.
188 Normally a defun starts when there is a char with open-parenthesis
189 syntax at the beginning of a line. If `defun-prompt-regexp' is
190 non-nil, then a string which matches that regexp may precede the
191 open-parenthesis, and point ends up at the beginning of the line.
193 If variable `beginning-of-defun-function' is non-nil, its value
194 is called as a function to find the defun's beginning."
196 (or (not (eq this-command
'beginning-of-defun
))
197 (eq last-command
'beginning-of-defun
)
198 (and transient-mark-mode mark-active
)
200 (and (beginning-of-defun-raw arg
)
201 (progn (beginning-of-line) t
)))
203 (defun beginning-of-defun-raw (&optional arg
)
204 "Move point to the character that starts a defun.
205 This is identical to function `beginning-of-defun', except that point
206 does not move to the beginning of the line when `defun-prompt-regexp'
209 If variable `beginning-of-defun-function' is non-nil, its value
210 is called as a function to find the defun's beginning."
212 (if beginning-of-defun-function
213 (if (> (setq arg
(or arg
1)) 0)
215 (funcall beginning-of-defun-function
))
216 ;; Better not call end-of-defun-function directly, in case
218 (end-of-defun (- arg
)))
219 (and arg
(< arg
0) (not (eobp)) (forward-char 1))
220 (and (re-search-backward (if defun-prompt-regexp
221 (concat (if open-paren-in-column-0-is-defun-start
223 "\\(?:" defun-prompt-regexp
"\\)\\s(")
225 nil
'move
(or arg
1))
226 (progn (goto-char (1- (match-end 0)))) t
)))
228 (defvar end-of-defun-function nil
229 "If non-nil, function for function `end-of-defun' to call.
230 This is used to find the end of the defun instead of using the normal
231 recipe (see `end-of-defun'). Major modes can define this if the
232 normal method is not appropriate.")
234 (defun buffer-end (arg)
235 "Return the \"far end\" position of the buffer, in direction ARG.
236 If ARG is positive, that's the end of the buffer.
237 Otherwise, that's the beginning of the buffer."
238 (if (> arg
0) (point-max) (point-min)))
240 (defun end-of-defun (&optional arg
)
241 "Move forward to next end of defun.
242 With argument, do it that many times.
243 Negative argument -N means move back to Nth preceding end of defun.
245 An end of a defun occurs right after the close-parenthesis that
246 matches the open-parenthesis that starts a defun; see function
247 `beginning-of-defun'.
249 If variable `end-of-defun-function' is non-nil, its value
250 is called as a function to find the defun's end."
252 (or (not (eq this-command
'end-of-defun
))
253 (eq last-command
'end-of-defun
)
254 (and transient-mark-mode mark-active
)
256 (if (or (null arg
) (= arg
0)) (setq arg
1))
257 (if end-of-defun-function
260 (funcall end-of-defun-function
))
261 ;; Better not call beginning-of-defun-function
262 ;; directly, in case it's not defined.
263 (beginning-of-defun (- arg
)))
265 (while (and (> arg
0) (< (point) (point-max)))
271 (beginning-of-defun-raw 1)))
273 (or (bobp) (forward-char -
1))
274 (beginning-of-defun-raw -
1))
277 (skip-chars-forward " \t")
278 (if (looking-at "\\s<\\|\n")
284 (beginning-of-defun-raw 1)
288 (if (beginning-of-defun-raw 2)
291 (skip-chars-forward " \t")
292 (if (looking-at "\\s<\\|\n")
294 (goto-char (point-min)))))
295 (setq arg
(1+ arg
))))))
297 (defun mark-defun (&optional allow-extend
)
298 "Put mark at end of this defun, point at beginning.
299 The defun marked is the one that contains point or follows point.
301 Interactively, if this command is repeated
302 or (in Transient Mark mode) if the mark is active,
303 it marks the next defun after the ones already marked."
305 (cond ((and allow-extend
306 (or (and (eq last-command this-command
) (mark t
))
307 (and transient-mark-mode mark-active
)))
314 (let ((opoint (point))
317 ;; Try first in this order for the sake of languages with nested
318 ;; functions where several can end at the same place as with
319 ;; the offside rule, e.g. Python.
324 (while (looking-at "^\n")
326 (if (> (point) opoint
)
328 ;; We got the right defun.
329 (push-mark beg nil t
)
331 (exchange-point-and-mark))
332 ;; beginning-of-defun moved back one defun
333 ;; so we got the wrong one.
336 (push-mark (point) nil t
)
337 (beginning-of-defun))
338 (re-search-backward "^\n" (- (point) 1) t
)))))
340 (defun narrow-to-defun (&optional arg
)
341 "Make text outside current defun invisible.
342 The defun visible is the one that contains point or follows point.
343 Optional ARG is ignored."
347 (let ((opoint (point))
349 ;; Try first in this order for the sake of languages with nested
350 ;; functions where several can end at the same place as with
351 ;; the offside rule, e.g. Python.
356 (while (looking-at "^\n")
358 (unless (> (point) opoint
)
359 ;; beginning-of-defun moved back one defun
360 ;; so we got the wrong one.
367 (re-search-backward "^\n" (- (point) 1) t
)
368 (narrow-to-region beg end
))))
370 (defvar insert-pair-alist
371 '((?\
( ?\
)) (?\
[ ?\
]) (?\
{ ?\
}) (?\
< ?\
>) (?
\" ?
\") (?
\' ?
\') (?\
` ?
\'))
372 "Alist of paired characters inserted by `insert-pair'.
373 Each element looks like (OPEN-CHAR CLOSE-CHAR) or (COMMAND-CHAR
374 OPEN-CHAR CLOSE-CHAR). The characters OPEN-CHAR and CLOSE-CHAR
375 of the pair whose key is equal to the last input character with
376 or without modifiers, are inserted by `insert-pair'.")
378 (defun insert-pair (&optional arg open close
)
379 "Enclose following ARG sexps in a pair of OPEN and CLOSE characters.
380 Leave point after the first character.
381 A negative ARG encloses the preceding ARG sexps instead.
382 No argument is equivalent to zero: just insert characters
383 and leave point between.
384 If `parens-require-spaces' is non-nil, this command also inserts a space
385 before and after, depending on the surrounding characters.
386 If region is active, insert enclosing characters at region boundaries.
388 If arguments OPEN and CLOSE are nil, the character pair is found
389 from the variable `insert-pair-alist' according to the last input
390 character with or without modifiers. If no character pair is
391 found in the variable `insert-pair-alist', then the last input
392 character is inserted ARG times."
394 (if (not (and open close
))
395 (let ((pair (or (assq last-command-char insert-pair-alist
)
396 (assq (event-basic-type last-command-event
)
397 insert-pair-alist
))))
400 (setq open
(nth 1 pair
) close
(nth 2 pair
))
401 (setq open
(nth 0 pair
) close
(nth 1 pair
))))))
403 (if (and transient-mark-mode mark-active
)
405 (save-excursion (goto-char (region-end)) (insert close
))
406 (save-excursion (goto-char (region-beginning)) (insert open
)))
407 (if arg
(setq arg
(prefix-numeric-value arg
))
409 (cond ((> arg
0) (skip-chars-forward " \t"))
410 ((< arg
0) (forward-sexp arg
) (setq arg
(- arg
))))
411 (and parens-require-spaces
413 (memq (char-syntax (preceding-char)) (list ?w ?_
(char-syntax close
)))
417 (or (eq arg
0) (forward-sexp arg
))
419 (and parens-require-spaces
421 (memq (char-syntax (following-char)) (list ?w ?_
(char-syntax open
)))
423 (insert-char (event-basic-type last-command-event
)
424 (prefix-numeric-value arg
))))
426 (defun insert-parentheses (&optional arg
)
427 "Enclose following ARG sexps in parentheses.
428 Leave point after open-paren.
429 A negative ARG encloses the preceding ARG sexps instead.
430 No argument is equivalent to zero: just insert `()' and leave point between.
431 If `parens-require-spaces' is non-nil, this command also inserts a space
432 before and after, depending on the surrounding characters.
433 If region is active, insert enclosing characters at region boundaries."
435 (insert-pair arg ?\
( ?\
)))
437 (defun delete-pair ()
438 "Delete a pair of characters enclosing the sexp that follows point."
440 (save-excursion (forward-sexp 1) (delete-char -
1))
443 (defun raise-sexp (&optional arg
)
444 "Raise ARG sexps higher up the tree."
446 (let ((s (if (and transient-mark-mode mark-active
)
447 (buffer-substring (region-beginning) (region-end))
450 (save-excursion (forward-sexp arg
) (point))))))
452 (delete-region (point) (save-excursion (forward-sexp 1) (point)))
453 (save-excursion (insert s
))))
455 (defun move-past-close-and-reindent ()
456 "Move past next `)', delete indentation before it, then indent after it."
460 (while (save-excursion ; this is my contribution
461 (let ((before-paren (point)))
462 (back-to-indentation)
463 (and (= (point) before-paren
)
465 ;; Move to end of previous line.
468 ;; Verify it doesn't end within a string or comment.
472 ;; Get state at start of line.
473 (setq state
(list 0 nil nil
474 (null (calculate-lisp-indent))
477 ;; Parse state across the line to get state at end.
478 (setq state
(parse-partial-sexp (point) end nil nil
480 ;; Check not in string or comment.
481 (and (not (elt state
3)) (not (elt state
4))))))))
482 (delete-indentation))
484 (newline-and-indent))
486 (defun check-parens () ; lame name?
487 "Check for unbalanced parentheses in the current buffer.
488 More accurately, check the narrowed part of the buffer for unbalanced
489 expressions (\"sexps\") in general. This is done according to the
490 current syntax table and will find unbalanced brackets or quotes as
491 appropriate. (See Info node `(emacs)Parentheses'.) If imbalance is
492 found, an error is signaled and point is left at the first unbalanced
496 ;; Buffer can't have more than (point-max) sexps.
497 (scan-sexps (point-min) (point-max))
498 (scan-error (goto-char (nth 2 data
))
499 ;; Could print (nth 1 data), which is either
500 ;; "Containing expression ends prematurely" or
501 ;; "Unbalanced parentheses", but those may not be so
502 ;; accurate/helpful, e.g. quotes may actually be
504 (error "Unmatched bracket or quote"))
505 (error (cond ((eq 'scan-error
(car data
))
506 (goto-char (nth 2 data
))
507 (error "Unmatched bracket or quote"))
508 (t (signal (car data
) (cdr data
)))))))
510 (defun lisp-complete-symbol (&optional predicate
)
511 "Perform completion on Lisp symbol preceding point.
512 Compare that symbol against the known Lisp symbols.
513 If no characters can be completed, display a list of possible completions.
514 Repeating the command at that point scrolls the list.
516 When called from a program, optional arg PREDICATE is a predicate
517 determining which symbols are considered, e.g. `commandp'.
518 If PREDICATE is nil, the context determines which symbols are
519 considered. If the symbol starts just after an open-parenthesis, only
520 symbols with function definitions are considered. Otherwise, all
521 symbols with function definitions, values or properties are
525 (let ((window (get-buffer-window "*Completions*")))
526 (if (and (eq last-command this-command
)
527 window
(window-live-p window
) (window-buffer window
)
528 (buffer-name (window-buffer window
)))
529 ;; If this command was repeated, and
530 ;; there's a fresh completion window with a live buffer,
531 ;; and this command is repeated, scroll that window.
532 (with-current-buffer (window-buffer window
)
533 (if (pos-visible-in-window-p (point-max) window
)
534 (set-window-start window
(point-min))
535 (save-selected-window
536 (select-window window
)
541 (beg (with-syntax-table emacs-lisp-mode-syntax-table
544 (while (= (char-syntax (following-char)) ?
\')
547 (pattern (buffer-substring-no-properties beg end
))
552 (if (not (eq (char-before) ?\
())
553 (lambda (sym) ;why not just nil ? -sm
554 (or (boundp sym
) (fboundp sym
)
556 ;; Looks like a funcall position. Let's double check.
557 (if (condition-case nil
558 (progn (up-list -
2) (forward-char 1)
559 (eq (char-after) ?\
())
561 ;; If the first element of the parent list is an open
562 ;; parenthesis we are probably not in a funcall position.
563 ;; Maybe a `let' varlist or something.
565 ;; Else, we assume that a function name is expected.
567 (completion (try-completion pattern obarray predicate
)))
568 (cond ((eq completion t
))
570 (message "Can't find completion for \"%s\"" pattern
)
572 ((not (string= pattern completion
))
573 (delete-region beg end
)
576 (message "Making completion list...")
577 (let ((list (all-completions pattern obarray predicate
)))
578 (setq list
(sort list
'string
<))
579 (or (eq predicate
'fboundp
)
582 (setq new
(cons (if (fboundp (intern (car list
)))
583 (list (car list
) " <f>")
586 (setq list
(cdr list
)))
587 (setq list
(nreverse new
))))
588 (with-output-to-temp-buffer "*Completions*"
589 (display-completion-list list
)))
590 (message "Making completion list...%s" "done")))))))
592 ;;; arch-tag: aa7fa8a4-2e6f-4e9b-9cd9-fef06340e67e
593 ;;; lisp.el ends here