[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#63861: [PATCH] pp.el: New "pretty printing" code
|
From: |
Stefan Monnier |
|
Subject: |
bug#63861: [PATCH] pp.el: New "pretty printing" code |
|
Date: |
Fri, 16 Jun 2023 14:26:54 -0400 |
|
User-agent: |
Gnus/5.13 (Gnus v5.13) |
> Otherwise LGTM, thanks.
OK, I think I have it almost ready see the patches below.
I just hit one snag when trying to fix the tests.
We have for example the following test:
(ert-deftest pp-print-quote ()
(should (string= (pp-to-string 'quote) "quote"))
(should (string= (pp-to-string ''quote) "'quote"))
(should (string= (pp-to-string '('a 'b)) "('a 'b)\n"))
(should (string= (pp-to-string '(''quote 'quote)) "(''quote 'quote)\n"))
This is how the old code behaved, i.e. the output sometimes ends with \n
and sometimes not, depending on whether the object printed is a list or not.
Currently, my new code behaves the same when using `pp-28` or `pp-29`
but when using the new default (i.e. `pp-fill`) the output never ends in
\n. This change was not intentional, but I think it makes sense because
it's more consistent.
I'm not completely sure how we should fix this. I think the old
behavior of sometimes adding \n and sometimes not is not desirable, so
I think we should change it (a backward incompatible change).
We have two remaining choices:
A) never add \n
B) always add \n
AFAICT, in practice the old behavior resulted in a \n added in most
cases, so (B) should lead to less breakage, but OTOH I think (A) would
be cleaner since it's easier for callers to add a \n when needed than
for them to remove a \n.
WDYT? A or B?
Stefan
>From 31bc44c81386f8db2aecfe1529d051fed1367df9 Mon Sep 17 00:00:00 2001
From: Stefan Monnier <monnier@iro.umontreal.ca>
Date: Fri, 16 Jun 2023 13:14:27 -0400
Subject: [PATCH 1/5] * lisp/emacs-lisp/lisp-mode.el (lisp-ppss): Fix
performance bug
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
(nth 2 ppss) can be absent but not incorrect, so don't recompute ppss
for (nth 2 ppss) when (nth 2 ppss) is already provided.
When calling `lisp-indent-line` on all the lines in a region, this
sometimes introduced a gratuitous O(N²) complexity.
---
lisp/emacs-lisp/lisp-mode.el | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lisp/emacs-lisp/lisp-mode.el b/lisp/emacs-lisp/lisp-mode.el
index d44c9d6e23d..9914ededb85 100644
--- a/lisp/emacs-lisp/lisp-mode.el
+++ b/lisp/emacs-lisp/lisp-mode.el
@@ -876,7 +876,7 @@ lisp-ppss
2 (counting from 0). This is important for Lisp indentation."
(unless pos (setq pos (point)))
(let ((pss (syntax-ppss pos)))
- (if (nth 9 pss)
+ (if (and (not (nth 2 pss)) (nth 9 pss))
(let ((sexp-start (car (last (nth 9 pss)))))
(parse-partial-sexp sexp-start pos nil nil (syntax-ppss sexp-start)))
pss)))
--
2.39.2
>From 16c8fa5e209e5d13f86e87a84a678608de0d5341 Mon Sep 17 00:00:00 2001
From: Stefan Monnier <monnier@iro.umontreal.ca>
Date: Fri, 16 Jun 2023 13:31:13 -0400
Subject: [PATCH 2/5] pp.el (pp-default-function): New custom var
* lisp/emacs-lisp/pp.el (pp-use-max-width): Make obsolete.
(pp-default-function): New custom var.
(pp--object, pp--region): New helper functions.
(pp-29): New function, extracted from `pp-to-string`.
(pp-to-string): Add `pp-function` arg and obey `pp-default-function`.
(pp-28): New function, extracted from `pp-buffer`.
(pp-buffer): Rewrite, using `pp` so it obeys `pp-default-function`.
(pp): Add new calling convention to apply it to a region,
and obey `pp-default-function`.
(pp-emacs-lisp-code): Add new calling convention to apply it to a region.
---
lisp/emacs-lisp/pp.el | 198 ++++++++++++++++++++++++++++++------------
1 file changed, 144 insertions(+), 54 deletions(-)
diff --git a/lisp/emacs-lisp/pp.el b/lisp/emacs-lisp/pp.el
index e6e3cd6c6f4..0798e46f735 100644
--- a/lisp/emacs-lisp/pp.el
+++ b/lisp/emacs-lisp/pp.el
@@ -52,53 +52,132 @@ pp-use-max-width
large lists."
:type 'boolean
:version "29.1")
+(make-obsolete-variable 'pp-use-max-width 'pp-default-function "30.1")
+
+(defcustom pp-default-function #'pp-29
+ ;; FIXME: The best pretty printer to use depends on the use-case
+ ;; so maybe we should allow callers to specify what they want (maybe with
+ ;; options like `fast', `compact', `code', `data', ...) and these
+ ;; can then be mapped to actual pretty-printing algorithms.
+ ;; Then again, callers can just directly call the corresponding function.
+ "Function that `pp' should dispatch to for pretty printing.
+That function can be called in one of two ways:
+- with a single argument, which it should insert and pretty-print at point.
+- with two arguments which delimit a region containing Lisp sexps
+ which should be pretty-printed.
+In both cases, the function can presume that the buffer is setup for
+Lisp syntax."
+ :type '(choice
+ (const :tag "Emacs≤28 algorithm, fast and good enough" pp-28)
+ (const :tag "Work hard for code (slow on large inputs)"
+ pp-emacs-lisp-code)
+ (const :tag "`pp-emacs-lisp-code' if `pp-use-max-width' else `pp-28'"
+ pp-29)
+ function)
+ :version "30.1")
(defvar pp--inhibit-function-formatting nil)
+;; There are basically two APIs for a pretty-printing function:
+;;
+;; - either the function takes an object (and prints it in addition to
+;; prettifying it).
+;; - or the function takes a region containing an already printed object
+;; and prettifies its content.
+;;
+;; `pp--object' and `pp--region' are helper functions to convert one
+;; API to the other.
+
+
+(defun pp--object (object region-function)
+ "Pretty-print OBJECT at point.
+The prettifying is done by REGION-FUNCTION which is
+called with two positions as arguments and should fold lines
+within that region. Returns the result as a string."
+ (let ((print-escape-newlines pp-escape-newlines)
+ (print-quoted t)
+ (beg (point)))
+ ;; FIXME: In many cases it would be preferable to use `cl-prin1' here.
+ (prin1 object (current-buffer))
+ (funcall region-function beg (point))))
+
+(defun pp--region (beg end object-function)
+ "Pretty-print the object(s) contained within BEG..END.
+OBJECT-FUNCTION is called with a single object as argument
+and should pretty print it at point into the current buffer."
+ (save-excursion
+ (with-restriction beg end
+ (goto-char (point-min))
+ (while
+ (progn
+ ;; We'll throw away all the comments within objects, but let's
+ ;; try at least to preserve the comments between objects.
+ (forward-comment (point-max))
+ (let ((beg (point))
+ (object (ignore-error end-of-buffer
+ (list (read (current-buffer))))))
+ (when (consp object)
+ (delete-region beg (point))
+ (funcall object-function (car object))
+ t)))))))
+
+(defun pp-29 (beg-or-sexp &optional end) ;FIXME: Better name?
+ "Prettify the current region with printed representation of a Lisp object.
+Uses the pretty-printing algorithm that was standard in Emacs-29,
+which, depending on `pp-use-max-width', will either use `pp-28'
+or `pp-emacs-lisp-code'."
+ (if pp-use-max-width
+ (let ((pp--inhibit-function-formatting t)) ;FIXME: Why?
+ (pp-emacs-lisp-code beg-or-sexp end))
+ (pp-28 beg-or-sexp end)))
+
;;;###autoload
-(defun pp-to-string (object)
+(defun pp-to-string (object &optional pp-function)
"Return a string containing the pretty-printed representation of OBJECT.
OBJECT can be any Lisp object. Quoting characters are used as needed
-to make output that `read' can handle, whenever this is possible."
- (if pp-use-max-width
- (let ((pp--inhibit-function-formatting t))
- (with-temp-buffer
- (pp-emacs-lisp-code object)
- (buffer-string)))
- (with-temp-buffer
- (lisp-mode-variables nil)
- (set-syntax-table emacs-lisp-mode-syntax-table)
- (let ((print-escape-newlines pp-escape-newlines)
- (print-quoted t))
- (prin1 object (current-buffer)))
- (pp-buffer)
- (buffer-string))))
+to make output that `read' can handle, whenever this is possible.
+Optional argument PP-FUNCTION overrides `pp-default-function'."
+ (with-temp-buffer
+ (lisp-mode-variables nil)
+ (set-syntax-table emacs-lisp-mode-syntax-table)
+ (funcall (or pp-function pp-default-function) object)
+ (buffer-string)))
;;;###autoload
(defun pp-buffer ()
"Prettify the current buffer with printed representation of a Lisp object."
(interactive)
- (goto-char (point-min))
- (while (not (eobp))
- (cond
- ((ignore-errors (down-list 1) t)
- (save-excursion
- (backward-char 1)
- (skip-chars-backward "'`#^")
- (when (and (not (bobp)) (memq (char-before) '(?\s ?\t ?\n)))
+ (pp (point-min) (point-max)))
+
+(defun pp-28 (beg &optional end) ;FIXME: Better name?
+ "Prettify the current region with printed representation of a Lisp object.
+Uses the pretty-printing algorithm that was standard in Emacs≤29.
+Non-interactively can also be called with a single argument, in which
+case that argument will be inserted pretty-printed at point."
+ (interactive "r")
+ (if (null end) (pp--object beg #'pp-29)
+ (save-restriction beg end
+ (goto-char (point-min))
+ (while (not (eobp))
+ (cond
+ ((ignore-errors (down-list 1) t)
+ (save-excursion
+ (backward-char 1)
+ (skip-chars-backward "'`#^")
+ (when (and (not (bobp)) (memq (char-before) '(?\s ?\t ?\n)))
+ (delete-region
+ (point)
+ (progn (skip-chars-backward " \t\n") (point)))
+ (insert "\n"))))
+ ((ignore-errors (up-list 1) t)
+ (skip-syntax-forward ")")
(delete-region
(point)
- (progn (skip-chars-backward " \t\n") (point)))
- (insert "\n"))))
- ((ignore-errors (up-list 1) t)
- (skip-syntax-forward ")")
- (delete-region
- (point)
- (progn (skip-chars-forward " \t\n") (point)))
- (insert ?\n))
- (t (goto-char (point-max)))))
- (goto-char (point-min))
- (indent-sexp))
+ (progn (skip-chars-forward " \t\n") (point)))
+ (insert ?\n))
+ (t (goto-char (point-max)))))
+ (goto-char (point-min))
+ (indent-sexp))))
;;;###autoload
(defun pp (object &optional stream)
@@ -106,14 +185,22 @@ pp
Quoting characters are printed as needed to make output that `read'
can handle, whenever this is possible.
-This function does not apply special formatting rules for Emacs
-Lisp code. See `pp-emacs-lisp-code' instead.
-
-By default, this function won't limit the line length of lists
-and vectors. Bind `pp-use-max-width' to a non-nil value to do so.
-
-Output stream is STREAM, or value of `standard-output' (which see)."
- (princ (pp-to-string object) (or stream standard-output)))
+Uses the pretty-printing code specified in `pp-default-function'.
+
+Output stream is STREAM, or value of `standard-output' (which see).
+An alternative calling convention is to pass it two buffer positions,
+in which case it will prettify that region's content."
+ (cond
+ ((and (integerp object) (integerp stream))
+ (funcall pp-default-function object stream))
+ ((and (eq (or stream standard-output) (current-buffer))
+ ;; Make sure the current buffer is setup sanely.
+ (eq (syntax-table) emacs-lisp-mode-syntax-table)
+ (eq indent-line-function #'lisp-indent-line))
+ ;; Skip the buffer->string->buffer middle man.
+ (funcall pp-default-function object))
+ (t
+ (princ (pp-to-string object) (or stream standard-output)))))
;;;###autoload
(defun pp-display-expression (expression out-buffer-name &optional lisp)
@@ -220,21 +307,24 @@ pp-macroexpand-last-sexp
(pp-macroexpand-expression (pp-last-sexp))))
;;;###autoload
-(defun pp-emacs-lisp-code (sexp)
+(defun pp-emacs-lisp-code (sexp &optional end)
"Insert SEXP into the current buffer, formatted as Emacs Lisp code.
Use the `pp-max-width' variable to control the desired line length.
-Note that this could be slow for large SEXPs."
+Note that this could be slow for large SEXPs.
+Can also be called with two arguments, in which case they're taken to be
+the bounds of a region containing Lisp code to pretty-print."
(require 'edebug)
- (let ((obuf (current-buffer)))
- (with-temp-buffer
- (emacs-lisp-mode)
- (pp--insert-lisp sexp)
- (insert "\n")
- (goto-char (point-min))
- (indent-sexp)
- (while (re-search-forward " +$" nil t)
- (replace-match ""))
- (insert-into-buffer obuf))))
+ (if end (pp--region sexp end #'pp-emacs-lisp-code)
+ (let ((obuf (current-buffer)))
+ (with-temp-buffer
+ (emacs-lisp-mode)
+ (pp--insert-lisp sexp)
+ (insert "\n")
+ (goto-char (point-min))
+ (indent-sexp)
+ (while (re-search-forward " +$" nil t)
+ (replace-match ""))
+ (insert-into-buffer obuf)))))
(defun pp--insert-lisp (sexp)
(cl-case (type-of sexp)
--
2.39.2
>From 2e10c9ef0b697fe55d6a5162312a217bc22133a1 Mon Sep 17 00:00:00 2001
From: Stefan Monnier <monnier@iro.umontreal.ca>
Date: Fri, 16 Jun 2023 13:21:15 -0400
Subject: [PATCH 3/5] pp.el (pp-buffer): Mark as obsolete
* lisp/emacs-lisp/pp.el (pp-buffer): Mark as obsolete
* lisp/org/org-table.el (org-table-fedit-lisp-indent):
* lisp/emacs-lisp/lisp-mode.el (indent-pp-sexp):
* lisp/emacs-lisp/backtrace.el (backtrace--multi-line):
* lisp/ielm.el (ielm-eval-input):
* lisp/help-fns.el (describe-variable): Use the new `pp` calling
convention instead of `pp-buffer`.
(help-fns-edit-variable): Use `pp` instead of `prin1` + `pp-buffer`.
Use the new `pp`
---
lisp/emacs-lisp/backtrace.el | 2 +-
lisp/emacs-lisp/lisp-mode.el | 2 +-
lisp/emacs-lisp/pp.el | 1 +
lisp/help-fns.el | 9 ++++-----
lisp/ielm.el | 2 +-
lisp/org/org-table.el | 5 ++++-
6 files changed, 12 insertions(+), 9 deletions(-)
diff --git a/lisp/emacs-lisp/backtrace.el b/lisp/emacs-lisp/backtrace.el
index 57912c854b0..81cfafa5738 100644
--- a/lisp/emacs-lisp/backtrace.el
+++ b/lisp/emacs-lisp/backtrace.el
@@ -556,7 +556,7 @@ backtrace-multi-line
(defun backtrace--multi-line ()
"Pretty print the current buffer, then remove the trailing newline."
(set-syntax-table emacs-lisp-mode-syntax-table)
- (pp-buffer)
+ (pp (point-min) (point-max))
(goto-char (1- (point-max)))
(delete-char 1))
diff --git a/lisp/emacs-lisp/lisp-mode.el b/lisp/emacs-lisp/lisp-mode.el
index 9914ededb85..83b374551fc 100644
--- a/lisp/emacs-lisp/lisp-mode.el
+++ b/lisp/emacs-lisp/lisp-mode.el
@@ -1418,7 +1418,7 @@ indent-pp-sexp
(save-excursion
(save-restriction
(narrow-to-region (point) (progn (forward-sexp 1) (point)))
- (pp-buffer)
+ (pp (point-min) (point-max))
(goto-char (point-max))
(if (eq (char-before) ?\n)
(delete-char -1)))))
diff --git a/lisp/emacs-lisp/pp.el b/lisp/emacs-lisp/pp.el
index 0798e46f735..65325dea6f1 100644
--- a/lisp/emacs-lisp/pp.el
+++ b/lisp/emacs-lisp/pp.el
@@ -146,6 +146,7 @@ pp-to-string
;;;###autoload
(defun pp-buffer ()
"Prettify the current buffer with printed representation of a Lisp object."
+ (declare (obsolete pp "30"))
(interactive)
(pp (point-min) (point-max)))
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index b9388b45397..79a2b9a495b 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -1341,7 +1341,7 @@ describe-variable
(lisp-data-mode)
(set-syntax-table emacs-lisp-mode-syntax-table)
(insert print-rep)
- (pp-buffer)
+ (pp (point-min) (point-max))
(font-lock-ensure)
(let ((pp-buffer (current-buffer)))
(with-current-buffer buf
@@ -1368,7 +1368,7 @@ describe-variable
(cl-prin1 origval))
(save-restriction
(narrow-to-region from (point))
- (save-excursion (pp-buffer)))
+ (save-excursion (pp (point-min) (point-max))))
(help-fns--editable-variable from (point)
variable origval buffer)
(if (< (point) (+ from 20))
@@ -1399,7 +1399,7 @@ describe-variable
(cl-prin1 global-val)
(save-restriction
(narrow-to-region from (point))
- (save-excursion (pp-buffer)))
+ (save-excursion (pp (point-min) (point-max))))
;; See previous comment for this function.
;; (help-xref-on-pp from (point))
(if (< (point) (+ from 20))
@@ -1479,8 +1479,7 @@ help-fns-edit-variable
(unless var
(error "No variable under point"))
(pop-to-buffer-same-window (format "*edit %s*" (nth 0 var)))
- (prin1 (nth 1 var) (current-buffer))
- (pp-buffer)
+ (pp (nth 1 var) (current-buffer))
(goto-char (point-min))
(help-fns--edit-value-mode)
(insert (format ";; Edit the `%s' variable.\n" (nth 0 var))
diff --git a/lisp/ielm.el b/lisp/ielm.el
index 5c370733c05..f7984ea162c 100644
--- a/lisp/ielm.el
+++ b/lisp/ielm.el
@@ -436,7 +436,7 @@ ielm-eval-input
;; right buffer!
(with-current-buffer ielmbuf
(cl-prin1 result tmpbuf))
- (pp-buffer)
+ (pp (point-min) (point-max))
(concat (buffer-string) aux))))))
(error
(setq error-type "IELM Error")
diff --git a/lisp/org/org-table.el b/lisp/org/org-table.el
index 42f234790c5..ecd17c76ec2 100644
--- a/lisp/org/org-table.el
+++ b/lisp/org/org-table.el
@@ -3717,7 +3717,10 @@ org-table-fedit-lisp-indent
(setq this-command nil)
(while (re-search-forward "[ \t]*\n[ \t]*" nil t)
(replace-match " ")))
- (pp-buffer)
+ (if (fboundp 'pp-buffer) ;Obsolete since Emacs-30
+ (with-suppressed-warnings ((obsolete pp-buffer))
+ (pp-buffer))
+ (pp (point-min) (point-max)))
(untabify (point-min) (point-max))
(goto-char (1+ (point-min)))
(while (re-search-forward "^." nil t)
--
2.39.2
>From cee9fb91a200afbaa9d3e7e52d8cd1533e150acc Mon Sep 17 00:00:00 2001
From: Stefan Monnier <monnier@iro.umontreal.ca>
Date: Fri, 16 Jun 2023 13:35:06 -0400
Subject: [PATCH 4/5] pp.el (pp-fill): New default pp function
* lisp/emacs-lisp/pp.el (pp-default-function): Change default.
(pp--within-fill-column-p): New helper function.
(pp-fill): New function.
---
lisp/emacs-lisp/pp.el | 91 ++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 90 insertions(+), 1 deletion(-)
diff --git a/lisp/emacs-lisp/pp.el b/lisp/emacs-lisp/pp.el
index 65325dea6f1..2dc8f7cb65d 100644
--- a/lisp/emacs-lisp/pp.el
+++ b/lisp/emacs-lisp/pp.el
@@ -54,7 +54,7 @@ pp-use-max-width
:version "29.1")
(make-obsolete-variable 'pp-use-max-width 'pp-default-function "30.1")
-(defcustom pp-default-function #'pp-29
+(defcustom pp-default-function #'pp-fill
;; FIXME: The best pretty printer to use depends on the use-case
;; so maybe we should allow callers to specify what they want (maybe with
;; options like `fast', `compact', `code', `data', ...) and these
@@ -68,6 +68,7 @@ pp-default-function
In both cases, the function can presume that the buffer is setup for
Lisp syntax."
:type '(choice
+ (const :tag "Fit within `fill-column'" pp-fill)
(const :tag "Emacs≤28 algorithm, fast and good enough" pp-28)
(const :tag "Work hard for code (slow on large inputs)"
pp-emacs-lisp-code)
@@ -143,6 +144,94 @@ pp-to-string
(funcall (or pp-function pp-default-function) object)
(buffer-string)))
+(defun pp--within-fill-column-p ()
+ "Return non-nil if point is within `fill-column'."
+ ;; Try and make it O(fill-column) rather than O(current-column),
+ ;; so as to avoid major slowdowns on long lines.
+ ;; FIXME: This doesn't account for invisible text or `display' properties :-(
+ (and (save-excursion
+ (re-search-backward
+ "^\\|\n" (max (point-min) (- (point) fill-column)) t))
+ (<= (current-column) fill-column)))
+
+(defun pp-fill (beg &optional end)
+ "Break lines in Lisp code between BEG and END so it fits within
`fill-column'.
+Presumes the current buffer has syntax and indentation properly
+configured for that.
+Designed under the assumption that the region occupies a single line,
+tho it should also work if that's not the case.
+Can also be called with a single argument, in which case
+it inserts and pretty-prints that arg at point."
+ (interactive "r")
+ (if (null end) (pp--object beg #'pp-fill)
+ (goto-char beg)
+ (let ((end (copy-marker end t))
+ (newline (lambda ()
+ (skip-chars-forward ")]}")
+ (unless (save-excursion (skip-chars-forward " \t") (eolp))
+ (insert "\n")
+ (indent-according-to-mode)))))
+ (while (progn (forward-comment (point-max))
+ (< (point) end))
+ (let ((beg (point))
+ ;; Whether we're in front of an element with paired delimiters.
+ ;; Can be something funky like #'(lambda ..) or ,'#s(...).
+ (paired (when (looking-at "['`,#]*[[:alpha:]]*\\([({[\"]\\)")
+ (match-beginning 1))))
+ ;; Go to the end of the sexp.
+ (goto-char (or (scan-sexps (or paired (point)) 1) end))
+ (unless
+ (and
+ ;; The sexp is all on a single line.
+ (save-excursion (not (search-backward "\n" beg t)))
+ ;; And its end is within `fill-column'.
+ (or (pp--within-fill-column-p)
+ ;; If the end of the sexp is beyond `fill-column',
+ ;; try to move the sexp to its own line.
+ (and
+ (save-excursion
+ (goto-char beg)
+ (if (save-excursion (skip-chars-backward " \t({[',")
+ (bolp))
+ ;; The sexp was already on its own line.
+ nil
+ (skip-chars-backward " \t")
+ (setq beg (copy-marker beg t))
+ (if paired (setq paired (copy-marker paired t)))
+ ;; We could try to undo this insertion if it
+ ;; doesn't reduce the indentation depth, but I'm
+ ;; not sure it's worth the trouble.
+ (insert "\n") (indent-according-to-mode)
+ t))
+ ;; Check again if we moved the whole exp to a new line.
+ (pp--within-fill-column-p))))
+ ;; The sexp is spread over several lines, and/or its end is
+ ;; (still) beyond `fill-column'.
+ (when (and paired (not (eq ?\" (char-after paired))))
+ ;; The sexp has sub-parts, so let's try and spread
+ ;; them over several lines.
+ (save-excursion
+ (goto-char beg)
+ (when (looking-at "(\\([^][()\" \t\n;']+\\)")
+ ;; Inside an expression of the form (SYM ARG1
+ ;; ARG2 ... ARGn) where SYM has a `lisp-indent-function'
+ ;; property that's a number, insert a newline after
+ ;; the corresponding ARGi, because it tends to lead to
+ ;; more natural and less indented code.
+ (let* ((sym (intern-soft (match-string 1)))
+ (lif (and sym (get sym 'lisp-indent-function))))
+ (if (eq lif 'defun) (setq lif 2))
+ (when (natnump lif)
+ (goto-char (match-end 0))
+ (forward-sexp lif)
+ (funcall newline)))))
+ (save-excursion
+ (pp-fill (1+ paired) (1- (point)))))
+ ;; Now the sexp either ends beyond `fill-column' or is
+ ;; spread over several lines (or both). Either way, the
+ ;; rest of the line should be moved to its own line.
+ (funcall newline)))))))
+
;;;###autoload
(defun pp-buffer ()
"Prettify the current buffer with printed representation of a Lisp object."
--
2.39.2
>From f55500ef4033c5919783f391c079b9e5ec61fc0c Mon Sep 17 00:00:00 2001
From: Stefan Monnier <monnier@iro.umontreal.ca>
Date: Fri, 16 Jun 2023 13:35:36 -0400
Subject: [PATCH 5/5] lispref/streams.texi: Document new PP functionality
* doc/lispref/streams.texi (Output Functions): Document new `pp`
calling convention.
(Output Variables): Document `pp-default-function`.
---
doc/lispref/streams.texi | 24 ++++++++++++++++++++----
etc/NEWS | 10 ++++++++++
2 files changed, 30 insertions(+), 4 deletions(-)
diff --git a/doc/lispref/streams.texi b/doc/lispref/streams.texi
index 89046a68249..2eb71b83f9c 100644
--- a/doc/lispref/streams.texi
+++ b/doc/lispref/streams.texi
@@ -755,10 +755,17 @@ Output Functions
@end defmac
@cindex pretty-printer
-@defun pp object &optional stream
-This function outputs @var{object} to @var{stream}, just like
-@code{prin1}, but does it in a prettier way. That is, it'll
-indent and fill the object to make it more readable for humans.
+@defun pp object-or-beg &optional stream-or-end
+This function indents and fills the printed representation of an
+object (typically representing ELisp code) to make it more readable
+for humans.
+
+It accepts two calling conventions: if called with two integers
+@var{beg} and @var{end}, it indents and fills the corresponding
+region, presumably containing the printed representation of one or
+more objects, otherwise it takes a @var{object} and an optional
+@var{stream}, and prints @var{object} like @code{prin1}, but does it
+in a prettier way.
@end defun
If you need to use binary I/O in batch mode, e.g., use the functions
@@ -981,6 +988,15 @@ Output Variables
having their own escape syntax such as newline.
@end defvar
+@defopt pp-default-function
+This user variable specifies the function used by @code{pp} to prettify
+its output. By default it uses @code{pp-fill} which attempts to
+strike a good balance between speed and generating natural looking output
+that fits within @code{fill-column}. The previous default was
+@code{pp-28}, which tends to be faster but generate output that looks
+less natural and is less compact.
+@end defopt
+
@node Output Overrides
@section Overriding Output Variables
@cindex overrides, in output functions
diff --git a/etc/NEWS b/etc/NEWS
index 61e6e161665..7aa387b3a5c 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -396,6 +396,16 @@ name as a string. The new function
'dictionary-completing-read-dictionary' can be used to prompt with
completion based on dictionaries that the server supports.
+** Pp
+*** New 'pp-default-function' custom variable replaces 'pp-use-max-width'.
+
+*** New default pretty printing function, which tries to obey 'fill-column'.
+
+*** 'pp' can be applied to a region rather than an object.
+As a consequence, 'pp-buffer' is now declared obsolete.
+
+*** 'pp-to-string' takes an additional 'pp-function' argument.
+This arg specifies the prettifying algorithm to use.
* New Modes and Packages in Emacs 30.1
--
2.39.2
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/02
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/03
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/03
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/03
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/12
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/13
- bug#63861: [PATCH] pp.el: New "pretty printing" code,
Stefan Monnier <=
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/17
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/17
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/17
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/17
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Visuwesh, 2023/06/03
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/07
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Visuwesh, 2023/06/08
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/09
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Ihor Radchenko, 2023/06/09
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/09