Context Navigation

clos.lisp @ 15708

Visit:

Last change on this file since 15708 was 15708, checked in by Mark Evenson, 6 months ago
clos: fix typo in early ADD-DIRECT-SUBCLASS declamation
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 205.7 KB

Line
1	;;; clos.lisp
2	;;;
3	;;; Copyright (C) 2003-2007 Peter Graves
4	;;; Copyright (C) 2010-2013 Mark Evenson
5	;;; $Id: clos.lisp 15708 2023-06-06 09:29:54Z mevenson $
6	;;;
7	;;; This program is free software; you can redistribute it and/or
8	;;; modify it under the terms of the GNU General Public License
9	;;; as published by the Free Software Foundation; either version 2
10	;;; of the License, or (at your option) any later version.
11	;;;
12	;;; This program is distributed in the hope that it will be useful,
13	;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14	;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	;;; GNU General Public License for more details.
16	;;;
17	;;; You should have received a copy of the GNU General Public License
18	;;; along with this program; if not, write to the Free Software
19	;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20	;;;
21	;;; As a special exception, the copyright holders of this library give you
22	;;; permission to link this library with independent modules to produce an
23	;;; executable, regardless of the license terms of these independent
24	;;; modules, and to copy and distribute the resulting executable under
25	;;; terms of your choice, provided that you also meet, for each linked
26	;;; independent module, the terms and conditions of the license of that
27	;;; module. An independent module is a module which is not derived from
28	;;; or based on this library. If you modify this library, you may extend
29	;;; this exception to your version of the library, but you are not
30	;;; obligated to do so. If you do not wish to do so, delete this
31	;;; exception statement from your version.
32
33	;;; Originally based on Closette.
34
35	;;; Closette Version 1.0 (February 10, 1991)
36	;;;
37	;;; Copyright (c) 1990, 1991 Xerox Corporation.
38	;;; All rights reserved.
39	;;;
40	;;; Use and copying of this software and preparation of derivative works
41	;;; based upon this software are permitted. Any distribution of this
42	;;; software or derivative works must comply with all applicable United
43	;;; States export control laws.
44	;;;
45	;;; This software is made available AS IS, and Xerox Corporation makes no
46	;;; warranty about the software, its performance or its conformity to any
47	;;; specification.
48	;;;
49	;;; Closette is an implementation of a subset of CLOS with a metaobject
50	;;; protocol as described in "The Art of The Metaobject Protocol",
51	;;; MIT Press, 1991.
52
53	(in-package #:mop)
54
55	(export '(%defgeneric canonicalize-direct-superclasses))
56
57
58	;;
59	;;
60	;;
61	;; In order to bootstrap CLOS, first implement the required API as
62	;; normal functions which only apply to the "root" metaclass
63	;; STANDARD-CLASS.
64	;;
65	;; After putting the normal functions in place, the building blocks
66	;; are in place to gradually swap the normal functions with
67	;; generic functions and methods.
68	;;
69	;; Some functionality implemented in the temporary regular functions
70	;; needs to be available later as a method definition to be dispatched
71	;; to for the standard case, e.g. with arguments of type STANDARD-CLASS
72	;; or STANDARD-GENERIC-FUNCTION. To prevent repeated code, the
73	;; functions are implemented in functions by the same name as the API
74	;; functions, but with the STD- prefix. These functions are sometimes
75	;; used in regular code as well, either in a "fast path" or to break a
76	;; circularity (e.g., within compute-discriminating-function when the
77	;; user adds a method to compute-discriminating-function).
78	;;
79	;; When hacking this file, note that some important parts are implemented
80	;; in the Java world. These Java bits can be found in the files
81	;;
82	;; * LispClass.java
83	;; * SlotClass.java
84	;; * StandardClass.java
85	;; * BuiltInClass.java
86	;; * StandardObject.java
87	;; * StandardObjectFunctions.java
88	;; * FuncallableStandardObject.java
89	;; * Layout.java
90	;;
91	;; In case of function names, those defined on the Java side can be
92	;; recognized by their prefixed percent (%) sign.
93	;;
94	;; The API functions need to be declaimed NOTINLINE explicitly, because
95	;; that prevents inlining in the current FASL (which is allowed by the
96	;; CLHS without the declaration); this is a hard requirement to in order
97	;; to be able to swap the symbol's function slot with a generic function
98	;; later on - with it actually being used.
99	;;
100	;;
101	;;
102	;; ### Note that the "declares all API functions as regular functions"
103	;; isn't true when I write the above, but it's definitely the target.
104	;;
105	;; A note about AMOP: the first chapters (and the sample Closette
106	;; implementation) of the book sometimes deviate from the specification.
107	;; For example, in the examples slot-value-using-class has the slot name
108	;; as third argument where in the specification it is the effective slot
109	;; definition. When in doubt, we aim to follow the specification, the
110	;; MOP test suite at http://common-lisp.net/project/closer/features.html
111	;; and the behavior of other CL implementations in preference to
112	;; chapters 1-4 and appendix D.
113
114	(defconstant +the-standard-class+ (find-class 'standard-class))
115	(defconstant +the-funcallable-standard-class+
116	(find-class 'funcallable-standard-class))
117	(defconstant +the-standard-object-class+ (find-class 'standard-object))
118	(defconstant +the-funcallable-standard-object-class+
119	(find-class 'funcallable-standard-object))
120	(defconstant +the-standard-method-class+ (find-class 'standard-method))
121	(defconstant +the-T-class+ (find-class 'T))
122	(defconstant +the-standard-slot-definition-class+ (find-class 'standard-slot-definition))
123	(defconstant +the-standard-direct-slot-definition-class+ (find-class 'standard-direct-slot-definition))
124	(defconstant +the-standard-effective-slot-definition-class+ (find-class 'standard-effective-slot-definition))
125
126	;; Don't use DEFVAR, because that disallows loading clos.lisp
127	;; after compiling it: the binding won't get assigned to T anymore
128	(defparameter clos-booting t)
129
130	(defmacro define-class->%class-forwarder (name)
131	(let* (($name (if (consp name) (cadr name) name))
132	(%name (intern (concatenate 'string
133	"%"
134	(if (consp name)
135	(symbol-name 'set-) "")
136	(symbol-name $name))
137	(symbol-package $name))))
138	`(progn
139	(declaim (notinline ,name))
140	(defun ,name (&rest args)
141	(apply #',%name args)))))
142
143	;;
144	;; DEFINE PLACE HOLDER FUNCTIONS
145	;;
146
147	(define-class->%class-forwarder class-name)
148	(define-class->%class-forwarder (setf class-name))
149	(define-class->%class-forwarder class-slots)
150	(define-class->%class-forwarder (setf class-slots))
151	(define-class->%class-forwarder class-direct-slots)
152	(define-class->%class-forwarder (setf class-direct-slots))
153	(define-class->%class-forwarder class-layout)
154	(define-class->%class-forwarder (setf class-layout))
155	(define-class->%class-forwarder class-direct-superclasses)
156	(define-class->%class-forwarder (setf class-direct-superclasses))
157	(define-class->%class-forwarder class-direct-subclasses)
158	(define-class->%class-forwarder (setf class-direct-subclasses))
159	(define-class->%class-forwarder class-direct-methods)
160	(define-class->%class-forwarder (setf class-direct-methods))
161	(define-class->%class-forwarder class-precedence-list)
162	(define-class->%class-forwarder (setf class-precedence-list))
163	(define-class->%class-forwarder class-finalized-p)
164	(define-class->%class-forwarder (setf class-finalized-p))
165	(define-class->%class-forwarder class-default-initargs)
166	(define-class->%class-forwarder (setf class-default-initargs))
167	(define-class->%class-forwarder class-direct-default-initargs)
168	(define-class->%class-forwarder (setf class-direct-default-initargs))
169
170	(declaim (notinline add-direct-subclass remove-direct-subclass))
171	(defun add-direct-subclass (superclass subclass)
172	(setf (class-direct-subclasses superclass)
173	(adjoin subclass (class-direct-subclasses superclass))))
174	(defun remove-direct-subclass (superclass subclass)
175	(setf (class-direct-subclasses superclass)
176	(remove subclass (class-direct-subclasses superclass))))
177
178	(defun fixup-standard-class-hierarchy ()
179	;; Make the result of class-direct-subclasses for the pre-built
180	;; classes agree with AMOP Table 5.1 (pg. 141). This could be done in
181	;; StandardClass.java where these classes are defined, but it's less
182	;; painful to do it Lisp-side.
183	(flet ((add-subclasses (class subclasses)
184	(when (atom subclasses) (setf subclasses (list subclasses)))
185	(setf (class-direct-subclasses (find-class class))
186	(union (class-direct-subclasses (find-class class))
187	(mapcar #'find-class subclasses)))))
188	(add-subclasses t 'standard-object)
189	(add-subclasses 'function 'funcallable-standard-object)
190	(add-subclasses 'standard-object '(funcallable-standard-object metaobject))
191	(add-subclasses 'metaobject
192	'(method slot-definition specializer))
193	(add-subclasses 'specializer '(class))
194	(add-subclasses 'method 'standard-method)
195	(add-subclasses 'slot-definition
196	'(direct-slot-definition effective-slot-definition
197	standard-slot-definition))
198	(add-subclasses 'standard-slot-definition
199	'(standard-direct-slot-definition
200	standard-effective-slot-definition))
201	(add-subclasses 'direct-slot-definition 'standard-direct-slot-definition)
202	(add-subclasses 'effective-slot-definition
203	'standard-effective-slot-definition)
204	(add-subclasses 'class
205	'(built-in-class standard-class funcallable-standard-class))))
206	(fixup-standard-class-hierarchy)
207
208	(defun std-class-p (class)
209	(let ((metaclass (class-of class)))
210	(or (eq metaclass +the-standard-class+)
211	(eq metaclass +the-funcallable-standard-class+))))
212
213	(defun no-applicable-method (generic-function &rest args)
214	(error "There is no applicable method for the generic function ~S when called with arguments ~S."
215	generic-function
216	args))
217
218	(defun function-keywords (method)
219	(std-function-keywords method))
220
221	(declaim (notinline map-dependents))
222	(defun map-dependents (metaobject function)
223	;; stub, will be redefined later
224	(declare (ignore metaobject function))
225	nil)
226
227	(defmacro push-on-end (value location)
228	`(setf ,location (nconc ,location (list ,value))))
229
230	;;; (SETF GETF*) is like (SETF GETF) except that it always changes the list,
231	;;; which must be non-nil.
232
233	(defun (setf getf*) (new-value plist key)
234	(block body
235	(do ((x plist (cddr x)))
236	((null x))
237	(when (eq (car x) key)
238	(setf (car (cdr x)) new-value)
239	(return-from body new-value)))
240	(push-on-end key plist)
241	(push-on-end new-value plist)
242	new-value))
243
244	(defun mapappend (fun &rest args)
245	(if (some #'null args)
246	()
247	(append (apply fun (mapcar #'car args))
248	(apply #'mapappend fun (mapcar #'cdr args)))))
249
250	(defun mapplist (fun x)
251	(if (null x)
252	()
253	(cons (funcall fun (car x) (cadr x))
254	(mapplist fun (cddr x)))))
255
256	(defsetf std-slot-value set-std-slot-value)
257
258	(defsetf std-instance-layout %set-std-instance-layout)
259	(defsetf standard-instance-access %set-standard-instance-access)
260	(defun funcallable-standard-instance-access (instance location)
261	(standard-instance-access instance location))
262	(defsetf funcallable-standard-instance-access %set-standard-instance-access)
263
264	(defun (setf find-class) (new-value symbol &optional errorp environment)
265	(declare (ignore errorp environment))
266	(%set-find-class symbol new-value))
267
268	(defun canonicalize-direct-slots (direct-slots)
269	`(list ,@(mapcar #'canonicalize-direct-slot direct-slots)))
270
271	(defun canonicalize-direct-slot (spec)
272	(if (symbolp spec)
273	`(list :name ',spec)
274	(let ((name (car spec))
275	(initfunction nil)
276	(initform nil)
277	(initargs ())
278	(type nil)
279	(allocation nil)
280	(documentation nil)
281	(readers ())
282	(writers ())
283	(other-options ())
284	(non-std-options ()))
285	(do ((olist (cdr spec) (cddr olist)))
286	((null olist))
287	(case (car olist)
288	(:initform
289	(when initform
290	(error 'program-error
291	"duplicate slot option :INITFORM for slot named ~S"
292	name))
293	(setq initfunction t)
294	(setq initform (cadr olist)))
295	(:initarg
296	(push-on-end (cadr olist) initargs))
297	(:allocation
298	(when allocation
299	(error 'program-error
300	"duplicate slot option :ALLOCATION for slot named ~S"
301	name))
302	(setf allocation (cadr olist))
303	(push-on-end (car olist) other-options)
304	(push-on-end (cadr olist) other-options))
305	(:type
306	(when type
307	(error 'program-error
308	"duplicate slot option :TYPE for slot named ~S"
309	name))
310	(setf type (cadr olist)))
311	(:documentation
312	(when documentation
313	(error 'program-error
314	"duplicate slot option :DOCUMENTATION for slot named ~S"
315	name))
316	(setf documentation (cadr olist)))
317	(:reader
318	(maybe-note-name-defined (cadr olist))
319	(push-on-end (cadr olist) readers))
320	(:writer
321	(maybe-note-name-defined (cadr olist))
322	(push-on-end (cadr olist) writers))
323	(:accessor
324	(maybe-note-name-defined (cadr olist))
325	(push-on-end (cadr olist) readers)
326	(push-on-end `(setf ,(cadr olist)) writers))
327	(t
328	(push-on-end (cadr olist) (getf non-std-options (car olist))))))
329	`(list
330	:name ',name
331	,@(when initfunction
332	`(:initform ',initform
333	:initfunction ,(if (eq allocation :class)
334	;; CLHS specifies the initform for a
335	;; class allocation level slot needs
336	;; to be evaluated in the dynamic
337	;; extent of the DEFCLASS form
338	(let ((var (gensym)))
339	`(let ((,var ,initform))
340	(lambda () ,var)))
341	`(lambda () ,initform))))
342	,@(when initargs `(:initargs ',initargs))
343	,@(when readers `(:readers ',readers))
344	,@(when writers `(:writers ',writers))
345	,@(when type `(:type ',type))
346	,@(when documentation `(:documentation ',documentation))
347	,@other-options
348	,@(mapcar #'(lambda (opt) (if (or (atom opt) (/= 1 (length opt)))
349	`',opt
350	`',(car opt)))
351	non-std-options)))))
352
353	(defun maybe-note-name-defined (name)
354	(when (fboundp 'note-name-defined)
355	(note-name-defined name)))
356
357	(defun canonicalize-defclass-options (options)
358	(mapappend #'canonicalize-defclass-option options))
359
360	(defun canonicalize-defclass-option (option)
361	(case (car option)
362	(:metaclass
363	(list ':metaclass
364	`(find-class ',(cadr option))))
365	(:default-initargs
366	(list
367	':direct-default-initargs
368	`(list ,@(mapplist
369	#'(lambda (key value)
370	`(list ',key ',value ,(make-initfunction value)))
371	(cdr option)))))
372	((:documentation :report)
373	(list (car option) `',(cadr option)))
374	(t (list `(quote ,(car option)) `(quote ,(cdr option))))))
375
376	(defun make-initfunction (initform)
377	`(function (lambda () ,initform)))
378
379	(defun slot-definition-allocation (slot-definition)
380	(std-slot-value slot-definition 'sys::allocation))
381
382	(declaim (notinline (setf slot-definition-allocation)))
383	(defun (setf slot-definition-allocation) (value slot-definition)
384	(setf (std-slot-value slot-definition 'sys::allocation) value))
385
386	(defun slot-definition-initargs (slot-definition)
387	(std-slot-value slot-definition 'sys::initargs))
388
389	(declaim (notinline (setf slot-definition-initargs)))
390	(defun (setf slot-definition-initargs) (value slot-definition)
391	(setf (std-slot-value slot-definition 'sys::initargs) value))
392
393	(defun slot-definition-initform (slot-definition)
394	(std-slot-value slot-definition 'sys::initform))
395
396	(declaim (notinline (setf slot-definition-initform)))
397	(defun (setf slot-definition-initform) (value slot-definition)
398	(setf (std-slot-value slot-definition 'sys::initform) value))
399
400	(defun slot-definition-initfunction (slot-definition)
401	(std-slot-value slot-definition 'sys::initfunction))
402
403	(declaim (notinline (setf slot-definition-initfunction)))
404	(defun (setf slot-definition-initfunction) (value slot-definition)
405	(setf (std-slot-value slot-definition 'sys::initfunction) value))
406
407	(defun slot-definition-name (slot-definition)
408	(std-slot-value slot-definition 'sys:name))
409
410	(declaim (notinline (setf slot-definition-name)))
411	(defun (setf slot-definition-name) (value slot-definition)
412	(setf (std-slot-value slot-definition 'sys:name) value))
413
414	(defun slot-definition-readers (slot-definition)
415	(std-slot-value slot-definition 'sys::readers))
416
417	(declaim (notinline (setf slot-definition-readers)))
418	(defun (setf slot-definition-readers) (value slot-definition)
419	(setf (std-slot-value slot-definition 'sys::readers) value))
420
421	(defun slot-definition-writers (slot-definition)
422	(std-slot-value slot-definition 'sys::writers))
423
424	(declaim (notinline (setf slot-definition-writers)))
425	(defun (setf slot-definition-writers) (value slot-definition)
426	(setf (std-slot-value slot-definition 'sys::writers) value))
427
428	(defun slot-definition-allocation-class (slot-definition)
429	(std-slot-value slot-definition 'sys::allocation-class))
430
431	(declaim (notinline (setf slot-definition-allocation-class)))
432	(defun (setf slot-definition-allocation-class) (value slot-definition)
433	(setf (std-slot-value slot-definition 'sys::allocation-class) value))
434
435	(defun slot-definition-location (slot-definition)
436	(std-slot-value slot-definition 'sys::location))
437
438	(declaim (notinline (setf slot-definition-location-class)))
439	(defun (setf slot-definition-location) (value slot-definition)
440	(setf (std-slot-value slot-definition 'sys::location) value))
441
442	(defun slot-definition-type (slot-definition)
443	(std-slot-value slot-definition 'sys::%type))
444
445	(declaim (notinline (setf slot-definition-type)))
446	(defun (setf slot-definition-type) (value slot-definition)
447	(setf (std-slot-value slot-definition 'sys::%type) value))
448
449	(defun slot-definition-documentation (slot-definition)
450	(std-slot-value slot-definition 'sys:%documentation))
451
452	(declaim (notinline (setf slot-definition-documentation)))
453	(defun (setf slot-definition-documentation) (value slot-definition)
454	(setf (std-slot-value slot-definition 'sys:%documentation) value))
455
456	(defun init-slot-definition (slot &key name
457	(initargs ())
458	(initform nil)
459	(initfunction nil)
460	(readers ())
461	(writers ())
462	(allocation :instance)
463	(allocation-class nil)
464	(type t)
465	(documentation nil))
466	(setf (slot-definition-name slot) name)
467	(setf (slot-definition-initargs slot) initargs)
468	(setf (slot-definition-initform slot) initform)
469	(setf (slot-definition-initfunction slot) initfunction)
470	(setf (slot-definition-readers slot) readers)
471	(setf (slot-definition-writers slot) writers)
472	(setf (slot-definition-allocation slot) allocation)
473	(setf (slot-definition-allocation-class slot) allocation-class)
474	(setf (slot-definition-type slot) type)
475	(setf (slot-definition-documentation slot) documentation)
476	slot)
477
478	(declaim (notinline direct-slot-definition-class))
479	(defun direct-slot-definition-class (class &rest args)
480	(declare (ignore class args))
481	+the-standard-direct-slot-definition-class+)
482
483	(defun make-direct-slot-definition (class &rest args)
484	(let ((slot-class (apply #'direct-slot-definition-class class args)))
485	(if (eq slot-class +the-standard-direct-slot-definition-class+)
486	(let ((slot (%make-slot-definition +the-standard-direct-slot-definition-class+)))
487	(apply #'init-slot-definition slot :allocation-class class args)
488	slot)
489	(progn
490	(let ((slot (apply #'make-instance slot-class :allocation-class class
491	args)))
492	slot)))))
493
494	(declaim (notinline effective-slot-definition-class))
495	(defun effective-slot-definition-class (class &rest args)
496	(declare (ignore class args))
497	+the-standard-effective-slot-definition-class+)
498
499	(defun make-effective-slot-definition (class &rest args)
500	(let ((slot-class (apply #'effective-slot-definition-class class args)))
501	(if (eq slot-class +the-standard-effective-slot-definition-class+)
502	(let ((slot (%make-slot-definition +the-standard-effective-slot-definition-class+)))
503	(apply #'init-slot-definition slot args)
504	slot)
505	(progn
506	(let ((slot (apply #'make-instance slot-class args)))
507	slot)))))
508
509	;;; finalize-inheritance
510
511	(declaim (notinline compute-default-initargs))
512	(defun compute-default-initargs (class)
513	(std-compute-default-initargs class))
514
515	(defun std-compute-default-initargs (class)
516	(delete-duplicates
517	(mapcan #'(lambda (c)
518	(copy-list
519	(class-direct-default-initargs c)))
520	(class-precedence-list class))
521	:key #'car :from-end t))
522
523	(defun std-finalize-inheritance (class)
524	;; In case the class is already finalized, return
525	;; immediately, as per AMOP.
526	; (when (class-finalized-p class)
527	; (return-from std-finalize-inheritance))
528	(setf (class-precedence-list class)
529	(funcall (if (std-class-p class)
530	#'std-compute-class-precedence-list
531	#'compute-class-precedence-list)
532	class))
533	(setf (class-slots class)
534	(funcall (if (std-class-p class)
535	#'std-compute-slots
536	#'compute-slots) class))
537	(let ((old-layout (class-layout class))
538	(length 0)
539	(instance-slots '())
540	(shared-slots '()))
541	(dolist (slot (class-slots class))
542	(case (slot-definition-allocation slot)
543	(:instance
544	(setf (slot-definition-location slot) length)
545	(incf length)
546	(push (slot-definition-name slot) instance-slots))
547	(:class
548	(unless (slot-definition-location slot)
549	(let ((allocation-class (slot-definition-allocation-class slot)))
550	(if (eq allocation-class class)
551	;; We initialize class slots here so they can be
552	;; accessed without creating a dummy instance.
553	(let ((initfunction (slot-definition-initfunction slot)))
554	(setf (slot-definition-location slot)
555	(cons (slot-definition-name slot)
556	(if initfunction
557	(funcall initfunction)
558	+slot-unbound+))))
559	(setf (slot-definition-location slot)
560	(slot-location allocation-class (slot-definition-name slot))))))
561	(push (slot-definition-location slot) shared-slots))))
562	(when old-layout
563	;; Redefined class: initialize added shared slots.
564	(dolist (location shared-slots)
565	(let* ((slot-name (car location))
566	(old-location (layout-slot-location old-layout slot-name)))
567	(unless old-location
568	(let* ((slot-definition (find slot-name (class-slots class) :key 'slot-definition-name))
569	(initfunction (slot-definition-initfunction slot-definition)))
570	(when initfunction
571	(setf (cdr location) (funcall initfunction))))))))
572	(setf (class-layout class)
573	(make-layout class (nreverse instance-slots) (nreverse shared-slots))))
574	(setf (class-default-initargs class)
575	(compute-default-initargs class))
576	(setf (class-finalized-p class) t))
577
578	(declaim (notinline finalize-inheritance))
579	(defun finalize-inheritance (class)
580	(std-finalize-inheritance class))
581
582
583	;;; Class precedence lists
584
585	(defun std-compute-class-precedence-list (class)
586	(let ((classes-to-order (collect-superclasses* class)))
587	(dolist (super classes-to-order)
588	(when (typep super 'forward-referenced-class)
589	(error "Can't compute class precedence list for class ~A ~
590	which depends on forward referenced class ~A." class super)))
591	(topological-sort classes-to-order
592	(remove-duplicates
593	(mapappend #'local-precedence-ordering
594	classes-to-order))
595	#'std-tie-breaker-rule)))
596
597	;;; topological-sort implements the standard algorithm for topologically
598	;;; sorting an arbitrary set of elements while honoring the precedence
599	;;; constraints given by a set of (X,Y) pairs that indicate that element
600	;;; X must precede element Y. The tie-breaker procedure is called when it
601	;;; is necessary to choose from multiple minimal elements; both a list of
602	;;; candidates and the ordering so far are provided as arguments.
603
604	(defun topological-sort (elements constraints tie-breaker)
605	(let ((remaining-constraints constraints)
606	(remaining-elements elements)
607	(result ()))
608	(loop
609	(let ((minimal-elements
610	(remove-if
611	#'(lambda (class)
612	(member class remaining-constraints
613	:key #'cadr))
614	remaining-elements)))
615	(when (null minimal-elements)
616	(if (null remaining-elements)
617	(return-from topological-sort result)
618	(error "Inconsistent precedence graph.")))
619	(let ((choice (if (null (cdr minimal-elements))
620	(car minimal-elements)
621	(funcall tie-breaker
622	minimal-elements
623	result))))
624	(setq result (append result (list choice)))
625	(setq remaining-elements
626	(remove choice remaining-elements))
627	(setq remaining-constraints
628	(remove choice
629	remaining-constraints
630	:test #'member)))))))
631
632	;;; In the event of a tie while topologically sorting class precedence lists,
633	;;; the CLOS Specification says to "select the one that has a direct subclass
634	;;; rightmost in the class precedence list computed so far." The same result
635	;;; is obtained by inspecting the partially constructed class precedence list
636	;;; from right to left, looking for the first minimal element to show up among
637	;;; the direct superclasses of the class precedence list constituent.
638	;;; (There's a lemma that shows that this rule yields a unique result.)
639
640	(defun std-tie-breaker-rule (minimal-elements cpl-so-far)
641	(dolist (cpl-constituent (reverse cpl-so-far))
642	(let* ((supers (class-direct-superclasses cpl-constituent))
643	(common (intersection minimal-elements supers)))
644	(when (not (null common))
645	(return-from std-tie-breaker-rule (car common))))))
646
647	;;; This version of collect-superclasses* isn't bothered by cycles in the class
648	;;; hierarchy, which sometimes happen by accident.
649
650	(defun collect-superclasses* (class)
651	(labels ((all-superclasses-loop (seen superclasses)
652	(let ((to-be-processed
653	(set-difference superclasses seen)))
654	(if (null to-be-processed)
655	superclasses
656	(let ((class-to-process
657	(car to-be-processed)))
658	(all-superclasses-loop
659	(cons class-to-process seen)
660	(union (class-direct-superclasses
661	class-to-process)
662	superclasses)))))))
663	(all-superclasses-loop () (list class))))
664
665	;;; The local precedence ordering of a class C with direct superclasses C_1,
666	;;; C_2, ..., C_n is the set ((C C_1) (C_1 C_2) ...(C_n-1 C_n)).
667
668	(defun local-precedence-ordering (class)
669	(mapcar #'list
670	(cons class
671	(butlast (class-direct-superclasses class)))
672	(class-direct-superclasses class)))
673
674	;;; Slot inheritance
675
676	(defun std-compute-slots (class)
677	(let* ((all-slots (mapappend #'(lambda (c) (class-direct-slots c))
678	;; Slots of base class must come first
679	(reverse (class-precedence-list class))))
680	(all-names (delete-duplicates
681	(mapcar 'slot-definition-name all-slots)
682	:from-end t)))
683	(mapcar #'(lambda (name)
684	(funcall
685	(if (std-class-p class)
686	#'std-compute-effective-slot-definition
687	#'compute-effective-slot-definition)
688	class
689	name
690	;; Slot of inherited class must override initfunction,
691	;; documentation of base class
692	(nreverse
693	(remove name all-slots
694	:key 'slot-definition-name
695	:test-not #'eq))))
696	all-names)))
697
698	(defun std-compute-effective-slot-definition (class name direct-slots)
699	(let ((initer (find-if-not #'null direct-slots
700	:key 'slot-definition-initfunction))
701	(documentation-slot (find-if-not #'null direct-slots
702	:key 'slot-definition-documentation))
703	(types (delete-duplicates
704	(delete t (mapcar #'slot-definition-type direct-slots))
705	:test #'equal)))
706	(make-effective-slot-definition
707	class
708	:name name
709	:initform (if initer
710	(slot-definition-initform initer)
711	nil)
712	:initfunction (if initer
713	(slot-definition-initfunction initer)
714	nil)
715	:initargs (remove-duplicates
716	(mapappend 'slot-definition-initargs
717	direct-slots))
718	:allocation (slot-definition-allocation (car direct-slots))
719	:allocation-class (when (slot-boundp (car direct-slots)
720	'sys::allocation-class)
721	;;for some classes created in Java
722	;;(e.g. SimpleCondition) this slot is unbound
723	(slot-definition-allocation-class (car direct-slots)))
724	:type (cond ((null types) t)
725	((= 1 (length types)) types)
726	(t (list* 'and types)))
727	:documentation (if documentation-slot
728	(documentation documentation-slot t)
729	nil))))
730
731	;;; Standard instance slot access
732
733	;;; N.B. The location of the effective-slots slots in the class metaobject for
734	;;; standard-class must be determined without making any further slot
735	;;; references.
736
737	(defun find-slot-definition (class slot-name)
738	(dolist (slot (class-slots class) nil)
739	(when (eq slot-name (slot-definition-name slot))
740	(return slot))))
741
742	(defun slot-location (class slot-name)
743	(let ((slot (find-slot-definition class slot-name)))
744	(if slot
745	(slot-definition-location slot)
746	nil)))
747
748	(defun instance-slot-location (instance slot-name)
749	(let ((layout (std-instance-layout instance)))
750	(and layout (layout-slot-location layout slot-name))))
751
752	(defun slot-value (object slot-name)
753	(let* ((class (class-of object))
754	(metaclass (class-of class)))
755	(if (or (eq metaclass +the-standard-class+)
756	(eq metaclass +the-structure-class+)
757	(eq metaclass +the-funcallable-standard-class+))
758	(std-slot-value object slot-name)
759	(slot-value-using-class class object
760	(find-slot-definition class slot-name)))))
761
762	(defun %set-slot-value (object slot-name new-value)
763	(let* ((class (class-of object))
764	(metaclass (class-of class)))
765	(if (or (eq metaclass +the-standard-class+)
766	(eq metaclass +the-structure-class+)
767	(eq metaclass +the-funcallable-standard-class+))
768	(setf (std-slot-value object slot-name) new-value)
769	(setf (slot-value-using-class class object
770	(find-slot-definition class slot-name))
771	new-value))))
772
773	(defsetf slot-value %set-slot-value)
774
775	(defun slot-boundp (object slot-name)
776	(let ((class (class-of object)))
777	(if (std-class-p class)
778	(std-slot-boundp object slot-name)
779	(slot-boundp-using-class class object
780	(find-slot-definition class slot-name)))))
781
782	(defun std-slot-makunbound (instance slot-name)
783	(let ((location (instance-slot-location instance slot-name)))
784	(cond ((fixnump location)
785	(setf (standard-instance-access instance location) +slot-unbound+))
786	((consp location)
787	(setf (cdr location) +slot-unbound+))
788	(t
789	(slot-missing (class-of instance) instance slot-name 'slot-makunbound))))
790	instance)
791
792	(defun slot-makunbound (object slot-name)
793	(let ((class (class-of object)))
794	(if (std-class-p class)
795	(std-slot-makunbound object slot-name)
796	(slot-makunbound-using-class class object
797	(find-slot-definition class slot-name)))))
798
799	(defun std-slot-exists-p (instance slot-name)
800	(not (null (find slot-name (class-slots (class-of instance))
801	:key 'slot-definition-name))))
802
803	(defun slot-exists-p (object slot-name)
804	(let ((class (class-of object)))
805	(if (std-class-p class)
806	(std-slot-exists-p object slot-name)
807	(slot-exists-p-using-class class object slot-name))))
808
809	(defun instance-slot-p (slot)
810	(eq (slot-definition-allocation slot) :instance))
811
812	(defun std-allocate-instance (class)
813	(sys::%std-allocate-instance class))
814
815	(defun allocate-funcallable-instance (class)
816	(let ((instance (sys::%allocate-funcallable-instance class)))
817	;; KLUDGE: without this, the build fails with unbound-slot
818	(when (or (eq class +the-standard-generic-function-class+)
819	(subtypep class +the-standard-generic-function-class+))
820	(setf (std-slot-value instance 'sys::method-class)
821	+the-standard-method-class+))
822	(set-funcallable-instance-function
823	instance
824	#'(lambda (&rest args)
825	(declare (ignore args))
826	(error 'program-error "Called a funcallable-instance with unset function.")))
827	instance))
828
829	(declaim (notinline class-prototype))
830	(defun class-prototype (class)
831	(unless (class-finalized-p class) (error "Class ~A not finalized" (class-name class)))
832	(std-allocate-instance class))
833
834	(defun maybe-finalize-class-subtree (class)
835	(when (every #'class-finalized-p (class-direct-superclasses class))
836	(finalize-inheritance class)
837	(dolist (subclass (class-direct-subclasses class))
838	(maybe-finalize-class-subtree subclass))))
839
840	(defun make-instance-standard-class (metaclass
841	&rest initargs
842	&key name direct-superclasses direct-slots
843	direct-default-initargs
844	documentation)
845	(declare (ignore metaclass))
846	(let ((class (std-allocate-instance +the-standard-class+)))
847	(unless clos-booting
848	(check-initargs (list #'allocate-instance #'initialize-instance)
849	(list* class initargs)
850	class t initargs
851	make-instance-initargs-cache 'make-instance))
852	(%set-class-name name class)
853	;; KLUDGE: necessary in define-primordial-class, otherwise
854	;; StandardClass.getClassLayout() throws an error
855	(unless clos-booting (%set-class-layout nil class))
856	(%set-class-direct-subclasses () class)
857	(%set-class-direct-methods () class)
858	(%set-class-documentation class documentation)
859	(std-after-initialization-for-classes class
860	:direct-superclasses direct-superclasses
861	:direct-slots direct-slots
862	:direct-default-initargs direct-default-initargs)
863	class))
864
865	(defun make-or-find-instance-funcallable-standard-class
866	(metaclass &rest initargs &key name direct-superclasses direct-slots
867	direct-default-initargs documentation)
868	(declare (ignore metaclass initargs))
869	(or (find-class name nil)
870	(let ((class (std-allocate-instance +the-funcallable-standard-class+)))
871	(%set-class-name name class)
872	(unless clos-booting (%set-class-layout nil class))
873	(%set-class-direct-subclasses () class)
874	(%set-class-direct-methods () class)
875	(%set-class-documentation class documentation)
876	(std-after-initialization-for-classes class
877	:direct-superclasses direct-superclasses
878	:direct-slots direct-slots
879	:direct-default-initargs direct-default-initargs)
880	class)))
881
882	;(defun convert-to-direct-slot-definition (class canonicalized-slot)
883	; (apply #'make-instance
884	; (apply #'direct-slot-definition-class
885	; class canonicalized-slot)
886	; canonicalized-slot))
887
888	(defun canonicalize-direct-superclass-list (class direct-superclasses)
889	(cond (direct-superclasses)
890	((subtypep (class-of class) +the-funcallable-standard-class+)
891	(list +the-funcallable-standard-object-class+))
892	((subtypep (class-of class) +the-standard-class+)
893	(list +the-standard-object-class+))))
894
895	(defun std-after-initialization-for-classes (class
896	&key direct-superclasses direct-slots
897	direct-default-initargs
898	&allow-other-keys)
899	(let ((supers (canonicalize-direct-superclass-list class direct-superclasses)))
900	(setf (class-direct-superclasses class) supers)
901	(dolist (superclass supers)
902	(add-direct-subclass superclass class)))
903	(let ((slots (mapcar #'(lambda (slot-properties)
904	(apply #'make-direct-slot-definition class slot-properties))
905	direct-slots)))
906	(setf (class-direct-slots class) slots)
907	(dolist (direct-slot slots)
908	(dolist (reader (slot-definition-readers direct-slot))
909	(add-reader-method class reader direct-slot))
910	(dolist (writer (slot-definition-writers direct-slot))
911	(add-writer-method class writer direct-slot))))
912	(setf (class-direct-default-initargs class) direct-default-initargs)
913	(maybe-finalize-class-subtree class)
914	(values))
915
916	(defmacro define-primordial-class (name superclasses direct-slots)
917	"Primitive class definition tool.
918	No non-standard metaclasses, accessor methods, duplicate slots,
919	non-existent superclasses, default initargs, or other complicated stuff.
920	Handle with care."
921	(let ((class (gensym)))
922	`(let ((,class (make-instance-standard-class
923	nil
924	:name ',name
925	:direct-superclasses ',(mapcar #'find-class superclasses)
926	:direct-slots ,(canonicalize-direct-slots direct-slots))))
927	(%set-find-class ',name ,class)
928	,class)))
929
930	(defmacro define-funcallable-primordial-class (name superclasses direct-slots)
931	"Primitive funcallable class definition tool.
932	No non-standard metaclasses, accessor methods, duplicate slots,
933	non-existent superclasses, default initargs, or other complicated stuff.
934	Handle with care.
935	Will not modify existing classes to avoid breaking std-generic-function-p."
936	(let ((class (gensym)))
937	`(let ((,class (make-or-find-instance-funcallable-standard-class
938	nil
939	:name ',name
940	:direct-superclasses ',(mapcar #'find-class superclasses)
941	:direct-slots ,(canonicalize-direct-slots direct-slots))))
942	(%set-find-class ',name ,class)
943	,class)))
944
945	(define-primordial-class eql-specializer (specializer)
946	((object :initform nil)
947	(direct-methods :initform nil)))
948
949	(define-primordial-class method-combination (metaobject)
950	((sys::name :initarg :name :initform nil)
951	(sys::%documentation :initarg :documentation :initform nil)
952	(options :initarg :options :initform nil)))
953
954	(define-primordial-class short-method-combination (method-combination)
955	((operator :initarg :operator)
956	(identity-with-one-argument :initarg :identity-with-one-argument)))
957
958	(define-primordial-class long-method-combination (method-combination)
959	((sys::lambda-list :initarg :lambda-list)
960	(method-group-specs :initarg :method-group-specs)
961	(args-lambda-list :initarg :args-lambda-list)
962	(generic-function-symbol :initarg :generic-function-symbol)
963	(function :initarg :function)
964	(arguments :initarg :arguments)
965	(declarations :initarg :declarations)
966	(forms :initarg :forms)))
967
968	(define-primordial-class standard-accessor-method (standard-method)
969	((sys::%slot-definition :initarg :slot-definition :initform nil)))
970
971	(define-primordial-class standard-reader-method (standard-accessor-method)
972	())
973	(defconstant +the-standard-reader-method-class+
974	(find-class 'standard-reader-method))
975
976	(define-primordial-class standard-writer-method (standard-accessor-method)
977	())
978	(defconstant +the-standard-writer-method-class+
979	(find-class 'standard-writer-method))
980
981	(define-primordial-class structure-class (class)
982	())
983	(defconstant +the-structure-class+ (find-class 'structure-class))
984
985	(define-primordial-class forward-referenced-class (class)
986	;; The standard-class layout. Not all of these slots are necessary,
987	;; but at least NAME and DIRECT-SUBCLASSES are.
988	((sys::name :initarg :name :initform nil)
989	(sys::layout :initform nil)
990	(sys::direct-superclasses :initform nil)
991	(sys::direct-subclasses :initform nil)
992	(sys::precedence-list :initform nil)
993	(sys::direct-methods :initform nil)
994	(sys::direct-slots :initform nil)
995	(sys::slots :initform nil)
996	(sys::direct-default-initargs :initform nil)
997	(sys::default-initargs :initform nil)
998	(sys::finalized-p :initform nil)
999	(sys::%documentation :initform nil)))
1000	(defconstant +the-forward-referenced-class+
1001	(find-class 'forward-referenced-class))
1002
1003	(define-funcallable-primordial-class generic-function
1004	(metaobject funcallable-standard-object)
1005	())
1006
1007	(defvar extensible-built-in-classes
1008	(list (find-class 'sequence)
1009	(find-class 'java:java-object)))
1010
1011	(defvar make-instance-initargs-cache
1012	(make-hash-table :test #'eq)
1013	"Cached sets of allowable initargs, keyed on the class they belong to.")
1014	(defvar reinitialize-instance-initargs-cache
1015	(make-hash-table :test #'eq)
1016	"Cached sets of allowable initargs, keyed on the class they belong to.")
1017
1018	(defun expand-long-defcombin (name args)
1019	(destructuring-bind (lambda-list method-groups &rest body) args
1020	`(apply #'define-long-form-method-combination
1021	',name
1022	',lambda-list
1023	(list ,@(mapcar #'canonicalize-method-group-spec method-groups))
1024	',body)))
1025
1026	;;; The class method-combination and its subclasses are defined in
1027	;;; StandardClass.java, but we cannot use make-instance and slot-value
1028	;;; yet.
1029
1030	(defun %make-long-method-combination (&key name documentation lambda-list
1031	method-group-specs args-lambda-list
1032	generic-function-symbol function
1033	arguments declarations forms)
1034	(let ((instance (std-allocate-instance (find-class 'long-method-combination))))
1035	(setf (std-slot-value instance 'sys::name) name)
1036	(setf (std-slot-value instance 'sys:%documentation) documentation)
1037	(setf (std-slot-value instance 'sys::lambda-list) lambda-list)
1038	(setf (std-slot-value instance 'method-group-specs) method-group-specs)
1039	(setf (std-slot-value instance 'args-lambda-list) args-lambda-list)
1040	(setf (std-slot-value instance 'generic-function-symbol)
1041	generic-function-symbol)
1042	(setf (std-slot-value instance 'function) function)
1043	(setf (std-slot-value instance 'arguments) arguments)
1044	(setf (std-slot-value instance 'declarations) declarations)
1045	(setf (std-slot-value instance 'forms) forms)
1046	(setf (std-slot-value instance 'options) nil)
1047	instance))
1048
1049	(defun method-combination-name (method-combination)
1050	(check-type method-combination method-combination)
1051	(std-slot-value method-combination 'sys::name))
1052
1053	(defun method-combination-documentation (method-combination)
1054	(check-type method-combination method-combination)
1055	(std-slot-value method-combination 'sys:%documentation))
1056
1057	(defun short-method-combination-operator (method-combination)
1058	(check-type method-combination short-method-combination)
1059	(std-slot-value method-combination 'operator))
1060
1061	(defun short-method-combination-identity-with-one-argument (method-combination)
1062	(check-type method-combination short-method-combination)
1063	(std-slot-value method-combination 'identity-with-one-argument))
1064
1065	(defun long-method-combination-lambda-list (method-combination)
1066	(check-type method-combination long-method-combination)
1067	(std-slot-value method-combination 'sys::lambda-list))
1068
1069	(defun long-method-combination-method-group-specs (method-combination)
1070	(check-type method-combination long-method-combination)
1071	(std-slot-value method-combination 'method-group-specs))
1072
1073	(defun long-method-combination-args-lambda-list (method-combination)
1074	(check-type method-combination long-method-combination)
1075	(std-slot-value method-combination 'args-lambda-list))
1076
1077	(defun long-method-combination-generic-function-symbol (method-combination)
1078	(check-type method-combination long-method-combination)
1079	(std-slot-value method-combination 'generic-function-symbol))
1080
1081	(defun long-method-combination-function (method-combination)
1082	(check-type method-combination long-method-combination)
1083	(std-slot-value method-combination 'function))
1084
1085	(defun long-method-combination-arguments (method-combination)
1086	(check-type method-combination long-method-combination)
1087	(std-slot-value method-combination 'arguments))
1088
1089	(defun long-method-combination-declarations (method-combination)
1090	(check-type method-combination long-method-combination)
1091	(std-slot-value method-combination 'declarations))
1092
1093	(defun long-method-combination-forms (method-combination)
1094	(check-type method-combination long-method-combination)
1095	(std-slot-value method-combination 'forms))
1096
1097
1098	(defun expand-short-defcombin (whole)
1099	(let* ((name (cadr whole))
1100	(documentation
1101	(getf (cddr whole) :documentation ""))
1102	(identity-with-one-arg
1103	(getf (cddr whole) :identity-with-one-argument nil))
1104	(operator
1105	(getf (cddr whole) :operator name)))
1106	`(progn
1107	(let ((instance (std-allocate-instance
1108	(find-class 'short-method-combination))))
1109	(setf (std-slot-value instance 'sys::name) ',name)
1110	(setf (std-slot-value instance 'sys:%documentation) ',documentation)
1111	(setf (std-slot-value instance 'operator) ',operator)
1112	(setf (std-slot-value instance 'identity-with-one-argument)
1113	',identity-with-one-arg)
1114	(setf (std-slot-value instance 'options) nil)
1115	(setf (get ',name 'method-combination-object) instance)
1116	',name))))
1117
1118	(defmacro define-method-combination (&whole form name &rest args)
1119	(if (and (cddr form)
1120	(listp (caddr form)))
1121	(expand-long-defcombin name args)
1122	(expand-short-defcombin form)))
1123
1124	(define-method-combination + :identity-with-one-argument t)
1125	(define-method-combination and :identity-with-one-argument t)
1126	(define-method-combination append :identity-with-one-argument nil)
1127	(define-method-combination list :identity-with-one-argument nil)
1128	(define-method-combination max :identity-with-one-argument t)
1129	(define-method-combination min :identity-with-one-argument t)
1130	(define-method-combination nconc :identity-with-one-argument t)
1131	(define-method-combination or :identity-with-one-argument t)
1132	(define-method-combination progn :identity-with-one-argument t)
1133
1134	;;;
1135	;;; long form of define-method-combination (from Sacla and XCL)
1136	;;;
1137	(defun method-group-p (selecter qualifiers)
1138	;; selecter::= qualifier-pattern \| predicate
1139	(etypecase selecter
1140	(list (or (equal selecter qualifiers)
1141	(let ((last (last selecter)))
1142	(when (eq '* (cdr last))
1143	(let* ((prefix `(,@(butlast selecter) ,(car last)))
1144	(pos (mismatch prefix qualifiers)))
1145	(or (null pos) (= pos (length prefix))))))))
1146	((eql *) t)
1147	(symbol (funcall (symbol-function selecter) qualifiers))))
1148
1149	(defun check-variable-name (name)
1150	(flet ((valid-variable-name-p (name)
1151	(and (symbolp name) (not (constantp name)))))
1152	(assert (valid-variable-name-p name))))
1153
1154	(defun canonicalize-method-group-spec (spec)
1155	;; spec ::= (name {qualifier-pattern+ \| predicate} [[long-form-option]])
1156	;; long-form-option::= :description description \| :order order \|
1157	;; :required required-p
1158	;; a canonicalized-spec is a simple plist.
1159	(let* ((rest spec)
1160	(name (prog2 (check-variable-name (car rest))
1161	(car rest)
1162	(setq rest (cdr rest))))
1163	(option-names '(:description :order :required))
1164	(selecters (let ((end (or (position-if #'(lambda (it)
1165	(member it option-names))
1166	rest)
1167	(length rest))))
1168	(prog1 (subseq rest 0 end)
1169	(setq rest (subseq rest end)))))
1170	(description (getf rest :description ""))
1171	(order (getf rest :order :most-specific-first))
1172	(required-p (getf rest :required)))
1173	`(list :name ',name
1174	:predicate (lambda (qualifiers)
1175	(loop for item in ',selecters
1176	thereis (method-group-p item qualifiers)))
1177	:description ',description
1178	:order ',order
1179	:required ',required-p
1180	:-selecter ,(equal selecters '()))))
1181
1182	(defun extract-required-part (lambda-list)
1183	(flet ((skip (key lambda-list)
1184	(if (eq (first lambda-list) key)
1185	(cddr lambda-list)
1186	lambda-list)))
1187	(let* ((trimmed-lambda-list
1188	(skip '&environment (skip '&whole lambda-list)))
1189	(after-required-lambda-list
1190	(member-if #'(lambda (it) (member it lambda-list-keywords))
1191	trimmed-lambda-list)))
1192	(if after-required-lambda-list
1193	(ldiff trimmed-lambda-list after-required-lambda-list)
1194	trimmed-lambda-list))))
1195
1196	(defun extract-specified-part (key lambda-list)
1197	(case key
1198	((&eval &whole)
1199	(list (second (member key lambda-list))))
1200	(t
1201	(let ((here (cdr (member key lambda-list))))
1202	(ldiff here
1203	(member-if #'(lambda (it) (member it lambda-list-keywords))
1204	here))))))
1205
1206	(defun extract-optional-part (lambda-list)
1207	(extract-specified-part '&optional lambda-list))
1208
1209	(defun parse-define-method-combination-args-lambda-list (lambda-list)
1210	;; Define-method-combination Arguments Lambda Lists
1211	;; http://www.lispworks.com/reference/HyperSpec/Body/03_dj.htm
1212	(let ((required (extract-required-part lambda-list))
1213	(whole (extract-specified-part '&whole lambda-list))
1214	(optional (extract-specified-part '&optional lambda-list))
1215	(rest (extract-specified-part '&rest lambda-list))
1216	(keys (extract-specified-part '&key lambda-list))
1217	(aux (extract-specified-part '&aux lambda-list)))
1218	(values (first whole)
1219	required
1220	(mapcar #'(lambda (spec)
1221	(if (consp spec)
1222	`(,(first spec) ,(second spec) ,@(cddr spec))
1223	`(,spec nil)))
1224	optional)
1225	(first rest)
1226	(mapcar #'(lambda (spec)
1227	(let ((key (if (consp spec) (car spec) spec))
1228	(rest (when (consp spec) (rest spec))))
1229	`(,(if (consp key) key `(,(make-keyword key) ,key))
1230	,(car rest)
1231	,@(cdr rest))))
1232	keys)
1233	(mapcar #'(lambda (spec)
1234	(if (consp spec)
1235	`(,(first spec) ,(second spec))
1236	`(,spec nil)))
1237	aux))))
1238
1239	(defun wrap-with-call-method-macro (gf args-var emf-form)
1240	`(macrolet
1241	((call-method (method &optional next-method-list)
1242	`(funcall
1243	,(cond
1244	((listp method)
1245	(assert (eq (first method) 'make-method))
1246	;; by generating an inline expansion we prevent allocation
1247	;; of a method instance which will be discarded immediately
1248	;; after reading the METHOD-FUNCTION slot
1249	(compute-method-function
1250	`(lambda (&rest ,(gensym))
1251	;; the MAKE-METHOD body form gets evaluated in
1252	;; the null lexical environment augmented
1253	;; with a binding for CALL-METHOD
1254	,(wrap-with-call-method-macro ,gf
1255	',args-var
1256	(second method)))))
1257	(t (method-function method)))
1258	,',args-var
1259	,(unless (null next-method-list)
1260	;; by not generating an emf when there are no next methods,
1261	;; we ensure next-method-p returns NIL
1262	(compute-effective-method
1263	,gf (generic-function-method-combination ,gf)
1264	(process-next-method-list next-method-list))))))
1265	,emf-form))
1266
1267	(defun assert-unambiguous-method-sorting (group-name methods)
1268	(let ((specializers (make-hash-table :test 'equal)))
1269	(dolist (method methods)
1270	(push method (gethash (method-specializers method) specializers)))
1271	(loop for specializer-methods being each hash-value of specializers
1272	using (hash-key method-specializers)
1273	unless (= 1 (length specializer-methods))
1274	do (error "Ambiguous method sorting in method group ~A due to multiple ~
1275	methods with specializers ~S: ~S"
1276	group-name method-specializers specializer-methods))))
1277
1278	(defmacro with-method-groups (method-group-specs methods-form &body forms)
1279	(flet ((grouping-form (spec methods-var)
1280	(let ((predicate (coerce-to-function (getf spec :predicate)))
1281	(group (gensym))
1282	(leftovers (gensym))
1283	(method (gensym)))
1284	`(let ((,group '())
1285	(,leftovers '()))
1286	(dolist (,method ,methods-var)
1287	(if (funcall ,predicate (method-qualifiers ,method))
1288	(push ,method ,group)
1289	(push ,method ,leftovers)))
1290	(ecase ,(getf spec :order)
1291	(:most-specific-last )
1292	(:most-specific-first (setq ,group (nreverse ,group))))
1293	,@(when (getf spec :required)
1294	`((when (null ,group)
1295	(error "Method group ~S must not be empty."
1296	',(getf spec :name)))))
1297	(setq ,methods-var (nreverse ,leftovers))
1298	,group))))
1299	(let ((rest (gensym))
1300	(method (gensym)))
1301	`(let* ((,rest ,methods-form)
1302	,@(mapcar #'(lambda (spec)
1303	`(,(getf spec :name) ,(grouping-form spec rest)))
1304	method-group-specs))
1305	(dolist (,method ,rest)
1306	(invalid-method-error ,method
1307	"Method ~S with qualifiers ~S does not belong to any method group."
1308	,method (method-qualifiers ,method)))
1309	,@(unless (and (= 1 (length method-group-specs))
1310	(getf (car method-group-specs) :*-selecter))
1311	(mapcar #'(lambda (spec)
1312	`(assert-unambiguous-method-sorting ',(getf spec :name) ,(getf spec :name)))
1313	method-group-specs))
1314	,@forms))))
1315
1316	(defun method-combination-type-lambda-with-args-emf
1317	(&key args-lambda-list generic-function-symbol forms &allow-other-keys)
1318	(multiple-value-bind
1319	(whole required optional rest keys aux)
1320	(parse-define-method-combination-args-lambda-list args-lambda-list)
1321	(unless rest
1322	(when keys
1323	(setf rest (gensym))))
1324	(let* ((gf-lambda-list (gensym))
1325	(args-var (gensym))
1326	(args-len-var (gensym))
1327	(binding-forms (gensym))
1328	(needs-args-len-var (gensym))
1329	(emf-form (gensym)))
1330	`(let* ((,gf-lambda-list (slot-value ,generic-function-symbol
1331	'sys::lambda-list))
1332	(nreq (length (extract-required-part ,gf-lambda-list)))
1333	(nopt (length (extract-optional-part ,gf-lambda-list)))
1334	(,binding-forms)
1335	(,needs-args-len-var)
1336	(,emf-form
1337	(let* (,@(when whole
1338	`((,whole (progn
1339	(push `(,',whole ,',args-var)
1340	,binding-forms)
1341	',args-var))))
1342	,@(when rest
1343	;; ### TODO: use a fresh symbol for the rest
1344	;; binding being generated and pushed into binding-forms
1345	`((,rest (progn
1346	(push `(,',rest
1347	(subseq ,',args-var
1348	,(+ nreq nopt)))
1349	,binding-forms)
1350	',rest))))
1351	,@(loop for var in required and i upfrom 0
1352	for var-binding = (gensym)
1353	collect `(,var (when (< ,i nreq)
1354	(push `(,',var-binding
1355	(nth ,,i ,',args-var))
1356	,binding-forms)
1357	',var-binding)))
1358	,@(loop for (var initform supplied-var) in optional
1359	and i upfrom 0
1360	for supplied-binding = (or supplied-var (gensym))
1361	for var-binding = (gensym)
1362	;; check for excess parameters
1363	;; only assign initform if the parameter
1364	;; isn't in excess: the spec says explicitly
1365	;; to bind parameters in excess to forms evaluating
1366	;; to nil.
1367	;; This leaves initforms to be used with
1368	;; parameters not supplied in excess, but
1369	;; not available in the arguments list
1370	;;
1371	;; Also, if specified, bind "supplied-p"
1372	collect `(,supplied-binding
1373	(when (< ,i nopt)
1374	(setq ,needs-args-len-var t)
1375	;; ### TODO: use a fresh symbol for the supplied binding
1376	;; binding being generated and pushed into binding-forms
1377	(push `(,',supplied-binding
1378	(< ,(+ ,i nreq) ,',args-len-var))
1379	,binding-forms)
1380	',supplied-binding))
1381	collect `(,var (when (< ,i nopt)
1382	(push `(,',var-binding
1383	(if ,',supplied-binding
1384	(nth ,(+ ,i nreq)
1385	,',args-var)
1386	,',initform))
1387	,binding-forms)
1388	',var-binding)))
1389	,@(loop for ((key var) initform supplied-var) in keys
1390	for supplied-binding = (or supplied-var (gensym))
1391	for var-binding = (gensym)
1392	;; Same as optional parameters:
1393	;; even though keywords can't be supplied in
1394	;; excess, we should bind "supplied-p" in case
1395	;; the key isn't supplied in the arguments list
1396	collect `(,supplied-binding
1397	(progn
1398	;; ### TODO: use a fresh symbol for the rest
1399	;; binding being generated and pushed into binding-forms
1400	(push `(,',supplied-binding
1401	(member ,',key ,',rest))
1402	,binding-forms)
1403	',supplied-binding))
1404	collect `(,var (progn
1405	(push `(,',var-binding
1406	(if ,',supplied-binding
1407	(cadr ,',supplied-binding)
1408	,',initform))
1409	,binding-forms)
1410	',var-binding)))
1411	,@(loop for (var initform) in aux
1412	for var-binding = (gensym)
1413	collect `(,var (progn
1414	(push '(,var-binding ,initform)
1415	,binding-forms)
1416	',var-binding))))
1417	,@forms)))
1418	`(lambda (,',args-var)
1419	;; set up bindings to ensure the expressions to which the
1420	;; variables of the arguments option have been bound are
1421	;; evaluated exactly once.
1422	(let* (,@(when ,needs-args-len-var
1423	`((,',args-len-var (length ,',args-var))))
1424	,@(reverse ,binding-forms))
1425	;; This is the lambda which is the effective method
1426	;; hence gets called on every method invocation
1427	;; be as efficient in this method as we can be
1428	,(wrap-with-call-method-macro ,generic-function-symbol
1429	',args-var ,emf-form)))))))
1430
1431	(defun method-combination-type-lambda
1432	(&rest all-args
1433	&key name lambda-list args-lambda-list generic-function-symbol
1434	method-group-specs declarations forms &allow-other-keys)
1435	(declare (ignore name))
1436	(let ((methods (gensym))
1437	(args-var (gensym))
1438	(emf-form (gensym)))
1439	`(lambda (,generic-function-symbol ,methods ,@lambda-list)
1440	;; This is the lambda which computes the effective method
1441	,@declarations
1442	(with-method-groups ,method-group-specs
1443	,methods
1444	,(if (null args-lambda-list)
1445	`(let ((,emf-form (progn ,@forms)))
1446	`(lambda (,',args-var)
1447	;; This is the lambda which is the effective method
1448	;; hence gets called on every method invocation
1449	;; be as efficient in this method as we can be
1450	,(wrap-with-call-method-macro ,generic-function-symbol
1451	',args-var ,emf-form)))
1452	(apply #'method-combination-type-lambda-with-args-emf all-args))))))
1453
1454	(defun declarationp (expr)
1455	(and (consp expr) (eq (car expr) 'DECLARE)))
1456
1457	(defun long-form-method-combination-args (args)
1458	;; define-method-combination name lambda-list (method-group-specifier*) args
1459	;; args ::= [(:arguments . args-lambda-list)]
1460	;; [(:generic-function generic-function-symbol)]
1461	;; [[declaration* \| documentation]] form*
1462	(let ((rest args))
1463	(labels ((nextp (key) (and (consp (car rest)) (eq key (caar rest))))
1464	(args-lambda-list ()
1465	(when (nextp :arguments)
1466	(prog1 (cdr (car rest)) (setq rest (cdr rest)))))
1467	(generic-function-symbol ()
1468	(if (nextp :generic-function)
1469	(prog1 (second (car rest)) (setq rest (cdr rest)))
1470	(gensym)))
1471	(declaration* ()
1472	(let ((end (position-if-not #'declarationp rest)))
1473	(when end
1474	(prog1 (subseq rest 0 end) (setq rest (nthcdr end rest))))))
1475	(documentation? ()
1476	(when (stringp (car rest))
1477	(prog1 (car rest) (setq rest (cdr rest)))))
1478	(form* () rest))
1479	(let ((declarations '()))
1480	`(:args-lambda-list ,(args-lambda-list)
1481	:generic-function-symbol ,(generic-function-symbol)
1482	:documentation ,(prog2 (setq declarations (declaration*))
1483	(documentation?))
1484	:declarations (,@declarations ,@(declaration*))
1485	:forms ,(form*))))))
1486
1487	(defun define-long-form-method-combination (name lambda-list method-group-specs
1488	&rest args)
1489	(let* ((initargs `(:name ,name
1490	:lambda-list ,lambda-list
1491	:method-group-specs ,method-group-specs
1492	,@(long-form-method-combination-args args)))
1493	(lambda-expression (apply #'method-combination-type-lambda initargs)))
1494	(setf (get name 'method-combination-object)
1495	(apply '%make-long-method-combination
1496	:function (coerce-to-function lambda-expression) initargs))
1497	name))
1498
1499	(defun std-find-method-combination (gf name options)
1500	(declare (ignore gf))
1501	(when (and (eql name 'standard) options)
1502	;; CLHS DEFGENERIC
1503	(error "The standard method combination does not accept any arguments."))
1504	(let ((mc (get name 'method-combination-object)))
1505	(cond
1506	((null mc) (error "Method combination ~S not found" name))
1507	((null options) mc)
1508	((typep mc 'short-method-combination)
1509	(make-instance
1510	'short-method-combination
1511	:name name
1512	:documentation (method-combination-documentation mc)
1513	:operator (short-method-combination-operator mc)
1514	:identity-with-one-argument
1515	(short-method-combination-identity-with-one-argument mc)
1516	:options options))
1517	((typep mc 'long-method-combination)
1518	(make-instance
1519	'long-method-combination
1520	:name name
1521	:documentation (method-combination-documentation mc)
1522	:lambda-list (long-method-combination-lambda-list mc)
1523	:method-group-specs (long-method-combination-method-group-specs mc)
1524	:args-lambda-list (long-method-combination-args-lambda-list mc)
1525	:generic-function-symbol (long-method-combination-generic-function-symbol mc)
1526	:function (long-method-combination-function mc)
1527	:arguments (long-method-combination-arguments mc)
1528	:declarations (long-method-combination-declarations mc)
1529	:forms (long-method-combination-forms mc)
1530	:options options)))))
1531
1532	(declaim (notinline find-method-combination))
1533	(defun find-method-combination (gf name options)
1534	(std-find-method-combination gf name options))
1535
1536	(defconstant +the-standard-method-combination+
1537	(let ((instance (std-allocate-instance (find-class 'method-combination))))
1538	(setf (std-slot-value instance 'sys::name) 'standard)
1539	(setf (std-slot-value instance 'sys:%documentation)
1540	"The standard method combination.")
1541	(setf (std-slot-value instance 'options) nil)
1542	instance)
1543	"The standard method combination.
1544	Do not use this object for identity since it changes between
1545	compile-time and run-time. To detect the standard method combination,
1546	compare the method combination name to the symbol 'standard.")
1547	(setf (get 'standard 'method-combination-object) +the-standard-method-combination+)
1548
1549	(define-funcallable-primordial-class standard-generic-function (generic-function)
1550	((sys::name :initarg :name :initform nil)
1551	(sys::lambda-list :initarg :lambda-list :initform nil)
1552	(sys::required-args :initarg :required-args :initform nil)
1553	(sys::optional-args :initarg :optional-args :initform nil)
1554	(sys::initial-methods :initarg :initial-methods :initform nil)
1555	(sys::methods :initarg :methods :initform nil)
1556	(sys::method-class :initarg :method-class
1557	:initform +the-standard-method-class+)
1558	(sys::%method-combination :initarg :method-combination
1559	:initform +the-standard-method-combination+)
1560	(sys::argument-precedence-order :initarg :argument-precedence-order
1561	:initform nil)
1562	(sys::declarations :initarg :declarations :initform nil)
1563	(sys::%documentation :initarg :documentation :initform nil)))
1564	(defconstant +the-standard-generic-function-class+
1565	(find-class 'standard-generic-function))
1566
1567	(defun std-generic-function-p (gf)
1568	(eq (class-of gf) +the-standard-generic-function-class+))
1569
1570	(defparameter eql-specializer-table (make-hash-table :test 'eql))
1571
1572	(defun intern-eql-specializer (object)
1573	(or (gethash object eql-specializer-table)
1574	(setf (gethash object eql-specializer-table)
1575	;; we will be called during generic function invocation
1576	;; setup, so have to rely on plain functions here.
1577	(let ((instance (std-allocate-instance (find-class 'eql-specializer))))
1578	(setf (std-slot-value instance 'object) object)
1579	(setf (std-slot-value instance 'direct-methods) nil)
1580	instance))))
1581
1582	(defun eql-specializer-object (eql-specializer)
1583	(check-type eql-specializer eql-specializer)
1584	(std-slot-value eql-specializer 'object))
1585
1586	;;; Initial versions of some method metaobject readers. Defined on
1587	;;; AMOP pg. 218ff, will be redefined when generic functions are set up.
1588
1589	(defun std-method-function (method)
1590	(std-slot-value method 'sys::%function))
1591
1592	(defun std-method-generic-function (method)
1593	(std-slot-value method 'sys::%generic-function))
1594
1595	(defun std-method-specializers (method)
1596	(std-slot-value method 'sys::specializers))
1597
1598	(defun std-method-qualifiers (method)
1599	(std-slot-value method 'sys::qualifiers))
1600
1601	(defun std-accessor-method-slot-definition (accessor-method)
1602	(std-slot-value accessor-method 'sys::%slot-definition))
1603
1604	;;; Additional method readers
1605	(defun std-method-fast-function (method)
1606	(std-slot-value method 'sys::fast-function))
1607
1608	(defun std-function-keywords (method)
1609	(values (std-slot-value method 'sys::keywords)
1610	(std-slot-value method 'sys::other-keywords-p)))
1611
1612	;;; Preliminary accessor definitions, will be redefined as generic
1613	;;; functions later in this file
1614
1615	(declaim (notinline method-generic-function))
1616	(defun method-generic-function (method)
1617	(std-method-generic-function method))
1618
1619	(declaim (notinline method-function))
1620	(defun method-function (method)
1621	(std-method-function method))
1622
1623	(declaim (notinline method-specializers))
1624	(defun method-specializers (method)
1625	(std-method-specializers method))
1626
1627	(declaim (notinline method-qualifiers))
1628	(defun method-qualifiers (method)
1629	(std-method-qualifiers method))
1630
1631
1632
1633	;;; MOP (p. 216) specifies the following reader generic functions:
1634	;;; generic-function-argument-precedence-order
1635	;;; generic-function-declarations
1636	;;; generic-function-lambda-list
1637	;;; generic-function-method-class
1638	;;; generic-function-method-combination
1639	;;; generic-function-methods
1640	;;; generic-function-name
1641
1642	;;; Additionally, we define the following reader functions:
1643	;;; generic-function-required-arguments
1644	;;; generic-function-optional-arguments
1645
1646	;;; These are defined as functions here and redefined as generic
1647	;;; functions via atomic-defgeneric once we're all set up.
1648
1649	(defun generic-function-name (gf)
1650	(std-slot-value gf 'sys::name))
1651
1652	(defun generic-function-lambda-list (gf)
1653	(std-slot-value gf 'sys::lambda-list))
1654
1655	(defun generic-function-methods (gf)
1656	(std-slot-value gf 'sys::methods))
1657
1658	(defun generic-function-method-class (gf)
1659	(std-slot-value gf 'sys::method-class))
1660
1661	(defun generic-function-method-combination (gf)
1662	(std-slot-value gf 'sys::%method-combination))
1663
1664	(defun generic-function-argument-precedence-order (gf)
1665	(std-slot-value gf 'sys::argument-precedence-order))
1666
1667	(defun generic-function-required-arguments (gf)
1668	(std-slot-value gf 'sys::required-args))
1669
1670	(defun generic-function-optional-arguments (gf)
1671	(std-slot-value gf 'sys::optional-args))
1672
1673	(defun (setf method-lambda-list) (new-value method)
1674	(setf (std-slot-value method 'sys::lambda-list) new-value))
1675
1676	(defun (setf method-qualifiers) (new-value method)
1677	(setf (std-slot-value method 'sys::qualifiers) new-value))
1678
1679	(defun method-documentation (method)
1680	(std-slot-value method 'sys:%documentation))
1681
1682	(defun (setf method-documentation) (new-value method)
1683	(setf (std-slot-value method 'sys:%documentation) new-value))
1684
1685	;;; defgeneric
1686
1687	(defmacro defgeneric (function-name lambda-list
1688	&rest options-and-method-descriptions)
1689	(let ((options ())
1690	(methods ())
1691	(declarations ())
1692	(documentation nil))
1693	(dolist (item options-and-method-descriptions)
1694	(case (car item)
1695	(declare
1696	(setf declarations (append declarations (cdr item))))
1697	(:documentation
1698	(when documentation
1699	(error 'program-error
1700	:format-control "Documentation option was specified twice for generic function ~S."
1701	:format-arguments (list function-name)))
1702	(setf documentation t)
1703	(push item options))
1704	(:method
1705	;; KLUDGE (rudi 2013-04-02): this only works with subclasses
1706	;; of standard-generic-function, since the initial-methods
1707	;; slot is not mandated by AMOP
1708	(push
1709	`(push (defmethod ,function-name ,@(cdr item))
1710	(std-slot-value (fdefinition ',function-name) 'sys::initial-methods))
1711	methods))
1712	(t
1713	(push item options))))
1714	(when declarations (push (list :declarations declarations) options))
1715	(setf options (nreverse options)
1716	methods (nreverse methods))
1717	;; Since DEFGENERIC currently shares its argument parsing with
1718	;; DEFMETHOD, we perform this check here.
1719	(when (find '&aux lambda-list)
1720	(error 'program-error
1721	:format-control "&AUX is not allowed in a generic function lambda list: ~S"
1722	:format-arguments (list lambda-list)))
1723	`(prog1
1724	(%defgeneric
1725	',function-name
1726	:lambda-list ',lambda-list
1727	,@(canonicalize-defgeneric-options options))
1728	(sys::record-source-information-for-type ',function-name '(:generic-function ,function-name))
1729	,@methods)))
1730
1731	(defun canonicalize-defgeneric-options (options)
1732	(mapappend #'canonicalize-defgeneric-option options))
1733
1734	(defun canonicalize-defgeneric-option (option)
1735	(case (car option)
1736	(:generic-function-class
1737	(list :generic-function-class `(find-class ',(cadr option))))
1738	(:method-class
1739	(list :method-class `(find-class ',(cadr option))))
1740	(:method-combination
1741	(list :method-combination `',(cdr option)))
1742	(:argument-precedence-order
1743	(list :argument-precedence-order `',(cdr option)))
1744	(t
1745	(list `',(car option) `',(cadr option)))))
1746
1747	;; From OpenMCL (called canonicalize-argument-precedence-order there,
1748	;; but AMOP specifies argument-precedence-order to return a permutation
1749	;; of the required arguments, not a list of indices, so we calculate
1750	;; them on demand).
1751	(defun argument-precedence-order-indices (apo req)
1752	(cond ((equal apo req) nil)
1753	((not (eql (length apo) (length req)))
1754	(error 'program-error
1755	:format-control "Specified argument precedence order ~S does not match lambda list."
1756	:format-arguments (list apo)))
1757	(t (let ((res nil))
1758	(dolist (arg apo (nreverse res))
1759	(let ((index (position arg req)))
1760	(if (or (null index) (memq index res))
1761	(error 'program-error
1762	:format-control "Specified argument precedence order ~S does not match lambda list."
1763	:format-arguments (list apo)))
1764	(push index res)))))))
1765
1766	(defun find-generic-function (name &optional (errorp t))
1767	(let ((function (and (fboundp name) (fdefinition name))))
1768	(when function
1769	(when (typep function 'generic-function)
1770	(return-from find-generic-function function))
1771	(when (and traced-names (find name traced-names :test #'equal))
1772	(setf function (untraced-function name))
1773	(when (typep function 'generic-function)
1774	(return-from find-generic-function function)))))
1775	(if errorp
1776	(error "There is no generic function named ~S." name)
1777	nil))
1778
1779	(defun lambda-lists-congruent-p (lambda-list1 lambda-list2)
1780	(let* ((plist1 (analyze-lambda-list lambda-list1))
1781	(args1 (getf plist1 :required-args))
1782	(plist2 (analyze-lambda-list lambda-list2))
1783	(args2 (getf plist2 :required-args)))
1784	(= (length args1) (length args2))))
1785
1786	(defun %defgeneric (function-name &rest all-keys)
1787	(when (fboundp function-name)
1788	(let ((gf (fdefinition function-name)))
1789	(when (typep gf 'standard-generic-function)
1790	;; Remove methods defined by previous DEFGENERIC forms, as
1791	;; specified by CLHS, 7.7 (Macro DEFGENERIC). KLUDGE: only
1792	;; works for subclasses of standard-generic-function. Since
1793	;; AMOP doesn't specify a reader for initial methods, we have to
1794	;; skip this step otherwise.
1795	(dolist (method (std-slot-value gf 'sys::initial-methods))
1796	(std-remove-method gf method)
1797	(map-dependents gf
1798	#'(lambda (dep)
1799	(update-dependent gf dep
1800	'remove-method method))))
1801	(setf (std-slot-value gf 'sys::initial-methods) '()))))
1802	(apply 'ensure-generic-function function-name all-keys))
1803
1804	;;; Bootstrap version of ensure-generic-function, handling only
1805	;;; standard-generic-function. This function is replaced later.
1806	(declaim (notinline ensure-generic-function))
1807	(defun ensure-generic-function (function-name
1808	&rest all-keys
1809	&key
1810	(lambda-list nil lambda-list-supplied-p)
1811	(generic-function-class +the-standard-generic-function-class+)
1812	(method-class +the-standard-method-class+)
1813	(method-combination +the-standard-method-combination+ mc-p)
1814	argument-precedence-order
1815	(documentation nil documentation-supplied-p)
1816	&allow-other-keys)
1817	(setf all-keys (copy-list all-keys)) ; since we modify it
1818	(remf all-keys :generic-function-class)
1819	(let ((gf (find-generic-function function-name nil)))
1820	(if gf
1821	(progn
1822	(when lambda-list-supplied-p
1823	(unless (or (null (generic-function-methods gf))
1824	(lambda-lists-congruent-p lambda-list
1825	(generic-function-lambda-list gf)))
1826	(error 'simple-error
1827	:format-control "The lambda list ~S is incompatible with the existing methods of ~S."
1828	:format-arguments (list lambda-list gf)))
1829	(setf (std-slot-value gf 'sys::lambda-list) lambda-list)
1830	(let* ((plist (analyze-lambda-list lambda-list))
1831	(required-args (getf plist ':required-args)))
1832	(setf (std-slot-value gf 'sys::required-args) required-args)
1833	(setf (std-slot-value gf 'sys::optional-args)
1834	(getf plist :optional-args))))
1835	(setf (std-slot-value gf 'sys::argument-precedence-order)
1836	(or argument-precedence-order (generic-function-required-arguments gf)))
1837	(when documentation-supplied-p
1838	(setf (std-slot-value gf 'sys::%documentation) documentation))
1839	(finalize-standard-generic-function gf)
1840	gf)
1841	(progn
1842	(when (and (null clos-booting)
1843	(and (fboundp function-name)
1844	;; since we're overwriting an autoloader,
1845	;; we're probably meant to redefine it,
1846	;; so throwing an error here might be a bad idea.
1847	;; also, resolving the symbol isn't
1848	;; a good option either: we've seen that lead to
1849	;; recursive loading of the same file
1850	(and (not (autoloadp function-name))
1851	(and (consp function-name)
1852	(eq 'setf (first function-name))
1853	(not (autoload-ref-p (second function-name)))))))
1854	(error 'program-error
1855	:format-control "~A already names an ordinary function, macro, or special operator."
1856	:format-arguments (list function-name)))
1857	(when mc-p
1858	(error "Preliminary ensure-method does not support :method-combination argument."))
1859	(apply #'make-instance-standard-generic-function
1860	generic-function-class
1861	:name function-name
1862	:method-class method-class
1863	:method-combination method-combination
1864	all-keys)))))
1865
1866	(defun collect-eql-specializer-objects (generic-function)
1867	(let ((result nil))
1868	(dolist (method (generic-function-methods generic-function))
1869	(dolist (specializer (method-specializers method))
1870	(when (typep specializer 'eql-specializer)
1871	(pushnew (eql-specializer-object specializer)
1872	result
1873	:test 'eql))))
1874	result))
1875
1876	(defun finalize-standard-generic-function (gf)
1877	(%reinit-emf-cache gf (collect-eql-specializer-objects gf))
1878	(set-funcallable-instance-function
1879	gf
1880	(if (std-generic-function-p gf)
1881	(std-compute-discriminating-function gf)
1882	(compute-discriminating-function gf)))
1883	;; FIXME Do we need to warn on redefinition somewhere else?
1884	(let ((warn-on-redefinition nil))
1885	(setf (fdefinition (generic-function-name gf)) gf))
1886	(values))
1887
1888	(defun make-instance-standard-generic-function (generic-function-class
1889	&key name lambda-list
1890	(method-class +the-standard-method-class+)
1891	(method-combination +the-standard-method-combination+)
1892	argument-precedence-order
1893	declarations
1894	documentation)
1895	;; to avoid circularities, we do not call generic functions in here.
1896	(declare (ignore generic-function-class))
1897	(check-argument-precedence-order lambda-list argument-precedence-order)
1898	(let ((gf (allocate-funcallable-instance +the-standard-generic-function-class+)))
1899	(unless (classp method-class) (setf method-class (find-class method-class)))
1900	(unless (typep method-combination 'method-combination)
1901	(setf method-combination
1902	(find-method-combination
1903	gf (car method-combination) (cdr method-combination))))
1904	(setf (std-slot-value gf 'sys::name) name)
1905	(setf (std-slot-value gf 'sys::lambda-list) lambda-list)
1906	(setf (std-slot-value gf 'sys::initial-methods) ())
1907	(setf (std-slot-value gf 'sys::methods) ())
1908	(setf (std-slot-value gf 'sys::method-class) method-class)
1909	(setf (std-slot-value gf 'sys::%method-combination) method-combination)
1910	(setf (std-slot-value gf 'sys::declarations) declarations)
1911	(setf (std-slot-value gf 'sys::%documentation) documentation)
1912	(let* ((plist (analyze-lambda-list (generic-function-lambda-list gf)))
1913	(required-args (getf plist ':required-args)))
1914	(setf (std-slot-value gf 'sys::required-args) required-args)
1915	(setf (std-slot-value gf 'sys::optional-args) (getf plist :optional-args))
1916	(setf (std-slot-value gf 'sys::argument-precedence-order)
1917	(or argument-precedence-order required-args)))
1918	(finalize-standard-generic-function gf)
1919	gf))
1920
1921	(defun canonicalize-specializers (specializers)
1922	(mapcar #'canonicalize-specializer specializers))
1923
1924	(defun canonicalize-specializer (specializer)
1925	(cond ((classp specializer)
1926	specializer)
1927	((typep specializer 'eql-specializer)
1928	specializer)
1929	((symbolp specializer)
1930	(find-class specializer))
1931	((and (consp specializer)
1932	(eq (car specializer) 'eql))
1933	(let ((object (cadr specializer)))
1934	(when (and (consp object)
1935	(eq (car object) 'quote))
1936	(setf object (cadr object)))
1937	(intern-eql-specializer object)))
1938	((and (consp specializer)
1939	(eq (car specializer) 'java:jclass))
1940	(let ((jclass (eval specializer)))
1941	(java::ensure-java-class jclass)))
1942	((typep specializer 'specializer)
1943	specializer)
1944	(t
1945	(error "Unknown specializer: ~S" specializer))))
1946
1947	(defun parse-defmethod (args)
1948	(let ((function-name (car args))
1949	(qualifiers ())
1950	(specialized-lambda-list ())
1951	(body ())
1952	(parse-state :qualifiers))
1953	(dolist (arg (cdr args))
1954	(ecase parse-state
1955	(:qualifiers
1956	(if (and (atom arg) (not (null arg)))
1957	(push arg qualifiers)
1958	(progn
1959	(setf specialized-lambda-list arg)
1960	(setf parse-state :body))))
1961	(:body (push arg body))))
1962	(setf qualifiers (nreverse qualifiers)
1963	body (nreverse body))
1964	(multiple-value-bind (real-body declarations documentation)
1965	(parse-body body)
1966	(values function-name
1967	qualifiers
1968	(extract-lambda-list specialized-lambda-list)
1969	(extract-specializer-names specialized-lambda-list)
1970	documentation
1971	declarations
1972	(list* 'block
1973	(fdefinition-block-name function-name)
1974	real-body)))))
1975
1976	(defun required-portion (gf args)
1977	(let ((number-required (length (generic-function-required-arguments gf))))
1978	(when (< (length args) number-required)
1979	(error 'program-error
1980	:format-control "Not enough arguments for generic function ~S."
1981	:format-arguments (list (generic-function-name gf))))
1982	(subseq args 0 number-required)))
1983
1984	(defun extract-lambda-list (specialized-lambda-list)
1985	(let* ((plist (analyze-lambda-list specialized-lambda-list))
1986	(requireds (getf plist :required-names))
1987	(rv (getf plist :rest-var))
1988	(ks (getf plist :key-args))
1989	(keysp (getf plist :keysp))
1990	(aok (getf plist :allow-other-keys))
1991	(opts (getf plist :optional-args))
1992	(auxs (getf plist :auxiliary-args)))
1993	`(,@requireds
1994	,@(if opts `(&optional ,@opts) ())
1995	,@(if rv `(&rest ,rv) ())
1996	,@(if (or ks keysp aok) `(&key ,@ks) ())
1997	,@(if aok '(&allow-other-keys) ())
1998	,@(if auxs `(&aux ,@auxs) ()))))
1999
2000	(defun extract-specializer-names (specialized-lambda-list)
2001	(let ((plist (analyze-lambda-list specialized-lambda-list)))
2002	(getf plist ':specializers)))
2003
2004	(defun get-keyword-from-arg (arg)
2005	(if (listp arg)
2006	(if (listp (car arg))
2007	(caar arg)
2008	(make-keyword (car arg)))
2009	(make-keyword arg)))
2010
2011	(defun analyze-lambda-list (lambda-list)
2012	(let ((keys ()) ; Just the keywords
2013	(key-args ()) ; Keywords argument specs
2014	(keysp nil) ;
2015	(required-names ()) ; Just the variable names
2016	(required-args ()) ; Variable names & specializers
2017	(specializers ()) ; Just the specializers
2018	(rest-var nil)
2019	(optionals ())
2020	(auxs ())
2021	(allow-other-keys nil)
2022	(state :required))
2023	(dolist (arg lambda-list)
2024	(if (member arg lambda-list-keywords)
2025	(ecase arg
2026	(&optional
2027	(unless (eq state :required)
2028	(error 'program-error
2029	:format-control "~A followed by &OPTIONAL not allowed ~
2030	in lambda list ~S"
2031	:format-arguments (list state lambda-list)))
2032	(setq state '&optional))
2033	(&rest
2034	(unless (or (eq state :required)
2035	(eq state '&optional))
2036	(error 'program-error
2037	:format-control "~A followed by &REST not allowed ~
2038	in lambda list ~S"
2039	:format-arguments (list state lambda-list)))
2040	(setq state '&rest))
2041	(&key
2042	(unless (or (eq state :required)
2043	(eq state '&optional)
2044	(eq state '&rest))
2045	(error 'program-error
2046	:format-control "~A followed by &KEY not allowed
2047	in lambda list ~S"
2048	:format-arguments (list state lambda-list)))
2049	(setq keysp t)
2050	(setq state '&key))
2051	(&allow-other-keys
2052	(unless (eq state '&key)
2053	(error 'program-error
2054	:format-control "&ALLOW-OTHER-KEYS not allowed while
2055	parsing ~A in lambda list ~S"
2056	:format-arguments (list state lambda-list)))
2057	(setq allow-other-keys 't))
2058	(&aux
2059	;; &aux comes last; any other previous state is fine
2060	(setq state '&aux)))
2061	(case state
2062	(:required
2063	(push-on-end arg required-args)
2064	(if (listp arg)
2065	(progn (push-on-end (car arg) required-names)
2066	(push-on-end (cadr arg) specializers))
2067	(progn (push-on-end arg required-names)
2068	(push-on-end 't specializers))))
2069	(&optional (push-on-end arg optionals))
2070	(&rest (setq rest-var arg))
2071	(&key
2072	(push-on-end (get-keyword-from-arg arg) keys)
2073	(push-on-end arg key-args))
2074	(&aux (push-on-end arg auxs)))))
2075	(list :required-names required-names
2076	:required-args required-args
2077	:specializers specializers
2078	:rest-var rest-var
2079	:keywords keys
2080	:key-args key-args
2081	:keysp keysp
2082	:auxiliary-args auxs
2083	:optional-args optionals
2084	:allow-other-keys allow-other-keys)))
2085
2086	#+nil
2087	(defun check-method-arg-info (gf arg-info method)
2088	(multiple-value-bind (nreq nopt keysp restp allow-other-keys-p keywords)
2089	(analyze-lambda-list (if (consp method)
2090	(early-method-lambda-list method)
2091	(method-lambda-list method)))
2092	(flet ((lose (string &rest args)
2093	(error 'program-error
2094	:format-control "~@<attempt to add the method~2I~_~S~I~_~
2095	to the generic function~2I~_~S;~I~_~
2096	but ~?~:>"
2097	:format-arguments (list method gf string args)))
2098	(comparison-description (x y)
2099	(if (> x y) "more" "fewer")))
2100	(let ((gf-nreq (arg-info-number-required arg-info))
2101	(gf-nopt (arg-info-number-optional arg-info))
2102	(gf-key/rest-p (arg-info-key/rest-p arg-info))
2103	(gf-keywords (arg-info-keys arg-info)))
2104	(unless (= nreq gf-nreq)
2105	(lose
2106	"the method has ~A required arguments than the generic function."
2107	(comparison-description nreq gf-nreq)))
2108	(unless (= nopt gf-nopt)
2109	(lose
2110	"the method has ~A optional arguments than the generic function."
2111	(comparison-description nopt gf-nopt)))
2112	(unless (eq (or keysp restp) gf-key/rest-p)
2113	(lose
2114	"the method and generic function differ in whether they accept~_~
2115	&REST or &KEY arguments."))
2116	(when (consp gf-keywords)
2117	(unless (or (and restp (not keysp))
2118	allow-other-keys-p
2119	(every (lambda (k) (memq k keywords)) gf-keywords))
2120	(lose "the method does not accept each of the &KEY arguments~2I~_~
2121	~S."
2122	gf-keywords)))))))
2123
2124	(defun check-method-lambda-list (name method-lambda-list gf-lambda-list)
2125	(let* ((gf-restp (not (null (memq '&rest gf-lambda-list))))
2126	(gf-plist (analyze-lambda-list gf-lambda-list))
2127	(gf-keysp (getf gf-plist :keysp))
2128	(gf-keywords (getf gf-plist :keywords))
2129	(method-plist (analyze-lambda-list method-lambda-list))
2130	(method-restp (not (null (memq '&rest method-lambda-list))))
2131	(method-keysp (getf method-plist :keysp))
2132	(method-keywords (getf method-plist :keywords))
2133	(method-allow-other-keys-p (getf method-plist :allow-other-keys)))
2134	(unless (= (length (getf gf-plist :required-args))
2135	(length (getf method-plist :required-args)))
2136	(error "The method-lambda-list ~S ~
2137	has the wrong number of required arguments ~
2138	for the generic function ~S." method-lambda-list name))
2139	(unless (= (length (getf gf-plist :optional-args))
2140	(length (getf method-plist :optional-args)))
2141	(error "The method-lambda-list ~S ~
2142	has the wrong number of optional arguments ~
2143	for the generic function ~S." method-lambda-list name))
2144	(unless (eq (or gf-restp gf-keysp) (or method-restp method-keysp))
2145	(error "The method-lambda-list ~S ~
2146	and the generic function ~S ~
2147	differ in whether they accept &REST or &KEY arguments."
2148	method-lambda-list name))
2149	(when (consp gf-keywords)
2150	(unless (or (and method-restp (not method-keysp))
2151	method-allow-other-keys-p
2152	(every (lambda (k) (memq k method-keywords)) gf-keywords))
2153	(error "The method-lambda-list ~S does not accept ~
2154	all of the keyword arguments defined for the ~
2155	generic function." method-lambda-list name)))))
2156
2157	(defun check-argument-precedence-order (lambda-list argument-precedence-order)
2158	(when argument-precedence-order
2159	(if lambda-list
2160	;; raising the required program-errors is a side-effect of
2161	;; calculating the given permutation of apo vs req
2162	(argument-precedence-order-indices
2163	argument-precedence-order
2164	(getf (analyze-lambda-list lambda-list) :required-args))
2165	;; AMOP pg. 198
2166	(error 'program-error "argument precedence order specified without lambda list"))))
2167
2168	(defvar gf-initialize-instance nil
2169	"Cached value of the INITIALIZE-INSTANCE generic function.
2170	Initialized with the true value near the end of the file.")
2171	(defvar gf-allocate-instance nil
2172	"Cached value of the ALLOCATE-INSTANCE generic function.
2173	Initialized with the true value near the end of the file.")
2174	(defvar gf-shared-initialize nil
2175	"Cached value of the SHARED-INITIALIZE generic function.
2176	Initialized with the true value near the end of the file.")
2177	(defvar gf-reinitialize-instance nil
2178	"Cached value of the REINITIALIZE-INSTANCE generic function.
2179	Initialized with the true value near the end of the file.")
2180
2181	(declaim (ftype (function * method) ensure-method))
2182	(defun ensure-method (name &rest all-keys)
2183	(let* ((method-lambda-list (getf all-keys :lambda-list))
2184	(gf (find-generic-function name nil))
2185	(gf-lambda-list (copy-tree method-lambda-list)))
2186	(when (or (eq gf gf-initialize-instance)
2187	(eq gf gf-allocate-instance)
2188	(eq gf gf-shared-initialize)
2189	(eq gf gf-reinitialize-instance))
2190	;; ### Clearly, this can be targeted much more exact
2191	;; as we only need to remove the specializing class and all
2192	;; its subclasses from the hash.
2193	(clrhash make-instance-initargs-cache)
2194	(clrhash reinitialize-instance-initargs-cache))
2195
2196	(let ((plist (analyze-lambda-list method-lambda-list)))
2197	(when (getf plist :keywords)
2198	;; remove all keywords arguments for the generic function definition
2199	(setf gf-lambda-list
2200	(append (subseq gf-lambda-list 0 (position '&key gf-lambda-list))
2201	'(&key) (if (getf plist :auxiliary-args)
2202	(subseq gf-lambda-list (position '&aux gf-lambda-list)))))))
2203	(if gf
2204	(restart-case
2205	(check-method-lambda-list name method-lambda-list
2206	(generic-function-lambda-list gf))
2207	(unbind-and-try-again () :report (lambda(s) (format s "Undefine generic function #'~a and continue" name))
2208	(fmakunbound name)
2209	(setf gf (ensure-generic-function name :lambda-list gf-lambda-list))))
2210	(setf gf (ensure-generic-function name :lambda-list gf-lambda-list)))
2211	(let ((method
2212	(if (eq (generic-function-method-class gf) +the-standard-method-class+)
2213	(apply #'make-instance-standard-method gf all-keys)
2214	(apply #'make-instance (generic-function-method-class gf) all-keys))))
2215	(if (and
2216	(eq (generic-function-method-class gf) +the-standard-method-class+)
2217	(std-generic-function-p gf))
2218	(progn
2219	(std-add-method gf method)
2220	(map-dependents gf
2221	#'(lambda (dep)
2222	(update-dependent gf dep 'add-method method))))
2223	(add-method gf method))
2224	method)))
2225
2226	(defun make-instance-standard-method (gf
2227	&key
2228	lambda-list
2229	qualifiers
2230	specializers
2231	documentation
2232	function
2233	fast-function)
2234	(declare (ignore gf))
2235	(let ((method (std-allocate-instance +the-standard-method-class+))
2236	(analyzed-args (analyze-lambda-list lambda-list)))
2237	(setf (method-lambda-list method) lambda-list)
2238	(setf (method-qualifiers method) qualifiers)
2239	(setf (std-slot-value method 'sys::specializers)
2240	(canonicalize-specializers specializers))
2241	(setf (method-documentation method) documentation)
2242	(setf (std-slot-value method 'sys::%generic-function) nil) ; set by add-method
2243	(setf (std-slot-value method 'sys::%function) function)
2244	(setf (std-slot-value method 'sys::fast-function) fast-function)
2245	(setf (std-slot-value method 'sys::keywords) (getf analyzed-args :keywords))
2246	(setf (std-slot-value method 'sys::other-keywords-p)
2247	(getf analyzed-args :allow-other-keys))
2248	method))
2249
2250	;;; To be redefined as generic functions later
2251	(declaim (notinline add-direct-method))
2252	(defun add-direct-method (specializer method)
2253	(if (or (typep specializer 'eql-specializer)
2254	(typep specializer 'specializer))
2255	(pushnew method (std-slot-value specializer 'direct-methods))
2256	(pushnew method (class-direct-methods specializer))))
2257
2258	(declaim (notinline remove-direct-method))
2259	(defun remove-direct-method (specializer method)
2260	(if (or (typep specializer 'eql-specializer)
2261	(typep specializer 'specializer))
2262	(setf (std-slot-value specializer 'direct-methods)
2263	(remove method (std-slot-value specializer 'direct-methods)))
2264	(setf (class-direct-methods specializer)
2265	(remove method (class-direct-methods specializer)))))
2266
2267	(defun std-add-method (gf method)
2268	;; calls sites need to make sure that method is either a method of the
2269	;; given gf or does not have a gf.
2270	(let ((old-method (%find-method gf (std-method-qualifiers method)
2271	(method-specializers method) nil)))
2272	(when old-method
2273	(if (and (std-generic-function-p gf)
2274	(eq (class-of old-method) +the-standard-method-class+))
2275	(std-remove-method gf old-method)
2276	(remove-method gf old-method))))
2277	(setf (std-slot-value method 'sys::%generic-function) gf)
2278	(push method (std-slot-value gf 'sys::methods))
2279	(dolist (specializer (method-specializers method))
2280	(add-direct-method specializer method))
2281	(finalize-standard-generic-function gf)
2282	gf)
2283
2284	(defun std-remove-method (gf method)
2285	(setf (std-slot-value gf 'sys::methods)
2286	(remove method (generic-function-methods gf)))
2287	(setf (std-slot-value method 'sys::%generic-function) nil)
2288	(dolist (specializer (method-specializers method))
2289	(remove-direct-method specializer method))
2290	(finalize-standard-generic-function gf)
2291	gf)
2292
2293	(defun %find-method (gf qualifiers specializers &optional (errorp t))
2294	;; "If the specializers argument does not correspond in length to the number
2295	;; of required arguments of the generic-function, an an error of type ERROR
2296	;; is signaled."
2297	(unless (= (length specializers) (length (generic-function-required-arguments gf)))
2298	(error "The specializers argument has length ~S, but ~S has ~S required parameters."
2299	(length specializers)
2300	gf
2301	(length (generic-function-required-arguments gf))))
2302	(let* ((canonical-specializers (canonicalize-specializers specializers))
2303	(method
2304	(find-if #'(lambda (method)
2305	(and (equal qualifiers
2306	(method-qualifiers method))
2307	(equal canonical-specializers
2308	(method-specializers method))))
2309	(generic-function-methods gf))))
2310	(if (and (null method) errorp)
2311	(error "No such method for ~S." (generic-function-name gf))
2312	method)))
2313
2314	(defun fast-callable-p (gf)
2315	(and (eq (method-combination-name (generic-function-method-combination gf))
2316	'standard)
2317	(null (intersection (generic-function-lambda-list gf)
2318	'(&rest &optional &key &allow-other-keys &aux)))))
2319
2320	(defun std-compute-discriminating-function (gf)
2321	;; In this function, we know that gf is of class
2322	;; standard-generic-function, so we can access the instance's slots
2323	;; via std-slot-value. This breaks circularities when redefining
2324	;; generic function accessors.
2325	(let ((methods (std-slot-value gf 'sys::methods)))
2326	(cond
2327	((and (= (length methods) 1)
2328	(eq (type-of (car methods)) 'standard-reader-method)
2329	(eq (type-of (car (std-method-specializers (car methods))))
2330	'standard-class))
2331	(let* ((method (first methods))
2332	(slot-definition (std-slot-value method 'sys::%slot-definition))
2333	(slot-name (std-slot-value slot-definition 'sys:name))
2334	(class (car (std-method-specializers method))))
2335	#'(lambda (instance)
2336	;; TODO: elide this test for low values of SAFETY
2337	(unless (typep instance class)
2338	(no-applicable-method gf (list instance)))
2339	;; hash table lookup for slot position in Layout object via
2340	;; StandardObject.SLOT_VALUE, so should be reasonably fast
2341	(std-slot-value instance slot-name))))
2342	((and (= (length methods) 1)
2343	(eq (type-of (car methods)) 'standard-writer-method)
2344	(eq (type-of (second (std-method-specializers (car methods))))
2345	'standard-class))
2346	(let* ((method (first methods))
2347	(slot-definition (std-slot-value method 'sys::%slot-definition))
2348	(slot-name (std-slot-value slot-definition 'sys:name))
2349	(class (car (std-method-specializers method))))
2350	#'(lambda (new-value instance)
2351	;; TODO: elide this test for low values of SAFETY
2352	(unless (typep instance class)
2353	(no-applicable-method gf (list new-value instance)))
2354	;; hash table lookup for slot position in Layout object via
2355	;; StandardObject.SET_SLOT_VALUE, so should be reasonably fast
2356	(setf (std-slot-value instance slot-name) new-value))))
2357	(t
2358	(let* ((number-required (length (generic-function-required-arguments gf)))
2359	(lambda-list (generic-function-lambda-list gf))
2360	(exact (null (intersection lambda-list
2361	'(&rest &optional &key
2362	&allow-other-keys))))
2363	(no-aux (null (some
2364	(lambda (method)
2365	(find '&aux (std-slot-value method 'sys::lambda-list)))
2366	methods))))
2367	(if (and exact
2368	no-aux)
2369	(cond
2370	((= number-required 1)
2371	(cond
2372	((and (eq (method-combination-name
2373	(std-slot-value gf 'sys::%method-combination))
2374	'standard)
2375	(= (length methods) 1)
2376	(std-method-fast-function (%car methods)))
2377	(let* ((method (%car methods))
2378	(specializer (car (std-method-specializers method)))
2379	(function (std-method-fast-function method)))
2380	(if (typep specializer 'eql-specializer)
2381	(let ((specializer-object (eql-specializer-object specializer)))
2382	#'(lambda (arg)
2383	(declare (optimize speed))
2384	(if (eql arg specializer-object)
2385	(funcall function arg)
2386	(no-applicable-method gf (list arg)))))
2387	#'(lambda (arg)
2388	(declare (optimize speed))
2389	(unless (simple-typep arg specializer)
2390	;; FIXME no applicable method
2391	(error 'simple-type-error
2392	:datum arg
2393	:expected-type specializer))
2394	(funcall function arg)))))
2395	(t
2396	#'(lambda (arg)
2397	(declare (optimize speed))
2398	(let* ((args (list arg))
2399	(emfun (get-cached-emf gf args)))
2400	(if emfun
2401	(funcall emfun args)
2402	(slow-method-lookup gf args)))))))
2403	((= number-required 2)
2404	#'(lambda (arg1 arg2)
2405	(declare (optimize speed))
2406	(let* ((args (list arg1 arg2))
2407	(emfun (get-cached-emf gf args)))
2408	(if emfun
2409	(funcall emfun args)
2410	(slow-method-lookup gf args)))))
2411	((= number-required 3)
2412	#'(lambda (arg1 arg2 arg3)
2413	(declare (optimize speed))
2414	(let* ((args (list arg1 arg2 arg3))
2415	(emfun (get-cached-emf gf args)))
2416	(if emfun
2417	(funcall emfun args)
2418	(slow-method-lookup gf args)))))
2419	(t
2420	#'(lambda (&rest args)
2421	(declare (optimize speed))
2422	(let ((len (length args)))
2423	(unless (= len number-required)
2424	(error 'program-error
2425	:format-control "Not enough arguments for generic function ~S."
2426	:format-arguments (list (generic-function-name gf)))))
2427	(let ((emfun (get-cached-emf gf args)))
2428	(if emfun
2429	(funcall emfun args)
2430	(slow-method-lookup gf args))))))
2431	#'(lambda (&rest args)
2432	(declare (optimize speed))
2433	(let ((len (length args)))
2434	(unless (>= len number-required)
2435	(error 'program-error
2436	:format-control "Not enough arguments for generic function ~S."
2437	:format-arguments (list (generic-function-name gf)))))
2438	(let ((emfun (get-cached-emf gf args)))
2439	(if emfun
2440	(funcall emfun args)
2441	(slow-method-lookup gf args))))))))))
2442
2443	(defun sort-methods (methods gf required-classes)
2444	(if (or (null methods) (null (%cdr methods)))
2445	methods
2446	(sort methods
2447	(if (std-generic-function-p gf)
2448	(let ((method-indices
2449	(argument-precedence-order-indices
2450	(generic-function-argument-precedence-order gf)
2451	(getf (analyze-lambda-list (generic-function-lambda-list gf))
2452	':required-args))))
2453	#'(lambda (m1 m2)
2454	(std-method-more-specific-p
2455	m1 m2 required-classes method-indices)))
2456	#'(lambda (m1 m2)
2457	(method-more-specific-p gf m1 m2 required-classes))))))
2458
2459	(defun method-applicable-p (method args)
2460	(do* ((specializers (method-specializers method) (cdr specializers))
2461	(args args (cdr args)))
2462	((null specializers) t)
2463	(let ((specializer (car specializers)))
2464	(if (typep specializer 'eql-specializer)
2465	(unless (eql (car args) (eql-specializer-object specializer))
2466	(return nil))
2467	(unless (subclassp (class-of (car args)) specializer)
2468	(return nil))))))
2469
2470	(defun std-compute-applicable-methods (gf args)
2471	(let ((required-classes (mapcar #'class-of (required-portion gf args)))
2472	(methods '()))
2473	(dolist (method (generic-function-methods gf))
2474	(when (method-applicable-p method args)
2475	(push method methods)))
2476	(sort-methods methods gf required-classes)))
2477
2478	(declaim (notinline compute-applicable-methods))
2479	(defun compute-applicable-methods (gf args)
2480	(std-compute-applicable-methods gf args))
2481
2482	;;; METHOD-APPLICABLE-USING-CLASSES-P
2483	;;;
2484	;;; If the first return value is T, METHOD is definitely applicable to
2485	;;; arguments that are instances of CLASSES. If the first value is
2486	;;; NIL and the second value is T, METHOD is definitely not applicable
2487	;;; to arguments that are instances of CLASSES; if the second value is
2488	;;; NIL the applicability of METHOD cannot be determined by inspecting
2489	;;; the classes of its arguments only.
2490	;;;
2491	(defun method-applicable-using-classes-p (method classes)
2492	(do* ((specializers (method-specializers method) (cdr specializers))
2493	(classes classes (cdr classes))
2494	(knownp t))
2495	((null specializers)
2496	(if knownp (values t t) (values nil nil)))
2497	(let ((specializer (car specializers)))
2498	(if (typep specializer 'eql-specializer)
2499	(if (eql (class-of (eql-specializer-object specializer))
2500	(car classes))
2501	(setf knownp nil)
2502	(return (values nil t)))
2503	(unless (subclassp (car classes) specializer)
2504	(return (values nil t)))))))
2505
2506	(defun check-applicable-method-keyword-args (gf args
2507	keyword-args
2508	applicable-keywords)
2509	(when (oddp (length keyword-args))
2510	(error 'program-error
2511	:format-control "Odd number of keyword arguments in call to ~S ~
2512	with arguments list ~S"
2513	:format-arguments (list gf args)))
2514	(unless (getf keyword-args :allow-other-keys)
2515	(loop for key in keyword-args by #'cddr
2516	unless (or (member key applicable-keywords)
2517	(eq key :allow-other-keys))
2518	do (error 'program-error
2519	:format-control "Invalid keyword argument ~S in call ~
2520	to ~S with argument list ~S."
2521	:format-arguments (list key gf args)))))
2522
2523	(defun compute-applicable-keywords (gf applicable-methods)
2524	(let ((applicable-keywords
2525	(getf (analyze-lambda-list (generic-function-lambda-list gf))
2526	:keywords)))
2527	(loop for method in applicable-methods
2528	do (multiple-value-bind
2529	(keywords allow-other-keys)
2530	(function-keywords method)
2531	(when allow-other-keys
2532	(setf applicable-keywords :any)
2533	(return))
2534	(setf applicable-keywords
2535	(union applicable-keywords keywords))))
2536	applicable-keywords))
2537
2538	(defun wrap-emfun-for-keyword-args-check (gf emfun non-keyword-args
2539	applicable-keywords)
2540	#'(lambda (args)
2541	(check-applicable-method-keyword-args
2542	gf args
2543	(nthcdr non-keyword-args args) applicable-keywords)
2544	(funcall emfun args)))
2545
2546	(defun slow-method-lookup (gf args)
2547	(let ((applicable-methods
2548	(if (std-generic-function-p gf)
2549	(std-compute-applicable-methods gf args)
2550	(or (compute-applicable-methods-using-classes gf (mapcar #'class-of args))
2551	(compute-applicable-methods gf args)))))
2552	(if applicable-methods
2553	(let* ((emfun (funcall (if (std-generic-function-p gf)
2554	#'std-compute-effective-method
2555	#'compute-effective-method)
2556	gf (generic-function-method-combination gf)
2557	applicable-methods))
2558	(non-keyword-args (+ (length (generic-function-required-arguments gf))
2559	(length (generic-function-optional-arguments gf))))
2560	(gf-lambda-list (generic-function-lambda-list gf))
2561	(checks-required (and (member '&key gf-lambda-list)
2562	(not (member '&allow-other-keys
2563	gf-lambda-list))))
2564	(applicable-keywords
2565	(when checks-required
2566	;; Don't do applicable keyword checks when this is
2567	;; one of the 'exceptional four' or when the gf allows
2568	;; other keywords.
2569	(compute-applicable-keywords gf applicable-methods))))
2570	(when (and checks-required
2571	(not (eq applicable-keywords :any)))
2572	(setf emfun
2573	(wrap-emfun-for-keyword-args-check gf emfun non-keyword-args
2574	applicable-keywords)))
2575	;;; Cache only understand classes and eql specializers
2576	(when (eq (class-of gf) 'standard-generic-function)
2577	(cache-emf gf args emfun))
2578	(funcall emfun args))
2579	(apply #'no-applicable-method gf args))))
2580
2581	(defun sub-specializer-p (c1 c2 c-arg)
2582	(find c2 (cdr (memq c1 (%class-precedence-list c-arg)))))
2583
2584	(defun std-method-more-specific-p (method1 method2 required-classes argument-precedence-order)
2585	(if argument-precedence-order
2586	(let ((specializers-1 (std-method-specializers method1))
2587	(specializers-2 (std-method-specializers method2)))
2588	(dolist (index argument-precedence-order)
2589	(let ((spec1 (nth index specializers-1))
2590	(spec2 (nth index specializers-2)))
2591	(unless (eq spec1 spec2)
2592	(cond ((typep spec1 'eql-specializer)
2593	(return t))
2594	((typep spec2 'eql-specializer)
2595	(return nil))
2596	(t
2597	(return (sub-specializer-p spec1 spec2
2598	(nth index required-classes)))))))))
2599	(do ((specializers-1 (std-method-specializers method1) (cdr specializers-1))
2600	(specializers-2 (std-method-specializers method2) (cdr specializers-2))
2601	(classes required-classes (cdr classes)))
2602	((null specializers-1) nil)
2603	(let ((spec1 (car specializers-1))
2604	(spec2 (car specializers-2)))
2605	(unless (eq spec1 spec2)
2606	(cond ((typep spec1 'eql-specializer)
2607	(return t))
2608	((typep spec2 'eql-specializer)
2609	(return nil))
2610	(t
2611	(return (sub-specializer-p spec1 spec2 (car classes))))))))))
2612
2613	(defun primary-method-p (method)
2614	(null (intersection '(:before :after :around) (method-qualifiers method))))
2615
2616	(defun before-method-p (method)
2617	(equal '(:before) (method-qualifiers method)))
2618
2619	(defun after-method-p (method)
2620	(equal '(:after) (method-qualifiers method)))
2621
2622	(defun around-method-p (method)
2623	(equal '(:around) (method-qualifiers method)))
2624
2625	(defun process-next-method-list (next-method-list)
2626	(mapcar #'(lambda (next-method-form)
2627	(cond
2628	((listp next-method-form)
2629	(assert (eq (first next-method-form) 'make-method))
2630	(let* ((rest-sym (gensym)))
2631	(make-instance-standard-method
2632	nil ;; ignored
2633	:lambda-list (list '&rest rest-sym)
2634	:function (compute-method-function `(lambda (&rest ,rest-sym)
2635	,(second next-method-form))))))
2636	(t
2637	(assert (typep next-method-form 'method))
2638	next-method-form)))
2639	next-method-list))
2640
2641	(defun std-compute-effective-method (gf method-combination methods)
2642	(assert (typep method-combination 'method-combination))
2643	(let* ((mc-name (method-combination-name method-combination))
2644	(options (slot-value method-combination 'options))
2645	(order (car options))
2646	(primaries '())
2647	(arounds '())
2648	around
2649	emf-form
2650	(long-method-combination-p
2651	(typep method-combination 'long-method-combination)))
2652	(unless long-method-combination-p
2653	(dolist (m methods)
2654	(let ((qualifiers (method-qualifiers m)))
2655	(cond ((null qualifiers)
2656	(if (eq mc-name 'standard)
2657	(push m primaries)
2658	(error "Method combination type mismatch: missing qualifier for method combination ~S." method-combination)))
2659	((cdr qualifiers)
2660	(error "Invalid method qualifiers."))
2661	((eq (car qualifiers) :around)
2662	(push m arounds))
2663	((eq (car qualifiers) mc-name)
2664	(push m primaries))
2665	((memq (car qualifiers) '(:before :after)))
2666	(t
2667	(error "Invalid method qualifiers."))))))
2668	(unless (eq order :most-specific-last)
2669	(setf primaries (nreverse primaries)))
2670	(setf arounds (nreverse arounds))
2671	(setf around (car arounds))
2672	(when (and (null primaries) (not long-method-combination-p))
2673	(error "No primary methods for the generic function ~S." gf))
2674	(cond
2675	(around
2676	(let ((next-emfun
2677	(funcall
2678	(if (std-generic-function-p gf)
2679	#'std-compute-effective-method
2680	#'compute-effective-method)
2681	gf method-combination (remove around methods))))
2682	(setf emf-form
2683	(generate-emf-lambda (method-function around) next-emfun))))
2684	((eq mc-name 'standard)
2685	(let* ((next-emfun (compute-primary-emfun (cdr primaries)))
2686	(befores (remove-if-not #'before-method-p methods))
2687	(reverse-afters
2688	(reverse (remove-if-not #'after-method-p methods))))
2689	(setf emf-form
2690	(cond
2691	((and (null befores) (null reverse-afters))
2692	(let ((fast-function (std-method-fast-function (car primaries))))
2693	(if fast-function
2694	(ecase (length (generic-function-required-arguments gf))
2695	(1
2696	#'(lambda (args)
2697	(declare (optimize speed))
2698	(funcall fast-function (car args))))
2699	(2
2700	#'(lambda (args)
2701	(declare (optimize speed))
2702	(funcall fast-function (car args) (cadr args)))))
2703	(generate-emf-lambda (std-method-function (car primaries))
2704	next-emfun))))
2705	(t
2706	(let ((method-function (method-function (car primaries))))
2707	#'(lambda (args)
2708	(declare (optimize speed))
2709	(dolist (before befores)
2710	(funcall (method-function before) args nil))
2711	(multiple-value-prog1
2712	(funcall method-function args next-emfun)
2713	(dolist (after reverse-afters)
2714	(funcall (method-function after) args nil))))))))))
2715	(long-method-combination-p
2716	(let ((function (long-method-combination-function method-combination))
2717	(arguments (slot-value method-combination 'options)))
2718	(assert function)
2719	(setf emf-form
2720	(if arguments
2721	(apply function gf methods arguments)
2722	(funcall function gf methods)))))
2723	(t
2724	(unless (typep method-combination 'short-method-combination)
2725	(error "Unsupported method combination type ~A." mc-name))
2726	(let ((operator (short-method-combination-operator method-combination))
2727	(ioa (short-method-combination-identity-with-one-argument method-combination)))
2728	(setf emf-form
2729	(if (and ioa (null (cdr primaries)))
2730	(generate-emf-lambda (method-function (car primaries)) nil)
2731	`(lambda (args)
2732	(,operator ,@(mapcar
2733	(lambda (primary)
2734	`(funcall ,(method-function primary) args nil))
2735	primaries))))))))
2736	(assert (not (null emf-form)))
2737	(or #+nil (ignore-errors (autocompile emf-form))
2738	(coerce-to-function emf-form))))
2739
2740	(defun generate-emf-lambda (method-function next-emfun)
2741	#'(lambda (args)
2742	(declare (optimize speed))
2743	(funcall method-function args next-emfun)))
2744
2745	;;; compute an effective method function from a list of primary methods:
2746
2747	(defun compute-primary-emfun (methods)
2748	(if (null methods)
2749	nil
2750	(let ((next-emfun (compute-primary-emfun (cdr methods))))
2751	#'(lambda (args)
2752	(funcall (std-method-function (car methods)) args next-emfun)))))
2753
2754	(defvar call-next-method-p)
2755	(defvar next-method-p-p)
2756
2757	;;; FIXME this doesn't work for macroized references
2758	(defun walk-form (form)
2759	(cond ((atom form)
2760	(cond ((eq form 'call-next-method)
2761	(setf call-next-method-p t))
2762	((eq form 'next-method-p)
2763	(setf next-method-p-p t))))
2764	(t
2765	(walk-form (%car form))
2766	(walk-form (%cdr form)))))
2767
2768	(defmacro flet-call-next-method (args next-emfun &body body)
2769	`(flet ((call-next-method (&rest cnm-args)
2770	(if (null ,next-emfun)
2771	(error "No next method for generic function.")
2772	(funcall ,next-emfun (or cnm-args ,args))))
2773	(next-method-p ()
2774	(not (null ,next-emfun))))
2775	(declare (ignorable (function call-next-method)
2776	(function next-method-p)))
2777	,@body))
2778
2779	(defun compute-method-function (lambda-expression)
2780	(let ((lambda-list (allow-other-keys (cadr lambda-expression)))
2781	(body (cddr lambda-expression)))
2782	(multiple-value-bind (body declarations) (parse-body body)
2783	(let ((ignorable-vars '()))
2784	(dolist (var lambda-list)
2785	(if (memq var lambda-list-keywords)
2786	(return)
2787	(push var ignorable-vars)))
2788	(push `(declare (ignorable ,@ignorable-vars)) declarations))
2789	(if (null (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux)))
2790	;; Required parameters only.
2791	(case (length lambda-list)
2792	(1
2793	`(lambda (args next-emfun)
2794	(let ((,(%car lambda-list) (%car args)))
2795	(declare (ignorable ,(%car lambda-list)))
2796	,@declarations
2797	(flet-call-next-method args next-emfun
2798	,@body))))
2799	(2
2800	`(lambda (args next-emfun)
2801	(let ((,(%car lambda-list) (%car args))
2802	(,(%cadr lambda-list) (%cadr args)))
2803	(declare (ignorable ,(%car lambda-list)
2804	,(%cadr lambda-list)))
2805	,@declarations
2806	(flet-call-next-method args next-emfun
2807	,@body))))
2808	(3
2809	`(lambda (args next-emfun)
2810	(let ((,(%car lambda-list) (%car args))
2811	(,(%cadr lambda-list) (%cadr args))
2812	(,(%caddr lambda-list) (%caddr args)))
2813	(declare (ignorable ,(%car lambda-list)
2814	,(%cadr lambda-list)
2815	,(%caddr lambda-list)))
2816	,@declarations
2817	(flet-call-next-method args next-emfun
2818	,@body))))
2819	(t
2820	`(lambda (args next-emfun)
2821	(apply #'(lambda ,lambda-list
2822	,@declarations
2823	(flet-call-next-method args next-emfun
2824	,@body))
2825	args))))
2826	`(lambda (args next-emfun)
2827	(apply #'(lambda ,lambda-list
2828	,@declarations
2829	(flet-call-next-method args next-emfun
2830	,@body))
2831	args))))))
2832
2833	(defun compute-method-fast-function (lambda-expression)
2834	(let ((lambda-list (allow-other-keys (cadr lambda-expression))))
2835	(when (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux))
2836	(return-from compute-method-fast-function nil))
2837	;; Only required args.
2838	(let ((body (cddr lambda-expression))
2839	(call-next-method-p nil)
2840	(next-method-p-p nil))
2841	(multiple-value-bind (body declarations) (parse-body body)
2842	;;; N.b. The WALK-FORM check is bogus for "hidden"
2843	;;; macroizations of CALL-NEXT-METHOD and NEXT-METHOD-P but
2844	;;; the presence of FAST-FUNCTION slots in our CLOS is
2845	;;; currently necessary to bootstrap CLOS in a way I didn't
2846	;;; manage to easily untangle.
2847	(walk-form body)
2848	(when (or call-next-method-p next-method-p-p)
2849	(return-from compute-method-fast-function nil))
2850	(let ((declaration `(declare (ignorable ,@lambda-list))))
2851	;;; 2020-10-19 refactored this expression from previous code
2852	;;; that was only declaring a fast function for one or two
2853	;;; element values of lamba-list
2854	(if (< 0 (length lambda-list) 3)
2855	`(lambda ,(cadr lambda-expression)
2856	,declaration
2857	(flet ((call-next-method (&rest args)
2858	(declare (ignore args))
2859	(error "No next method for generic function"))
2860	(next-method-p () nil))
2861	(declare (ignorable (function call-next-method)
2862	(function next-method-p)))
2863	,@body))
2864	nil))))))
2865
2866
2867	(declaim (notinline make-method-lambda))
2868	(defun make-method-lambda (generic-function method lambda-expression env)
2869	(declare (ignore generic-function method env))
2870	(values (compute-method-function lambda-expression) nil))
2871
2872
2873	;; From CLHS section 7.6.5:
2874	;; "When a generic function or any of its methods mentions &key in a lambda
2875	;; list, the specific set of keyword arguments accepted by the generic function
2876	;; varies according to the applicable methods. The set of keyword arguments
2877	;; accepted by the generic function for a particular call is the union of the
2878	;; keyword arguments accepted by all applicable methods and the keyword
2879	;; arguments mentioned after &key in the generic function definition, if any."
2880	;; Adapted from Sacla.
2881	(defun allow-other-keys (lambda-list)
2882	(if (and (member '&key lambda-list)
2883	(not (member '&allow-other-keys lambda-list)))
2884	(let* ((key-end (or (position '&aux lambda-list) (length lambda-list)))
2885	(aux-part (subseq lambda-list key-end)))
2886	`(,@(subseq lambda-list 0 key-end) &allow-other-keys ,@aux-part))
2887	lambda-list))
2888
2889	(defmacro defmethod (&rest args &environment env)
2890	(multiple-value-bind
2891	(function-name qualifiers lambda-list specializers documentation declarations body)
2892	(parse-defmethod args)
2893	(let* ((specializers-form '())
2894	(lambda-expression `(lambda ,lambda-list ,@declarations ,body))
2895	(gf (or (find-generic-function function-name nil)
2896	(class-prototype (find-class 'standard-generic-function))))
2897	(method-function
2898	(make-method-lambda gf (class-prototype (generic-function-method-class gf))
2899	lambda-expression env))
2900	(fast-function (compute-method-fast-function lambda-expression))
2901	)
2902	(dolist (specializer specializers)
2903	(cond ((and (consp specializer) (eq (car specializer) 'eql))
2904	(push `(list 'eql ,(cadr specializer)) specializers-form))
2905	(t
2906	(push `',specializer specializers-form))))
2907	(setf specializers-form `(list ,@(nreverse specializers-form)))
2908	`(progn
2909	(sys::record-source-information-for-type ',function-name '(:method ,function-name ,qualifiers ,specializers))
2910	(ensure-method ',function-name
2911	:lambda-list ',lambda-list
2912	:qualifiers ',qualifiers
2913	:specializers (canonicalize-specializers ,specializers-form)
2914	,@(when documentation `(:documentation ,documentation))
2915	:function (function ,method-function)
2916	,@(when fast-function `(:fast-function (function ,fast-function)))
2917	)))))
2918
2919	;;; Reader and writer methods
2920
2921	(defun make-instance-standard-accessor-method (method-class
2922	&key
2923	lambda-list
2924	qualifiers
2925	specializers
2926	documentation
2927	function
2928	fast-function
2929	slot-definition)
2930	(let ((method (std-allocate-instance method-class)))
2931	(setf (method-lambda-list method) lambda-list)
2932	(setf (method-qualifiers method) qualifiers)
2933	(setf (std-slot-value method 'sys::specializers)
2934	(canonicalize-specializers specializers))
2935	(setf (method-documentation method) documentation)
2936	(setf (std-slot-value method 'sys::%generic-function) nil)
2937	(setf (std-slot-value method 'sys::%function) function)
2938	(setf (std-slot-value method 'sys::fast-function) fast-function)
2939	(setf (std-slot-value method 'sys::%slot-definition) slot-definition)
2940	(setf (std-slot-value method 'sys::keywords) nil)
2941	(setf (std-slot-value method 'sys::other-keywords-p) nil)
2942	method))
2943
2944	(defun add-reader-method (class function-name slot-definition)
2945	(let* ((slot-name (slot-definition-name slot-definition))
2946	(lambda-expression
2947	(if (std-class-p class)
2948	`(lambda (object) (std-slot-value object ',slot-name))
2949	`(lambda (object) (slot-value object ',slot-name))))
2950	(method-function (compute-method-function lambda-expression))
2951	(fast-function (compute-method-fast-function lambda-expression))
2952	(method-lambda-list '(object))
2953	(gf (find-generic-function function-name nil))
2954	(initargs `(:lambda-list ,method-lambda-list
2955	:qualifiers ()
2956	:specializers (,class)
2957	:function ,(if (autoloadp 'compile)
2958	method-function
2959	(autocompile method-function))
2960	:fast-function ,(if (autoloadp 'compile)
2961	fast-function
2962	(autocompile fast-function))
2963	:slot-definition ,slot-definition))
2964	(method-class (if (std-class-p class)
2965	+the-standard-reader-method-class+
2966	(apply #'reader-method-class class slot-definition
2967	initargs))))
2968	;; required by AMOP pg. 225
2969	(assert (subtypep method-class +the-standard-reader-method-class+))
2970	(if gf
2971	(check-method-lambda-list function-name
2972	method-lambda-list
2973	(generic-function-lambda-list gf))
2974	(setf gf (ensure-generic-function function-name
2975	:lambda-list method-lambda-list)))
2976	(let ((method
2977	(if (eq method-class +the-standard-reader-method-class+)
2978	(apply #'make-instance-standard-accessor-method method-class
2979	initargs)
2980	(apply #'make-instance method-class
2981	:generic-function nil ; handled by add-method
2982	initargs))))
2983	(if (std-generic-function-p gf)
2984	(progn
2985	(std-add-method gf method)
2986	(map-dependents gf
2987	#'(lambda (dep)
2988	(update-dependent gf dep 'add-method method))))
2989	(add-method gf method))
2990	(sys::record-source-information-for-type function-name `(:slot-reader ,function-name ,(class-name class)))
2991	method)))
2992
2993	(defun add-writer-method (class function-name slot-definition)
2994	(let* ((slot-name (slot-definition-name slot-definition))
2995	(lambda-expression
2996	(if (std-class-p class)
2997	`(lambda (new-value object)
2998	(setf (std-slot-value object ',slot-name) new-value))
2999	`(lambda (new-value object)
3000	(setf (slot-value object ',slot-name) new-value))))
3001	(method-function (compute-method-function lambda-expression))
3002	(fast-function (compute-method-fast-function lambda-expression))
3003	(method-lambda-list '(new-value object))
3004	(gf (find-generic-function function-name nil))
3005	(initargs `(:lambda-list ,method-lambda-list
3006	:qualifiers ()
3007	:specializers (,+the-T-class+ ,class)
3008	:function ,(if (autoloadp 'compile)
3009	method-function
3010	(autocompile method-function))
3011	:fast-function ,(if (autoloadp 'compile)
3012	fast-function
3013	(autocompile fast-function))
3014	:slot-definition ,slot-definition))
3015	(method-class (if (std-class-p class)
3016	+the-standard-writer-method-class+
3017	(apply #'writer-method-class class slot-definition
3018	initargs))))
3019	;; required by AMOP pg. 242
3020	(assert (subtypep method-class +the-standard-writer-method-class+))
3021	(if gf
3022	(check-method-lambda-list function-name
3023	method-lambda-list
3024	(generic-function-lambda-list gf))
3025	(setf gf (ensure-generic-function function-name
3026	:lambda-list method-lambda-list)))
3027	(let ((method
3028	(if (eq method-class +the-standard-writer-method-class+)
3029	(apply #'make-instance-standard-accessor-method method-class
3030	initargs)
3031	(apply #'make-instance method-class
3032	:generic-function nil ; handled by add-method
3033	initargs))))
3034	(if (std-generic-function-p gf)
3035	(progn
3036	(std-add-method gf method)
3037	(map-dependents gf
3038	#'(lambda (dep)
3039	(update-dependent gf dep 'add-method method))))
3040	(add-method gf method))
3041	(sys::record-source-information-for-type function-name `(:slot-writer ,function-name ,(class-name class)))
3042	method)))
3043
3044	(defmacro atomic-defgeneric (function-name &rest rest)
3045	"Macro to define a generic function and 'swap it into place' after
3046	it's been fully defined with all its methods.
3047
3048	Note: the user should really use the (:method ..) method description
3049	way of defining methods; there's not much use in atomically defining
3050	generic functions without providing sensible behaviour."
3051	(let ((temp-sym (gensym)))
3052	`(progn
3053	(defgeneric ,temp-sym ,@rest)
3054	(sys::record-source-information-for-type ',function-name '(:generic-function ,function-name))
3055	,@(loop for method-form in rest
3056	when (eq (car method-form) :method)
3057	collect
3058	(multiple-value-bind (function-name qualifiers lambda-list specializers documentation declarations body)
3059	(mop::parse-defmethod `(,function-name ,@(rest method-form)))
3060	`(sys::record-source-information-for-type ',function-name '(:method ,function-name ,qualifiers ,specializers))))
3061	(let ((gf (symbol-function ',temp-sym)))
3062	;; FIXME (rudi 2012-07-08): fset gets the source location info
3063	;; to charpos 23 always (but (setf fdefinition) leaves the
3064	;; outdated source position in place, which is even worse).
3065	(fset ',function-name gf)
3066	(setf (std-slot-value gf 'sys::name) ',function-name)
3067	(fmakunbound ',temp-sym)
3068	gf))))
3069
3070	(defmacro redefine-class-forwarder (name slot &optional body-alist)
3071	"Define a generic function on a temporary symbol as an accessor
3072	for the slot `slot'. Then, when definition is complete (including
3073	allocation of methods), swap the definition in place.
3074
3075	`body-alist' can be used to override the default method bodies for given
3076	metaclasses. In substitute method bodies, `class' names the class
3077	instance and, for setters, `new-value' the new value."
3078	(let* ((setterp (consp name))
3079	(%name
3080	(intern (concatenate 'string
3081	"%"
3082	(if setterp (symbol-name 'set-) "")
3083	(symbol-name (if setterp (cadr name) name)))
3084	(find-package "SYS")))
3085	(bodies
3086	(append body-alist
3087	(if setterp
3088	`((built-in-class . (,%name new-value class))
3089	(forward-referenced-class . (,%name new-value class))
3090	(structure-class . (,%name new-value class))
3091	(standard-class . (setf (slot-value class ',slot)
3092	new-value))
3093	(funcallable-standard-class . (setf (slot-value class ',slot)
3094	new-value)))
3095	`((built-in-class . (,%name class))
3096	(forward-referenced-class . (,%name class))
3097	(structure-class . (,%name class))
3098	(standard-class . (slot-value class ',slot))
3099	(funcallable-standard-class . (slot-value class ',slot)))))))
3100	`(atomic-defgeneric ,name (,@(when setterp (list 'new-value)) class)
3101	,@(mapcar #'(lambda (class-name)
3102	`(:method (,@(when setterp (list 'new-value))
3103	(class ,class-name))
3104	,(cdr (assoc class-name bodies))))
3105	'(built-in-class forward-referenced-class structure-class
3106	standard-class funcallable-standard-class)))))
3107
3108	;;; The slot names here must agree with the ones defined in
3109	;;; StandardClass.java:layoutStandardClass.
3110	(redefine-class-forwarder class-name sys:name)
3111	;;; AMOP pg. 230
3112	(redefine-class-forwarder (setf class-name) sys:name
3113	((standard-class . (progn (reinitialize-instance class :name new-value) new-value))
3114	(funcallable-standard-class . (progn (reinitialize-instance class :name new-value) new-value))))
3115	(redefine-class-forwarder class-slots sys:slots)
3116	(redefine-class-forwarder (setf class-slots) sys:slots)
3117	(redefine-class-forwarder class-direct-slots sys:direct-slots)
3118	(redefine-class-forwarder (setf class-direct-slots) sys:direct-slots)
3119	(redefine-class-forwarder class-layout sys:layout)
3120	(redefine-class-forwarder (setf class-layout) sys:layout)
3121	(redefine-class-forwarder class-direct-superclasses sys:direct-superclasses)
3122	(redefine-class-forwarder (setf class-direct-superclasses) sys:direct-superclasses)
3123	(redefine-class-forwarder class-direct-subclasses sys:direct-subclasses)
3124	(redefine-class-forwarder (setf class-direct-subclasses) sys:direct-subclasses)
3125	(redefine-class-forwarder class-direct-methods sys:direct-methods)
3126	(redefine-class-forwarder (setf class-direct-methods) sys:direct-methods)
3127	(redefine-class-forwarder class-precedence-list sys:precedence-list)
3128	(redefine-class-forwarder (setf class-precedence-list) sys:precedence-list)
3129	(redefine-class-forwarder class-finalized-p sys:finalized-p)
3130	(redefine-class-forwarder (setf class-finalized-p) sys:finalized-p)
3131	(redefine-class-forwarder class-default-initargs sys:default-initargs)
3132	(redefine-class-forwarder (setf class-default-initargs) sys:default-initargs)
3133	(redefine-class-forwarder class-direct-default-initargs sys:direct-default-initargs)
3134	(redefine-class-forwarder (setf class-direct-default-initargs) sys:direct-default-initargs)
3135
3136	;;; Class definition
3137
3138	(defun check-duplicate-slots (slots)
3139	(flet ((canonical-slot-name (canonical-slot)
3140	(getf canonical-slot :name)))
3141	(dolist (s1 slots)
3142	(let ((name1 (canonical-slot-name s1)))
3143	(dolist (s2 (cdr (memq s1 slots)))
3144	(when (eq name1 (canonical-slot-name s2))
3145	(error 'program-error "Duplicate slot ~S" name1)))))))
3146
3147	(defun check-duplicate-default-initargs (initargs)
3148	(let ((names ()))
3149	(dolist (initarg initargs)
3150	(push (car initarg) names))
3151	(do* ((names names (cdr names))
3152	(name (car names) (car names)))
3153	((null names))
3154	(when (memq name (cdr names))
3155	(error 'program-error
3156	:format-control "Duplicate initialization argument name ~S in :DEFAULT-INITARGS."
3157	:format-arguments (list name))))))
3158
3159	(defun canonicalize-direct-superclasses (direct-superclasses)
3160	(let ((classes '()))
3161	(dolist (class-specifier direct-superclasses)
3162	(let ((class (if (classp class-specifier)
3163	class-specifier
3164	(find-class class-specifier nil))))
3165	(unless class
3166	(setf class (make-instance +the-forward-referenced-class+
3167	:name class-specifier))
3168	(setf (find-class class-specifier) class))
3169	(when (and (typep class 'built-in-class)
3170	(not (member class extensible-built-in-classes)))
3171	(error "Attempt to define a subclass of built-in-class ~S."
3172	class-specifier))
3173	(push class classes)))
3174	(nreverse classes)))
3175
3176	(atomic-defgeneric add-direct-subclass (superclass subclass)
3177	(:method ((superclass class) (subclass class))
3178	(setf (class-direct-subclasses superclass)
3179	(adjoin subclass (class-direct-subclasses superclass)))))
3180
3181	(atomic-defgeneric remove-direct-subclass (superclass subclass)
3182	(:method ((superclass class) (subclass class))
3183	(setf (class-direct-subclasses superclass)
3184	(remove subclass (class-direct-subclasses superclass)))))
3185
3186	;;; AMOP pg. 182
3187	(defun ensure-class (name &rest all-keys &key &allow-other-keys)
3188	(let ((class (find-class name nil)))
3189	;; CLHS DEFCLASS: "If a class with the same proper name already
3190	;; exists [...] the existing class is redefined." Ansi-tests
3191	;; CLASS-0309 and CLASS-0310.1 demand this behavior.
3192	(if (and class (eql (class-name class) name))
3193	(apply #'ensure-class-using-class class name all-keys)
3194	(apply #'ensure-class-using-class nil name all-keys))))
3195
3196	;;; AMOP pg. 183ff.
3197	(defgeneric ensure-class-using-class (class name &key direct-default-initargs
3198	direct-slots direct-superclasses
3199	metaclass &allow-other-keys))
3200
3201	(defmethod ensure-class-using-class :before (class name &key direct-slots
3202	direct-default-initargs
3203	&allow-other-keys)
3204	(check-duplicate-slots direct-slots)
3205	(check-duplicate-default-initargs direct-default-initargs))
3206
3207	(defmethod ensure-class-using-class ((class null) name &rest all-keys
3208	&key (metaclass +the-standard-class+)
3209	direct-superclasses
3210	&allow-other-keys)
3211	(setf all-keys (copy-list all-keys)) ; since we modify it
3212	(remf all-keys :metaclass)
3213	(unless (classp metaclass) (setf metaclass (find-class metaclass)))
3214	(let ((class (apply (if (eq metaclass +the-standard-class+)
3215	#'make-instance-standard-class
3216	#'make-instance)
3217	metaclass :name name
3218	:direct-superclasses (canonicalize-direct-superclasses
3219	direct-superclasses)
3220	all-keys)))
3221	(%set-find-class name class)
3222	class))
3223
3224	(defmethod ensure-class-using-class ((class built-in-class) name &rest all-keys
3225	&key &allow-other-keys)
3226	(declare (ignore all-keys))
3227	(error "The symbol ~S names a built-in class." name))
3228
3229	(defmethod ensure-class-using-class ((class forward-referenced-class) name
3230	&rest all-keys
3231	&key (metaclass +the-standard-class+)
3232	direct-superclasses &allow-other-keys)
3233	(setf all-keys (copy-list all-keys)) ; since we modify it
3234	(remf all-keys :metaclass)
3235	(unless (classp metaclass) (setf metaclass (find-class metaclass)))
3236	(apply #'change-class class metaclass all-keys)
3237	(apply #'reinitialize-instance class
3238	:name name
3239	:direct-superclasses (canonicalize-direct-superclasses
3240	direct-superclasses)
3241	all-keys)
3242	class)
3243
3244	(defmethod ensure-class-using-class ((class class) name
3245	&rest all-keys
3246	&key (metaclass +the-standard-class+ metaclassp)
3247	direct-superclasses
3248	&allow-other-keys)
3249	(declare (ignore name))
3250	(setf all-keys (copy-list all-keys)) ; since we modify it
3251	(remf all-keys :metaclass)
3252	(unless (classp metaclass) (setf metaclass (find-class metaclass)))
3253	(when (and metaclassp (not (eq (class-of class) metaclass)))
3254	(error 'program-error
3255	"Trying to redefine class ~S with different metaclass."
3256	(class-name class)))
3257	(apply #'reinitialize-instance class
3258	:direct-superclasses (canonicalize-direct-superclasses direct-superclasses)
3259	all-keys)
3260	class)
3261
3262	(defmacro defclass (&whole form name direct-superclasses direct-slots &rest options)
3263	(unless (>= (length form) 3)
3264	(error 'program-error "Wrong number of arguments for DEFCLASS."))
3265	(check-declaration-type name)
3266	`(progn
3267	(sys::record-source-information-for-type ',name :class)
3268	(ensure-class ',name
3269	:direct-superclasses
3270	(canonicalize-direct-superclasses ',direct-superclasses)
3271	:direct-slots
3272	,(canonicalize-direct-slots direct-slots)
3273	,@(canonicalize-defclass-options options))))
3274
3275
3276	;;; AMOP pg. 180
3277	(defgeneric direct-slot-definition-class (class &rest initargs))
3278
3279	(defmethod direct-slot-definition-class ((class class) &rest initargs)
3280	(declare (ignore initargs))
3281	+the-standard-direct-slot-definition-class+)
3282
3283	;;; AMOP pg. 181
3284	(defgeneric effective-slot-definition-class (class &rest initargs))
3285
3286	(defmethod effective-slot-definition-class ((class class) &rest initargs)
3287	(declare (ignore initargs))
3288	+the-standard-effective-slot-definition-class+)
3289
3290	;;; AMOP pg. 224
3291	(defgeneric reader-method-class (class direct-slot &rest initargs))
3292
3293	(defmethod reader-method-class ((class standard-class)
3294	(direct-slot standard-direct-slot-definition)
3295	&rest initargs)
3296	(declare (ignore initargs))
3297	+the-standard-reader-method-class+)
3298
3299	(defmethod reader-method-class ((class funcallable-standard-class)
3300	(direct-slot standard-direct-slot-definition)
3301	&rest initargs)
3302	(declare (ignore initargs))
3303	+the-standard-reader-method-class+)
3304
3305	;;; AMOP pg. 242
3306	(defgeneric writer-method-class (class direct-slot &rest initargs))
3307
3308	(defmethod writer-method-class ((class standard-class)
3309	(direct-slot standard-direct-slot-definition)
3310	&rest initargs)
3311	(declare (ignore initargs))
3312	+the-standard-writer-method-class+)
3313
3314	(defmethod writer-method-class ((class funcallable-standard-class)
3315	(direct-slot standard-direct-slot-definition)
3316	&rest initargs)
3317	(declare (ignore initargs))
3318	+the-standard-writer-method-class+)
3319
3320	;;; Applicable methods
3321
3322	(atomic-defgeneric compute-applicable-methods (gf args)
3323	(:method ((gf standard-generic-function) args)
3324	(std-compute-applicable-methods gf args)))
3325
3326	(defgeneric compute-applicable-methods-using-classes (gf classes)
3327	(:method ((gf standard-generic-function) classes)
3328	(let ((methods '()))
3329	(dolist (method (generic-function-methods gf))
3330	(multiple-value-bind (applicable knownp)
3331	(method-applicable-using-classes-p method classes)
3332	(cond (applicable
3333	(push method methods))
3334	((not knownp)
3335	(return-from compute-applicable-methods-using-classes
3336	(values nil nil))))))
3337	(values (sort-methods methods gf classes)
3338	t))))
3339
3340
3341	;;; Slot access
3342	;;;
3343	;;; See AMOP pg. 156ff. for an overview.
3344	;;;
3345	;;; AMOP specifies these generic functions to dispatch on slot objects
3346	;;; (with the exception of slot-exists-p-using-class), although its
3347	;;; sample implementation Closette dispatches on slot names. We let
3348	;;; slot-value and friends call their gf counterparts with the effective
3349	;;; slot definition, but leave the definitions dispatching on slot name
3350	;;; in place for user convenience.
3351
3352	;;; AMOP pg. 235
3353	(defgeneric slot-value-using-class (class instance slot))
3354
3355	(defmethod slot-value-using-class ((class standard-class) instance (slot symbol))
3356	(std-slot-value instance slot))
3357	(defmethod slot-value-using-class ((class standard-class) instance
3358	(slot standard-effective-slot-definition))
3359	(let* ((location (slot-definition-location slot))
3360	(value (if (consp location)
3361	(cdr location) ; :allocation :class
3362	(standard-instance-access instance location))))
3363	(if (eq value +slot-unbound+)
3364	;; fix SLOT-UNBOUND.5 from ansi test suite
3365	(nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3366	value)))
3367
3368	(defmethod slot-value-using-class ((class funcallable-standard-class)
3369	instance (slot symbol))
3370	(std-slot-value instance slot))
3371	(defmethod slot-value-using-class ((class funcallable-standard-class) instance
3372	(slot standard-effective-slot-definition))
3373	(let* ((location (slot-definition-location slot))
3374	(value (if (consp location)
3375	(cdr location) ; :allocation :class
3376	(funcallable-standard-instance-access instance location))))
3377	(if (eq value +slot-unbound+)
3378	;; fix SLOT-UNBOUND.5 from ansi test suite
3379	(nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3380	value)))
3381
3382	(defmethod slot-value-using-class ((class structure-class) instance
3383	(slot symbol))
3384	(std-slot-value instance slot))
3385	(defmethod slot-value-using-class ((class structure-class) instance
3386	(slot standard-effective-slot-definition))
3387	(std-slot-value instance (slot-definition-name slot)))
3388
3389	;;; AMOP pg. 231
3390	(defgeneric (setf slot-value-using-class) (new-value class instance slot))
3391
3392	(defmethod (setf slot-value-using-class) (new-value
3393	(class standard-class)
3394	instance
3395	(slot symbol))
3396	(setf (std-slot-value instance slot) new-value))
3397	(defmethod (setf slot-value-using-class) (new-value
3398	(class standard-class)
3399	instance
3400	(slot standard-effective-slot-definition))
3401	(let ((location (slot-definition-location slot)))
3402	(if (consp location) ; :allocation :class
3403	(setf (cdr location) new-value)
3404	(setf (standard-instance-access instance location) new-value))))
3405
3406	(defmethod (setf slot-value-using-class) (new-value
3407	(class funcallable-standard-class)
3408	instance
3409	(slot symbol))
3410	(setf (std-slot-value instance slot) new-value))
3411	(defmethod (setf slot-value-using-class) (new-value
3412	(class funcallable-standard-class)
3413	instance
3414	(slot standard-effective-slot-definition))
3415	(let ((location (slot-definition-location slot)))
3416	(if (consp location) ; :allocation :class
3417	(setf (cdr location) new-value)
3418	(setf (funcallable-standard-instance-access instance location)
3419	new-value))))
3420
3421	(defmethod (setf slot-value-using-class) (new-value
3422	(class structure-class)
3423	instance
3424	(slot symbol))
3425	(setf (std-slot-value instance slot) new-value))
3426	(defmethod (setf slot-value-using-class) (new-value
3427	(class structure-class)
3428	instance
3429	(slot standard-effective-slot-definition))
3430	(setf (std-slot-value instance (slot-definition-name slot)) new-value))
3431
3432	;;; slot-exists-p-using-class is not specified by AMOP, and obviously
3433	;;; cannot be specialized on the slot type. Hence, its implementation
3434	;;; differs from slot-(boundp\|makunbound\|value)-using-class
3435	(defgeneric slot-exists-p-using-class (class instance slot-name))
3436
3437	(defmethod slot-exists-p-using-class (class instance slot-name)
3438	nil)
3439
3440	(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
3441	(std-slot-exists-p instance slot-name))
3442	(defmethod slot-exists-p-using-class ((class funcallable-standard-class) instance slot-name)
3443	(std-slot-exists-p instance slot-name))
3444
3445	(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
3446	(dolist (dsd (class-slots class))
3447	(when (eq (sys::dsd-name dsd) slot-name)
3448	(return-from slot-exists-p-using-class t)))
3449	nil)
3450
3451
3452	(defgeneric slot-boundp-using-class (class instance slot))
3453	(defmethod slot-boundp-using-class ((class standard-class) instance (slot symbol))
3454	(std-slot-boundp instance slot))
3455	(defmethod slot-boundp-using-class ((class standard-class) instance
3456	(slot standard-effective-slot-definition))
3457	(let ((location (slot-definition-location slot)))
3458	(if (consp location)
3459	(not (eq (cdr location) +slot-unbound+)) ; :allocation :class
3460	(not (eq (standard-instance-access instance location) +slot-unbound+)))))
3461
3462	(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3463	(slot symbol))
3464	(std-slot-boundp instance slot))
3465	(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3466	(slot standard-effective-slot-definition))
3467	(let ((location (slot-definition-location slot)))
3468	(if (consp location)
3469	(not (eq (cdr location) +slot-unbound+)) ; :allocation :class
3470	(not (eq (funcallable-standard-instance-access instance location)
3471	+slot-unbound+)))))
3472
3473	(defmethod slot-boundp-using-class ((class structure-class) instance slot)
3474	"Structure slots can't be unbound, so this method always returns T."
3475	(declare (ignore class instance slot))
3476	t)
3477
3478	(defgeneric slot-makunbound-using-class (class instance slot))
3479	(defmethod slot-makunbound-using-class ((class standard-class)
3480	instance
3481	(slot symbol))
3482	(std-slot-makunbound instance slot))
3483	(defmethod slot-makunbound-using-class ((class standard-class)
3484	instance
3485	(slot standard-effective-slot-definition))
3486	(let ((location (slot-definition-location slot)))
3487	(if (consp location)
3488	(setf (cdr location) +slot-unbound+)
3489	(setf (standard-instance-access instance location) +slot-unbound+))))
3490
3491	(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3492	instance
3493	(slot symbol))
3494	(std-slot-makunbound instance slot))
3495	(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3496	instance
3497	(slot symbol))
3498	(let ((location (slot-definition-location slot)))
3499	(if (consp location)
3500	(setf (cdr location) +slot-unbound+)
3501	(setf (funcallable-standard-instance-access instance location)
3502	+slot-unbound+))))
3503
3504	(defmethod slot-makunbound-using-class ((class structure-class)
3505	instance
3506	slot)
3507	(declare (ignore class instance slot))
3508	(error "Structure slots can't be unbound"))
3509
3510	(defgeneric slot-missing (class instance slot-name operation &optional new-value))
3511
3512	(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
3513	(declare (ignore new-value))
3514	(error "The slot ~S is missing from the class ~S." slot-name class))
3515
3516	(defgeneric slot-unbound (class instance slot-name))
3517
3518	(defmethod slot-unbound ((class t) instance slot-name)
3519	(error 'unbound-slot :instance instance :name slot-name))
3520
3521	;;; Instance creation and initialization
3522
3523	;;; AMOP pg. 168ff.
3524	(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
3525
3526	(defmethod allocate-instance ((class standard-class) &rest initargs)
3527	(declare (ignore initargs))
3528	(std-allocate-instance class))
3529
3530	(defmethod allocate-instance ((class funcallable-standard-class) &rest initargs)
3531	(declare (ignore initargs))
3532	(allocate-funcallable-instance class))
3533
3534	(defmethod allocate-instance ((class structure-class) &rest initargs)
3535	(declare (ignore initargs))
3536	(%make-structure (class-name class)
3537	(make-list (length (class-slots class))
3538	:initial-element +slot-unbound+)))
3539
3540	(defmethod allocate-instance ((class built-in-class) &rest initargs)
3541	(declare (ignore initargs))
3542	(error "Cannot allocate instances of a built-in class: ~S" class))
3543
3544	(defmethod allocate-instance :before ((class class) &rest initargs)
3545	(declare (ignore initargs))
3546	(unless (class-finalized-p class)
3547	(finalize-inheritance class)))
3548
3549	;; "The set of valid initialization arguments for a class is the set of valid
3550	;; initialization arguments that either fill slots or supply arguments to
3551	;; methods, along with the predefined initialization argument :ALLOW-OTHER-KEYS."
3552	;; 7.1.2
3553
3554	(defun calculate-allowable-initargs (gf-list args instance
3555	shared-initialize-param
3556	initargs)
3557	(let* ((methods
3558	(nconc
3559	(std-compute-applicable-methods #'shared-initialize
3560	(list* instance
3561	shared-initialize-param
3562	initargs))
3563	(mapcan #'(lambda (gf)
3564	(if (std-generic-function-p gf)
3565	(std-compute-applicable-methods gf args)
3566	(compute-applicable-methods gf args)))
3567	gf-list)))
3568	(method-keyword-args
3569	(reduce #'merge-initargs-sets
3570	(mapcar #'method-lambda-list methods)
3571	:key #'extract-lambda-list-keywords
3572	:initial-value nil))
3573	(slots-initargs
3574	(mapappend #'slot-definition-initargs
3575	(class-slots (class-of instance)))))
3576	(merge-initargs-sets
3577	(merge-initargs-sets slots-initargs method-keyword-args)
3578	'(:allow-other-keys)))) ;; allow-other-keys is always allowed
3579
3580	(defun check-initargs (gf-list args instance
3581	shared-initialize-param initargs
3582	cache call-site)
3583	"Checks the validity of `initargs' for the generic functions in `gf-list'
3584	when called with `args' by calculating the applicable methods for each gf.
3585	The applicable methods for SHARED-INITIALIZE based on `instance',
3586	`shared-initialize-param' and `initargs' are added to the list of
3587	applicable methods."
3588	(when (oddp (length initargs))
3589	(error 'program-error
3590	:format-control "Odd number of keyword arguments."))
3591	(unless (getf initargs :allow-other-keys)
3592	(multiple-value-bind (allowable-initargs present-p)
3593	(when cache
3594	(gethash (class-of instance) cache))
3595	(unless present-p
3596	(setf allowable-initargs
3597	(calculate-allowable-initargs gf-list args instance
3598	shared-initialize-param initargs))
3599	(when cache
3600	(setf (gethash (class-of instance) cache)
3601	allowable-initargs)))
3602	(unless (eq t allowable-initargs)
3603	(do* ((tail initargs (cddr tail))
3604	(initarg (car tail) (car tail)))
3605	((null tail))
3606	(unless (memq initarg allowable-initargs)
3607	(error 'program-error
3608	:format-control "Invalid initarg ~S in call to ~S with arglist ~S."
3609	:format-arguments (list initarg call-site args))))))))
3610
3611	(defun merge-initargs-sets (list1 list2)
3612	(cond
3613	((eq list1 t) t)
3614	((eq list2 t) t)
3615	(t (union list1 list2))))
3616
3617	(defun extract-lambda-list-keywords (lambda-list)
3618	"Returns a list of keywords acceptable as keyword arguments,
3619	or T when any keyword is acceptable due to presence of
3620	&allow-other-keys."
3621	(when (member '&allow-other-keys lambda-list)
3622	(return-from extract-lambda-list-keywords t))
3623	(loop with keyword-args = (cdr (memq '&key lambda-list))
3624	for key in keyword-args
3625	when (eq key '&aux) do (loop-finish)
3626	when (eq key '&allow-other-keys) do (return t)
3627	when (listp key) do (setq key (car key))
3628	collect (if (symbolp key)
3629	(make-keyword key)
3630	(car key))))
3631
3632
3633	(defgeneric make-instance (class &rest initargs &key &allow-other-keys))
3634
3635	(defmethod make-instance :before ((class class) &rest initargs)
3636	(when (oddp (length initargs))
3637	(error 'program-error :format-control "Odd number of keyword arguments."))
3638	(unless (class-finalized-p class)
3639	(finalize-inheritance class)))
3640
3641	(defun augment-initargs-with-defaults (class initargs)
3642	(let ((default-initargs '()))
3643	(dolist (initarg (class-default-initargs class))
3644	(let ((key (first initarg))
3645	(fn (third initarg)))
3646	(when (eq (getf initargs key +slot-unbound+) +slot-unbound+)
3647	(push key default-initargs)
3648	(push (funcall fn) default-initargs))))
3649	(append initargs (nreverse default-initargs))))
3650
3651	(defmethod make-instance ((class standard-class) &rest initargs)
3652	(setf initargs (augment-initargs-with-defaults class initargs))
3653	(let ((instance (std-allocate-instance class)))
3654	(check-initargs (list #'allocate-instance #'initialize-instance)
3655	(list* instance initargs)
3656	instance t initargs
3657	make-instance-initargs-cache 'make-instance)
3658	(apply #'initialize-instance instance initargs)
3659	instance))
3660
3661	(defmethod make-instance ((class funcallable-standard-class) &rest initargs)
3662	(setf initargs (augment-initargs-with-defaults class initargs))
3663	(let ((instance (allocate-funcallable-instance class)))
3664	(check-initargs (list #'allocate-instance #'initialize-instance)
3665	(list* instance initargs)
3666	instance t initargs
3667	make-instance-initargs-cache 'make-instance)
3668	(apply #'initialize-instance instance initargs)
3669	instance))
3670
3671	(defmethod make-instance ((class symbol) &rest initargs)
3672	(apply #'make-instance (find-class class) initargs))
3673
3674	(defgeneric initialize-instance (instance &rest initargs
3675	&key &allow-other-keys))
3676
3677	(defmethod initialize-instance ((instance standard-object) &rest initargs)
3678	(apply #'shared-initialize instance t initargs))
3679
3680	(defgeneric reinitialize-instance (instance &rest initargs
3681	&key &allow-other-keys))
3682
3683	;; "The system-supplied primary method for REINITIALIZE-INSTANCE checks the
3684	;; validity of initargs and signals an error if an initarg is supplied that is
3685	;; not declared as valid. The method then calls the generic function SHARED-
3686	;; INITIALIZE with the following arguments: the instance, nil (which means no
3687	;; slots should be initialized according to their initforms), and the initargs
3688	;; it received."
3689	(defmethod reinitialize-instance ((instance standard-object) &rest initargs)
3690	(check-initargs (list #'reinitialize-instance) (list* instance initargs)
3691	instance () initargs
3692	reinitialize-instance-initargs-cache 'reinitialize-instance)
3693	(apply #'shared-initialize instance () initargs))
3694
3695	(defun std-shared-initialize (instance slot-names all-keys)
3696	(when (oddp (length all-keys))
3697	(error 'program-error :format-control "Odd number of keyword arguments."))
3698	;; do a quick scan of the arguments list to see if it's a real
3699	;; 'initialization argument list' (which is not the same as
3700	;; checking initarg validity
3701	(do* ((tail all-keys (cddr tail))
3702	(initarg (car tail) (car tail)))
3703	((null tail))
3704	(unless (symbolp initarg)
3705	(error 'program-error
3706	:format-control "Initarg ~S not a symbol."
3707	:format-arguments (list initarg))))
3708	(dolist (slot (class-slots (class-of instance)))
3709	(let ((slot-name (slot-definition-name slot)))
3710	(multiple-value-bind (init-key init-value foundp)
3711	(get-properties all-keys (slot-definition-initargs slot))
3712	(if foundp
3713	(setf (slot-value instance slot-name) init-value)
3714	(unless (slot-boundp instance slot-name)
3715	(let ((initfunction (slot-definition-initfunction slot)))
3716	(when (and initfunction (or (eq slot-names t)
3717	(memq slot-name slot-names)))
3718	(setf (slot-value instance slot-name)
3719	(funcall initfunction)))))))))
3720	instance)
3721
3722	(defgeneric shared-initialize (instance slot-names
3723	&rest initargs
3724	&key &allow-other-keys))
3725
3726	(defmethod shared-initialize ((instance standard-object) slot-names
3727	&rest initargs)
3728	(std-shared-initialize instance slot-names initargs))
3729
3730	(defmethod shared-initialize ((slot slot-definition) slot-names
3731	&rest args
3732	&key name initargs initform initfunction
3733	readers writers allocation
3734	&allow-other-keys)
3735	;;Keyword args are duplicated from init-slot-definition only to have
3736	;;them checked.
3737	(declare (ignore slot-names)) ;;TODO?
3738	(declare (ignore name initargs initform initfunction readers writers allocation))
3739	;;For built-in slots
3740	(apply #'init-slot-definition slot :allow-other-keys t args)
3741	;;For user-defined slots
3742	(call-next-method))
3743
3744	;;; change-class
3745
3746	(defgeneric change-class (instance new-class &key &allow-other-keys))
3747
3748	(defmethod change-class ((old-instance standard-object) (new-class standard-class)
3749	&rest initargs)
3750	(let ((old-slots (class-slots (class-of old-instance)))
3751	(new-slots (class-slots new-class))
3752	(new-instance (allocate-instance new-class)))
3753	;; "The values of local slots specified by both the class CTO and the class
3754	;; CFROM are retained. If such a local slot was unbound, it remains
3755	;; unbound."
3756	(dolist (new-slot new-slots)
3757	(when (instance-slot-p new-slot)
3758	(let* ((slot-name (slot-definition-name new-slot))
3759	(old-slot (find slot-name old-slots :key 'slot-definition-name)))
3760	;; "The values of slots specified as shared in the class CFROM and as
3761	;; local in the class CTO are retained."
3762	(when (and old-slot (slot-boundp old-instance slot-name))
3763	(setf (slot-value new-instance slot-name)
3764	(slot-value old-instance slot-name))))))
3765	(swap-slots old-instance new-instance)
3766	(rotatef (std-instance-layout new-instance)
3767	(std-instance-layout old-instance))
3768	(apply #'update-instance-for-different-class
3769	new-instance old-instance initargs)
3770	old-instance))
3771
3772	(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
3773	(apply #'change-class instance (find-class new-class) initargs))
3774
3775	(defgeneric update-instance-for-different-class (old new
3776	&rest initargs
3777	&key &allow-other-keys))
3778
3779	(defmethod update-instance-for-different-class
3780	((old standard-object) (new standard-object) &rest initargs)
3781	(let ((added-slots
3782	(remove-if #'(lambda (slot-name)
3783	(slot-exists-p old slot-name))
3784	(mapcar 'slot-definition-name
3785	(class-slots (class-of new))))))
3786	(check-initargs (list #'update-instance-for-different-class)
3787	(list old new initargs)
3788	new added-slots initargs
3789	nil 'update-instance-for-different-class)
3790	(apply #'shared-initialize new added-slots initargs)))
3791
3792	;;; make-instances-obsolete
3793
3794	(defgeneric make-instances-obsolete (class))
3795
3796	(defmethod make-instances-obsolete ((class standard-class))
3797	(%make-instances-obsolete class))
3798	(defmethod make-instances-obsolete ((class funcallable-standard-class))
3799	(%make-instances-obsolete class))
3800	(defmethod make-instances-obsolete ((class symbol))
3801	(make-instances-obsolete (find-class class))
3802	class)
3803
3804	;;; update-instance-for-redefined-class
3805
3806	(defgeneric update-instance-for-redefined-class (instance
3807	added-slots
3808	discarded-slots
3809	property-list
3810	&rest initargs
3811	&key
3812	&allow-other-keys))
3813
3814	(defmethod update-instance-for-redefined-class ((instance standard-object)
3815	added-slots
3816	discarded-slots
3817	property-list
3818	&rest initargs)
3819	(check-initargs (list #'update-instance-for-redefined-class)
3820	(list* instance added-slots discarded-slots
3821	property-list initargs)
3822	instance added-slots initargs
3823	nil 'update-instance-for-redefined-class)
3824	(apply #'shared-initialize instance added-slots initargs))
3825
3826	;;; Methods having to do with class metaobjects.
3827
3828	(defmethod initialize-instance :after ((class standard-class) &rest args)
3829	(apply #'std-after-initialization-for-classes class args))
3830
3831	(defmethod initialize-instance :after ((class funcallable-standard-class)
3832	&rest args)
3833	(apply #'std-after-initialization-for-classes class args))
3834
3835	(defmethod reinitialize-instance :before ((class standard-class)
3836	&rest all-keys
3837	&key direct-superclasses)
3838	(check-initargs (list #'allocate-instance
3839	#'initialize-instance)
3840	(list* class all-keys)
3841	class t all-keys
3842	nil 'reinitialize-instance)
3843	(dolist (superclass (set-difference (class-direct-superclasses class)
3844	direct-superclasses))
3845	(remove-direct-subclass superclass class))
3846	(dolist (superclass (set-difference direct-superclasses
3847	(class-direct-superclasses class)))
3848	(add-direct-subclass superclass class)))
3849
3850	(defmethod reinitialize-instance :before ((class funcallable-standard-class)
3851	&rest all-keys
3852	&key direct-superclasses)
3853	(check-initargs (list #'allocate-instance
3854	#'initialize-instance)
3855	(list* class all-keys)
3856	class t all-keys
3857	nil 'reinitialize-instance)
3858	(dolist (superclass (set-difference (class-direct-superclasses class)
3859	direct-superclasses))
3860	(remove-direct-subclass superclass class))
3861	(dolist (superclass (set-difference direct-superclasses
3862	(class-direct-superclasses class)))
3863	(add-direct-subclass superclass class)))
3864
3865	(defun std-after-reinitialization-for-classes (class
3866	&rest all-keys
3867	&key (direct-superclasses nil direct-superclasses-p)
3868	(direct-slots nil direct-slots-p)
3869	(direct-default-initargs nil direct-default-initargs-p)
3870	&allow-other-keys)
3871	(remhash class make-instance-initargs-cache)
3872	(remhash class reinitialize-instance-initargs-cache)
3873	(%make-instances-obsolete class)
3874	(setf (class-finalized-p class) nil)
3875	(when direct-superclasses-p
3876	(let* ((old-supers (class-direct-superclasses class))
3877	(new-supers (canonicalize-direct-superclass-list
3878	class direct-superclasses)))
3879	(setf (class-direct-superclasses class) new-supers)
3880	(dolist (old-superclass (set-difference old-supers new-supers))
3881	(remove-direct-subclass old-superclass class))
3882	(dolist (new-superclass (set-difference new-supers old-supers))
3883	(add-direct-subclass new-superclass class))))
3884	(when direct-slots-p
3885	;; FIXME: maybe remove old reader and writer methods?
3886	(let ((slots (mapcar #'(lambda (slot-properties)
3887	(apply #'make-direct-slot-definition class slot-properties))
3888	direct-slots)))
3889	(setf (class-direct-slots class) slots)
3890	(dolist (direct-slot slots)
3891	(dolist (reader (slot-definition-readers direct-slot))
3892	(add-reader-method class reader direct-slot))
3893	(dolist (writer (slot-definition-writers direct-slot))
3894	(add-writer-method class writer direct-slot)))))
3895	(when direct-default-initargs-p
3896	(setf (class-direct-default-initargs class) direct-default-initargs))
3897	(maybe-finalize-class-subtree class)
3898	(map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3899
3900	(defmethod reinitialize-instance :after ((class standard-class)
3901	&rest all-keys)
3902	(apply #'std-after-reinitialization-for-classes class all-keys))
3903
3904	(defmethod reinitialize-instance :after ((class funcallable-standard-class)
3905	&rest all-keys)
3906	(apply #'std-after-reinitialization-for-classes class all-keys))
3907
3908	(defmethod reinitialize-instance :before ((gf standard-generic-function)
3909	&key
3910	(lambda-list nil lambda-list-supplied-p)
3911	&allow-other-keys)
3912	(when lambda-list-supplied-p
3913	(unless (or (null (generic-function-methods gf))
3914	(lambda-lists-congruent-p lambda-list
3915	(generic-function-lambda-list gf)))
3916	(error "The lambda list ~S is incompatible with the existing methods of ~S."
3917	lambda-list gf))))
3918
3919	(defmethod reinitialize-instance :after ((gf standard-generic-function)
3920	&rest all-keys)
3921	(map-dependents gf #'(lambda (dep) (update-dependent gf dep all-keys))))
3922
3923	;;; Finalize inheritance
3924
3925	(atomic-defgeneric finalize-inheritance (class)
3926	(:method ((class standard-class))
3927	(std-finalize-inheritance class))
3928	(:method ((class funcallable-standard-class))
3929	(std-finalize-inheritance class)))
3930
3931	;;; Default initargs
3932
3933	;;; AMOP pg. 174
3934	(atomic-defgeneric compute-default-initargs (class)
3935	(:method ((class standard-class))
3936	(std-compute-default-initargs class))
3937	(:method ((class funcallable-standard-class))
3938	(std-compute-default-initargs class)))
3939
3940	;;; Class precedence lists
3941
3942	(defgeneric compute-class-precedence-list (class))
3943	(defmethod compute-class-precedence-list ((class standard-class))
3944	(std-compute-class-precedence-list class))
3945	(defmethod compute-class-precedence-list ((class funcallable-standard-class))
3946	(std-compute-class-precedence-list class))
3947
3948	;;; Slot inheritance
3949
3950	(defgeneric compute-slots (class))
3951	(defmethod compute-slots ((class standard-class))
3952	(std-compute-slots class))
3953	(defmethod compute-slots ((class funcallable-standard-class))
3954	(std-compute-slots class))
3955
3956	(defgeneric compute-effective-slot-definition (class name direct-slots))
3957	(defmethod compute-effective-slot-definition
3958	((class standard-class) name direct-slots)
3959	(std-compute-effective-slot-definition class name direct-slots))
3960	(defmethod compute-effective-slot-definition
3961	((class funcallable-standard-class) name direct-slots)
3962	(std-compute-effective-slot-definition class name direct-slots))
3963
3964	;;; Methods having to do with generic function invocation.
3965
3966	(defgeneric compute-discriminating-function (gf))
3967	(defmethod compute-discriminating-function ((gf standard-generic-function))
3968	(std-compute-discriminating-function gf))
3969
3970	(defgeneric method-more-specific-p (gf method1 method2 required-classes))
3971
3972	(defmethod method-more-specific-p ((gf standard-generic-function)
3973	method1 method2 required-classes)
3974	(let ((method-indices
3975	(argument-precedence-order-indices
3976	(generic-function-argument-precedence-order gf)
3977	(getf (analyze-lambda-list (generic-function-lambda-list gf))
3978	':required-args))))
3979	(std-method-more-specific-p method1 method2 required-classes method-indices)))
3980
3981	;;; AMOP pg. 176
3982	(defgeneric compute-effective-method (gf method-combination methods))
3983	(defmethod compute-effective-method ((gf standard-generic-function) method-combination methods)
3984	(std-compute-effective-method gf method-combination methods))
3985
3986	(defgeneric compute-applicable-methods (gf args))
3987	(defmethod compute-applicable-methods ((gf standard-generic-function) args)
3988	(std-compute-applicable-methods gf args))
3989
3990	;;; AMOP pg. 207
3991	(atomic-defgeneric make-method-lambda (generic-function method lambda-expression environment)
3992	(:method ((generic-function standard-generic-function)
3993	(method standard-method)
3994	lambda-expression environment)
3995	(declare (ignore environment))
3996	(values (compute-method-function lambda-expression) nil)))
3997
3998
3999	;;; Slot definition accessors
4000
4001	(defmacro slot-definition-dispatch (slot-definition std-form generic-form)
4002	`(let (($cl (class-of ,slot-definition)))
4003	(case $cl
4004	((+the-standard-slot-definition-class+
4005	+the-standard-direct-slot-definition-class+
4006	+the-standard-effective-slot-definition-class+)
4007	,std-form)
4008	(t ,generic-form))))
4009
4010	(atomic-defgeneric slot-definition-allocation (slot-definition)
4011	(:method ((slot-definition slot-definition))
4012	(slot-definition-dispatch slot-definition
4013	(std-slot-value slot-definition 'sys::allocation)
4014	(slot-value slot-definition 'sys::allocation))))
4015
4016	(atomic-defgeneric (setf slot-definition-allocation) (value slot-definition)
4017	(:method (value (slot-definition slot-definition))
4018	(slot-definition-dispatch slot-definition
4019	(setf (std-slot-value slot-definition 'sys::allocation) value)
4020	(setf (slot-value slot-definition 'sys::allocation) value))))
4021
4022	(atomic-defgeneric slot-definition-initargs (slot-definition)
4023	(:method ((slot-definition slot-definition))
4024	(slot-definition-dispatch slot-definition
4025	(std-slot-value slot-definition 'sys::initargs)
4026	(slot-value slot-definition 'sys::initargs))))
4027
4028	(atomic-defgeneric (setf slot-definition-initargs) (value slot-definition)
4029	(:method (value (slot-definition slot-definition))
4030	(slot-definition-dispatch slot-definition
4031	(setf (std-slot-value slot-definition 'sys::initargs) value)
4032	(setf (slot-value slot-definition 'sys::initargs) value))))
4033
4034	(atomic-defgeneric slot-definition-initform (slot-definition)
4035	(:method ((slot-definition slot-definition))
4036	(slot-definition-dispatch slot-definition
4037	(std-slot-value slot-definition 'sys::initform)
4038	(slot-value slot-definition 'sys::initform))))
4039
4040	(atomic-defgeneric (setf slot-definition-initform) (value slot-definition)
4041	(:method (value (slot-definition slot-definition))
4042	(slot-definition-dispatch slot-definition
4043	(setf (std-slot-value slot-definition 'sys::initform) value)
4044	(setf (slot-value slot-definition 'sys::initform) value))))
4045
4046	(atomic-defgeneric slot-definition-initfunction (slot-definition)
4047	(:method ((slot-definition slot-definition))
4048	(slot-definition-dispatch slot-definition
4049	(std-slot-value slot-definition 'sys::initfunction)
4050	(slot-value slot-definition 'sys::initfunction))))
4051
4052	(atomic-defgeneric (setf slot-definition-initfunction) (value slot-definition)
4053	(:method (value (slot-definition slot-definition))
4054	(slot-definition-dispatch slot-definition
4055	(setf (std-slot-value slot-definition 'sys::initfunction) value)
4056	(setf (slot-value slot-definition 'sys::initfunction) value))))
4057
4058	(atomic-defgeneric slot-definition-name (slot-definition)
4059	(:method ((slot-definition slot-definition))
4060	(slot-definition-dispatch slot-definition
4061	(std-slot-value slot-definition 'sys:name)
4062	(slot-value slot-definition 'sys:name))))
4063
4064	(atomic-defgeneric (setf slot-definition-name) (value slot-definition)
4065	(:method (value (slot-definition slot-definition))
4066	(slot-definition-dispatch slot-definition
4067	(setf (std-slot-value slot-definition 'sys:name) value)
4068	(setf (slot-value slot-definition 'sys:name) value))))
4069
4070	(atomic-defgeneric slot-definition-readers (slot-definition)
4071	(:method ((slot-definition slot-definition))
4072	(slot-definition-dispatch slot-definition
4073	(std-slot-value slot-definition 'sys::readers)
4074	(slot-value slot-definition 'sys::readers))))
4075
4076	(atomic-defgeneric (setf slot-definition-readers) (value slot-definition)
4077	(:method (value (slot-definition slot-definition))
4078	(slot-definition-dispatch slot-definition
4079	(setf (std-slot-value slot-definition 'sys::readers) value)
4080	(setf (slot-value slot-definition 'sys::readers) value))))
4081
4082	(atomic-defgeneric slot-definition-writers (slot-definition)
4083	(:method ((slot-definition slot-definition))
4084	(slot-definition-dispatch slot-definition
4085	(std-slot-value slot-definition 'sys::writers)
4086	(slot-value slot-definition 'sys::writers))))
4087
4088	(atomic-defgeneric (setf slot-definition-writers) (value slot-definition)
4089	(:method (value (slot-definition slot-definition))
4090	(slot-definition-dispatch slot-definition
4091	(setf (std-slot-value slot-definition 'sys::writers) value)
4092	(setf (slot-value slot-definition 'sys::writers) value))))
4093
4094	(atomic-defgeneric slot-definition-allocation-class (slot-definition)
4095	(:method ((slot-definition slot-definition))
4096	(slot-definition-dispatch slot-definition
4097	(std-slot-value slot-definition 'sys::allocation-class)
4098	(slot-value slot-definition 'sys::allocation-class))))
4099
4100	(atomic-defgeneric (setf slot-definition-allocation-class)
4101	(value slot-definition)
4102	(:method (value (slot-definition slot-definition))
4103	(slot-definition-dispatch slot-definition
4104	(setf (std-slot-value slot-definition 'sys::allocation-class) value)
4105	(setf (slot-value slot-definition 'sys::allocation-class) value))))
4106
4107	(atomic-defgeneric slot-definition-location (slot-definition)
4108	(:method ((slot-definition slot-definition))
4109	(slot-definition-dispatch slot-definition
4110	(std-slot-value slot-definition 'sys::location)
4111	(slot-value slot-definition 'sys::location))))
4112
4113	(atomic-defgeneric (setf slot-definition-location) (value slot-definition)
4114	(:method (value (slot-definition slot-definition))
4115	(slot-definition-dispatch slot-definition
4116	(setf (std-slot-value slot-definition 'sys::location) value)
4117	(setf (slot-value slot-definition 'sys::location) value))))
4118
4119	(atomic-defgeneric slot-definition-type (slot-definition)
4120	(:method ((slot-definition slot-definition))
4121	(slot-definition-dispatch slot-definition
4122	(std-slot-value slot-definition 'sys::%type)
4123	(slot-value slot-definition 'sys::%type))))
4124
4125	(atomic-defgeneric (setf slot-definition-type) (value slot-definition)
4126	(:method (value (slot-definition slot-definition))
4127	(slot-definition-dispatch slot-definition
4128	(setf (std-slot-value slot-definition 'sys::%type) value)
4129	(setf (slot-value slot-definition 'sys::%type) value))))
4130
4131	(atomic-defgeneric slot-definition-documentation (slot-definition)
4132	(:method ((slot-definition slot-definition))
4133	(slot-definition-dispatch slot-definition
4134	(std-slot-value slot-definition 'sys:%documentation)
4135	(slot-value slot-definition 'sys:%documentation))))
4136
4137	(atomic-defgeneric (setf slot-definition-documentation) (value slot-definition)
4138	(:method (value (slot-definition slot-definition))
4139	(slot-definition-dispatch slot-definition
4140	(setf (std-slot-value slot-definition 'sys:%documentation) value)
4141	(setf (slot-value slot-definition 'sys:%documentation) value))))
4142
4143
4144	;;; Conditions.
4145
4146	(defmacro define-condition (name (&rest parent-types) (&rest slot-specs) &body options)
4147	(let ((parent-types (or parent-types '(condition)))
4148	(report nil))
4149	(dolist (option options)
4150	(when (eq (car option) :report)
4151	(setf report (cadr option))
4152	(setf options (delete option options :test #'equal))
4153	(return)))
4154	(typecase report
4155	(null
4156	`(progn
4157	(sys::record-source-information-for-type ',name :condition)
4158	(defclass ,name ,parent-types ,slot-specs ,@options)
4159	',name))
4160	(string
4161	`(progn
4162	(sys::record-source-information-for-type ',name :condition)
4163	(defclass ,name ,parent-types ,slot-specs ,@options)
4164	(defmethod print-object ((condition ,name) stream)
4165	(if print-escape
4166	(call-next-method)
4167	(progn (write-string ,report stream) condition)))
4168	',name))
4169	(t
4170	`(progn
4171	(sys::record-source-information-for-type ',name :condition)
4172	(defclass ,name ,parent-types ,slot-specs ,@options)
4173	(defmethod print-object ((condition ,name) stream)
4174	(if print-escape
4175	(call-next-method)
4176	(funcall #',report condition stream)))
4177	',name)))))
4178
4179	(defun make-condition (type &rest initargs)
4180	(or (%make-condition type initargs)
4181	(let ((class (if (symbolp type) (find-class type) type)))
4182	(apply #'make-instance class initargs))))
4183
4184	;; Adapted from SBCL.
4185	;; Originally defined in signal.lisp. Redefined here now that we have MAKE-CONDITION.
4186	(defun coerce-to-condition (datum arguments default-type fun-name)
4187	(cond ((typep datum 'condition)
4188	(when arguments
4189	(error 'simple-type-error
4190	:datum arguments
4191	:expected-type 'null
4192	:format-control "You may not supply additional arguments when giving ~S to ~S."
4193	:format-arguments (list datum fun-name)))
4194	datum)
4195	((symbolp datum)
4196	(apply #'make-condition datum arguments))
4197	((or (stringp datum) (functionp datum))
4198	(make-condition default-type
4199	:format-control datum
4200	:format-arguments arguments))
4201	(t
4202	(error 'simple-type-error
4203	:datum datum
4204	:expected-type '(or symbol string)
4205	:format-control "Bad argument to ~S: ~S."
4206	:format-arguments (list fun-name datum)))))
4207
4208	(defgeneric make-load-form (object &optional environment))
4209
4210	(defmethod make-load-form ((object t) &optional environment)
4211	(declare (ignore environment))
4212	(apply #'no-applicable-method #'make-load-form (list object)))
4213
4214	(defmethod make-load-form ((class class) &optional environment)
4215	(declare (ignore environment))
4216	(let ((name (class-name class)))
4217	(unless (and name (eq (find-class name nil) class))
4218	(error 'simple-type-error
4219	:format-control "Can't use anonymous or undefined class as a constant: ~S."
4220	:format-arguments (list class)))
4221	`(find-class ',name)))
4222
4223	(defun invalid-method-error (method format-control &rest args)
4224	(let ((message (apply #'format nil format-control args)))
4225	(error "Invalid method error for ~S:~% ~A" method message)))
4226
4227	(defun method-combination-error (format-control &rest args)
4228	(let ((message (apply #'format nil format-control args)))
4229	(error "Method combination error in CLOS dispatch:~% ~A" message)))
4230
4231
4232	(atomic-defgeneric no-applicable-method (generic-function &rest args)
4233	(:method (generic-function &rest args)
4234	(error "There is no applicable method for the generic function ~S ~
4235	when called with arguments ~S."
4236	generic-function
4237	args)))
4238
4239
4240	;;; FIXME (rudi 2012-01-28): this can be a function, it only needs to
4241	;;; use standard accessor functions
4242	(defgeneric find-method (generic-function
4243	qualifiers
4244	specializers
4245	&optional errorp))
4246
4247	(defmethod find-method ((generic-function standard-generic-function)
4248	qualifiers specializers &optional (errorp t))
4249	(%find-method generic-function qualifiers specializers errorp))
4250
4251	(defgeneric find-method ((generic-function symbol)
4252	qualifiers specializers &optional (errorp t))
4253	(find-method (find-generic-function generic-function errorp)
4254	qualifiers specializers errorp))
4255
4256	;;; AMOP pg. 167
4257	(defgeneric add-method (generic-function method))
4258
4259	(defmethod add-method :before ((generic-function generic-function)
4260	(method method))
4261	(when (and (method-generic-function method)
4262	(not (eql generic-function (method-generic-function method))))
4263	(error 'simple-error
4264	:format-control "~S is already a method of ~S, cannot add to ~S."
4265	:format-arguments (list method (method-generic-function method)
4266	generic-function)))
4267	(check-method-lambda-list (generic-function-name generic-function)
4268	(method-lambda-list method)
4269	(generic-function-lambda-list generic-function)))
4270
4271	(defmethod add-method ((generic-function standard-generic-function)
4272	(method standard-method))
4273	(std-add-method generic-function method))
4274
4275	(defmethod add-method :after ((generic-function generic-function)
4276	(method method))
4277	(map-dependents generic-function
4278	#'(lambda (dep) (update-dependent generic-function dep
4279	'add-method method))))
4280
4281	(defgeneric remove-method (generic-function method))
4282
4283	(defmethod remove-method ((generic-function standard-generic-function)
4284	(method standard-method))
4285	(std-remove-method generic-function method))
4286
4287	(defmethod remove-method :after ((generic-function generic-function)
4288	(method method))
4289	(map-dependents generic-function
4290	#'(lambda (dep) (update-dependent generic-function dep
4291	'remove-method method))))
4292
4293	;; See describe.lisp.
4294	(defgeneric describe-object (object stream))
4295
4296	;; FIXME
4297	(defgeneric no-next-method (generic-function method &rest args))
4298
4299	(atomic-defgeneric function-keywords (method)
4300	(:method ((method standard-method))
4301	(std-function-keywords method)))
4302
4303	(setf gf-initialize-instance (symbol-function 'initialize-instance))
4304	(setf gf-allocate-instance (symbol-function 'allocate-instance))
4305	(setf gf-shared-initialize (symbol-function 'shared-initialize))
4306	(setf gf-reinitialize-instance (symbol-function 'reinitialize-instance))
4307	(setf clos-booting nil)
4308
4309	(atomic-defgeneric class-prototype (class)
4310	(:method ((class standard-class))
4311	(allocate-instance class))
4312	(:method ((class funcallable-standard-class))
4313	(allocate-instance class))
4314	(:method ((class structure-class))
4315	(allocate-instance class))
4316	(:method :before (class)
4317	(unless (class-finalized-p class)
4318	(error "~@<~S is not finalized.~:@>" class))))
4319
4320
4321
4322
4323
4324	(defmethod shared-initialize :before ((instance generic-function)
4325	slot-names
4326	&key lambda-list argument-precedence-order
4327	&allow-other-keys)
4328	(check-argument-precedence-order lambda-list argument-precedence-order))
4329
4330	(defmethod shared-initialize :after ((instance standard-generic-function)
4331	slot-names
4332	&key (lambda-list nil lambda-list-p)
4333	(argument-precedence-order nil a-p-o-p)
4334	(method-combination '(standard))
4335	&allow-other-keys)
4336	(when lambda-list-p
4337	(let* ((plist (analyze-lambda-list lambda-list))
4338	(required-args (getf plist ':required-args)))
4339	(setf (std-slot-value instance 'sys::required-args) required-args)
4340	(setf (std-slot-value instance 'sys::optional-args)
4341	(getf plist :optional-args))
4342	(setf (std-slot-value instance 'sys::argument-precedence-order)
4343	(or (and a-p-o-p argument-precedence-order) required-args))))
4344	(unless (typep (generic-function-method-combination instance)
4345	'method-combination)
4346	;; this fixes (make-instance 'standard-generic-function) -- the
4347	;; constructor of StandardGenericFunction sets this slot to '(standard)
4348	(setf (std-slot-value instance 'sys::%method-combination)
4349	(find-method-combination
4350	instance (car method-combination) (cdr method-combination))))
4351	(finalize-standard-generic-function instance))
4352
4353	;;; Readers for generic function metaobjects
4354	;;; AMOP pg. 216ff.
4355	(atomic-defgeneric generic-function-argument-precedence-order (generic-function)
4356	(:method ((generic-function standard-generic-function))
4357	(std-slot-value generic-function 'sys::argument-precedence-order)))
4358
4359	(atomic-defgeneric generic-function-declarations (generic-function)
4360	(:method ((generic-function standard-generic-function))
4361	(std-slot-value generic-function 'sys::declarations)))
4362
4363	(atomic-defgeneric generic-function-lambda-list (generic-function)
4364	(:method ((generic-function standard-generic-function))
4365	(std-slot-value generic-function 'sys::lambda-list)))
4366
4367	(atomic-defgeneric generic-function-method-class (generic-function)
4368	(:method ((generic-function standard-generic-function))
4369	(std-slot-value generic-function 'sys::method-class)))
4370
4371	(atomic-defgeneric generic-function-method-combination (generic-function)
4372	(:method ((generic-function standard-generic-function))
4373	(std-slot-value generic-function 'sys::%method-combination)))
4374
4375	(atomic-defgeneric generic-function-methods (generic-function)
4376	(:method ((generic-function standard-generic-function))
4377	(std-slot-value generic-function 'sys::methods)))
4378
4379	(atomic-defgeneric generic-function-name (generic-function)
4380	(:method ((generic-function standard-generic-function))
4381	(slot-value generic-function 'sys::name)))
4382
4383	(atomic-defgeneric generic-function-required-arguments (generic-function)
4384	(:method ((generic-function standard-generic-function))
4385	(std-slot-value generic-function 'sys::required-args)))
4386
4387	(atomic-defgeneric generic-function-optional-arguments (generic-function)
4388	(:method ((generic-function standard-generic-function))
4389	(std-slot-value generic-function 'sys::optional-args)))
4390
4391	;;; AMOP pg. 231
4392	(defgeneric (setf generic-function-name) (new-value gf)
4393	(:method (new-value (gf generic-function))
4394	(reinitialize-instance gf :name new-value)))
4395
4396	;;; Readers for Method Metaobjects
4397	;;; AMOP pg. 218ff.
4398
4399	(atomic-defgeneric method-function (method)
4400	(:method ((method standard-method))
4401	(std-method-function method)))
4402
4403	(atomic-defgeneric method-generic-function (method)
4404	(:method ((method standard-method))
4405	(std-method-generic-function method)))
4406
4407	(atomic-defgeneric method-lambda-list (method)
4408	(:method ((method standard-method))
4409	(std-slot-value method 'sys::lambda-list)))
4410
4411	(atomic-defgeneric method-specializers (method)
4412	(:method ((method standard-method))
4413	(std-method-specializers method)))
4414
4415	(atomic-defgeneric method-qualifiers (method)
4416	(:method ((method standard-method))
4417	(std-method-qualifiers method)))
4418
4419	(atomic-defgeneric accessor-method-slot-definition (method)
4420	(:method ((method standard-accessor-method))
4421	(std-accessor-method-slot-definition method)))
4422
4423
4424	;;; find-method-combination
4425
4426	;;; AMOP pg. 191
4427	(atomic-defgeneric find-method-combination (gf name options)
4428	(:method (gf (name symbol) options)
4429	(std-find-method-combination gf name options)))
4430
4431	;;; specializer-direct-method and friends.
4432
4433	;;; AMOP pg. 237
4434	(defgeneric specializer-direct-generic-functions (specializer))
4435
4436	(defmethod specializer-direct-generic-functions ((specializer class))
4437	(delete-duplicates (mapcar #'method-generic-function
4438	(class-direct-methods specializer))))
4439
4440	(defmethod specializer-direct-generic-functions ((specializer eql-specializer))
4441	(delete-duplicates (mapcar #'method-generic-function
4442	(slot-value specializer 'direct-methods))))
4443
4444	;;; AMOP pg. 238
4445	(defgeneric specializer-direct-methods (specializer))
4446
4447	(defmethod specializer-direct-methods ((specializer class))
4448	(class-direct-methods specializer))
4449
4450	(defmethod specializer-direct-methods ((specializer eql-specializer))
4451	(slot-value specializer 'direct-methods))
4452
4453	;;; AMOP pg. 165
4454	(atomic-defgeneric add-direct-method (specializer method)
4455	(:method ((specializer class) (method method))
4456	(pushnew method (class-direct-methods specializer)))
4457	(:method ((specializer eql-specializer) (method method))
4458	(pushnew method (slot-value specializer 'direct-methods)))
4459	(:method ((specializer specializer) (method method))
4460	(pushnew method (slot-value specializer 'direct-methods))))
4461
4462	;;; AMOP pg. 227
4463	(atomic-defgeneric remove-direct-method (specializer method)
4464	(:method ((specializer class) (method method))
4465	(setf (class-direct-methods specializer)
4466	(remove method (class-direct-methods specializer))))
4467	(:method ((specializer eql-specializer) (method method))
4468	(setf (slot-value specializer 'direct-methods)
4469	(remove method (slot-value specializer 'direct-methods))))
4470	(:method ((specializer specializer) (method method))
4471	(setf (slot-value specializer 'direct-methods)
4472	(remove method (slot-value specializer 'direct-methods)))))
4473
4474	;;; The Dependent Maintenance Protocol (AMOP pg. 160ff.)
4475
4476	(defvar dependents (make-hash-table :test 'eq :weakness :key))
4477
4478	;;; AMOP pg. 164
4479	(defgeneric add-dependent (metaobject dependent))
4480	(defmethod add-dependent ((metaobject standard-class) dependent)
4481	(pushnew dependent (gethash metaobject dependents nil)))
4482	(defmethod add-dependent ((metaobject funcallable-standard-class) dependent)
4483	(pushnew dependent (gethash metaobject dependents nil)))
4484	(defmethod add-dependent ((metaobject standard-generic-function) dependent)
4485	(pushnew dependent (gethash metaobject dependents nil)))
4486
4487	;;; AMOP pg. 225
4488	(defgeneric remove-dependent (metaobject dependent))
4489	(defmethod remove-dependent ((metaobject standard-class) dependent)
4490	(setf (gethash metaobject dependents)
4491	(delete dependent (gethash metaobject dependents nil) :test #'eq)))
4492	(defmethod remove-dependent ((metaobject funcallable-standard-class) dependent)
4493	(setf (gethash metaobject dependents)
4494	(delete dependent (gethash metaobject dependents nil) :test #'eq)))
4495	(defmethod remove-dependent ((metaobject standard-generic-function) dependent)
4496	(setf (gethash metaobject dependents)
4497	(delete dependent (gethash metaobject dependents nil) :test #'eq)))
4498
4499	;;; AMOP pg. 210
4500	(atomic-defgeneric map-dependents (metaobject function)
4501	(:method ((metaobject standard-class) function)
4502	(dolist (dependent (gethash metaobject dependents nil))
4503	(funcall function dependent)))
4504	(:method ((metaobject funcallable-standard-class) function)
4505	(dolist (dependent (gethash metaobject dependents nil))
4506	(funcall function dependent)))
4507	(:method ((metaobject standard-generic-function) function)
4508	(dolist (dependent (gethash metaobject dependents nil))
4509	(funcall function dependent))))
4510
4511	;;; AMOP pg. 239
4512	(defgeneric update-dependent (metaobject dependent &rest initargs))
4513
4514
4515	;;; ensure-generic-function(-using-class), AMOP pg. 185ff.
4516	(defgeneric ensure-generic-function-using-class (generic-function function-name
4517	&key
4518	argument-precedence-order
4519	declarations documentation
4520	generic-function-class
4521	lambda-list method-class
4522	method-combination
4523	name
4524	&allow-other-keys))
4525
4526	(defmethod ensure-generic-function-using-class
4527	((generic-function generic-function)
4528	function-name
4529	&rest all-keys
4530	&key (generic-function-class (class-of generic-function))
4531	(method-class (generic-function-method-class generic-function))
4532	(method-combination (generic-function-method-combination generic-function))
4533	&allow-other-keys)
4534	(setf all-keys (copy-list all-keys)) ; since we modify it
4535	(remf all-keys :generic-function-class)
4536	(unless (classp generic-function-class)
4537	(setf generic-function-class (find-class generic-function-class)))
4538	(unless (classp method-class) (setf method-class (find-class method-class)))
4539	(unless (eq generic-function-class (class-of generic-function))
4540	(error "The class ~S is incompatible with the existing class (~S) of ~S."
4541	generic-function-class (class-of generic-function) generic-function))
4542	;; We used to check for changes in method class here, but CLHS says:
4543	;; "If function-name specifies a generic function that has a different
4544	;; value for the :method-class argument, the value is changed, but any
4545	;; existing methods are not changed."
4546	(unless (typep method-combination 'method-combination)
4547	(setf method-combination
4548	(find-method-combination generic-function
4549	(car method-combination)
4550	(cdr method-combination))))
4551	(apply #'reinitialize-instance generic-function
4552	:method-combination method-combination
4553	:method-class method-class
4554	all-keys)
4555	generic-function)
4556
4557	(defmethod ensure-generic-function-using-class ((generic-function null)
4558	function-name
4559	&rest all-keys
4560	&key (generic-function-class +the-standard-generic-function-class+)
4561	&allow-other-keys)
4562	(setf all-keys (copy-list all-keys)) ; since we modify it
4563	(remf all-keys :generic-function-class)
4564	(unless (classp generic-function-class)
4565	(setf generic-function-class (find-class generic-function-class)))
4566	(when (and (null clos-booting) (fboundp function-name))
4567	(if (or (autoloadp function-name)
4568	(and (consp function-name)
4569	(eq 'setf (first function-name))
4570	(autoload-ref-p (second function-name))))
4571	(fmakunbound function-name)
4572	(progn
4573	(cerror "Redefine as generic function" "~A already names an ordinary function, macro, or special operator." function-name)
4574	(fmakunbound function-name)
4575	)))
4576	(apply (if (eq generic-function-class +the-standard-generic-function-class+)
4577	#'make-instance-standard-generic-function
4578	#'make-instance)
4579	generic-function-class :name function-name all-keys))
4580
4581	(defun ensure-generic-function (function-name &rest all-keys
4582	&key
4583	lambda-list generic-function-class
4584	method-class
4585	method-combination
4586	argument-precedence-order
4587	declarations
4588	documentation
4589	&allow-other-keys)
4590	(declare (ignore lambda-list generic-function-class method-class
4591	method-combination argument-precedence-order declarations
4592	documentation))
4593	(apply #'ensure-generic-function-using-class
4594	(find-generic-function function-name nil)
4595	function-name all-keys))
4596
4597	;;; SLIME compatibility functions.
4598
4599	(defun %method-generic-function (method)
4600	(method-generic-function method))
4601
4602	(defun %method-function (method)
4603	(method-function method))
4604
4605	(eval-when (:compile-toplevel :load-toplevel :execute)
4606	(require "MOP"))
4607
4608	(provide "CLOS")