Commit | Line | Data |
---|---|---|
be010748 | 1 | ;;; pp.el --- pretty printer for Emacs Lisp |
b578f267 | 2 | |
eaf33a17 | 3 | ;; Copyright (C) 1989, 1993, 2001, 2004 Free Software Foundation, Inc. |
258544f8 | 4 | |
df072942 | 5 | ;; Author: Randal Schwartz <merlyn@stonehenge.com> |
284b3043 | 6 | ;; Keywords: lisp |
258544f8 RS |
7 | |
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
258544f8 | 24 | |
e8af40ee PJ |
25 | ;;; Commentary: |
26 | ||
258544f8 | 27 | ;;; Code: |
e8af40ee | 28 | |
666b9413 SE |
29 | (defgroup pp nil |
30 | "Pretty printer for Emacs Lisp." | |
31 | :prefix "pp-" | |
32 | :group 'lisp) | |
33 | ||
a1506d29 | 34 | (defcustom pp-escape-newlines t |
666b9413 SE |
35 | "*Value of `print-escape-newlines' used by pp-* functions." |
36 | :type 'boolean | |
37 | :group 'pp) | |
258544f8 | 38 | |
0e520006 | 39 | ;;;###autoload |
258544f8 | 40 | (defun pp-to-string (object) |
e189df50 KH |
41 | "Return a string containing the pretty-printed representation of OBJECT. |
42 | OBJECT can be any Lisp object. Quoting characters are used as needed | |
43 | to make output that `read' can handle, whenever this is possible." | |
258544f8 RS |
44 | (save-excursion |
45 | (set-buffer (generate-new-buffer " pp-to-string")) | |
46 | (unwind-protect | |
47 | (progn | |
15b605ae RS |
48 | (lisp-mode-variables nil) |
49 | (set-syntax-table emacs-lisp-mode-syntax-table) | |
3d98a374 AS |
50 | (let ((print-escape-newlines pp-escape-newlines) |
51 | (print-quoted t)) | |
258544f8 | 52 | (prin1 object (current-buffer))) |
575c3bca | 53 | (pp-buffer) |
258544f8 RS |
54 | (buffer-string)) |
55 | (kill-buffer (current-buffer))))) | |
56 | ||
c47e847f | 57 | ;;;###autoload |
575c3bca JL |
58 | (defun pp-buffer () |
59 | "Prettify the current buffer with printed representation of a Lisp object." | |
60 | (goto-char (point-min)) | |
61 | (while (not (eobp)) | |
62 | ;; (message "%06d" (- (point-max) (point))) | |
63 | (cond | |
64 | ((condition-case err-var | |
65 | (prog1 t (down-list 1)) | |
66 | (error nil)) | |
67 | (save-excursion | |
68 | (backward-char 1) | |
69 | (skip-chars-backward "'`#^") | |
70 | (when (and (not (bobp)) (memq (char-before) '(?\ ?\t ?\n))) | |
71 | (delete-region | |
72 | (point) | |
73 | (progn (skip-chars-backward " \t\n") (point))) | |
74 | (insert "\n")))) | |
75 | ((condition-case err-var | |
76 | (prog1 t (up-list 1)) | |
77 | (error nil)) | |
78 | (while (looking-at "\\s)") | |
79 | (forward-char 1)) | |
80 | (delete-region | |
81 | (point) | |
82 | (progn (skip-chars-forward " \t\n") (point))) | |
83 | (insert ?\n)) | |
84 | (t (goto-char (point-max))))) | |
85 | (goto-char (point-min)) | |
86 | (indent-sexp)) | |
87 | ||
ccba0a20 | 88 | ;;;###autoload |
258544f8 RS |
89 | (defun pp (object &optional stream) |
90 | "Output the pretty-printed representation of OBJECT, any Lisp object. | |
e189df50 | 91 | Quoting characters are printed as needed to make output that `read' |
258544f8 RS |
92 | can handle, whenever this is possible. |
93 | Output stream is STREAM, or value of `standard-output' (which see)." | |
94 | (princ (pp-to-string object) (or stream standard-output))) | |
95 | ||
ccba0a20 | 96 | ;;;###autoload |
258544f8 RS |
97 | (defun pp-eval-expression (expression) |
98 | "Evaluate EXPRESSION and pretty-print value into a new display buffer. | |
99 | If the pretty-printed value fits on one line, the message line is used | |
e189df50 KH |
100 | instead. The value is also consed onto the front of the list |
101 | in the variable `values'." | |
258544f8 RS |
102 | (interactive "xPp-eval: ") |
103 | (setq values (cons (eval expression) values)) | |
bf464fad RS |
104 | (let* ((old-show-function temp-buffer-show-function) |
105 | ;; Use this function to display the buffer. | |
106 | ;; This function either decides not to display it at all | |
107 | ;; or displays it in the usual way. | |
108 | (temp-buffer-show-function | |
258544f8 RS |
109 | (function |
110 | (lambda (buf) | |
111 | (save-excursion | |
112 | (set-buffer buf) | |
113 | (goto-char (point-min)) | |
114 | (end-of-line 1) | |
115 | (if (or (< (1+ (point)) (point-max)) | |
06115f9d | 116 | (>= (- (point) (point-min)) (frame-width))) |
bf464fad RS |
117 | (let ((temp-buffer-show-function old-show-function) |
118 | (old-selected (selected-window)) | |
119 | (window (display-buffer buf))) | |
258544f8 | 120 | (goto-char (point-min)) ; expected by some hooks ... |
bf464fad RS |
121 | (make-frame-visible (window-frame window)) |
122 | (unwind-protect | |
123 | (progn | |
124 | (select-window window) | |
125 | (run-hooks 'temp-buffer-show-hook)) | |
126 | (select-window old-selected))) | |
258544f8 | 127 | (message "%s" (buffer-substring (point-min) (point))) |
bf464fad | 128 | )))))) |
258544f8 | 129 | (with-output-to-temp-buffer "*Pp Eval Output*" |
eaf33a17 SM |
130 | (pp (car values)) |
131 | (with-current-buffer standard-output | |
132 | (emacs-lisp-mode) | |
133 | (set (make-local-variable 'font-lock-verbose) nil))))) | |
258544f8 | 134 | |
ccba0a20 | 135 | ;;;###autoload |
258544f8 RS |
136 | (defun pp-eval-last-sexp (arg) |
137 | "Run `pp-eval-expression' on sexp before point (which see). | |
138 | With argument, pretty-print output into current buffer. | |
139 | Ignores leading comment characters." | |
140 | (interactive "P") | |
141 | (let ((stab (syntax-table)) (pt (point)) start exp) | |
142 | (set-syntax-table emacs-lisp-mode-syntax-table) | |
143 | (save-excursion | |
144 | (forward-sexp -1) | |
145 | ;; If first line is commented, ignore all leading comments: | |
146 | (if (save-excursion (beginning-of-line) (looking-at "[ \t]*;")) | |
147 | (progn | |
148 | (setq exp (buffer-substring (point) pt)) | |
149 | (while (string-match "\n[ \t]*;+" exp start) | |
150 | (setq start (1+ (match-beginning 0)) | |
151 | exp (concat (substring exp 0 start) | |
152 | (substring exp (match-end 0))))) | |
153 | (setq exp (read exp))) | |
154 | (setq exp (read (current-buffer))))) | |
155 | (set-syntax-table stab) | |
156 | (if arg | |
157 | (insert (pp-to-string (eval exp))) | |
158 | (pp-eval-expression exp)))) | |
159 | ||
160 | ;;; Test cases for quote | |
161 | ;; (pp-eval-expression ''(quote quote)) | |
162 | ;; (pp-eval-expression ''((quote a) (quote b))) | |
163 | ;; (pp-eval-expression ''('a 'b)) ; same as above | |
164 | ;; (pp-eval-expression ''((quote (quote quote)) (quote quote))) | |
165 | ;; These do not satisfy the quote test. | |
166 | ;; (pp-eval-expression ''quote) | |
167 | ;; (pp-eval-expression ''(quote)) | |
168 | ;; (pp-eval-expression ''(quote . quote)) | |
169 | ;; (pp-eval-expression ''(quote a b)) | |
170 | ;; (pp-eval-expression ''(quotefoo)) | |
171 | ;; (pp-eval-expression ''(a b)) | |
172 | ||
173 | (provide 'pp) ; so (require 'pp) works | |
174 | ||
ab5796a9 | 175 | ;;; arch-tag: b0f7c65b-02c7-42bb-9ee3-508a59b8fbb9 |
e8af40ee | 176 | ;;; pp.el ends here |