package.lisp 18.4 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
   #:symbol-name-package #:package-data
20
   #:ensure-package #:define-package))
21 22 23

(in-package :asdf/package)

24 25 26
(defmacro DBG (tag &rest exprs)
  "simple debug statement macro:
outputs a tag plus a list of variable and their values, returns the last value"
27
  ;;"if not in debugging mode, just compute and return last value"
28
  ;; #-DBGXXX (declare (ignore tag)) #-DBGXXX (car (last exprs)) #+DBGXXX
29 30 31 32 33 34 35 36 37 38 39 40
  (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)))))

41

42 43 44
;;;; General purpose package utilities

(eval-when (:load-toplevel :compile-toplevel :execute)
45 46 47 48 49 50 51
  (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))
52 53 54 55 56 57
    "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."
58 59 60 61 62 63 64 65
    (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))))
66 67 68 69 70
  (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))
71
  (defun intern* (name package-designator &optional (error t))
72
    (intern (string name) (find-package* package-designator error)))
73 74 75 76 77 78 79 80 81 82 83
  (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))))
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
  (defun symbol-shadowing-p (symbol package)
    (member symbol (package-shadowing-symbols package)))
  (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))
            #+ccl
            (multiple-value-bind (setf-name foundp)
                (gethash symbol ccl::%setf-function-names%)
              (when foundp
                (let* ((setf-function (fdefinition setf-name))
                       (new-setf-name (ccl::construct-setf-function-name symbol)))
                  (setf (fdefinition new-setf-name) setf-function
                        (gethash symbol ccl::%setf-function-names%) new-setf-name
                        (gethash new-setf-name ccl::%setf-function-name-inverses%) symbol))))
            #+ccl
            (multiple-value-bind (overwritten-setf foundp)
                (gethash overwritten-symbol ccl::%setf-function-names%)
              (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))))
131 132 133 134 135 136 137 138
  (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))))
139 140
  (defun package-names (package)
    (cons (package-name package) (package-nicknames package)))
141 142 143 144 145 146 147 148 149
  (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)
  (defun symbol-name-package (symbol)
    (cons (symbol-name symbol) (package-name (symbol-package symbol))))
150
  (defun package-data (package-designator &key name-package (error t))
151 152
    (let ((package (find-package* package-designator error)))
      (when package
153 154 155 156
        (labels ((marshall-symbols (symbols)
                   (if name-package (mapcar #'symbol-name-package symbols) symbols))
                 (sort-symbols (symbols)
                   (marshall-symbols (sort symbols #'string<)))
157
                 (sort-packages (packages)
158
                   (sort (mapcar #'package-name packages) #'string<)))
159 160 161 162 163 164 165 166 167 168 169
          (loop :with internal :with external :with inherited
                :for sym :being :the :symbols :in package
                :for status = (nth-value 1 (find-symbol* sym package)) :do
                  (ecase status
                    (:internal (push sym internal))
                    (:external (push sym external))
                    (:inherited (push sym inherited)))
                :finally
                   (return
                     `(:name ,(package-name package)
                       :nicknames ,(package-nicknames package)
170 171 172 173
                       :internal ,(sort-symbols internal)
                       :external ,(sort-symbols external)
                       :inherited ,(sort-symbols inherited)
                       :shadowing ,(sort-symbols (package-shadowing-symbols package))
174 175
                       :use ,(sort-packages (package-use-list package))
                       :used-by ,(sort-packages (package-used-by-list package))))))))))
176

177 178 179

;;; ensure-package, define-package

180
(eval-when (:load-toplevel :compile-toplevel :execute)
181
  (defun ensure-package (name &key
182 183 184 185
                                nicknames documentation use
                                shadow shadowing-import-from
                                import-from export intern
                                recycle mix reexport
186
                                unintern)
187
    (let* ((name (string name))
188
           (nicknames (mapcar #'string nicknames))
189
           (names (cons name nicknames))
190
           (previous (packages-from-names names))
191
           (discarded (cdr previous))
192 193 194 195 196 197
           (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
198 199 200 201 202 203
      (labels
          ((ensure-shadowing-import (sym p)
             (let* ((name (string sym))
                    (i (find-symbol* name p)))
               (cond
                 ((gethash name shadowed)
204
                  (unless (eq i (find-symbol* name package))
205 206 207
                    (error "Conflicting shadowings for ~A" name)))
                 (t
                    (setf (gethash name shadowed) t)
208
                    (setf (gethash name imported) t)
209
                    (shadowing-import i package)))))
210 211 212
           (ensure-import (sym p)
             (let* ((name (string sym))
                    (i (find-symbol* name p)))
213
               (multiple-value-bind (x xp) (find-symbol name package)
214
                 (cond
215 216
                   ((gethash name imported)
                    (unless (eq i x)
217
                      (error "Can't import ~S from both ~S and ~S"
218
                             name (package-name (symbol-package x)) (package-name p))))
219 220 221
                   ((gethash name shadowed)
                    (error "Can't both shadow ~S and import it from ~S" name (package-name p)))
                   (t
222
                    (setf (gethash name imported) t)
223 224 225
                    (unless (and xp (eq i x))
                      (when xp (unintern* x p))
                      (import i package)))))))
226 227
           (ensure-mix (sym p)
             (let* ((name (string sym))
228 229 230
                    (sp (string p)))
               (unless (or (gethash name shadowed) (gethash name imported))
                 (let ((ip (gethash name inherited)))
231
                   (cond
232 233
                     ((eq sp ip))
                     (ip
234
                      (remhash name inherited)
235
                      (ensure-shadowing-import name ip))
236
                     (t
237
                      (ensure-inherited sym sp)))))))
238 239
           (ensure-inherited (sym p)
             (let* ((name (string sym))
240 241 242 243
                    (symbol (find-symbol* name p))
                    (sp (symbol-package symbol))
                    (spn (package-name sp))
                    (ipn (gethash name inherited)))
244 245
               (multiple-value-bind (x xp) (find-symbol name package)
                 (cond
246
                   ((gethash name shadowed))
247 248
                   (ipn
                    (unless (eq spn ipn)
249
                      (error "Can't inherit ~S from ~S, it is inherited from ~S"
250
                             name spn ipn)))
251
                   ((gethash name imported)
252
                    (unless (eq symbol x)
253 254 255
                      (error "Can't inherit ~S from ~S, it is imported from ~S"
                             name sp (package-name (symbol-package x)))))
                   (t
256
                    (setf (gethash name inherited) spn)
257 258
                    (when xp
                      (unintern* x package)))))))
259
           (recycle-symbol (name)
260 261 262 263
             (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))))))
264
           (symbol-recycled-p (sym)
265
             (member (symbol-package sym) recycle))
266 267 268 269 270 271 272 273 274
           (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)))
275
                   (t (rehome-symbol recycled package))))))
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
           (ensure-export (name p)
             (multiple-value-bind (symbol status) (find-symbol name p)
               (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))))))))
298
        #-gcl (setf (documentation package t) documentation) #+gcl documentation
299 300 301
        (loop :for p :in discarded
              :for n = (remove-if #'(lambda (x) (member x names :test 'equal))
                                  (package-names p))
302 303
              :do (if n (rename-package p (first n) (rest n))
                      (delete-package* p)))
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
        (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))
        (loop :for sym :in export :for name = (string sym) :do
          (setf (gethash name exported) t))
        (loop :for p :in reexport :do
          (do-external-symbols (sym p)
            (let ((name (string sym)))
              (export (find-symbol* name package) package) (setf (gethash name exported) t))))
        (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))
325
              (t (rehome-symbol recycled package)))))
326 327 328 329 330 331
        (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)))
332
        (loop :for p :in use :for sp = (string p) :for pp = (find-package* sp) :do
333 334
          (do-external-symbols (sym pp) (ensure-inherited sym sp))
          (use-package pp package))
335 336
        (loop :for name :being :the :hash-keys :of exported :do
          (ensure-symbol name t))
337
       (dolist (name intern)
338
          (ensure-symbol (string name) t))
339
        (do-symbols (sym package)
340 341 342
          (ensure-symbol (symbol-name sym)))
        (loop :for name :being :the :hash-keys :of exported :do
          (ensure-export name package))
343 344 345
        package))))

(eval-when (:load-toplevel :compile-toplevel :execute)
346
  (defun parse-define-package-form (package clauses)
347 348
    (loop
      :with use-p = nil :with recycle-p = nil
349
      :with documentation = nil
350
      :for (kw . args) :in clauses
351
      :when (eq kw :nicknames) :append args :into nicknames :else
352 353 354 355 356 357
      :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
358
      :when (eq kw :shadow) :append args :into shadow :else
359 360
      :when (eq kw :shadowing-import-from) :collect args :into shadowing-import-from :else
      :when (eq kw :import-from) :collect args :into import-from :else
361 362
      :when (eq kw :export) :append args :into export :else
      :when (eq kw :intern) :append args :into intern :else
363
      :when (eq kw :recycle) :append args :into recycle :and :do (setf recycle-p t) :else
364
      :when (eq kw :mix) :append args :into mix :else
365
      :when (eq kw :reexport) :append args :into reexport :else
366
      :when (eq kw :unintern) :append args :into unintern :else
367
      :do (error "unrecognized define-package keyword ~S" kw)
368 369
      :finally (return `(,package
                         :nicknames ,nicknames :documentation ,documentation
370 371 372 373
                         :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))
374
                         :mix ,mix :reexport ,reexport :unintern ,unintern)))))
375 376 377

(defmacro define-package (package &rest clauses)
  `(eval-when (:compile-toplevel :load-toplevel :execute)
378
     #+(or ecl gcl) (defpackage ,package (:use))
379
     (apply 'ensure-package ',(parse-define-package-form package clauses))))
380