From: Ryan Crum <ryan.crum@eleostech.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, 17 Nov 2012 12:37:17 -0500 [thread overview]
Message-ID: <9E9C89A9-FACE-47A9-BCC7-3AC5ABC64518@gmail.com> (raw)
In-Reply-To: <jwvtxsry70o.fsf-monnier+emacs@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 186 bytes --]
Hi Stefan,
I actually have not yet received anything regarding copyright assignment in the mail, so I resubmitted the questionnaire to assign@gnu.org today.
New patch attached.
[-- Attachment #2: json-pretty-print.diff --]
[-- Type: application/octet-stream, Size: 8756 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,122 ----
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-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 "\n"
+ "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
+ "If non-nil, then the output of `json-encode' will be pretty-printed.")
+
+ (defvar json-encoding-lisp-style-closings nil
+ "If non-nil, ] and } closings will be formatted lisp-style, without indentation.")
+
\f
;;; Utilities
***************
*** 124,129 **** this around your call to `json-read' instead of `setq'ing it.")
--- 142,155 ----
'not-plist)))
(null list))
+ (defmacro json--with-indentation (body)
+ `(let ((json--encoding-current-indentation
+ (if json-encoding-pretty-print
+ (concat json--encoding-current-indentation
+ json-encoding-default-indentation)
+ "")))
+ ,body))
+
;; Reader utilities
(defsubst json-advance (&optional n)
***************
*** 402,442 **** Please see the documentation of `json-object-type' and `json-key-type'."
(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-key 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-key (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-key (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.
--- 428,497 ----
(defun json-encode-hash-table (hash-table)
"Return a JSON representation of HASH-TABLE."
! (format "{%s%s}"
(json-join
(let (r)
! (json--with-indentation
! (maphash
! (lambda (k v)
! (push (format
! (if json-encoding-pretty-print
! "%s%s: %s"
! "%s%s:%s")
! json--encoding-current-indentation
! (json-encode-key k)
! (json-encode v))
! r))
! hash-table))
r)
! json-encoding-separator)
! (if (or (not json-encoding-pretty-print)
! json-encoding-lisp-style-closings)
! ""
! json--encoding-current-indentation)))
;; List encoding (including alists and plists)
(defun json-encode-alist (alist)
"Return a JSON representation of ALIST."
! (format "{%s%s}"
! (json-join
! (json--with-indentation
! (mapcar (lambda (cons)
! (format (if json-encoding-pretty-print
! "%s%s: %s"
! "%s%s:%s")
! json--encoding-current-indentation
! (json-encode-key (car cons))
! (json-encode (cdr cons))))
! alist))
! json-encoding-separator)
! (if (or (not json-encoding-pretty-print)
! json-encoding-lisp-style-closings)
! ""
! json--encoding-current-indentation)))
(defun json-encode-plist (plist)
"Return a JSON representation of PLIST."
(let (result)
! (json--with-indentation
! (while plist
! (push (concat
! json--encoding-current-indentation
! (json-encode-key (car plist))
! (if json-encoding-pretty-print
! ": "
! ":")
! (json-encode (cadr plist)))
! result)
! (setq plist (cddr plist))))
! (concat "{"
! (json-join (nreverse result) json-encoding-separator)
! (if (and json-encoding-pretty-print
! (not json-encoding-lisp-style-closings))
! json--encoding-current-indentation
! "")
! "}")))
(defun json-encode-list (list)
"Return a JSON representation of LIST.
***************
*** 475,481 **** become JSON objects."
(defun json-encode-array (array)
"Return a JSON representation of ARRAY."
! (concat "[" (mapconcat 'json-encode array ", ") "]"))
\f
--- 530,551 ----
(defun json-encode-array (array)
"Return a JSON representation of ARRAY."
! (if (and json-encoding-pretty-print
! (> (length array) 0))
! (concat
! (json--with-indentation
! (concat (format "[%s" json--encoding-current-indentation)
! (json-join (mapcar 'json-encode array)
! (format "%s%s"
! json-encoding-separator
! json--encoding-current-indentation))))
! (format "%s]"
! (if json-encoding-lisp-style-closings
! ""
! json--encoding-current-indentation)))
! (concat "["
! (mapconcat 'json-encode array json-encoding-separator)
! "]")))
\f
***************
*** 542,547 **** Advances point just past JSON object."
--- 612,644 ----
((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)
+ (condition-case-unless-debug err
+ (insert (json-encode (json-read-from-string (current-kill 0))))
+ (error
+ (insert (current-kill 0))
+ (error "Unable to parse JSON.")))))
+
(provide 'json)
;;; json.el ends here
[-- Attachment #3: Type: text/plain, Size: 1815 bytes --]
On Nov 14, 2012, at 8:56 PM, Stefan Monnier wrote:
> Use a "json--" prefix, since it's a convention we use to express that
> something is internal.
Fixed.
> The first line of a docstring should "stand on it own", i.e. it
> shouldn't end in the middle of a sentence.
> Try C-u M-x checkdoc-current-buffer.
Ah, cool feature. Fixed.
>
>> (defun json-encode-hash-table (hash-table)
>> "Return a JSON representation of HASH-TABLE."
>> - (format "{%s}"
>> + (format (if json-encoding-pretty-print "{%s%s}" "{%s}")
>
> Hmm... if json-encoding-pretty-print is nil, we still pass 2 args, and
> the second is always "", so we can always use "{%s%s}", right?
Not exactly, since json--encoding-current-indentation defaults to newline. I've tweaked this part to shift the complexity down into the second clause, however, instead of specifying 2 formats with a potentially unused second argument.
>> - (concat "[" (mapconcat 'json-encode 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)))
>
> Use json--with-indentation here (even if it performs an extra redundant
> test of json-encoding-pretty-print).
Agreed, fixed.
I've also added an error handling clause to fix a bug I noticed where if you attempt to `json-pretty-print' some invalid JSON your text gets killed but formatting fails and it doesn't get replaced. Is there a more idiomatic way of doing this? I considered using copy-region-as-kill and then only killing the text if the call to json-encode succeeds, but that seemed more awkward.
Thanks for your help!
-Ryan
next prev parent reply other threads:[~2012-11-17 17:37 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
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 [this message]
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=9E9C89A9-FACE-47A9-BCC7-3AC5ABC64518@gmail.com \
--to=ryan.crum@eleostech.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.