From: Ryan Crum <ryan.j.crum@gmail.com>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 12634@debbugs.gnu.org
Subject: bug#12634: Patch for pretty-printing in json.el
Date: Sat, 27 Oct 2012 15:31:46 -0400 [thread overview]
Message-ID: <CAMiu-qBKbohFN0KALZMUERxMD2ROr651gG8FSj2u=NSR=TC-PQ@mail.gmail.com> (raw)
In-Reply-To: <jwvzk3a8mv0.fsf-monnier+emacs@gnu.org>
[-- Attachment #1.1: Type: text/plain, Size: 1064 bytes --]
Cool, new patch attached. I've consolidated current-separator into
current-indentation and created a little private helper function
`json--current-whitespace' for the newline/indentation.
I've also created a var called `json-encoding-lisp-style-closings' per your
request. :-)
Just let me know if there's anything else.
Thanks,
-Ryan
On Thu, Oct 25, 2012 at 2:08 PM, Stefan Monnier <monnier@iro.umontreal.ca>wrote:
> It looks OK overall, but I do have some comments:
> - it would be better not to re-compute json-encoding-current-separator
> every time we call json-encode, since that function is called all
> the time.
> IOW, build it once in an external caller. Or better yet: get rid of
> json-encoding-current-separator and add a "\n" at the beginning of
> json-encoding-current-indentation instead.
> - you can use the "json--" prefix to indicate it is an internal
> variable/function.
> - You could also prefer to place the closing ] at the end of the
> previous line, à la Lisp ;-)
>
>
> Stefan
>
[-- Attachment #1.2: Type: text/html, Size: 1465 bytes --]
[-- Attachment #2: json-pretty-printing --]
[-- Type: application/octet-stream, Size: 8853 bytes --]
*** a/json.el
--- b/json.el
***************
*** 3,9 ****
;; Copyright (C) 2006-2012 Free Software Foundation, Inc.
;; Author: Edward O'Connor <ted@oconnor.cx>
! ;; Version: 1.3
;; Keywords: convenience
;; This file is part of GNU Emacs.
--- 3,9 ----
;; Copyright (C) 2006-2012 Free Software Foundation, Inc.
;; Author: Edward O'Connor <ted@oconnor.cx>
! ;; Version: 1.4
;; Keywords: convenience
;; This file is part of GNU Emacs.
***************
*** 48,53 ****
--- 48,54 ----
;; 2006-12-29 - XEmacs support, from Aidan Kehoe <kehoea@parhasard.net>.
;; 2008-02-21 - Installed in GNU Emacs.
;; 2011-10-17 - Patch `json-alist-p' and `json-plist-p' to avoid recursion -tzz
+ ;; 2012-10-25 - Added pretty-printed reformatting -Ryan Crum (ryan@ryancrum.org)
;;; Code:
***************
*** 99,104 **** If this has the same value as `json-false', you might not be able to
--- 100,124 ----
tell the difference between `false' and `null'. Consider let-binding
this around your call to `json-read' instead of `setq'ing it.")
+ (defvar json-encoding-default-separator ", "
+ "Value to use as an element seperator when encoding.")
+
+ (defvar json-encoding-default-indentation " "
+ "The default indentation level for encoding. Used only when
+ `json-encoding-pretty-print' is non-nil.")
+
+ (defvar json-encoding-current-indentation ""
+ "Internally used to keep track of the current indentation level of
+ encoding. Used only when `json-encoding-pretty-print' is non-nil.")
+
+ (defvar json-encoding-pretty-print nil
+ "Setting this to non-nil will result in the output of `json-encode'
+ to be pretty-printed.")
+
+ (defvar json-encoding-lisp-style-closings nil
+ "Setting this to `t' will cause ] and } closings to happen lisp-style,
+ without indentation.")
+
\f
;;; Utilities
***************
*** 387,429 **** Please see the documentation of `json-object-type' and `json-key-type'."
;; Hash table encoding
(defun json-encode-hash-table (hash-table)
"Return a JSON representation of HASH-TABLE."
! (format "{%s}"
(json-join
(let (r)
! (maphash
! (lambda (k v)
! (push (format "%s:%s"
! (json-encode k)
! (json-encode v))
! r))
! hash-table)
r)
! ", ")))
;; List encoding (including alists and plists)
(defun json-encode-alist (alist)
"Return a JSON representation of ALIST."
! (format "{%s}"
! (json-join (mapcar (lambda (cons)
! (format "%s:%s"
! (json-encode (car cons))
! (json-encode (cdr cons))))
! alist)
! ", ")))
(defun json-encode-plist (plist)
"Return a JSON representation of PLIST."
(let (result)
(while plist
! (push (concat (json-encode (car plist))
! ":"
! (json-encode (cadr plist)))
! result)
(setq plist (cddr plist)))
! (concat "{" (json-join (nreverse result) ", ") "}")))
(defun json-encode-list (list)
"Return a JSON representation of LIST.
--- 407,493 ----
;; Hash table encoding
+ (defun json--current-whitespace ()
+ (if json-encoding-pretty-print
+ (concat "\n" json-encoding-current-indentation)
+ ""))
+
(defun json-encode-hash-table (hash-table)
"Return a JSON representation of HASH-TABLE."
! (format (if json-encoding-pretty-print "{%s%s}" "{%s}")
(json-join
(let (r)
! (let ((json-encoding-current-indentation
! (if json-encoding-pretty-print
! (concat json-encoding-current-indentation
! json-encoding-default-indentation)
! "")))
! (maphash
! (lambda (k v)
! (push (format
! (if json-encoding-pretty-print
! "%s%s: %s"
! "%s%s:%s")
! (json--current-whitespace)
! (json-encode k)
! (json-encode v))
! r))
! hash-table))
r)
! json-encoding-default-separator)
! (if json-encoding-lisp-style-closings
! ""
! (json--current-whitespace))))
;; List encoding (including alists and plists)
(defun json-encode-alist (alist)
"Return a JSON representation of ALIST."
! (format (if json-encoding-pretty-print "{%s%s}" "{%s}")
! (json-join
! (let ((json-encoding-current-indentation
! (if json-encoding-pretty-print
! (concat json-encoding-current-indentation
! json-encoding-default-indentation)
! "")))
! (mapcar (lambda (cons)
! (format (if json-encoding-pretty-print
! "%s%s: %s"
! "%s%s:%s")
! (json--current-whitespace)
! (json-encode (car cons))
! (json-encode (cdr cons))))
! alist))
! json-encoding-default-separator)
! (if json-encoding-lisp-style-closings
! ""
! (json--current-whitespace))))
(defun json-encode-plist (plist)
"Return a JSON representation of PLIST."
(let (result)
(while plist
! (let ((json-encoding-current-indentation
! (if json-encoding-pretty-print
! (concat json-encoding-current-indentation
! json-encoding-default-indentation)
! "")))
! (push (concat
! (json-encoding-current-indentation)
! (json-encode (car plist))
! (if json-encoding-pretty-print
! ": "
! ":")
! (json-encode (cadr plist)))
! result))
(setq plist (cddr plist)))
! (concat "{"
! (json-join (nreverse result) json-encoding-default-separator)
! (if (and json-encoding-pretty-print
! (not json-encoding-lisp-style-closings))
! (format "%s" (json--current-whitespace))
! "")
! "}")))
(defun json-encode-list (list)
"Return a JSON representation of LIST.
***************
*** 462,468 **** become JSON objects."
(defun json-encode-array (array)
"Return a JSON representation of ARRAY."
! (concat "[" (mapconcat 'json-encode array ", ") "]"))
\f
--- 526,549 ----
(defun json-encode-array (array)
"Return a JSON representation of ARRAY."
! (if (and json-encoding-pretty-print
! (> (length array) 0))
! (concat
! (let ((json-encoding-current-indentation
! (concat json-encoding-current-indentation
! json-encoding-default-indentation)))
! (concat (format "[%s" (json--current-whitespace))
! (json-join (mapcar 'json-encode array)
! (format "%s%s"
! json-encoding-default-separator
! (json--current-whitespace)))))
! (format "%s]"
! (if json-encoding-lisp-style-closings
! ""
! (json--current-whitespace))))
! (concat "["
! (mapconcat 'json-encode array json-encoding-default-separator)
! "]")))
\f
***************
*** 529,534 **** Advances point just past JSON object."
--- 610,638 ----
((listp object) (json-encode-list object))
(t (signal 'json-error (list object)))))
+ ;; Pretty printing
+
+ (defun json-pretty-print-buffer ()
+ "Pretty-print current buffer."
+ (interactive)
+ (let* ((json-encoding-pretty-print t)
+ (json-string (json-encode (json-read-from-string (buffer-string))))
+ (buf (current-buffer)))
+ (with-current-buffer buf
+ (erase-buffer)
+ (insert json-string))))
+
+ (defun json-pretty-print ()
+ "Pretty-print selected region."
+ (interactive)
+ (unless mark-active
+ (error "No region selected."))
+ (let ((begin (region-beginning))
+ (end (region-end))
+ (json-encoding-pretty-print t))
+ (kill-region begin end)
+ (insert (json-encode (json-read-from-string (current-kill 0))))))
+
(provide 'json)
;;; json.el ends here
next prev parent reply other threads:[~2012-10-27 19:31 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-10-13 8:39 bug#12634: 24.2; [FEATURE REQUEST] JSON pretty printer Leo
2012-10-13 21:56 ` Stefan Monnier
2012-10-18 21:18 ` bug#12634: existing implementation Aurélien Aptel
2012-10-19 1:37 ` Stefan Monnier
2012-10-19 16:20 ` Aurélien Aptel
2012-10-19 18:04 ` Stefan Monnier
2012-10-19 21:28 ` Stefan Monnier
2012-10-25 14:55 ` bug#12634: Patch for pretty-printing in json.el Ryan Crum
2012-10-25 18:08 ` Stefan Monnier
2012-10-27 19:31 ` Ryan Crum [this message]
2012-10-30 20:03 ` Stefan Monnier
2012-10-30 21:04 ` Ryan Crum
2012-11-15 1:56 ` Stefan Monnier
2012-11-17 17:37 ` Ryan Crum
2012-11-20 18:52 ` Stefan Monnier
2012-11-27 23:15 ` Ryan Crum
2012-12-14 2:56 ` bug#12634: Patch Ryan Crum
2012-12-14 14:59 ` Stefan Monnier
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAMiu-qBKbohFN0KALZMUERxMD2ROr651gG8FSj2u=NSR=TC-PQ@mail.gmail.com' \
--to=ryan.j.crum@gmail.com \
--cc=12634@debbugs.gnu.org \
--cc=monnier@iro.umontreal.ca \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.