lisp-build.lisp 40.5 KB
Newer Older
1 2 3
;;;; -------------------------------------------------------------------------
;;;; Support to build (compile and load) Lisp files

4
(uiop/package:define-package :uiop/lisp-build
5
  (:nicknames :asdf/lisp-build) ;; OBSOLETE, used by slime/contrib/swank-asdf.lisp
6 7
  (:use :uiop/common-lisp :uiop/package :uiop/utility
   :uiop/os :uiop/pathname :uiop/filesystem :uiop/stream :uiop/image)
8
  (:export
9
   ;; Variables
10
   #:*compile-file-warnings-behaviour* #:*compile-file-failure-behaviour*
11
   #:*output-translation-function*
12
   #:*optimization-settings* #:*previous-optimization-settings*
13
   #:*base-build-directory*
14 15 16
   #:compile-condition #:compile-file-error #:compile-warned-error #:compile-failed-error
   #:compile-warned-warning #:compile-failed-warning
   #:check-lisp-compile-results #:check-lisp-compile-warnings
17 18
   #:*uninteresting-conditions* #:*usual-uninteresting-conditions*
   #:*uninteresting-compiler-conditions* #:*uninteresting-loader-conditions*
19 20
   ;; Types
   #+sbcl #:sb-grovel-unknown-constant-condition
21
   ;; Functions & Macros
22
   #:get-optimization-settings #:proclaim-optimization-settings #:with-optimization-settings
23 24
   #:call-with-muffled-compiler-conditions #:with-muffled-compiler-conditions
   #:call-with-muffled-loader-conditions #:with-muffled-loader-conditions
25
   #:reify-simple-sexp #:unreify-simple-sexp
26
   #:reify-deferred-warnings #:unreify-deferred-warnings
27
   #:reset-deferred-warnings #:save-deferred-warnings #:check-deferred-warnings
28
   #:with-saved-deferred-warnings #:warnings-file-p #:warnings-file-type #:*warnings-file-type*
29
   #:enable-deferred-warnings-check #:disable-deferred-warnings-check
30 31
   #:current-lisp-file-pathname #:load-pathname
   #:lispize-pathname #:compile-file-type #:call-around-hook
32
   #:compile-file* #:compile-file-pathname* #:*compile-check*
33
   #:load* #:load-from-string #:combine-fasls)
34
  (:intern #:defaults #:failure-p #:warnings-p #:s #:y #:body))
35
(in-package :uiop/lisp-build)
36

37 38 39 40
(with-upgradability ()
  (defvar *compile-file-warnings-behaviour*
    (or #+clisp :ignore :warn)
    "How should ASDF react if it encounters a warning when compiling a file?
41 42
Valid values are :error, :warn, and :ignore.")

43 44 45
  (defvar *compile-file-failure-behaviour*
    (or #+(or mkcl sbcl) :error #+clisp :ignore :warn)
    "How should ASDF react if it encounters a failure (per the ANSI spec of COMPILE-FILE)
46 47
when compiling a file, which includes any non-style-warning warning.
Valid values are :error, :warn, and :ignore.
48
Note that ASDF ALWAYS raises an error if it fails to create an output file when compiling.")
49

50 51 52 53 54
  (defvar *base-build-directory* nil
    "When set to a non-null value, it should be an absolute directory pathname,
which will serve as the *DEFAULT-PATHNAME-DEFAULTS* around a COMPILE-FILE,
what more while the input-file is shortened if possible to ENOUGH-PATHNAME relative to it.
This can help you produce more deterministic output for FASLs."))
55 56

;;; Optimization settings
57
(with-upgradability ()
58 59 60 61
  (defvar *optimization-settings* nil
    "Optimization settings to be used by PROCLAIM-OPTIMIZATION-SETTINGS")
  (defvar *previous-optimization-settings* nil
    "Optimization settings saved by PROCLAIM-OPTIMIZATION-SETTINGS")
62 63
  (defparameter +optimization-variables+
    ;; TODO: allegro genera corman mcl
64 65
    (or #+(or abcl xcl) '(system::*speed* system::*space* system::*safety* system::*debug*)
        #+clisp '() ;; system::*optimize* is a constant hash-table! (with non-constant contents)
66 67
        #+clozure '(ccl::*nx-speed* ccl::*nx-space* ccl::*nx-safety*
                    ccl::*nx-debug* ccl::*nx-cspeed*)
68
        #+(or cmucl scl) '(c::*default-cookie*)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
69
        #+clasp '()
70
        #+ecl (unless (use-ecl-byte-compiler-p) '(c::*speed* c::*space* c::*safety* c::*debug*))
71 72 73 74
        #+gcl '(compiler::*speed* compiler::*space* compiler::*compiler-new-safety* compiler::*debug*)
        #+lispworks '(compiler::*optimization-level*)
        #+mkcl '(si::*speed* si::*space* si::*safety* si::*debug*)
        #+sbcl '(sb-c::*policy*)))
75 76
  (defun get-optimization-settings ()
    "Get current compiler optimization settings, ready to PROCLAIM again"
77
    #-(or abcl allegro clasp clisp clozure cmucl ecl lispworks mkcl sbcl scl xcl)
78 79
    (warn "~S does not support ~S. Please help me fix that."
          'get-optimization-settings (implementation-type))
80 81
    #+(or abcl allegro clasp clisp clozure cmucl ecl lispworks mkcl sbcl scl xcl)
    (let ((settings '(speed space safety debug compilation-speed #+(or cmucl scl) c::brevity)))
82 83 84 85
      #.`(loop #+(or allegro clozure)
               ,@'(:with info = #+allegro (sys:declaration-information 'optimize)
                   #+clozure (ccl:declaration-information 'optimize nil))
               :for x :in settings
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
86
               ,@(or #+(or abcl clasp ecl gcl mkcl xcl) '(:for v :in +optimization-variables+))
87 88
               :for y = (or #+(or allegro clozure) (second (assoc x info)) ; normalize order
                            #+clisp (gethash x system::*optimize* 1)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
89
                            #+(or abcl clasp ecl mkcl xcl) (symbol-value v)
90
                            #+(or cmucl scl) (slot-value c::*default-cookie*
91 92
                                                       (case x (compilation-speed 'c::cspeed)
                                                             (otherwise x)))
93
                            #+lispworks (slot-value compiler::*optimization-level* x)
94
                            #+sbcl (sb-c::policy-quality sb-c::*policy* x))
95 96 97 98 99 100
               :when y :collect (list x y))))
  (defun proclaim-optimization-settings ()
    "Proclaim the optimization settings in *OPTIMIZATION-SETTINGS*"
    (proclaim `(optimize ,@*optimization-settings*))
    (let ((settings (get-optimization-settings)))
      (unless (equal *previous-optimization-settings* settings)
101 102
        (setf *previous-optimization-settings* settings))))
  (defmacro with-optimization-settings ((&optional (settings *optimization-settings*)) &body body)
103
    #+(or allegro clisp)
104 105 106 107 108
    (let ((previous-settings (gensym "PREVIOUS-SETTINGS")))
      `(let ((,previous-settings (get-optimization-settings)))
         ,@(when settings `((proclaim `(optimize ,@,settings))))
         (unwind-protect (progn ,@body)
           (proclaim `(optimize ,@,previous-settings)))))
109
    #-(or allegro clisp)
110 111 112
    `(let ,(loop :for v :in +optimization-variables+ :collect `(,v ,v))
       ,@(when settings `((proclaim `(optimize ,@,settings))))
       ,@body)))
113 114 115


;;; Condition control
116 117 118 119
(with-upgradability ()
  #+sbcl
  (progn
    (defun sb-grovel-unknown-constant-condition-p (c)
120
      "Detect SB-GROVEL unknown-constant conditions on older versions of SBCL"
121 122 123 124 125 126 127 128
      (and (typep c 'sb-int:simple-style-warning)
           (string-enclosed-p
            "Couldn't grovel for "
            (simple-condition-format-control c)
            " (unknown to the C compiler).")))
    (deftype sb-grovel-unknown-constant-condition ()
      '(and style-warning (satisfies sb-grovel-unknown-constant-condition-p))))

129
  (defvar *usual-uninteresting-conditions*
130 131
    (append
     ;;#+clozure '(ccl:compiler-warning)
132
     #+cmucl '("Deleting unreachable code.")
133 134
     #+lispworks '("~S being redefined in ~A (previously in ~A)."
                   "~S defined more than once in ~A.") ;; lispworks gets confused by eval-when.
135 136 137 138
     #+sbcl
     '(sb-c::simple-compiler-note
       "&OPTIONAL and &KEY found in the same lambda list: ~S"
       #+sb-eval sb-kernel:lexical-environment-too-complex
139
       sb-kernel:undefined-alien-style-warning
140
       sb-grovel-unknown-constant-condition ; defined above.
141
       sb-ext:implicit-generic-function-warning ;; Controversial.
142 143
       sb-int:package-at-variance
       sb-kernel:uninteresting-redefinition
144 145 146 147 148 149
       ;; BEWARE: the below four are controversial to include here.
       sb-kernel:redefinition-with-defun
       sb-kernel:redefinition-with-defgeneric
       sb-kernel:redefinition-with-defmethod
       sb-kernel::redefinition-with-defmacro) ; not exported by old SBCLs
     '("No generic function ~S present when encountering macroexpansion of defmethod. Assuming it will be an instance of standard-generic-function.")) ;; from closer2mop
150 151 152
    "A suggested value to which to set or bind *uninteresting-conditions*.")

  (defvar *uninteresting-conditions* '()
153 154 155
    "Conditions that may be skipped while compiling or loading Lisp code.")
  (defvar *uninteresting-compiler-conditions* '()
    "Additional conditions that may be skipped while compiling Lisp code.")
156 157 158 159 160
  (defvar *uninteresting-loader-conditions*
    (append
     '("Overwriting already existing readtable ~S." ;; from named-readtables
       #(#:finalizers-off-warning :asdf-finalizers)) ;; from asdf-finalizers
     #+clisp '(clos::simple-gf-replacing-method-warning))
161
    "Additional conditions that may be skipped while loading Lisp code."))
162 163

;;;; ----- Filtering conditions while building -----
164 165
(with-upgradability ()
  (defun call-with-muffled-compiler-conditions (thunk)
166
    "Call given THUNK in a context where uninteresting conditions and compiler conditions are muffled"
167
    (call-with-muffled-conditions
168
     thunk (append *uninteresting-conditions* *uninteresting-compiler-conditions*)))
169
  (defmacro with-muffled-compiler-conditions ((&optional) &body body)
170
    "Trivial syntax for CALL-WITH-MUFFLED-COMPILER-CONDITIONS"
171 172
    `(call-with-muffled-compiler-conditions #'(lambda () ,@body)))
  (defun call-with-muffled-loader-conditions (thunk)
173
    "Call given THUNK in a context where uninteresting conditions and loader conditions are muffled"
174
    (call-with-muffled-conditions
175
     thunk (append *uninteresting-conditions* *uninteresting-loader-conditions*)))
176
  (defmacro with-muffled-loader-conditions ((&optional) &body body)
177
    "Trivial syntax for CALL-WITH-MUFFLED-LOADER-CONDITIONS"
178
    `(call-with-muffled-loader-conditions #'(lambda () ,@body))))
179

180

181
;;;; Handle warnings and failures
182 183 184 185 186 187 188 189 190
(with-upgradability ()
  (define-condition compile-condition (condition)
    ((context-format
      :initform nil :reader compile-condition-context-format :initarg :context-format)
     (context-arguments
      :initform nil :reader compile-condition-context-arguments :initarg :context-arguments)
     (description
      :initform nil :reader compile-condition-description :initarg :description))
    (:report (lambda (c s)
191 192 193 194
               (format s (compatfmt "~@<~A~@[ while ~?~]~@:>")
                       (or (compile-condition-description c) (type-of c))
                       (compile-condition-context-format c)
                       (compile-condition-context-arguments c)))))
195 196 197 198 199 200 201 202
  (define-condition compile-file-error (compile-condition error) ())
  (define-condition compile-warned-warning (compile-condition warning) ())
  (define-condition compile-warned-error (compile-condition error) ())
  (define-condition compile-failed-warning (compile-condition warning) ())
  (define-condition compile-failed-error (compile-condition error) ())

  (defun check-lisp-compile-warnings (warnings-p failure-p
                                                  &optional context-format context-arguments)
203 204
    "Given the warnings or failures as resulted from COMPILE-FILE or checking deferred warnings,
raise an error or warning as appropriate"
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
    (when failure-p
      (case *compile-file-failure-behaviour*
        (:warn (warn 'compile-failed-warning
                     :description "Lisp compilation failed"
                     :context-format context-format
                     :context-arguments context-arguments))
        (:error (error 'compile-failed-error
                       :description "Lisp compilation failed"
                       :context-format context-format
                       :context-arguments context-arguments))
        (:ignore nil)))
    (when warnings-p
      (case *compile-file-warnings-behaviour*
        (:warn (warn 'compile-warned-warning
                     :description "Lisp compilation had style-warnings"
                     :context-format context-format
                     :context-arguments context-arguments))
        (:error (error 'compile-warned-error
                       :description "Lisp compilation had style-warnings"
                       :context-format context-format
                       :context-arguments context-arguments))
        (:ignore nil))))

  (defun check-lisp-compile-results (output warnings-p failure-p
                                             &optional context-format context-arguments)
230
    "Given the results of COMPILE-FILE, raise an error or warning as appropriate"
231 232 233
    (unless output
      (error 'compile-file-error :context-format context-format :context-arguments context-arguments))
    (check-lisp-compile-warnings warnings-p failure-p context-format context-arguments)))
234 235


236
;;;; Deferred-warnings treatment, originally implemented by Douglas Katzman.
237 238 239 240 241 242
;;;
;;; To support an implementation, three functions must be implemented:
;;; reify-deferred-warnings unreify-deferred-warnings reset-deferred-warnings
;;; See their respective docstrings.
(with-upgradability ()
  (defun reify-simple-sexp (sexp)
243 244
    "Given a simple SEXP, return a representation of it as a portable SEXP.
Simple means made of symbols, numbers, characters, simple-strings, pathnames, cons cells."
245 246 247
    (etypecase sexp
      (symbol (reify-symbol sexp))
      ((or number character simple-string pathname) sexp)
248 249
      (cons (cons (reify-simple-sexp (car sexp)) (reify-simple-sexp (cdr sexp))))
      (simple-vector (vector (mapcar 'reify-simple-sexp (coerce sexp 'list))))))
250

251
  (defun unreify-simple-sexp (sexp)
252
    "Given the portable output of REIFY-SIMPLE-SEXP, return the simple SEXP it represents"
253 254 255
    (etypecase sexp
      ((or symbol number character simple-string pathname) sexp)
      (cons (cons (unreify-simple-sexp (car sexp)) (unreify-simple-sexp (cdr sexp))))
256 257
      ((simple-vector 2) (unreify-symbol sexp))
      ((simple-vector 1) (coerce (mapcar 'unreify-simple-sexp (aref sexp 0)) 'vector))))
258 259 260 261 262 263 264

  #+clozure
  (progn
    (defun reify-source-note (source-note)
      (when source-note
        (with-accessors ((source ccl::source-note-source) (filename ccl:source-note-filename)
                         (start-pos ccl:source-note-start-pos) (end-pos ccl:source-note-end-pos)) source-note
265 266 267
          (declare (ignorable source))
          (list :filename filename :start-pos start-pos :end-pos end-pos
                #|:source (reify-source-note source)|#))))
268 269 270 271 272
    (defun unreify-source-note (source-note)
      (when source-note
        (destructuring-bind (&key filename start-pos end-pos source) source-note
          (ccl::make-source-note :filename filename :start-pos start-pos :end-pos end-pos
                                 :source (unreify-source-note source)))))
273 274 275 276 277 278 279 280 281
    (defun unsymbolify-function-name (name)
      (if-let (setfed (gethash name ccl::%setf-function-name-inverses%))
        `(setf ,setfed)
        name))
    (defun symbolify-function-name (name)
      (if (and (consp name) (eq (first name) 'setf))
          (let ((setfed (second name)))
            (gethash setfed ccl::%setf-function-names%))
          name))
282
    (defun reify-function-name (function-name)
283
      (let ((name (or (first function-name) ;; defun: extract the name
284 285 286
                      (let ((sec (second function-name)))
                        (or (and (atom sec) sec) ; scoped method: drop scope
                            (first sec)))))) ; method: keep gf name, drop method specializers
287
        (list name)))
288
    (defun unreify-function-name (function-name)
289
      function-name)
290 291 292 293 294 295
    (defun nullify-non-literals (sexp)
      (typecase sexp
        ((or number character simple-string symbol pathname) sexp)
        (cons (cons (nullify-non-literals (car sexp))
                    (nullify-non-literals (cdr sexp))))
        (t nil)))
296 297 298 299 300
    (defun reify-deferred-warning (deferred-warning)
      (with-accessors ((warning-type ccl::compiler-warning-warning-type)
                       (args ccl::compiler-warning-args)
                       (source-note ccl:compiler-warning-source-note)
                       (function-name ccl:compiler-warning-function-name)) deferred-warning
301
        (list :warning-type warning-type :function-name (reify-function-name function-name)
302
              :source-note (reify-source-note source-note)
303 304 305 306
              :args (destructuring-bind (fun &rest more)
                        args
                      (cons (unsymbolify-function-name fun)
                            (nullify-non-literals more))))))
307 308 309 310 311
    (defun unreify-deferred-warning (reified-deferred-warning)
      (destructuring-bind (&key warning-type function-name source-note args)
          reified-deferred-warning
        (make-condition (or (cdr (ccl::assq warning-type ccl::*compiler-whining-conditions*))
                            'ccl::compiler-warning)
312
                        :function-name (unreify-function-name function-name)
313 314
                        :source-note (unreify-source-note source-note)
                        :warning-type warning-type
315 316
                        :args (destructuring-bind (fun . more) args
                                (cons (symbolify-function-name fun) more))))))
317
  #+(or cmucl scl)
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  (defun reify-undefined-warning (warning)
    ;; Extracting undefined-warnings from the compilation-unit
    ;; To be passed through the above reify/unreify link, it must be a "simple-sexp"
    (list*
     (c::undefined-warning-kind warning)
     (c::undefined-warning-name warning)
     (c::undefined-warning-count warning)
     (mapcar
      #'(lambda (frob)
          ;; the lexenv slot can be ignored for reporting purposes
          `(:enclosing-source ,(c::compiler-error-context-enclosing-source frob)
            :source ,(c::compiler-error-context-source frob)
            :original-source ,(c::compiler-error-context-original-source frob)
            :context ,(c::compiler-error-context-context frob)
            :file-name ,(c::compiler-error-context-file-name frob) ; a pathname
            :file-position ,(c::compiler-error-context-file-position frob) ; an integer
            :original-source-path ,(c::compiler-error-context-original-source-path frob)))
      (c::undefined-warning-warnings warning))))

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
  #+sbcl
  (defun reify-undefined-warning (warning)
    ;; Extracting undefined-warnings from the compilation-unit
    ;; To be passed through the above reify/unreify link, it must be a "simple-sexp"
    (list*
     (sb-c::undefined-warning-kind warning)
     (sb-c::undefined-warning-name warning)
     (sb-c::undefined-warning-count warning)
     (mapcar
      #'(lambda (frob)
          ;; the lexenv slot can be ignored for reporting purposes
          `(:enclosing-source ,(sb-c::compiler-error-context-enclosing-source frob)
            :source ,(sb-c::compiler-error-context-source frob)
            :original-source ,(sb-c::compiler-error-context-original-source frob)
            :context ,(sb-c::compiler-error-context-context frob)
            :file-name ,(sb-c::compiler-error-context-file-name frob) ; a pathname
            :file-position ,(sb-c::compiler-error-context-file-position frob) ; an integer
            :original-source-path ,(sb-c::compiler-error-context-original-source-path frob)))
      (sb-c::undefined-warning-warnings warning))))

  (defun reify-deferred-warnings ()
    "return a portable S-expression, portably readable and writeable in any Common Lisp implementation
359 360
using READ within a WITH-SAFE-IO-SYNTAX, that represents the warnings currently deferred by
WITH-COMPILATION-UNIT. One of three functions required for deferred-warnings support in ASDF."
361
    #+allegro
362
    (list :functions-defined excl::.functions-defined.
363
          :functions-called excl::.functions-called.)
364 365 366 367 368
    #+clozure
    (mapcar 'reify-deferred-warning
            (if-let (dw ccl::*outstanding-deferred-warnings*)
              (let ((mdw (ccl::ensure-merged-deferred-warnings dw)))
                (ccl::deferred-warnings.warnings mdw))))
369
    #+(or cmucl scl)
370 371 372 373 374 375 376 377 378 379 380
    (when lisp::*in-compilation-unit*
      ;; Try to send nothing through the pipe if nothing needs to be accumulated
      `(,@(when c::*undefined-warnings*
            `((c::*undefined-warnings*
               ,@(mapcar #'reify-undefined-warning c::*undefined-warnings*))))
        ,@(loop :for what :in '(c::*compiler-error-count*
                                c::*compiler-warning-count*
                                c::*compiler-note-count*)
                :for value = (symbol-value what)
                :when (plusp value)
                  :collect `(,what . ,value))))
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    #+sbcl
    (when sb-c::*in-compilation-unit*
      ;; Try to send nothing through the pipe if nothing needs to be accumulated
      `(,@(when sb-c::*undefined-warnings*
            `((sb-c::*undefined-warnings*
               ,@(mapcar #'reify-undefined-warning sb-c::*undefined-warnings*))))
        ,@(loop :for what :in '(sb-c::*aborted-compilation-unit-count*
                                sb-c::*compiler-error-count*
                                sb-c::*compiler-warning-count*
                                sb-c::*compiler-style-warning-count*
                                sb-c::*compiler-note-count*)
                :for value = (symbol-value what)
                :when (plusp value)
                  :collect `(,what . ,value)))))

  (defun unreify-deferred-warnings (reified-deferred-warnings)
    "given a S-expression created by REIFY-DEFERRED-WARNINGS, reinstantiate the corresponding
398 399 400 401
deferred warnings as to be handled at the end of the current WITH-COMPILATION-UNIT.
Handle any warning that has been resolved already,
such as an undefined function that has been defined since.
One of three functions required for deferred-warnings support in ASDF."
402
    (declare (ignorable reified-deferred-warnings))
403 404
    #+allegro
    (destructuring-bind (&key functions-defined functions-called)
405
        reified-deferred-warnings
406 407 408 409
      (setf excl::.functions-defined.
            (append functions-defined excl::.functions-defined.)
            excl::.functions-called.
            (append functions-called excl::.functions-called.)))
410 411 412 413 414
    #+clozure
    (let ((dw (or ccl::*outstanding-deferred-warnings*
                  (setf ccl::*outstanding-deferred-warnings* (ccl::%defer-warnings t)))))
      (appendf (ccl::deferred-warnings.warnings dw)
               (mapcar 'unreify-deferred-warning reified-deferred-warnings)))
415
    #+(or cmucl scl)
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
    (dolist (item reified-deferred-warnings)
      ;; Each item is (symbol . adjustment) where the adjustment depends on the symbol.
      ;; For *undefined-warnings*, the adjustment is a list of initargs.
      ;; For everything else, it's an integer.
      (destructuring-bind (symbol . adjustment) item
        (case symbol
          ((c::*undefined-warnings*)
           (setf c::*undefined-warnings*
                 (nconc (mapcan
                         #'(lambda (stuff)
                             (destructuring-bind (kind name count . rest) stuff
                               (unless (case kind (:function (fboundp name)))
                                 (list
                                  (c::make-undefined-warning
                                   :name name
                                   :kind kind
                                   :count count
                                   :warnings
                                   (mapcar #'(lambda (x)
                                               (apply #'c::make-compiler-error-context x))
                                           rest))))))
                         adjustment)
                        c::*undefined-warnings*)))
          (otherwise
           (set symbol (+ (symbol-value symbol) adjustment))))))
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
    #+sbcl
    (dolist (item reified-deferred-warnings)
      ;; Each item is (symbol . adjustment) where the adjustment depends on the symbol.
      ;; For *undefined-warnings*, the adjustment is a list of initargs.
      ;; For everything else, it's an integer.
      (destructuring-bind (symbol . adjustment) item
        (case symbol
          ((sb-c::*undefined-warnings*)
           (setf sb-c::*undefined-warnings*
                 (nconc (mapcan
                         #'(lambda (stuff)
                             (destructuring-bind (kind name count . rest) stuff
                               (unless (case kind (:function (fboundp name)))
                                 (list
                                  (sb-c::make-undefined-warning
                                   :name name
                                   :kind kind
                                   :count count
                                   :warnings
                                   (mapcar #'(lambda (x)
                                               (apply #'sb-c::make-compiler-error-context x))
                                           rest))))))
                         adjustment)
                        sb-c::*undefined-warnings*)))
          (otherwise
           (set symbol (+ (symbol-value symbol) adjustment)))))))

  (defun reset-deferred-warnings ()
    "Reset the set of deferred warnings to be handled at the end of the current WITH-COMPILATION-UNIT.
470
One of three functions required for deferred-warnings support in ASDF."
471 472 473
    #+allegro
    (setf excl::.functions-defined. nil
          excl::.functions-called. nil)
474 475 476 477
    #+clozure
    (if-let (dw ccl::*outstanding-deferred-warnings*)
      (let ((mdw (ccl::ensure-merged-deferred-warnings dw)))
        (setf (ccl::deferred-warnings.warnings mdw) nil)))
478
    #+(or cmucl scl)
479 480 481 482 483
    (when lisp::*in-compilation-unit*
      (setf c::*undefined-warnings* nil
            c::*compiler-error-count* 0
            c::*compiler-warning-count* 0
            c::*compiler-note-count* 0))
484 485 486 487 488 489 490 491 492 493 494
    #+sbcl
    (when sb-c::*in-compilation-unit*
      (setf sb-c::*undefined-warnings* nil
            sb-c::*aborted-compilation-unit-count* 0
            sb-c::*compiler-error-count* 0
            sb-c::*compiler-warning-count* 0
            sb-c::*compiler-style-warning-count* 0
            sb-c::*compiler-note-count* 0)))

  (defun save-deferred-warnings (warnings-file)
    "Save forward reference conditions so they may be issued at a latter time,
495
possibly in a different process."
496 497 498
    (with-open-file (s warnings-file :direction :output :if-exists :supersede
                       :element-type *default-stream-element-type*
                       :external-format *utf-8-external-format*)
499
      (with-safe-io-syntax ()
500 501
        (let ((*read-eval* t))
          (write (reify-deferred-warnings) :stream s :pretty t :readably t))
502 503 504
        (terpri s))))

  (defun warnings-file-type (&optional implementation-type)
505 506
    "The pathname type for warnings files on given IMPLEMENTATION-TYPE,
where NIL designates the current one"
507
    (case (or implementation-type *implementation-type*)
508 509
      ((:acl :allegro) "allegro-warnings")
      ;;((:clisp) "clisp-warnings")
510 511 512 513
      ((:cmu :cmucl) "cmucl-warnings")
      ((:sbcl) "sbcl-warnings")
      ((:clozure :ccl) "ccl-warnings")
      ((:scl) "scl-warnings")))
514

515
  (defvar *warnings-file-type* nil
516
    "Pathname type for warnings files, or NIL if disabled")
517

518
  (defun enable-deferred-warnings-check ()
519
    "Enable the saving of deferred warnings"
520 521 522
    (setf *warnings-file-type* (warnings-file-type)))

  (defun disable-deferred-warnings-check ()
523
    "Disable the saving of deferred warnings"
524 525
    (setf *warnings-file-type* nil))

526
  (defun warnings-file-p (file &optional implementation-type)
527 528
    "Is FILE a saved warnings file for the given IMPLEMENTATION-TYPE?
If that given type is NIL, use the currently configured *WARNINGS-FILE-TYPE* instead."
529 530 531 532 533 534
    (if-let (type (if implementation-type
                      (warnings-file-type implementation-type)
                      *warnings-file-type*))
      (equal (pathname-type file) type)))

  (defun check-deferred-warnings (files &optional context-format context-arguments)
535
    "Given a list of FILES containing deferred warnings saved by CALL-WITH-SAVED-DEFERRED-WARNINGS,
536
re-intern and raise any warnings that are still meaningful."
537 538 539 540 541 542 543 544 545 546 547 548
    (let ((file-errors nil)
          (failure-p nil)
          (warnings-p nil))
      (handler-bind
          ((warning #'(lambda (c)
                        (setf warnings-p t)
                        (unless (typep c 'style-warning)
                          (setf failure-p t)))))
        (with-compilation-unit (:override t)
          (reset-deferred-warnings)
          (dolist (file files)
            (unreify-deferred-warnings
549 550 551 552
             (handler-case
                 (with-safe-io-syntax ()
                   (let ((*read-eval* t))
                     (read-file-form file)))
553
               (error (c)
554
                 ;;(delete-file-if-exists file) ;; deleting forces rebuild but prevents debugging
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
                 (push c file-errors)
                 nil))))))
      (dolist (error file-errors) (error error))
      (check-lisp-compile-warnings
       (or failure-p warnings-p) failure-p context-format context-arguments)))

  #|
  Mini-guide to adding support for deferred warnings on an implementation.

  First, look at what such a warning looks like:

  (describe
  (handler-case
  (and (eval '(lambda () (some-undefined-function))) nil)
  (t (c) c)))

  Then you can grep for the condition type in your compiler sources
  and see how to catch those that have been deferred,
  and/or read, clear and restore the deferred list.

  Also look at
  (macroexpand-1 '(with-compilation-unit () foo))
  |#

579
  (defun call-with-saved-deferred-warnings (thunk warnings-file &key source-namestring)
580 581 582
    "If WARNINGS-FILE is not nil, record the deferred-warnings around a call to THUNK
and save those warnings to the given file for latter use,
possibly in a different process. Otherwise just call THUNK."
583
    (declare (ignorable source-namestring))
584
    (if warnings-file
585
        (with-compilation-unit (:override t #+sbcl :source-namestring #+sbcl source-namestring)
586 587 588
          (unwind-protect
               (let (#+sbcl (sb-c::*undefined-warnings* nil))
                 (multiple-value-prog1
589
                     (funcall thunk)
590 591 592 593
                   (save-deferred-warnings warnings-file)))
            (reset-deferred-warnings)))
        (funcall thunk)))

594
  (defmacro with-saved-deferred-warnings ((warnings-file &key source-namestring) &body body)
595
    "Trivial syntax for CALL-WITH-SAVED-DEFERRED-WARNINGS"
596 597
    `(call-with-saved-deferred-warnings
      #'(lambda () ,@body) ,warnings-file :source-namestring ,source-namestring)))
598 599 600


;;; from ASDF
601 602
(with-upgradability ()
  (defun current-lisp-file-pathname ()
603
    "Portably return the PATHNAME of the current Lisp source file being compiled or loaded"
604 605 606
    (or *compile-file-pathname* *load-pathname*))

  (defun load-pathname ()
607
    "Portably return the LOAD-PATHNAME of the current source file or fasl"
608
    *load-pathname*) ;; magic no longer needed for GCL.
609 610

  (defun lispize-pathname (input-file)
611
    "From a INPUT-FILE pathname, return a corresponding .lisp source pathname"
612 613 614 615 616
    (make-pathname :type "lisp" :defaults input-file))

  (defun compile-file-type (&rest keys)
    "pathname TYPE for lisp FASt Loading files"
    (declare (ignorable keys))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
617 618
    #-(or clasp ecl mkcl) (load-time-value (pathname-type (compile-file-pathname "foo.lisp")))
    #+(or clasp ecl mkcl) (pathname-type (apply 'compile-file-pathname "foo" keys)))
619 620

  (defun call-around-hook (hook function)
621
    "Call a HOOK around the execution of FUNCTION"
622 623 624
    (call-function (or hook 'funcall) function))

  (defun compile-file-pathname* (input-file &rest keys &key output-file &allow-other-keys)
625
    "Variant of COMPILE-FILE-PATHNAME that works well with COMPILE-FILE*"
626
    (let* ((keys
627
             (remove-plist-keys `(#+(or (and allegro (not (version>= 8 2)))) :external-format
628 629 630 631 632 633 634 635 636 637
                                    ,@(unless output-file '(:output-file))) keys)))
      (if (absolute-pathname-p output-file)
          ;; what cfp should be doing, w/ mp* instead of mp
          (let* ((type (pathname-type (apply 'compile-file-type keys)))
                 (defaults (make-pathname
                            :type type :defaults (merge-pathnames* input-file))))
            (merge-pathnames* output-file defaults))
          (funcall *output-translation-function*
                   (apply 'compile-file-pathname input-file keys)))))

638 639 640
  (defvar *compile-check* nil
    "A hook for user-defined compile-time invariants")

641
  (defun* (compile-file*) (input-file &rest keys
642
                                      &key (compile-check *compile-check*) output-file warnings-file
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
643
                                      #+clisp lib-file #+(or clasp ecl mkcl) object-file #+sbcl emit-cfasl
644 645
                                      &allow-other-keys)
    "This function provides a portable wrapper around COMPILE-FILE.
646 647
It ensures that the OUTPUT-FILE value is only returned and
the file only actually created if the compilation was successful,
648 649
even though your implementation may not do that. It also checks an optional
user-provided consistency function COMPILE-CHECK to determine success;
650 651 652 653 654 655
it will call this function if not NIL at the end of the compilation
with the arguments sent to COMPILE-FILE*, except with :OUTPUT-FILE TMP-FILE
where TMP-FILE is the name of a temporary output-file.
It also checks two flags (with legacy british spelling from ASDF1),
*COMPILE-FILE-FAILURE-BEHAVIOUR* and *COMPILE-FILE-WARNINGS-BEHAVIOUR*
with appropriate implementation-dependent defaults,
656 657
and if a failure (respectively warnings) are reported by COMPILE-FILE,
it will consider that an error unless the respective behaviour flag
658
is one of :SUCCESS :WARN :IGNORE.
659
If WARNINGS-FILE is defined, deferred warnings are saved to that file.
660 661 662
On ECL or MKCL, it creates both the linkable object and loadable fasl files.
On implementations that erroneously do not recognize standard keyword arguments,
it will filter them appropriately."
663 664 665 666 667
    #+(or clasp ecl)
    (when (and object-file (equal (compile-file-type) (pathname object-file)))
      (format t "Whoa, some funky ASDF upgrade switched ~S calling convention for ~S and ~S~%"
              'compile-file* output-file object-file)
      (rotatef output-file object-file))
668
    (let* ((keywords (remove-plist-keys
669
                      `(:output-file :compile-check :warnings-file
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
670
                                     #+clisp :lib-file #+(or clasp ecl mkcl) :object-file) keys))
671 672 673
           (output-file
             (or output-file
                 (apply 'compile-file-pathname* input-file :output-file output-file keywords)))
674
           (physical-output-file (physicalize-pathname output-file))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
675
           #+(or clasp ecl)
676 677 678
           (object-file
             (unless (use-ecl-byte-compiler-p)
               (or object-file
679
                   #+ecl (compile-file-pathname output-file :type :object)
680
                   #+clasp (compile-file-pathname output-file :output-type :object))))
681 682
           #+mkcl
           (object-file
683
             (or object-file
684
                 (compile-file-pathname output-file :fasl-p nil)))
685
           (tmp-file (tmpize-pathname physical-output-file))
686 687 688
           #+sbcl
           (cfasl-file (etypecase emit-cfasl
                         (null nil)
689
                         ((eql t) (make-pathname :type "cfasl" :defaults physical-output-file))
690 691 692 693
                         (string (parse-namestring emit-cfasl))
                         (pathname emit-cfasl)))
           #+sbcl
           (tmp-cfasl (when cfasl-file (make-pathname :type "cfasl" :defaults tmp-file)))
694 695 696
           #+clisp
           (tmp-lib (make-pathname :type "lib" :defaults tmp-file)))
      (multiple-value-bind (output-truename warnings-p failure-p)
697 698 699
          (with-enough-pathname (input-file :defaults *base-build-directory*)
            (with-saved-deferred-warnings (warnings-file :source-namestring (namestring input-file))
              (with-muffled-compiler-conditions ()
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
700
                (or #-(or clasp ecl mkcl)
701 702 703 704
                    (apply 'compile-file input-file :output-file tmp-file
                           #+sbcl (if emit-cfasl (list* :emit-cfasl tmp-cfasl keywords) keywords)
                           #-sbcl keywords)
                    #+ecl (apply 'compile-file input-file :output-file
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
705 706 707 708 709 710 711
                                (if object-file
                                    (list* object-file :system-p t keywords)
                                    (list* tmp-file keywords)))
                    #+clasp (apply 'compile-file input-file :output-file
                                  (if object-file
                                      (list* object-file :output-type :object #|:system-p t|# keywords)
                                      (list* tmp-file keywords)))
712 713
                    #+mkcl (apply 'compile-file input-file
                                  :output-file object-file :fasl-p nil keywords)))))
714 715 716 717 718 719 720
        (cond
          ((and output-truename
                (flet ((check-flag (flag behaviour)
                         (or (not flag) (member behaviour '(:success :warn :ignore)))))
                  (and (check-flag failure-p *compile-file-failure-behaviour*)
                       (check-flag warnings-p *compile-file-warnings-behaviour*)))
                (progn
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
721 722
                  #+(or clasp ecl mkcl)
                  (when (and #+(or clasp ecl) object-file)
723
                    (setf output-truename
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
724
                          (compiler::build-fasl tmp-file
725
                           #+(or clasp ecl) :lisp-files #+mkcl :lisp-object-files (list object-file))))
726
                  (or (not compile-check)
727
                      (apply compile-check input-file
728
                             :output-file output-truename
729
                             keywords))))
730
           (delete-file-if-exists physical-output-file)
731
           (when output-truename
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
732
             #+clasp (when output-truename (rename-file-overwriting-target tmp-file output-truename))
733 734 735 736 737 738
             ;; see CLISP bug 677
             #+clisp
             (progn
               (setf tmp-lib (make-pathname :type "lib" :defaults output-truename))
               (unless lib-file (setf lib-file (make-pathname :type "lib" :defaults physical-output-file)))
               (rename-file-overwriting-target tmp-lib lib-file))
739
             #+sbcl (when cfasl-file (rename-file-overwriting-target tmp-cfasl cfasl-file))
740 741
             (rename-file-overwriting-target output-truename physical-output-file)
             (setf output-truename (truename physical-output-file)))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
742
           #+clasp (delete-file-if-exists tmp-file)
743 744
           #+clisp (progn (delete-file-if-exists tmp-file) ;; this one works around clisp BUG 677
                          (delete-file-if-exists tmp-lib))) ;; this one is "normal" defensive cleanup
745 746
          (t ;; error or failed check
           (delete-file-if-exists output-truename)
747 748
           #+clisp (delete-file-if-exists tmp-lib)
           #+sbcl (delete-file-if-exists tmp-cfasl)
749 750 751 752
           (setf output-truename nil)))
        (values output-truename warnings-p failure-p))))

  (defun load* (x &rest keys &key &allow-other-keys)
753
    "Portable wrapper around LOAD that properly handles loading from a stream."
754 755 756 757 758 759 760 761 762 763 764 765 766 767
    (with-muffled-loader-conditions ()
      (etypecase x
        ((or pathname string #-(or allegro clozure genera) stream #+clozure file-stream)
         (apply 'load x keys))
        ;; Genera can't load from a string-input-stream
        ;; ClozureCL 1.6 can only load from file input stream
        ;; Allegro 5, I don't remember but it must have been broken when I tested.
        #+(or allegro clozure genera)
        (stream ;; make do this way
         (let ((*package* *package*)
               (*readtable* *readtable*)
               (*load-pathname* nil)
               (*load-truename* nil))
           (eval-input x))))))
768 769 770 771

  (defun load-from-string (string)
    "Portably read and evaluate forms from a STRING."
    (with-input-from-string (s string) (load* s))))
772 773

;;; Links FASLs together
774 775
(with-upgradability ()
  (defun combine-fasls (inputs output)
776
    "Combine a list of FASLs INPUTS into a single FASL OUTPUT"
777
    #-(or abcl allegro clisp clozure cmucl lispworks sbcl scl xcl)
778
    (not-implemented-error 'combine-fasls "~%inputs: ~S~%output: ~S" inputs output)
779
    #+abcl (funcall 'sys::concatenate-fasls inputs output) ; requires ABCL 1.2.0
780
    #+(or allegro clisp cmucl sbcl scl xcl) (concatenate-files inputs output)
781
    #+clozure (ccl:fasl-concatenate output inputs :if-exists :supersede)
782 783 784 785 786 787 788 789
    #+lispworks
    (let (fasls)
      (unwind-protect
           (progn
             (loop :for i :in inputs
                   :for n :from 1
                   :for f = (add-pathname-suffix
                             output (format nil "-FASL~D" n))
790 791
                   :do (copy-file i f)
                       (push f fasls))
792 793 794 795 796 797
             (ignore-errors (lispworks:delete-system :fasls-to-concatenate))
             (eval `(scm:defsystem :fasls-to-concatenate
                      (:default-pathname ,(pathname-directory-pathname output))
                      :members
                      ,(loop :for f :in (reverse fasls)
                             :collect `(,(namestring f) :load-only t))))
798
             (scm:concatenate-system output :fasls-to-concatenate :force t))
799 800
        (loop :for f :in fasls :do (ignore-errors (delete-file f)))
        (ignore-errors (lispworks:delete-system :fasls-to-concatenate))))))