1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
|
;; Copyright (c) 2013-2025 by Greg Hendershott.
;; SPDX-License-Identifier: GPL-3.0-or-later
#lang at-exp racket/base
(require (only-in racket/list
add-between
append*
argmin
cartesian-product
remove-duplicates)
racket/match
(only-in racket/path
simple-form-path)
syntax/parse/pre
(only-in syntax/stx
stx-map)
(only-in "../syntax.rkt"
file->syntax)
(only-in "../util.rkt"
safe-dynamic-require))
(provide requires/tidy
requires/trim
requires/base)
(module+ test
(require rackunit
racket/format
version/utils))
(define (requires/tidy path-str)
(tidy-file path-str))
(define (requires/trim path-str)
(tidy-file path-str
#:drops (drops (analyze path-str))))
(define (requires/base path-str)
(define a (analyze path-str))
(tidy-file path-str
#:adds (adds/racket->racket/base a)
#:drops (drops a)))
(module+ test
(let ([p (path->string
(simple-form-path
(build-path 'up 'up "test" "example" "requires.rkt")))])
(check-equal?
(requires/tidy p)
'((delete 174 17)
(replace
129
44
"(require net/url\n (combine-in net/url\n racket/format))")
(replace 39 42 "(require net/uri-codec\n net/url)")))
(cond
[(not show-requires)
(displayln "Skipping requires analysis tests (macro-debugger-text-lib seemingly not installed).")]
;; On older Rackets macro-debugger/analysis/check-requires might
;; give error:
;; derivation-parser: error on token #2: <local-value, #<syntax:/usr/share/racket/collects/syntax/parse/private/lib.rkt:63:55 -string>>
[(version<? (version) "8.14")
(displayln "Skipping requires analysis tests (Racket < 8.14).")]
[else
(check-equal?
(requires/trim p)
'((delete 174 17)
(replace
129
44
"(require net/url\n (combine-in net/url\n racket/format))")
(replace 39 42 "(require net/uri-codec\n net/url)")))
(check-equal?
(requires/base p)
'((delete 174 17)
(replace
129
44
"(require (for-syntax racket/base)\n net/url\n (combine-in net/url\n racket/format)\n racket/list\n racket/match)")
(replace 39 42 "(require net/uri-codec\n net/url)")))])))
;;; analysis by macro-debugger/analysis/check-requires
(define show-requires
(safe-dynamic-require 'macro-debugger/analysis/check-requires
'show-requires
(λ () #f)))
(define (analyze path-str)
(unless show-requires
(error 'analyze-requires
"Cannot work until you `raco pkg install macro-debugger-text-lib`"))
(define-values (base name _) (split-path (string->path path-str)))
(parameterize ([current-load-relative-directory base]
[current-directory base])
(show-requires name)))
(define (drops analyses)
(for*/list ([a (in-list analyses)]
[v (in-value
(match a
[(list 'drop mod level) (cons mod level)]
[_ #f]))]
#:when v)
v))
;; Use `bypass` directives to indicate what explicit requires must be
;; added when changing #lang from racket to racket/base.
;;
;; Note: Because `show-requires` seems to miss the need to (require
;; (for-syntax racket/base)), we're making the choice to always add
;; that, even when the specific user program doesn't need it.
(define (adds/racket->racket/base analyses)
(for*/list ([a (in-list analyses)]
[replacements (in-value
(match a
[(list 'bypass 'racket _level rs)
(cons '(racket/base 1 #f)
rs)]
[_ null]))]
[replacement (in-list replacements)]
[v (in-value
(match replacement
;; Don't need racket/base when that will be the
;; #lang, so ignore.
[(list 'racket/base 0 _) #f]
;; We're ignoring the "rename" field because it's
;; N/A for our specfic scenario, changing racket
;; to racket/base.
[(list mod level _) (cons mod level)]))]
#:when v)
v))
;;; tidy-module
(define current-phase-level (make-parameter 0))
(define current-drops (make-parameter null)) ; (listof (cons mod level))
;; The `sortable` (names are hard) struct represents the syntax for a
;; require-spec, along with information about how to sort it.
;;
;; The `group` is a number, used to order things like absolute path
;; symbols above relative path strings.
;;
;; The `key` is a symbol or string, used to sort alphabetically within
;; each group.
;;
;; The sortable-group+key function produces a string comprising both,
;; suitable to give to `sort` as the #:key, with of course `string<?`
;; as the less-than arg.
;;
;; The simplest require-spec is a root-module-path like racket/string
;; or "foo.rkt".
;;
;; Some require-specs contain multiple module paths, for example
;; combine-in. When we parse these, we produce a `sortable` from the
;; component require-specs; see `copy` and `combine`.
(struct sortable (stx group key) #:transparent)
(define group-id 0)
(define group-lib 1)
(define group-file 2)
(define group-string 3)
(define group-quote 4)
(define group-rel-submod 5)
(define (sortable-group+key v)
(format "~a:~a" (sortable-group v) (sortable-key v)))
;; Because the unused requires analysis works at the level of module
;; paths, here we possibly return #f instead of a `sortable` struct.
;; This value may percolate up through more complex require-specs that
;; wrap a module path, causing them to be false and elided.
(define (modpath->sortable sort-group modpath-stx)
(define mod (syntax->datum modpath-stx))
(and (not (member (cons mod (current-phase-level))
(current-drops)))
(sortable modpath-stx sort-group mod)))
(define (copy orig stx)
(and orig
(sortable stx
(sortable-group orig)
(sortable-key orig))))
(define (combine sortables stx-preface)
(match (sort (filter values sortables) ;non-false
#:key sortable-group+key
string<?)
[(list) #f] ;elide
[(list v) v] ;reduce
[vs ;use first for sort, plus all stxs
(copy (car vs)
#`(#,@stx-preface #,@(map sortable-stx vs)))]))
;; These syntax classes generally follow the grammar from the docs.
(define-syntax-class root-module-path
#:attributes (s)
#:datum-literals (quote lib file) ;intentionally omit `planet`
(pattern id:id
#:attr s (modpath->sortable group-id #'id))
(pattern (lib) ;elide
#:attr s #f)
(pattern (lib str:string ...+)
#:attr s
(combine (stx-map (λ (str) (modpath->sortable group-lib str))
#'(str ...))
#'(lib)))
(pattern (file str:string)
#:attr s (modpath->sortable group-file #'str))
(pattern str:string
#:attr s (modpath->sortable group-string #'str))
(pattern (quote id:id)
#:attr s (modpath->sortable group-quote #'(quote id))))
(define-syntax-class submod-path-element
(pattern _id:id)
(pattern ".."))
(define-syntax-class module-path
#:attributes (s)
#:datum-literals (submod)
(pattern rmp:root-module-path
#:attr s (attribute rmp.s))
(pattern (submod rmp:root-module-path _:submod-path-element ...+)
#:attr s (attribute rmp.s))
(pattern (submod (~or "." "..") _:submod-path-element ...+)
#:attr s (sortable this-syntax group-rel-submod ".")))
(define-syntax-class require-spec
#:attributes (s)
#:datum-literals (;racket/base
only-in except-in prefix-in rename-in combine-in
relative-in only-meta-in only-space-in for-space
;racket/require
matching-identifiers-in subtract-in filtered-in
path-up multi-in)
#:local-conventions ([spec require-spec])
;; Main jobs here:
;;
;; 1. Calculate a `sortable` as the value for the `s` attribute. For
;; "complex" specs this uses the sort info from one of its
;; sub-specs; see `copy` and `combine`.
;;
;; 2. Simplify specs. For example `(only-in m)` -- with no
;; exceptions listed -- is legal but can be reduced to just `m`.
;; Furthermore, `(only-in m)` and `m` both elide to nothing when `m`
;; is a member of `current-drops`, in which case the `a` attribute
;; is #f. Likewise (combine-in) elides to #f.
(pattern mp:module-path
#:attr s (attribute mp.s))
(pattern (only-in spec) ;reduce
#:attr s (attribute spec.s))
(pattern (only-in spec _id-maybe-renamed ...+)
#:attr s (copy (attribute spec.s) this-syntax))
(pattern (except-in spec) ;reduce
#:attr s (attribute spec.s))
(pattern (except-in spec _id ...+)
#:attr s (copy (attribute spec.s) this-syntax))
(pattern (prefix-in _prefix:id spec)
#:attr s (copy (attribute spec.s) this-syntax))
(pattern (rename-in spec) ;reduce
#:attr s (attribute spec.s))
(pattern (rename-in spec [_orig:id _bind:id] ...)
#:attr s (copy (attribute spec.s) this-syntax))
(pattern (relative-in _mp:module-path) ;elide
#:attr s #f)
(pattern (relative-in mp:module-path spec ...+)
#:attr s (combine (attribute spec.s)
#'(relative-in mp)))
(pattern (combine-in spec ...)
#:attr s (combine (attribute spec.s)
#'(combine-in)))
(pattern (only-meta-in phase spec ...)
#:attr s (combine (attribute spec.s)
#`(only-meta-in phase)))
(pattern (only-space-in space spec ...)
#:attr s (combine (attribute spec.s)
#`(only-space-in space)))
(pattern (for-space space spec ...)
#:attr s (combine (attribute spec.s)
#`(for-space space)))
(pattern (matching-identifiers-in _regexp spec)
#:attr s (copy (attribute spec.s) this-syntax))
(pattern (subtract-in spec) ;reduce
#:attr s (attribute spec.s))
(pattern (subtract-in spec _subtracted-spec ...)
#:attr s (copy (attribute spec.s) this-syntax))
(pattern (filtered-in _proc spec)
#:attr s (copy (attribute spec.s) this-syntax))
(pattern (path-up) ;elide
#:attr s #f)
(pattern (path-up str:string ...+)
#:attr s
(combine (stx-map (λ (str) (modpath->sortable 1 str))
#'(str ...))
#'(path-up)))
(pattern (multi-in) ;elide
#:attr s #f)
(pattern (multi-in id:id ...+) ;reduce to id/id ..
#:attr s
(modpath->sortable group-id
#`#,(join (syntax->datum #'(id ...))
symbol->string
string->symbol)))
(pattern (multi-in str:string ...+) ;reduce to str/str ..
#:attr s
(modpath->sortable group-string
#`#,(join (syntax->datum #'(str ...)))))
(pattern (multi-in id:id ...+ p:multi-in-id-subs) ;1xN
#:attr s
(multi-in-1xN (syntax->datum #'(id ...))
(attribute p.ids)
symbol->string
string->symbol))
(pattern (multi-in str:string ...+ p:multi-in-string-subs) ;1xN
#:attr s
(multi-in-1xN (syntax->datum #'(str ...))
(attribute p.strs)))
(pattern (multi-in p:multi-in-id-subs ...+)
#:attr s (multi-in-general (attribute p.ids)
symbol->string
string->symbol))
(pattern (multi-in p:multi-in-string-subs ...+)
#:attr s (multi-in-general (attribute p.strs))))
(define-syntax-class multi-in-string-subs
#:attributes (strs)
(pattern str:string
#:attr strs (syntax->datum #'(str)))
(pattern (str:string ...+)
#:attr strs (syntax->datum #'(str ...))))
(define-syntax-class multi-in-id-subs
#:attributes (ids)
(pattern id:id
#:attr ids (syntax->datum #'(id)))
(pattern (id:id ...+)
#:attr ids (syntax->datum #'(id ...))))
(define (join vs [->str values] [str-> values])
(str->
(apply string-append
(add-between (map ->str vs)
"/"))))
;; The simple case of one or more single subs and a final list of subs
;; -- e.g. (multi-in typed racket (string format)) -- which allows us
;; to handle dropped modules by removing an item from the final subs.
;; Or, if all final subs removed, elide the multi-in form entirely.
(define (multi-in-1xN single-subs final-subs [->str values] [str-> values])
(define sorted (sort final-subs #:key ->str string<?))
(define filtered
(for*/list ([p (in-list sorted)]
[mod (in-value (join (append single-subs (list p))
->str str->))]
#:unless (member (cons mod (current-phase-level))
(current-drops)))
p))
(cond
[(null? filtered) #f] ;nothing remains, elide entirely
[else
(sortable #`(multi-in #,@single-subs
#,(simplify-subs filtered))
(if (equal? ->str values) group-string group-id)
(join (append single-subs (list (car final-subs)))
->str str->))]))
;; The general case of any cartesian product.
;;
;; Expects every subs to be normalized to a list, even if it contains
;; just one item.
(define (multi-in-general subs [->str values] [str-> values])
(define sorted (map (λ (sub-path)
(sort sub-path #:key ->str string<?))
subs))
(define sort-key (join (map car sorted) ->str str->))
(define sort-group (if (string? sort-key) group-string group-id))
(define products (apply cartesian-product sorted))
(define mods (for/list ([vs (in-list products)])
(join vs ->str str->)))
(define drops (for*/list ([mod (in-list mods)]
#:when (member (cons mod (current-phase-level))
(current-drops)))
mod))
(cond
;; Trivial case: As-is, just simplify.
[(null? drops)
(sortable #`(multi-in #,@(simplify-subs sorted))
sort-group
sort-key)]
[else
;; General case for any cartesian product: IIUC the best we can
;; do is subtract, i.e. wrap the multi-in in subtract-in.
;;
;; Example: (multi-in (a b) (0 1) (x y))
;;
;; If we're to drop only b/1/y -- but keep a/1/y -- how else
;; could we rewrite this?
(sortable #`(subtract-in (multi-in #,@(simplify-subs sorted))
#,@drops)
sort-group
sort-key)]))
(define (simplify-subs subs)
(for/list ([s (in-list subs)])
(match s
[(list v) v]
[v v])))
(module+ example
(syntax-parse #'(multi-in "math" "matrix" "utils.rkt")
[spec:require-spec (attribute spec.s)])
(syntax-parse #'(multi-in "math" ("matrix.rkt" "foo.rkt"))
[spec:require-spec (attribute spec.s)])
(parameterize ([current-drops (list (cons 'racket/format 0))])
(syntax-parse #'(multi-in racket (string format match))
[spec:require-spec (attribute spec.s)]))
(parameterize ([current-drops (list (cons 'racket/format 0))])
(syntax-parse #'(multi-in racket (string format))
[spec:require-spec (attribute spec.s)]))
(parameterize ([current-drops (list (cons 'racket/string 0))])
(syntax-parse #'(multi-in (foobar racket) (string format))
[spec:require-spec (attribute spec.s)])))
(define-syntax-class phased-require-spec
#:attributes (phase specs)
#:datum-literals (racket/require for-syntax for-template for-label for-meta)
#:local-conventions ([spec require-spec])
(pattern racket/require
#:attr phase 'racket/require
#:with specs #'(racket/require))
;; Note: We don't attempt to recognize nested phased specs such as
;; (for-syntax (for-template _)) and reduce to a net phase level.
;; Although such forms are legal, and might be generated by macros,
;; instead our goal here is to parse specs that a human is likely to
;; write by hand.
(pattern (for-syntax spec ...)
#:attr phase 1
#:with specs #'(spec ...))
(pattern (for-template spec ...)
#:attr phase -1
#:with specs #'(spec ...))
(pattern (for-label spec ...)
#:attr phase #f
#:with specs #'(spec ...))
(pattern (for-meta phase-level spec ...)
#:attr phase (syntax->datum #'phase-level)
#:with specs #'(spec ...))
(pattern spec
#:attr phase 0
#:with specs #'(spec)))
(define (tidy-module reqs #:adds [adds null] #:drops [drops null])
(define ht (make-hash)) ;phase-level => sortable?
(define (add! v)
(hash-update! ht
(current-phase-level)
(λ (vs) (cons v vs))
null))
;; Denormalize
(syntax-parse reqs
#:datum-literals (require)
[((require spec:phased-require-spec ...) ...)
(for ([spec (in-list (syntax->list #'(spec ... ...)))])
(syntax-parse spec
[v:phased-require-spec
(parameterize ([current-phase-level (attribute v.phase)]
[current-drops drops])
(for ([spec (in-list (syntax->list #'v.specs))])
(syntax-parse spec
[spec:require-spec
(define v (attribute spec.s))
(when v (add! v))])))]))])
(for ([mod+level (in-list adds)])
(match-define (cons mod level) mod+level)
(parameterize ([current-phase-level level])
(define group (if (string? mod) group-string group-id))
(define v (modpath->sortable group #`#,mod))
(when v (add! v))))
;; Normalize
(define (for-level level k)
(define sorted (sort (hash-ref ht level null)
#:key sortable-group+key
string<?))
(define datums (remove-duplicates
(for/list ([v (in-list sorted)])
(syntax->datum (sortable-stx v)))))
(cond [(null? datums) null]
[else (k datums)]))
(define ((preface . pres) specs)
`((,@pres ,@specs)))
(define meta-levels
(sort (filter (match-lambda
[(or -1 0 1) #f]
[(? number?) #t]
[_ #f])
(hash-keys ht))
<))
(match `(require
,@(for-level 'racket/require values)
,@(for-level 1 (preface 'for-syntax))
,@(for-level -1 (preface 'for-template))
,@(for-level #f (preface 'for-label))
,@(append* (for/list ([level (in-list meta-levels)])
(for-level level (preface 'for-meta level))))
,@(for-level 0 values))
['(require) #f]
[v v]))
(module+ test
(check-equal? (tidy-module
#:drops (list (cons 'racket/string 0)
(cons 'bar/b 0))
'((require z c b a)
(require racket/require)
(require (multi-in mi-z (mi-z0 mi-z1)))
(require (multi-in mi-a (mi-a1 mi-a0)))
(require (multi-in baz (a b)))
(require (multi-in racket (format string match)))
(require (multi-in racket string)) ;disappears
(require (multi-in racket list)) ;=> racket/list
(require (multi-in "dir" "file.rkt")) ;=> "dir/file.rkt"
(require (multi-in (foo bar) (a b c)))
(require (combine-in)) ;disappears
(require (combine-in combine-0)) ;=> combine-0
(require (combine-in racket/string)) ;disappears
(require (combine-in combine-0 racket/string)) ;=> combine-0
(require (for-meta 4 m41 m40))
(require (for-meta -4 m-41 m-40))
(require (for-label l1 l0))
(require (for-template t1 t0))
(require (for-syntax s1 s0))
(require
"a.rkt" "b.rkt" "c.rkt" "z.rkt"
(only-in "mod.rkt" oi)
(only-in mod oi))))
'(require
racket/require
(for-syntax s0 s1)
(for-template t0 t1)
(for-label l0 l1)
(for-meta -4 m-40 m-41)
(for-meta 4 m40 m41)
a
b
(subtract-in ;drop bar/b but keep foo/b
(multi-in (bar foo) (a b c))
bar/b)
(multi-in baz (a b))
c
combine-0
(multi-in mi-a (mi-a0 mi-a1))
(multi-in mi-z (mi-z0 mi-z1))
(only-in mod oi)
(multi-in racket (format match)) ;racket/string dropped
racket/list
z
"a.rkt" "b.rkt" "c.rkt"
"dir/file.rkt"
(only-in "mod.rkt" oi)
"z.rkt")))
;;; tidy-file
;; Per each module (file root-module or submodule): (listof syntax?).
(define current-module-old-requires (make-parameter null))
;; Per entire file: (listof (or/c insert? delete?)).
(struct delete (pos span) #:transparent)
(struct insert (pos str) #:transparent)
(define current-file-changes (make-parameter null))
;; cons a new value onto a list-valued parameter
(define (cons-param v p)
(p (cons v (p))))
(define-syntax-class require-statement
#:datum-literals (require)
(pattern (require _:phased-require-spec ...)
#:do
[(cons-param this-syntax
current-module-old-requires)
(cons-param (delete (syntax-position this-syntax)
(syntax-span this-syntax))
current-file-changes)]))
(define-syntax-class module-level
(pattern _:require-statement)
(pattern _:submodule-statement)
(pattern _))
(define-syntax-class submodule-statement
#:datum-literals (module)
(pattern (module _mod _lang ml ...)
#:do
[(parameterize ([current-module-old-requires null])
(syntax-parse #'(ml ...)
[(_:module-level ...)
;; Intentionally not supplying adds/drops because
;; analysis doesn't work for submodules.
(add-insert-change-for-new-require)]))]))
(define-syntax-class root-module
#:attributes (lang)
#:datum-literals (module #%module-begin)
(pattern (module _mod lang (#%module-begin _:module-level ...))))
(define (tidy-file path-str #:adds [adds null] #:drops [drops null])
(parameterize ([current-file-changes null])
(syntax-parse (file->syntax path-str)
[rm:root-module
(add-insert-change-for-new-require #:adds adds
#:drops drops
#:lang #'rm.lang)
;; Sort changes in reverse position, with deletes sorting
;; before inserts at the same position.
(define changes (sort (current-file-changes)
>
#:key
(match-lambda
[(insert pos _) pos]
[(delete pos _) (+ pos 0.5)])))
;; Return a list of changes. A consecutive delete and insert at
;; same position is consolidated into (list 'replace pos span
;; str). The remaining changes are converted to (list 'delete
;; pos span) or (list 'insert pos str).
(let loop ([changes changes])
(match changes
[(list) (list)]
[(list* (delete pos span) (insert pos str) more)
(cons (list 'replace pos span str) (loop more))]
[(cons (delete pos span) more)
(cons (list 'delete pos span) (loop more))]
[(cons (insert pos str) more)
(cons (list 'insert pos str) (loop more))]))])))
;; Given current-module-old-requires, as well as optional adds and
;; drops, tidy into a single new require statement. Add that `insert`
;; change to current-file-changes.
(define (add-insert-change-for-new-require #:adds [adds null]
#:drops [drops null]
#:lang [lang #f])
(define olds (current-module-old-requires))
(define new (tidy-module (sort olds < #:key syntax-position)
#:adds adds
#:drops drops))
(when new
;; Preferably we insert the new require at the same position as
;; the first of the old requires. However if no old require (as
;; can happen changing #lang racket -> racket/base) position it
;; after the #lang line.
(define pos
(cond
[(null? olds)
(unless lang
(error 'tidy-file
"No old require position and unknown lang syntax"))
(+ (syntax-position lang) (syntax-span lang) 1)]
[else
(syntax-position (argmin syntax-position olds))]))
(cons-param (insert pos (format-require new))
current-file-changes)))
;;; format
(define (format-require x)
(define out (open-output-string))
(parameterize ([current-output-port out])
(print-require x))
(get-output-string out))
(module+ test
(check-equal? (format-require
'(require a))
@~a{(require a)})
(check-equal? (format-require
'(require a b))
@~a{(require a
b)})
(check-equal? (format-require
'(require (for-syntax a b) (for-meta 2 c d) e f))
@~a{(require (for-syntax a
b)
(for-meta 2
c
d)
e
f)})
(check-equal? (format-require
`(require (only-in m a b) (except-in m a b)))
@~a{(require (only-in m
a
b)
(except-in m
a
b))}))
;; Rint a require form.
;;
;; All forms are indented with `require` indent style.
;;
;; Unlike pretty-print, we always print the head item plus the first
;; arg on the same line, then any subsequent items each on their own
;; line indented with the first arg. We don't use pretty-print's
;; approach of hot or cold porridge -- i.e. trying to squeeze forms
;; onto the same line <= pretty-print-columns, otherwise every item on
;; its own line all indented with the head. Instead we want warm
;; uniformity. (But we break that rule for module-path forms like
;; `submod`, which we print on one line.)
;;
;; Also there are details like printing `[old-id new-id]` forms with
;; square brackets, by convention.
;;
;; Note: Although it might be more robust to write this in a grammar
;; style, the following is less tedious and seems OK.
(define (print-require v)
(struct text (v)) ;a value to `display` not `write`
(let prn ([v v] [indent? #t] [indent 0])
(define (maybe-indent)
(when indent?
(for ([_ (in-range indent)])
(display #\space))))
(define (prn-form head this more)
(define head-str (symbol->string head))
(define new-indent (+ indent 2 (string-length head-str)))
(maybe-indent)
(printf "(~a " head-str)
(prn this #f new-indent)
(for ([v more])
(newline)
(let ([v (match v
[(list old new)
#:when (memq head '(rename-in only-in))
(text (format "[~a ~a]" old new))]
[v v])])
(prn v #t new-indent)))
(display ")"))
(match v
[(and (or (? string?)
(? symbol?)
(cons (or 'submod 'quote 'lib 'file 'planet '= '+ '-) _))
mod-path)
(maybe-indent)
(write mod-path)]
[(list* (? symbol? head) this more)
(prn-form head this more)]
[(text s)
(maybe-indent)
(display s)]
[v ;Some other value, like number or #f for phase-level
(maybe-indent)
(write v)])))
(module+ test
(check-equal? (format-require
'(require
(prefix-in pre:
(combine-in
(only-in "a.rkt" b [c d])
(rename-in (submod m sub) [y z] [p q])))))
@~a{(require (prefix-in pre:
(combine-in (only-in "a.rkt"
b
[c d])
(rename-in (submod m sub)
[y z]
[p q]))))}))
|