From: Tassilo Horn <tsdh@gnu.org>
To: emacs-devel@gnu.org
Subject: [RFC]: replace-region-contents
Date: Fri, 01 Feb 2019 22:20:37 +0100 [thread overview]
Message-ID: <871s4rqk7u.fsf@gnu.org> (raw)
Hi all,
on gnu-emacs-help I've asked why my wrapper command around
`json-pretty-print' doesn't restore point although it uses
`save-excursion'. The reason is that `json-pretty-print' replaces the
region with copy, delete, and insert. Robert and Eli pointed me to the
new `replace-buffer-contents' which allowed me to rewrite
`json-pretty-print' in a way where point stays where it has been before
pretty-printing:
--8<---------------cut here---------------start------------->8---
(defun json-pretty-print (begin end)
"Pretty-print selected region."
(interactive "r")
(save-excursion
(save-restriction
(narrow-to-region begin end)
(goto-char (point-min))
(atomic-change-group
(let ((json-encoding-pretty-print t)
;; Distinguish an empty objects from 'null'
(json-null :json-null)
;; Ensure that ordering is maintained
(json-object-type 'alist)
(obj (json-read))
(orig-buffer (current-buffer)))
(with-temp-buffer
(insert (json-encode obj))
(let ((tmp-buffer (current-buffer)))
(set-buffer orig-buffer)
(replace-buffer-contents tmp-buffer))))))))
--8<---------------cut here---------------end--------------->8---
I think that replacing a region by transforming its contents in some
arbitray way is some generally useful feature, so I'd propose to extract
that functionality into some new function `replace-region-contents' I'd
like to add to subr-x.el. Here it is and how it is applied in the
json-pretty-printing scenario.
--8<---------------cut here---------------start------------->8---
;; in subr-x.el (or wherever you please)
(defun replace-region-contents (beg end extract-fn inject-fn)
"Replace the region between BEG and END using EXTRACT-FN and INJECT-FN.
The current buffer is narrowed to the region between BEG and END,
then EXTRACT-FN is called in order to extract some value.
Thereafter, INJECT-FN is called with that value in a temporary
buffer which it should populate.
Finally, the region in the source buffer is replaced with the
contents of the temporary buffer prepared by INJECT-FN using
`replace-buffer-contents'."
(save-excursion
(save-restriction
(narrow-to-region beg end)
(goto-char (point-min))
(atomic-change-group
(let ((source-buffer (current-buffer))
(extracted (funcall extract-fn)))
(with-temp-buffer
(funcall inject-fn extracted)
(let ((tmp-buffer (current-buffer)))
(set-buffer source-buffer)
(replace-buffer-contents tmp-buffer))))))))
;; in json.el
(defun json-pretty-print (begin end)
"Pretty-print selected region."
(interactive "r")
(replace-region-contents
begin end
(lambda ()
(let ((json-null :json-null)
;; Ensure that ordering is maintained
(json-object-type 'alist))
(json-read)))
(lambda (json-obj)
(let ((json-encoding-pretty-print t)
;; Distinguish an empty objects from 'null'
(json-null :json-null))
(insert (json-encode json-obj))))))
--8<---------------cut here---------------end--------------->8---
Does that seem like a good idea, is there anything to improve, or should
I just fix `json-pretty-print' as in the first snippet?
Bye,
Tassilo
next reply other threads:[~2019-02-01 21:20 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-01 21:20 Tassilo Horn [this message]
2019-02-02 9:33 ` [RFC]: replace-region-contents Marcin Borkowski
2019-02-02 13:57 ` Tassilo Horn
2019-02-02 15:42 ` Stefan Monnier
2019-02-04 5:23 ` Tassilo Horn
2019-02-05 2:56 ` Stefan Monnier
2019-02-05 5:57 ` Tassilo Horn
2019-02-05 13:21 ` Tassilo Horn
2019-02-05 16:36 ` Eli Zaretskii
2019-02-05 17:19 ` Tassilo Horn
2019-02-06 16:00 ` Eli Zaretskii
2019-02-06 17:02 ` Tassilo Horn
2019-02-06 17:33 ` Eli Zaretskii
2019-02-06 18:07 ` Tassilo Horn
2019-02-08 16:23 ` Tassilo Horn
2019-02-08 16:28 ` Stefan Monnier
2019-02-08 17:17 ` Tassilo Horn
2019-02-08 21:37 ` Eli Zaretskii
2019-02-08 21:53 ` Stefan Monnier
2019-02-08 21:27 ` Eli Zaretskii
2019-02-08 22:03 ` Tassilo Horn
2019-02-08 22:19 ` Eli Zaretskii
2019-02-09 0:00 ` Tassilo Horn
2019-02-09 8:26 ` Eli Zaretskii
2019-02-09 8:52 ` Tassilo Horn
2019-02-05 13:43 ` Stefan Monnier
2019-02-06 8:07 ` Tassilo Horn
2019-02-06 9:55 ` Marcin Borkowski
2019-02-06 11:10 ` Tassilo Horn
2019-02-06 14:09 ` Stefan Monnier
2019-02-05 16:11 ` Eli Zaretskii
2019-02-02 16:17 ` Stefan Monnier
2019-02-03 15:59 ` Eli Zaretskii
2019-02-03 17:05 ` Stefan Monnier
2019-02-03 17:18 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=871s4rqk7u.fsf@gnu.org \
--to=tsdh@gnu.org \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).