package.lisp 40.3 KB
Newer Older
1
2
3
4
5
6
;;;; ---------------------------------------------------------------------------
;;;; Handle ASDF package upgrade, including implementation-dependent magic.
;;
;; See https://bugs.launchpad.net/asdf/+bug/485687
;;

7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

;;; package local nicknames feature. Can't be deferred until common-lisp.lisp,
;;; where most such features are set.
;;; ABCL and CCL already define this feature appropriately.
;;; Seems to be unconditionally present for SBCL, ACL, and clasp
;;; Don't know about ecl, or others
 (eval-when (:load-toplevel :compile-toplevel :execute)
   ;; abcl pushes :package-local-nicknames without UIOP interfering,
   ;; and Lispworks will do so
    #+(or sbcl clasp)
    (pushnew :package-local-nicknames *features*)
    #+allegro
    (let ((fname (find-symbol (symbol-name '#:add-package-local-nickname) '#:excl)))
      (when (and fname (fboundp fname))
            (pushnew :package-local-nicknames *features*))))

23
(defpackage :uiop/package
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
24
25
26
  ;; CAUTION: we must handle the first few packages specially for hot-upgrade.
  ;; This package definition MUST NOT change unless its name too changes;
  ;; if/when it changes, don't forget to add new functions missing from below.
27
  ;; Until then, uiop/package is frozen to forever
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
28
29
  ;; import and export the same exact symbols as for ASDF 2.27.
  ;; Any other symbol must be import-from'ed and re-export'ed in a different package.
30
  (:use :common-lisp)
31
32
33
  #+package-local-nicknames
  (:import-from #+allegro #:excl
                #+sbcl #:sb-ext
Robert Goldman's avatar
Robert Goldman committed
34
                #+(or clasp abcl ecl) #:ext
35
36
                #+ccl #:ccl
                #+lispworks #:hcl
Robert Goldman's avatar
Robert Goldman committed
37
                #-(or allegro sbcl clasp abcl ccl lispworks ecl)
38
39
                (error "Don't know from which package this lisp supplies the local-package-nicknames API.")
                #:remove-package-local-nickname #:package-local-nicknames #:add-package-local-nickname)
40
  (:export
41
   #:find-package* #:find-symbol* #:symbol-call
42
   #:intern* #:export* #:import* #:shadowing-import* #:shadow* #:make-symbol* #:unintern*
43
   #:symbol-shadowing-p #:home-package-p
44
45
   #:symbol-package-name #:standard-common-lisp-symbol-p
   #:reify-package #:unreify-package #:reify-symbol #:unreify-symbol
46
   #:nuke-symbol-in-package #:nuke-symbol #:rehome-symbol
47
   #:ensure-package-unused #:delete-package*
48
   #:package-names #:packages-from-names #:fresh-package-name #:rename-package-away
49
   #:package-definition-form #:parse-define-package-form
50
51
52
53
54
   #:ensure-package #:define-package
   #+package-local-nicknames #:add-package-local-nickname
   #+package-local-nicknames #:remove-package-local-nickname
   #+package-local-nicknames #:package-local-nicknames
   ))
55

56
(in-package :uiop/package)
57
58
59
60

;;;; General purpose package utilities

(eval-when (:load-toplevel :compile-toplevel :execute)
61
62
63
64
65
66
67
  (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))
68
    "Find a symbol in a package of given string'ified NAME;
69
unlike CL:FIND-SYMBOL, work well with 'modern' case sensitive syntax
70
71
72
73
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."
74
75
    (block nil
      (let ((package (find-package* package-designator error)))
76
        (when package ;; package error handled by find-package* already
77
78
79
80
81
          (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))))
82
83
84
85
86
  (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))
87
  (defun intern* (name package-designator &optional (error t))
88
    (intern (string name) (find-package* package-designator error)))
89
90
91
92
  (defun export* (name package-designator)
    (let* ((package (find-package* package-designator))
           (symbol (intern* name package)))
      (export (or symbol (list symbol)) package)))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
93
94
95
96
97
  (defun import* (symbol package-designator)
    (import (or symbol (list symbol)) (find-package* package-designator)))
  (defun shadowing-import* (symbol package-designator)
    (shadowing-import (or symbol (list symbol)) (find-package* package-designator)))
  (defun shadow* (name package-designator)
98
    (shadow (list (string name)) (find-package* package-designator)))
99
100
101
102
  (defun make-symbol* (name)
    (etypecase name
      (string (make-symbol name))
      (symbol (copy-symbol name))))
103
104
105
106
107
108
109
110
111
112
113
  (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))))
114
  (defun symbol-shadowing-p (symbol package)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
115
    (and (member symbol (package-shadowing-symbols package)) t))
116
  (defun home-package-p (symbol package)
117
118
119
120
    (and package (let ((sp (symbol-package symbol)))
                   (and sp (let ((pp (find-package* package)))
                             (and pp (eq sp pp))))))))

121
122

(eval-when (:load-toplevel :compile-toplevel :execute)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
123
124
125
  (defun symbol-package-name (symbol)
    (let ((package (symbol-package symbol)))
      (and package (package-name package))))
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
  (defun standard-common-lisp-symbol-p (symbol)
    (multiple-value-bind (sym status) (find-symbol* symbol :common-lisp nil)
      (and (eq sym symbol) (eq status :external))))
  (defun reify-package (package &optional package-context)
    (if (eq package package-context) t
        (etypecase package
          (null nil)
          ((eql (find-package :cl)) :cl)
          (package (package-name package)))))
  (defun unreify-package (package &optional package-context)
    (etypecase package
      (null nil)
      ((eql t) package-context)
      ((or symbol string) (find-package package))))
  (defun reify-symbol (symbol &optional package-context)
    (etypecase symbol
      ((or keyword (satisfies standard-common-lisp-symbol-p)) symbol)
      (symbol (vector (symbol-name symbol)
                      (reify-package (symbol-package symbol) package-context)))))
  (defun unreify-symbol (symbol &optional package-context)
    (etypecase symbol
      (symbol symbol)
      ((simple-vector 2)
       (let* ((symbol-name (svref symbol 0))
              (package-foo (svref symbol 1))
              (package (unreify-package package-foo package-context)))
152
153
         (if package (intern* symbol-name package)
             (make-symbol* symbol-name)))))))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
154

155
156
157
158
159
(eval-when (:load-toplevel :compile-toplevel :execute)
  (defvar *all-package-happiness* '())
  (defvar *all-package-fishiness* (list t))
  (defun record-fishy (info)
    ;;(format t "~&FISHY: ~S~%" info)
160
    (push info *all-package-fishiness*))
161
162
163
164
165
  (defmacro when-package-fishiness (&body body)
    `(when *all-package-fishiness* ,@body))
  (defmacro note-package-fishiness (&rest info)
    `(when-package-fishiness (record-fishy (list ,@info)))))

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
166
(eval-when (:load-toplevel :compile-toplevel :execute)
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
  #+(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)
187
188
189
       (setf (get symbol 'system::setf-expander) new-setf-symbol))
      (t (error "invalid kind of setf-function ~S for ~S to be set to ~S"
                kind symbol new-setf-symbol)))
190
191
192
193
194
195
196
197
    #+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))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
  (defun set-dummy-symbol (symbol reason other-symbol)
    (setf (get symbol 'dummy-symbol) (cons reason other-symbol)))
  (defun make-dummy-symbol (symbol)
    (let ((dummy (copy-symbol symbol)))
      (set-dummy-symbol dummy 'replacing symbol)
      (set-dummy-symbol symbol 'replaced-by dummy)
      dummy))
  (defun dummy-symbol (symbol)
    (get symbol 'dummy-symbol))
  (defun get-dummy-symbol (symbol)
    (let ((existing (dummy-symbol symbol)))
      (if existing (values (cdr existing) (car existing))
          (make-dummy-symbol symbol))))
  (defun nuke-symbol-in-package (symbol package-designator)
    (let ((package (find-package* package-designator))
          (name (symbol-name symbol)))
      (multiple-value-bind (sym stat) (find-symbol name package)
        (when (and (member stat '(:internal :external)) (eq symbol sym))
          (if (symbol-shadowing-p symbol package)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
217
218
              (shadowing-import* (get-dummy-symbol symbol) package)
              (unintern* symbol package))))))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
219
220
221
222
223
224
  (defun nuke-symbol (symbol &optional (packages (list-all-packages)))
    #+(or clisp clozure)
    (multiple-value-bind (setf-symbol kind)
        (get-setf-function-symbol symbol)
      (when kind (nuke-symbol setf-symbol)))
    (loop :for p :in packages :do (nuke-symbol-in-package symbol p)))
225
226
227
228
229
230
231
232
233
234
235
236
  (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))))
237
            (note-package-fishiness
238
239
240
             :rehome-symbol name
             (when old-package (package-name old-package)) old-status (and shadowing t)
             (package-name package) overwritten-symbol-status overwritten-symbol-shadowing-p)
241
242
            (when old-package
              (if shadowing
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
243
244
                  (shadowing-import* shadowing old-package))
              (unintern* symbol old-package))
245
246
            (cond
              (overwritten-symbol-shadowing-p
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
247
               (shadowing-import* symbol package))
248
249
              (t
               (when overwritten-symbol-status
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
250
251
                 (unintern* overwritten-symbol package))
               (import* symbol package)))
252
            (if shadowing
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
253
254
                (shadowing-import* symbol old-package)
                (import* symbol old-package))
255
256
257
258
259
260
            #+(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)))
261
262
263
264
265
266
                  (note-package-fishiness
                   :setf-function
                   name (package-name package)
                   (symbol-name setf-symbol) (symbol-package-name setf-symbol)
                   (symbol-name new-setf-symbol) (symbol-package-name new-setf-symbol))
                  (when (symbol-package setf-symbol)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
267
                    (unintern* setf-symbol (symbol-package setf-symbol)))
268
                  (setf (fdefinition new-setf-symbol) setf-function)
269
                  (set-setf-function-symbol new-setf-symbol symbol kind))))
270
            #+(or clisp clozure)
271
            (multiple-value-bind (overwritten-setf foundp)
272
                (get-setf-function-symbol overwritten-symbol)
273
274
275
              (when foundp
                (unintern overwritten-setf)))
            (when (eq old-status :external)
276
              (export* symbol old-package))
277
            (when (eq overwritten-symbol-status :external)
278
              (export* symbol package))))
279
        (values overwritten-symbol overwritten-symbol-status))))
280
281
282
  (defun ensure-package-unused (package)
    (loop :for p :in (package-used-by-list package) :do
      (unuse-package package p)))
283
  (defun delete-package* (package &key nuke)
284
285
    (let ((p (find-package package)))
      (when p
286
        (when nuke (do-symbols (s p) (when (home-package-p s p) (nuke-symbol s))))
287
288
        (ensure-package-unused p)
        (delete-package package))))
289
290
291
292
  (defun package-names (package)
    (cons (package-name package) (package-nicknames package)))
  (defun packages-from-names (names)
    (remove-duplicates (remove nil (mapcar #'find-package names)) :from-end t))
293
294
  (defun fresh-package-name (&key (prefix :%TO-BE-DELETED)
                               separator
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
295
296
                               (index (random most-positive-fixnum)))
    (loop :for i :from index
297
          :for n = (format nil "~A~@[~A~D~]" prefix (and (plusp i) (or separator "")) i)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
298
          :thereis (and (not (find-package n)) n)))
299
  (defun rename-package-away (p &rest keys &key prefix &allow-other-keys)
300
301
302
303
304
    (let ((new-name
            (apply 'fresh-package-name
                   :prefix (or prefix (format nil "__~A__" (package-name p))) keys)))
      (record-fishy (list :rename-away (package-names p) new-name))
      (rename-package p new-name))))
305
306
307
308
309


;;; Communicable representation of symbol and package information

(eval-when (:load-toplevel :compile-toplevel :execute)
310
311
312
313
314
315
  (defun package-definition-form (package-designator
                                  &key (nicknamesp t) (usep t)
                                    (shadowp t) (shadowing-import-p t)
                                    (exportp t) (importp t) internp (error t))
    (let* ((package (or (find-package* package-designator error)
                        (return-from package-definition-form nil)))
316
317
318
319
320
321
322
323
           (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 ()))
324
      (when package
325
326
327
328
329
330
331
332
333
334
335
336
        (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
337
                       ((and shadowing imported)
338
339
340
341
342
343
344
345
346
347
348
                        (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)
349
                   (sort (copy-list names) #'string<))
350
351
352
353
354
355
356
357
                 (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
358
             ,@(when-relevant :nicknames (and nicknamesp (sort-names nicknames)))
359
360
361
362
363
             (:use ,@(and usep (sort-names use)))
             ,@(when-relevant :shadow (and shadowp (sort-names shadow)))
             ,@(import-options :shadowing-import-from (and shadowing-import-p shadowing-import))
             ,@(import-options :import-from (and importp import))
             ,@(when-relevant :export (and exportp (sort-names export)))
364
             ,@(when-relevant :intern (and internp (sort-names intern)))))))))
365

366
367

;;; ensure-package, define-package
368
(eval-when (:load-toplevel :compile-toplevel :execute)
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
  (defun ensure-shadowing-import (name to-package from-package shadowed imported)
    (check-type name string)
    (check-type to-package package)
    (check-type from-package package)
    (check-type shadowed hash-table)
    (check-type imported hash-table)
    (let ((import-me (find-symbol* name from-package)))
      (multiple-value-bind (existing status) (find-symbol name to-package)
        (cond
          ((gethash name shadowed)
           (unless (eq import-me existing)
             (error "Conflicting shadowings for ~A" name)))
          (t
           (setf (gethash name shadowed) t)
           (setf (gethash name imported) t)
           (unless (or (null status)
                       (and (member status '(:internal :external))
                            (eq existing import-me)
                            (symbol-shadowing-p existing to-package)))
             (note-package-fishiness
              :shadowing-import name
              (package-name from-package)
              (or (home-package-p import-me from-package) (symbol-package-name import-me))
              (package-name to-package) status
393
              (and status (or (home-package-p existing to-package) (symbol-package-name existing)))))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
           (shadowing-import* import-me to-package))))))
  (defun ensure-imported (import-me into-package &optional from-package)
    (check-type import-me symbol)
    (check-type into-package package)
    (check-type from-package (or null package))
    (let ((name (symbol-name import-me)))
      (multiple-value-bind (existing status) (find-symbol name into-package)
        (cond
          ((not status)
           (import* import-me into-package))
          ((eq import-me existing))
          (t
           (let ((shadowing-p (symbol-shadowing-p existing into-package)))
             (note-package-fishiness
              :ensure-imported name
              (and from-package (package-name from-package))
              (or (home-package-p import-me from-package) (symbol-package-name import-me))
              (package-name into-package)
              status
              (and status (or (home-package-p existing into-package) (symbol-package-name existing)))
              shadowing-p)
             (cond
               ((or shadowing-p (eq status :inherited))
                (shadowing-import* import-me into-package))
               (t
                (unintern* existing into-package)
                (import* import-me into-package))))))))
    (values))
422
423
424
425
426
427
  (defun ensure-import (name to-package from-package shadowed imported)
    (check-type name string)
    (check-type to-package package)
    (check-type from-package package)
    (check-type shadowed hash-table)
    (check-type imported hash-table)
428
429
430
431
    (multiple-value-bind (import-me import-status) (find-symbol name from-package)
      (when (null import-status)
        (note-package-fishiness
         :import-uninterned name (package-name from-package) (package-name to-package))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
432
        (setf import-me (intern* name from-package)))
433
434
      (multiple-value-bind (existing status) (find-symbol name to-package)
        (cond
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
435
436
          ((and imported (gethash name imported))
           (unless (and status (eq import-me existing))
437
438
439
440
441
             (error "Can't import ~S from both ~S and ~S"
                    name (package-name (symbol-package existing)) (package-name from-package))))
          ((gethash name shadowed)
           (error "Can't both shadow ~S and import it from ~S" name (package-name from-package)))
          (t
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
442
443
           (setf (gethash name imported) t))))
      (ensure-imported import-me to-package from-package)))
444
445
446
447
448
  (defun ensure-inherited (name symbol to-package from-package mixp shadowed imported inherited)
    (check-type name string)
    (check-type symbol symbol)
    (check-type to-package package)
    (check-type from-package package)
449
    (check-type mixp (member nil t)) ; no cl:boolean on Genera
450
451
452
453
454
455
456
457
458
459
460
    (check-type shadowed hash-table)
    (check-type imported hash-table)
    (check-type inherited hash-table)
    (multiple-value-bind (existing status) (find-symbol name to-package)
      (let* ((sp (symbol-package symbol))
             (in (gethash name inherited))
             (xp (and status (symbol-package existing))))
        (when (null sp)
          (note-package-fishiness
           :import-uninterned name
           (package-name from-package) (package-name to-package) mixp)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
461
          (import* symbol from-package)
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
          (setf sp (package-name from-package)))
        (cond
          ((gethash name shadowed))
          (in
           (unless (equal sp (first in))
             (if mixp
                 (ensure-shadowing-import name to-package (second in) shadowed imported)
                 (error "Can't inherit ~S from ~S, it is inherited from ~S"
                        name (package-name sp) (package-name (first in))))))
          ((gethash name imported)
           (unless (eq symbol existing)
             (error "Can't inherit ~S from ~S, it is imported from ~S"
                    name (package-name sp) (package-name xp))))
          (t
           (setf (gethash name inherited) (list sp from-package))
           (when (and status (not (eq sp xp)))
             (let ((shadowing (symbol-shadowing-p existing to-package)))
               (note-package-fishiness
                :inherited name
                (package-name from-package)
                (or (home-package-p symbol from-package) (symbol-package-name symbol))
                (package-name to-package)
                (or (home-package-p existing to-package) (symbol-package-name existing)))
               (if shadowing (ensure-shadowing-import name to-package from-package shadowed imported)
                   (unintern* existing to-package)))))))))
  (defun ensure-mix (name symbol to-package from-package shadowed imported inherited)
    (check-type name string)
    (check-type symbol symbol)
    (check-type to-package package)
    (check-type from-package package)
    (check-type shadowed hash-table)
    (check-type imported hash-table)
    (check-type inherited hash-table)
    (unless (gethash name shadowed)
      (multiple-value-bind (existing status) (find-symbol name to-package)
        (let* ((sp (symbol-package symbol))
               (im (gethash name imported))
               (in (gethash name inherited)))
          (cond
            ((or (null status)
                 (and status (eq symbol existing))
                 (and in (eq sp (first in))))
             (ensure-inherited name symbol to-package from-package t shadowed imported inherited))
            (in
             (remhash name inherited)
             (ensure-shadowing-import name to-package (second in) shadowed imported))
            (im
509
             (error "Symbol ~S import from ~S~:[~; actually ~:[uninterned~;~:*from ~S~]~] conflicts with existing symbol in ~S~:[~; actually ~:[uninterned~;from ~:*~S~]~]"
510
511
512
513
514
515
                    name (package-name from-package)
                    (home-package-p symbol from-package) (symbol-package-name symbol)
                    (package-name to-package)
                    (home-package-p existing to-package) (symbol-package-name existing)))
            (t
             (ensure-inherited name symbol to-package from-package t shadowed imported inherited)))))))
516

517
  (defun recycle-symbol (name recycle exported)
518
519
520
521
522
523
    ;; Takes a symbol NAME (a string), a list of package designators for RECYCLE
    ;; packages, and a hash-table of names (strings) of symbols scheduled to be
    ;; EXPORTED from the package being defined. It returns two values, the
    ;; symbol found (if any, or else NIL), and a boolean flag indicating whether
    ;; a symbol was found. The caller (DEFINE-PACKAGE) will then do the
    ;; re-homing of the symbol, etc.
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
    (check-type name string)
    (check-type recycle list)
    (check-type exported hash-table)
    (when (gethash name exported) ;; don't bother recycling private symbols
      (let (recycled foundp)
        (dolist (r recycle (values recycled foundp))
          (multiple-value-bind (symbol status) (find-symbol name r)
            (when (and status (home-package-p symbol r))
              (cond
                (foundp
                 ;; (nuke-symbol symbol)) -- even simple variable names like O or C will do that.
                 (note-package-fishiness :recycled-duplicate name (package-name foundp) (package-name r)))
                (t
                 (setf recycled symbol foundp r)))))))))
  (defun symbol-recycled-p (sym recycle)
    (check-type sym symbol)
    (check-type recycle list)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
541
    (and (member (symbol-package sym) recycle) t))
542
543
544
  (defun ensure-symbol (name package intern recycle shadowed imported inherited exported)
    (check-type name string)
    (check-type package package)
545
    (check-type intern (member nil t)) ; no cl:boolean on Genera
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
    (check-type shadowed hash-table)
    (check-type imported hash-table)
    (check-type inherited hash-table)
    (unless (or (gethash name shadowed)
                (gethash name imported)
                (gethash name inherited))
      (multiple-value-bind (existing status)
          (find-symbol name package)
        (multiple-value-bind (recycled previous) (recycle-symbol name recycle exported)
          (cond
            ((and status (eq existing recycled) (eq previous package)))
            (previous
             (rehome-symbol recycled package))
            ((and status (eq package (symbol-package existing))))
            (t
             (when status
               (note-package-fishiness
                :ensure-symbol name
                (reify-package (symbol-package existing) package)
                status intern)
               (unintern existing))
             (when intern
               (intern* name package))))))))
569
  (declaim (ftype (function (t t t &optional t) t) ensure-exported))
570
571
572
573
574
  (defun ensure-exported-to-user (name symbol to-package &optional recycle)
    (check-type name string)
    (check-type symbol symbol)
    (check-type to-package package)
    (check-type recycle list)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
575
    (assert (equal name (symbol-name symbol)))
576
577
578
579
580
581
582
583
584
585
586
587
588
    (multiple-value-bind (existing status) (find-symbol name to-package)
      (unless (and status (eq symbol existing))
        (let ((accessible
                (or (null status)
                    (let ((shadowing (symbol-shadowing-p existing to-package))
                          (recycled (symbol-recycled-p existing recycle)))
                      (unless (and shadowing (not recycled))
                        (note-package-fishiness
                         :ensure-export name (symbol-package-name symbol)
                         (package-name to-package)
                         (or (home-package-p existing to-package) (symbol-package-name existing))
                         status shadowing)
                        (if (or (eq status :inherited) shadowing)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
589
                            (shadowing-import* symbol to-package)
590
591
592
593
594
595
596
                            (unintern existing to-package))
                        t)))))
          (when (and accessible (eq status :external))
            (ensure-exported name symbol to-package recycle))))))
  (defun ensure-exported (name symbol from-package &optional recycle)
    (dolist (to-package (package-used-by-list from-package))
      (ensure-exported-to-user name symbol to-package recycle))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
597
598
    (unless (eq from-package (symbol-package symbol))
      (ensure-imported symbol from-package))
599
600
601
602
603
    (export* name from-package))
  (defun ensure-export (name from-package &optional recycle)
    (multiple-value-bind (symbol status) (find-symbol* name from-package)
      (unless (eq status :external)
        (ensure-exported name symbol from-package recycle))))
604

605
606
607
608
609
610
611
612
613
614
615
  #+package-local-nicknames
  (defun install-package-local-nicknames (destination-package new-nicknames)
    ;; First, remove all package-local nicknames. (We'll reinstall any desired ones later.)
    (dolist (pair-to-remove (package-local-nicknames destination-package))
      (remove-package-local-nickname (string (car pair-to-remove)) destination-package))
    ;; Then, install all desired nicknames.
    (loop :for (nickname package) :in new-nicknames
          :do (add-package-local-nickname (string nickname)
                                          (find-package package)
                                          destination-package)))

616
617
618
619
620
  (defun ensure-package (name &key
                                nicknames documentation use
                                shadow shadowing-import-from
                                import-from export intern
                                recycle mix reexport
621
                                unintern local-nicknames)
622
    #+genera (declare (ignore documentation))
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
    (let* ((package-name (string name))
           (nicknames (mapcar #'string nicknames))
           (names (cons package-name nicknames))
           (previous (packages-from-names names))
           (discarded (cdr previous))
           (to-delete ())
           (package (or (first previous) (make-package package-name :nicknames nicknames)))
           (recycle (packages-from-names recycle))
           (use (mapcar 'find-package* use))
           (mix (mapcar 'find-package* mix))
           (reexport (mapcar 'find-package* reexport))
           (shadow (mapcar 'string shadow))
           (export (mapcar 'string export))
           (intern (mapcar 'string intern))
           (unintern (mapcar 'string unintern))
638
           (local-nicknames (mapcar #'(lambda (pair) (mapcar 'string pair)) local-nicknames))
639
640
641
642
643
           (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
           ;; string to list home package and use package:
           (inherited (make-hash-table :test 'equal)))
644
645
      #-package-local-nicknames
      (declare (ignore local-nicknames)) ; if not supported
646
      (when-package-fishiness (record-fishy package-name))
647
      ;; if supported, put package documentation
648
      #-genera
649
      (when documentation (setf (documentation package t) documentation))
650
      ;; remove unwanted packages from use list
651
652
653
      (loop :for p :in (set-difference (package-use-list package) (append mix use))
            :do (note-package-fishiness :over-use name (package-names p))
                (unuse-package p package))
654
      ;; mark unwanted packages for deletion
655
656
657
658
659
660
661
      (loop :for p :in discarded
            :for n = (remove-if #'(lambda (x) (member x names :test 'equal))
                                (package-names p))
            :do (note-package-fishiness :nickname name (package-names p))
                (cond (n (rename-package p (first n) (rest n)))
                      (t (rename-package-away p)
                         (push p to-delete))))
662
      ;; give package its desired name
663
      (rename-package package package-name nicknames)
664
665
      ;; Handle local nicknames
      #+package-local-nicknames
666
667
      (install-package-local-nicknames package local-nicknames)
      ;; handle uninterning unwanted symbols
668
669
670
671
672
673
674
      (dolist (name unintern)
        (multiple-value-bind (existing status) (find-symbol name package)
          (when status
            (unless (eq status :inherited)
              (note-package-fishiness
               :unintern (package-name package) name (symbol-package-name existing) status)
              (unintern* name package nil)))))
675
      ;; handle exports
676
677
      (dolist (name export)
        (setf (gethash name exported) t))
678
      ;; handle reexportss
679
680
681
      (dolist (p reexport)
        (do-external-symbols (sym p)
          (setf (gethash (string sym) exported) t)))
682
      ;; unexport symbols not listed in (re)export
683
684
685
686
687
688
689
      (do-external-symbols (sym package)
        (let ((name (symbol-name sym)))
          (unless (gethash name exported)
            (note-package-fishiness
             :over-export (package-name package) name
             (or (home-package-p sym package) (symbol-package-name sym)))
            (unexport sym package))))
690
      ;; handle explicitly listed shadowed ssymbols
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
      (dolist (name shadow)
        (setf (gethash name shadowed) t)
        (multiple-value-bind (existing status) (find-symbol name package)
          (multiple-value-bind (recycled previous) (recycle-symbol name recycle exported)
            (let ((shadowing (and status (symbol-shadowing-p existing package))))
              (cond
                ((eq previous package))
                (previous
                 (rehome-symbol recycled package))
                ((or (member status '(nil :inherited))
                     (home-package-p existing package)))
                (t
                 (let ((dummy (make-symbol name)))
                   (note-package-fishiness
                    :shadow-imported (package-name package) name
                    (symbol-package-name existing) status shadowing)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
707
708
709
                   (shadowing-import* dummy package)
                   (import* dummy package)))))))
        (shadow* name package))
710
      ;; handle shadowing imports
711
712
713
      (loop :for (p . syms) :in shadowing-import-from
            :for pp = (find-package* p) :do
              (dolist (sym syms) (ensure-shadowing-import (string sym) package pp shadowed imported)))
714
      ;; handle mixed packages
715
716
717
      (loop :for p :in mix
            :for pp = (find-package* p) :do
              (do-external-symbols (sym pp) (ensure-mix (symbol-name sym) sym package pp shadowed imported inherited)))
718
      ;; handle import-from packages
719
720
721
      (loop :for (p . syms) :in import-from
            :for pp = (find-package p) :do
              (dolist (sym syms) (ensure-import (symbol-name sym) package pp shadowed imported)))
722
      ;; handle use-list and mix
723
724
725
726
727
728
      (dolist (p (append use mix))
        (do-external-symbols (sym p) (ensure-inherited (string sym) sym package p nil shadowed imported inherited))
        (use-package p package))
      (loop :for name :being :the :hash-keys :of exported :do
        (ensure-symbol name package t recycle shadowed imported inherited exported)
        (ensure-export name package recycle))
729
      ;; intern dessired symbols
730
731
732
733
      (dolist (name intern)
        (ensure-symbol name package t recycle shadowed imported inherited exported))
      (do-symbols (sym package)
        (ensure-symbol (symbol-name sym) package nil recycle shadowed imported inherited exported))
734
      ;; delete now-deceased packages
735
736
      (map () 'delete-package* to-delete)
      package)))
737

738

739
(eval-when (:load-toplevel :compile-toplevel :execute)
740
  (defun parse-define-package-form (package clauses)
741
742
    (loop
      :with use-p = nil :with recycle-p = nil
743
      :with documentation = nil
744
      :for (kw . args) :in clauses
745
      :when (eq kw :nicknames) :append args :into nicknames :else
746
747
748
749
750
      :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
751
      :when (eq kw :use) :append args :into use :and :do (setf use-p t) :else
752
753
754
755
756
757
758
759
760
761
762
763
764
      :when (eq kw :shadow) :append args :into shadow :else
      :when (eq kw :shadowing-import-from) :collect args :into shadowing-import-from :else
      :when (eq kw :import-from) :collect args :into import-from :else
      :when (eq kw :export) :append args :into export :else
      :when (eq kw :intern) :append args :into intern :else
      :when (eq kw :recycle) :append args :into recycle :and :do (setf recycle-p t) :else
      :when (eq kw :mix) :append args :into mix :else
      :when (eq kw :reexport) :append args :into reexport :else
      :when (eq kw :use-reexport) :append args :into use :and :append args :into reexport
        :and :do (setf use-p t) :else
      :when (eq kw :mix-reexport) :append args :into mix :and :append args :into reexport
        :and :do (setf use-p t) :else
      :when (eq kw :unintern) :append args :into unintern :else
765
766
767
768
769
770
771
      :when (eq kw :local-nicknames)
        :if (symbol-call '#:uiop '#:featurep :package-local-nicknames)
          :append args :into local-nicknames
        :else
          :do (error ":LOCAL-NICKAMES option is not supported on this lisp implementation.")
        :end
      :else
772
        :do (error "unrecognized define-package keyword ~S" kw)
773
774
775
776
777
778
      :finally (return `(',package
                         :nicknames ',nicknames :documentation ',documentation
                         :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))
779
780
                         :mix ',mix :reexport ',reexport :unintern ',unintern
                         :local-nicknames ',local-nicknames)))))
781
782

(defmacro define-package (package &rest clauses)
783
  "DEFINE-PACKAGE takes a PACKAGE and a number of CLAUSES, of the form
784
785
\(KEYWORD . ARGS\).
DEFINE-PACKAGE supports the following keywords:
786
787
USE, SHADOW, SHADOWING-IMPORT-FROM, IMPORT-FROM, EXPORT, INTERN, NICKNAMES,
DOCUMENTATION -- as per CL:DEFPACKAGE.
788
789
790
791
792
793
794
795
796
797
RECYCLE -- Recycle the package's exported symbols from the specified packages,
in order.  For every symbol scheduled to be exported by the DEFINE-PACKAGE,
either through an :EXPORT option or a :REEXPORT option, if the symbol exists in
one of the :RECYCLE packages, the first such symbol is re-homed to the package
being defined.
For the sake of idempotence, it is important that the package being defined
should appear in first position if it already exists, and even if it doesn't,
ahead of any package that is not going to be deleted afterwards and never
created again. In short, except for special cases, always make it the first
package on the list if the list is not empty.
798
MIX -- Takes a list of package designators.  MIX behaves like
799
800
\(:USE PKG1 PKG2 ... PKGn\) but additionally uses :SHADOWING-IMPORT-FROM to
resolve conflicts in favor of the first found symbol.  It may still yield
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
801
an error if there is a conflict with an explicitly :IMPORT-FROM symbol.
802
803
804
REEXPORT -- Takes a list of package designators.  For each package, p, in the list,
export symbols with the same name as those exported from p.  Note that in the case
of shadowing, etc. the symbols with the same name may not be the same symbols.
805
806
807
808
UNINTERN -- Remove symbols here from PACKAGE.
LOCAL-NICKNAMES -- If the host implementation supports package local nicknames
\(check for the :PACKAGE-LOCAL-NICKNAMES feature\), then this should be a list of
nickname and package name pairs.  Using this option will cause an error if the
809
810
811
host CL implementation does not support it.
USE-REEXPORT, MIX-REEXPORT -- Use or mix the specified packages as per the USE or
MIX directives, and reexport their contents as per the REEXPORT directive."
812
  (let ((ensure-form
813
         `(prog1
814
              (funcall 'ensure-package ,@(parse-define-package-form package clauses))
815
            #+sbcl (setf (sb-impl::package-source-location (find-package ',package))
816
                         (sb-c:source-location)))))
817
    `(progn
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
818
       #+(or clasp ecl gcl mkcl) (defpackage ,package (:use))
819
820
       (eval-when (:compile-toplevel :load-toplevel :execute)
         ,ensure-form))))