aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2022-01-02 18:14:00 +0100
committerLudovic Courtès <ludo@gnu.org>2022-01-10 14:59:26 +0100
commit5d9a5e230189347ba6f5b78a3d74b36a867aa9e6 (patch)
tree68360d1d116fa767274eae10043a5dd41a505293
parentc4fe13c294cc1e31dd8a49ce3981f603fb169e0a (diff)
downloadguix-5d9a5e230189347ba6f5b78a3d74b36a867aa9e6.tar
guix-5d9a5e230189347ba6f5b78a3d74b36a867aa9e6.tar.gz
style: '-S format' canonicalizes comments.
* 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.
-rw-r--r--guix/scripts/style.scm39
-rw-r--r--tests/style.scm25
2 files changed, 56 insertions, 8 deletions
diff --git a/guix/scripts/style.scm b/guix/scripts/style.scm
index 85e66fe1a6..fb31c694f2 100644
--- a/guix/scripts/style.scm
+++ b/guix/scripts/style.scm
@@ -47,6 +47,7 @@
#:use-module (srfi srfi-37)
#:export (pretty-print-with-comments
read-with-comments
+ canonicalize-comment
guix-style))
@@ -227,8 +228,23 @@ particular newlines, is left as is."
"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))
@@ -236,7 +252,9 @@ particular newlines, is left as is."
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
@@ -301,14 +319,16 @@ Lists longer than LONG-LIST are written as one element per line."
(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)
@@ -443,11 +463,12 @@ Lists longer than LONG-LIST are written as one element per line."
(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))))
;;;
@@ -701,13 +722,15 @@ PACKAGE."
(package-full-name package)))
(edit-expression
- (location->source-properties (package-definition-location package))
+ (location->source-properties
+ (absolute-location (package-definition-location package)))
(lambda (str)
(let ((exp (call-with-input-string str
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."
diff --git a/tests/style.scm b/tests/style.scm
index 7dae543860..8c6d37a661 100644
--- a/tests/style.scm
+++ b/tests/style.scm
@@ -485,6 +485,31 @@ mnopqrstuvwxyz.\")"
'(#: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: