Have `-Wformat' remain quiet for any procedure called `_' or `N_'.
[bpt/guile.git] / module / language / tree-il / analyze.scm
index c5f6cb9..c3ff9e2 100644 (file)
@@ -1,6 +1,6 @@
 ;;; TREE-IL -> GLIL compiler
 
-;; Copyright (C) 2001,2008,2009,2010 Free Software Foundation, Inc.
+;; Copyright (C) 2001, 2008, 2009, 2010, 2011, 2012 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
@@ -22,7 +22,9 @@
   #: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)
@@ -33,7 +35,8 @@
             unused-variable-analysis
             unused-toplevel-analysis
             unbound-variable-analysis
-            arity-analysis))
+            arity-analysis
+            format-analysis))
 
 ;; Allocation is the process of assigning storage locations for lexical
 ;; variables. A lexical variable has a distinct "address", or storage
 
   ;; returns variables referenced in expr
   (define (analyze! x proc labels-in-proc tail? tail-call-args)
-    (define (step y) (analyze! y proc labels-in-proc #f #f))
+    (define (step y) (analyze! y proc '() #f #f))
     (define (step-tail y) (analyze! y proc labels-in-proc tail? #f))
     (define (step-tail-call y args) (analyze! y proc labels-in-proc #f
                                               (and tail? args)))
          (hashq-set! free-vars x free)
          free))
       
-      ((<lambda-case> opt kw inits vars body alternate)
+      ((<lambda-case> opt kw inits gensyms body alternate)
        (hashq-set! bound-vars proc
-                   (append (reverse vars) (hashq-ref bound-vars proc)))
+                   (append (reverse gensyms) (hashq-ref bound-vars proc)))
        (lset-union
         eq?
         (lset-difference eq?
                          (lset-union eq?
                                      (apply lset-union eq? (map step inits))
                                      (step-tail body))
-                         vars)
+                         gensyms)
         (if alternate (step-tail alternate) '())))
       
-      ((<let> vars vals body)
+      ((<let> gensyms vals body)
        (hashq-set! bound-vars proc
-                   (append (reverse vars) (hashq-ref bound-vars proc)))
+                   (append (reverse gensyms) (hashq-ref bound-vars proc)))
        (lset-difference eq?
                         (apply lset-union eq? (step-tail body) (map step vals))
-                        vars))
+                        gensyms))
       
-      ((<letrec> vars vals body)
+      ((<letrec> gensyms vals body)
        (hashq-set! bound-vars proc
-                   (append (reverse vars) (hashq-ref bound-vars proc)))
-       (for-each (lambda (sym) (hashq-set! assigned sym #t)) vars)
+                   (append (reverse gensyms) (hashq-ref bound-vars proc)))
+       (for-each (lambda (sym) (hashq-set! assigned sym #t)) gensyms)
        (lset-difference eq?
                         (apply lset-union eq? (step-tail body) (map step vals))
-                        vars))
+                        gensyms))
       
-      ((<fix> vars vals body)
+      ((<fix> gensyms vals body)
        ;; Try to allocate these procedures as labels.
        (for-each (lambda (sym val) (hashq-set! labels sym val))
-                 vars vals)
+                 gensyms vals)
        (hashq-set! bound-vars proc
-                   (append (reverse vars) (hashq-ref bound-vars proc)))
+                   (append (reverse gensyms) (hashq-ref bound-vars proc)))
        ;; Step into subexpressions.
        (let* ((var-refs
                (map
                      ;; just like the closure case, except here we use
                      ;; recur/labels instead of recur
                      (hashq-set! bound-vars x '())
-                     (let ((free (recur/labels body x vars)))
+                     (let ((free (recur/labels body x gensyms)))
                        (hashq-set! bound-vars x (reverse! (hashq-ref bound-vars x)))
                        (hashq-set! free-vars x free)
                        free))))
                 vals))
-              (vars-with-refs (map cons vars var-refs))
-              (body-refs (recur/labels body proc vars)))
+              (vars-with-refs (map cons gensyms var-refs))
+              (body-refs (recur/labels body proc gensyms)))
          (define (delabel-dependents! sym)
            (let ((refs (assq-ref vars-with-refs sym)))
              (if refs
          (for-each (lambda (sym)
                      (if (not (hashq-ref labels sym))
                          (delabel-dependents! sym)))
-                   vars)
+                   gensyms)
          ;; Now lift bound variables with label-allocated lambdas to the
          ;; parent procedure.
          (for-each
                                       (hashq-ref bound-vars proc)))
                   (hashq-remove! bound-vars val)
                   (hashq-remove! free-vars val))))
-          vars vals)
+          gensyms vals)
          (lset-difference eq?
                           (apply lset-union eq? body-refs var-refs)
-                          vars)))
+                          gensyms)))
       
       ((<let-values> exp body)
        (lset-union eq? (step exp) (step body)))
        (lset-union eq? (step fluid) (step exp)))
       
       ((<prompt> tag body handler)
-       (lset-union eq? (step tag) (step handler)))
+       (lset-union eq? (step tag) (step body) (step-tail handler)))
       
-      ((<abort> tag args)
-       (apply lset-union eq? (step tag) (map step args)))
+      ((<abort> tag args tail)
+       (apply lset-union eq? (step tag) (step tail) (map step args)))
       
       (else '())))
   
   ;; allocation: sym -> {lambda -> address}
-  ;;             lambda -> (nlocs labels . free-locs)
+  ;;             lambda -> (labels . free-locs)
+  ;;             lambda-case -> (gensym . nlocs)
   (define allocation (make-hash-table))
   
   (define (allocate! x proc n)
          (hashq-set! allocation x (cons labels free-addresses)))
        n)
 
-      ((<lambda-case> opt kw inits vars body alternate)
+      ((<lambda-case> opt kw inits gensyms body alternate)
        (max
-        (let lp ((vars vars) (n n))
-          (if (null? vars)
+        (let lp ((gensyms gensyms) (n n))
+          (if (null? gensyms)
               (let ((nlocs (apply
                             max
                             (allocate! body proc n)
                 (hashq-set! allocation x (cons (gensym ":LCASE") nlocs))
                 nlocs)
               (begin
-                (hashq-set! allocation (car vars)
+                (hashq-set! allocation (car gensyms)
                             (make-hashq
-                             proc `(#t ,(hashq-ref assigned (car vars)) . ,n)))
-                (lp (cdr vars) (1+ n)))))
+                             proc `(#t ,(hashq-ref assigned (car gensyms)) . ,n)))
+                (lp (cdr gensyms) (1+ n)))))
         (if alternate (allocate! alternate proc n) n)))
       
-      ((<let> vars vals body)
+      ((<let> gensyms vals body)
        (let ((nmax (apply max (map recur vals))))
          (cond
           ;; the `or' hack
           ((and (conditional? body)
-                (= (length vars) 1)
-                (let ((v (car vars)))
+                (= (length gensyms) 1)
+                (let ((v (car gensyms)))
                   (and (not (hashq-ref assigned v))
                        (= (hashq-ref refcounts v 0) 2)
                        (lexical-ref? (conditional-test body))
                        (eq? (lexical-ref-gensym (conditional-test body)) v)
                        (lexical-ref? (conditional-consequent body))
                        (eq? (lexical-ref-gensym (conditional-consequent body)) v))))
-           (hashq-set! allocation (car vars)
+           (hashq-set! allocation (car gensyms)
                        (make-hashq proc `(#t #f . ,n)))
            ;; the 1+ for this var
            (max nmax (1+ n) (allocate! (conditional-alternate body) proc n)))
           (else
-           (let lp ((vars vars) (n n))
-             (if (null? vars)
+           (let lp ((gensyms gensyms) (n n))
+             (if (null? gensyms)
                  (max nmax (allocate! body proc n))
-                 (let ((v (car vars)))
+                 (let ((v (car gensyms)))
                    (hashq-set!
                     allocation v
                     (make-hashq proc
                                 `(#t ,(hashq-ref assigned v) . ,n)))
-                   (lp (cdr vars) (1+ n)))))))))
+                   (lp (cdr gensyms) (1+ n)))))))))
       
-      ((<letrec> vars vals body)
-       (let lp ((vars vars) (n n))
-         (if (null? vars)
+      ((<letrec> gensyms vals body)
+       (let lp ((gensyms gensyms) (n n))
+         (if (null? gensyms)
              (let ((nmax (apply max
                                 (map (lambda (x)
                                        (allocate! x proc n))
                                      vals))))
                (max nmax (allocate! body proc n)))
-             (let ((v (car vars)))
+             (let ((v (car gensyms)))
                (hashq-set!
                 allocation v
                 (make-hashq proc
                             `(#t ,(hashq-ref assigned v) . ,n)))
-               (lp (cdr vars) (1+ n))))))
+               (lp (cdr gensyms) (1+ n))))))
 
-      ((<fix> vars vals body)
-       (let lp ((in vars) (n n))
+      ((<fix> gensyms vals body)
+       (let lp ((in gensyms) (n n))
          (if (null? in)
-             (let lp ((vars vars) (vals vals) (nmax n))
+             (let lp ((gensyms gensyms) (vals vals) (nmax n))
                (cond
-                ((null? vars)
+                ((null? gensyms)
                  (max nmax (allocate! body proc n)))
-                ((hashq-ref labels (car vars))                 
+                ((hashq-ref labels (car gensyms))                 
                  ;; allocate lambda body inline to proc
-                 (lp (cdr vars)
+                 (lp (cdr gensyms)
                      (cdr vals)
                      (record-case (car vals)
                        ((<lambda> body)
                         (max nmax (allocate! body proc n))))))
                 (else
                  ;; allocate closure
-                 (lp (cdr vars)
+                 (lp (cdr gensyms)
                      (cdr vals)
                      (max nmax (allocate! (car vals) proc n))))))
              
       
       ((<prompt> tag body handler)
        (let ((cont-var (and (lambda-case? handler)
-                            (pair? (lambda-case-vars handler))
-                            (car (lambda-case-vars handler)))))
+                            (pair? (lambda-case-gensyms handler))
+                            (car (lambda-case-gensyms handler)))))
          (hashq-set! allocation x
                      (and cont-var (zero? (hashq-ref refcounts cont-var 0))))
          (max (recur tag) (recur body) (recur handler))))
       
-      ((<abort> tag args)
-       (apply max (recur tag) (map recur args)))
+      ((<abort> tag args tail)
+       (apply max (recur tag) (recur tail) (map recur args)))
       
       (else n)))
 
@@ -601,6 +605,10 @@ accurate information is missing from a given `tree-il' element."
   (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
@@ -629,18 +637,18 @@ accurate information is missing from a given `tree-il' element."
        (record-case x
          ((<lexical-set> gensym)
           (make-binding-info vars (vhash-consq gensym #t refs)))
-         ((<lambda-case> req opt inits rest kw vars)
+         ((<lambda-case> req opt inits rest kw gensyms)
           (let ((names `(,@req
                          ,@(or opt '())
                          ,@(if rest (list rest) '())
                          ,@(if kw (map cadr (cdr kw)) '()))))
-            (make-binding-info (extend vars names) refs)))
-         ((<let> vars names)
-          (make-binding-info (extend vars names) refs))
-         ((<letrec> vars names)
-          (make-binding-info (extend vars names) refs))
-         ((<fix> vars names)
-          (make-binding-info (extend vars names) refs))
+            (make-binding-info (extend gensyms names) refs)))
+         ((<let> gensyms names)
+          (make-binding-info (extend gensyms names) refs))
+         ((<letrec> gensyms names)
+          (make-binding-info (extend gensyms names) refs))
+         ((<fix> gensyms names)
+          (make-binding-info (extend gensyms names) refs))
          (else info))))
 
    (lambda (x info env locs)
@@ -661,7 +669,9 @@ accurate information is missing from a given `tree-il' element."
                         ;; the LOCS location stack.
                         (loc  (or (caddr var)
                                   (find pair? locs))))
-                    (warning 'unused-variable loc name)))))
+                    (if (and (not (gensym? name))
+                             (not (eq? name '_)))
+                        (warning 'unused-variable loc name))))))
           vars)
          (vlist-drop vars (length inner-vars)))
 
@@ -670,14 +680,14 @@ accurate information is missing from a given `tree-il' element."
        ;; It doesn't hurt as these are unique names, it just
        ;; makes REFS unnecessarily fat.
        (record-case x
-         ((<lambda-case> vars)
-          (make-binding-info (shrink vars refs) refs))
-         ((<let> vars)
-          (make-binding-info (shrink vars refs) refs))
-         ((<letrec> vars)
-          (make-binding-info (shrink vars refs) refs))
-         ((<fix> vars)
-          (make-binding-info (shrink vars refs) refs))
+         ((<lambda-case> gensyms)
+          (make-binding-info (shrink gensyms refs) refs))
+         ((<let> gensyms)
+          (make-binding-info (shrink gensyms refs) refs))
+         ((<letrec> gensyms)
+          (make-binding-info (shrink gensyms refs) refs))
+         ((<fix> gensyms)
+          (make-binding-info (shrink gensyms refs) refs))
          (else info))))
 
    (lambda (result env) #t)
@@ -834,7 +844,8 @@ accurate information is missing from a given `tree-il' element."
            (vlist-for-each (lambda (name+loc)
                              (let ((name (car name+loc))
                                    (loc  (cdr name+loc)))
-                               (warning 'unused-toplevel loc name)))
+                               (if (not (gensym? name))
+                                   (warning 'unused-toplevel loc name))))
                            unused))))
 
      (make-reference-graph vlist-null vlist-null #f))))
@@ -859,25 +870,20 @@ accurate information is missing from a given `tree-il' element."
   ;; the name of the variable being defined; otherwise return #f.  This
   ;; assumes knowledge of the current implementation of `define-class' et al.
   (define (toplevel-define-arg args)
-    (and (pair? args) (pair? (cdr args)) (null? (cddr args))
-         (record-case (car args)
-           ((<const> exp)
-            (and (symbol? exp) exp))
-           (else #f))))
-
-  (record-case proc
-    ((<module-ref> mod public? name)
-     (and (equal? mod '(oop goops))
-          (not public?)
-          (eq? name 'toplevel-define!)
-          (toplevel-define-arg args)))
-    ((<toplevel-ref> name)
+    (match args
+      ((($ <const> _ (and (? symbol?) exp)) _)
+       exp)
+      (_ #f)))
+
+  (match proc
+    (($ <module-ref> _ '(oop goops) 'toplevel-define! #f)
+     (toplevel-define-arg args))
+    (($ <toplevel-ref> _ 'toplevel-define!)
      ;; This may be the result of expanding one of the GOOPS macros within
      ;; `oop/goops.scm'.
-     (and (eq? name 'toplevel-define!)
-          (eq? env (resolve-module '(oop goops)))
+     (and (eq? env (resolve-module '(oop goops)))
           (toplevel-define-arg args)))
-    (else #f)))
+    (_ #f)))
 
 (define unbound-variable-analysis
   ;; Report possibly unbound variables in the given tree.
@@ -918,7 +924,7 @@ accurate information is missing from a given `tree-il' element."
                 (make-toplevel-info (vhash-consq name src refs)
                                     defs))))
          ((<toplevel-define> name)
-          (make-toplevel-info (vhash-delete name refs eq?)
+          (make-toplevel-info (vhash-delq name refs)
                               (vhash-consq name #t defs)))
 
          ((<application> proc args)
@@ -927,8 +933,7 @@ accurate information is missing from a given `tree-il' element."
           (let ((name (goops-toplevel-definition proc args
                                                  env)))
             (if (symbol? name)
-                (make-toplevel-info (vhash-delete name refs
-                                                  eq?)
+                (make-toplevel-info (vhash-delq name refs)
                                     (vhash-consq name #t defs))
                 (make-toplevel-info refs defs))))
          (else
@@ -996,14 +1001,14 @@ accurate information is missing from a given `tree-il' element."
                (length x))
           0))
     (cond ((program? proc)
-           (values (program-name proc)
+           (values (procedure-name proc)
                    (map (lambda (a)
                           (list (arity:nreq a) (arity:nopt a) (arity:rest? a)
                                 (map car (arity:kw a))
                                 (arity:allow-other-keys? a)))
                         (program-arities proc))))
           ((procedure? proc)
-           (let ((arity (procedure-property proc 'arity)))
+           (let ((arity (procedure-minimum-arity proc)))
              (values (procedure-name proc)
                      (list (list (car arity) (cadr arity) (caddr arity)
                                  #f #f)))))
@@ -1106,12 +1111,12 @@ accurate information is missing from a given `tree-il' element."
                                                  exp)
                                              toplevel-lambdas))))
             (else info)))
-         ((<let> vars vals)
-          (fold extend info vars vals))
-         ((<letrec> vars vals)
-          (fold extend info vars vals))
-         ((<fix> vars vals)
-          (fold extend info vars vals))
+         ((<let> gensyms vals)
+          (fold extend info gensyms vals))
+         ((<letrec> gensyms vals)
+          (fold extend info gensyms vals))
+         ((<fix> gensyms vals)
+          (fold extend info gensyms vals))
 
          ((<application> proc args src)
           (record-case proc
@@ -1158,12 +1163,12 @@ accurate information is missing from a given `tree-il' element."
            (lexical-lambdas  (lexical-lambdas info))
            (toplevel-lambdas (toplevel-lambdas info)))
        (record-case x
-         ((<let> vars vals)
-          (fold shrink info vars vals))
-         ((<letrec> vars vals)
-          (fold shrink info vars vals))
-         ((<fix> vars vals)
-          (fold shrink info vars vals))
+         ((<let> gensyms vals)
+          (fold shrink info gensyms vals))
+         ((<letrec> gensyms vals)
+          (fold shrink info gensyms vals))
+         ((<fix> gensyms vals)
+          (fold shrink info gensyms vals))
 
          (else info))))
 
@@ -1189,8 +1194,320 @@ accurate information is missing from a given `tree-il' element."
                              (false-if-exception
                               (module-ref env name))))
                       proc)))
-            (if (or (lambda? proc*) (procedure? proc*))
-                (validate-arity proc* application (lambda? proc*)))))
+            (cond ((lambda? proc*)
+                   (validate-arity proc* application #t))
+                  ((struct? proc*)
+                   ;; An applicable struct.
+                   (let ((p (struct-ref proc* 0)))
+                     (and (procedure? p)
+                          (validate-arity p application #f))))
+                  ((procedure? proc*)
+                   (validate-arity proc* application #f)))))
         toplevel-calls)))
 
    (make-arity-info vlist-null vlist-null vlist-null)))
+
+\f
+;;;
+;;; `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 #\_ #\newline #\( #\))
+                        (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)))
+             ((#\[)
+              (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)
+              ;; We don't have enough info to determine the exact number
+              ;; of args, but we could determine a lower bound (TODO).
+              (values 'any 'any))
+             ((#\h #\H)
+                        (let ((argc (if (memq #\: params) 2 1)))
+                          (loop (cdr chars) 'literal '()
+                                conditions end-group
+                                (+ argc min-count)
+                                (+ argc 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 _ (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 '_ <>))
+(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)
+    (($ <application> _ (? (cut gettext? <> env))
+        (($ <const> _ (? string? fmt))))
+     ;; Gettexted literals, like `(_ "foo")'.
+     fmt)
+    (($ <application> _ (? (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 _ env locs)
+     ;; X is a leaf.
+     #t)
+
+   (lambda (x _ 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
+       (($ <application> 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))))))
+       (($ <application> src ($ <module-ref> _ '(ice-9 format) 'format) args)
+        (check-format-args args (or src (find pair? locs))))
+       (($ <application> 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))