ryan77627/guix
1
0
Fork 0
mirror of https://git.in.rschanz.org/ryan77627/guix.git synced 2024-12-24 05:18:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

read-print: 'canonicalize-comment' leaves top-level comments unchanged.

Browse source 
This lets users use three leading semicolons, for instance, in top-level
comments.

* guix/read-print.scm (canonicalize-comment): Add INDENT parameter and
honor it.
(pretty-print-with-comments): Change default value of #:format-comment.
Call FORMAT-COMMENT with INDENT as the second argument.
* tests/read-print.scm: Adjust test accordingly.
This commit is contained in:
Ludovic Courtès 2022-08-02 17:39:55 +02:00
parent 9b00c97de4
commit 90ef692e9b
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5
2 changed files with 22 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
guix/read-print.scm
View file

@ -371,23 +371,26 @@ (define (string-width str)
"Return the \"width\" of STR--i.e., the width of the longest line of STR."
(apply max (map string-length (string-split str #\newline))))
(define (canonicalize-comment c)
"Canonicalize comment C, ensuring it has the \"right\" number of leading
semicolons."
(let ((line (string-trim-both
(string-trim (comment->string c) (char-set #\;)))))
(string->comment (string-append
(if (comment-margin? c)
";"
(if (string-null? line)
";;" ;no trailing space
";; "))
line "\n")
(comment-margin? c))))
(define (canonicalize-comment comment indent)
"Canonicalize COMMENT, which is to be printed at INDENT, ensuring it has the
\"right\" number of leading semicolons."
(if (zero? indent)
comment ;leave top-level comments unchanged
(let ((line (string-trim-both
(string-trim (comment->string comment) (char-set #\;)))))
(string->comment (string-append
(if (comment-margin? comment)
";"
(if (string-null? line)
";;" ;no trailing space
";; "))
line "\n")
(comment-margin? comment)))))
(define* (pretty-print-with-comments port obj
#:key
(format-comment identity)
(format-comment
(lambda (comment indent) comment))
(format-vertical-space identity)
(indent 0)
(max-width 78)
@ -475,7 +478,7 @@ (define (special-form? head)
(if (comment-margin? comment)
(begin
(display " " port)
(display (comment->string (format-comment comment))
(display (comment->string (format-comment comment indent))
port))
(begin
;; When already at the beginning of a line, for example because
@ -483,7 +486,7 @@ (define (special-form? head)
(unless (= column indent)
(newline port)
(display (make-string indent #\space) port))
(display (comment->string (format-comment comment))
(display (comment->string (format-comment comment indent))
port)))
(display (make-string indent #\space) port)
indent)

4
tests/read-print.scm
View file

@ -274,6 +274,7 @@ (define-syntax-rule (test-pretty-print/sequence str args ...)
(test-pretty-print/sequence "
;;; Hello!
;;; Notice that there are three semicolons here.
(define-module (foo bar)
#:use-module (guix)
@ -286,7 +287,8 @@ (define-module (foo bar)
(locale \"eo_EO.UTF-8\")
(services
(cons (service mcron-service-type) %base-services)))\n")
(cons (service mcron-service-type) %base-services)))\n"
#:format-comment canonicalize-comment)
(test-equal "pretty-print-with-comments, canonicalize-comment"
"\