package.lisp 21.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
;;;; ---------------------------------------------------------------------------
;;;; Handle ASDF package upgrade, including implementation-dependent magic.
;;
;; See https://bugs.launchpad.net/asdf/+bug/485687
;;
;; CAUTION: we must handle the first few packages specially for hot-upgrade.
;; asdf/package will be frozen as of 2.27
;; to forever export the same exact symbols.
;; Any other symbol must be import-from'ed
;; and reexported in a different package
;; (alternatively the package may be dropped & replaced by one with a new name).

(defpackage :asdf/package
  (:use :common-lisp)
  (:export
16 17 18
   #:find-package* #:find-symbol* #:symbol-call #:intern* #:unintern*
   #:symbol-shadowing-p #:rehome-symbol
   #:delete-package* #:package-names #:packages-from-names
19
   #:package-definition-form #:ensure-package #:define-package))
20 21 22

(in-package :asdf/package)

23 24 25
(defmacro DBG (tag &rest exprs)
  "simple debug statement macro:
outputs a tag plus a list of variable and their values, returns the last value"
26
  ;;"if not in debugging mode, just compute and return last value"
27
  ;; #-DBGXXX (declare (ignore tag)) #-DBGXXX (car (last exprs)) #+DBGXXX
28 29 30 31 32 33 34 35 36 37 38 39
  (let ((res (gensym))(f (gensym)))
  `(let (,res (*print-readably* nil))
    (flet ((,f (fmt &rest args) (apply #'format *error-output* fmt args)))
      (fresh-line *standard-output*) (fresh-line *trace-output*) (fresh-line *error-output*)
      (,f "~&~A~%" ,tag)
      ,@(mapcan
         #'(lambda (x)
            `((,f "~&  ~S => " ',x)
              (,f "~{~S~^ ~}~%" (setf ,res (multiple-value-list ,x)))))
         exprs)
      (apply 'values ,res)))))

40

41 42 43
;;;; General purpose package utilities

(eval-when (:load-toplevel :compile-toplevel :execute)
44 45 46 47 48 49 50
  (defun find-package* (package-designator &optional (error t))
    (let ((package (find-package package-designator)))
      (cond
        (package package)
        (error (error "No package named ~S" (string package-designator)))
        (t nil))))
  (defun find-symbol* (name package-designator &optional (error t))
51 52 53 54 55 56
    "Find a symbol in a package of given string'ified NAME;
unless CL:FIND-SYMBOL, work well with 'modern' case sensitive syntax
by letting you supply a symbol or keyword for the name;
also works well when the package is not present.
If optional ERROR argument is NIL, return NIL instead of an error
when the symbol is not found."
57 58 59 60 61 62 63 64
    (block nil
      (let ((package (find-package* package-designator error)))
        (when package
          (multiple-value-bind (symbol status) (find-symbol (string name) package)
            (cond
              (status (return (values symbol status)))
              (error (error "There is no symbol ~S in package ~S" name (package-name package))))))
        (values nil nil))))
65 66 67 68 69
  (defun symbol-call (package name &rest args)
    "Call a function associated with symbol of given name in given package,
with given ARGS. Useful when the call is read before the package is loaded,
or when loading the package is optional."
    (apply (find-symbol* name package) args))
70
  (defun intern* (name package-designator &optional (error t))
71
    (intern (string name) (find-package* package-designator error)))
72 73 74 75 76 77 78 79 80 81 82
  (defun unintern* (name package-designator &optional (error t))
    (block nil
      (let ((package (find-package* package-designator error)))
        (when package
          (multiple-value-bind (symbol status) (find-symbol* name package error)
            (cond
              (status (unintern symbol package)
                      (return (values symbol status)))
              (error (error "symbol ~A not present in package ~A"
                            (string symbol) (package-name package))))))
        (values nil nil))))
83 84
  (defun symbol-shadowing-p (symbol package)
    (member symbol (package-shadowing-symbols package)))
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
  #+(or clisp clozure)
  (defun get-setf-function-symbol (symbol)
    #+clisp (let ((sym (get symbol 'system::setf-function)))
              (if sym (values sym :setf-function)
                  (let ((sym (get symbol 'system::setf-expander)))
                    (if sym (values sym :setf-expander)
                        (values nil nil)))))
    #+clozure (gethash symbol ccl::%setf-function-names%))
  #+(or clisp clozure)
  (defun set-setf-function-symbol (new-setf-symbol symbol &optional kind)
    #+clisp (assert (member kind '(:setf-function :setf-expander)))
    #+clozure (assert (eq kind t))
    #+clisp
    (cond
      ((null new-setf-symbol)
       (remprop symbol 'system::setf-function)
       (remprop symbol 'system::setf-expander))
      ((eq kind :setf-function)
       (setf (get symbol 'system::setf-function) new-setf-symbol))
      ((eq kind :setf-expander)
       (setf (get symbol 'system::setf-expander) new-setf-symbol)))
    #+clozure
    (progn
      (gethash symbol ccl::%setf-function-names%) new-setf-symbol
      (gethash new-setf-symbol ccl::%setf-function-name-inverses%) symbol))
  #+(or clisp clozure)
  (defun create-setf-function-symbol (symbol)
    #+clisp (system::setf-symbol symbol)
    #+clozure (ccl::construct-setf-function-name symbol))
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
  (defun rehome-symbol (symbol package-designator)
    "Changes the home package of a symbol, also leaving it present in its old home if any"
    (let* ((name (symbol-name symbol))
           (package (find-package* package-designator))
           (old-package (symbol-package symbol))
           (old-status (and old-package (nth-value 1 (find-symbol name old-package))))
           (shadowing (and old-package (symbol-shadowing-p symbol old-package) (make-symbol name))))
      (multiple-value-bind (overwritten-symbol overwritten-symbol-status) (find-symbol name package)
        (unless (eq package old-package)
          (let ((overwritten-symbol-shadowing-p
                  (and overwritten-symbol-status
                       (symbol-shadowing-p overwritten-symbol package))))
            (when old-package
              (if shadowing
                  (shadowing-import shadowing old-package))
                  (unintern symbol old-package))
            (cond
              (overwritten-symbol-shadowing-p
               (shadowing-import symbol package))
              (t
               (when overwritten-symbol-status
                 (unintern overwritten-symbol package))
               (import symbol package)))
            (if shadowing
                (shadowing-import symbol old-package)
                (import symbol old-package))
140 141 142 143 144 145 146 147 148
            #+(or clisp clozure)
            (multiple-value-bind (setf-symbol kind)
                (get-setf-function-symbol symbol)
              (when kind
                (let* ((setf-function (fdefinition setf-symbol))
                       (new-setf-symbol (create-setf-function-symbol symbol)))
                  (setf (fdefinition new-setf-symbol) setf-function)
                  (set-setf-function-symbol symbol new-setf-symbol kind))))
            #+(or clisp clozure)
149
            (multiple-value-bind (overwritten-setf foundp)
150
                (get-setf-function-symbol overwritten-symbol)
151 152 153 154 155 156 157
              (when foundp
                (unintern overwritten-setf)))
            (when (eq old-status :external)
              (export symbol old-package))
            (when (eq overwritten-symbol-status :external)
              (export symbol package))))
        (values overwritten-symbol overwritten-symbol-status))))
158 159 160 161 162 163 164 165
  (defun ensure-package-unused (package)
    (loop :for p :in (package-used-by-list package) :do
      (unuse-package package p)))
  (defun delete-package* (package)
    (let ((p (find-package package)))
      (when p
        (ensure-package-unused p)
        (delete-package package))))
166 167
  (defun package-names (package)
    (cons (package-name package) (package-nicknames package)))
168 169 170 171 172 173 174
  (defun packages-from-names (names)
    (remove-duplicates (remove nil (mapcar #'find-package names)) :from-end t)))


;;; Communicable representation of symbol and package information

(eval-when (:load-toplevel :compile-toplevel :execute)
175 176 177 178 179 180 181 182 183 184
  (defun package-definition-form (package-designator &key internp (error t))
    (let* ((package (find-package* package-designator error))
           (name (package-name package))
           (nicknames (package-nicknames package))
           (use (mapcar #'package-name (package-use-list package)))
           (shadow ())
           (shadowing-import (make-hash-table :test 'equal))
           (import (make-hash-table :test 'equal))
           (export ())
           (intern ()))
185
      (when package
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
        (loop :for sym :being :the :symbols :in package
              :for status = (nth-value 1 (find-symbol* sym package)) :do
                (ecase status
                  ((nil :inherited))
                  ((:internal :external)
                   (let* ((name (symbol-name sym))
                          (external (eq status :external))
                          (home (symbol-package sym))
                          (home-name (package-name home))
                          (imported (not (eq home package)))
                          (shadowing (symbol-shadowing-p sym package)))
                     (cond
                       ((and shadowing import)
                        (push name (gethash home-name shadowing-import)))
                       (shadowing
                        (push name shadow))
                       (imported
                        (push name (gethash home-name import))))
                     (cond
                       (external
                        (push name export))
                       (imported)
                       (t (push name intern)))))))
        (labels ((sort-names (names)
                   (sort names #'string<))
                 (table-keys (table)
                   (loop :for k :being :the :hash-keys :of table :collect k))
                 (when-relevant (key value)
                   (when value (list (cons key value))))
                 (import-options (key table)
                   (loop :for i :in (sort-names (table-keys table))
                         :collect `(,key ,i ,@(sort-names (gethash i table))))))
          `(defpackage ,name
             ,@(when-relevant :nicknames (sort-names nicknames))
             (:use ,@(sort-names use))
             ,@(when-relevant :shadow (sort-names shadow))
             ,@(import-options :shadowing-import-from shadowing-import)
             ,@(import-options :import-from import)
             ,@(when-relevant :export (sort-names export))
             ,@(when-relevant :intern (and internp (sort-names intern)))))))))
226

227 228 229

;;; ensure-package, define-package

230
(eval-when (:load-toplevel :compile-toplevel :execute)
231
  (defun ensure-package (name &key
232 233 234 235
                                nicknames documentation use
                                shadow shadowing-import-from
                                import-from export intern
                                recycle mix reexport
236
                                unintern)
237
    (let* ((name (string name))
238
           (nicknames (mapcar #'string nicknames))
239
           (names (cons name nicknames))
240
           (previous (packages-from-names names))
241
           (discarded (cdr previous))
242
           (to-delete ())
243 244 245 246 247 248
           (package (or (first previous) (make-package name :nicknames nicknames)))
           (recycle (packages-from-names recycle))
           (shadowed (make-hash-table :test 'equal)) ; string to bool
           (imported (make-hash-table :test 'equal)) ; string to bool
           (exported (make-hash-table :test 'equal)) ; string to bool
           (inherited (make-hash-table :test 'equal))) ; string to package name
249
      (labels
250 251 252 253 254 255 256 257
          ((fresh-package-name (&optional (prefix :%TO-BE-DELETED)
                                  (index (random most-positive-fixnum)))
             (loop :for i :from index
                   :for n = (format nil "~A-~D" prefix i)
                   :thereis (and (not (find-package n)) n)))
           (rename-package-away (p)
             (rename-package p (fresh-package-name)))
           (ensure-shadowing-import (sym p)
258 259 260 261
             (let* ((name (string sym))
                    (i (find-symbol* name p)))
               (cond
                 ((gethash name shadowed)
262
                  (unless (eq i (find-symbol* name package))
263 264 265
                    (error "Conflicting shadowings for ~A" name)))
                 (t
                    (setf (gethash name shadowed) t)
266
                    (setf (gethash name imported) t)
267
                    (shadowing-import i package)))))
268 269 270
           (ensure-import (sym p)
             (let* ((name (string sym))
                    (i (find-symbol* name p)))
271
               (multiple-value-bind (x xp) (find-symbol name package)
272
                 (cond
273 274
                   ((gethash name imported)
                    (unless (eq i x)
275
                      (error "Can't import ~S from both ~S and ~S"
276
                             name (package-name (symbol-package x)) (package-name p))))
277 278 279
                   ((gethash name shadowed)
                    (error "Can't both shadow ~S and import it from ~S" name (package-name p)))
                   (t
280
                    (setf (gethash name imported) t)
281 282 283
                    (unless (and xp (eq i x))
                      (when xp (unintern* x p))
                      (import i package)))))))
284 285
           (ensure-mix (sym p)
             (let* ((name (string sym))
286 287 288
                    (sp (string p)))
               (unless (or (gethash name shadowed) (gethash name imported))
                 (let ((ip (gethash name inherited)))
289
                   (cond
290 291
                     ((eq sp ip))
                     (ip
292
                      (remhash name inherited)
293
                      (ensure-shadowing-import name ip))
294
                     (t
295
                      (ensure-inherited sym sp)))))))
296 297
           (ensure-inherited (sym p)
             (let* ((name (string sym))
298 299 300 301
                    (symbol (find-symbol* name p))
                    (sp (symbol-package symbol))
                    (spn (package-name sp))
                    (ipn (gethash name inherited)))
302 303
               (multiple-value-bind (x xp) (find-symbol name package)
                 (cond
304
                   ((gethash name shadowed))
305 306
                   (ipn
                    (unless (eq spn ipn)
307
                      (error "Can't inherit ~S from ~S, it is inherited from ~S"
308
                             name spn ipn)))
309
                   ((gethash name imported)
310
                    (unless (eq symbol x)
311 312 313
                      (error "Can't inherit ~S from ~S, it is imported from ~S"
                             name sp (package-name (symbol-package x)))))
                   (t
314
                    (setf (gethash name inherited) spn)
315 316
                    (when xp
                      (unintern* x package)))))))
317
           (recycle-symbol (name)
318 319 320 321
             (dolist (r recycle (values nil nil))
               (multiple-value-bind (symbol status) (find-symbol name r)
                 (when (and status (eq r (symbol-package symbol)))
                   (return (values symbol r))))))
322
           (symbol-recycled-p (sym)
323
             (member (symbol-package sym) recycle))
324 325 326 327 328 329 330 331 332
           (ensure-symbol (name &optional intern)
             (unless (or (gethash name shadowed)
                         (gethash name imported)
                         (gethash name inherited))
               (multiple-value-bind (recycled previous) (recycle-symbol name)
                 (cond
                   ((eq previous package))
                   ((or (not previous) (not (member (symbol-package recycled) recycle)))
                    (when intern (intern* name package)))
333
                   (t (rehome-symbol recycled package))))))
334
           (ensure-export (name p)
335
             (multiple-value-bind (symbol status) (find-symbol* name p)
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
               (assert status)
               (unless (eq status :external)
                 (ensure-exported name symbol p))))
           (ensure-exported (name sym p)
             (dolist (u (package-used-by-list p))
               (ensure-exported-to-user name sym u))
             (export sym p))
           (ensure-exported-to-user (name sym u)
             (multiple-value-bind (usym ustat) (find-symbol name u)
               (unless (eq sym usym)
                 (let ((shadowing (member usym (package-shadowing-symbols u))))
                   (block nil
                     (cond
                       ((not shadowing)
                        (unintern usym u))
                       ((symbol-recycled-p usym)
                        (shadowing-import sym u))
                       (t (return)))
                     (when (eq ustat :external)
                       (ensure-exported name sym u))))))))
356
        #-gcl (setf (documentation package t) documentation) #+gcl documentation
357 358 359
        (loop :for p :in discarded
              :for n = (remove-if #'(lambda (x) (member x names :test 'equal))
                                  (package-names p))
360
              :do (if n (rename-package p (first n) (rest n))
361 362 363
                      (progn
                        (rename-package-away p)
                        (push p to-delete))))
364 365 366 367
        (rename-package package name nicknames)
        (loop :for p :in (set-difference (package-use-list package) (append mix use))
              :do (unuse-package p package))
        (dolist (name unintern) (unintern* name package nil))
368
        (dolist (sym export) (setf (gethash (string sym) exported) t))
369 370
        (loop :for p :in reexport :do
          (do-external-symbols (sym p)
371
            (setf (gethash (string sym) exported) t)))
372 373 374 375 376 377 378 379 380 381 382
        (do-external-symbols (sym package)
          (unless (gethash (symbol-name sym) exported) (unexport sym package)))
        (loop :for s :in shadow :for name = (string s) :do
          (setf (gethash name shadowed) t)
          (multiple-value-bind (recycled previous) (recycle-symbol name)
            (cond
              ((or (not previous) (not (member (symbol-package recycle) recycle)))
               (ecase (nth-value 1 (find-symbol* name package nil))
                 ((nil :inherited) (shadow name package))
                 ((:internal :external) (shadowing-import (make-symbol name) package))))
              ((eq previous package) (shadow recycled package))
383
              (t (rehome-symbol recycled package)))))
384 385 386 387 388 389
        (loop :for (p . syms) :in shadowing-import-from :do
          (dolist (sym syms) (ensure-shadowing-import sym p)))
        (loop :for p :in mix :do
          (do-external-symbols (sym p) (ensure-mix sym p)))
        (loop :for (p . syms) :in import-from :do
          (dolist (sym syms) (ensure-import sym p)))
390 391
        (loop :for p :in (append use mix) :for pp = (find-package* p) :do
          (do-external-symbols (sym pp) (ensure-inherited sym pp))
392
          (use-package pp package))
393
        (loop :for name :being :the :hash-keys :of exported :do
394 395 396
          (ensure-symbol (string name) t)
          (ensure-export name package))
        (dolist (name intern)
397
          (ensure-symbol (string name) t))
398
        (do-symbols (sym package)
399
          (ensure-symbol (symbol-name sym)))
400
        (map () 'delete-package* to-delete)
401 402 403
        package))))

(eval-when (:load-toplevel :compile-toplevel :execute)
404
  (defun parse-define-package-form (package clauses)
405 406
    (loop
      :with use-p = nil :with recycle-p = nil
407
      :with documentation = nil
408
      :for (kw . args) :in clauses
409
      :when (eq kw :nicknames) :append args :into nicknames :else
410 411 412 413 414 415
      :when (eq kw :documentation)
        :do (cond
              (documentation (error "define-package: can't define documentation twice"))
              ((or (atom args) (cdr args)) (error "define-package: bad documentation"))
              (t (setf documentation (car args)))) :else
      :when (eq kw :use) :append args :into use :and :do (setf use-p t) :else
416
      :when (eq kw :shadow) :append args :into shadow :else
417 418
      :when (eq kw :shadowing-import-from) :collect args :into shadowing-import-from :else
      :when (eq kw :import-from) :collect args :into import-from :else
419 420
      :when (eq kw :export) :append args :into export :else
      :when (eq kw :intern) :append args :into intern :else
421
      :when (eq kw :recycle) :append args :into recycle :and :do (setf recycle-p t) :else
422
      :when (eq kw :mix) :append args :into mix :else
423
      :when (eq kw :reexport) :append args :into reexport :else
424
      :when (eq kw :unintern) :append args :into unintern :else
425
      :do (error "unrecognized define-package keyword ~S" kw)
426 427
      :finally (return `(,package
                         :nicknames ,nicknames :documentation ,documentation
428 429 430 431
                         :use ,(if use-p use '(:common-lisp))
                         :shadow ,shadow :shadowing-import-from ,shadowing-import-from
                         :import-from ,import-from :export ,export :intern ,intern
                         :recycle ,(if recycle-p recycle (cons package nicknames))
432
                         :mix ,mix :reexport ,reexport :unintern ,unintern)))))
433 434 435

(defmacro define-package (package &rest clauses)
  `(eval-when (:compile-toplevel :load-toplevel :execute)
436
     #+(or ecl gcl) (defpackage ,package (:use))
437 438 439 440
     #+clisp (macrolet ((foo ()
                          (apply 'ensure-package ',(parse-define-package-form package clauses))
                          (package-definition-form ',package)))
               (foo))
441
     (apply 'ensure-package ',(parse-define-package-form package clauses))))
442

443 444
#+clisp
(eval-when (:compile-toplevel :load-toplevel :execute)
445 446
  (when (and (find-package :asdf) (not (member :asdf2.27 *features*)))
    (delete-package* :asdf)))
447