1 ;;; lisp.el --- Lisp editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1994 Free Software Foundation, Inc.
6 ;; Keywords: lisp, languages
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; Lisp editing commands to go with Lisp major mode.
31 ;; Note that this variable is used by non-lisp modes too.
32 (defvar defun-prompt-regexp nil
33 "*Non-nil => regexp to ignore, before the character that starts a defun.
34 This is only necessary if the opening paren or brace is not in column 0.
35 See `beginning-of-defun'.")
36 (make-variable-buffer-local 'defun-prompt-regexp)
38 (defvar parens-require-spaces t
39 "Non-nil => `insert-parentheses' should insert whitespace as needed.")
41 (defun forward-sexp (&optional arg)
42 "Move forward across one balanced expression (sexp).
43 With argument, do it that many times. Negative arg -N means
44 move backward across N balanced expressions."
47 (goto-char (or (scan-sexps (point) arg) (buffer-end arg)))
48 (if (< arg 0) (backward-prefix-chars)))
50 (defun backward-sexp (&optional arg)
51 "Move backward across one balanced expression (sexp).
52 With argument, do it that many times. Negative arg -N means
53 move forward across N balanced expressions."
56 (forward-sexp (- arg)))
58 (defun mark-sexp (arg)
59 "Set mark ARG sexps from point.
60 The place mark goes is the same place \\[forward-sexp] would
61 move to with the same argument."
69 (defun forward-list (&optional arg)
70 "Move forward across one balanced group of parentheses.
71 With argument, do it that many times.
72 Negative arg -N means move backward across N groups of parentheses."
75 (goto-char (or (scan-lists (point) arg 0) (buffer-end arg))))
77 (defun backward-list (&optional arg)
78 "Move backward across one balanced group of parentheses.
79 With argument, do it that many times.
80 Negative arg -N means move forward across N groups of parentheses."
83 (forward-list (- arg)))
85 (defun down-list (arg)
86 "Move forward down one level of parentheses.
87 With argument, do this that many times.
88 A negative argument means move backward but still go down a level.
89 In Lisp programs, an argument is required."
91 (let ((inc (if (> arg 0) 1 -1)))
93 (goto-char (or (scan-lists (point) inc -1) (buffer-end arg)))
94 (setq arg (- arg inc)))))
96 (defun backward-up-list (arg)
97 "Move backward out of one level of parentheses.
98 With argument, do this that many times.
99 A negative argument means move forward but still to a less deep spot.
100 In Lisp programs, an argument is required."
105 "Move forward out of one level of parentheses.
106 With argument, do this that many times.
107 A negative argument means move backward but still to a less deep spot.
108 In Lisp programs, an argument is required."
110 (let ((inc (if (> arg 0) 1 -1)))
112 (goto-char (or (scan-lists (point) inc 1) (buffer-end arg)))
113 (setq arg (- arg inc)))))
115 (defun kill-sexp (arg)
116 "Kill the sexp (balanced expression) following the cursor.
117 With argument, kill that many sexps after the cursor.
118 Negative arg -N means kill N sexps before the cursor."
120 (let ((opoint (point)))
122 (kill-region opoint (point))))
124 (defun backward-kill-sexp (arg)
125 "Kill the sexp (balanced expression) preceding the cursor.
126 With argument, kill that many sexps before the cursor.
127 Negative arg -N means kill N sexps after the cursor."
131 (defun beginning-of-defun (&optional arg)
132 "Move backward to the beginning of a defun.
133 With argument, do it that many times. Negative arg -N
134 means move forward to Nth following beginning of defun.
135 Returns t unless search stops due to beginning or end of buffer.
137 Normally a defun starts when there is an char with open-parenthesis
138 syntax at the beginning of a line. If `defun-prompt-regexp' is
139 non-nil, then a string which matches that regexp may precede the
140 open-parenthesis, and point ends up at the beginning of the line."
142 (and (beginning-of-defun-raw arg)
143 (progn (beginning-of-line) t)))
145 (defun beginning-of-defun-raw (&optional arg)
146 "Move point to the character that starts a defun.
147 This is identical to beginning-of-defun, except that point does not move
148 to the beginning of the line when `defun-prompt-regexp' is non-nil."
150 (and arg (< arg 0) (not (eobp)) (forward-char 1))
151 (and (re-search-backward (if defun-prompt-regexp
153 "\\(" defun-prompt-regexp "\\)\\s(")
155 nil 'move (or arg 1))
156 (progn (goto-char (1- (match-end 0)))) t))
158 (defun buffer-end (arg)
159 (if (> arg 0) (point-max) (point-min)))
161 (defun end-of-defun (&optional arg)
162 "Move forward to next end of defun. With argument, do it that many times.
163 Negative argument -N means move back to Nth preceding end of defun.
165 An end of a defun occurs right after the close-parenthesis that matches
166 the open-parenthesis that starts a defun; see `beginning-of-defun'."
168 (if (or (null arg) (= arg 0)) (setq arg 1))
170 (while (and (> arg 0) (< (point) (point-max)))
171 (let ((pos (point)) npos)
176 (beginning-of-defun-raw 1)))
178 (or (bobp) (forward-char -1))
179 (beginning-of-defun-raw -1))
182 (skip-chars-forward " \t")
183 (if (looking-at "\\s<\\|\n")
189 (beginning-of-defun-raw 1)
193 (if (beginning-of-defun-raw 2)
196 (skip-chars-forward " \t")
197 (if (looking-at "\\s<\\|\n")
199 (goto-char (point-min)))))
200 (setq arg (1+ arg)))))
203 "Put mark at end of this defun, point at beginning.
204 The defun marked is the one that contains point or follows point."
208 (push-mark (point) nil t)
210 (re-search-backward "^\n" (- (point) 1) t))
212 (defun narrow-to-defun (&optional arg)
213 "Make text outside current defun invisible.
214 The defun visible is the one that contains point or follows point."
219 (narrow-to-region (point) (progn (end-of-defun) (point)))))
221 (defun insert-parentheses (arg)
222 "Put parentheses around next ARG sexps. Leave point after open-paren.
223 No argument is equivalent to zero: just insert `()' and leave point between.
224 If `parens-require-spaces' is non-nil, this command also inserts a space
225 before and after, depending on the surrounding characters."
227 (if arg (setq arg (prefix-numeric-value arg))
229 (or (eq arg 0) (skip-chars-forward " \t"))
230 (and parens-require-spaces
232 (memq (char-syntax (preceding-char)) '(?w ?_ ?\) ))
236 (or (eq arg 0) (forward-sexp arg))
238 (and parens-require-spaces
240 (memq (char-syntax (following-char)) '(?w ?_ ?\( ))
243 (defun move-past-close-and-reindent ()
244 "Move past next `)', delete indentation before it, then indent after it."
248 (while (save-excursion ; this is my contribution
249 (let ((before-paren (point)))
250 (back-to-indentation)
251 (= (point) before-paren)))
252 (delete-indentation))
254 (newline-and-indent))
256 (defun lisp-complete-symbol ()
257 "Perform completion on Lisp symbol preceding point.
258 Compare that symbol against the known Lisp symbols.
260 The context determines which symbols are considered.
261 If the symbol starts just after an open-parenthesis, only symbols
262 with function definitions are considered. Otherwise, all symbols with
263 function definitions, values or properties are considered."
266 (buffer-syntax (syntax-table))
269 (set-syntax-table emacs-lisp-mode-syntax-table)
271 (while (= (char-syntax (following-char)) ?\')
274 (set-syntax-table buffer-syntax)))
275 (pattern (buffer-substring beg end))
277 (if (eq (char-after (1- beg)) ?\()
279 (function (lambda (sym)
280 (or (boundp sym) (fboundp sym)
281 (symbol-plist sym))))))
282 (completion (try-completion pattern obarray predicate)))
283 (cond ((eq completion t))
285 (message "Can't find completion for \"%s\"" pattern)
287 ((not (string= pattern completion))
288 (delete-region beg end)
291 (message "Making completion list...")
292 (let ((list (all-completions pattern obarray predicate))
293 (completion-fixup-function
294 (function (lambda () (if (save-excursion
295 (goto-char (max (point-min) (- (point) 4)))
297 (forward-char -4))))))
298 (or (eq predicate 'fboundp)
301 (setq new (cons (if (fboundp (intern (car list)))
302 (list (car list) " <f>")
305 (setq list (cdr list)))
306 (setq list (nreverse new))))
307 (with-output-to-temp-buffer "*Completions*"
308 (display-completion-list list)))
309 (message "Making completion list...%s" "done")))))
311 ;;; lisp.el ends here