@@ -47,6 +47,7 @@ (define-module (guix scripts style)
#:use-module (srfi srfi-37)
#:export (pretty-print-with-comments
read-with-comments
+ canonicalize-comment
guix-style))
@@ -226,8 +227,23 @@ (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 #\;)))))
+ (comment (string-append
+ (if (comment-margin? c)
+ ";"
+ (if (string-null? line)
+ ";;" ;no trailing space
+ ";; "))
+ line "\n")
+ (comment-margin? c))))
+
(define* (pretty-print-with-comments port obj
#:key
+ (format-comment identity)
(indent 0)
(max-width 78)
(long-list 5))
@@ -235,7 +251,9 @@ (define* (pretty-print-with-comments port obj
and assuming the current column is INDENT. Comments present in OBJ are
included in the output.
-Lists longer than LONG-LIST are written as one element per line."
+Lists longer than LONG-LIST are written as one element per line. Comments are
+passed through FORMAT-COMMENT before being emitted; a useful value for
+FORMAT-COMMENT is 'canonicalize-comment'."
(let loop ((indent indent)
(column indent)
(delimited? #t) ;true if comes after a delimiter
@@ -300,14 +318,16 @@ (define (special-form? head)
(if (comment-margin? comment)
(begin
(display " " port)
- (display (comment->string comment) port))
+ (display (comment->string (format-comment comment))
+ port))
(begin
;; When already at the beginning of a line, for example because
;; COMMENT follows a margin comment, no need to emit a newline.
(unless (= column indent)
(newline port)
(display (make-string indent #\space) port))
- (display (comment->string comment) port)))
+ (display (comment->string (format-comment comment))
+ port)))
(display (make-string indent #\space) port)
indent)
(('quote lst)
@@ -442,11 +462,12 @@ (define new-column
(display str port)
(+ column (if delimited? 0 1) len))))))))
-(define (object->string* obj indent)
+(define (object->string* obj indent . args)
(call-with-output-string
(lambda (port)
- (pretty-print-with-comments port obj
- #:indent indent))))
+ (apply pretty-print-with-comments port obj
+ #:indent indent
+ args))))
;;;
@@ -706,7 +727,8 @@ (define* (format-package-definition package
read-with-comments)))
(object->string* exp
(location-column
- (package-definition-location package)))))))
+ (package-definition-location package))
+ #:format-comment canonicalize-comment)))))
(define (package-location<? p1 p2)
"Return true if P1's location is \"before\" P2's."
@@ -485,6 +485,31 @@ (define file
'(#:phases %standard-phases
#:tests? #f)))")
+(test-equal "pretty-print-with-comments, canonicalize-comment"
+ "\
+(list abc
+ ;; Not a margin comment.
+ ;; Ditto.
+ ;;
+ ;; There's a blank line above.
+ def ;margin comment
+ ghi)"
+ (let ((sexp (call-with-input-string
+ "\
+(list abc
+ ;Not a margin comment.
+ ;;; Ditto.
+ ;;;;;
+ ; There's a blank line above.
+ def ;; margin comment
+ ghi)"
+ read-with-comments)))
+ (call-with-output-string
+ (lambda (port)
+ (pretty-print-with-comments port sexp
+ #:format-comment
+ canonicalize-comment)))))
+
(test-end)
;; Local Variables:
* guix/scripts/style.scm (canonicalize-comment): New procedure. (pretty-print-with-comments): Add #:format-comment. and honor it. (object->string*): Add 'args' and honor them. (format-package-definition): Pass #:format-comment to 'object->string*'. * tests/style.scm ("pretty-print-with-comments, canonicalize-comment"): New test. --- guix/scripts/style.scm | 36 +++++++++++++++++++++++++++++------- tests/style.scm | 25 +++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 7 deletions(-)