[Git][cmucl/cmucl][issue-169-pprint-define-vop] Add some comments and do some cosmetic changes.

[Raymond Toy (@rtoy)]

Raymond Toy pushed to branch issue-169-pprint-define-vop at cmucl / cmucl


Commits:
c387104a by Raymond Toy at 2023-02-28T06:20:33-08:00
Add some comments and do some cosmetic changes.

Add some comments so we know what we're trying to do.

Don't need the `kernel:` package for `output-object`, so remove it.
And indent the code neatly.

- - - - -


1 changed file:

- src/code/pprint.lisp


Changes:

=====================================
src/code/pprint.lisp
=====================================
@@ -1841,49 +1841,54 @@ When annotations are present, invoke them at the right positions."
   (declare (ignore noise))
   (pprint-logical-block (stream list :prefix "(" :suffix ")")
     ;; Output "define-vop"
-    (kernel:output-object (pprint-pop) stream)
+    (output-object (pprint-pop) stream)
     (pprint-exit-if-list-exhausted)
     (write-char #\space stream)
     ;; Output vop name
-    (kernel:output-object (pprint-pop) stream)
+    (output-object (pprint-pop) stream)
     (pprint-exit-if-list-exhausted)
     (pprint-newline :mandatory stream)
     (pprint-indent :block 0 stream)
-    ;; Print out each option
+    ;; Print out each option starting on a new line
     (loop
       (write-char #\space stream)
       (let ((vop-option (pprint-pop)))
-	  (case (car vop-option)
-	    ((:args :results)
-	     (pprint-logical-block (stream vop-option :prefix "(" :suffix ")")
-	       ;; Output :args
-	       (kernel:output-object (pprint-pop) stream)
-	       (pprint-exit-if-list-exhausted)
-	       (write-char #\space stream)
-	       (pprint-indent :current 0 stream)
-	       (loop
-		 (kernel:output-object (pprint-pop) stream)
-		 (pprint-exit-if-list-exhausted)
-		 (pprint-newline :mandatory stream))))
-	    ((:generator)
-	     (pprint-logical-block (stream vop-option :prefix "(" :suffix ")")
-	       ;; Output :generator
-	       (kernel:output-object (pprint-pop) stream)
+	;; Figure out what option we have and print it neatly
+	(case (car vop-option)
+	  ((:args :results)
+	   ;; :args and :results print out each arg/result indented neatly
+	   (pprint-logical-block (stream vop-option :prefix "(" :suffix ")")
+	     ;; Output :args/:results
+	     (output-object (pprint-pop) stream)
+	     (pprint-exit-if-list-exhausted)
+	     (write-char #\space stream)
+	     (pprint-indent :current 0 stream)
+	     ;; Print each value indented the same amount so the line
+	     ;; up neatly.
+	     (loop
+	       (output-object (pprint-pop) stream)
 	       (pprint-exit-if-list-exhausted)
-	       (write-char #\space stream)
-	       ;; Output cost
-	       (kernel:output-object (pprint-pop) stream)
+	       (pprint-newline :mandatory stream))))
+	  ((:generator)
+	   (pprint-logical-block (stream vop-option :prefix "(" :suffix ")")
+	     ;; Output :generator
+	     (output-object (pprint-pop) stream)
+	     (pprint-exit-if-list-exhausted)
+	     (write-char #\space stream)
+	     ;; Output cost
+	     (output-object (pprint-pop) stream)
+	     (pprint-exit-if-list-exhausted)
+	     ;; Newline and then the body of the generator
+	     (pprint-newline :mandatory stream)
+	     (write-char #\space stream)
+	     (pprint-indent :current 0 stream)
+	     (loop
+	       (output-object (pprint-pop) stream)
 	       (pprint-exit-if-list-exhausted)
-	       ;; Newline and then the body of the generator
-	       (pprint-newline :mandatory stream)
-	       (write-char #\space stream)
-	       (pprint-indent :current 0 stream)
-	       (loop
-		 (kernel:output-object (pprint-pop) stream)
-		 (pprint-exit-if-list-exhausted)
-		 (pprint-newline :mandatory stream))))
-	    (t
-	     (kernel:output-object vop-option stream))))
+	       (pprint-newline :mandatory stream))))
+	  (t
+	   ;; Everything else just get printed as usual.
+	   (output-object vop-option stream))))
       (pprint-exit-if-list-exhausted)
       (pprint-newline :linear stream))))
 
@@ -1891,26 +1896,26 @@ When annotations are present, invoke them at the right positions."
   (declare (ignore noise))
   (pprint-logical-block (stream list :prefix "(" :suffix ")")
     ;; Output "sc-case"
-    (kernel:output-object (pprint-pop) stream)
+    (output-object (pprint-pop) stream)
     (pprint-exit-if-list-exhausted)
     (write-char #\space stream)
-    ;; Output variable
-    (kernel:output-object (pprint-pop) stream)
+    ;; Output variable name
+    (output-object (pprint-pop) stream)
     (pprint-exit-if-list-exhausted)
+    ;; Start the cases on a new line, indented.
     (pprint-newline :mandatory stream)
-    ;; Indent for the cases
     (pprint-indent :block 0 stream)
     ;; Print out each case.
     (loop
       (write-char #\space stream)
       (pprint-logical-block (stream (pprint-pop) :prefix "(" :suffix ")")
 	;; Output the case item
-	(kernel:output-object (pprint-pop) stream)
+	(output-object (pprint-pop) stream)
 	(pprint-exit-if-list-exhausted)
 	(pprint-newline :mandatory stream)
-	;; Output everything else
+	;; Output everything else, starting on a new line.
 	(loop
-	  (kernel:output-object (pprint-pop) stream)
+	  (output-object (pprint-pop) stream)
 	  (pprint-exit-if-list-exhausted)
 	  (pprint-newline :mandatory stream)))
       (pprint-exit-if-list-exhausted)



View it on GitLab: https://gitlab.common-lisp.net/cmucl/cmucl/-/commit/c387104a2aac3db2967a96d752c991224ae5eb0d

-- 
View it on GitLab: https://gitlab.common-lisp.net/cmucl/cmucl/-/commit/c387104a2aac3db2967a96d752c991224ae5eb0d
You're receiving this email because of your account on gitlab.common-lisp.net.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mailman.common-lisp.net/pipermail/cmucl-cvs/attachments/20230228/e1bcb60c/attachment-0001.html>