1 ;;; lisp.el --- Lisp editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1994, 2000 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. More-or-less
28 ;; applicable in other modes too.
32 ;; Note that this variable is used by non-lisp modes too.
33 (defcustom defun-prompt-regexp nil
34 "*If non-nil, a regexp to ignore before the character that starts a defun.
35 This is only necessary if the opening paren or brace is not in column 0.
36 See function `beginning-of-defun'."
37 :type
'(choice (const nil
)
40 (make-variable-buffer-local 'defun-prompt-regexp
)
42 (defcustom parens-require-spaces t
43 "Non-nil means `insert-parentheses' should insert whitespace as needed."
47 (defun forward-sexp (&optional arg
)
48 "Move forward across one balanced expression (sexp).
49 With ARG, do it that many times. Negative arg -N means
50 move backward across N balanced expressions."
53 (goto-char (or (scan-sexps (point) arg
) (buffer-end arg
)))
54 (if (< arg
0) (backward-prefix-chars)))
56 (defun backward-sexp (&optional arg
)
57 "Move backward across one balanced expression (sexp).
58 With ARG, do it that many times. Negative arg -N means
59 move forward across N balanced expressions."
62 (forward-sexp (- arg
)))
64 (defun mark-sexp (&optional arg
)
65 "Set mark ARG sexps from point.
66 The place mark goes is the same place \\[forward-sexp] would
67 move to with the same argument."
71 (forward-sexp (or arg
1))
75 (defun forward-list (&optional arg
)
76 "Move forward across one balanced group of parentheses.
77 With ARG, do it that many times.
78 Negative arg -N means move backward across N groups of parentheses."
81 (goto-char (or (scan-lists (point) arg
0) (buffer-end arg
))))
83 (defun backward-list (&optional arg
)
84 "Move backward across one balanced group of parentheses.
85 With ARG, do it that many times.
86 Negative arg -N means move forward across N groups of parentheses."
89 (forward-list (- arg
)))
91 (defun down-list (&optional arg
)
92 "Move forward down one level of parentheses.
93 With ARG, do this that many times.
94 A negative argument means move backward but still go down a level.
95 In Lisp programs, an argument is required."
98 (let ((inc (if (> arg
0) 1 -
1)))
100 (goto-char (or (scan-lists (point) inc -
1) (buffer-end arg
)))
101 (setq arg
(- arg inc
)))))
103 (defun backward-up-list (&optional arg
)
104 "Move backward out of one level of parentheses.
105 With ARG, do this that many times.
106 A negative argument means move forward but still to a less deep spot.
107 In Lisp programs, an argument is required."
109 (up-list (- (or arg
1))))
111 (defun up-list (&optional arg
)
112 "Move forward out of one level of parentheses.
113 With ARG, do this that many times.
114 A negative argument means move backward but still to a less deep spot.
115 In Lisp programs, an argument is required."
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 kill-sexp (&optional arg
)
124 "Kill the sexp (balanced expression) following the cursor.
125 With ARG, kill that many sexps after the cursor.
126 Negative arg -N means kill N sexps before the cursor."
128 (let ((opoint (point)))
129 (forward-sexp (or arg
1))
130 (kill-region opoint
(point))))
132 (defun backward-kill-sexp (&optional arg
)
133 "Kill the sexp (balanced expression) preceding the cursor.
134 With ARG, kill that many sexps before the cursor.
135 Negative arg -N means kill N sexps after the cursor."
137 (kill-sexp (- (or arg
1))))
139 (defvar beginning-of-defun-function nil
140 "If non-nil, function for `beginning-of-defun-raw' to call.
141 This is used to find the beginning of the defun instead of using the
142 normal recipe (see `beginning-of-defun'). Major modes can define this
143 if defining `defun-prompt-regexp' is not sufficient to handle the mode's
146 The function should go to the line on which the current defun starts,
147 and return non-nil, or should return nil if it can't find the beginning.")
149 (defun beginning-of-defun (&optional arg
)
150 "Move backward to the beginning of a defun.
151 With ARG, do it that many times. Negative arg -N
152 means move forward to Nth following beginning of defun.
153 Returns t unless search stops due to beginning or end of buffer.
155 Normally a defun starts when there is an char with open-parenthesis
156 syntax at the beginning of a line. If `defun-prompt-regexp' is
157 non-nil, then a string which matches that regexp may precede the
158 open-parenthesis, and point ends up at the beginning of the line.
160 If variable `beginning-of-defun-function' is non-nil, its value
161 is called as a function to find the defun's beginning."
163 (and (beginning-of-defun-raw arg
)
164 (progn (beginning-of-line) t
)))
166 (defun beginning-of-defun-raw (&optional arg
)
167 "Move point to the character that starts a defun.
168 This is identical to function `beginning-of-defun', except that point
169 does not move to the beginning of the line when `defun-prompt-regexp'
172 If variable `beginning-of-defun-function' is non-nil, its value
173 is called as a function to find the defun's beginning."
175 (if beginning-of-defun-function
176 (funcall beginning-of-defun-function
)
177 (and arg
(< arg
0) (not (eobp)) (forward-char 1))
178 (and (re-search-backward (if defun-prompt-regexp
179 (concat (if open-paren-in-column-0-is-defun-start
181 "\\(" defun-prompt-regexp
"\\)\\s(")
183 nil
'move
(or arg
1))
184 (progn (goto-char (1- (match-end 0)))) t
)))
186 (defvar end-of-defun-function nil
187 "If non-nil, function for function `end-of-defun' to call.
188 This is used to find the end of the defun instead of using the normal
189 recipe (see `end-of-defun'). Major modes can define this if the
190 normal method is not appropriate.")
192 (defun buffer-end (arg)
193 (if (> arg
0) (point-max) (point-min)))
195 (defun end-of-defun (&optional arg
)
196 "Move forward to next end of defun. With argument, do it that many times.
197 Negative argument -N means move back to Nth preceding end of defun.
199 An end of a defun occurs right after the close-parenthesis that
200 matches the open-parenthesis that starts a defun; see function
201 `beginning-of-defun'.
203 If variable `end-of-defun-function' is non-nil, its value
204 is called as a function to find the defun's end."
206 (if end-of-defun-function
207 (funcall end-of-defun-function
)
208 (if (or (null arg
) (= arg
0)) (setq arg
1))
210 (while (and (> arg
0) (< (point) (point-max)))
211 (let ((pos (point)) npos
)
216 (beginning-of-defun-raw 1)))
218 (or (bobp) (forward-char -
1))
219 (beginning-of-defun-raw -
1))
222 (skip-chars-forward " \t")
223 (if (looking-at "\\s<\\|\n")
229 (beginning-of-defun-raw 1)
233 (if (beginning-of-defun-raw 2)
236 (skip-chars-forward " \t")
237 (if (looking-at "\\s<\\|\n")
239 (goto-char (point-min)))))
240 (setq arg
(1+ arg
))))))
243 "Put mark at end of this defun, point at beginning.
244 The defun marked is the one that contains point or follows point."
248 (push-mark (point) nil t
)
250 (re-search-backward "^\n" (- (point) 1) t
))
252 (defun narrow-to-defun (&optional arg
)
253 "Make text outside current defun invisible.
254 The defun visible is the one that contains point or follows point.
255 Optional ARG is ignored."
262 (narrow-to-region (point) end
))))
264 (defun insert-parentheses (arg)
265 "Enclose following ARG sexps in parentheses. Leave point after open-paren.
266 A negative ARG encloses the preceding ARG sexps instead.
267 No argument is equivalent to zero: just insert `()' and leave point between.
268 If `parens-require-spaces' is non-nil, this command also inserts a space
269 before and after, depending on the surrounding characters."
271 (if arg
(setq arg
(prefix-numeric-value arg
))
273 (cond ((> arg
0) (skip-chars-forward " \t"))
274 ((< arg
0) (forward-sexp arg
) (setq arg
(- arg
))))
275 (and parens-require-spaces
277 (memq (char-syntax (preceding-char)) '(?w ?_ ?\
) ))
281 (or (eq arg
0) (forward-sexp arg
))
283 (and parens-require-spaces
285 (memq (char-syntax (following-char)) '(?w ?_ ?\
( ))
288 (defun move-past-close-and-reindent ()
289 "Move past next `)', delete indentation before it, then indent after it."
293 (while (save-excursion ; this is my contribution
294 (let ((before-paren (point)))
295 (back-to-indentation)
296 (and (= (point) before-paren
)
298 ;; Move to end of previous line.
301 ;; Verify it doesn't end within a string or comment.
305 ;; Get state at start of line.
306 (setq state
(list 0 nil nil
307 (null (calculate-lisp-indent))
310 ;; Parse state across the line to get state at end.
311 (setq state
(parse-partial-sexp (point) end nil nil
313 ;; Check not in string or comment.
314 (and (not (elt state
3)) (not (elt state
4))))))))
315 (delete-indentation))
317 (newline-and-indent))
319 (defun check-parens () ; lame name?
320 "Check for unbalanced parentheses in the current buffer.
321 More accurately, check the narrowed part of the buffer for unbalanced
322 expressions (\"sexps\") in general. This is done according to the
323 current syntax table and will find unbalanced brackets or quotes as
324 appropriate. (See Info node `(emacs)Lists and Sexps'.) If imbalance
325 is found, an error is signalled and point is left at the first
326 unbalanced character."
329 ;; Buffer can't have more than (point-max) sexps.
330 (scan-sexps (point-min) (point-max))
331 (scan-error (goto-char (nth 2 data
))
332 ;; Could print (nth 1 data), which is either
333 ;; "Containing expression ends prematurely" or
334 ;; "Unbalanced parentheses", but those may not be so
335 ;; accurate/helpful, e.g. quotes may actually be
337 (error "Unmatched bracket or quote"))
338 (error (cond ((eq 'scan-error
(car data
))
339 (goto-char (nth 2 data
))
340 (error "Unmatched bracket or quote"))
341 (t (signal (car data
) (cdr data
)))))))
343 (defun lisp-complete-symbol (&optional predicate
)
344 "Perform completion on Lisp symbol preceding point.
345 Compare that symbol against the known Lisp symbols.
347 When called from a program, optional arg PREDICATE is a predicate
348 determining which symbols are considered, e.g. `commandp'.
349 If PREDICATE is nil, the context determines which symbols are
350 considered. If the symbol starts just after an open-parenthesis, only
351 symbols with function definitions are considered. Otherwise, all
352 symbols with function definitions, values or properties are
356 (beg (with-syntax-table emacs-lisp-mode-syntax-table
359 (while (= (char-syntax (following-char)) ?
\')
362 (pattern (buffer-substring-no-properties beg end
))
365 (if (eq (char-after (1- beg
)) ?\
()
367 (function (lambda (sym)
368 (or (boundp sym
) (fboundp sym
)
369 (symbol-plist sym
)))))))
370 (completion (try-completion pattern obarray predicate
)))
371 (cond ((eq completion t
))
373 (message "Can't find completion for \"%s\"" pattern
)
375 ((not (string= pattern completion
))
376 (delete-region beg end
)
379 (message "Making completion list...")
380 (let ((list (all-completions pattern obarray predicate
)))
381 (setq list
(sort list
'string
<))
382 (or (eq predicate
'fboundp
)
385 (setq new
(cons (if (fboundp (intern (car list
)))
386 (list (car list
) " <f>")
389 (setq list
(cdr list
)))
390 (setq list
(nreverse new
))))
391 (with-output-to-temp-buffer "*Completions*"
392 (display-completion-list list
)))
393 (message "Making completion list...%s" "done")))))
395 ;;; lisp.el ends here