Mercurial > emacs
annotate lisp/emacs-lisp/pp.el @ 70166:1204092d4458
*** empty log message ***
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Fri, 21 Apr 2006 14:06:42 +0000 |
parents | 067115a6e738 |
children | 5eddbe565062 c5406394f567 |
rev | line source |
---|---|
13337 | 1 ;;; pp.el --- pretty printer for Emacs Lisp |
14169 | 2 |
64751
5b1a238fcbb4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64085
diff
changeset
|
3 ;; Copyright (C) 1989, 1993, 2001, 2002, 2003, 2004, |
68648
067115a6e738
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
65193
diff
changeset
|
4 ;; 2005, 2006 Free Software Foundation, Inc. |
8544 | 5 |
14224 | 6 ;; Author: Randal Schwartz <merlyn@stonehenge.com> |
39117 | 7 ;; Keywords: lisp |
8544 | 8 |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
14169 | 22 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
64085 | 23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 ;; Boston, MA 02110-1301, USA. | |
8544 | 25 |
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
23244
diff
changeset
|
26 ;;; Commentary: |
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
23244
diff
changeset
|
27 |
8544 | 28 ;;; Code: |
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
23244
diff
changeset
|
29 |
65193
228d206af8c8
(font-lock-verbose): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
64751
diff
changeset
|
30 (defvar font-lock-verbose) |
228d206af8c8
(font-lock-verbose): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
64751
diff
changeset
|
31 |
21365 | 32 (defgroup pp nil |
33 "Pretty printer for Emacs Lisp." | |
34 :prefix "pp-" | |
35 :group 'lisp) | |
8544 | 36 |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
43295
diff
changeset
|
37 (defcustom pp-escape-newlines t |
21365 | 38 "*Value of `print-escape-newlines' used by pp-* functions." |
39 :type 'boolean | |
40 :group 'pp) | |
8544 | 41 |
43295
ce2590f06ba0
2002-02-14 Per Abrahamsen <abraham@dina.kvl.dk>
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
39117
diff
changeset
|
42 ;;;###autoload |
8544 | 43 (defun pp-to-string (object) |
23244 | 44 "Return a string containing the pretty-printed representation of OBJECT. |
45 OBJECT can be any Lisp object. Quoting characters are used as needed | |
46 to make output that `read' can handle, whenever this is possible." | |
8544 | 47 (save-excursion |
48 (set-buffer (generate-new-buffer " pp-to-string")) | |
49 (unwind-protect | |
50 (progn | |
19147
ec57f19bc39c
(pp-to-string): Use emacs-lisp-mode-sytax-table.
Richard M. Stallman <rms@gnu.org>
parents:
16171
diff
changeset
|
51 (lisp-mode-variables nil) |
ec57f19bc39c
(pp-to-string): Use emacs-lisp-mode-sytax-table.
Richard M. Stallman <rms@gnu.org>
parents:
16171
diff
changeset
|
52 (set-syntax-table emacs-lisp-mode-syntax-table) |
20598
a61e2395961f
(pp-to-string): Greatly simplify by letting the
Andreas Schwab <schwab@suse.de>
parents:
19147
diff
changeset
|
53 (let ((print-escape-newlines pp-escape-newlines) |
a61e2395961f
(pp-to-string): Greatly simplify by letting the
Andreas Schwab <schwab@suse.de>
parents:
19147
diff
changeset
|
54 (print-quoted t)) |
8544 | 55 (prin1 object (current-buffer))) |
55802
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
56 (pp-buffer) |
8544 | 57 (buffer-string)) |
58 (kill-buffer (current-buffer))))) | |
59 | |
56274 | 60 ;;;###autoload |
55802
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
61 (defun pp-buffer () |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
62 "Prettify the current buffer with printed representation of a Lisp object." |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
63 (goto-char (point-min)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
64 (while (not (eobp)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
65 ;; (message "%06d" (- (point-max) (point))) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
66 (cond |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
67 ((condition-case err-var |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
68 (prog1 t (down-list 1)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
69 (error nil)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
70 (save-excursion |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
71 (backward-char 1) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
72 (skip-chars-backward "'`#^") |
63852
dd7fb3231397
(pp-buffer): Change space constants followed by a sexp to "?\s ".
Juanma Barranquero <lekktu@gmail.com>
parents:
56274
diff
changeset
|
73 (when (and (not (bobp)) (memq (char-before) '(?\s ?\t ?\n))) |
55802
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
74 (delete-region |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
75 (point) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
76 (progn (skip-chars-backward " \t\n") (point))) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
77 (insert "\n")))) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
78 ((condition-case err-var |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
79 (prog1 t (up-list 1)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
80 (error nil)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
81 (while (looking-at "\\s)") |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
82 (forward-char 1)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
83 (delete-region |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
84 (point) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
85 (progn (skip-chars-forward " \t\n") (point))) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
86 (insert ?\n)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
87 (t (goto-char (point-max))))) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
88 (goto-char (point-min)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
89 (indent-sexp)) |
7bb617df33db
(pp-buffer): New fun created from the code in
Juri Linkov <juri@jurta.org>
parents:
54502
diff
changeset
|
90 |
10329 | 91 ;;;###autoload |
8544 | 92 (defun pp (object &optional stream) |
93 "Output the pretty-printed representation of OBJECT, any Lisp object. | |
23244 | 94 Quoting characters are printed as needed to make output that `read' |
8544 | 95 can handle, whenever this is possible. |
96 Output stream is STREAM, or value of `standard-output' (which see)." | |
97 (princ (pp-to-string object) (or stream standard-output))) | |
98 | |
10329 | 99 ;;;###autoload |
8544 | 100 (defun pp-eval-expression (expression) |
101 "Evaluate EXPRESSION and pretty-print value into a new display buffer. | |
102 If the pretty-printed value fits on one line, the message line is used | |
23244 | 103 instead. The value is also consed onto the front of the list |
104 in the variable `values'." | |
8544 | 105 (interactive "xPp-eval: ") |
106 (setq values (cons (eval expression) values)) | |
11730
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
107 (let* ((old-show-function temp-buffer-show-function) |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
108 ;; Use this function to display the buffer. |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
109 ;; This function either decides not to display it at all |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
110 ;; or displays it in the usual way. |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
111 (temp-buffer-show-function |
8544 | 112 (function |
113 (lambda (buf) | |
114 (save-excursion | |
115 (set-buffer buf) | |
116 (goto-char (point-min)) | |
117 (end-of-line 1) | |
118 (if (or (< (1+ (point)) (point-max)) | |
14225
ec298b8bee29
(pp-eval-expression): Use `frame-width' instead of `screen-width'.
Erik Naggum <erik@naggum.no>
parents:
14224
diff
changeset
|
119 (>= (- (point) (point-min)) (frame-width))) |
11730
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
120 (let ((temp-buffer-show-function old-show-function) |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
121 (old-selected (selected-window)) |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
122 (window (display-buffer buf))) |
8544 | 123 (goto-char (point-min)) ; expected by some hooks ... |
11730
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
124 (make-frame-visible (window-frame window)) |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
125 (unwind-protect |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
126 (progn |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
127 (select-window window) |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
128 (run-hooks 'temp-buffer-show-hook)) |
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
129 (select-window old-selected))) |
8544 | 130 (message "%s" (buffer-substring (point-min) (point))) |
11730
084c36d46615
(pp-eval-expression): Update use of temp-buffer-show-function.
Richard M. Stallman <rms@gnu.org>
parents:
10732
diff
changeset
|
131 )))))) |
8544 | 132 (with-output-to-temp-buffer "*Pp Eval Output*" |
54502
a8550ca246eb
(pp-eval-expression): Simplify.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
133 (pp (car values)) |
a8550ca246eb
(pp-eval-expression): Simplify.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
134 (with-current-buffer standard-output |
a8550ca246eb
(pp-eval-expression): Simplify.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
135 (emacs-lisp-mode) |
a8550ca246eb
(pp-eval-expression): Simplify.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
136 (set (make-local-variable 'font-lock-verbose) nil))))) |
8544 | 137 |
10329 | 138 ;;;###autoload |
8544 | 139 (defun pp-eval-last-sexp (arg) |
140 "Run `pp-eval-expression' on sexp before point (which see). | |
141 With argument, pretty-print output into current buffer. | |
142 Ignores leading comment characters." | |
143 (interactive "P") | |
144 (let ((stab (syntax-table)) (pt (point)) start exp) | |
145 (set-syntax-table emacs-lisp-mode-syntax-table) | |
146 (save-excursion | |
147 (forward-sexp -1) | |
148 ;; If first line is commented, ignore all leading comments: | |
149 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*;")) | |
150 (progn | |
151 (setq exp (buffer-substring (point) pt)) | |
152 (while (string-match "\n[ \t]*;+" exp start) | |
153 (setq start (1+ (match-beginning 0)) | |
154 exp (concat (substring exp 0 start) | |
155 (substring exp (match-end 0))))) | |
156 (setq exp (read exp))) | |
157 (setq exp (read (current-buffer))))) | |
158 (set-syntax-table stab) | |
159 (if arg | |
160 (insert (pp-to-string (eval exp))) | |
161 (pp-eval-expression exp)))) | |
162 | |
163 ;;; Test cases for quote | |
164 ;; (pp-eval-expression ''(quote quote)) | |
165 ;; (pp-eval-expression ''((quote a) (quote b))) | |
166 ;; (pp-eval-expression ''('a 'b)) ; same as above | |
167 ;; (pp-eval-expression ''((quote (quote quote)) (quote quote))) | |
168 ;; These do not satisfy the quote test. | |
169 ;; (pp-eval-expression ''quote) | |
170 ;; (pp-eval-expression ''(quote)) | |
171 ;; (pp-eval-expression ''(quote . quote)) | |
172 ;; (pp-eval-expression ''(quote a b)) | |
173 ;; (pp-eval-expression ''(quotefoo)) | |
174 ;; (pp-eval-expression ''(a b)) | |
175 | |
176 (provide 'pp) ; so (require 'pp) works | |
177 | |
52401 | 178 ;;; arch-tag: b0f7c65b-02c7-42bb-9ee3-508a59b8fbb9 |
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
23244
diff
changeset
|
179 ;;; pp.el ends here |