lisp-mode.el 48.3 KB
Newer Older
1
;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3 4
;; Copyright (C) 1985, 1986, 1999, 2000, 2001, 2002, 2003, 2004,
;;   2005 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: lisp, languages
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Brian Preble's avatar
Brian Preble committed
9 10 11 12
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
13
;; the Free Software Foundation; either version 2, or (at your option)
Brian Preble's avatar
Brian Preble committed
14 15 16 17 18 19 20 21
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Brian Preble's avatar
Brian Preble committed
25

26 27 28
;;; Commentary:

;; The base major mode for editing Lisp code (used also for Emacs Lisp).
Dave Love's avatar
Dave Love committed
29
;; This mode is documented in the Emacs manual.
30 31 32

;;; Code:

33 34 35 36 37
(defvar font-lock-comment-face)
(defvar font-lock-doc-face)
(defvar font-lock-keywords-case-fold-search)
(defvar font-lock-string-face)

Dave Love's avatar
Dave Love committed
38
(defvar lisp-mode-abbrev-table nil)
Brian Preble's avatar
Brian Preble committed
39

Dave Love's avatar
Dave Love committed
40 41
(defvar emacs-lisp-mode-syntax-table
  (let ((table (make-syntax-table)))
Brian Preble's avatar
Brian Preble committed
42 43
    (let ((i 0))
      (while (< i ?0)
Dave Love's avatar
Dave Love committed
44
	(modify-syntax-entry i "_   " table)
Brian Preble's avatar
Brian Preble committed
45 46 47
	(setq i (1+ i)))
      (setq i (1+ ?9))
      (while (< i ?A)
Dave Love's avatar
Dave Love committed
48
	(modify-syntax-entry i "_   " table)
Brian Preble's avatar
Brian Preble committed
49 50 51
	(setq i (1+ i)))
      (setq i (1+ ?Z))
      (while (< i ?a)
Dave Love's avatar
Dave Love committed
52
	(modify-syntax-entry i "_   " table)
Brian Preble's avatar
Brian Preble committed
53 54 55
	(setq i (1+ i)))
      (setq i (1+ ?z))
      (while (< i 128)
Dave Love's avatar
Dave Love committed
56
	(modify-syntax-entry i "_   " table)
Brian Preble's avatar
Brian Preble committed
57
	(setq i (1+ i)))
58
      (modify-syntax-entry ?\s "    " table)
Dave Love's avatar
Dave Love committed
59 60 61
      (modify-syntax-entry ?\t "    " table)
      (modify-syntax-entry ?\f "    " table)
      (modify-syntax-entry ?\n ">   " table)
62 63 64
;;; This is probably obsolete since nowadays such features use overlays.
;;;      ;; Give CR the same syntax as newline, for selective-display.
;;;      (modify-syntax-entry ?\^m ">   " table)
Dave Love's avatar
Dave Love committed
65 66 67 68
      (modify-syntax-entry ?\; "<   " table)
      (modify-syntax-entry ?` "'   " table)
      (modify-syntax-entry ?' "'   " table)
      (modify-syntax-entry ?, "'   " table)
69
      (modify-syntax-entry ?@ "'   " table)
Brian Preble's avatar
Brian Preble committed
70
      ;; Used to be singlequote; changed for flonums.
Dave Love's avatar
Dave Love committed
71 72 73 74 75 76 77
      (modify-syntax-entry ?. "_   " table)
      (modify-syntax-entry ?# "'   " table)
      (modify-syntax-entry ?\" "\"    " table)
      (modify-syntax-entry ?\\ "\\   " table)
      (modify-syntax-entry ?\( "()  " table)
      (modify-syntax-entry ?\) ")(  " table)
      (modify-syntax-entry ?\[ "(]  " table)
78
      (modify-syntax-entry ?\] ")[  " table))
Dave Love's avatar
Dave Love committed
79 80 81 82 83 84 85
    table))

(defvar lisp-mode-syntax-table
  (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
    (modify-syntax-entry ?\[ "_   " table)
    (modify-syntax-entry ?\] "_   " table)
    (modify-syntax-entry ?# "' 14bn" table)
86
    (modify-syntax-entry ?| "\" 23b" table)
Dave Love's avatar
Dave Love committed
87
    table))
Jim Blandy's avatar
Jim Blandy committed
88

Brian Preble's avatar
Brian Preble committed
89 90
(define-abbrev-table 'lisp-mode-abbrev-table ())

91
(defvar lisp-imenu-generic-expression
Dave Love's avatar
Dave Love committed
92
  (list
93
   (list nil
94 95 96 97 98 99
	 (purecopy (concat "^\\s-*("
			   (eval-when-compile
			     (regexp-opt
			      '("defun" "defun*" "defsubst" "defmacro"
				"defadvice" "define-skeleton"
				"define-minor-mode" "define-derived-mode"
100
				"define-generic-mode"
101 102 103
				"define-compiler-macro" "define-modify-macro"
				"defsetf" "define-setf-expander"
				"define-method-combination"
104 105
				"defgeneric" "defmethod") t))
			   "\\s-+\\(\\sw\\(\\sw\\|\\s_\\)+\\)"))
106
	 2)
107
   (list (purecopy "Variables")
108 109 110 111
	 (purecopy (concat "^\\s-*("
			   (eval-when-compile
			     (regexp-opt
			      '("defvar" "defconst" "defconstant" "defcustom"
112 113
				"defparameter" "define-symbol-macro") t))
			   "\\s-+\\(\\sw\\(\\sw\\|\\s_\\)+\\)"))
114
	 2)
115
   (list (purecopy "Types")
116 117 118
	 (purecopy (concat "^\\s-*("
			   (eval-when-compile
			     (regexp-opt
119 120 121
			      '("defgroup" "deftheme" "deftype" "defstruct"
				"defclass" "define-condition" "define-widget"
				"defface" "defpackage") t))
122
			   "\\s-+'?\\(\\sw\\(\\sw\\|\\s_\\)+\\)"))
123 124 125 126
	 2))

  "Imenu generic expression for Lisp mode.  See `imenu-generic-expression'.")

127 128 129 130 131 132
;; This was originally in autoload.el and is still used there.
(put 'autoload 'doc-string-elt 3)
(put 'defun    'doc-string-elt 3)
(put 'defun*    'doc-string-elt 3)
(put 'defvar   'doc-string-elt 3)
(put 'defcustom 'doc-string-elt 3)
133
(put 'deftheme 'doc-string-elt 2)
134 135
(put 'defconst 'doc-string-elt 3)
(put 'defmacro 'doc-string-elt 3)
136
(put 'defmacro* 'doc-string-elt 3)
137
(put 'defsubst 'doc-string-elt 3)
138
(put 'defstruct 'doc-string-elt 2)
139 140
(put 'define-skeleton 'doc-string-elt 2)
(put 'define-derived-mode 'doc-string-elt 4)
141
(put 'define-compilation-mode 'doc-string-elt 3)
142 143 144 145 146
(put 'easy-mmode-define-minor-mode 'doc-string-elt 2)
(put 'define-minor-mode 'doc-string-elt 2)
(put 'define-generic-mode 'doc-string-elt 7)
;; define-global-mode has no explicit docstring.
(put 'easy-mmode-define-global-mode 'doc-string-elt 0)
147
(put 'define-ibuffer-filter 'doc-string-elt 2)
148
(put 'define-ibuffer-op 'doc-string-elt 3)
149
(put 'define-ibuffer-sorter 'doc-string-elt 2)
150 151 152 153 154 155 156 157 158

(defun lisp-font-lock-syntactic-face-function (state)
  (if (nth 3 state)
      (if (and (eq (nth 0 state) 1)
	       ;; This might be a docstring.
	       (save-excursion
		 (let ((n 0))
		   (goto-char (nth 8 state))
		   (condition-case nil
159 160
		       (while (and (not (bobp))
				   (progn (backward-sexp 1) (setq n (1+ n)))))
161 162 163 164 165
		     (scan-error nil))
		   (when (> n 0)
		     (let ((sym (intern-soft
				 (buffer-substring
				  (point) (progn (forward-sexp 1) (point))))))
166
		       (eq n (get sym 'doc-string-elt)))))))
167 168 169 170 171 172 173
	  font-lock-doc-face
	font-lock-string-face)
    font-lock-comment-face))

;; The LISP-SYNTAX argument is used by code in inf-lisp.el and is
;; (uselessly) passed from pp.el, chistory.el, gnus-kill.el and score-mode.el
(defun lisp-mode-variables (&optional lisp-syntax)
174 175
  (when lisp-syntax
    (set-syntax-table lisp-mode-syntax-table))
Brian Preble's avatar
Brian Preble committed
176 177 178
  (setq local-abbrev-table lisp-mode-abbrev-table)
  (make-local-variable 'paragraph-ignore-fill-prefix)
  (setq paragraph-ignore-fill-prefix t)
179 180
  (make-local-variable 'fill-paragraph-function)
  (setq fill-paragraph-function 'lisp-fill-paragraph)
181 182 183 184
  ;; Adaptive fill mode gets the fill wrong for a one-line paragraph made of
  ;; a single docstring.  Let's fix it here.
  (set (make-local-variable 'adaptive-fill-function)
       (lambda () (if (looking-at "\\s-+\"[^\n\"]+\"\\s-*$") "")))
185 186 187
  ;; Adaptive fill mode gets in the way of auto-fill,
  ;; and should make no difference for explicit fill
  ;; because lisp-fill-paragraph should do the job.
188 189
  ;;  I believe that newcomment's auto-fill code properly deals with it  -stef
  ;;(set (make-local-variable 'adaptive-fill-mode) nil)
Brian Preble's avatar
Brian Preble committed
190 191 192 193 194 195
  (make-local-variable 'indent-line-function)
  (setq indent-line-function 'lisp-indent-line)
  (make-local-variable 'indent-region-function)
  (setq indent-region-function 'lisp-indent-region)
  (make-local-variable 'parse-sexp-ignore-comments)
  (setq parse-sexp-ignore-comments t)
196
  (make-local-variable 'outline-regexp)
197
  (setq outline-regexp ";;;\\(;* [^ \t\n]\\|###autoload\\)\\|(")
Gerd Moellmann's avatar
Gerd Moellmann committed
198 199
  (make-local-variable 'outline-level)
  (setq outline-level 'lisp-outline-level)
Brian Preble's avatar
Brian Preble committed
200 201 202
  (make-local-variable 'comment-start)
  (setq comment-start ";")
  (make-local-variable 'comment-start-skip)
203 204 205
  ;; Look within the line for a ; following an even number of backslashes
  ;; after either a non-backslash or the line beginning.
  (setq comment-start-skip "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\);+ *")
206 207
  (make-local-variable 'font-lock-comment-start-skip)
  ;; Font lock mode uses this only when it KNOWS a comment is starting.
208
  (setq font-lock-comment-start-skip ";+ *")
209 210
  (make-local-variable 'comment-add)
  (setq comment-add 1)			;default to `;;' in comment-region
Brian Preble's avatar
Brian Preble committed
211 212
  (make-local-variable 'comment-column)
  (setq comment-column 40)
213 214
  ;; Don't get confused by `;' in doc strings when paragraph-filling.
  (set (make-local-variable 'comment-use-global-state) t)
215 216
  (make-local-variable 'comment-indent-function)
  (setq comment-indent-function 'lisp-comment-indent)
217
  (make-local-variable 'imenu-generic-expression)
218 219
  (setq imenu-generic-expression lisp-imenu-generic-expression)
  (make-local-variable 'multibyte-syntax-as-symbol)
Stefan Monnier's avatar
Stefan Monnier committed
220
  (setq multibyte-syntax-as-symbol t)
221
  (set (make-local-variable 'syntax-begin-function) 'beginning-of-defun)
Stefan Monnier's avatar
Stefan Monnier committed
222 223 224
  (setq font-lock-defaults
	'((lisp-font-lock-keywords
	   lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
225
	  nil nil (("+-*/.<>=!?$%_&~^:@" . "w")) nil
226 227 228
	  (font-lock-mark-block-function . mark-defun)
	  (font-lock-syntactic-face-function
	   . lisp-font-lock-syntactic-face-function))))
Gerd Moellmann's avatar
Gerd Moellmann committed
229 230 231

(defun lisp-outline-level ()
  "Lisp mode `outline-level' function."
232 233 234 235
  (let ((len (- (match-end 0) (match-beginning 0))))
    (if (looking-at "(\\|;;;###autoload")
	1000
      len)))
236

Stefan Monnier's avatar
Stefan Monnier committed
237 238
(defvar lisp-mode-shared-map
  (let ((map (make-sparse-keymap)))
239
    (define-key map "\t" 'lisp-indent-line)
Stefan Monnier's avatar
Stefan Monnier committed
240 241
    (define-key map "\e\C-q" 'indent-sexp)
    (define-key map "\177" 'backward-delete-char-untabify)
242 243 244 245
    ;; This gets in the way when viewing a Lisp file in view-mode.  As
    ;; long as [backspace] is mapped into DEL via the
    ;; function-key-map, this should remain disabled!!
    ;;;(define-key map [backspace] 'backward-delete-char-untabify)
Stefan Monnier's avatar
Stefan Monnier committed
246
    map)
Brian Preble's avatar
Brian Preble committed
247 248 249 250
  "Keymap for commands shared by all sorts of Lisp modes.")

(defvar emacs-lisp-mode-map ()
  "Keymap for Emacs Lisp mode.
251
All commands in `lisp-mode-shared-map' are inherited by this map.")
Brian Preble's avatar
Brian Preble committed
252 253 254

(if emacs-lisp-mode-map
    ()
255
  (let ((map (make-sparse-keymap "Emacs-Lisp")))
256
    (setq emacs-lisp-mode-map (make-sparse-keymap))
257
    (set-keymap-parent emacs-lisp-mode-map lisp-mode-shared-map)
258 259
    (define-key emacs-lisp-mode-map "\e\t" 'lisp-complete-symbol)
    (define-key emacs-lisp-mode-map "\e\C-x" 'eval-defun)
260
    (define-key emacs-lisp-mode-map "\e\C-q" 'indent-pp-sexp)
261 262 263 264 265 266 267
    (define-key emacs-lisp-mode-map [menu-bar] (make-sparse-keymap))
    (define-key emacs-lisp-mode-map [menu-bar emacs-lisp]
      (cons "Emacs-Lisp" map))
    (define-key map [edebug-defun]
      '("Instrument Function for Debugging" . edebug-defun))
    (define-key map [byte-recompile]
      '("Byte-recompile Directory..." . byte-recompile-directory))
268
    (define-key map [emacs-byte-compile-and-load]
269
      '("Byte-compile And Load" . emacs-lisp-byte-compile-and-load))
270 271 272 273 274 275 276 277 278
    (define-key map [byte-compile]
      '("Byte-compile This File" . emacs-lisp-byte-compile))
    (define-key map [separator-eval] '("--"))
    (define-key map [eval-buffer] '("Evaluate Buffer" . eval-current-buffer))
    (define-key map [eval-region] '("Evaluate Region" . eval-region))
    (define-key map [eval-sexp] '("Evaluate Last S-expression" . eval-last-sexp))
    (define-key map [separator-format] '("--"))
    (define-key map [comment-region] '("Comment Out Region" . comment-region))
    (define-key map [indent-region] '("Indent Region" . indent-region))
279 280 281 282
    (define-key map [indent-line] '("Indent Line" . lisp-indent-line))
    (put 'eval-region 'menu-enable 'mark-active)
    (put 'comment-region 'menu-enable 'mark-active)
    (put 'indent-region 'menu-enable 'mark-active)))
283 284 285 286 287 288

(defun emacs-lisp-byte-compile ()
  "Byte compile the file containing the current buffer."
  (interactive)
  (if buffer-file-name
      (byte-compile-file buffer-file-name)
289 290
    (error "The buffer must be saved in a file first")))

291
(defun emacs-lisp-byte-compile-and-load ()
292 293 294 295 296 297
  "Byte-compile the current file (if it has changed), then load compiled code."
  (interactive)
  (or buffer-file-name
      (error "The buffer must be saved in a file first"))
  (require 'bytecomp)
  ;; Recompile if file or buffer has changed since last compilation.
298
  (if (and (buffer-modified-p)
Dave Love's avatar
Dave Love committed
299
	   (y-or-n-p (format "Save buffer %s first? " (buffer-name))))
300 301 302 303 304
      (save-buffer))
  (let ((compiled-file-name (byte-compile-dest-file buffer-file-name)))
    (if (file-newer-than-file-p compiled-file-name buffer-file-name)
	(load-file compiled-file-name)
      (byte-compile-file buffer-file-name t))))
Brian Preble's avatar
Brian Preble committed
305

306 307
(defcustom emacs-lisp-mode-hook nil
  "Hook run when entering Emacs Lisp mode."
Dave Love's avatar
Dave Love committed
308
  :options '(turn-on-eldoc-mode imenu-add-menubar-index checkdoc-minor-mode)
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
  :type 'hook
  :group 'lisp)

(defcustom lisp-mode-hook nil
  "Hook run when entering Lisp mode."
  :options '(imenu-add-menubar-index)
  :type 'hook
  :group 'lisp)

(defcustom lisp-interaction-mode-hook nil
  "Hook run when entering Lisp Interaction mode."
  :options '(turn-on-eldoc-mode)
  :type 'hook
  :group 'lisp)

324
(defun emacs-lisp-mode ()
Brian Preble's avatar
Brian Preble committed
325 326 327 328 329 330 331
  "Major mode for editing Lisp code to run in Emacs.
Commands:
Delete converts tabs to spaces as it moves back.
Blank lines separate paragraphs.  Semicolons start comments.
\\{emacs-lisp-mode-map}
Entry to this mode calls the value of `emacs-lisp-mode-hook'
if that value is non-nil."
332 333 334 335 336 337
  (interactive)
  (kill-all-local-variables)
  (use-local-map emacs-lisp-mode-map)
  (set-syntax-table emacs-lisp-mode-syntax-table)
  (setq major-mode 'emacs-lisp-mode)
  (setq mode-name "Emacs-Lisp")
338
  (lisp-mode-variables)
339
  (setq imenu-case-fold-search nil)
340
  (run-mode-hooks 'emacs-lisp-mode-hook))
341
(put 'emacs-lisp-mode 'custom-mode-group 'lisp)
Brian Preble's avatar
Brian Preble committed
342

Dave Love's avatar
Dave Love committed
343 344
(defvar lisp-mode-map
  (let ((map (make-sparse-keymap)))
345
    (set-keymap-parent map lisp-mode-shared-map)
Dave Love's avatar
Dave Love committed
346 347 348
    (define-key map "\e\C-x" 'lisp-eval-defun)
    (define-key map "\C-c\C-z" 'run-lisp)
    map)
Brian Preble's avatar
Brian Preble committed
349
  "Keymap for ordinary Lisp mode.
350
All commands in `lisp-mode-shared-map' are inherited by this map.")
Brian Preble's avatar
Brian Preble committed
351

352
(defun lisp-mode ()
Brian Preble's avatar
Brian Preble committed
353 354 355 356 357 358 359 360 361 362
  "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
Commands:
Delete converts tabs to spaces as it moves back.
Blank lines separate paragraphs.  Semicolons start comments.
\\{lisp-mode-map}
Note that `run-lisp' may be used either to start an inferior Lisp job
or to switch back to an existing one.

Entry to this mode calls the value of `lisp-mode-hook'
if that value is non-nil."
363 364 365 366 367
  (interactive)
  (kill-all-local-variables)
  (use-local-map lisp-mode-map)
  (setq major-mode 'lisp-mode)
  (setq mode-name "Lisp")
368
  (lisp-mode-variables)
369 370
  (make-local-variable 'comment-start-skip)
  (setq comment-start-skip
371
       "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(;+\\|#|\\) *")
372 373 374 375
  (make-local-variable 'font-lock-keywords-case-fold-search)
  (setq font-lock-keywords-case-fold-search t)
  (setq imenu-case-fold-search t)
  (set-syntax-table lisp-mode-syntax-table)
376
  (run-mode-hooks 'lisp-mode-hook))
377 378 379 380 381 382 383
(put 'lisp-mode 'find-tag-default-function 'lisp-find-tag-default)

(defun lisp-find-tag-default ()
  (let ((default (find-tag-default)))
    (when (stringp default)
      (if (string-match ":+" default)
          (substring default (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
384
	default))))
Brian Preble's avatar
Brian Preble committed
385

Dave Love's avatar
Dave Love committed
386 387 388
;; Used in old LispM code.
(defalias 'common-lisp-mode 'lisp-mode)

389 390
;; This will do unless inf-lisp.el is loaded.
(defun lisp-eval-defun (&optional and-go)
Brian Preble's avatar
Brian Preble committed
391 392 393 394
  "Send the current defun to the Lisp process made by \\[run-lisp]."
  (interactive)
  (error "Process lisp does not exist"))

Dave Love's avatar
Dave Love committed
395 396
(defvar lisp-interaction-mode-map
  (let ((map (make-sparse-keymap)))
397
    (set-keymap-parent map lisp-mode-shared-map)
Dave Love's avatar
Dave Love committed
398
    (define-key map "\e\C-x" 'eval-defun)
399
    (define-key map "\e\C-q" 'indent-pp-sexp)
Dave Love's avatar
Dave Love committed
400 401 402
    (define-key map "\e\t" 'lisp-complete-symbol)
    (define-key map "\n" 'eval-print-last-sexp)
    map)
403
  "Keymap for Lisp Interaction mode.
404
All commands in `lisp-mode-shared-map' are inherited by this map.")
Brian Preble's avatar
Brian Preble committed
405

406
(defvar lisp-interaction-mode-abbrev-table lisp-mode-abbrev-table)
Stefan Monnier's avatar
Stefan Monnier committed
407
(define-derived-mode lisp-interaction-mode emacs-lisp-mode "Lisp Interaction"
Brian Preble's avatar
Brian Preble committed
408 409 410
  "Major mode for typing and evaluating Lisp forms.
Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
before point, and prints its value into the buffer, advancing point.
Pavel Janík's avatar
Pavel Janík committed
411
Note that printing is controlled by `eval-expression-print-length'
412
and `eval-expression-print-level'.
Brian Preble's avatar
Brian Preble committed
413 414 415 416 417 418 419

Commands:
Delete converts tabs to spaces as it moves back.
Paragraphs are separated only by blank lines.
Semicolons start comments.
\\{lisp-interaction-mode-map}
Entry to this mode calls the value of `lisp-interaction-mode-hook'
420
if that value is non-nil.")
Brian Preble's avatar
Brian Preble committed
421

Roland McGrath's avatar
Roland McGrath committed
422
(defun eval-print-last-sexp ()
423 424 425 426 427
  "Evaluate sexp before point; print value into current buffer.

Note that printing the result is controlled by the variables
`eval-expression-print-length' and `eval-expression-print-level',
which see."
Roland McGrath's avatar
Roland McGrath committed
428
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432
  (let ((standard-output (current-buffer)))
    (terpri)
    (eval-last-sexp t)
    (terpri)))
433

434

435 436 437
(defun last-sexp-setup-props (beg end value alt1 alt2)
  "Set up text properties for the output of `eval-last-sexp-1'.
BEG and END are the start and end of the output in current-buffer.
438
VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
439 440 441 442 443 444
alternative printed representations that can be displayed."
  (let ((map (make-sparse-keymap)))
    (define-key map "\C-m" 'last-sexp-toggle-display)
    (define-key map [down-mouse-2] 'mouse-set-point)
    (define-key map [mouse-2] 'last-sexp-toggle-display)
    (add-text-properties
445
     beg end
446
     `(printed-value (,value ,alt1 ,alt2)
447
		     mouse-face highlight
448 449 450 451 452 453
		     keymap ,map
		     help-echo "RET, mouse-2: toggle abbreviated display"
		     rear-nonsticky (mouse-face keymap help-echo
						printed-value)))))


454
(defun last-sexp-toggle-display (&optional arg)
455
  "Toggle between abbreviated and unabbreviated printed representations."
456
  (interactive "P")
457 458
  (save-restriction
    (widen)
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
    (let ((value (get-text-property (point) 'printed-value)))
      (when value
	(let ((beg (or (previous-single-property-change (min (point-max) (1+ (point)))
							'printed-value)
		       (point)))
	      (end (or (next-single-char-property-change (point) 'printed-value) (point)))
	      (standard-output (current-buffer))
	      (point (point)))
	  (delete-region beg end)
	  (insert (nth 1 value))
	  (last-sexp-setup-props beg (point)
				 (nth 0 value)
				 (nth 2 value)
				 (nth 1 value))
	  (goto-char (min (point-max) point)))))))
474

475 476 477 478
(defun prin1-char (char)
  "Return a string representing CHAR as a character rather than as an integer.
If CHAR is not a character, return nil."
  (and (integerp char)
Stefan Monnier's avatar
Stefan Monnier committed
479
       (eventp char)
480
       (let ((c (event-basic-type char))
481 482
	     (mods (event-modifiers char))
	     string)
483 484
	 ;; Prevent ?A from turning into ?\S-a.
	 (if (and (memq 'shift mods)
485
		  (zerop (logand char ?\S-\^@))
486 487 488
		  (not (let ((case-fold-search nil))
			 (char-equal c (upcase c)))))
	     (setq c (upcase c) mods nil))
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
	 ;; What string are we considering using?
	 (condition-case nil
	     (setq string
		   (concat
		    "?"
		    (mapconcat
		     (lambda (modif)
		       (cond ((eq modif 'super) "\\s-")
			     (t (string ?\\ (upcase (aref (symbol-name modif) 0)) ?-))))
		     mods "")
		    (cond
		     ((memq c '(?\; ?\( ?\) ?\{ ?\} ?\[ ?\] ?\" ?\' ?\\)) (string ?\\ c))
		     ((eq c 127) "\\C-?")
		     (t
		      (string c)))))
	   (error nil))
	 ;; Verify the string reads a CHAR, not to some other character.
	 ;; If it doesn't, return nil instead.
	 (and string
	      (= (car (read-from-string string)) char)
	      string))))
510

511

512
(defun eval-last-sexp-1 (eval-last-sexp-arg-internal)
Brian Preble's avatar
Brian Preble committed
513 514
  "Evaluate sexp before point; print value in minibuffer.
With argument, print output into current buffer."
515
  (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
516 517
    (let ((value
	   (eval (let ((stab (syntax-table))
518
		       (opoint (point))
519
		       ignore-quotes
520
		       expr)
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
		   (save-excursion
		     (with-syntax-table emacs-lisp-mode-syntax-table
		       ;; If this sexp appears to be enclosed in `...'
		       ;; then ignore the surrounding quotes.
		       (setq ignore-quotes
			     (or (eq (following-char) ?\')
				 (eq (preceding-char) ?\')))
		       (forward-sexp -1)
		       ;; If we were after `?\e' (or similar case),
		       ;; use the whole thing, not just the `e'.
		       (when (eq (preceding-char) ?\\)
			 (forward-char -1)
			 (when (eq (preceding-char) ??)
			   (forward-char -1)))

		       ;; Skip over `#N='s.
		       (when (eq (preceding-char) ?=)
			 (let (labeled-p)
			   (save-excursion
			     (skip-chars-backward "0-9#=")
			     (setq labeled-p (looking-at "\\(#[0-9]+=\\)+")))
			   (when labeled-p
			     (forward-sexp -1))))

		       (save-restriction
			 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
			 ;; `variable' so that the value is returned, not the
			 ;; name
			 (if (and ignore-quotes
				  (eq (following-char) ?`))
			     (forward-char))
			 (narrow-to-region (point-min) opoint)
			 (setq expr (read (current-buffer)))
			 ;; If it's an (interactive ...) form, it's more
			 ;; useful to show how an interactive call would
			 ;; use it.
			 (and (consp expr)
			      (eq (car expr) 'interactive)
			      (setq expr
				    (list 'call-interactively
					  (list 'quote
						(list 'lambda
						      '(&rest args)
						      expr
						      'args)))))
			 expr)))))))
567 568 569 570 571 572 573 574 575 576 577
      (eval-last-sexp-print-value value))))

(defun eval-last-sexp-print-value (value)
  (let ((unabbreviated (let ((print-length nil) (print-level nil))
			 (prin1-to-string value)))
	(print-length eval-expression-print-length)
	(print-level eval-expression-print-level)
	(beg (point))
	end)
    (prog1
	(prin1 value)
578 579
      (let ((str (eval-expression-print-format value)))
	(if str (princ str)))
580 581 582 583 584 585 586 587 588 589
      (setq end (point))
      (when (and (bufferp standard-output)
		 (or (not (null print-length))
		     (not (null print-level)))
		 (not (string= unabbreviated
			       (buffer-substring-no-properties beg end))))
	(last-sexp-setup-props beg end value
			       unabbreviated
			       (buffer-substring-no-properties beg end))
	))))
590

Brian Preble's avatar
Brian Preble committed
591

592 593
(defvar eval-last-sexp-fake-value (make-symbol "t"))

594 595
(defun eval-last-sexp (eval-last-sexp-arg-internal)
  "Evaluate sexp before point; print value in minibuffer.
596
Interactively, with prefix argument, print output into current buffer."
597 598 599
  (interactive "P")
  (if (null eval-expression-debug-on-error)
      (eval-last-sexp-1 eval-last-sexp-arg-internal)
600
    (let ((old-value eval-last-sexp-fake-value) new-value value)
601 602 603 604 605 606
      (let ((debug-on-error old-value))
	(setq value (eval-last-sexp-1 eval-last-sexp-arg-internal))
	(setq new-value debug-on-error))
      (unless (eq old-value new-value)
	(setq debug-on-error new-value))
      value)))
607

608
(defun eval-defun-1 (form)
609 610 611
  "Treat some expressions specially.
Reset the `defvar' and `defcustom' variables to the initial value.
Reinitialize the face according to the `defface' specification."
612 613
  ;; The code in edebug-defun should be consistent with this, but not
  ;; the same, since this gets a macroexpended form.
614 615 616
  (cond ((not (listp form))
	 form)
	((and (eq (car form) 'defvar)
617 618 619 620
	      (cdr-safe (cdr-safe form))
	      (boundp (cadr form)))
	 ;; Force variable to be re-set.
	 `(progn (defvar ,(nth 1 form) nil ,@(nthcdr 3 form))
621
		 (setq-default ,(nth 1 form) ,(nth 2 form))))
622 623
	;; `defcustom' is now macroexpanded to
	;; `custom-declare-variable' with a quoted value arg.
Dave Love's avatar
Dave Love committed
624 625
	((and (eq (car form) 'custom-declare-variable)
	      (default-boundp (eval (nth 1 form))))
626
	 ;; Force variable to be bound.
627
	 (set-default (eval (nth 1 form)) (eval (nth 1 (nth 2 form))))
628
	 form)
629 630 631 632 633
	;; `defface' is macroexpanded to `custom-declare-face'.
	((eq (car form) 'custom-declare-face)
	 ;; Reset the face.
	 (setq face-new-frame-defaults
	       (assq-delete-all (eval (nth 1 form)) face-new-frame-defaults))
Juri Linkov's avatar
Juri Linkov committed
634 635 636 637 638 639 640 641 642 643
	 (put (eval (nth 1 form)) 'face-defface-spec nil)
	 ;; Setting `customized-face' to the new spec after calling
	 ;; the form, but preserving the old saved spec in `saved-face',
	 ;; imitates the situation when the new face spec is set
	 ;; temporarily for the current session in the customize
	 ;; buffer, thus allowing `face-user-default-spec' to use the
	 ;; new customized spec instead of the saved spec.
	 ;; Resetting `saved-face' temporarily to nil is needed to let
	 ;; `defface' change the spec, regardless of a saved spec.
	 (prog1 `(prog1 ,form
644
		   (put ,(nth 1 form) 'saved-face
Juri Linkov's avatar
Juri Linkov committed
645
			',(get (eval (nth 1 form)) 'saved-face))
646 647
		   (put ,(nth 1 form) 'customized-face
			,(nth 2 form)))
Juri Linkov's avatar
Juri Linkov committed
648
	   (put (eval (nth 1 form)) 'saved-face nil)))
649 650 651 652
	((eq (car form) 'progn)
	 (cons 'progn (mapcar 'eval-defun-1 (cdr form))))
	(t form)))

653
(defun eval-defun-2 ()
Roland McGrath's avatar
Roland McGrath committed
654
  "Evaluate defun that point is in or before.
Karl Heuer's avatar
Karl Heuer committed
655 656 657 658 659 660 661
The value is displayed in the minibuffer.
If the current defun is actually a call to `defvar',
then reset the variable using the initial value expression
even if the variable already has some other value.
\(Normally `defvar' does not change the variable's value
if it already has a value.\)

662 663
With argument, insert value in current buffer after the defun.
Return the result of evaluation."
Brian Preble's avatar
Brian Preble committed
664
  (interactive "P")
665 666 667 668 669 670 671 672 673
  (let ((debug-on-error eval-expression-debug-on-error)
	(print-length eval-expression-print-length)
	(print-level eval-expression-print-level))
    (save-excursion
      ;; Arrange for eval-region to "read" the (possibly) altered form.
      ;; eval-region handles recording which file defines a function or
      ;; variable.  Re-written using `apply' to avoid capturing
      ;; variables like `end'.
      (apply
674
       #'eval-region
675
       (let ((standard-output t)
676 677 678 679 680 681 682 683
	     beg end form)
	 ;; Read the form from the buffer, and record where it ends.
	 (save-excursion
	   (end-of-defun)
	   (beginning-of-defun)
	   (setq beg (point))
	   (setq form (read (current-buffer)))
	   (setq end (point)))
684
	 ;; Alter the form if necessary.
685 686 687 688 689 690 691
	 (setq form (eval-defun-1 (macroexpand form)))
	 (list beg end standard-output
	       `(lambda (ignore)
		 ;; Skipping to the end of the specified region
		 ;; will make eval-region return.
		 (goto-char ,end)
		 ',form))))))
Dave Love's avatar
Dave Love committed
692 693
  ;; The result of evaluation has been put onto VALUES.  So return it.
  (car values))
694

695 696
(defun eval-defun (edebug-it)
  "Evaluate the top-level form containing point, or after point.
697

Richard M. Stallman's avatar
Richard M. Stallman committed
698 699 700 701 702
If the current defun is actually a call to `defvar' or `defcustom',
evaluating it this way resets the variable using its initial value
expression even if the variable already has some other value.
\(Normally `defvar' and `defcustom' do not alter the value if there
already is one.)
703 704 705 706 707 708 709 710

With a prefix argument, instrument the code for Edebug.

If acting on a `defun' for FUNCTION, and the function was
instrumented, `Edebug: FUNCTION' is printed in the minibuffer.  If not
instrumented, just FUNCTION is printed.

If not acting on a `defun', the result of evaluation is displayed in
711 712 713
the minibuffer.  This display is controlled by the variables
`eval-expression-print-length' and `eval-expression-print-level',
which see."
714
  (interactive "P")
715 716 717 718 719 720 721 722 723 724 725 726 727
  (cond (edebug-it
	 (require 'edebug)
	 (eval-defun (not edebug-all-defs)))
	(t
	 (if (null eval-expression-debug-on-error)
	     (eval-defun-2)
	   (let ((old-value (make-symbol "t")) new-value value)
	     (let ((debug-on-error old-value))
	       (setq value (eval-defun-2))
	       (setq new-value debug-on-error))
	     (unless (eq old-value new-value)
	       (setq debug-on-error new-value))
	     value)))))
728

729
;; Used for comment-indent-function in Lisp modes.
Brian Preble's avatar
Brian Preble committed
730 731 732 733
(defun lisp-comment-indent ()
  (if (looking-at "\\s<\\s<\\s<")
      (current-column)
    (if (looking-at "\\s<\\s<")
734
	(let ((tem (or (calculate-lisp-indent) (current-column))))
Brian Preble's avatar
Brian Preble committed
735 736 737 738 739
	  (if (listp tem) (car tem) tem))
      (skip-chars-backward " \t")
      (max (if (bolp) 0 (1+ (current-column)))
	   comment-column))))

740 741 742
;; This function just forces a more costly detection of comments (using
;; parse-partial-sexp from beginning-of-defun).  I.e. It avoids the problem of
;; taking a `;' inside a string started on another line for a comment starter.
743 744
;; Note: `newcomment' gets it right now since we set comment-use-global-state
;; so we could get rid of it.   -stef
745 746 747
(defun lisp-mode-auto-fill ()
  (if (> (current-column) (current-fill-column))
      (if (save-excursion
748
	    (nth 4 (syntax-ppss (point))))
749
	  (do-auto-fill)
750 751 752 753
	(unless (and (boundp 'comment-auto-fill-only-comments)
		     comment-auto-fill-only-comments)
	  (let ((comment-start nil) (comment-start-skip nil))
	    (do-auto-fill))))))
754

755 756
(defvar lisp-indent-offset nil
  "If non-nil, indent second line of expressions that many more columns.")
Dave Love's avatar
Dave Love committed
757
(defvar lisp-indent-function 'lisp-indent-function)
Brian Preble's avatar
Brian Preble committed
758 759 760 761 762 763

(defun lisp-indent-line (&optional whole-exp)
  "Indent current line as Lisp code.
With argument, indent any additional lines of the same expression
rigidly along with this one."
  (interactive "P")
764 765 766
  (let ((indent (calculate-lisp-indent)) shift-amt end
	(pos (- (point-max) (point)))
	(beg (progn (beginning-of-line) (point))))
Brian Preble's avatar
Brian Preble committed
767
    (skip-chars-forward " \t")
768 769 770
    (if (or (null indent) (looking-at "\\s<\\s<\\s<"))
	;; Don't alter indentation of a ;;; comment line
	;; or a line that starts in a string.
771
	(goto-char (- (point-max) pos))
Brian Preble's avatar
Brian Preble committed
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
      (if (and (looking-at "\\s<") (not (looking-at "\\s<\\s<")))
	  ;; Single-semicolon comment lines should be indented
	  ;; as comment lines, not as code.
	  (progn (indent-for-comment) (forward-char -1))
	(if (listp indent) (setq indent (car indent)))
	(setq shift-amt (- indent (current-column)))
	(if (zerop shift-amt)
	    nil
	  (delete-region beg (point))
	  (indent-to indent)))
      ;; If initial point was within line's indentation,
      ;; position after the indentation.  Else stay at same point in text.
      (if (> (- (point-max) pos) (point))
	  (goto-char (- (point-max) pos)))
      ;; If desired, shift remaining lines of expression the same amount.
      (and whole-exp (not (zerop shift-amt))
	   (save-excursion
	     (goto-char beg)
	     (forward-sexp 1)
	     (setq end (point))
	     (goto-char beg)
	     (forward-line 1)
	     (setq beg (point))
	     (> end beg))
	   (indent-code-rigidly beg end shift-amt)))))

798
(defvar calculate-lisp-indent-last-sexp)
799

Brian Preble's avatar
Brian Preble committed
800 801 802
(defun calculate-lisp-indent (&optional parse-start)
  "Return appropriate indentation for current line as Lisp code.
In usual case returns an integer: the column to indent to.
803 804 805 806
If the value is nil, that means don't change the indentation
because the line starts inside a string.

The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
Brian Preble's avatar
Brian Preble committed
807
This means that following lines at the same level of indentation
808 809 810
should not necessarily be indented the same as this line.
Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
is the buffer position of the start of the containing expression."
Brian Preble's avatar
Brian Preble committed
811 812 813 814 815 816 817
  (save-excursion
    (beginning-of-line)
    (let ((indent-point (point))
          state paren-depth
          ;; setting this to a number inhibits calling hook
          (desired-indent nil)
          (retry t)
818
          calculate-lisp-indent-last-sexp containing-sexp)
Brian Preble's avatar
Brian Preble committed
819 820 821 822 823 824 825 826 827 828 829
      (if parse-start
          (goto-char parse-start)
          (beginning-of-defun))
      ;; Find outermost containing sexp
      (while (< (point) indent-point)
        (setq state (parse-partial-sexp (point) indent-point 0)))
      ;; Find innermost containing sexp
      (while (and retry
		  state
                  (> (setq paren-depth (elt state 0)) 0))
        (setq retry nil)
830
        (setq calculate-lisp-indent-last-sexp (elt state 2))
Brian Preble's avatar
Brian Preble committed
831 832 833 834
        (setq containing-sexp (elt state 1))
        ;; Position following last unclosed open.
        (goto-char (1+ containing-sexp))
        ;; Is there a complete sexp since then?
835 836
        (if (and calculate-lisp-indent-last-sexp
		 (> calculate-lisp-indent-last-sexp (point)))
Brian Preble's avatar
Brian Preble committed
837
            ;; Yes, but is there a containing sexp after that?
838 839
            (let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
					    indent-point 0)))
Brian Preble's avatar
Brian Preble committed
840 841 842 843 844
              (if (setq retry (car (cdr peek))) (setq state peek)))))
      (if retry
          nil
        ;; Innermost containing sexp found
        (goto-char (1+ containing-sexp))
845
        (if (not calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
846 847 848 849
	    ;; indent-point immediately follows open paren.
	    ;; Don't call hook.
            (setq desired-indent (current-column))
	  ;; Find the start of first element of containing sexp.
850
	  (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
Brian Preble's avatar
Brian Preble committed
851 852 853 854 855
	  (cond ((looking-at "\\s(")
		 ;; First element of containing sexp is a list.
		 ;; Indent under that list.
		 )
		((> (save-excursion (forward-line 1) (point))
856
		    calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
857 858
		 ;; This is the first line to start within the containing sexp.
		 ;; It's almost certainly a function call.
859
		 (if (= (point) calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
860 861 862 863 864 865
		     ;; Containing sexp has nothing before this line
		     ;; except the first element.  Indent under that element.
		     nil
		   ;; Skip the first element, find start of second (the first
		   ;; argument of the function call) and indent under.
		   (progn (forward-sexp 1)
866 867 868
			  (parse-partial-sexp (point)
					      calculate-lisp-indent-last-sexp
					      0 t)))
Brian Preble's avatar
Brian Preble committed
869 870
		 (backward-prefix-chars))
		(t
871
		 ;; Indent beneath first sexp on same line as
Dave Love's avatar
Dave Love committed
872
		 ;; `calculate-lisp-indent-last-sexp'.  Again, it's
873 874
		 ;; almost certainly a function call.
		 (goto-char calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
875
		 (beginning-of-line)
876 877
		 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
				     0 t)
Brian Preble's avatar
Brian Preble committed
878 879
		 (backward-prefix-chars)))))
      ;; Point is at the point to indent under unless we are inside a string.
880
      ;; Call indentation hook except when overridden by lisp-indent-offset
Brian Preble's avatar
Brian Preble committed
881 882 883 884
      ;; or if the desired indentation has already been computed.
      (let ((normal-indent (current-column)))
        (cond ((elt state 3)
               ;; Inside a string, don't change indentation.
885
	       nil)
Brian Preble's avatar
Brian Preble committed
886 887 888 889 890 891 892 893 894 895 896
              ((and (integerp lisp-indent-offset) containing-sexp)
               ;; Indent by constant offset
               (goto-char containing-sexp)
               (+ (current-column) lisp-indent-offset))
              (desired-indent)
              ((and (boundp 'lisp-indent-function)
                    lisp-indent-function
                    (not retry))
               (or (funcall lisp-indent-function indent-point state)
                   normal-indent))
              (t
Brian Preble's avatar
Brian Preble committed
897
               normal-indent))))))
Brian Preble's avatar
Brian Preble committed
898 899

(defun lisp-indent-function (indent-point state)
900 901 902 903 904 905 906 907 908 909 910 911 912
  "This function is the normal value of the variable `lisp-indent-function'.
It is used when indenting a line within a function call, to see if the
called function says anything special about how to indent the line.

INDENT-POINT is the position where the user typed TAB, or equivalent.
Point is located at the point to indent under (for default indentation);
STATE is the `parse-partial-sexp' state for that position.

If the current line is in a call to a Lisp function
which has a non-nil property `lisp-indent-function',
that specifies how to do the indentation.  The property value can be
* `defun', meaning indent `defun'-style;
* an integer N, meaning indent the first N arguments specially
913 914
  like ordinary function arguments and then indent any further
  arguments like a body;
915
* a function to call just as this function was called.
916 917
  If that function returns nil, that means it doesn't specify
  the indentation.
918 919

This function also returns nil meaning don't specify the indentation."
Brian Preble's avatar
Brian Preble committed
920 921
  (let ((normal-indent (current-column)))
    (goto-char (1+ (elt state 1)))
922
    (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
Brian Preble's avatar
Brian Preble committed
923 924
    (if (and (elt state 2)
             (not (looking-at "\\sw\\|\\s_")))
Juanma Barranquero's avatar
Juanma Barranquero committed
925
        ;; car of form doesn't seem to be a symbol
Brian Preble's avatar
Brian Preble committed
926 927
        (progn
          (if (not (> (save-excursion (forward-line 1) (point))
928
                      calculate-lisp-indent-last-sexp))
929 930 931 932 933 934 935
		(progn (goto-char calculate-lisp-indent-last-sexp)
		       (beginning-of-line)
		       (parse-partial-sexp (point)
					   calculate-lisp-indent-last-sexp 0 t)))
	    ;; Indent under the list or under the first sexp on the same
	    ;; line as calculate-lisp-indent-last-sexp.  Note that first
	    ;; thing on that line has to be complete sexp since we are
936
          ;; inside the innermost containing sexp.
Brian Preble's avatar
Brian Preble committed
937 938 939 940 941
          (backward-prefix-chars)
          (current-column))
      (let ((function (buffer-substring (point)
					(progn (forward-sexp 1) (point))))
	    method)
942 943
	(setq method (or (get (intern-soft function) 'lisp-indent-function)
			 (get (intern-soft function) 'lisp-indent-hook)))
Brian Preble's avatar
Brian Preble committed
944 945 946 947 948 949 950 951 952
	(cond ((or (eq method 'defun)
		   (and (null method)
			(> (length function) 3)
			(string-match "\\`def" function)))
	       (lisp-indent-defform state indent-point))
	      ((integerp method)
	       (lisp-indent-specform method state
				     indent-point normal-indent))
	      (method
953
		(funcall method indent-point state)))))))
Brian Preble's avatar
Brian Preble committed
954

955
(defvar lisp-body-indent 2
956
  "Number of columns to indent the second line of a `(def...)' form.")
Brian Preble's avatar
Brian Preble committed
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010

(defun lisp-indent-specform (count state indent-point normal-indent)
  (let ((containing-form-start (elt state 1))
        (i count)
        body-indent containing-form-column)
    ;; Move to the start of containing form, calculate indentation
    ;; to use for non-distinguished forms (> count), and move past the
    ;; function symbol.  lisp-indent-function guarantees that there is at
    ;; least one word or symbol character following open paren of containing
    ;; form.
    (goto-char containing-form-start)
    (setq containing-form-column (current-column))
    (setq body-indent (+ lisp-body-indent containing-form-column))
    (forward-char 1)
    (forward-sexp 1)
    ;; Now find the start of the last form.
    (parse-partial-sexp (point) indent-point 1 t)
    (while (and (< (point) indent-point)
                (condition-case ()
                    (progn
                      (setq count (1- count))
                      (forward-sexp 1)
                      (parse-partial-sexp (point) indent-point 1 t))
                  (error nil))))
    ;; Point is sitting on first character of last (or count) sexp.
    (if (> count 0)
        ;; A distinguished form.  If it is the first or second form use double
        ;; lisp-body-indent, else normal indent.  With lisp-body-indent bound
        ;; to 2 (the default), this just happens to work the same with if as
        ;; the older code, but it makes unwind-protect, condition-case,
        ;; with-output-to-temp-buffer, et. al. much more tasteful.  The older,
        ;; less hacked, behavior can be obtained by replacing below with
        ;; (list normal-indent containing-form-start).
        (if (<= (- i count) 1)
            (list (+ containing-form-column (* 2 lisp-body-indent))
                  containing-form-start)
            (list normal-indent containing-form-start))
      ;; A non-distinguished form.  Use body-indent if there are no
      ;; distinguished forms and this is the first undistinguished form,
      ;; or if this is the first undistinguished form and the preceding
      ;; distinguished form has indentation at least as great as body-indent.
      (if (or (and (= i 0) (= count 0))
              (and (= count 0) (<= body-indent normal-indent)))
          body-indent
          normal-indent))))

(defun lisp-indent-defform (state indent-point)
  (goto-char (car (cdr state)))
  (forward-line 1)
  (if (> (point) (car (cdr (cdr state))))
      (progn
	(goto-char (car (cdr state)))
	(+ lisp-body-indent (current-column)))))

1011

Brian Preble's avatar
Brian Preble committed
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
;; like defun if the first form is placed on the next line, otherwise
;; it is indented like any other form (i.e. forms line up under first).

(put 'lambda 'lisp-indent-function 'defun)
(put 'autoload 'lisp-indent-function 'defun)
(put 'progn 'lisp-indent-function 0)
(put 'prog1 'lisp-indent-function 1)
(put 'prog2 'lisp-indent-function 2)
(put 'save-excursion 'lisp-indent-function 0)
(put 'save-window-excursion 'lisp-indent-function 0)