File size: 61,712 Bytes
3dcad1f |
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 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 |
;;; Diagnostic warnings for Tree-IL
;; Copyright (C) 2001,2008-2014,2016,2018-2023 Free Software Foundation, Inc.
;;;; This library is free software; you can redistribute it and/or
;;;; modify it under the terms of the GNU Lesser General Public
;;;; License as published by the Free Software Foundation; either
;;;; version 3 of the License, or (at your option) any later version.
;;;;
;;;; This library is distributed in the hope that it will be useful,
;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;;;; Lesser General Public License for more details.
;;;;
;;;; You should have received a copy of the GNU Lesser General Public
;;;; License along with this library; if not, write to the Free Software
;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
;;; Code:
(define-module (language tree-il analyze)
#:use-module (srfi srfi-1)
#:use-module (srfi srfi-9)
#:use-module (srfi srfi-11)
#:use-module (srfi srfi-26)
#:use-module (ice-9 vlist)
#:use-module (ice-9 match)
#:use-module (system base syntax)
#:use-module (system base message)
#:use-module (system vm program)
#:use-module (language tree-il)
#:use-module (system base pmatch)
#:export (analyze-tree
unused-variable-analysis
unused-toplevel-analysis
shadowed-toplevel-analysis
make-use-before-definition-analysis
arity-analysis
format-analysis
make-analyzer))
;;;
;;; Tree analyses for warnings.
;;;
(define-record-type <tree-analysis>
(make-tree-analysis down up post init)
tree-analysis?
(down tree-analysis-down) ;; (lambda (x result env locs) ...)
(up tree-analysis-up) ;; (lambda (x result env locs) ...)
(post tree-analysis-post) ;; (lambda (result env) ...)
(init tree-analysis-init)) ;; arbitrary value
(define (analyze-tree analyses tree env)
"Run all tree analyses listed in ANALYSES on TREE for ENV, using
`tree-il-fold'. Return TREE. The down and up procedures of each
analysis are passed a ``location stack', which is the stack of
`tree-il-src' values for each parent tree (a list); it can be used to
approximate source location when accurate information is missing from a
given `tree-il' element."
(define (traverse proc update-locs)
;; Return a tree traversing procedure that returns a list of analysis
;; results prepended by the location stack.
(lambda (x results)
(let ((locs (update-locs x (car results))))
(cons locs ;; the location stack
(map (lambda (analysis result)
((proc analysis) x result env locs))
analyses
(cdr results))))))
;; Extending and shrinking the location stack.
(define (extend-locs x locs) (cons (tree-il-srcv x) locs))
(define (shrink-locs x locs) (cdr locs))
(let ((results
(tree-il-fold (traverse tree-analysis-down extend-locs)
(traverse tree-analysis-up shrink-locs)
(cons '() ;; empty location stack
(map tree-analysis-init analyses))
tree)))
(for-each (lambda (analysis result)
((tree-analysis-post analysis) result env))
analyses
(cdr results)))
tree)
;;;
;;; Unused variable analysis.
;;;
;; <binding-info> records are used during tree traversals in
;; `unused-variable-analysis'. They contain a list of the local vars
;; currently in scope, and a list of locals vars that have been referenced.
(define-record-type <binding-info>
(make-binding-info vars refs)
binding-info?
(vars binding-info-vars) ;; ((GENSYM NAME LOCATION) ...)
(refs binding-info-refs)) ;; (GENSYM ...)
(define (gensym? sym)
;; Return #t if SYM is (likely) a generated symbol.
(string-any #\space (symbol->string sym)))
(define unused-variable-analysis
;; Report unused variables in the given tree.
(make-tree-analysis
(lambda (x info env locs)
;; Going down into X: extend INFO's variable list
;; accordingly.
(let ((refs (binding-info-refs info))
(vars (binding-info-vars info))
(src (tree-il-srcv x)))
(define (extend inner-vars inner-names)
(fold (lambda (var name vars)
(vhash-consq var (list name src) vars))
vars
inner-vars
inner-names))
(match x
(($ <lexical-ref> src name gensym)
(make-binding-info vars (vhash-consq gensym #t refs)))
(($ <lexical-set> src name gensym)
(make-binding-info vars (vhash-consq gensym #t refs)))
(($ <lambda-case> src req opt rest kw inits gensyms body alt)
(let ((names `(,@req
,@(or opt '())
,@(if rest (list rest) '())
,@(if kw (map cadr (cdr kw)) '()))))
(make-binding-info (extend gensyms names) refs)))
(($ <let> src names gensyms)
(make-binding-info (extend gensyms names) refs))
(($ <letrec> src in-order? names gensyms)
(make-binding-info (extend gensyms names) refs))
(($ <fix> src names gensyms)
(make-binding-info (extend gensyms names) refs))
(_ info))))
(lambda (x info env locs)
;; Leaving X's scope: shrink INFO's variable list
;; accordingly and reported unused nested variables.
(let ((refs (binding-info-refs info))
(vars (binding-info-vars info)))
(define (shrink inner-vars refs)
(vlist-for-each
(lambda (var)
(let ((gensym (car var)))
;; Don't report lambda parameters as unused.
(if (and (memq gensym inner-vars)
(not (vhash-assq gensym refs))
(not (lambda-case? x)))
(let ((name (cadr var))
;; We can get approximate source location by going up
;; the LOCS location stack.
(loc (or (caddr var)
(find pair? locs))))
(if (and (not (gensym? name))
(not (eq? name '_)))
(warning 'unused-variable loc name))))))
vars)
(vlist-drop vars (length inner-vars)))
;; For simplicity, we leave REFS untouched, i.e., with
;; names of variables that are now going out of scope.
;; It doesn't hurt as these are unique names, it just
;; makes REFS unnecessarily fat.
(match x
(($ <lambda-case> src req opt rest kw inits gensyms)
(make-binding-info (shrink gensyms refs) refs))
(($ <let> src names gensyms)
(make-binding-info (shrink gensyms refs) refs))
(($ <letrec> src in-order? names gensyms)
(make-binding-info (shrink gensyms refs) refs))
(($ <fix> src names gensyms)
(make-binding-info (shrink gensyms refs) refs))
(_ info))))
(lambda (result env) #t)
(make-binding-info vlist-null vlist-null)))
;;;
;;; Unused top-level variable analysis.
;;;
;; <reference-graph> record top-level definitions that are made, references to
;; top-level definitions and their context (the top-level definition in which
;; the reference appears), as well as the current context (the top-level
;; definition we're currently in). The second part (`refs' below) is
;; effectively a graph from which we can determine unused top-level definitions.
(define-record-type <reference-graph>
(make-reference-graph defs refs toplevel-context)
reference-graph?
(defs reference-graph-defs) ;; ((NAME . LOC) ...)
(refs reference-graph-refs) ;; ((REF-CONTEXT REF ...) ...)
(toplevel-context reference-graph-toplevel-context)) ;; NAME | #f
(define (graph-reachable-nodes root refs reachable)
;; Add to REACHABLE the nodes reachable from ROOT in graph REFS. REFS is a
;; vhash mapping nodes to the list of their children: for instance,
;; ((A -> (B C)) (B -> (A)) (C -> ())) corresponds to
;;
;; ,-------.
;; v |
;; A ----> B
;; |
;; v
;; C
;;
;; REACHABLE is a vhash of nodes known to be otherwise reachable.
(let loop ((root root)
(path vlist-null)
(result reachable))
(if (or (vhash-assq root path)
(vhash-assq root result))
result
(let* ((children (or (and=> (vhash-assq root refs) cdr) '()))
(path (vhash-consq root #t path))
(result (fold (lambda (kid result)
(loop kid path result))
result
children)))
(fold (lambda (kid result)
(vhash-consq kid #t result))
result
children)))))
(define (graph-reachable-nodes* roots refs)
;; Return the list of nodes in REFS reachable from the nodes listed in ROOTS.
(vlist-fold (lambda (root+true result)
(let* ((root (car root+true))
(reachable (graph-reachable-nodes root refs result)))
(vhash-consq root #t reachable)))
vlist-null
roots))
(define (partition* pred vhash)
;; Partition VHASH according to PRED. Return the two resulting vhashes.
(let ((result
(vlist-fold (lambda (k+v result)
(let ((k (car k+v))
(v (cdr k+v))
(r1 (car result))
(r2 (cdr result)))
(if (pred k)
(cons (vhash-consq k v r1) r2)
(cons r1 (vhash-consq k v r2)))))
(cons vlist-null vlist-null)
vhash)))
(values (car result) (cdr result))))
(define unused-toplevel-analysis
;; Report unused top-level definitions that are not exported.
(let ()
(define initial-graph
(make-reference-graph vlist-null vlist-null #f))
(define (add-def graph name src)
(match graph
(($ <reference-graph> defs refs ctx)
(make-reference-graph (vhash-consq name src defs) refs name))))
(define (add-ref graph pred succ)
;; Add a ref edge PRED -> SUCC in GRAPH.
(match graph
(($ <reference-graph> defs refs ctx)
(let* ((succs (match (vhash-assq pred refs)
((pred . succs) succs)
(#f '())))
(refs (vhash-consq pred (cons succ succs) refs)))
(make-reference-graph defs refs ctx)))))
(define (add-ref-from-context graph name)
;; Add a ref edge from the current context to NAME in GRAPH.
(add-ref graph (reference-graph-toplevel-context graph) name))
(define (add-root-ref graph name)
;; Add a ref edge to NAME from the root, because its metadata is
;; marked maybe-unused.
(add-ref graph #f name))
(define (macro-variable? name env)
(and (module? env)
(let ((var (module-variable env name)))
(and var (variable-bound? var)
(macro? (variable-ref var))))))
(define (maybe-unused? metadata)
(assq 'maybe-unused metadata))
(make-tree-analysis
(lambda (x graph env locs)
;; Going down into X.
(match x
(($ <toplevel-ref> src mod name)
(add-ref-from-context graph name))
(($ <toplevel-define> src mod name expr)
(let ((graph (add-def graph name (or src (find pair? locs)))))
(match expr
(($ <lambda> src (? maybe-unused?) body)
(add-root-ref graph name))
(_ graph))))
(($ <toplevel-set> src mod name expr)
(add-ref-from-context graph name))
(_ graph)))
(lambda (x graph env locs)
;; Leaving X's scope.
(match x
(($ <toplevel-define>)
(match graph
(($ <reference-graph> defs refs ctx)
(make-reference-graph defs refs #f))))
(_ graph)))
(lambda (graph env)
;; Process the resulting reference graph: determine all private definitions
;; not reachable from any public definition. Macros
;; (syntax-transformers), which are globally bound, never considered
;; unused since we can't tell whether a macro is actually used; in
;; addition, macros are considered roots of the graph since they may use
;; private bindings. FIXME: The `make-syntax-transformer' calls don't
;; contain any literal `toplevel-ref' of the global bindings they use so
;; this strategy fails.
(define exports (make-hash-table))
(when (module? env)
(module-for-each (lambda (name var) (hashq-set! exports var name))
(module-public-interface env)))
(define (exported? name)
(if (module? env)
(and=> (module-variable env name)
(lambda (var)
(hashq-ref exports var)))
#t))
(let-values (((public-defs private-defs)
(partition* (lambda (name)
(or (exported? name)
(macro-variable? name env)))
(reference-graph-defs graph))))
(let* ((roots (vhash-consq #f #t public-defs))
(refs (reference-graph-refs graph))
(reachable (graph-reachable-nodes* roots refs))
(unused (vlist-filter (lambda (name+src)
(not (vhash-assq (car name+src)
reachable)))
private-defs)))
(vlist-for-each (lambda (name+loc)
(let ((name (car name+loc))
(loc (cdr name+loc)))
(if (not (gensym? name))
(warning 'unused-toplevel loc name))))
unused))))
initial-graph)))
;;;
;;; Unused module analysis.
;;;
;; Module uses and references to bindings of imported modules.
(define-record-type <module-info>
(module-info location qualified-references
toplevel-references toplevel-definitions)
module-info?
(location module-info-location) ;location vector | #f
(qualified-references module-info-qualified-references) ;module name vhash
(toplevel-references module-info-toplevel-references) ;list of symbols
(toplevel-definitions module-info-toplevel-definitions)) ;symbol vhash
(define unused-module-analysis
;; Report unused modules in the given tree.
(make-tree-analysis
(lambda (x info env locs)
;; Going down into X: extend INFO accordingly.
(match x
((or ($ <module-ref> loc module name)
($ <module-set> loc module name))
(let ((references (module-info-qualified-references info)))
(if (vhash-assoc module references)
info
(module-info (module-info-location info)
(vhash-cons module #t references)
(module-info-toplevel-references info)
(module-info-toplevel-definitions info)))))
((or ($ <toplevel-ref> loc module name)
($ <toplevel-set> loc module name))
(if (equal? module (module-name env))
(let ((references (module-info-toplevel-references info)))
(module-info (module-info-location info)
(module-info-qualified-references info)
(cons x references)
(module-info-toplevel-definitions info)))
(let ((references (module-info-qualified-references info)))
(module-info (module-info-location info)
(vhash-cons module #t references)
(module-info-toplevel-references info)
(module-info-toplevel-definitions info)))))
(($ <toplevel-define> loc module name)
(module-info (module-info-location info)
(module-info-qualified-references info)
(module-info-toplevel-references info)
(vhash-consq name x
(module-info-toplevel-definitions info))))
;; Record the approximate location of the module import. We
;; could parse the #:imports arguments to determine the location
;; of each #:use-module but we'll leave that as an exercise for
;; the reader.
(($ <call> loc ($ <module-ref> _ '(guile) 'define-module*))
(module-info loc
(module-info-qualified-references info)
(module-info-toplevel-references info)
(module-info-toplevel-definitions info)))
(($ <call> loc ($ <module-ref> _ '(guile) 'process-use-modules))
(module-info loc
(module-info-qualified-references info)
(module-info-toplevel-references info)
(module-info-toplevel-definitions info)))
(_
info)))
(lambda (x info env locs) ;leaving X's scope
info)
(lambda (info env) ;finishing
(define (defining-module ref env)
;; Return the name of the module that defines REF, a
;; <toplevel-ref> or <toplevel-set>, in ENV.
(let ((name (if (toplevel-ref? ref)
(toplevel-ref-name ref)
(toplevel-set-name ref))))
(match (vhash-assq name (module-info-toplevel-definitions info))
(#f
;; NAME is not among the top-level definitions of this
;; compilation unit, so check which module provides it.
(and=> (module-variable env name)
(lambda (variable)
(and=> (find (lambda (module)
(module-reverse-lookup module variable))
(module-uses env))
module-name))))
(_
(if (toplevel-ref? ref)
(toplevel-ref-mod ref)
(toplevel-set-mod ref))))))
(define (module-bindings-reexported? module env)
;; Return true if ENV reexports one or more bindings from MODULE.
(let ((module (resolve-interface module))
(tag (make-prompt-tag)))
(call-with-prompt tag
(lambda ()
(module-for-each (lambda (symbol variable)
(when (module-reverse-lookup module variable)
(abort-to-prompt tag)))
(module-public-interface env))
#f)
(const #t))))
(define (module-exports-macros? module)
;; Return #t if MODULE exports one or more macros.
(let ((tag (make-prompt-tag)))
(call-with-prompt tag
(lambda ()
(module-for-each (lambda (symbol variable)
(when (and (variable-bound? variable)
(macro?
(variable-ref variable)))
(abort-to-prompt tag)))
module)
#f)
(const #t))))
(let ((used-modules ;list of modules actually used
(fold (lambda (reference modules)
(let ((module (defining-module reference env)))
(if (or (not module) (vhash-assoc module modules))
modules
(vhash-cons module #t modules))))
(module-info-qualified-references info)
(module-info-toplevel-references info))))
;; Compare the modules imported by ENV with USED-MODULES, the
;; list of modules actually referenced. When a module is not in
;; USED-MODULES, check whether ENV reexports bindings from it.
(for-each (lambda (module)
(unless (or (vhash-assoc (module-name module)
used-modules)
(module-bindings-reexported?
(module-name module) env))
;; If MODULE exports macros, and if the expansion
;; of those macros doesn't contain <module-ref>s
;; inside MODULE, then we cannot conclude whether
;; or not MODULE is used.
(warning 'unused-module
(module-info-location info)
(module-name module)
(not (module-exports-macros? module)))))
(module-uses env))))
(module-info #f vlist-null '() vlist-null)))
;;;
;;; Shadowed top-level definition analysis.
;;;
(define shadowed-toplevel-analysis
;; Report top-level definitions that shadow previous top-level
;; definitions from the same compilation unit.
(make-tree-analysis
(lambda (x defs env locs)
;; Going down into X.
(match x
(($ <toplevel-define> src mod name expr)
(match (vhash-assq name defs)
((_ . previous-definition)
(warning 'shadowed-toplevel src name
(tree-il-srcv previous-definition))
defs)
(#f
(vhash-consq name x defs))))
(else defs)))
(lambda (x defs env locs)
;; Leaving X's scope.
defs)
(lambda (defs env)
#t)
vlist-null))
;;;
;;; Use before definition analysis.
;;;
;;; This analysis collects all definitions of top-level variables, and
;;; references to top-level variables. As it visits the term, it tries
;;; to match uses to the definition that corresponds to that program
;;; point. For example, in this sample program:
;;;
;;; (define a 42)
;;; (define b a)
;;;
;;; The analysis will be able to know that the definition of "a"
;;; referred to when defining "b" is 42.
;;;
;;; In many cases this definition is conservative. For example, in this
;;; code:
;;;
;;; (define a 42)
;;; (define b (lambda () a))
;;;
;;; We don't necessarily know that the "a" in the lambda is 42, as a
;;; further top-level definition could provide a different value.
;;; However, we do know that "a" is bound, unlike in this code:
;;;
;;; (define b (lambda () a))
;;;
;;; Here we should issue a warning if no import provides an "a" binding.
;;;
;;; Use-before-def analysis also issues specialized warnings for some
;;; less common errors. One relates specifically to macro use before
;;; definition. If a compilation unit defines a macro and has some uses
;;; of the macro, usually the uses will be expanded out by the
;;; macro-expander. If there is any reference to a macro as a value,
;;; that usually indicates a bug in the user's program. Like in this
;;; program:
;;;
;;; (define (a) (b))
;;; (define-syntax-rule (b) 42)
;;;
;;; If this program is expanded one top-level expression at a time,
;;; which is Guile's default compilation mode, the expander will assume
;;; that the reference to (b) is a call to a top-level procedure, only
;;; to find out it's a macro later on. Use-before-def analysis can warn
;;; for this case.
;;;
;;; Similarly, if a compilation unit uses an imported binding, then
;;; provides a local definition for the binding, this may cause problems
;;; if the module is re-loaded. Consider:
;;;
;;; (define-module (foo))
;;; (define a +)
;;; (define + -)
;;;
;;; In this fragment, we see the intention of the programmer is to
;;; locally redefine `+', but to preserve the previous definition in
;;; `a'.
;;;
;;; However, if the module is loaded twice, `a' will be bound not to the
;;; `(guile)' binding of `+', but rather to `-'. This is because each
;;; module has a single global instance, and the first definition
;;; already bound `+' to `-'. Use-before-def analysis can detect this
;;; situation as well.
;;;
;;; <use-before-def-info> records are used during tree traversal in
;;; search of possible uses of values before they are defined. They
;;; contain a list of references to top-level variables, and a list of
;;; the top-level definitions that have been encountered. Any definition
;;; which is a macro should in theory be expanded out already; if that's
;;; not the case, the program likely has a bug.
(define-record-type <use-before-def-info>
(make-use-before-def-info depth uses defs)
use-before-def-info?
;; LOCAL-DEF := #(MACRO? DEPTH LOCATION)
;; DEF := LOCAL-DEF ; Defined in compilation unit already at use.
;; | import ; Def provided by imported module.
;; | unknown-module ; Module at use site not known.
;; | unknown-declarative ; Defined, but def not within compilation unit.
;; | unknown-imperative ; Same as above, but in non-declarative module.
;; | unbound ; No top-level definition known at use
;; USE := #(MOD-NAME VAR-NAME DEPTH DEF LOCATION)
(depth use-before-def-info-depth) ;; Zero if definitely evaluated
(uses use-before-def-info-uses) ;; List of USE
(defs use-before-def-info-defs)) ;; Vhash of ((MOD . NAME) . LOCAL-DEF)
(define (goops-toplevel-definition proc args env)
;; If call of PROC to ARGS is a GOOPS top-level definition, return the
;; name of the variable being defined; otherwise return #f. This
;; assumes knowledge of the current implementation of `define-class'
;; et al.
(match (cons proc args)
((($ <module-ref> _ '(oop goops) 'toplevel-define! #f)
($ <const> _ (? symbol? name))
exp)
;; We don't know the precise module in which we are defining the
;; variable :/ Guess that it's in `env'.
(vector (module-name env) name exp))
((($ <toplevel-ref> _ '(oop goops) 'toplevel-define!)
($ <const> _ (? symbol? name))
exp)
(vector '(oop goops) name exp))
(_ #f)))
(define* (make-use-before-definition-analysis #:key (warning-level 0)
(enabled-warnings '()))
;; Report possibly unbound variables in the given tree.
(define (enabled-for-level? level) (<= level warning-level))
(define-syntax-rule (define-warning enabled
#:level level #:name warning-name)
(define enabled
(or (enabled-for-level? level)
(memq 'warning-name enabled-warnings))))
(define-warning use-before-definition-enabled
#:level 1 #:name use-before-definition)
(define-warning unbound-variable-enabled
#:level 1 #:name unbound-variable)
(define-warning macro-use-before-definition-enabled
#:level 1 #:name macro-use-before-definition)
(define-warning non-idempotent-definition-enabled
#:level 1 #:name non-idempotent-definition)
(define (resolve mod name defs)
(match (vhash-assoc (cons mod name) defs)
((_ . local-def)
;; Top-level def present in this compilation unit, before this
;; use.
local-def)
(#f
(let ((mod (and mod (resolve-module mod #f #:ensure #f))))
(cond
((not mod)
;; We don't know the module with respect to which this var
;; is being resolved.
'unknown-module)
((module-local-variable mod name)
;; The variable is locally bound in the module, but not by
;; any definition in the compilation unit; perhaps by load
;; or load-extension or something.
(if (module-declarative? mod)
'unknown-declarative
'unknown-imperative))
((module-variable mod name)
;; The variable is an import. At the time of use, the
;; name is bound to the import.
'import)
((and=> (module-public-interface mod)
(lambda (interface)
(module-variable interface name)))
;; The variable is re-exported from another module.
'import)
(else
;; Variable unbound in the module.
'unbound))))))
(and
(or use-before-definition-enabled
unbound-variable-enabled
macro-use-before-definition-enabled
non-idempotent-definition-enabled)
(make-tree-analysis
(lambda (x info env locs)
;; Going down into X.
(define (make-use mod name depth def src)
(vector mod name depth def src))
(define (make-def is-macro? depth src)
(vector is-macro? depth src))
(define (nearest-loc src)
(or src (find pair? locs)))
(define (add-use mod name src)
(match info
(($ <use-before-def-info> depth uses defs)
(let* ((def (resolve mod name defs))
(use (make-use mod name depth def src)))
(make-use-before-def-info depth (cons use uses) defs)))))
(define (add-def mod name src is-macro?)
(match info
(($ <use-before-def-info> depth uses defs)
(let ((def (make-def is-macro? depth src)))
(make-use-before-def-info depth uses
(vhash-cons (cons mod name) def
defs))))))
(define (macro? x)
(match x
(($ <primcall> _ 'make-syntax-transformer) #t)
(_ #f)))
(match x
(($ <toplevel-ref> src mod name)
(add-use mod name (nearest-loc src)))
(($ <toplevel-set> src mod name)
(add-use mod name (nearest-loc src)))
(($ <toplevel-define> src mod name exp)
(add-def mod name (nearest-loc src) (macro? exp)))
(($ <call> src proc args)
;; Check for a dynamic top-level definition, as is
;; done by code expanded from GOOPS macros.
(match (goops-toplevel-definition proc args env)
(#f info)
(#(mod name exp) (add-def mod name (nearest-loc src) (macro? exp)))))
((or ($ <lambda>) ($ <conditional>))
(match info
(($ <use-before-def-info> depth uses defs)
(make-use-before-def-info (1+ depth) uses defs))))
(_ info)))
(lambda (x info env locs)
;; Leaving X's scope.
(match x
((or ($ <lambda>) ($ <conditional>))
(match info
(($ <use-before-def-info> depth uses defs)
(make-use-before-def-info (1- depth) uses defs))))
(_ info)))
(lambda (info env)
(define (compute-macros defs)
(let ((macros (make-hash-table)))
(vlist-for-each (match-lambda
((mod+name . #(is-macro? depth src))
(when is-macro?
(hash-set! macros mod+name src))))
defs)
macros))
;; Post-process the result.
;; FIXME: What to do with defs at nonzero depth?
(match info
(($ <use-before-def-info> 0 uses defs)
;; The way the traversal works is that we only add entries to
;; `defs' as we go, corresponding to local bindings.
;; Therefore the result of `resolve' can only go from being an
;; import, unbound, or top-level definition to being a
;; definition within the compilation unit. It can't go from
;; e.g. being an import to being a top-level definition, for
;; the purposes of our analysis, without the definition being
;; local to the compilation unit.
(let ((macros (compute-macros defs))
(issued-unbound-warnings (make-hash-table)))
(for-each
(match-lambda
(#(mod name use-depth def-at-use use-loc)
(cond
((and (hash-ref macros (cons mod name))
macro-use-before-definition-enabled)
;; Something bound to this name is a macro, probably
;; later in the compilation unit. Probably the author
;; made a mistake somewhere!
(warning 'macro-use-before-definition use-loc name))
(else
(let ((def-at-end (resolve mod name defs)))
(match (cons def-at-use def-at-end)
(('import . 'import) #t)
(('import . #(is-macro? def-depth def-loc))
;; At use, the binding was an import, but later
;; had a local definition. Warn as this could
;; pose a hazard when reloading the module, as the
;; initial binding wouldn't come from the import.
;; If depth nonzero though, use might happen later
;; as it might be in a lambda, so no warning in
;; that case.
(when (and non-idempotent-definition-enabled
(zero? use-depth) (zero? def-depth))
(warning 'non-idempotent-definition use-loc name)))
(('unbound . 'unbound)
;; No binding at all; probably an error at
;; run-time, but we just warn at compile-time.
(when unbound-variable-enabled
(unless (hash-ref issued-unbound-warnings
(cons mod name))
(hash-set! issued-unbound-warnings (cons mod name) #t)
(warning 'unbound-variable use-loc name))))
(('unbound . _)
;; If the depth at the use is 0, then the use
;; definitely occurs before the definition.
(when (and use-before-definition-enabled
(zero? use-depth))
(warning 'use-before-definition use-loc name)))
(('unknown-module . _)
;; Could issue a warning here that for whatever
;; reason, we weren't able to reason about what
;; module was current!
#t)
(('unknown-declarative . 'unknown-declarative)
;; FIXME: Probably we should emit a warning as in
;; a declarative module perhaps this should not
;; happen.
#t)
(('unknown-declarative . _)
;; Def later in compilation unit than use; no
;; problem. Can occur when reloading declarative
;; modules.
#t)
(('unknown-imperative . _)
;; Def present and although not visible at the
;; use, don't warn as use module is
;; non-declarative.
#t)
(((? vector) . (? vector?))
;; Def locally bound at use; no problem.
#t)))))))
(reverse uses))))))
(make-use-before-def-info 0 '() vlist-null))))
;;;
;;; Arity analysis.
;;;
;; <arity-info> records contain information about lexical definitions of
;; procedures currently in scope, top-level procedure definitions that have
;; been encountered, and calls to top-level procedures that have been
;; encountered.
(define-record-type <arity-info>
(make-arity-info toplevel-calls lexical-lambdas toplevel-lambdas)
arity-info?
(toplevel-calls toplevel-procedure-calls) ;; ((NAME . CALL) ...)
(lexical-lambdas lexical-lambdas) ;; ((GENSYM . DEFINITION) ...)
(toplevel-lambdas toplevel-lambdas)) ;; ((NAME . DEFINITION) ...)
(define (validate-arity proc call lexical?)
;; Validate the argument count of CALL, a tree-il call of
;; PROC, emitting a warning in case of argument count mismatch.
(define (filter-keyword-args keywords allow-other-keys? args)
;; Filter keyword arguments from ARGS and return the resulting list.
;; KEYWORDS is the list of allowed keywords, and ALLOW-OTHER-KEYS?
;; specified whethere keywords not listed in KEYWORDS are allowed.
(let loop ((args args)
(result '()))
(if (null? args)
(reverse result)
(let ((arg (car args)))
(if (and (const? arg)
(or (memq (const-exp arg) keywords)
(and allow-other-keys?
(keyword? (const-exp arg)))))
(loop (if (pair? (cdr args))
(cddr args)
'())
result)
(loop (cdr args)
(cons arg result)))))))
(define (arities proc)
;; Return the arities of PROC, which can be either a tree-il or a
;; procedure.
(define (len x)
(or (and (or (null? x) (pair? x))
(length x))
0))
(cond ((program? proc)
(values (procedure-name proc)
(map (lambda (a)
(list (length (or (assq-ref a 'required) '()))
(length (or (assq-ref a 'optional) '()))
(and (assq-ref a 'rest) #t)
(map car (or (assq-ref a 'keyword) '()))
(assq-ref a 'allow-other-keys?)))
(program-arguments-alists proc))))
((procedure? proc)
(if (struct? proc)
;; An applicable struct.
(arities (struct-ref proc 0))
;; An applicable smob.
(let ((arity (procedure-minimum-arity proc)))
(values (procedure-name proc)
(list (list (car arity) (cadr arity) (caddr arity)
#f #f))))))
(else
(let loop ((name #f)
(proc proc)
(arities '()))
(if (not proc)
(values name (reverse arities))
(match proc
(($ <lambda-case> src req opt rest kw inits gensyms body alt)
(loop name alt
(cons (list (len req) (len opt) rest
(and (pair? kw) (map car (cdr kw)))
(and (pair? kw) (car kw)))
arities)))
(($ <lambda> src meta body)
(loop (assoc-ref meta 'name) body arities))
(_
(values #f #f))))))))
(let ((args (call-args call))
(src (tree-il-srcv call)))
(call-with-values (lambda () (arities proc))
(lambda (name arities)
(define matches?
(find (lambda (arity)
(pmatch arity
((,req ,opt ,rest? ,kw ,aok?)
(let ((args (if (pair? kw)
(filter-keyword-args kw aok? args)
args)))
(if (and req opt)
(let ((count (length args)))
(and (>= count req)
(or rest?
(<= count (+ req opt)))))
#t)))
(else #t)))
arities))
(if (not matches?)
(warning 'arity-mismatch src
(or name (with-output-to-string (lambda () (write proc))))
lexical?)))))
#t)
(define arity-analysis
;; Report arity mismatches in the given tree.
(make-tree-analysis
(lambda (x info env locs)
;; Down into X.
(define (extend lexical-name val info)
;; If VAL is a lambda, add NAME to the lexical-lambdas of INFO.
(let ((toplevel-calls (toplevel-procedure-calls info))
(lexical-lambdas (lexical-lambdas info))
(toplevel-lambdas (toplevel-lambdas info)))
(match val
(($ <lambda> src meta body)
(make-arity-info toplevel-calls
(vhash-consq lexical-name val
lexical-lambdas)
toplevel-lambdas))
(($ <lexical-ref> src name gensym)
;; lexical alias
(let ((val* (vhash-assq gensym lexical-lambdas)))
(if (pair? val*)
(extend lexical-name (cdr val*) info)
info)))
(($ <toplevel-ref> src mod name)
;; top-level alias
(make-arity-info toplevel-calls
(vhash-consq lexical-name val
lexical-lambdas)
toplevel-lambdas))
(_ info))))
(let ((toplevel-calls (toplevel-procedure-calls info))
(lexical-lambdas (lexical-lambdas info))
(toplevel-lambdas (toplevel-lambdas info)))
(match x
(($ <toplevel-define> src mod name exp)
(match exp
(($ <lambda> src' meta body)
(make-arity-info toplevel-calls
lexical-lambdas
(vhash-consq name exp toplevel-lambdas)))
(($ <toplevel-ref> src' mod name)
;; alias for another toplevel
(let ((proc (vhash-assq name toplevel-lambdas)))
(make-arity-info toplevel-calls
lexical-lambdas
(vhash-consq (toplevel-define-name x)
(if (pair? proc)
(cdr proc)
exp)
toplevel-lambdas))))
(_ info)))
(($ <let> src names gensyms vals)
(fold extend info gensyms vals))
(($ <letrec> src in-order? names gensyms vals)
(fold extend info gensyms vals))
(($ <fix> src names gensyms vals)
(fold extend info gensyms vals))
(($ <call> src proc args)
(match proc
(($ <lambda> src' meta body)
(validate-arity proc x #t)
info)
(($ <toplevel-ref> src' mod name)
(make-arity-info (vhash-consq name x toplevel-calls)
lexical-lambdas
toplevel-lambdas))
(($ <lexical-ref> src' name gensym)
(match (vhash-assq gensym lexical-lambdas)
((gensym . ($ <toplevel-ref> src'' mod name'))
;; alias to toplevel
(make-arity-info (vhash-consq name' x toplevel-calls)
lexical-lambdas
toplevel-lambdas))
((gensym . proc)
(validate-arity proc x #t)
info)
(#f
;; If GENSYM wasn't found, it may be because it's an
;; argument of the procedure being compiled.
info)))
(_ info)))
(_ info))))
(lambda (x info env locs)
;; Up from X.
(define (shrink name val info)
;; Remove NAME from the lexical-lambdas of INFO.
(let ((toplevel-calls (toplevel-procedure-calls info))
(lexical-lambdas (lexical-lambdas info))
(toplevel-lambdas (toplevel-lambdas info)))
(make-arity-info toplevel-calls
(if (vhash-assq name lexical-lambdas)
(vlist-tail lexical-lambdas)
lexical-lambdas)
toplevel-lambdas)))
(let ((toplevel-calls (toplevel-procedure-calls info))
(lexical-lambdas (lexical-lambdas info))
(toplevel-lambdas (toplevel-lambdas info)))
(match x
(($ <let> src names gensyms vals)
(fold shrink info gensyms vals))
(($ <letrec> src in-order? names gensyms vals)
(fold shrink info gensyms vals))
(($ <fix> src names gensyms vals)
(fold shrink info gensyms vals))
(_ info))))
(lambda (result env)
;; Post-processing: check all top-level procedure calls that have been
;; encountered.
(let ((toplevel-calls (toplevel-procedure-calls result))
(toplevel-lambdas (toplevel-lambdas result)))
(vlist-for-each
(lambda (name+call)
(let* ((name (car name+call))
(call (cdr name+call))
(proc
(or (and=> (vhash-assq name toplevel-lambdas) cdr)
(and (module? env)
(false-if-exception
(module-ref env name)))))
(proc*
;; handle toplevel aliases
(if (toplevel-ref? proc)
(let ((name (toplevel-ref-name proc)))
(and (module? env)
(false-if-exception
(module-ref env name))))
proc)))
(cond ((lambda? proc*)
(validate-arity proc* call #t))
((procedure? proc*)
(validate-arity proc* call #f)))))
toplevel-calls)))
(make-arity-info vlist-null vlist-null vlist-null)))
;;;
;;; `format' argument analysis.
;;;
(define &syntax-error
;; The `throw' key for syntax errors.
(gensym "format-string-syntax-error"))
(define (format-string-argument-count fmt)
;; Return the minimum and maxium number of arguments that should
;; follow format string FMT (or, ahem, a good estimate thereof) or
;; `any' if the format string can be followed by any number of
;; arguments.
(define (drop-group chars end)
;; Drop characters from CHARS until "~END" is encountered.
(let loop ((chars chars)
(tilde? #f))
(if (null? chars)
(throw &syntax-error 'unterminated-iteration)
(if tilde?
(if (eq? (car chars) end)
(cdr chars)
(loop (cdr chars) #f))
(if (eq? (car chars) #\~)
(loop (cdr chars) #t)
(loop (cdr chars) #f))))))
(define (digit? char)
;; Return true if CHAR is a digit, #f otherwise.
(memq char '(#\0 #\1 #\2 #\3 #\4 #\5 #\6 #\7 #\8 #\9)))
(define (previous-number chars)
;; Return the previous series of digits found in CHARS.
(let ((numbers (take-while digit? chars)))
(and (not (null? numbers))
(string->number (list->string (reverse numbers))))))
(let loop ((chars (string->list fmt))
(state 'literal)
(params '())
(conditions '())
(end-group #f)
(min-count 0)
(max-count 0))
(if (null? chars)
(if end-group
(throw &syntax-error 'unterminated-conditional)
(values min-count max-count))
(case state
((tilde)
(case (car chars)
((#\~ #\% #\& #\t #\T #\_ #\newline #\( #\) #\! #\| #\/ #\q #\Q)
(loop (cdr chars) 'literal '()
conditions end-group
min-count max-count))
((#\0 #\1 #\2 #\3 #\4 #\5 #\6 #\7 #\8 #\9 #\, #\: #\@ #\+ #\- #\#)
(loop (cdr chars)
'tilde (cons (car chars) params)
conditions end-group
min-count max-count))
((#\v #\V) (loop (cdr chars)
'tilde (cons (car chars) params)
conditions end-group
(+ 1 min-count)
(+ 1 max-count)))
((#\p #\P) (let* ((colon? (memq #\: params))
(min-count (if colon?
(max 1 min-count)
(+ 1 min-count))))
(loop (cdr chars) 'literal '()
conditions end-group
min-count
(if colon?
(max max-count min-count)
(+ 1 max-count)))))
((#\[)
(loop chars 'literal '() '()
(let ((selector (previous-number params))
(at? (memq #\@ params)))
(lambda (chars conds)
;; end of group
(let ((mins (map car conds))
(maxs (map cdr conds))
(sel? (and selector
(< selector (length conds)))))
(if (and (every number? mins)
(every number? maxs))
(loop chars 'literal '() conditions end-group
(+ min-count
(if sel?
(car (list-ref conds selector))
(+ (if at? 0 1)
(if (null? mins)
0
(apply min mins)))))
(+ max-count
(if sel?
(cdr (list-ref conds selector))
(+ (if at? 0 1)
(if (null? maxs)
0
(apply max maxs))))))
(values 'any 'any))))) ;; XXX: approximation
0 0))
((#\;)
(if end-group
(loop (cdr chars) 'literal '()
(cons (cons min-count max-count) conditions)
end-group
0 0)
(throw &syntax-error 'unexpected-semicolon)))
((#\])
(if end-group
(end-group (cdr chars)
(reverse (cons (cons min-count max-count)
conditions)))
(throw &syntax-error 'unexpected-conditional-termination)))
((#\{) (if (memq #\@ params)
(values min-count 'any)
(loop (drop-group (cdr chars) #\})
'literal '()
conditions end-group
(+ 1 min-count) (+ 1 max-count))))
((#\*) (if (memq #\@ params)
(values 'any 'any) ;; it's unclear what to do here
(loop (cdr chars)
'literal '()
conditions end-group
(+ (or (previous-number params) 1)
min-count)
(+ (or (previous-number params) 1)
max-count))))
((#\? #\k #\K)
;; We don't have enough info to determine the exact number
;; of args, but we could determine a lower bound (TODO).
(values 'any 'any))
((#\^)
(values min-count 'any))
((#\h #\H)
(let ((argc (if (memq #\: params) 2 1)))
(loop (cdr chars) 'literal '()
conditions end-group
(+ argc min-count)
(+ argc max-count))))
((#\')
(if (null? (cdr chars))
(throw &syntax-error 'unexpected-termination)
(loop (cddr chars) 'tilde (cons (cadr chars) params)
conditions end-group min-count max-count)))
(else (loop (cdr chars) 'literal '()
conditions end-group
(+ 1 min-count) (+ 1 max-count)))))
((literal)
(case (car chars)
((#\~) (loop (cdr chars) 'tilde '()
conditions end-group
min-count max-count))
(else (loop (cdr chars) 'literal '()
conditions end-group
min-count max-count))))
(else (error "computer bought the farm" state))))))
(define (proc-ref? exp proc special-name env)
"Return #t when EXP designates procedure PROC in ENV. As a last
resort, return #t when EXP refers to the global variable SPECIAL-NAME."
(define special?
(cut eq? <> special-name))
(match exp
(($ <toplevel-ref> _ _ (? special?))
;; Allow top-levels like: (define G_ (cut gettext <> "my-domain")).
#t)
(($ <toplevel-ref> _ _ name)
(let ((var (module-variable env name)))
(and var (variable-bound? var)
(eq? (variable-ref var) proc))))
(($ <module-ref> _ _ (? special?))
#t)
(($ <module-ref> _ module name public?)
(let* ((mod (if public?
(false-if-exception (resolve-interface module))
(resolve-module module #:ensure #f)))
(var (and mod (module-variable mod name))))
(and var (variable-bound? var) (eq? (variable-ref var) proc))))
(($ <lexical-ref> _ (? special?))
#t)
(_ #f)))
(define gettext? (cut proc-ref? <> gettext 'G_ <>))
(define ngettext? (cut proc-ref? <> ngettext 'N_ <>))
(define (const-fmt x env)
;; Return the literal format string for X, or #f.
(match x
(($ <const> _ (? string? exp))
exp)
(($ <call> _ (? (cut gettext? <> env))
(($ <const> _ (? string? fmt))))
;; Gettexted literals, like `(G_ "foo")'.
fmt)
(($ <call> _ (? (cut ngettext? <> env))
(($ <const> _ (? string? fmt)) ($ <const> _ (? string?)) _ ..1))
;; Plural gettextized literals, like `(N_ "singular" "plural" n)'.
;; TODO: Check whether the singular and plural strings have the
;; same format escapes.
fmt)
(_ #f)))
(define format-analysis
;; Report arity mismatches in the given tree.
(make-tree-analysis
(lambda (x res env locs)
;; Down into X.
(define (check-format-args args loc)
(pmatch args
((,port ,fmt . ,rest)
(guard (const-fmt fmt env))
(if (and (const? port)
(not (boolean? (const-exp port))))
(warning 'format loc 'wrong-port (const-exp port)))
(let ((fmt (const-fmt fmt env))
(count (length rest)))
(catch &syntax-error
(lambda ()
(let-values (((min max)
(format-string-argument-count fmt)))
(and min max
(or (and (or (eq? min 'any) (>= count min))
(or (eq? max 'any) (<= count max)))
(warning 'format loc 'wrong-format-arg-count
fmt min max count)))))
(lambda (_ key)
(warning 'format loc 'syntax-error key fmt)))))
((,port ,fmt . ,rest)
(if (and (const? port)
(not (boolean? (const-exp port))))
(warning 'format loc 'wrong-port (const-exp port)))
(match fmt
(($ <const> loc* (? (negate string?) fmt))
(warning 'format (or loc* loc) 'wrong-format-string fmt))
;; Warn on non-literal format strings, unless they refer to
;; a lexical variable named "fmt".
(($ <lexical-ref> _ fmt)
#t)
((? (negate const?))
(warning 'format loc 'non-literal-format-string))))
(else
(warning 'format loc 'wrong-num-args (length args)))))
(define (check-simple-format-args args loc)
;; Check the arguments to the `simple-format' procedure, which is
;; less capable than that of (ice-9 format).
(define allowed-chars
'(#\A #\S #\a #\s #\~ #\%))
(define (format-chars fmt)
(let loop ((chars (string->list fmt))
(result '()))
(match chars
(()
(reverse result))
((#\~ opt rest ...)
(loop rest (cons opt result)))
((_ rest ...)
(loop rest result)))))
(match args
((port ($ <const> _ (? string? fmt)) _ ...)
(let ((opts (format-chars fmt)))
(or (every (cut memq <> allowed-chars) opts)
(begin
(warning 'format loc 'simple-format fmt
(find (negate (cut memq <> allowed-chars)) opts))
#f))))
((port (= (cut const-fmt <> env) (? string? fmt)) args ...)
(check-simple-format-args `(,port ,(make-const loc fmt) ,args) loc))
(_ #t)))
(define (resolve-toplevel name)
(and (module? env)
(false-if-exception (module-ref env name))))
(match x
(($ <call> src ($ <toplevel-ref> _ _ name) args)
(let ((proc (resolve-toplevel name)))
(if (or (and (eq? proc (@ (guile) simple-format))
(check-simple-format-args args
(or src (find pair? locs))))
(eq? proc (@ (ice-9 format) format)))
(check-format-args args (or src (find pair? locs))))))
(($ <call> src ($ <module-ref> _ '(ice-9 format) 'format) args)
(check-format-args args (or src (find pair? locs))))
(($ <call> src ($ <module-ref> _ '(guile)
(or 'format 'simple-format))
args)
(and (check-simple-format-args args
(or src (find pair? locs)))
(check-format-args args (or src (find pair? locs)))))
(_ #t))
#t)
(lambda (x _ env locs)
;; Up from X.
#t)
(lambda (_ env)
;; Post-processing.
#t)
#t))
(begin-deprecated
(define-syntax unbound-variable-analysis
(identifier-syntax
(begin
(issue-deprecation-warning
"`unbound-variable-analysis' is deprecated. "
"Use `make-use-before-definition-analysis' instead.")
(make-use-before-definition-analysis
#:enabled-warnings '(unbound-variable)))))
(define-syntax macro-use-before-definition-analysis
(identifier-syntax
(begin
(issue-deprecation-warning
"`macro-use-before-definition-analysis' is deprecated. "
"Use `make-use-before-definition-analysis' instead.")
(make-use-before-definition-analysis
#:enabled-warnings '(macro-use-before-definition)))))
(export unbound-variable-analysis
macro-use-before-definition-analysis))
(define-syntax-rule (define-analysis make-analysis
#:level level #:kind kind #:analysis analysis)
(define* (make-analysis #:key (warning-level 0) (enabled-warnings '()))
(and (or (<= level warning-level)
(memq 'kind enabled-warnings))
analysis)))
(define-analysis make-unused-variable-analysis
#:level 3 #:kind unused-variable #:analysis unused-variable-analysis)
(define-analysis make-unused-toplevel-analysis
#:level 2 #:kind unused-toplevel #:analysis unused-toplevel-analysis)
(define-analysis make-unused-module-analysis
#:level 2 #:kind unused-module #:analysis unused-module-analysis)
(define-analysis make-shadowed-toplevel-analysis
#:level 2 #:kind shadowed-toplevel #:analysis shadowed-toplevel-analysis)
(define-analysis make-arity-analysis
#:level 1 #:kind arity-mismatch #:analysis arity-analysis)
(define-analysis make-format-analysis
#:level 1 #:kind format #:analysis format-analysis)
(define (make-analyzer warning-level warnings)
(define-syntax compute-analyses
(syntax-rules ()
((_) '())
((_ make-analysis . make-analysis*)
(let ((tail (compute-analyses . make-analysis*)))
(match (make-analysis #:warning-level warning-level
#:enabled-warnings warnings)
(#f tail)
(analysis (cons analysis tail)))))))
(let ((analyses (compute-analyses make-unused-variable-analysis
make-unused-toplevel-analysis
make-unused-module-analysis
make-shadowed-toplevel-analysis
make-arity-analysis
make-format-analysis
make-use-before-definition-analysis)))
(lambda (exp env)
(analyze-tree analyses exp env))))
|