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

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

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

Brian Preble's avatar
Brian Preble committed
8 9 10 11
;; 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
12
;; the Free Software Foundation; either version 2, or (at your option)
Brian Preble's avatar
Brian Preble committed
13 14 15 16 17 18 19 20
;; 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
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Brian Preble's avatar
Brian Preble committed
24

25 26 27
;;; Commentary:

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

;;; Code:

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

Dave Love's avatar
Dave Love committed
34 35
(defvar emacs-lisp-mode-syntax-table
  (let ((table (make-syntax-table)))
Brian Preble's avatar
Brian Preble committed
36 37
    (let ((i 0))
      (while (< i ?0)
Dave Love's avatar
Dave Love committed
38
	(modify-syntax-entry i "_   " table)
Brian Preble's avatar
Brian Preble committed
39 40 41
	(setq i (1+ i)))
      (setq i (1+ ?9))
      (while (< i ?A)
Dave Love's avatar
Dave Love committed
42
	(modify-syntax-entry i "_   " table)
Brian Preble's avatar
Brian Preble committed
43 44 45
	(setq i (1+ i)))
      (setq i (1+ ?Z))
      (while (< i ?a)
Dave Love's avatar
Dave Love committed
46
	(modify-syntax-entry i "_   " table)
Brian Preble's avatar
Brian Preble committed
47 48 49
	(setq i (1+ i)))
      (setq i (1+ ?z))
      (while (< i 128)
Dave Love's avatar
Dave Love committed
50
	(modify-syntax-entry i "_   " table)
Brian Preble's avatar
Brian Preble committed
51
	(setq i (1+ i)))
Dave Love's avatar
Dave Love committed
52 53 54 55
      (modify-syntax-entry ?  "    " table)
      (modify-syntax-entry ?\t "    " table)
      (modify-syntax-entry ?\f "    " table)
      (modify-syntax-entry ?\n ">   " table)
56
      ;; Give CR the same syntax as newline, for selective-display.
Dave Love's avatar
Dave Love committed
57 58 59 60 61
      (modify-syntax-entry ?\^m ">   " table)
      (modify-syntax-entry ?\; "<   " table)
      (modify-syntax-entry ?` "'   " table)
      (modify-syntax-entry ?' "'   " table)
      (modify-syntax-entry ?, "'   " table)
Brian Preble's avatar
Brian Preble committed
62
      ;; Used to be singlequote; changed for flonums.
Dave Love's avatar
Dave Love committed
63 64 65 66 67 68 69
      (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)
70
      (modify-syntax-entry ?\] ")[  " table))
Dave Love's avatar
Dave Love committed
71 72 73 74 75 76 77
    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)
78
    (modify-syntax-entry ?| "\" 23b" table)
Dave Love's avatar
Dave Love committed
79
    table))
Jim Blandy's avatar
Jim Blandy committed
80

Brian Preble's avatar
Brian Preble committed
81 82
(define-abbrev-table 'lisp-mode-abbrev-table ())

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

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

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
;; 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)
(put 'defconst 'doc-string-elt 3)
(put 'defmacro 'doc-string-elt 3)
(put 'defsubst 'doc-string-elt 3)
(put 'define-skeleton 'doc-string-elt 2)
(put 'define-derived-mode 'doc-string-elt 4)
(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)


(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
		       (while (progn (backward-sexp 1) (setq n (1+ n))))
		     (scan-error nil))
		   (when (> n 0)
		     (let ((sym (intern-soft
				 (buffer-substring
				  (point) (progn (forward-sexp 1) (point))))))
		       (eq n (or (get sym 'doc-string-elt) 3)))))))
	  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)
Brian Preble's avatar
Brian Preble committed
158 159 160 161
  (cond (lisp-syntax
	  (set-syntax-table lisp-mode-syntax-table)))
  (setq local-abbrev-table lisp-mode-abbrev-table)
  (make-local-variable 'paragraph-start)
162
  (setq paragraph-start (concat page-delimiter "\\|$" ))
Brian Preble's avatar
Brian Preble committed
163 164 165 166
  (make-local-variable 'paragraph-separate)
  (setq paragraph-separate paragraph-start)
  (make-local-variable 'paragraph-ignore-fill-prefix)
  (setq paragraph-ignore-fill-prefix t)
167 168
  (make-local-variable 'fill-paragraph-function)
  (setq fill-paragraph-function 'lisp-fill-paragraph)
169 170 171 172 173
  ;; 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.
  (make-local-variable 'adaptive-fill-mode)
  (setq adaptive-fill-mode nil)
174 175
  (make-local-variable 'normal-auto-fill-function)
  (setq normal-auto-fill-function 'lisp-mode-auto-fill)
Brian Preble's avatar
Brian Preble committed
176 177 178 179 180 181
  (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)
182
  (make-local-variable 'outline-regexp)
Gerd Moellmann's avatar
Gerd Moellmann committed
183 184 185
  (setq outline-regexp ";;;;* \\|(")
  (make-local-variable 'outline-level)
  (setq outline-level 'lisp-outline-level)
Brian Preble's avatar
Brian Preble committed
186 187 188
  (make-local-variable 'comment-start)
  (setq comment-start ";")
  (make-local-variable 'comment-start-skip)
189 190 191
  ;; 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]\\)\\(\\\\\\\\\\)*\\);+ *")
192 193
  (make-local-variable 'comment-add)
  (setq comment-add 1)			;default to `;;' in comment-region
Brian Preble's avatar
Brian Preble committed
194 195
  (make-local-variable 'comment-column)
  (setq comment-column 40)
196
  (make-local-variable 'comment-indent-function)
197 198
  (setq comment-indent-function 'lisp-comment-indent)
  (make-local-variable 'imenu-generic-expression)
199 200
  (setq imenu-generic-expression lisp-imenu-generic-expression)
  (make-local-variable 'multibyte-syntax-as-symbol)
Stefan Monnier's avatar
Stefan Monnier committed
201 202 203 204 205
  (setq multibyte-syntax-as-symbol t)
  (setq font-lock-defaults
	'((lisp-font-lock-keywords
	   lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
	  nil nil (("+-*/.<>=!?$%_&~^:" . "w")) beginning-of-defun
206 207 208
	  (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
209 210 211 212 213 214 215 216

(defun lisp-outline-level ()
  "Lisp mode `outline-level' function."
  (if (looking-at "(")
      1000
    (looking-at outline-regexp)
    (- (match-end 0) (match-beginning 0))))

217

Stefan Monnier's avatar
Stefan Monnier committed
218 219
(defvar lisp-mode-shared-map
  (let ((map (make-sparse-keymap)))
220
    (define-key map "\t" 'lisp-indent-line)
Stefan Monnier's avatar
Stefan Monnier committed
221 222
    (define-key map "\e\C-q" 'indent-sexp)
    (define-key map "\177" 'backward-delete-char-untabify)
223 224 225 226
    ;; 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
227
    map)
Brian Preble's avatar
Brian Preble committed
228 229 230 231
  "Keymap for commands shared by all sorts of Lisp modes.")

(defvar emacs-lisp-mode-map ()
  "Keymap for Emacs Lisp mode.
232
All commands in `lisp-mode-shared-map' are inherited by this map.")
Brian Preble's avatar
Brian Preble committed
233 234 235

(if emacs-lisp-mode-map
    ()
236
  (let ((map (make-sparse-keymap "Emacs-Lisp")))
237
    (setq emacs-lisp-mode-map (make-sparse-keymap))
238
    (set-keymap-parent emacs-lisp-mode-map lisp-mode-shared-map)
239 240 241 242 243 244 245 246 247
    (define-key emacs-lisp-mode-map "\e\t" 'lisp-complete-symbol)
    (define-key emacs-lisp-mode-map "\e\C-x" 'eval-defun)
    (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))
248
    (define-key map [emacs-byte-compile-and-load]
249
      '("Byte-compile And Load" . emacs-lisp-byte-compile-and-load))
250 251 252 253 254 255 256 257 258
    (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))
259 260 261 262
    (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)))
263 264 265 266 267 268

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

271
(defun emacs-lisp-byte-compile-and-load ()
272 273 274 275 276 277
  "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.
278
  (if (and (buffer-modified-p)
Dave Love's avatar
Dave Love committed
279
	   (y-or-n-p (format "Save buffer %s first? " (buffer-name))))
280 281 282 283 284
      (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
285

286 287
(defcustom emacs-lisp-mode-hook nil
  "Hook run when entering Emacs Lisp mode."
Dave Love's avatar
Dave Love committed
288
  :options '(turn-on-eldoc-mode imenu-add-menubar-index checkdoc-minor-mode)
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
  :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)

Stefan Monnier's avatar
Stefan Monnier committed
304
(define-derived-mode emacs-lisp-mode nil "Emacs-Lisp"
Brian Preble's avatar
Brian Preble committed
305 306 307 308 309 310 311
  "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."
312
  (lisp-mode-variables)
Stefan Monnier's avatar
Stefan Monnier committed
313
  (setq imenu-case-fold-search nil))
Brian Preble's avatar
Brian Preble committed
314

Dave Love's avatar
Dave Love committed
315 316
(defvar lisp-mode-map
  (let ((map (make-sparse-keymap)))
317
    (set-keymap-parent map lisp-mode-shared-map)
Dave Love's avatar
Dave Love committed
318 319 320
    (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
321
  "Keymap for ordinary Lisp mode.
322
All commands in `lisp-mode-shared-map' are inherited by this map.")
Brian Preble's avatar
Brian Preble committed
323

Stefan Monnier's avatar
Stefan Monnier committed
324
(define-derived-mode lisp-mode nil "Lisp"
Brian Preble's avatar
Brian Preble committed
325 326 327 328 329 330 331 332 333 334
  "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."
335 336 337 338
  (lisp-mode-variables)
  (set (make-local-variable 'comment-start-skip)
       "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(;+\\|#|\\) *")
  (set (make-local-variable 'font-lock-keywords-case-fold-search) t)
Stefan Monnier's avatar
Stefan Monnier committed
339
  (setq imenu-case-fold-search t))
Brian Preble's avatar
Brian Preble committed
340

341 342
;; This will do unless inf-lisp.el is loaded.
(defun lisp-eval-defun (&optional and-go)
Brian Preble's avatar
Brian Preble committed
343 344 345 346
  "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
347 348
(defvar lisp-interaction-mode-map
  (let ((map (make-sparse-keymap)))
349
    (set-keymap-parent map lisp-mode-shared-map)
Dave Love's avatar
Dave Love committed
350 351 352 353
    (define-key map "\e\C-x" 'eval-defun)
    (define-key map "\e\t" 'lisp-complete-symbol)
    (define-key map "\n" 'eval-print-last-sexp)
    map)
354
  "Keymap for Lisp Interaction mode.
355
All commands in `lisp-mode-shared-map' are inherited by this map.")
Brian Preble's avatar
Brian Preble committed
356

Stefan Monnier's avatar
Stefan Monnier committed
357
(define-derived-mode lisp-interaction-mode emacs-lisp-mode "Lisp Interaction"
Brian Preble's avatar
Brian Preble committed
358 359 360
  "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.
361 362
Note that printing is controled by `eval-expression-print-length'
and `eval-expression-print-level'.
Brian Preble's avatar
Brian Preble committed
363 364 365 366 367 368 369

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'
Stefan Monnier's avatar
Stefan Monnier committed
370
if that value is non-nil.")
Brian Preble's avatar
Brian Preble committed
371

Roland McGrath's avatar
Roland McGrath committed
372
(defun eval-print-last-sexp ()
373 374 375 376 377
  "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
378
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382
  (let ((standard-output (current-buffer)))
    (terpri)
    (eval-last-sexp t)
    (terpri)))
383

384

385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
(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.
VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the 
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
     beg end 
     `(printed-value (,value ,alt1 ,alt2)
		     mouse-face highlight 
		     keymap ,map
		     help-echo "RET, mouse-2: toggle abbreviated display"
		     rear-nonsticky (mouse-face keymap help-echo
						printed-value)))))


(defun last-sexp-toggle-display ()
  "Toggle between abbreviated and unabbreviated printed representations."
406 407 408 409 410
  (interactive)
  (let ((value (get-text-property (point) 'printed-value)))
    (when value
      (let ((beg (previous-single-property-change (point) 'printed-value))
	    (end (next-single-char-property-change (point) 'printed-value))
411
	    (standard-output (current-buffer))
412
	    (point (point)))
413
	(delete-region beg end)
414 415 416 417 418 419
	(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))))))
420 421


422
(defun eval-last-sexp-1 (eval-last-sexp-arg-internal)
Brian Preble's avatar
Brian Preble committed
423 424
  "Evaluate sexp before point; print value in minibuffer.
With argument, print output into current buffer."
425
  (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
426 427
    (let ((value
	   (eval (let ((stab (syntax-table))
428
		       (opoint (point))
429
		       ignore-quotes
430 431
		       expr)
		   (unwind-protect
Roland McGrath's avatar
Roland McGrath committed
432 433
		       (save-excursion
			 (set-syntax-table emacs-lisp-mode-syntax-table)
434 435 436 437 438
			 ;; If this sexp appears to be enclosed in `...'
			 ;; then ignore the surrounding quotes.
			 (setq ignore-quotes
			       (or (eq (following-char) ?\')
				   (eq (preceding-char) ?\')))
Roland McGrath's avatar
Roland McGrath committed
439
			 (forward-sexp -1)
440 441 442 443 444 445
			 ;; 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)))
446

447 448 449 450 451 452 453 454 455
			 ;; 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))))

Richard M. Stallman's avatar
Richard M. Stallman committed
456
			 (save-restriction
457 458
			   ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
			   ;; `variable' so that the value is returned, not the
459
			   ;; name
460 461 462
			   (if (and ignore-quotes
				    (eq (following-char) ?`))
			       (forward-char))
Richard M. Stallman's avatar
Richard M. Stallman committed
463
			   (narrow-to-region (point-min) opoint)
464 465 466 467 468 469 470 471 472 473 474 475 476 477
			   (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))
478
		     (set-syntax-table stab))))))
479 480 481
      (let ((unabbreviated (let ((print-length nil) (print-level nil))
			     (prin1-to-string value)))
	    (print-length eval-expression-print-length)
482
	    (print-level eval-expression-print-level)
483 484
	    (beg (point))
	    end)
485
	(prin1 value)
486
	(setq end (point))
487 488
	(when (and (bufferp standard-output)
		   (or (not (null print-length))
489
		       (not (null print-level)))
490 491 492 493 494 495
		   (not (string= unabbreviated
				 (buffer-substring-no-properties beg end))))
	  (last-sexp-setup-props beg end value 
				 unabbreviated
				 (buffer-substring-no-properties beg end))
	  )))))
496

Brian Preble's avatar
Brian Preble committed
497

498 499
(defun eval-last-sexp (eval-last-sexp-arg-internal)
  "Evaluate sexp before point; print value in minibuffer.
500
Interactively, with prefix argument, print output into current buffer."
501 502 503 504 505 506 507 508 509 510
  (interactive "P")
  (if (null eval-expression-debug-on-error)
      (eval-last-sexp-1 eval-last-sexp-arg-internal)
    (let ((old-value (make-symbol "t")) new-value value)
      (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)))
511

512
(defun eval-defun-1 (form)
513 514 515 516
  "Change defvar into defconst within FORM.
Likewise for other constructs as necessary."
  ;; The code in edebug-defun should be consistent with this, but not
  ;; the same, since this gets a macroexpended form.
517 518 519 520
  (cond ((and (eq (car form) 'defvar)
	      (cdr-safe (cdr-safe form)))
	 ;; Force variable to be bound.
	 (cons 'defconst (cdr form)))
521 522
	;; `defcustom' is now macroexpanded to
	;; `custom-declare-variable' with a quoted value arg.
Dave Love's avatar
Dave Love committed
523 524
	((and (eq (car form) 'custom-declare-variable)
	      (default-boundp (eval (nth 1 form))))
525
	 ;; Force variable to be bound.
526
	 (set-default (eval (nth 1 form)) (eval (nth 1 (nth 2 form))))
527 528 529 530 531
	 form)
	((eq (car form) 'progn)
	 (cons 'progn (mapcar 'eval-defun-1 (cdr form))))
	(t form)))

532
(defun eval-defun-2 ()
Roland McGrath's avatar
Roland McGrath committed
533
  "Evaluate defun that point is in or before.
Karl Heuer's avatar
Karl Heuer committed
534 535 536 537 538 539 540
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.\)

541 542
With argument, insert value in current buffer after the defun.
Return the result of evaluation."
Brian Preble's avatar
Brian Preble committed
543
  (interactive "P")
544 545 546 547 548 549 550 551 552
  (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
553
       #'eval-region
554
       (let ((standard-output t)
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
	     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)))
	 ;; Alter the form if necessary, changing defvar into defconst, etc.
	 (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
571 572
  ;; The result of evaluation has been put onto VALUES.  So return it.
  (car values))
573

574 575
(defun eval-defun (edebug-it)
  "Evaluate the top-level form containing point, or after point.
576

577 578 579 580 581 582 583 584 585 586 587 588
If the current defun is actually a call to `defvar', then reset the
variable using its 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.)

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
589 590 591
the minibuffer.  This display is controlled by the variables
`eval-expression-print-length' and `eval-expression-print-level',
which see."
592
  (interactive "P")
593 594 595 596 597 598 599 600 601 602 603 604 605
  (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)))))
606

607

Brian Preble's avatar
Brian Preble committed
608 609 610 611
(defun lisp-comment-indent ()
  (if (looking-at "\\s<\\s<\\s<")
      (current-column)
    (if (looking-at "\\s<\\s<")
612
	(let ((tem (or (calculate-lisp-indent) (current-column))))
Brian Preble's avatar
Brian Preble committed
613 614 615 616 617
	  (if (listp tem) (car tem) tem))
      (skip-chars-backward " \t")
      (max (if (bolp) 0 (1+ (current-column)))
	   comment-column))))

618 619 620 621 622 623 624 625 626 627 628
(defun lisp-mode-auto-fill ()
  (if (> (current-column) (current-fill-column))
      (if (save-excursion
	    (nth 4 (parse-partial-sexp (save-excursion
					 (beginning-of-defun)
					 (point))
				       (point))))
	  (do-auto-fill)
	(let ((comment-start nil) (comment-start-skip nil))
	  (do-auto-fill)))))

629 630
(defvar lisp-indent-offset nil
  "If non-nil, indent second line of expressions that many more columns.")
Dave Love's avatar
Dave Love committed
631
(defvar lisp-indent-function 'lisp-indent-function)
Brian Preble's avatar
Brian Preble committed
632 633 634 635 636 637

(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")
638 639 640
  (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
641
    (skip-chars-forward " \t")
642 643 644
    (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.
645
	(goto-char (- (point-max) pos))
Brian Preble's avatar
Brian Preble committed
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
      (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)))))

672
(defvar calculate-lisp-indent-last-sexp)
673

Brian Preble's avatar
Brian Preble committed
674 675 676
(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.
677 678 679 680
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
681
This means that following lines at the same level of indentation
682 683 684
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
685 686 687 688 689 690 691
  (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)
692
          calculate-lisp-indent-last-sexp containing-sexp)
Brian Preble's avatar
Brian Preble committed
693 694 695 696 697 698 699 700 701 702 703
      (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)
704
        (setq calculate-lisp-indent-last-sexp (elt state 2))
Brian Preble's avatar
Brian Preble committed
705 706 707 708
        (setq containing-sexp (elt state 1))
        ;; Position following last unclosed open.
        (goto-char (1+ containing-sexp))
        ;; Is there a complete sexp since then?
709 710
        (if (and calculate-lisp-indent-last-sexp
		 (> calculate-lisp-indent-last-sexp (point)))
Brian Preble's avatar
Brian Preble committed
711
            ;; Yes, but is there a containing sexp after that?
712 713
            (let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
					    indent-point 0)))
Brian Preble's avatar
Brian Preble committed
714 715 716 717 718
              (if (setq retry (car (cdr peek))) (setq state peek)))))
      (if retry
          nil
        ;; Innermost containing sexp found
        (goto-char (1+ containing-sexp))
719
        (if (not calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
720 721 722 723
	    ;; indent-point immediately follows open paren.
	    ;; Don't call hook.
            (setq desired-indent (current-column))
	  ;; Find the start of first element of containing sexp.
724
	  (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
Brian Preble's avatar
Brian Preble committed
725 726 727 728 729
	  (cond ((looking-at "\\s(")
		 ;; First element of containing sexp is a list.
		 ;; Indent under that list.
		 )
		((> (save-excursion (forward-line 1) (point))
730
		    calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
731 732
		 ;; This is the first line to start within the containing sexp.
		 ;; It's almost certainly a function call.
733
		 (if (= (point) calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
734 735 736 737 738 739
		     ;; 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)
740 741 742
			  (parse-partial-sexp (point)
					      calculate-lisp-indent-last-sexp
					      0 t)))
Brian Preble's avatar
Brian Preble committed
743 744
		 (backward-prefix-chars))
		(t
745
		 ;; Indent beneath first sexp on same line as
Dave Love's avatar
Dave Love committed
746
		 ;; `calculate-lisp-indent-last-sexp'.  Again, it's
747 748
		 ;; almost certainly a function call.
		 (goto-char calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
749
		 (beginning-of-line)
750 751
		 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
				     0 t)
Brian Preble's avatar
Brian Preble committed
752 753
		 (backward-prefix-chars)))))
      ;; Point is at the point to indent under unless we are inside a string.
754
      ;; Call indentation hook except when overridden by lisp-indent-offset
Brian Preble's avatar
Brian Preble committed
755 756 757 758
      ;; 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.
759
	       nil)
Brian Preble's avatar
Brian Preble committed
760 761 762 763 764 765 766 767 768 769 770
              ((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
771
               normal-indent))))))
Brian Preble's avatar
Brian Preble committed
772 773 774 775

(defun lisp-indent-function (indent-point state)
  (let ((normal-indent (current-column)))
    (goto-char (1+ (elt state 1)))
776
    (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
Brian Preble's avatar
Brian Preble committed
777 778 779 780 781
    (if (and (elt state 2)
             (not (looking-at "\\sw\\|\\s_")))
        ;; car of form doesn't seem to be a a symbol
        (progn
          (if (not (> (save-excursion (forward-line 1) (point))
782 783
                      calculate-lisp-indent-last-sexp))
              (progn (goto-char calculate-lisp-indent-last-sexp)
Brian Preble's avatar
Brian Preble committed
784
                     (beginning-of-line)
785 786 787 788 789 790
                     (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
          ;; inside the innermost containing sexp.
Brian Preble's avatar
Brian Preble committed
791 792 793 794 795
          (backward-prefix-chars)
          (current-column))
      (let ((function (buffer-substring (point)
					(progn (forward-sexp 1) (point))))
	    method)
796 797
	(setq method (or (get (intern-soft function) 'lisp-indent-function)
			 (get (intern-soft function) 'lisp-indent-hook)))
Brian Preble's avatar
Brian Preble committed
798 799 800 801 802 803 804 805 806 807 808
	(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
		(funcall method state indent-point)))))))

809
(defvar lisp-body-indent 2
810
  "Number of columns to indent the second line of a `(def...)' form.")
Brian Preble's avatar
Brian Preble committed
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864

(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)))))

865

Brian Preble's avatar
Brian Preble committed
866 867 868 869 870 871 872 873 874 875 876
;; (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)
877
(put 'save-selected-window 'lisp-indent-function 0)
Brian Preble's avatar
Brian Preble committed
878
(put 'save-restriction 'lisp-indent-function 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
879
(put 'save-match-data 'lisp-indent-function 0)
880
(put 'save-current-buffer 'lisp-indent-function 0)
881
(put 'with-current-buffer 'lisp-indent-function 1)
882
(put 'combine-after-change-calls 'lisp-indent-function 0)
883
(put 'with-output-to-string 'lisp-indent-function 0)
884
(put 'with-temp-file 'lisp-indent-function 1)
885
(put 'with-temp-buffer 'lisp-indent-function 0)
886
(put 'with-temp-message 'lisp-indent-function 1)
887
(put 'with-syntax-table 'lisp-indent-function 1)
Brian Preble's avatar
Brian Preble committed
888 889 890 891 892 893 894 895
(put 'let 'lisp-indent-function 1)
(put 'let* 'lisp-indent-function 1)
(put 'while 'lisp-indent-function 1)
(put 'if 'lisp-indent-function 2)
(put 'catch 'lisp-indent-function 1)
(put 'condition-case 'lisp-indent-function 2)
(put 'unwind-protect 'lisp-indent-function 1)
(put 'with-output-to-temp-buffer 'lisp-indent-function 1)
896
(put 'eval-after-load 'lisp-indent-function 1)
897 898 899 900
(put 'dolist 'lisp-indent-function 1)
(put 'dotimes 'lisp-indent-function 1)
(put 'when 'lisp-indent-function 1)
(put 'unless 'lisp-indent-function 1)
Brian Preble's avatar
Brian Preble committed
901 902 903 904 905 906

(defun indent-sexp (&optional endpos)
  "Indent each line of the list starting just after point.
If optional arg ENDPOS is given, indent each line, stopping when
ENDPOS is encountered."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
907 908
  (let ((indent-stack (list nil))
	(next-depth 0)
909 910 911 912 913 914
	;; If ENDPOS is non-nil, use nil as STARTING-POINT
	;; so that calculate-lisp-indent will find the beginning of
	;; the defun we are in.
	;; If ENDPOS is nil, it is safe not to scan before point
	;; since every line we indent is more deeply nested than point is.
	(starting-point (if endpos nil (point)))
Jim Blandy's avatar
Jim Blandy committed
915 916
	(last-point (point))
	last-depth bol outer-loop-done inner-loop-done state this-indent)
917 918 919
    (or endpos
	;; Get error now if we don't have a complete sexp after point.
	(save-excursion (forward-sexp 1)))
Brian Preble's avatar
Brian Preble committed
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
    (save-excursion
      (setq outer-loop-done nil)
      (while (if endpos (< (point) endpos)
	       (not outer-loop-done))
	(setq last-depth next-depth
	      inner-loop-done nil)
	;; Parse this line so we can learn the state
	;; to indent the next line.
	;; This inner loop goes through only once
	;; unless a line ends inside a string.
	(while (and (not inner-loop-done)
		    (not (setq outer-loop-done (eobp))))
	  (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
					  nil nil state))
	  (setq next-depth (car state))
	  ;; If the line contains a comment other than the sort
	  ;; that is indented like code,
	  ;; indent it now with indent-for-comment.
	  ;; Comments indented like code are right already.
	  ;; In any case clear the in-comment flag in the state
	  ;; because parse-partial-sexp never sees the newlines.
	  (if (car (nthcdr 4 state))
	      (progn (indent-for-comment)
		     (end-of-line)
		     (setcar (nthcdr 4 state) nil)))
	  ;; If this line ends inside a string,
	  ;; go straight to next line, remaining within the inner loop,
	  ;; and turn off the \-flag.
	  (if (car (nthcdr 3 state))
	      (progn
		(forward-line 1)
		(setcar (nthcdr 5 state) nil))
	    (setq inner-loop-done t)))
	(and endpos
Jim Blandy's avatar
Jim Blandy committed
954 955
	     (<= next-depth 0)
	     (progn
956 957
	       (setq indent-stack (nconc indent-stack
					 (make-list (- next-depth) nil))
Jim Blandy's avatar
Jim Blandy committed
958 959
		     last-depth (- last-depth next-depth)
		     next-depth 0)))
960
	(or outer-loop-done endpos
Brian Preble's avatar
Brian Preble committed
961 962
	    (setq outer-loop-done (<= next-depth 0)))
	(if outer-loop-done
963
	    (forward-line 1)
Brian Preble's avatar
Brian Preble committed
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
	  (while (> last-depth next-depth)
	    (setq indent-stack (cdr indent-stack)
		  last-depth (1- last-depth)))
	  (while (< last-depth next-depth)
	    (setq indent-stack (cons nil indent-stack)
		  last-depth (1+ last-depth)))
	  ;; Now go to the next line and indent it according
	  ;; to what we learned from parsing the previous one.
	  (forward-line 1)
	  (setq bol (point))
	  (skip-chars-forward " \t")
	  ;; But not if the line is blank, or just a comment
	  ;; (except for double-semi comments; indent them as usual).
	  (if (or (eobp) (looking-at "\\s<\\|\n"))
	      nil
	    (if (and (car indent-stack)
		     (>= (car indent-stack) 0))
		(setq this-indent (car indent-stack))
	      (let ((val (calculate-lisp-indent
			  (if (car indent-stack) (- (car indent-stack))
Jim Blandy's avatar
Jim Blandy committed
984
			    starting-point))))
985 986 987 988 989 990 991 992
		(if (null val)
		    (setq this-indent val)
		  (if (integerp val)
		      (setcar indent-stack
			      (setq this-indent val))
		    (setcar indent-stack (- (car (cdr val))))
		    (setq this-indent (car val))))))
	    (if (and this-indent (/= (current-column) this-indent))
Brian Preble's avatar
Brian Preble committed
993 994 995 996 997 998 999
		(progn (delete-region bol (point))
		       (indent-to this-indent)))))
	(or outer-loop-done
	    (setq outer-loop-done (= (point) last-point))
	    (setq last-point (point)))))))

(defun lisp-indent-region (start end)
Dave Love's avatar
Dave Love committed
1000
  "Indent every line whose first char is between START and END inclusive."
Brian Preble's avatar
Brian Preble committed
1001 1002
  (save-excursion
    (let ((endmark (copy-marker end)))
1003 1004 1005
      (goto-char start)
      (and (bolp) (not (eolp))
	   (lisp-indent-line))
Brian Preble's avatar
Brian Preble committed
1006 1007
      (indent-sexp endmark)
      (set-marker endmark nil))))
1008

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
;;;; Lisp paragraph filling commands.

(defun lisp-fill-paragraph (&optional justify)
  "Like \\[fill-paragraph], but handle Emacs Lisp comments.
If any of the current line is a comment, fill the comment or the
paragraph of it that point is in, preserving the comment's indentation
and initial semicolons."
  (interactive "P")
  (let (
	;; Non-nil if the current line contains a comment.
	has-comment

1021 1022 1023
	;; Non-nil if the current line contains code and a comment.
	has-code-and-comment

1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
	;; If has-comment, the appropriate fill-prefix for the comment.
	comment-fill-prefix
	)

    ;; Figure out what kind of comment we are looking at.
    (save-excursion
      (beginning-of-line)
      (cond

       ;; A line with nothing but a comment on it?
       ((looking-at "[ \t]*;[; \t]*")
	(setq has-comment t
	      comment-fill-prefix (buffer-substring (match-beginning 0)
						    (match-end 0))))

       ;; A line with some code, followed by a comment?  Remember that the
       ;; semi which starts the comment shouldn't be part of a string or
       ;; character.
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
       ((condition-case nil
	    (save-restriction
	      (narrow-to-region (point-min)
				(save-excursion (end-of-line) (point)))
	      (while (not (looking-at ";\\|$"))
		(skip-chars-forward "^;\n\"\\\\?")
		(cond
		 ((eq (char-after (point)) ?\\) (forward-char 2))
		 ((memq (char-after (point)) '(?\" ??)) (forward-sexp 1))))
	      (looking-at ";+[\t ]*"))
	  (error nil))
1053
	(setq has-comment t has-code-and-comment t)
1054
	(setq comment-fill-prefix
1055 1056
	      (concat (make-string (/ (current-column) 8) ?\t)
		      (make-string (% (current-column) 8) ?\ )
1057 1058 1059
		      (buffer-substring (match-beginning 0) (match-end 0)))))))

    (if (not has-comment)
Dave Love's avatar
Dave Love committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
        ;; `paragraph-start' is set here (not in the buffer-local
        ;; variable so that `forward-paragraph' et al work as
        ;; expected) so that filling (doc) strings works sensibly.
        ;; Adding the opening paren to avoid the following sexp being
        ;; filled means that sexps generally aren't filled as normal
        ;; text, which is probably sensible.  The `;' and `:' stop the
        ;; filled para at following comment lines and keywords
        ;; (typically in `defcustom').
	(let ((paragraph-start (concat paragraph-start
                                       "\\|\\s-*[\(;:\"]")))
          (fill-paragraph justify))
1071 1072

      ;; Narrow to include only the comment, and then fill the region.
1073 1074 1075 1076 1077 1078 1079
      (save-excursion
	(save-restriction
	  (beginning-of-line)
	  (narrow-to-region
	   ;; Find the first line we should include in the region to fill.
	   (save-excursion
	     (while (and (zerop (forward-line -1))
1080
			 (looking-at "^[ \t]*;")))
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
	     ;; We may have gone too far.  Go forward again.
	     (or (looking-at ".*;")
		 (forward-line 1))
	     (point))
	   ;; Find the beginning of the first line past the region to fill.
	   (save-excursion
	     (while (progn (forward-line 1)
			   (looking-at "^[ \t]*;")))
	     (point)))

	  ;; Lines with only semicolons on them can be paragraph boundaries.
	  (let* ((paragraph-start (concat paragraph-start "\\|[ \t;]*$"))
		 (paragraph-separate (concat paragraph-start "\\|[ \t;]*$"))
		 (paragraph-ignore-fill-prefix nil)
		 (fill-prefix comment-fill-prefix)
1096 1097 1098
		 (after-line (if has-code-and-comment
				 (save-excursion
				   (forward-line 1) (point))))
1099 1100 1101 1102
		 (end (progn
			(forward-paragraph)
			(or (bolp) (newline 1))
			(point)))
1103 1104 1105 1106 1107 1108
		 ;; If this comment starts on a line with code,
		 ;; include that like in the filling.
		 (beg (progn (backward-paragraph)
			     (if (eq (point) after-line)
				 (forward-line -1))
			     (point))))
1109 1110 1111 1112 1113 1114 1115 1116
	    (fill-region-as-paragraph beg end
				      justify nil
				      (save-excursion
					(goto-char beg)
					(if (looking-at fill-prefix)
					    nil
					  (re-search-forward comment-start-skip)
					  (point))))))))
1117
    t))