diff options
Diffstat (limited to 'lisp/lisp-mode.el')
| -rw-r--r-- | lisp/lisp-mode.el | 578 |
1 files changed, 578 insertions, 0 deletions
diff --git a/lisp/lisp-mode.el b/lisp/lisp-mode.el new file mode 100644 index 00000000000..860dc368ee8 --- /dev/null +++ b/lisp/lisp-mode.el @@ -0,0 +1,578 @@ +;; Lisp mode, and its idiosyncratic commands. +;; Copyright (C) 1985 Free Software Foundation, Inc. + +;; 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 +;; the Free Software Foundation; either version 1, or (at your option) +;; 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 +;; along with GNU Emacs; see the file COPYING. If not, write to +;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. + + +(defvar lisp-mode-syntax-table nil "") +(defvar emacs-lisp-mode-syntax-table nil "") +(defvar lisp-mode-abbrev-table nil "") + +(if (not emacs-lisp-mode-syntax-table) + (let ((i 0)) + (setq emacs-lisp-mode-syntax-table (make-syntax-table)) + (while (< i ?0) + (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table) + (setq i (1+ i))) + (setq i (1+ ?9)) + (while (< i ?A) + (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table) + (setq i (1+ i))) + (setq i (1+ ?Z)) + (while (< i ?a) + (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table) + (setq i (1+ i))) + (setq i (1+ ?z)) + (while (< i 128) + (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table) + (setq i (1+ i))) + (modify-syntax-entry ? " " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\t " " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\n "> " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\f "> " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\; "< " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?` "' " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?' "' " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?, "' " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?. "' " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?# "' " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\" "\" " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\\ "\\ " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\( "() " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\) ")( " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\[ "(] " emacs-lisp-mode-syntax-table) + (modify-syntax-entry ?\] ")[ " emacs-lisp-mode-syntax-table))) + +(define-abbrev-table 'lisp-mode-abbrev-table ()) + +(defun lisp-mode-variables (lisp-syntax) + (cond (lisp-syntax + (if (not lisp-mode-syntax-table) + (progn (setq lisp-mode-syntax-table + (copy-syntax-table emacs-lisp-mode-syntax-table)) + (modify-syntax-entry ?\| "\" " + lisp-mode-syntax-table) + (modify-syntax-entry ?\[ "_ " + lisp-mode-syntax-table) + (modify-syntax-entry ?\] "_ " + lisp-mode-syntax-table))) + (set-syntax-table lisp-mode-syntax-table))) + (setq local-abbrev-table lisp-mode-abbrev-table) + (make-local-variable 'paragraph-start) + (setq paragraph-start (concat "^$\\|" page-delimiter)) + (make-local-variable 'paragraph-separate) + (setq paragraph-separate paragraph-start) + (make-local-variable 'paragraph-ignore-fill-prefix) + (setq paragraph-ignore-fill-prefix t) + (make-local-variable 'indent-line-function) + (setq indent-line-function 'lisp-indent-line) + (make-local-variable 'comment-start) + (setq comment-start ";") + (make-local-variable 'comment-start-skip) + (setq comment-start-skip ";+ *") + (make-local-variable 'comment-column) + (setq comment-column 40) + (make-local-variable 'comment-indent-hook) + (setq comment-indent-hook 'lisp-comment-indent)) + +(defun lisp-mode-commands (map) + (define-key map "\e\C-q" 'indent-sexp) + (define-key map "\177" 'backward-delete-char-untabify) + (define-key map "\t" 'lisp-indent-line)) + +(defvar emacs-lisp-mode-map () "") +(if emacs-lisp-mode-map + () + (setq emacs-lisp-mode-map (make-sparse-keymap)) + (define-key emacs-lisp-mode-map "\e\C-x" 'eval-defun) + (lisp-mode-commands emacs-lisp-mode-map)) + +(defun emacs-lisp-mode () + "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." + (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") + (lisp-mode-variables nil) + (run-hooks 'emacs-lisp-mode-hook)) + +(defvar lisp-mode-map ()) +(if lisp-mode-map + () + (setq lisp-mode-map (make-sparse-keymap)) + (define-key lisp-mode-map "\e\C-x" 'lisp-send-defun) + (define-key lisp-mode-map "\C-c\C-l" 'run-lisp) + (lisp-mode-commands lisp-mode-map)) + +(defun lisp-mode () + "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." + (interactive) + (kill-all-local-variables) + (use-local-map lisp-mode-map) + (setq major-mode 'lisp-mode) + (setq mode-name "Lisp") + (lisp-mode-variables t) + (set-syntax-table lisp-mode-syntax-table) + (run-hooks 'lisp-mode-hook)) + +;; This will do unless shell.el is loaded. +(defun lisp-send-defun nil + "Send the current defun to the Lisp process made by M-x run-lisp." + (interactive) + (error "Process lisp does not exist")) + +(defvar lisp-interaction-mode-map ()) +(if lisp-interaction-mode-map + () + (setq lisp-interaction-mode-map (make-sparse-keymap)) + (lisp-mode-commands lisp-interaction-mode-map) + (define-key lisp-interaction-mode-map "\e\C-x" 'eval-defun) + (define-key lisp-interaction-mode-map "\n" 'eval-print-last-sexp)) + +(defun lisp-interaction-mode () + "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. + +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 +if that value is non-nil." + (interactive) + (kill-all-local-variables) + (use-local-map lisp-interaction-mode-map) + (set-syntax-table emacs-lisp-mode-syntax-table) + (setq major-mode 'lisp-interaction-mode) + (setq mode-name "Lisp Interaction") + (lisp-mode-variables nil) + (run-hooks 'lisp-interaction-mode-hook)) + +(defun eval-print-last-sexp (arg) + "Evaluate sexp before point; print value into current buffer." + (interactive "P") + (eval-region + (let ((stab (syntax-table))) + (unwind-protect + (save-excursion + (set-syntax-table emacs-lisp-mode-syntax-table) + (forward-sexp -1) + (point)) + (set-syntax-table stab))) + (point) + (current-buffer))) + +(defun eval-last-sexp (arg) + "Evaluate sexp before point; print value in minibuffer. +With argument, print output into current buffer." + (interactive "P") + (eval-region + (let ((stab (syntax-table))) + (unwind-protect + (save-excursion + (set-syntax-table emacs-lisp-mode-syntax-table) + (forward-sexp -1) + (point)) + (set-syntax-table stab))) + (point) + (if arg (current-buffer) t))) + +(defun eval-defun (arg) + "Evaluate defun that point is in or before. +Print value in minibuffer. +With argument, insert value in current buffer after the defun." + (interactive "P") + (save-excursion + (end-of-defun) + (let ((end (point))) + (beginning-of-defun) + (eval-region (point) end + (if arg (current-buffer) t))))) + +(defun lisp-comment-indent () + (if (looking-at ";;;") + (current-column) + (if (looking-at ";;") + (let ((tem (calculate-lisp-indent))) + (if (listp tem) (car tem) tem)) + (skip-chars-backward " \t") + (max (if (bolp) 0 (1+ (current-column))) + comment-column)))) + +(defconst lisp-indent-offset nil "") +(defconst lisp-indent-hook 'lisp-indent-hook "") + +(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") + (let ((indent (calculate-lisp-indent)) shift-amt beg end + (pos (- (point-max) (point)))) + (beginning-of-line) + (setq beg (point)) + (skip-chars-forward " \t") + (if (looking-at ";;;") + ;; Don't alter indentation of a ;;; comment line. + nil + (if (and (looking-at ";") (not (looking-at ";;"))) + ;; 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))))) + +(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. +Can instead return a list, whose car is the column to indent to. +This means that following lines at the same level of indentation +should not necessarily be indented the same way. +The second element of the list is the buffer position +of the start of the containing expression." + (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) + last-sexp containing-sexp) + (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) + (setq last-sexp (elt state 2)) + (setq containing-sexp (elt state 1)) + ;; Position following last unclosed open. + (goto-char (1+ containing-sexp)) + ;; Is there a complete sexp since then? + (if (and last-sexp (> last-sexp (point))) + ;; Yes, but is there a containing sexp after that? + (let ((peek (parse-partial-sexp last-sexp indent-point 0))) + (if (setq retry (car (cdr peek))) (setq state peek))))) + (if retry + nil + ;; Innermost containing sexp found + (goto-char (1+ containing-sexp)) + (if (not last-sexp) + ;; indent-point immediately follows open paren. + ;; Don't call hook. + (setq desired-indent (current-column)) + ;; Find the start of first element of containing sexp. + (parse-partial-sexp (point) last-sexp 0 t) + (cond ((looking-at "\\s(") + ;; First element of containing sexp is a list. + ;; Indent under that list. + ) + ((> (save-excursion (forward-line 1) (point)) + last-sexp) + ;; This is the first line to start within the containing sexp. + ;; It's almost certainly a function call. + (if (= (point) last-sexp) + ;; 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) + (parse-partial-sexp (point) last-sexp 0 t))) + (backward-prefix-chars)) + (t + ;; Indent beneath first sexp on same line as last-sexp. + ;; Again, it's almost certainly a function call. + (goto-char last-sexp) + (beginning-of-line) + (parse-partial-sexp (point) last-sexp 0 t) + (backward-prefix-chars))))) + ;; Point is at the point to indent under unless we are inside a string. + ;; Call indentation hook except when overriden by lisp-indent-offset + ;; 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. + (goto-char indent-point) + (skip-chars-forward " \t") + (current-column)) + ((and (integerp lisp-indent-offset) containing-sexp) + ;; Indent by constant offset + (goto-char containing-sexp) + (+ normal-indent lisp-indent-offset)) + (desired-indent) + ((and (boundp 'lisp-indent-hook) + lisp-indent-hook + (not retry)) + (or (funcall lisp-indent-hook indent-point state) + normal-indent)) + (t + normal-indent)))))) + +(defun lisp-indent-hook (indent-point state) + (let ((normal-indent (current-column))) + (goto-char (1+ (elt state 1))) + (parse-partial-sexp (point) last-sexp 0 t) + (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)) + last-sexp)) + (progn (goto-char last-sexp) + (beginning-of-line) + (parse-partial-sexp (point) last-sexp 0 t))) + ;; Indent under the list or under the first sexp on the + ;; same line as last-sexp. Note that first thing on that + ;; line has to be complete sexp since we are inside the + ;; innermost containing sexp. + (backward-prefix-chars) + (current-column)) + (let ((function (buffer-substring (point) + (progn (forward-sexp 1) (point)))) + method) + (setq method (get (intern-soft function) 'lisp-indent-hook)) + (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))))))) + +(defconst lisp-body-indent 2 "") + +(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-hook 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))))) + + +;; (put 'progn 'lisp-indent-hook 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-hook 'defun) +(put 'progn 'lisp-indent-hook 0) +(put 'prog1 'lisp-indent-hook 1) +(put 'save-excursion 'lisp-indent-hook 0) +(put 'save-window-excursion 'lisp-indent-hook 0) +(put 'save-restriction 'lisp-indent-hook 0) +(put 'let 'lisp-indent-hook 1) +(put 'let* 'lisp-indent-hook 1) +(put 'while 'lisp-indent-hook 1) +(put 'if 'lisp-indent-hook 2) +(put 'catch 'lisp-indent-hook 1) +(put 'condition-case 'lisp-indent-hook 2) +(put 'unwind-protect 'lisp-indent-hook 1) +(put 'with-output-to-temp-buffer 'lisp-indent-hook 1) + +(defun indent-sexp () + "Indent each line of the list starting just after point." + (interactive) + (let ((indent-stack (list nil)) (next-depth 0) bol + outer-loop-done inner-loop-done state this-indent) + ;; Get error now if we don't have a complete sexp after point. + (save-excursion (forward-sexp 1)) + (save-excursion + (setq outer-loop-done nil) + (while (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))) + (if (or outer-loop-done (setq outer-loop-done (<= next-depth 0))) + nil + (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 "[;\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)))))) + (if (integerp val) + (setcar indent-stack + (setq this-indent val)) + (setcar indent-stack (- (car (cdr val)))) + (setq this-indent (car val))))) + (if (/= (current-column) this-indent) + (progn (delete-region bol (point)) + (indent-to this-indent))))))))) + +(defun indent-code-rigidly (start end arg &optional nochange-regexp) + "Indent all lines of code, starting in the region, sideways by ARG columns. +Does not affect lines starting inside comments or strings, +assuming that the start of the region is not inside them. +Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP. +The last is a regexp which, if matched at the beginning of a line, +means don't indent that line." + (interactive "r\np") + (let (state) + (save-excursion + (goto-char end) + (setq end (point-marker)) + (goto-char start) + (or (bolp) + (setq state (parse-partial-sexp (point) + (progn + (forward-line 1) (point)) + nil nil state))) + (while (< (point) end) + (or (car (nthcdr 3 state)) + (and nochange-regexp + (looking-at nochange-regexp)) + ;; If line does not start in string, indent it + (let ((indent (current-indentation))) + (delete-region (point) (progn (skip-chars-forward " \t") (point))) + (or (eolp) + (indent-to (max 0 (+ indent arg)) 0)))) + (setq state (parse-partial-sexp (point) + (progn + (forward-line 1) (point)) + nil nil state)))))) + |