Context Navigation

source: trunk/abcl/src/org/armedbear/lisp/clos.lisp @ 15459

Visit:

Last change on this file since 15459 was 15459, checked in by Mark Evenson, 3 years ago
Tidy call-next-method flets with macrology
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 204.0 KB

Line
1	;;; clos.lisp
2	;;;
3	;;; Copyright (C) 2003-2007 Peter Graves
4	;;; Copyright (C) 2010-2013 Mark Evenson
5	;;; $Id: clos.lisp 15459 2020-10-29 16:55:03Z 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	(t
1943	(error "Unknown specializer: ~S" specializer))))
1944
1945	(defun parse-defmethod (args)
1946	(let ((function-name (car args))
1947	(qualifiers ())
1948	(specialized-lambda-list ())
1949	(body ())
1950	(parse-state :qualifiers))
1951	(dolist (arg (cdr args))
1952	(ecase parse-state
1953	(:qualifiers
1954	(if (and (atom arg) (not (null arg)))
1955	(push arg qualifiers)
1956	(progn
1957	(setf specialized-lambda-list arg)
1958	(setf parse-state :body))))
1959	(:body (push arg body))))
1960	(setf qualifiers (nreverse qualifiers)
1961	body (nreverse body))
1962	(multiple-value-bind (real-body declarations documentation)
1963	(parse-body body)
1964	(values function-name
1965	qualifiers
1966	(extract-lambda-list specialized-lambda-list)
1967	(extract-specializer-names specialized-lambda-list)
1968	documentation
1969	declarations
1970	(list* 'block
1971	(fdefinition-block-name function-name)
1972	real-body)))))
1973
1974	(defun required-portion (gf args)
1975	(let ((number-required (length (generic-function-required-arguments gf))))
1976	(when (< (length args) number-required)
1977	(error 'program-error
1978	:format-control "Not enough arguments for generic function ~S."
1979	:format-arguments (list (generic-function-name gf))))
1980	(subseq args 0 number-required)))
1981
1982	(defun extract-lambda-list (specialized-lambda-list)
1983	(let* ((plist (analyze-lambda-list specialized-lambda-list))
1984	(requireds (getf plist :required-names))
1985	(rv (getf plist :rest-var))
1986	(ks (getf plist :key-args))
1987	(keysp (getf plist :keysp))
1988	(aok (getf plist :allow-other-keys))
1989	(opts (getf plist :optional-args))
1990	(auxs (getf plist :auxiliary-args)))
1991	`(,@requireds
1992	,@(if opts `(&optional ,@opts) ())
1993	,@(if rv `(&rest ,rv) ())
1994	,@(if (or ks keysp aok) `(&key ,@ks) ())
1995	,@(if aok '(&allow-other-keys) ())
1996	,@(if auxs `(&aux ,@auxs) ()))))
1997
1998	(defun extract-specializer-names (specialized-lambda-list)
1999	(let ((plist (analyze-lambda-list specialized-lambda-list)))
2000	(getf plist ':specializers)))
2001
2002	(defun get-keyword-from-arg (arg)
2003	(if (listp arg)
2004	(if (listp (car arg))
2005	(caar arg)
2006	(make-keyword (car arg)))
2007	(make-keyword arg)))
2008
2009	(defun analyze-lambda-list (lambda-list)
2010	(let ((keys ()) ; Just the keywords
2011	(key-args ()) ; Keywords argument specs
2012	(keysp nil) ;
2013	(required-names ()) ; Just the variable names
2014	(required-args ()) ; Variable names & specializers
2015	(specializers ()) ; Just the specializers
2016	(rest-var nil)
2017	(optionals ())
2018	(auxs ())
2019	(allow-other-keys nil)
2020	(state :required))
2021	(dolist (arg lambda-list)
2022	(if (member arg lambda-list-keywords)
2023	(ecase arg
2024	(&optional
2025	(unless (eq state :required)
2026	(error 'program-error
2027	:format-control "~A followed by &OPTIONAL not allowed ~
2028	in lambda list ~S"
2029	:format-arguments (list state lambda-list)))
2030	(setq state '&optional))
2031	(&rest
2032	(unless (or (eq state :required)
2033	(eq state '&optional))
2034	(error 'program-error
2035	:format-control "~A followed by &REST not allowed ~
2036	in lambda list ~S"
2037	:format-arguments (list state lambda-list)))
2038	(setq state '&rest))
2039	(&key
2040	(unless (or (eq state :required)
2041	(eq state '&optional)
2042	(eq state '&rest))
2043	(error 'program-error
2044	:format-control "~A followed by &KEY not allowed
2045	in lambda list ~S"
2046	:format-arguments (list state lambda-list)))
2047	(setq keysp t)
2048	(setq state '&key))
2049	(&allow-other-keys
2050	(unless (eq state '&key)
2051	(error 'program-error
2052	:format-control "&ALLOW-OTHER-KEYS not allowed while
2053	parsing ~A in lambda list ~S"
2054	:format-arguments (list state lambda-list)))
2055	(setq allow-other-keys 't))
2056	(&aux
2057	;; &aux comes last; any other previous state is fine
2058	(setq state '&aux)))
2059	(case state
2060	(:required
2061	(push-on-end arg required-args)
2062	(if (listp arg)
2063	(progn (push-on-end (car arg) required-names)
2064	(push-on-end (cadr arg) specializers))
2065	(progn (push-on-end arg required-names)
2066	(push-on-end 't specializers))))
2067	(&optional (push-on-end arg optionals))
2068	(&rest (setq rest-var arg))
2069	(&key
2070	(push-on-end (get-keyword-from-arg arg) keys)
2071	(push-on-end arg key-args))
2072	(&aux (push-on-end arg auxs)))))
2073	(list :required-names required-names
2074	:required-args required-args
2075	:specializers specializers
2076	:rest-var rest-var
2077	:keywords keys
2078	:key-args key-args
2079	:keysp keysp
2080	:auxiliary-args auxs
2081	:optional-args optionals
2082	:allow-other-keys allow-other-keys)))
2083
2084	#+nil
2085	(defun check-method-arg-info (gf arg-info method)
2086	(multiple-value-bind (nreq nopt keysp restp allow-other-keys-p keywords)
2087	(analyze-lambda-list (if (consp method)
2088	(early-method-lambda-list method)
2089	(method-lambda-list method)))
2090	(flet ((lose (string &rest args)
2091	(error 'simple-program-error
2092	:format-control "~@<attempt to add the method~2I~_~S~I~_~
2093	to the generic function~2I~_~S;~I~_~
2094	but ~?~:>"
2095	:format-arguments (list method gf string args)))
2096	(comparison-description (x y)
2097	(if (> x y) "more" "fewer")))
2098	(let ((gf-nreq (arg-info-number-required arg-info))
2099	(gf-nopt (arg-info-number-optional arg-info))
2100	(gf-key/rest-p (arg-info-key/rest-p arg-info))
2101	(gf-keywords (arg-info-keys arg-info)))
2102	(unless (= nreq gf-nreq)
2103	(lose
2104	"the method has ~A required arguments than the generic function."
2105	(comparison-description nreq gf-nreq)))
2106	(unless (= nopt gf-nopt)
2107	(lose
2108	"the method has ~A optional arguments than the generic function."
2109	(comparison-description nopt gf-nopt)))
2110	(unless (eq (or keysp restp) gf-key/rest-p)
2111	(lose
2112	"the method and generic function differ in whether they accept~_~
2113	&REST or &KEY arguments."))
2114	(when (consp gf-keywords)
2115	(unless (or (and restp (not keysp))
2116	allow-other-keys-p
2117	(every (lambda (k) (memq k keywords)) gf-keywords))
2118	(lose "the method does not accept each of the &KEY arguments~2I~_~
2119	~S."
2120	gf-keywords)))))))
2121
2122	(defun check-method-lambda-list (name method-lambda-list gf-lambda-list)
2123	(let* ((gf-restp (not (null (memq '&rest gf-lambda-list))))
2124	(gf-plist (analyze-lambda-list gf-lambda-list))
2125	(gf-keysp (getf gf-plist :keysp))
2126	(gf-keywords (getf gf-plist :keywords))
2127	(method-plist (analyze-lambda-list method-lambda-list))
2128	(method-restp (not (null (memq '&rest method-lambda-list))))
2129	(method-keysp (getf method-plist :keysp))
2130	(method-keywords (getf method-plist :keywords))
2131	(method-allow-other-keys-p (getf method-plist :allow-other-keys)))
2132	(unless (= (length (getf gf-plist :required-args))
2133	(length (getf method-plist :required-args)))
2134	(error "The method-lambda-list ~S ~
2135	has the wrong number of required arguments ~
2136	for the generic function ~S." method-lambda-list name))
2137	(unless (= (length (getf gf-plist :optional-args))
2138	(length (getf method-plist :optional-args)))
2139	(error "The method-lambda-list ~S ~
2140	has the wrong number of optional arguments ~
2141	for the generic function ~S." method-lambda-list name))
2142	(unless (eq (or gf-restp gf-keysp) (or method-restp method-keysp))
2143	(error "The method-lambda-list ~S ~
2144	and the generic function ~S ~
2145	differ in whether they accept &REST or &KEY arguments."
2146	method-lambda-list name))
2147	(when (consp gf-keywords)
2148	(unless (or (and method-restp (not method-keysp))
2149	method-allow-other-keys-p
2150	(every (lambda (k) (memq k method-keywords)) gf-keywords))
2151	(error "The method-lambda-list ~S does not accept ~
2152	all of the keyword arguments defined for the ~
2153	generic function." method-lambda-list name)))))
2154
2155	(defun check-argument-precedence-order (lambda-list argument-precedence-order)
2156	(when argument-precedence-order
2157	(if lambda-list
2158	;; raising the required program-errors is a side-effect of
2159	;; calculating the given permutation of apo vs req
2160	(argument-precedence-order-indices
2161	argument-precedence-order
2162	(getf (analyze-lambda-list lambda-list) :required-args))
2163	;; AMOP pg. 198
2164	(error 'program-error "argument precedence order specified without lambda list"))))
2165
2166	(defvar gf-initialize-instance nil
2167	"Cached value of the INITIALIZE-INSTANCE generic function.
2168	Initialized with the true value near the end of the file.")
2169	(defvar gf-allocate-instance nil
2170	"Cached value of the ALLOCATE-INSTANCE generic function.
2171	Initialized with the true value near the end of the file.")
2172	(defvar gf-shared-initialize nil
2173	"Cached value of the SHARED-INITIALIZE generic function.
2174	Initialized with the true value near the end of the file.")
2175	(defvar gf-reinitialize-instance nil
2176	"Cached value of the REINITIALIZE-INSTANCE generic function.
2177	Initialized with the true value near the end of the file.")
2178
2179	(declaim (ftype (function * method) ensure-method))
2180	(defun ensure-method (name &rest all-keys)
2181	(let ((method-lambda-list (getf all-keys :lambda-list))
2182	(gf (find-generic-function name nil)))
2183	(when (or (eq gf gf-initialize-instance)
2184	(eq gf gf-allocate-instance)
2185	(eq gf gf-shared-initialize)
2186	(eq gf gf-reinitialize-instance))
2187	;; ### Clearly, this can be targeted much more exact
2188	;; as we only need to remove the specializing class and all
2189	;; its subclasses from the hash.
2190	(clrhash make-instance-initargs-cache)
2191	(clrhash reinitialize-instance-initargs-cache))
2192	(if gf
2193	(restart-case
2194	(check-method-lambda-list name method-lambda-list
2195	(generic-function-lambda-list gf))
2196	(unbind-and-try-again () :report (lambda(s) (format s "Undefine generic function #'~a and continue" name))
2197	(fmakunbound name)
2198	(setf gf (ensure-generic-function name :lambda-list method-lambda-list))))
2199	(setf gf (ensure-generic-function name :lambda-list method-lambda-list)))
2200	(let ((method
2201	(if (eq (generic-function-method-class gf) +the-standard-method-class+)
2202	(apply #'make-instance-standard-method gf all-keys)
2203	(apply #'make-instance (generic-function-method-class gf) all-keys))))
2204	(if (and
2205	(eq (generic-function-method-class gf) +the-standard-method-class+)
2206	(std-generic-function-p gf))
2207	(progn
2208	(std-add-method gf method)
2209	(map-dependents gf
2210	#'(lambda (dep)
2211	(update-dependent gf dep 'add-method method))))
2212	(add-method gf method))
2213	method)))
2214
2215	(defun make-instance-standard-method (gf
2216	&key
2217	lambda-list
2218	qualifiers
2219	specializers
2220	documentation
2221	function
2222	fast-function)
2223	(declare (ignore gf))
2224	(let ((method (std-allocate-instance +the-standard-method-class+))
2225	(analyzed-args (analyze-lambda-list lambda-list)))
2226	(setf (method-lambda-list method) lambda-list)
2227	(setf (method-qualifiers method) qualifiers)
2228	(setf (std-slot-value method 'sys::specializers)
2229	(canonicalize-specializers specializers))
2230	(setf (method-documentation method) documentation)
2231	(setf (std-slot-value method 'sys::%generic-function) nil) ; set by add-method
2232	(setf (std-slot-value method 'sys::%function) function)
2233	(setf (std-slot-value method 'sys::fast-function) fast-function)
2234	(setf (std-slot-value method 'sys::keywords) (getf analyzed-args :keywords))
2235	(setf (std-slot-value method 'sys::other-keywords-p)
2236	(getf analyzed-args :allow-other-keys))
2237	method))
2238
2239	;;; To be redefined as generic functions later
2240	(declaim (notinline add-direct-method))
2241	(defun add-direct-method (specializer method)
2242	(if (typep specializer 'eql-specializer)
2243	(pushnew method (std-slot-value specializer 'direct-methods))
2244	(pushnew method (class-direct-methods specializer))))
2245
2246	(declaim (notinline remove-direct-method))
2247	(defun remove-direct-method (specializer method)
2248	(if (typep specializer 'eql-specializer)
2249	(setf (std-slot-value specializer 'direct-methods)
2250	(remove method (std-slot-value specializer 'direct-methods)))
2251	(setf (class-direct-methods specializer)
2252	(remove method (class-direct-methods specializer)))))
2253
2254	(defun std-add-method (gf method)
2255	;; calls sites need to make sure that method is either a method of the
2256	;; given gf or does not have a gf.
2257	(let ((old-method (%find-method gf (std-method-qualifiers method)
2258	(method-specializers method) nil)))
2259	(when old-method
2260	(if (and (std-generic-function-p gf)
2261	(eq (class-of old-method) +the-standard-method-class+))
2262	(std-remove-method gf old-method)
2263	(remove-method gf old-method))))
2264	(setf (std-slot-value method 'sys::%generic-function) gf)
2265	(push method (std-slot-value gf 'sys::methods))
2266	(dolist (specializer (method-specializers method))
2267	(add-direct-method specializer method))
2268	(finalize-standard-generic-function gf)
2269	gf)
2270
2271	(defun std-remove-method (gf method)
2272	(setf (std-slot-value gf 'sys::methods)
2273	(remove method (generic-function-methods gf)))
2274	(setf (std-slot-value method 'sys::%generic-function) nil)
2275	(dolist (specializer (method-specializers method))
2276	(remove-direct-method specializer method))
2277	(finalize-standard-generic-function gf)
2278	gf)
2279
2280	(defun %find-method (gf qualifiers specializers &optional (errorp t))
2281	;; "If the specializers argument does not correspond in length to the number
2282	;; of required arguments of the generic-function, an an error of type ERROR
2283	;; is signaled."
2284	(unless (= (length specializers) (length (generic-function-required-arguments gf)))
2285	(error "The specializers argument has length ~S, but ~S has ~S required parameters."
2286	(length specializers)
2287	gf
2288	(length (generic-function-required-arguments gf))))
2289	(let* ((canonical-specializers (canonicalize-specializers specializers))
2290	(method
2291	(find-if #'(lambda (method)
2292	(and (equal qualifiers
2293	(method-qualifiers method))
2294	(equal canonical-specializers
2295	(method-specializers method))))
2296	(generic-function-methods gf))))
2297	(if (and (null method) errorp)
2298	(error "No such method for ~S." (generic-function-name gf))
2299	method)))
2300
2301	(defun fast-callable-p (gf)
2302	(and (eq (method-combination-name (generic-function-method-combination gf))
2303	'standard)
2304	(null (intersection (generic-function-lambda-list gf)
2305	'(&rest &optional &key &allow-other-keys &aux)))))
2306
2307	(defun std-compute-discriminating-function (gf)
2308	;; In this function, we know that gf is of class
2309	;; standard-generic-function, so we can access the instance's slots
2310	;; via std-slot-value. This breaks circularities when redefining
2311	;; generic function accessors.
2312	(let ((methods (std-slot-value gf 'sys::methods)))
2313	(cond
2314	((and (= (length methods) 1)
2315	(eq (type-of (car methods)) 'standard-reader-method)
2316	(eq (type-of (car (std-method-specializers (car methods))))
2317	'standard-class))
2318	(let* ((method (first methods))
2319	(slot-definition (std-slot-value method 'sys::%slot-definition))
2320	(slot-name (std-slot-value slot-definition 'sys:name))
2321	(class (car (std-method-specializers method))))
2322	#'(lambda (instance)
2323	;; TODO: elide this test for low values of SAFETY
2324	(unless (typep instance class)
2325	(no-applicable-method gf (list instance)))
2326	;; hash table lookup for slot position in Layout object via
2327	;; StandardObject.SLOT_VALUE, so should be reasonably fast
2328	(std-slot-value instance slot-name))))
2329	((and (= (length methods) 1)
2330	(eq (type-of (car methods)) 'standard-writer-method)
2331	(eq (type-of (second (std-method-specializers (car methods))))
2332	'standard-class))
2333	(let* ((method (first methods))
2334	(slot-definition (std-slot-value method 'sys::%slot-definition))
2335	(slot-name (std-slot-value slot-definition 'sys:name))
2336	(class (car (std-method-specializers method))))
2337	#'(lambda (new-value instance)
2338	;; TODO: elide this test for low values of SAFETY
2339	(unless (typep instance class)
2340	(no-applicable-method gf (list new-value instance)))
2341	;; hash table lookup for slot position in Layout object via
2342	;; StandardObject.SET_SLOT_VALUE, so should be reasonably fast
2343	(setf (std-slot-value instance slot-name) new-value))))
2344	(t
2345	(let* ((number-required (length (generic-function-required-arguments gf)))
2346	(lambda-list (generic-function-lambda-list gf))
2347	(exact (null (intersection lambda-list
2348	'(&rest &optional &key
2349	&allow-other-keys))))
2350	(no-aux (null (some
2351	(lambda (method)
2352	(find '&aux (std-slot-value method 'sys::lambda-list)))
2353	methods))))
2354	(if (and exact
2355	no-aux)
2356	(cond
2357	((= number-required 1)
2358	(cond
2359	((and (eq (method-combination-name
2360	(std-slot-value gf 'sys::%method-combination))
2361	'standard)
2362	(= (length methods) 1)
2363	(std-method-fast-function (%car methods)))
2364	(let* ((method (%car methods))
2365	(specializer (car (std-method-specializers method)))
2366	(function (std-method-fast-function method)))
2367	(if (typep specializer 'eql-specializer)
2368	(let ((specializer-object (eql-specializer-object specializer)))
2369	#'(lambda (arg)
2370	(declare (optimize speed))
2371	(if (eql arg specializer-object)
2372	(funcall function arg)
2373	(no-applicable-method gf (list arg)))))
2374	#'(lambda (arg)
2375	(declare (optimize speed))
2376	(unless (simple-typep arg specializer)
2377	;; FIXME no applicable method
2378	(error 'simple-type-error
2379	:datum arg
2380	:expected-type specializer))
2381	(funcall function arg)))))
2382	(t
2383	#'(lambda (arg)
2384	(declare (optimize speed))
2385	(let* ((args (list arg))
2386	(emfun (get-cached-emf gf args)))
2387	(if emfun
2388	(funcall emfun args)
2389	(slow-method-lookup gf args)))))))
2390	((= number-required 2)
2391	#'(lambda (arg1 arg2)
2392	(declare (optimize speed))
2393	(let* ((args (list arg1 arg2))
2394	(emfun (get-cached-emf gf args)))
2395	(if emfun
2396	(funcall emfun args)
2397	(slow-method-lookup gf args)))))
2398	((= number-required 3)
2399	#'(lambda (arg1 arg2 arg3)
2400	(declare (optimize speed))
2401	(let* ((args (list arg1 arg2 arg3))
2402	(emfun (get-cached-emf gf args)))
2403	(if emfun
2404	(funcall emfun args)
2405	(slow-method-lookup gf args)))))
2406	(t
2407	#'(lambda (&rest args)
2408	(declare (optimize speed))
2409	(let ((len (length args)))
2410	(unless (= len number-required)
2411	(error 'program-error
2412	:format-control "Not enough arguments for generic function ~S."
2413	:format-arguments (list (generic-function-name gf)))))
2414	(let ((emfun (get-cached-emf gf args)))
2415	(if emfun
2416	(funcall emfun args)
2417	(slow-method-lookup gf args))))))
2418	#'(lambda (&rest args)
2419	(declare (optimize speed))
2420	(let ((len (length args)))
2421	(unless (>= len number-required)
2422	(error 'program-error
2423	:format-control "Not enough arguments for generic function ~S."
2424	:format-arguments (list (generic-function-name gf)))))
2425	(let ((emfun (get-cached-emf gf args)))
2426	(if emfun
2427	(funcall emfun args)
2428	(slow-method-lookup gf args))))))))))
2429
2430	(defun sort-methods (methods gf required-classes)
2431	(if (or (null methods) (null (%cdr methods)))
2432	methods
2433	(sort methods
2434	(if (std-generic-function-p gf)
2435	(let ((method-indices
2436	(argument-precedence-order-indices
2437	(generic-function-argument-precedence-order gf)
2438	(getf (analyze-lambda-list (generic-function-lambda-list gf))
2439	':required-args))))
2440	#'(lambda (m1 m2)
2441	(std-method-more-specific-p
2442	m1 m2 required-classes method-indices)))
2443	#'(lambda (m1 m2)
2444	(method-more-specific-p gf m1 m2 required-classes))))))
2445
2446	(defun method-applicable-p (method args)
2447	(do* ((specializers (method-specializers method) (cdr specializers))
2448	(args args (cdr args)))
2449	((null specializers) t)
2450	(let ((specializer (car specializers)))
2451	(if (typep specializer 'eql-specializer)
2452	(unless (eql (car args) (eql-specializer-object specializer))
2453	(return nil))
2454	(unless (subclassp (class-of (car args)) specializer)
2455	(return nil))))))
2456
2457	(defun std-compute-applicable-methods (gf args)
2458	(let ((required-classes (mapcar #'class-of (required-portion gf args)))
2459	(methods '()))
2460	(dolist (method (generic-function-methods gf))
2461	(when (method-applicable-p method args)
2462	(push method methods)))
2463	(sort-methods methods gf required-classes)))
2464
2465	(declaim (notinline compute-applicable-methods))
2466	(defun compute-applicable-methods (gf args)
2467	(std-compute-applicable-methods gf args))
2468
2469	;;; METHOD-APPLICABLE-USING-CLASSES-P
2470	;;;
2471	;;; If the first return value is T, METHOD is definitely applicable to
2472	;;; arguments that are instances of CLASSES. If the first value is
2473	;;; NIL and the second value is T, METHOD is definitely not applicable
2474	;;; to arguments that are instances of CLASSES; if the second value is
2475	;;; NIL the applicability of METHOD cannot be determined by inspecting
2476	;;; the classes of its arguments only.
2477	;;;
2478	(defun method-applicable-using-classes-p (method classes)
2479	(do* ((specializers (method-specializers method) (cdr specializers))
2480	(classes classes (cdr classes))
2481	(knownp t))
2482	((null specializers)
2483	(if knownp (values t t) (values nil nil)))
2484	(let ((specializer (car specializers)))
2485	(if (typep specializer 'eql-specializer)
2486	(if (eql (class-of (eql-specializer-object specializer))
2487	(car classes))
2488	(setf knownp nil)
2489	(return (values nil t)))
2490	(unless (subclassp (car classes) specializer)
2491	(return (values nil t)))))))
2492
2493	(defun check-applicable-method-keyword-args (gf args
2494	keyword-args
2495	applicable-keywords)
2496	(when (oddp (length keyword-args))
2497	(error 'program-error
2498	:format-control "Odd number of keyword arguments in call to ~S ~
2499	with arguments list ~S"
2500	:format-arguments (list gf args)))
2501	(unless (getf keyword-args :allow-other-keys)
2502	(loop for key in keyword-args by #'cddr
2503	unless (or (member key applicable-keywords)
2504	(eq key :allow-other-keys))
2505	do (error 'program-error
2506	:format-control "Invalid keyword argument ~S in call ~
2507	to ~S with argument list ~S."
2508	:format-arguments (list key gf args)))))
2509
2510	(defun compute-applicable-keywords (gf applicable-methods)
2511	(let ((applicable-keywords
2512	(getf (analyze-lambda-list (generic-function-lambda-list gf))
2513	:keywords)))
2514	(loop for method in applicable-methods
2515	do (multiple-value-bind
2516	(keywords allow-other-keys)
2517	(function-keywords method)
2518	(when allow-other-keys
2519	(setf applicable-keywords :any)
2520	(return))
2521	(setf applicable-keywords
2522	(union applicable-keywords keywords))))
2523	applicable-keywords))
2524
2525	(defun wrap-emfun-for-keyword-args-check (gf emfun non-keyword-args
2526	applicable-keywords)
2527	#'(lambda (args)
2528	(check-applicable-method-keyword-args
2529	gf args
2530	(nthcdr non-keyword-args args) applicable-keywords)
2531	(funcall emfun args)))
2532
2533	(defun slow-method-lookup (gf args)
2534	(let ((applicable-methods
2535	(if (std-generic-function-p gf)
2536	(std-compute-applicable-methods gf args)
2537	(or (compute-applicable-methods-using-classes gf (mapcar #'class-of args))
2538	(compute-applicable-methods gf args)))))
2539	(if applicable-methods
2540	(let* ((emfun (funcall (if (std-generic-function-p gf)
2541	#'std-compute-effective-method
2542	#'compute-effective-method)
2543	gf (generic-function-method-combination gf)
2544	applicable-methods))
2545	(non-keyword-args (+ (length (generic-function-required-arguments gf))
2546	(length (generic-function-optional-arguments gf))))
2547	(gf-lambda-list (generic-function-lambda-list gf))
2548	(checks-required (and (member '&key gf-lambda-list)
2549	(not (member '&allow-other-keys
2550	gf-lambda-list))))
2551	(applicable-keywords
2552	(when checks-required
2553	;; Don't do applicable keyword checks when this is
2554	;; one of the 'exceptional four' or when the gf allows
2555	;; other keywords.
2556	(compute-applicable-keywords gf applicable-methods))))
2557	(when (and checks-required
2558	(not (eq applicable-keywords :any)))
2559	(setf emfun
2560	(wrap-emfun-for-keyword-args-check gf emfun non-keyword-args
2561	applicable-keywords)))
2562	(cache-emf gf args emfun)
2563	(funcall emfun args))
2564	(apply #'no-applicable-method gf args))))
2565
2566	(defun sub-specializer-p (c1 c2 c-arg)
2567	(find c2 (cdr (memq c1 (%class-precedence-list c-arg)))))
2568
2569	(defun std-method-more-specific-p (method1 method2 required-classes argument-precedence-order)
2570	(if argument-precedence-order
2571	(let ((specializers-1 (std-method-specializers method1))
2572	(specializers-2 (std-method-specializers method2)))
2573	(dolist (index argument-precedence-order)
2574	(let ((spec1 (nth index specializers-1))
2575	(spec2 (nth index specializers-2)))
2576	(unless (eq spec1 spec2)
2577	(cond ((typep spec1 'eql-specializer)
2578	(return t))
2579	((typep spec2 'eql-specializer)
2580	(return nil))
2581	(t
2582	(return (sub-specializer-p spec1 spec2
2583	(nth index required-classes)))))))))
2584	(do ((specializers-1 (std-method-specializers method1) (cdr specializers-1))
2585	(specializers-2 (std-method-specializers method2) (cdr specializers-2))
2586	(classes required-classes (cdr classes)))
2587	((null specializers-1) nil)
2588	(let ((spec1 (car specializers-1))
2589	(spec2 (car specializers-2)))
2590	(unless (eq spec1 spec2)
2591	(cond ((typep spec1 'eql-specializer)
2592	(return t))
2593	((typep spec2 'eql-specializer)
2594	(return nil))
2595	(t
2596	(return (sub-specializer-p spec1 spec2 (car classes))))))))))
2597
2598	(defun primary-method-p (method)
2599	(null (intersection '(:before :after :around) (method-qualifiers method))))
2600
2601	(defun before-method-p (method)
2602	(equal '(:before) (method-qualifiers method)))
2603
2604	(defun after-method-p (method)
2605	(equal '(:after) (method-qualifiers method)))
2606
2607	(defun around-method-p (method)
2608	(equal '(:around) (method-qualifiers method)))
2609
2610	(defun process-next-method-list (next-method-list)
2611	(mapcar #'(lambda (next-method-form)
2612	(cond
2613	((listp next-method-form)
2614	(assert (eq (first next-method-form) 'make-method))
2615	(let* ((rest-sym (gensym)))
2616	(make-instance-standard-method
2617	nil ;; ignored
2618	:lambda-list (list '&rest rest-sym)
2619	:function (compute-method-function `(lambda (&rest ,rest-sym)
2620	,(second next-method-form))))))
2621	(t
2622	(assert (typep next-method-form 'method))
2623	next-method-form)))
2624	next-method-list))
2625
2626	(defun std-compute-effective-method (gf method-combination methods)
2627	(assert (typep method-combination 'method-combination))
2628	(let* ((mc-name (method-combination-name method-combination))
2629	(options (slot-value method-combination 'options))
2630	(order (car options))
2631	(primaries '())
2632	(arounds '())
2633	around
2634	emf-form
2635	(long-method-combination-p
2636	(typep method-combination 'long-method-combination)))
2637	(unless long-method-combination-p
2638	(dolist (m methods)
2639	(let ((qualifiers (method-qualifiers m)))
2640	(cond ((null qualifiers)
2641	(if (eq mc-name 'standard)
2642	(push m primaries)
2643	(error "Method combination type mismatch: missing qualifier for method combination ~S." method-combination)))
2644	((cdr qualifiers)
2645	(error "Invalid method qualifiers."))
2646	((eq (car qualifiers) :around)
2647	(push m arounds))
2648	((eq (car qualifiers) mc-name)
2649	(push m primaries))
2650	((memq (car qualifiers) '(:before :after)))
2651	(t
2652	(error "Invalid method qualifiers."))))))
2653	(unless (eq order :most-specific-last)
2654	(setf primaries (nreverse primaries)))
2655	(setf arounds (nreverse arounds))
2656	(setf around (car arounds))
2657	(when (and (null primaries) (not long-method-combination-p))
2658	(error "No primary methods for the generic function ~S." gf))
2659	(cond
2660	(around
2661	(let ((next-emfun
2662	(funcall
2663	(if (std-generic-function-p gf)
2664	#'std-compute-effective-method
2665	#'compute-effective-method)
2666	gf method-combination (remove around methods))))
2667	(setf emf-form
2668	(generate-emf-lambda (method-function around) next-emfun))))
2669	((eq mc-name 'standard)
2670	(let* ((next-emfun (compute-primary-emfun (cdr primaries)))
2671	(befores (remove-if-not #'before-method-p methods))
2672	(reverse-afters
2673	(reverse (remove-if-not #'after-method-p methods))))
2674	(setf emf-form
2675	(cond
2676	((and (null befores) (null reverse-afters))
2677	(let ((fast-function (std-method-fast-function (car primaries))))
2678	(if fast-function
2679	(ecase (length (generic-function-required-arguments gf))
2680	(1
2681	#'(lambda (args)
2682	(declare (optimize speed))
2683	(funcall fast-function (car args))))
2684	(2
2685	#'(lambda (args)
2686	(declare (optimize speed))
2687	(funcall fast-function (car args) (cadr args)))))
2688	(generate-emf-lambda (std-method-function (car primaries))
2689	next-emfun))))
2690	(t
2691	(let ((method-function (method-function (car primaries))))
2692	#'(lambda (args)
2693	(declare (optimize speed))
2694	(dolist (before befores)
2695	(funcall (method-function before) args nil))
2696	(multiple-value-prog1
2697	(funcall method-function args next-emfun)
2698	(dolist (after reverse-afters)
2699	(funcall (method-function after) args nil))))))))))
2700	(long-method-combination-p
2701	(let ((function (long-method-combination-function method-combination))
2702	(arguments (slot-value method-combination 'options)))
2703	(assert function)
2704	(setf emf-form
2705	(if arguments
2706	(apply function gf methods arguments)
2707	(funcall function gf methods)))))
2708	(t
2709	(unless (typep method-combination 'short-method-combination)
2710	(error "Unsupported method combination type ~A." mc-name))
2711	(let ((operator (short-method-combination-operator method-combination))
2712	(ioa (short-method-combination-identity-with-one-argument method-combination)))
2713	(setf emf-form
2714	(if (and ioa (null (cdr primaries)))
2715	(generate-emf-lambda (method-function (car primaries)) nil)
2716	`(lambda (args)
2717	(,operator ,@(mapcar
2718	(lambda (primary)
2719	`(funcall ,(method-function primary) args nil))
2720	primaries))))))))
2721	(assert (not (null emf-form)))
2722	(or #+nil (ignore-errors (autocompile emf-form))
2723	(coerce-to-function emf-form))))
2724
2725	(defun generate-emf-lambda (method-function next-emfun)
2726	#'(lambda (args)
2727	(declare (optimize speed))
2728	(funcall method-function args next-emfun)))
2729
2730	;;; compute an effective method function from a list of primary methods:
2731
2732	(defun compute-primary-emfun (methods)
2733	(if (null methods)
2734	nil
2735	(let ((next-emfun (compute-primary-emfun (cdr methods))))
2736	#'(lambda (args)
2737	(funcall (std-method-function (car methods)) args next-emfun)))))
2738
2739	(defvar call-next-method-p)
2740	(defvar next-method-p-p)
2741
2742	;;; FIXME this doesn't work for macroized references
2743	(defun walk-form (form)
2744	(cond ((atom form)
2745	(cond ((eq form 'call-next-method)
2746	(setf call-next-method-p t))
2747	((eq form 'next-method-p)
2748	(setf next-method-p-p t))))
2749	(t
2750	(walk-form (%car form))
2751	(walk-form (%cdr form)))))
2752
2753	(defmacro flet-call-next-method (args next-emfun &body body)
2754	`(flet ((call-next-method (&rest cnm-args)
2755	(if (null ,next-emfun)
2756	(error "No next method for generic function.")
2757	(funcall ,next-emfun (or cnm-args ,args))))
2758	(next-method-p ()
2759	(not (null ,next-emfun))))
2760	(declare (ignorable (function call-next-method)
2761	(function next-method-p)))
2762	,@body))
2763
2764	(defun compute-method-function (lambda-expression)
2765	(let ((lambda-list (allow-other-keys (cadr lambda-expression)))
2766	(body (cddr lambda-expression)))
2767	(multiple-value-bind (body declarations) (parse-body body)
2768	(let ((ignorable-vars '()))
2769	(dolist (var lambda-list)
2770	(if (memq var lambda-list-keywords)
2771	(return)
2772	(push var ignorable-vars)))
2773	(push `(declare (ignorable ,@ignorable-vars)) declarations))
2774	(if (null (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux)))
2775	;; Required parameters only.
2776	(case (length lambda-list)
2777	(1
2778	`(lambda (args next-emfun)
2779	(let ((,(%car lambda-list) (%car args)))
2780	(declare (ignorable ,(%car lambda-list)))
2781	,@declarations
2782	(flet-call-next-method args next-emfun
2783	,@body))))
2784	(2
2785	`(lambda (args next-emfun)
2786	(let ((,(%car lambda-list) (%car args))
2787	(,(%cadr lambda-list) (%cadr args)))
2788	(declare (ignorable ,(%car lambda-list)
2789	,(%cadr lambda-list)))
2790	,@declarations
2791	(flet-call-next-method args next-emfun
2792	,@body))))
2793	(3
2794	`(lambda (args next-emfun)
2795	(let ((,(%car lambda-list) (%car args))
2796	(,(%cadr lambda-list) (%cadr args))
2797	(,(%caddr lambda-list) (%caddr args)))
2798	(declare (ignorable ,(%car lambda-list)
2799	,(%cadr lambda-list)
2800	,(%caddr lambda-list)))
2801	,@declarations
2802	(flet-call-next-method args next-emfun
2803	,@body))))
2804	(t
2805	`(lambda (args next-emfun)
2806	(apply #'(lambda ,lambda-list
2807	,@declarations
2808	(flet-call-next-method args next-emfun
2809	,@body))
2810	args))))
2811	`(lambda (args next-emfun)
2812	(apply #'(lambda ,lambda-list
2813	,@declarations
2814	(flet-call-next-method args next-emfun
2815	,@body))
2816	args))))))
2817
2818	(defun compute-method-fast-function (lambda-expression)
2819	(let ((lambda-list (allow-other-keys (cadr lambda-expression))))
2820	(when (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux))
2821	(return-from compute-method-fast-function nil))
2822	;; Only required args.
2823	(let ((body (cddr lambda-expression))
2824	(call-next-method-p nil)
2825	(next-method-p-p nil))
2826	(multiple-value-bind (body declarations) (parse-body body)
2827	;;; N.b. The WALK-FORM check is bogus for "hidden"
2828	;;; macroizations of CALL-NEXT-METHOD and NEXT-METHOD-P but
2829	;;; the presence of FAST-FUNCTION slots in our CLOS is
2830	;;; currently necessary to bootstrap CLOS in a way I didn't
2831	;;; manage to easily untangle.
2832	(walk-form body)
2833	(when (or call-next-method-p next-method-p-p)
2834	(return-from compute-method-fast-function nil))
2835	(let ((declaration `(declare (ignorable ,@lambda-list))))
2836	;;; 2020-10-19 refactored this expression from previous code
2837	;;; that was only declaring a fast function for one or two
2838	;;; element values of lamba-list
2839	(if (< 0 (length lambda-list) 3)
2840	`(lambda ,(cadr lambda-expression)
2841	,declaration
2842	(flet ((call-next-method (&rest args)
2843	(declare (ignore args))
2844	(error "No next method for generic function"))
2845	(next-method-p () nil))
2846	(declare (ignorable (function call-next-method)
2847	(function next-method-p)))
2848	,@body))
2849	nil))))))
2850
2851
2852	(declaim (notinline make-method-lambda))
2853	(defun make-method-lambda (generic-function method lambda-expression env)
2854	(declare (ignore generic-function method env))
2855	(values (compute-method-function lambda-expression) nil))
2856
2857
2858	;; From CLHS section 7.6.5:
2859	;; "When a generic function or any of its methods mentions &key in a lambda
2860	;; list, the specific set of keyword arguments accepted by the generic function
2861	;; varies according to the applicable methods. The set of keyword arguments
2862	;; accepted by the generic function for a particular call is the union of the
2863	;; keyword arguments accepted by all applicable methods and the keyword
2864	;; arguments mentioned after &key in the generic function definition, if any."
2865	;; Adapted from Sacla.
2866	(defun allow-other-keys (lambda-list)
2867	(if (and (member '&key lambda-list)
2868	(not (member '&allow-other-keys lambda-list)))
2869	(let* ((key-end (or (position '&aux lambda-list) (length lambda-list)))
2870	(aux-part (subseq lambda-list key-end)))
2871	`(,@(subseq lambda-list 0 key-end) &allow-other-keys ,@aux-part))
2872	lambda-list))
2873
2874	(defmacro defmethod (&rest args &environment env)
2875	(multiple-value-bind
2876	(function-name qualifiers lambda-list specializers documentation declarations body)
2877	(parse-defmethod args)
2878	(let* ((specializers-form '())
2879	(lambda-expression `(lambda ,lambda-list ,@declarations ,body))
2880	(gf (or (find-generic-function function-name nil)
2881	(class-prototype (find-class 'standard-generic-function))))
2882	(method-function
2883	(make-method-lambda gf (class-prototype (generic-function-method-class gf))
2884	lambda-expression env))
2885	(fast-function (compute-method-fast-function lambda-expression))
2886	)
2887	(dolist (specializer specializers)
2888	(cond ((and (consp specializer) (eq (car specializer) 'eql))
2889	(push `(list 'eql ,(cadr specializer)) specializers-form))
2890	(t
2891	(push `',specializer specializers-form))))
2892	(setf specializers-form `(list ,@(nreverse specializers-form)))
2893	`(progn
2894	(sys::record-source-information-for-type ',function-name '(:method ,function-name ,qualifiers ,specializers))
2895	(ensure-method ',function-name
2896	:lambda-list ',lambda-list
2897	:qualifiers ',qualifiers
2898	:specializers (canonicalize-specializers ,specializers-form)
2899	,@(when documentation `(:documentation ,documentation))
2900	:function (function ,method-function)
2901	,@(when fast-function `(:fast-function (function ,fast-function)))
2902	)))))
2903
2904	;;; Reader and writer methods
2905
2906	(defun make-instance-standard-accessor-method (method-class
2907	&key
2908	lambda-list
2909	qualifiers
2910	specializers
2911	documentation
2912	function
2913	fast-function
2914	slot-definition)
2915	(let ((method (std-allocate-instance method-class)))
2916	(setf (method-lambda-list method) lambda-list)
2917	(setf (method-qualifiers method) qualifiers)
2918	(setf (std-slot-value method 'sys::specializers)
2919	(canonicalize-specializers specializers))
2920	(setf (method-documentation method) documentation)
2921	(setf (std-slot-value method 'sys::%generic-function) nil)
2922	(setf (std-slot-value method 'sys::%function) function)
2923	(setf (std-slot-value method 'sys::fast-function) fast-function)
2924	(setf (std-slot-value method 'sys::%slot-definition) slot-definition)
2925	(setf (std-slot-value method 'sys::keywords) nil)
2926	(setf (std-slot-value method 'sys::other-keywords-p) nil)
2927	method))
2928
2929	(defun add-reader-method (class function-name slot-definition)
2930	(let* ((slot-name (slot-definition-name slot-definition))
2931	(lambda-expression
2932	(if (std-class-p class)
2933	`(lambda (object) (std-slot-value object ',slot-name))
2934	`(lambda (object) (slot-value object ',slot-name))))
2935	(method-function (compute-method-function lambda-expression))
2936	(fast-function (compute-method-fast-function lambda-expression))
2937	(method-lambda-list '(object))
2938	(gf (find-generic-function function-name nil))
2939	(initargs `(:lambda-list ,method-lambda-list
2940	:qualifiers ()
2941	:specializers (,class)
2942	:function ,(if (autoloadp 'compile)
2943	method-function
2944	(autocompile method-function))
2945	:fast-function ,(if (autoloadp 'compile)
2946	fast-function
2947	(autocompile fast-function))
2948	:slot-definition ,slot-definition))
2949	(method-class (if (std-class-p class)
2950	+the-standard-reader-method-class+
2951	(apply #'reader-method-class class slot-definition
2952	initargs))))
2953	;; required by AMOP pg. 225
2954	(assert (subtypep method-class +the-standard-reader-method-class+))
2955	(if gf
2956	(check-method-lambda-list function-name
2957	method-lambda-list
2958	(generic-function-lambda-list gf))
2959	(setf gf (ensure-generic-function function-name
2960	:lambda-list method-lambda-list)))
2961	(let ((method
2962	(if (eq method-class +the-standard-reader-method-class+)
2963	(apply #'make-instance-standard-accessor-method method-class
2964	initargs)
2965	(apply #'make-instance method-class
2966	:generic-function nil ; handled by add-method
2967	initargs))))
2968	(if (std-generic-function-p gf)
2969	(progn
2970	(std-add-method gf method)
2971	(map-dependents gf
2972	#'(lambda (dep)
2973	(update-dependent gf dep 'add-method method))))
2974	(add-method gf method))
2975	method)))
2976
2977	(defun add-writer-method (class function-name slot-definition)
2978	(let* ((slot-name (slot-definition-name slot-definition))
2979	(lambda-expression
2980	(if (std-class-p class)
2981	`(lambda (new-value object)
2982	(setf (std-slot-value object ',slot-name) new-value))
2983	`(lambda (new-value object)
2984	(setf (slot-value object ',slot-name) new-value))))
2985	(method-function (compute-method-function lambda-expression))
2986	(fast-function (compute-method-fast-function lambda-expression))
2987	(method-lambda-list '(new-value object))
2988	(gf (find-generic-function function-name nil))
2989	(initargs `(:lambda-list ,method-lambda-list
2990	:qualifiers ()
2991	:specializers (,+the-T-class+ ,class)
2992	:function ,(if (autoloadp 'compile)
2993	method-function
2994	(autocompile method-function))
2995	:fast-function ,(if (autoloadp 'compile)
2996	fast-function
2997	(autocompile fast-function))
2998	:slot-definition ,slot-definition))
2999	(method-class (if (std-class-p class)
3000	+the-standard-writer-method-class+
3001	(apply #'writer-method-class class slot-definition
3002	initargs))))
3003	;; required by AMOP pg. 242
3004	(assert (subtypep method-class +the-standard-writer-method-class+))
3005	(if gf
3006	(check-method-lambda-list function-name
3007	method-lambda-list
3008	(generic-function-lambda-list gf))
3009	(setf gf (ensure-generic-function function-name
3010	:lambda-list method-lambda-list)))
3011	(let ((method
3012	(if (eq method-class +the-standard-writer-method-class+)
3013	(apply #'make-instance-standard-accessor-method method-class
3014	initargs)
3015	(apply #'make-instance method-class
3016	:generic-function nil ; handled by add-method
3017	initargs))))
3018	(if (std-generic-function-p gf)
3019	(progn
3020	(std-add-method gf method)
3021	(map-dependents gf
3022	#'(lambda (dep)
3023	(update-dependent gf dep 'add-method method))))
3024	(add-method gf method))
3025	method)))
3026
3027	(defmacro atomic-defgeneric (function-name &rest rest)
3028	"Macro to define a generic function and 'swap it into place' after
3029	it's been fully defined with all its methods.
3030
3031	Note: the user should really use the (:method ..) method description
3032	way of defining methods; there's not much use in atomically defining
3033	generic functions without providing sensible behaviour."
3034	(let ((temp-sym (gensym)))
3035	`(progn
3036	(defgeneric ,temp-sym ,@rest)
3037	(sys::record-source-information-for-type ',function-name '(:generic-function ,function-name))
3038	,@(loop for method-form in rest
3039	when (eq (car method-form) :method)
3040	collect
3041	(multiple-value-bind (function-name qualifiers lambda-list specializers documentation declarations body)
3042	(mop::parse-defmethod `(,function-name ,@(rest method-form)))
3043	`(sys::record-source-information-for-type ',function-name '(:method ,function-name ,qualifiers ,specializers))))
3044	(let ((gf (symbol-function ',temp-sym)))
3045	;; FIXME (rudi 2012-07-08): fset gets the source location info
3046	;; to charpos 23 always (but (setf fdefinition) leaves the
3047	;; outdated source position in place, which is even worse).
3048	(fset ',function-name gf)
3049	(setf (std-slot-value gf 'sys::name) ',function-name)
3050	(fmakunbound ',temp-sym)
3051	gf))))
3052
3053	(defmacro redefine-class-forwarder (name slot &optional body-alist)
3054	"Define a generic function on a temporary symbol as an accessor
3055	for the slot `slot'. Then, when definition is complete (including
3056	allocation of methods), swap the definition in place.
3057
3058	`body-alist' can be used to override the default method bodies for given
3059	metaclasses. In substitute method bodies, `class' names the class
3060	instance and, for setters, `new-value' the new value."
3061	(let* ((setterp (consp name))
3062	(%name
3063	(intern (concatenate 'string
3064	"%"
3065	(if setterp (symbol-name 'set-) "")
3066	(symbol-name (if setterp (cadr name) name)))
3067	(find-package "SYS")))
3068	(bodies
3069	(append body-alist
3070	(if setterp
3071	`((built-in-class . (,%name new-value class))
3072	(forward-referenced-class . (,%name new-value class))
3073	(structure-class . (,%name new-value class))
3074	(standard-class . (setf (slot-value class ',slot)
3075	new-value))
3076	(funcallable-standard-class . (setf (slot-value class ',slot)
3077	new-value)))
3078	`((built-in-class . (,%name class))
3079	(forward-referenced-class . (,%name class))
3080	(structure-class . (,%name class))
3081	(standard-class . (slot-value class ',slot))
3082	(funcallable-standard-class . (slot-value class ',slot)))))))
3083	`(atomic-defgeneric ,name (,@(when setterp (list 'new-value)) class)
3084	,@(mapcar #'(lambda (class-name)
3085	`(:method (,@(when setterp (list 'new-value))
3086	(class ,class-name))
3087	,(cdr (assoc class-name bodies))))
3088	'(built-in-class forward-referenced-class structure-class
3089	standard-class funcallable-standard-class)))))
3090
3091	;;; The slot names here must agree with the ones defined in
3092	;;; StandardClass.java:layoutStandardClass.
3093	(redefine-class-forwarder class-name sys:name)
3094	;;; AMOP pg. 230
3095	(redefine-class-forwarder (setf class-name) sys:name
3096	((standard-class . (progn (reinitialize-instance class :name new-value) new-value))
3097	(funcallable-standard-class . (progn (reinitialize-instance class :name new-value) new-value))))
3098	(redefine-class-forwarder class-slots sys:slots)
3099	(redefine-class-forwarder (setf class-slots) sys:slots)
3100	(redefine-class-forwarder class-direct-slots sys:direct-slots)
3101	(redefine-class-forwarder (setf class-direct-slots) sys:direct-slots)
3102	(redefine-class-forwarder class-layout sys:layout)
3103	(redefine-class-forwarder (setf class-layout) sys:layout)
3104	(redefine-class-forwarder class-direct-superclasses sys:direct-superclasses)
3105	(redefine-class-forwarder (setf class-direct-superclasses) sys:direct-superclasses)
3106	(redefine-class-forwarder class-direct-subclasses sys:direct-subclasses)
3107	(redefine-class-forwarder (setf class-direct-subclasses) sys:direct-subclasses)
3108	(redefine-class-forwarder class-direct-methods sys:direct-methods)
3109	(redefine-class-forwarder (setf class-direct-methods) sys:direct-methods)
3110	(redefine-class-forwarder class-precedence-list sys:precedence-list)
3111	(redefine-class-forwarder (setf class-precedence-list) sys:precedence-list)
3112	(redefine-class-forwarder class-finalized-p sys:finalized-p)
3113	(redefine-class-forwarder (setf class-finalized-p) sys:finalized-p)
3114	(redefine-class-forwarder class-default-initargs sys:default-initargs)
3115	(redefine-class-forwarder (setf class-default-initargs) sys:default-initargs)
3116	(redefine-class-forwarder class-direct-default-initargs sys:direct-default-initargs)
3117	(redefine-class-forwarder (setf class-direct-default-initargs) sys:direct-default-initargs)
3118
3119	;;; Class definition
3120
3121	(defun check-duplicate-slots (slots)
3122	(flet ((canonical-slot-name (canonical-slot)
3123	(getf canonical-slot :name)))
3124	(dolist (s1 slots)
3125	(let ((name1 (canonical-slot-name s1)))
3126	(dolist (s2 (cdr (memq s1 slots)))
3127	(when (eq name1 (canonical-slot-name s2))
3128	(error 'program-error "Duplicate slot ~S" name1)))))))
3129
3130	(defun check-duplicate-default-initargs (initargs)
3131	(let ((names ()))
3132	(dolist (initarg initargs)
3133	(push (car initarg) names))
3134	(do* ((names names (cdr names))
3135	(name (car names) (car names)))
3136	((null names))
3137	(when (memq name (cdr names))
3138	(error 'program-error
3139	:format-control "Duplicate initialization argument name ~S in :DEFAULT-INITARGS."
3140	:format-arguments (list name))))))
3141
3142	(defun canonicalize-direct-superclasses (direct-superclasses)
3143	(let ((classes '()))
3144	(dolist (class-specifier direct-superclasses)
3145	(let ((class (if (classp class-specifier)
3146	class-specifier
3147	(find-class class-specifier nil))))
3148	(unless class
3149	(setf class (make-instance +the-forward-referenced-class+
3150	:name class-specifier))
3151	(setf (find-class class-specifier) class))
3152	(when (and (typep class 'built-in-class)
3153	(not (member class extensible-built-in-classes)))
3154	(error "Attempt to define a subclass of built-in-class ~S."
3155	class-specifier))
3156	(push class classes)))
3157	(nreverse classes)))
3158
3159	(atomic-defgeneric add-direct-subclass (superclass subclass)
3160	(:method ((superclass class) (subclass class))
3161	(setf (class-direct-subclasses superclass)
3162	(adjoin subclass (class-direct-subclasses superclass)))))
3163
3164	(atomic-defgeneric remove-direct-subclass (superclass subclass)
3165	(:method ((superclass class) (subclass class))
3166	(setf (class-direct-subclasses superclass)
3167	(remove subclass (class-direct-subclasses superclass)))))
3168
3169	;;; AMOP pg. 182
3170	(defun ensure-class (name &rest all-keys &key &allow-other-keys)
3171	(let ((class (find-class name nil)))
3172	;; CLHS DEFCLASS: "If a class with the same proper name already
3173	;; exists [...] the existing class is redefined." Ansi-tests
3174	;; CLASS-0309 and CLASS-0310.1 demand this behavior.
3175	(if (and class (eql (class-name class) name))
3176	(apply #'ensure-class-using-class class name all-keys)
3177	(apply #'ensure-class-using-class nil name all-keys))))
3178
3179	;;; AMOP pg. 183ff.
3180	(defgeneric ensure-class-using-class (class name &key direct-default-initargs
3181	direct-slots direct-superclasses
3182	metaclass &allow-other-keys))
3183
3184	(defmethod ensure-class-using-class :before (class name &key direct-slots
3185	direct-default-initargs
3186	&allow-other-keys)
3187	(check-duplicate-slots direct-slots)
3188	(check-duplicate-default-initargs direct-default-initargs))
3189
3190	(defmethod ensure-class-using-class ((class null) name &rest all-keys
3191	&key (metaclass +the-standard-class+)
3192	direct-superclasses
3193	&allow-other-keys)
3194	(setf all-keys (copy-list all-keys)) ; since we modify it
3195	(remf all-keys :metaclass)
3196	(unless (classp metaclass) (setf metaclass (find-class metaclass)))
3197	(let ((class (apply (if (eq metaclass +the-standard-class+)
3198	#'make-instance-standard-class
3199	#'make-instance)
3200	metaclass :name name
3201	:direct-superclasses (canonicalize-direct-superclasses
3202	direct-superclasses)
3203	all-keys)))
3204	(%set-find-class name class)
3205	class))
3206
3207	(defmethod ensure-class-using-class ((class built-in-class) name &rest all-keys
3208	&key &allow-other-keys)
3209	(declare (ignore all-keys))
3210	(error "The symbol ~S names a built-in class." name))
3211
3212	(defmethod ensure-class-using-class ((class forward-referenced-class) name
3213	&rest all-keys
3214	&key (metaclass +the-standard-class+)
3215	direct-superclasses &allow-other-keys)
3216	(setf all-keys (copy-list all-keys)) ; since we modify it
3217	(remf all-keys :metaclass)
3218	(unless (classp metaclass) (setf metaclass (find-class metaclass)))
3219	(apply #'change-class class metaclass all-keys)
3220	(apply #'reinitialize-instance class
3221	:name name
3222	:direct-superclasses (canonicalize-direct-superclasses
3223	direct-superclasses)
3224	all-keys)
3225	class)
3226
3227	(defmethod ensure-class-using-class ((class class) name
3228	&rest all-keys
3229	&key (metaclass +the-standard-class+ metaclassp)
3230	direct-superclasses
3231	&allow-other-keys)
3232	(declare (ignore name))
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	(when (and metaclassp (not (eq (class-of class) metaclass)))
3237	(error 'program-error
3238	"Trying to redefine class ~S with different metaclass."
3239	(class-name class)))
3240	(apply #'reinitialize-instance class
3241	:direct-superclasses (canonicalize-direct-superclasses direct-superclasses)
3242	all-keys)
3243	class)
3244
3245	(defmacro defclass (&whole form name direct-superclasses direct-slots &rest options)
3246	(unless (>= (length form) 3)
3247	(error 'program-error "Wrong number of arguments for DEFCLASS."))
3248	(check-declaration-type name)
3249	`(progn
3250	(sys::record-source-information-for-type ',name :class)
3251	(ensure-class ',name
3252	:direct-superclasses
3253	(canonicalize-direct-superclasses ',direct-superclasses)
3254	:direct-slots
3255	,(canonicalize-direct-slots direct-slots)
3256	,@(canonicalize-defclass-options options))))
3257
3258
3259	;;; AMOP pg. 180
3260	(defgeneric direct-slot-definition-class (class &rest initargs))
3261
3262	(defmethod direct-slot-definition-class ((class class) &rest initargs)
3263	(declare (ignore initargs))
3264	+the-standard-direct-slot-definition-class+)
3265
3266	;;; AMOP pg. 181
3267	(defgeneric effective-slot-definition-class (class &rest initargs))
3268
3269	(defmethod effective-slot-definition-class ((class class) &rest initargs)
3270	(declare (ignore initargs))
3271	+the-standard-effective-slot-definition-class+)
3272
3273	;;; AMOP pg. 224
3274	(defgeneric reader-method-class (class direct-slot &rest initargs))
3275
3276	(defmethod reader-method-class ((class standard-class)
3277	(direct-slot standard-direct-slot-definition)
3278	&rest initargs)
3279	(declare (ignore initargs))
3280	+the-standard-reader-method-class+)
3281
3282	(defmethod reader-method-class ((class funcallable-standard-class)
3283	(direct-slot standard-direct-slot-definition)
3284	&rest initargs)
3285	(declare (ignore initargs))
3286	+the-standard-reader-method-class+)
3287
3288	;;; AMOP pg. 242
3289	(defgeneric writer-method-class (class direct-slot &rest initargs))
3290
3291	(defmethod writer-method-class ((class standard-class)
3292	(direct-slot standard-direct-slot-definition)
3293	&rest initargs)
3294	(declare (ignore initargs))
3295	+the-standard-writer-method-class+)
3296
3297	(defmethod writer-method-class ((class funcallable-standard-class)
3298	(direct-slot standard-direct-slot-definition)
3299	&rest initargs)
3300	(declare (ignore initargs))
3301	+the-standard-writer-method-class+)
3302
3303	;;; Applicable methods
3304
3305	(atomic-defgeneric compute-applicable-methods (gf args)
3306	(:method ((gf standard-generic-function) args)
3307	(std-compute-applicable-methods gf args)))
3308
3309	(defgeneric compute-applicable-methods-using-classes (gf classes)
3310	(:method ((gf standard-generic-function) classes)
3311	(let ((methods '()))
3312	(dolist (method (generic-function-methods gf))
3313	(multiple-value-bind (applicable knownp)
3314	(method-applicable-using-classes-p method classes)
3315	(cond (applicable
3316	(push method methods))
3317	((not knownp)
3318	(return-from compute-applicable-methods-using-classes
3319	(values nil nil))))))
3320	(values (sort-methods methods gf classes)
3321	t))))
3322
3323
3324	;;; Slot access
3325	;;;
3326	;;; See AMOP pg. 156ff. for an overview.
3327	;;;
3328	;;; AMOP specifies these generic functions to dispatch on slot objects
3329	;;; (with the exception of slot-exists-p-using-class), although its
3330	;;; sample implementation Closette dispatches on slot names. We let
3331	;;; slot-value and friends call their gf counterparts with the effective
3332	;;; slot definition, but leave the definitions dispatching on slot name
3333	;;; in place for user convenience.
3334
3335	;;; AMOP pg. 235
3336	(defgeneric slot-value-using-class (class instance slot))
3337
3338	(defmethod slot-value-using-class ((class standard-class) instance (slot symbol))
3339	(std-slot-value instance slot))
3340	(defmethod slot-value-using-class ((class standard-class) instance
3341	(slot standard-effective-slot-definition))
3342	(let* ((location (slot-definition-location slot))
3343	(value (if (consp location)
3344	(cdr location) ; :allocation :class
3345	(standard-instance-access instance location))))
3346	(if (eq value +slot-unbound+)
3347	;; fix SLOT-UNBOUND.5 from ansi test suite
3348	(nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3349	value)))
3350
3351	(defmethod slot-value-using-class ((class funcallable-standard-class)
3352	instance (slot symbol))
3353	(std-slot-value instance slot))
3354	(defmethod slot-value-using-class ((class funcallable-standard-class) instance
3355	(slot standard-effective-slot-definition))
3356	(let* ((location (slot-definition-location slot))
3357	(value (if (consp location)
3358	(cdr location) ; :allocation :class
3359	(funcallable-standard-instance-access instance location))))
3360	(if (eq value +slot-unbound+)
3361	;; fix SLOT-UNBOUND.5 from ansi test suite
3362	(nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3363	value)))
3364
3365	(defmethod slot-value-using-class ((class structure-class) instance
3366	(slot symbol))
3367	(std-slot-value instance slot))
3368	(defmethod slot-value-using-class ((class structure-class) instance
3369	(slot standard-effective-slot-definition))
3370	(std-slot-value instance (slot-definition-name slot)))
3371
3372	;;; AMOP pg. 231
3373	(defgeneric (setf slot-value-using-class) (new-value class instance slot))
3374
3375	(defmethod (setf slot-value-using-class) (new-value
3376	(class standard-class)
3377	instance
3378	(slot symbol))
3379	(setf (std-slot-value instance slot) new-value))
3380	(defmethod (setf slot-value-using-class) (new-value
3381	(class standard-class)
3382	instance
3383	(slot standard-effective-slot-definition))
3384	(let ((location (slot-definition-location slot)))
3385	(if (consp location) ; :allocation :class
3386	(setf (cdr location) new-value)
3387	(setf (standard-instance-access instance location) new-value))))
3388
3389	(defmethod (setf slot-value-using-class) (new-value
3390	(class funcallable-standard-class)
3391	instance
3392	(slot symbol))
3393	(setf (std-slot-value instance slot) new-value))
3394	(defmethod (setf slot-value-using-class) (new-value
3395	(class funcallable-standard-class)
3396	instance
3397	(slot standard-effective-slot-definition))
3398	(let ((location (slot-definition-location slot)))
3399	(if (consp location) ; :allocation :class
3400	(setf (cdr location) new-value)
3401	(setf (funcallable-standard-instance-access instance location)
3402	new-value))))
3403
3404	(defmethod (setf slot-value-using-class) (new-value
3405	(class structure-class)
3406	instance
3407	(slot symbol))
3408	(setf (std-slot-value instance slot) new-value))
3409	(defmethod (setf slot-value-using-class) (new-value
3410	(class structure-class)
3411	instance
3412	(slot standard-effective-slot-definition))
3413	(setf (std-slot-value instance (slot-definition-name slot)) new-value))
3414
3415	;;; slot-exists-p-using-class is not specified by AMOP, and obviously
3416	;;; cannot be specialized on the slot type. Hence, its implementation
3417	;;; differs from slot-(boundp\|makunbound\|value)-using-class
3418	(defgeneric slot-exists-p-using-class (class instance slot-name))
3419
3420	(defmethod slot-exists-p-using-class (class instance slot-name)
3421	nil)
3422
3423	(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
3424	(std-slot-exists-p instance slot-name))
3425	(defmethod slot-exists-p-using-class ((class funcallable-standard-class) instance slot-name)
3426	(std-slot-exists-p instance slot-name))
3427
3428	(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
3429	(dolist (dsd (class-slots class))
3430	(when (eq (sys::dsd-name dsd) slot-name)
3431	(return-from slot-exists-p-using-class t)))
3432	nil)
3433
3434
3435	(defgeneric slot-boundp-using-class (class instance slot))
3436	(defmethod slot-boundp-using-class ((class standard-class) instance (slot symbol))
3437	(std-slot-boundp instance slot))
3438	(defmethod slot-boundp-using-class ((class standard-class) instance
3439	(slot standard-effective-slot-definition))
3440	(let ((location (slot-definition-location slot)))
3441	(if (consp location)
3442	(not (eq (cdr location) +slot-unbound+)) ; :allocation :class
3443	(not (eq (standard-instance-access instance location) +slot-unbound+)))))
3444
3445	(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3446	(slot symbol))
3447	(std-slot-boundp instance slot))
3448	(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3449	(slot standard-effective-slot-definition))
3450	(let ((location (slot-definition-location slot)))
3451	(if (consp location)
3452	(not (eq (cdr location) +slot-unbound+)) ; :allocation :class
3453	(not (eq (funcallable-standard-instance-access instance location)
3454	+slot-unbound+)))))
3455
3456	(defmethod slot-boundp-using-class ((class structure-class) instance slot)
3457	"Structure slots can't be unbound, so this method always returns T."
3458	(declare (ignore class instance slot))
3459	t)
3460
3461	(defgeneric slot-makunbound-using-class (class instance slot))
3462	(defmethod slot-makunbound-using-class ((class standard-class)
3463	instance
3464	(slot symbol))
3465	(std-slot-makunbound instance slot))
3466	(defmethod slot-makunbound-using-class ((class standard-class)
3467	instance
3468	(slot standard-effective-slot-definition))
3469	(let ((location (slot-definition-location slot)))
3470	(if (consp location)
3471	(setf (cdr location) +slot-unbound+)
3472	(setf (standard-instance-access instance location) +slot-unbound+))))
3473
3474	(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3475	instance
3476	(slot symbol))
3477	(std-slot-makunbound instance slot))
3478	(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3479	instance
3480	(slot symbol))
3481	(let ((location (slot-definition-location slot)))
3482	(if (consp location)
3483	(setf (cdr location) +slot-unbound+)
3484	(setf (funcallable-standard-instance-access instance location)
3485	+slot-unbound+))))
3486
3487	(defmethod slot-makunbound-using-class ((class structure-class)
3488	instance
3489	slot)
3490	(declare (ignore class instance slot))
3491	(error "Structure slots can't be unbound"))
3492
3493	(defgeneric slot-missing (class instance slot-name operation &optional new-value))
3494
3495	(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
3496	(declare (ignore new-value))
3497	(error "The slot ~S is missing from the class ~S." slot-name class))
3498
3499	(defgeneric slot-unbound (class instance slot-name))
3500
3501	(defmethod slot-unbound ((class t) instance slot-name)
3502	(error 'unbound-slot :instance instance :name slot-name))
3503
3504	;;; Instance creation and initialization
3505
3506	;;; AMOP pg. 168ff.
3507	(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
3508
3509	(defmethod allocate-instance ((class standard-class) &rest initargs)
3510	(declare (ignore initargs))
3511	(std-allocate-instance class))
3512
3513	(defmethod allocate-instance ((class funcallable-standard-class) &rest initargs)
3514	(declare (ignore initargs))
3515	(allocate-funcallable-instance class))
3516
3517	(defmethod allocate-instance ((class structure-class) &rest initargs)
3518	(declare (ignore initargs))
3519	(%make-structure (class-name class)
3520	(make-list (length (class-slots class))
3521	:initial-element +slot-unbound+)))
3522
3523	(defmethod allocate-instance ((class built-in-class) &rest initargs)
3524	(declare (ignore initargs))
3525	(error "Cannot allocate instances of a built-in class: ~S" class))
3526
3527	(defmethod allocate-instance :before ((class class) &rest initargs)
3528	(declare (ignore initargs))
3529	(unless (class-finalized-p class)
3530	(finalize-inheritance class)))
3531
3532	;; "The set of valid initialization arguments for a class is the set of valid
3533	;; initialization arguments that either fill slots or supply arguments to
3534	;; methods, along with the predefined initialization argument :ALLOW-OTHER-KEYS."
3535	;; 7.1.2
3536
3537	(defun calculate-allowable-initargs (gf-list args instance
3538	shared-initialize-param
3539	initargs)
3540	(let* ((methods
3541	(nconc
3542	(std-compute-applicable-methods #'shared-initialize
3543	(list* instance
3544	shared-initialize-param
3545	initargs))
3546	(mapcan #'(lambda (gf)
3547	(if (std-generic-function-p gf)
3548	(std-compute-applicable-methods gf args)
3549	(compute-applicable-methods gf args)))
3550	gf-list)))
3551	(method-keyword-args
3552	(reduce #'merge-initargs-sets
3553	(mapcar #'method-lambda-list methods)
3554	:key #'extract-lambda-list-keywords
3555	:initial-value nil))
3556	(slots-initargs
3557	(mapappend #'slot-definition-initargs
3558	(class-slots (class-of instance)))))
3559	(merge-initargs-sets
3560	(merge-initargs-sets slots-initargs method-keyword-args)
3561	'(:allow-other-keys)))) ;; allow-other-keys is always allowed
3562
3563	(defun check-initargs (gf-list args instance
3564	shared-initialize-param initargs
3565	cache call-site)
3566	"Checks the validity of `initargs' for the generic functions in `gf-list'
3567	when called with `args' by calculating the applicable methods for each gf.
3568	The applicable methods for SHARED-INITIALIZE based on `instance',
3569	`shared-initialize-param' and `initargs' are added to the list of
3570	applicable methods."
3571	(when (oddp (length initargs))
3572	(error 'program-error
3573	:format-control "Odd number of keyword arguments."))
3574	(unless (getf initargs :allow-other-keys)
3575	(multiple-value-bind (allowable-initargs present-p)
3576	(when cache
3577	(gethash (class-of instance) cache))
3578	(unless present-p
3579	(setf allowable-initargs
3580	(calculate-allowable-initargs gf-list args instance
3581	shared-initialize-param initargs))
3582	(when cache
3583	(setf (gethash (class-of instance) cache)
3584	allowable-initargs)))
3585	(unless (eq t allowable-initargs)
3586	(do* ((tail initargs (cddr tail))
3587	(initarg (car tail) (car tail)))
3588	((null tail))
3589	(unless (memq initarg allowable-initargs)
3590	(error 'program-error
3591	:format-control "Invalid initarg ~S in call to ~S with arglist ~S."
3592	:format-arguments (list initarg call-site args))))))))
3593
3594	(defun merge-initargs-sets (list1 list2)
3595	(cond
3596	((eq list1 t) t)
3597	((eq list2 t) t)
3598	(t (union list1 list2))))
3599
3600	(defun extract-lambda-list-keywords (lambda-list)
3601	"Returns a list of keywords acceptable as keyword arguments,
3602	or T when any keyword is acceptable due to presence of
3603	&allow-other-keys."
3604	(when (member '&allow-other-keys lambda-list)
3605	(return-from extract-lambda-list-keywords t))
3606	(loop with keyword-args = (cdr (memq '&key lambda-list))
3607	for key in keyword-args
3608	when (eq key '&aux) do (loop-finish)
3609	when (eq key '&allow-other-keys) do (return t)
3610	when (listp key) do (setq key (car key))
3611	collect (if (symbolp key)
3612	(make-keyword key)
3613	(car key))))
3614
3615
3616	(defgeneric make-instance (class &rest initargs &key &allow-other-keys))
3617
3618	(defmethod make-instance :before ((class class) &rest initargs)
3619	(when (oddp (length initargs))
3620	(error 'program-error :format-control "Odd number of keyword arguments."))
3621	(unless (class-finalized-p class)
3622	(finalize-inheritance class)))
3623
3624	(defun augment-initargs-with-defaults (class initargs)
3625	(let ((default-initargs '()))
3626	(dolist (initarg (class-default-initargs class))
3627	(let ((key (first initarg))
3628	(fn (third initarg)))
3629	(when (eq (getf initargs key +slot-unbound+) +slot-unbound+)
3630	(push key default-initargs)
3631	(push (funcall fn) default-initargs))))
3632	(append initargs (nreverse default-initargs))))
3633
3634	(defmethod make-instance ((class standard-class) &rest initargs)
3635	(setf initargs (augment-initargs-with-defaults class initargs))
3636	(let ((instance (std-allocate-instance class)))
3637	(check-initargs (list #'allocate-instance #'initialize-instance)
3638	(list* instance initargs)
3639	instance t initargs
3640	make-instance-initargs-cache 'make-instance)
3641	(apply #'initialize-instance instance initargs)
3642	instance))
3643
3644	(defmethod make-instance ((class funcallable-standard-class) &rest initargs)
3645	(setf initargs (augment-initargs-with-defaults class initargs))
3646	(let ((instance (allocate-funcallable-instance class)))
3647	(check-initargs (list #'allocate-instance #'initialize-instance)
3648	(list* instance initargs)
3649	instance t initargs
3650	make-instance-initargs-cache 'make-instance)
3651	(apply #'initialize-instance instance initargs)
3652	instance))
3653
3654	(defmethod make-instance ((class symbol) &rest initargs)
3655	(apply #'make-instance (find-class class) initargs))
3656
3657	(defgeneric initialize-instance (instance &rest initargs
3658	&key &allow-other-keys))
3659
3660	(defmethod initialize-instance ((instance standard-object) &rest initargs)
3661	(apply #'shared-initialize instance t initargs))
3662
3663	(defgeneric reinitialize-instance (instance &rest initargs
3664	&key &allow-other-keys))
3665
3666	;; "The system-supplied primary method for REINITIALIZE-INSTANCE checks the
3667	;; validity of initargs and signals an error if an initarg is supplied that is
3668	;; not declared as valid. The method then calls the generic function SHARED-
3669	;; INITIALIZE with the following arguments: the instance, nil (which means no
3670	;; slots should be initialized according to their initforms), and the initargs
3671	;; it received."
3672	(defmethod reinitialize-instance ((instance standard-object) &rest initargs)
3673	(check-initargs (list #'reinitialize-instance) (list* instance initargs)
3674	instance () initargs
3675	reinitialize-instance-initargs-cache 'reinitialize-instance)
3676	(apply #'shared-initialize instance () initargs))
3677
3678	(defun std-shared-initialize (instance slot-names all-keys)
3679	(when (oddp (length all-keys))
3680	(error 'program-error :format-control "Odd number of keyword arguments."))
3681	;; do a quick scan of the arguments list to see if it's a real
3682	;; 'initialization argument list' (which is not the same as
3683	;; checking initarg validity
3684	(do* ((tail all-keys (cddr tail))
3685	(initarg (car tail) (car tail)))
3686	((null tail))
3687	(unless (symbolp initarg)
3688	(error 'program-error
3689	:format-control "Initarg ~S not a symbol."
3690	:format-arguments (list initarg))))
3691	(dolist (slot (class-slots (class-of instance)))
3692	(let ((slot-name (slot-definition-name slot)))
3693	(multiple-value-bind (init-key init-value foundp)
3694	(get-properties all-keys (slot-definition-initargs slot))
3695	(if foundp
3696	(setf (slot-value instance slot-name) init-value)
3697	(unless (slot-boundp instance slot-name)
3698	(let ((initfunction (slot-definition-initfunction slot)))
3699	(when (and initfunction (or (eq slot-names t)
3700	(memq slot-name slot-names)))
3701	(setf (slot-value instance slot-name)
3702	(funcall initfunction)))))))))
3703	instance)
3704
3705	(defgeneric shared-initialize (instance slot-names
3706	&rest initargs
3707	&key &allow-other-keys))
3708
3709	(defmethod shared-initialize ((instance standard-object) slot-names
3710	&rest initargs)
3711	(std-shared-initialize instance slot-names initargs))
3712
3713	(defmethod shared-initialize ((slot slot-definition) slot-names
3714	&rest args
3715	&key name initargs initform initfunction
3716	readers writers allocation
3717	&allow-other-keys)
3718	;;Keyword args are duplicated from init-slot-definition only to have
3719	;;them checked.
3720	(declare (ignore slot-names)) ;;TODO?
3721	(declare (ignore name initargs initform initfunction readers writers allocation))
3722	;;For built-in slots
3723	(apply #'init-slot-definition slot :allow-other-keys t args)
3724	;;For user-defined slots
3725	(call-next-method))
3726
3727	;;; change-class
3728
3729	(defgeneric change-class (instance new-class &key &allow-other-keys))
3730
3731	(defmethod change-class ((old-instance standard-object) (new-class standard-class)
3732	&rest initargs)
3733	(let ((old-slots (class-slots (class-of old-instance)))
3734	(new-slots (class-slots new-class))
3735	(new-instance (allocate-instance new-class)))
3736	;; "The values of local slots specified by both the class CTO and the class
3737	;; CFROM are retained. If such a local slot was unbound, it remains
3738	;; unbound."
3739	(dolist (new-slot new-slots)
3740	(when (instance-slot-p new-slot)
3741	(let* ((slot-name (slot-definition-name new-slot))
3742	(old-slot (find slot-name old-slots :key 'slot-definition-name)))
3743	;; "The values of slots specified as shared in the class CFROM and as
3744	;; local in the class CTO are retained."
3745	(when (and old-slot (slot-boundp old-instance slot-name))
3746	(setf (slot-value new-instance slot-name)
3747	(slot-value old-instance slot-name))))))
3748	(swap-slots old-instance new-instance)
3749	(rotatef (std-instance-layout new-instance)
3750	(std-instance-layout old-instance))
3751	(apply #'update-instance-for-different-class
3752	new-instance old-instance initargs)
3753	old-instance))
3754
3755	(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
3756	(apply #'change-class instance (find-class new-class) initargs))
3757
3758	(defgeneric update-instance-for-different-class (old new
3759	&rest initargs
3760	&key &allow-other-keys))
3761
3762	(defmethod update-instance-for-different-class
3763	((old standard-object) (new standard-object) &rest initargs)
3764	(let ((added-slots
3765	(remove-if #'(lambda (slot-name)
3766	(slot-exists-p old slot-name))
3767	(mapcar 'slot-definition-name
3768	(class-slots (class-of new))))))
3769	(check-initargs (list #'update-instance-for-different-class)
3770	(list old new initargs)
3771	new added-slots initargs
3772	nil 'update-instance-for-different-class)
3773	(apply #'shared-initialize new added-slots initargs)))
3774
3775	;;; make-instances-obsolete
3776
3777	(defgeneric make-instances-obsolete (class))
3778
3779	(defmethod make-instances-obsolete ((class standard-class))
3780	(%make-instances-obsolete class))
3781	(defmethod make-instances-obsolete ((class funcallable-standard-class))
3782	(%make-instances-obsolete class))
3783	(defmethod make-instances-obsolete ((class symbol))
3784	(make-instances-obsolete (find-class class))
3785	class)
3786
3787	;;; update-instance-for-redefined-class
3788
3789	(defgeneric update-instance-for-redefined-class (instance
3790	added-slots
3791	discarded-slots
3792	property-list
3793	&rest initargs
3794	&key
3795	&allow-other-keys))
3796
3797	(defmethod update-instance-for-redefined-class ((instance standard-object)
3798	added-slots
3799	discarded-slots
3800	property-list
3801	&rest initargs)
3802	(check-initargs (list #'update-instance-for-redefined-class)
3803	(list* instance added-slots discarded-slots
3804	property-list initargs)
3805	instance added-slots initargs
3806	nil 'update-instance-for-redefined-class)
3807	(apply #'shared-initialize instance added-slots initargs))
3808
3809	;;; Methods having to do with class metaobjects.
3810
3811	(defmethod initialize-instance :after ((class standard-class) &rest args)
3812	(apply #'std-after-initialization-for-classes class args))
3813
3814	(defmethod initialize-instance :after ((class funcallable-standard-class)
3815	&rest args)
3816	(apply #'std-after-initialization-for-classes class args))
3817
3818	(defmethod reinitialize-instance :before ((class standard-class)
3819	&rest all-keys
3820	&key direct-superclasses)
3821	(check-initargs (list #'allocate-instance
3822	#'initialize-instance)
3823	(list* class all-keys)
3824	class t all-keys
3825	nil 'reinitialize-instance)
3826	(dolist (superclass (set-difference (class-direct-superclasses class)
3827	direct-superclasses))
3828	(remove-direct-subclass superclass class))
3829	(dolist (superclass (set-difference direct-superclasses
3830	(class-direct-superclasses class)))
3831	(add-direct-subclass superclass class)))
3832
3833	(defmethod reinitialize-instance :before ((class funcallable-standard-class)
3834	&rest all-keys
3835	&key direct-superclasses)
3836	(check-initargs (list #'allocate-instance
3837	#'initialize-instance)
3838	(list* class all-keys)
3839	class t all-keys
3840	nil 'reinitialize-instance)
3841	(dolist (superclass (set-difference (class-direct-superclasses class)
3842	direct-superclasses))
3843	(remove-direct-subclass superclass class))
3844	(dolist (superclass (set-difference direct-superclasses
3845	(class-direct-superclasses class)))
3846	(add-direct-subclass superclass class)))
3847
3848	(defun std-after-reinitialization-for-classes (class
3849	&rest all-keys
3850	&key (direct-superclasses nil direct-superclasses-p)
3851	(direct-slots nil direct-slots-p)
3852	(direct-default-initargs nil direct-default-initargs-p)
3853	&allow-other-keys)
3854	(remhash class make-instance-initargs-cache)
3855	(remhash class reinitialize-instance-initargs-cache)
3856	(%make-instances-obsolete class)
3857	(setf (class-finalized-p class) nil)
3858	(when direct-superclasses-p
3859	(let* ((old-supers (class-direct-superclasses class))
3860	(new-supers (canonicalize-direct-superclass-list
3861	class direct-superclasses)))
3862	(setf (class-direct-superclasses class) new-supers)
3863	(dolist (old-superclass (set-difference old-supers new-supers))
3864	(remove-direct-subclass old-superclass class))
3865	(dolist (new-superclass (set-difference new-supers old-supers))
3866	(add-direct-subclass new-superclass class))))
3867	(when direct-slots-p
3868	;; FIXME: maybe remove old reader and writer methods?
3869	(let ((slots (mapcar #'(lambda (slot-properties)
3870	(apply #'make-direct-slot-definition class slot-properties))
3871	direct-slots)))
3872	(setf (class-direct-slots class) slots)
3873	(dolist (direct-slot slots)
3874	(dolist (reader (slot-definition-readers direct-slot))
3875	(add-reader-method class reader direct-slot))
3876	(dolist (writer (slot-definition-writers direct-slot))
3877	(add-writer-method class writer direct-slot)))))
3878	(when direct-default-initargs-p
3879	(setf (class-direct-default-initargs class) direct-default-initargs))
3880	(maybe-finalize-class-subtree class)
3881	(map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3882
3883	(defmethod reinitialize-instance :after ((class standard-class)
3884	&rest all-keys)
3885	(apply #'std-after-reinitialization-for-classes class all-keys))
3886
3887	(defmethod reinitialize-instance :after ((class funcallable-standard-class)
3888	&rest all-keys)
3889	(apply #'std-after-reinitialization-for-classes class all-keys))
3890
3891	(defmethod reinitialize-instance :before ((gf standard-generic-function)
3892	&key
3893	(lambda-list nil lambda-list-supplied-p)
3894	&allow-other-keys)
3895	(when lambda-list-supplied-p
3896	(unless (or (null (generic-function-methods gf))
3897	(lambda-lists-congruent-p lambda-list
3898	(generic-function-lambda-list gf)))
3899	(error "The lambda list ~S is incompatible with the existing methods of ~S."
3900	lambda-list gf))))
3901
3902	(defmethod reinitialize-instance :after ((gf standard-generic-function)
3903	&rest all-keys)
3904	(map-dependents gf #'(lambda (dep) (update-dependent gf dep all-keys))))
3905
3906	;;; Finalize inheritance
3907
3908	(atomic-defgeneric finalize-inheritance (class)
3909	(:method ((class standard-class))
3910	(std-finalize-inheritance class))
3911	(:method ((class funcallable-standard-class))
3912	(std-finalize-inheritance class)))
3913
3914	;;; Default initargs
3915
3916	;;; AMOP pg. 174
3917	(atomic-defgeneric compute-default-initargs (class)
3918	(:method ((class standard-class))
3919	(std-compute-default-initargs class))
3920	(:method ((class funcallable-standard-class))
3921	(std-compute-default-initargs class)))
3922
3923	;;; Class precedence lists
3924
3925	(defgeneric compute-class-precedence-list (class))
3926	(defmethod compute-class-precedence-list ((class standard-class))
3927	(std-compute-class-precedence-list class))
3928	(defmethod compute-class-precedence-list ((class funcallable-standard-class))
3929	(std-compute-class-precedence-list class))
3930
3931	;;; Slot inheritance
3932
3933	(defgeneric compute-slots (class))
3934	(defmethod compute-slots ((class standard-class))
3935	(std-compute-slots class))
3936	(defmethod compute-slots ((class funcallable-standard-class))
3937	(std-compute-slots class))
3938
3939	(defgeneric compute-effective-slot-definition (class name direct-slots))
3940	(defmethod compute-effective-slot-definition
3941	((class standard-class) name direct-slots)
3942	(std-compute-effective-slot-definition class name direct-slots))
3943	(defmethod compute-effective-slot-definition
3944	((class funcallable-standard-class) name direct-slots)
3945	(std-compute-effective-slot-definition class name direct-slots))
3946
3947	;;; Methods having to do with generic function invocation.
3948
3949	(defgeneric compute-discriminating-function (gf))
3950	(defmethod compute-discriminating-function ((gf standard-generic-function))
3951	(std-compute-discriminating-function gf))
3952
3953	(defgeneric method-more-specific-p (gf method1 method2 required-classes))
3954
3955	(defmethod method-more-specific-p ((gf standard-generic-function)
3956	method1 method2 required-classes)
3957	(let ((method-indices
3958	(argument-precedence-order-indices
3959	(generic-function-argument-precedence-order gf)
3960	(getf (analyze-lambda-list (generic-function-lambda-list gf))
3961	':required-args))))
3962	(std-method-more-specific-p method1 method2 required-classes method-indices)))
3963
3964	;;; AMOP pg. 176
3965	(defgeneric compute-effective-method (gf method-combination methods))
3966	(defmethod compute-effective-method ((gf standard-generic-function) method-combination methods)
3967	(std-compute-effective-method gf method-combination methods))
3968
3969	(defgeneric compute-applicable-methods (gf args))
3970	(defmethod compute-applicable-methods ((gf standard-generic-function) args)
3971	(std-compute-applicable-methods gf args))
3972
3973	;;; AMOP pg. 207
3974	(atomic-defgeneric make-method-lambda (generic-function method lambda-expression environment)
3975	(:method ((generic-function standard-generic-function)
3976	(method standard-method)
3977	lambda-expression environment)
3978	(declare (ignore environment))
3979	(values (compute-method-function lambda-expression) nil)))
3980
3981
3982	;;; Slot definition accessors
3983
3984	(defmacro slot-definition-dispatch (slot-definition std-form generic-form)
3985	`(let (($cl (class-of ,slot-definition)))
3986	(case $cl
3987	((+the-standard-slot-definition-class+
3988	+the-standard-direct-slot-definition-class+
3989	+the-standard-effective-slot-definition-class+)
3990	,std-form)
3991	(t ,generic-form))))
3992
3993	(atomic-defgeneric slot-definition-allocation (slot-definition)
3994	(:method ((slot-definition slot-definition))
3995	(slot-definition-dispatch slot-definition
3996	(std-slot-value slot-definition 'sys::allocation)
3997	(slot-value slot-definition 'sys::allocation))))
3998
3999	(atomic-defgeneric (setf slot-definition-allocation) (value slot-definition)
4000	(:method (value (slot-definition slot-definition))
4001	(slot-definition-dispatch slot-definition
4002	(setf (std-slot-value slot-definition 'sys::allocation) value)
4003	(setf (slot-value slot-definition 'sys::allocation) value))))
4004
4005	(atomic-defgeneric slot-definition-initargs (slot-definition)
4006	(:method ((slot-definition slot-definition))
4007	(slot-definition-dispatch slot-definition
4008	(std-slot-value slot-definition 'sys::initargs)
4009	(slot-value slot-definition 'sys::initargs))))
4010
4011	(atomic-defgeneric (setf slot-definition-initargs) (value slot-definition)
4012	(:method (value (slot-definition slot-definition))
4013	(slot-definition-dispatch slot-definition
4014	(setf (std-slot-value slot-definition 'sys::initargs) value)
4015	(setf (slot-value slot-definition 'sys::initargs) value))))
4016
4017	(atomic-defgeneric slot-definition-initform (slot-definition)
4018	(:method ((slot-definition slot-definition))
4019	(slot-definition-dispatch slot-definition
4020	(std-slot-value slot-definition 'sys::initform)
4021	(slot-value slot-definition 'sys::initform))))
4022
4023	(atomic-defgeneric (setf slot-definition-initform) (value slot-definition)
4024	(:method (value (slot-definition slot-definition))
4025	(slot-definition-dispatch slot-definition
4026	(setf (std-slot-value slot-definition 'sys::initform) value)
4027	(setf (slot-value slot-definition 'sys::initform) value))))
4028
4029	(atomic-defgeneric slot-definition-initfunction (slot-definition)
4030	(:method ((slot-definition slot-definition))
4031	(slot-definition-dispatch slot-definition
4032	(std-slot-value slot-definition 'sys::initfunction)
4033	(slot-value slot-definition 'sys::initfunction))))
4034
4035	(atomic-defgeneric (setf slot-definition-initfunction) (value slot-definition)
4036	(:method (value (slot-definition slot-definition))
4037	(slot-definition-dispatch slot-definition
4038	(setf (std-slot-value slot-definition 'sys::initfunction) value)
4039	(setf (slot-value slot-definition 'sys::initfunction) value))))
4040
4041	(atomic-defgeneric slot-definition-name (slot-definition)
4042	(:method ((slot-definition slot-definition))
4043	(slot-definition-dispatch slot-definition
4044	(std-slot-value slot-definition 'sys:name)
4045	(slot-value slot-definition 'sys:name))))
4046
4047	(atomic-defgeneric (setf slot-definition-name) (value slot-definition)
4048	(:method (value (slot-definition slot-definition))
4049	(slot-definition-dispatch slot-definition
4050	(setf (std-slot-value slot-definition 'sys:name) value)
4051	(setf (slot-value slot-definition 'sys:name) value))))
4052
4053	(atomic-defgeneric slot-definition-readers (slot-definition)
4054	(:method ((slot-definition slot-definition))
4055	(slot-definition-dispatch slot-definition
4056	(std-slot-value slot-definition 'sys::readers)
4057	(slot-value slot-definition 'sys::readers))))
4058
4059	(atomic-defgeneric (setf slot-definition-readers) (value slot-definition)
4060	(:method (value (slot-definition slot-definition))
4061	(slot-definition-dispatch slot-definition
4062	(setf (std-slot-value slot-definition 'sys::readers) value)
4063	(setf (slot-value slot-definition 'sys::readers) value))))
4064
4065	(atomic-defgeneric slot-definition-writers (slot-definition)
4066	(:method ((slot-definition slot-definition))
4067	(slot-definition-dispatch slot-definition
4068	(std-slot-value slot-definition 'sys::writers)
4069	(slot-value slot-definition 'sys::writers))))
4070
4071	(atomic-defgeneric (setf slot-definition-writers) (value slot-definition)
4072	(:method (value (slot-definition slot-definition))
4073	(slot-definition-dispatch slot-definition
4074	(setf (std-slot-value slot-definition 'sys::writers) value)
4075	(setf (slot-value slot-definition 'sys::writers) value))))
4076
4077	(atomic-defgeneric slot-definition-allocation-class (slot-definition)
4078	(:method ((slot-definition slot-definition))
4079	(slot-definition-dispatch slot-definition
4080	(std-slot-value slot-definition 'sys::allocation-class)
4081	(slot-value slot-definition 'sys::allocation-class))))
4082
4083	(atomic-defgeneric (setf slot-definition-allocation-class)
4084	(value slot-definition)
4085	(:method (value (slot-definition slot-definition))
4086	(slot-definition-dispatch slot-definition
4087	(setf (std-slot-value slot-definition 'sys::allocation-class) value)
4088	(setf (slot-value slot-definition 'sys::allocation-class) value))))
4089
4090	(atomic-defgeneric slot-definition-location (slot-definition)
4091	(:method ((slot-definition slot-definition))
4092	(slot-definition-dispatch slot-definition
4093	(std-slot-value slot-definition 'sys::location)
4094	(slot-value slot-definition 'sys::location))))
4095
4096	(atomic-defgeneric (setf slot-definition-location) (value slot-definition)
4097	(:method (value (slot-definition slot-definition))
4098	(slot-definition-dispatch slot-definition
4099	(setf (std-slot-value slot-definition 'sys::location) value)
4100	(setf (slot-value slot-definition 'sys::location) value))))
4101
4102	(atomic-defgeneric slot-definition-type (slot-definition)
4103	(:method ((slot-definition slot-definition))
4104	(slot-definition-dispatch slot-definition
4105	(std-slot-value slot-definition 'sys::%type)
4106	(slot-value slot-definition 'sys::%type))))
4107
4108	(atomic-defgeneric (setf slot-definition-type) (value slot-definition)
4109	(:method (value (slot-definition slot-definition))
4110	(slot-definition-dispatch slot-definition
4111	(setf (std-slot-value slot-definition 'sys::%type) value)
4112	(setf (slot-value slot-definition 'sys::%type) value))))
4113
4114	(atomic-defgeneric slot-definition-documentation (slot-definition)
4115	(:method ((slot-definition slot-definition))
4116	(slot-definition-dispatch slot-definition
4117	(std-slot-value slot-definition 'sys:%documentation)
4118	(slot-value slot-definition 'sys:%documentation))))
4119
4120	(atomic-defgeneric (setf slot-definition-documentation) (value slot-definition)
4121	(:method (value (slot-definition slot-definition))
4122	(slot-definition-dispatch slot-definition
4123	(setf (std-slot-value slot-definition 'sys:%documentation) value)
4124	(setf (slot-value slot-definition 'sys:%documentation) value))))
4125
4126
4127	;;; Conditions.
4128
4129	(defmacro define-condition (name (&rest parent-types) (&rest slot-specs) &body options)
4130	(let ((parent-types (or parent-types '(condition)))
4131	(report nil))
4132	(dolist (option options)
4133	(when (eq (car option) :report)
4134	(setf report (cadr option))
4135	(setf options (delete option options :test #'equal))
4136	(return)))
4137	(typecase report
4138	(null
4139	`(progn
4140	(sys::record-source-information-for-type ',name :condition)
4141	(defclass ,name ,parent-types ,slot-specs ,@options)
4142	',name))
4143	(string
4144	`(progn
4145	(sys::record-source-information-for-type ',name :condition)
4146	(defclass ,name ,parent-types ,slot-specs ,@options)
4147	(defmethod print-object ((condition ,name) stream)
4148	(if print-escape
4149	(call-next-method)
4150	(progn (write-string ,report stream) condition)))
4151	',name))
4152	(t
4153	`(progn
4154	(sys::record-source-information-for-type ',name :condition)
4155	(defclass ,name ,parent-types ,slot-specs ,@options)
4156	(defmethod print-object ((condition ,name) stream)
4157	(if print-escape
4158	(call-next-method)
4159	(funcall #',report condition stream)))
4160	',name)))))
4161
4162	(defun make-condition (type &rest initargs)
4163	(or (%make-condition type initargs)
4164	(let ((class (if (symbolp type) (find-class type) type)))
4165	(apply #'make-instance class initargs))))
4166
4167	;; Adapted from SBCL.
4168	;; Originally defined in signal.lisp. Redefined here now that we have MAKE-CONDITION.
4169	(defun coerce-to-condition (datum arguments default-type fun-name)
4170	(cond ((typep datum 'condition)
4171	(when arguments
4172	(error 'simple-type-error
4173	:datum arguments
4174	:expected-type 'null
4175	:format-control "You may not supply additional arguments when giving ~S to ~S."
4176	:format-arguments (list datum fun-name)))
4177	datum)
4178	((symbolp datum)
4179	(apply #'make-condition datum arguments))
4180	((or (stringp datum) (functionp datum))
4181	(make-condition default-type
4182	:format-control datum
4183	:format-arguments arguments))
4184	(t
4185	(error 'simple-type-error
4186	:datum datum
4187	:expected-type '(or symbol string)
4188	:format-control "Bad argument to ~S: ~S."
4189	:format-arguments (list fun-name datum)))))
4190
4191	(defgeneric make-load-form (object &optional environment))
4192
4193	(defmethod make-load-form ((object t) &optional environment)
4194	(declare (ignore environment))
4195	(apply #'no-applicable-method #'make-load-form (list object)))
4196
4197	(defmethod make-load-form ((class class) &optional environment)
4198	(declare (ignore environment))
4199	(let ((name (class-name class)))
4200	(unless (and name (eq (find-class name nil) class))
4201	(error 'simple-type-error
4202	:format-control "Can't use anonymous or undefined class as a constant: ~S."
4203	:format-arguments (list class)))
4204	`(find-class ',name)))
4205
4206	(defun invalid-method-error (method format-control &rest args)
4207	(let ((message (apply #'format nil format-control args)))
4208	(error "Invalid method error for ~S:~% ~A" method message)))
4209
4210	(defun method-combination-error (format-control &rest args)
4211	(let ((message (apply #'format nil format-control args)))
4212	(error "Method combination error in CLOS dispatch:~% ~A" message)))
4213
4214
4215	(atomic-defgeneric no-applicable-method (generic-function &rest args)
4216	(:method (generic-function &rest args)
4217	(error "There is no applicable method for the generic function ~S ~
4218	when called with arguments ~S."
4219	generic-function
4220	args)))
4221
4222
4223	;;; FIXME (rudi 2012-01-28): this can be a function, it only needs to
4224	;;; use standard accessor functions
4225	(defgeneric find-method (generic-function
4226	qualifiers
4227	specializers
4228	&optional errorp))
4229
4230	(defmethod find-method ((generic-function standard-generic-function)
4231	qualifiers specializers &optional (errorp t))
4232	(%find-method generic-function qualifiers specializers errorp))
4233
4234	(defgeneric find-method ((generic-function symbol)
4235	qualifiers specializers &optional (errorp t))
4236	(find-method (find-generic-function generic-function errorp)
4237	qualifiers specializers errorp))
4238
4239	;;; AMOP pg. 167
4240	(defgeneric add-method (generic-function method))
4241
4242	(defmethod add-method :before ((generic-function generic-function)
4243	(method method))
4244	(when (and (method-generic-function method)
4245	(not (eql generic-function (method-generic-function method))))
4246	(error 'simple-error
4247	:format-control "~S is already a method of ~S, cannot add to ~S."
4248	:format-arguments (list method (method-generic-function method)
4249	generic-function)))
4250	(check-method-lambda-list (generic-function-name generic-function)
4251	(method-lambda-list method)
4252	(generic-function-lambda-list generic-function)))
4253
4254	(defmethod add-method ((generic-function standard-generic-function)
4255	(method standard-method))
4256	(std-add-method generic-function method))
4257
4258	(defmethod add-method :after ((generic-function generic-function)
4259	(method method))
4260	(map-dependents generic-function
4261	#'(lambda (dep) (update-dependent generic-function dep
4262	'add-method method))))
4263
4264	(defgeneric remove-method (generic-function method))
4265
4266	(defmethod remove-method ((generic-function standard-generic-function)
4267	(method standard-method))
4268	(std-remove-method generic-function method))
4269
4270	(defmethod remove-method :after ((generic-function generic-function)
4271	(method method))
4272	(map-dependents generic-function
4273	#'(lambda (dep) (update-dependent generic-function dep
4274	'remove-method method))))
4275
4276	;; See describe.lisp.
4277	(defgeneric describe-object (object stream))
4278
4279	;; FIXME
4280	(defgeneric no-next-method (generic-function method &rest args))
4281
4282	(atomic-defgeneric function-keywords (method)
4283	(:method ((method standard-method))
4284	(std-function-keywords method)))
4285
4286	(setf gf-initialize-instance (symbol-function 'initialize-instance))
4287	(setf gf-allocate-instance (symbol-function 'allocate-instance))
4288	(setf gf-shared-initialize (symbol-function 'shared-initialize))
4289	(setf gf-reinitialize-instance (symbol-function 'reinitialize-instance))
4290	(setf clos-booting nil)
4291
4292	(atomic-defgeneric class-prototype (class)
4293	(:method ((class standard-class))
4294	(allocate-instance class))
4295	(:method ((class funcallable-standard-class))
4296	(allocate-instance class))
4297	(:method ((class structure-class))
4298	(allocate-instance class))
4299	(:method :before (class)
4300	(unless (class-finalized-p class)
4301	(error "~@<~S is not finalized.~:@>" class))))
4302
4303
4304
4305
4306
4307	(defmethod shared-initialize :before ((instance generic-function)
4308	slot-names
4309	&key lambda-list argument-precedence-order
4310	&allow-other-keys)
4311	(check-argument-precedence-order lambda-list argument-precedence-order))
4312
4313	(defmethod shared-initialize :after ((instance standard-generic-function)
4314	slot-names
4315	&key (lambda-list nil lambda-list-p)
4316	(argument-precedence-order nil a-p-o-p)
4317	(method-combination '(standard))
4318	&allow-other-keys)
4319	(when lambda-list-p
4320	(let* ((plist (analyze-lambda-list lambda-list))
4321	(required-args (getf plist ':required-args)))
4322	(setf (std-slot-value instance 'sys::required-args) required-args)
4323	(setf (std-slot-value instance 'sys::optional-args)
4324	(getf plist :optional-args))
4325	(setf (std-slot-value instance 'sys::argument-precedence-order)
4326	(or (and a-p-o-p argument-precedence-order) required-args))))
4327	(unless (typep (generic-function-method-combination instance)
4328	'method-combination)
4329	;; this fixes (make-instance 'standard-generic-function) -- the
4330	;; constructor of StandardGenericFunction sets this slot to '(standard)
4331	(setf (std-slot-value instance 'sys::%method-combination)
4332	(find-method-combination
4333	instance (car method-combination) (cdr method-combination))))
4334	(finalize-standard-generic-function instance))
4335
4336	;;; Readers for generic function metaobjects
4337	;;; AMOP pg. 216ff.
4338	(atomic-defgeneric generic-function-argument-precedence-order (generic-function)
4339	(:method ((generic-function standard-generic-function))
4340	(std-slot-value generic-function 'sys::argument-precedence-order)))
4341
4342	(atomic-defgeneric generic-function-declarations (generic-function)
4343	(:method ((generic-function standard-generic-function))
4344	(std-slot-value generic-function 'sys::declarations)))
4345
4346	(atomic-defgeneric generic-function-lambda-list (generic-function)
4347	(:method ((generic-function standard-generic-function))
4348	(std-slot-value generic-function 'sys::lambda-list)))
4349
4350	(atomic-defgeneric generic-function-method-class (generic-function)
4351	(:method ((generic-function standard-generic-function))
4352	(std-slot-value generic-function 'sys::method-class)))
4353
4354	(atomic-defgeneric generic-function-method-combination (generic-function)
4355	(:method ((generic-function standard-generic-function))
4356	(std-slot-value generic-function 'sys::%method-combination)))
4357
4358	(atomic-defgeneric generic-function-methods (generic-function)
4359	(:method ((generic-function standard-generic-function))
4360	(std-slot-value generic-function 'sys::methods)))
4361
4362	(atomic-defgeneric generic-function-name (generic-function)
4363	(:method ((generic-function standard-generic-function))
4364	(slot-value generic-function 'sys::name)))
4365
4366	(atomic-defgeneric generic-function-required-arguments (generic-function)
4367	(:method ((generic-function standard-generic-function))
4368	(std-slot-value generic-function 'sys::required-args)))
4369
4370	(atomic-defgeneric generic-function-optional-arguments (generic-function)
4371	(:method ((generic-function standard-generic-function))
4372	(std-slot-value generic-function 'sys::optional-args)))
4373
4374	;;; AMOP pg. 231
4375	(defgeneric (setf generic-function-name) (new-value gf)
4376	(:method (new-value (gf generic-function))
4377	(reinitialize-instance gf :name new-value)))
4378
4379	;;; Readers for Method Metaobjects
4380	;;; AMOP pg. 218ff.
4381
4382	(atomic-defgeneric method-function (method)
4383	(:method ((method standard-method))
4384	(std-method-function method)))
4385
4386	(atomic-defgeneric method-generic-function (method)
4387	(:method ((method standard-method))
4388	(std-method-generic-function method)))
4389
4390	(atomic-defgeneric method-lambda-list (method)
4391	(:method ((method standard-method))
4392	(std-slot-value method 'sys::lambda-list)))
4393
4394	(atomic-defgeneric method-specializers (method)
4395	(:method ((method standard-method))
4396	(std-method-specializers method)))
4397
4398	(atomic-defgeneric method-qualifiers (method)
4399	(:method ((method standard-method))
4400	(std-method-qualifiers method)))
4401
4402	(atomic-defgeneric accessor-method-slot-definition (method)
4403	(:method ((method standard-accessor-method))
4404	(std-accessor-method-slot-definition method)))
4405
4406
4407	;;; find-method-combination
4408
4409	;;; AMOP pg. 191
4410	(atomic-defgeneric find-method-combination (gf name options)
4411	(:method (gf (name symbol) options)
4412	(std-find-method-combination gf name options)))
4413
4414	;;; specializer-direct-method and friends.
4415
4416	;;; AMOP pg. 237
4417	(defgeneric specializer-direct-generic-functions (specializer))
4418
4419	(defmethod specializer-direct-generic-functions ((specializer class))
4420	(delete-duplicates (mapcar #'method-generic-function
4421	(class-direct-methods specializer))))
4422
4423	(defmethod specializer-direct-generic-functions ((specializer eql-specializer))
4424	(delete-duplicates (mapcar #'method-generic-function
4425	(slot-value specializer 'direct-methods))))
4426
4427	;;; AMOP pg. 238
4428	(defgeneric specializer-direct-methods (specializer))
4429
4430	(defmethod specializer-direct-methods ((specializer class))
4431	(class-direct-methods specializer))
4432
4433	(defmethod specializer-direct-methods ((specializer eql-specializer))
4434	(slot-value specializer 'direct-methods))
4435
4436	;;; AMOP pg. 165
4437	(atomic-defgeneric add-direct-method (specializer method)
4438	(:method ((specializer class) (method method))
4439	(pushnew method (class-direct-methods specializer)))
4440	(:method ((specializer eql-specializer) (method method))
4441	(pushnew method (slot-value specializer 'direct-methods))))
4442
4443
4444	;;; AMOP pg. 227
4445	(atomic-defgeneric remove-direct-method (specializer method)
4446	(:method ((specializer class) (method method))
4447	(setf (class-direct-methods specializer)
4448	(remove method (class-direct-methods specializer))))
4449	(:method ((specializer eql-specializer) (method method))
4450	(setf (slot-value specializer 'direct-methods)
4451	(remove method (slot-value specializer 'direct-methods)))))
4452
4453	;;; The Dependent Maintenance Protocol (AMOP pg. 160ff.)
4454
4455	(defvar dependents (make-hash-table :test 'eq :weakness :key))
4456
4457	;;; AMOP pg. 164
4458	(defgeneric add-dependent (metaobject dependent))
4459	(defmethod add-dependent ((metaobject standard-class) dependent)
4460	(pushnew dependent (gethash metaobject dependents nil)))
4461	(defmethod add-dependent ((metaobject funcallable-standard-class) dependent)
4462	(pushnew dependent (gethash metaobject dependents nil)))
4463	(defmethod add-dependent ((metaobject standard-generic-function) dependent)
4464	(pushnew dependent (gethash metaobject dependents nil)))
4465
4466	;;; AMOP pg. 225
4467	(defgeneric remove-dependent (metaobject dependent))
4468	(defmethod remove-dependent ((metaobject standard-class) dependent)
4469	(setf (gethash metaobject dependents)
4470	(delete dependent (gethash metaobject dependents nil) :test #'eq)))
4471	(defmethod remove-dependent ((metaobject funcallable-standard-class) dependent)
4472	(setf (gethash metaobject dependents)
4473	(delete dependent (gethash metaobject dependents nil) :test #'eq)))
4474	(defmethod remove-dependent ((metaobject standard-generic-function) dependent)
4475	(setf (gethash metaobject dependents)
4476	(delete dependent (gethash metaobject dependents nil) :test #'eq)))
4477
4478	;;; AMOP pg. 210
4479	(atomic-defgeneric map-dependents (metaobject function)
4480	(:method ((metaobject standard-class) function)
4481	(dolist (dependent (gethash metaobject dependents nil))
4482	(funcall function dependent)))
4483	(:method ((metaobject funcallable-standard-class) function)
4484	(dolist (dependent (gethash metaobject dependents nil))
4485	(funcall function dependent)))
4486	(:method ((metaobject standard-generic-function) function)
4487	(dolist (dependent (gethash metaobject dependents nil))
4488	(funcall function dependent))))
4489
4490	;;; AMOP pg. 239
4491	(defgeneric update-dependent (metaobject dependent &rest initargs))
4492
4493
4494	;;; ensure-generic-function(-using-class), AMOP pg. 185ff.
4495	(defgeneric ensure-generic-function-using-class (generic-function function-name
4496	&key
4497	argument-precedence-order
4498	declarations documentation
4499	generic-function-class
4500	lambda-list method-class
4501	method-combination
4502	name
4503	&allow-other-keys))
4504
4505	(defmethod ensure-generic-function-using-class
4506	((generic-function generic-function)
4507	function-name
4508	&rest all-keys
4509	&key (generic-function-class (class-of generic-function))
4510	(method-class (generic-function-method-class generic-function))
4511	(method-combination (generic-function-method-combination generic-function))
4512	&allow-other-keys)
4513	(setf all-keys (copy-list all-keys)) ; since we modify it
4514	(remf all-keys :generic-function-class)
4515	(unless (classp generic-function-class)
4516	(setf generic-function-class (find-class generic-function-class)))
4517	(unless (classp method-class) (setf method-class (find-class method-class)))
4518	(unless (eq generic-function-class (class-of generic-function))
4519	(error "The class ~S is incompatible with the existing class (~S) of ~S."
4520	generic-function-class (class-of generic-function) generic-function))
4521	;; We used to check for changes in method class here, but CLHS says:
4522	;; "If function-name specifies a generic function that has a different
4523	;; value for the :method-class argument, the value is changed, but any
4524	;; existing methods are not changed."
4525	(unless (typep method-combination 'method-combination)
4526	(setf method-combination
4527	(find-method-combination generic-function
4528	(car method-combination)
4529	(cdr method-combination))))
4530	(apply #'reinitialize-instance generic-function
4531	:method-combination method-combination
4532	:method-class method-class
4533	all-keys)
4534	generic-function)
4535
4536	(defmethod ensure-generic-function-using-class ((generic-function null)
4537	function-name
4538	&rest all-keys
4539	&key (generic-function-class +the-standard-generic-function-class+)
4540	&allow-other-keys)
4541	(setf all-keys (copy-list all-keys)) ; since we modify it
4542	(remf all-keys :generic-function-class)
4543	(unless (classp generic-function-class)
4544	(setf generic-function-class (find-class generic-function-class)))
4545	(when (and (null clos-booting) (fboundp function-name))
4546	(if (or (autoloadp function-name)
4547	(and (consp function-name)
4548	(eq 'setf (first function-name))
4549	(autoload-ref-p (second function-name))))
4550	(fmakunbound function-name)
4551	(progn
4552	(cerror "Redefine as generic function" "~A already names an ordinary function, macro, or special operator." function-name)
4553	(fmakunbound function-name)
4554	)))
4555	(apply (if (eq generic-function-class +the-standard-generic-function-class+)
4556	#'make-instance-standard-generic-function
4557	#'make-instance)
4558	generic-function-class :name function-name all-keys))
4559
4560	(defun ensure-generic-function (function-name &rest all-keys
4561	&key
4562	lambda-list generic-function-class
4563	method-class
4564	method-combination
4565	argument-precedence-order
4566	declarations
4567	documentation
4568	&allow-other-keys)
4569	(declare (ignore lambda-list generic-function-class method-class
4570	method-combination argument-precedence-order declarations
4571	documentation))
4572	(apply #'ensure-generic-function-using-class
4573	(find-generic-function function-name nil)
4574	function-name all-keys))
4575
4576	;;; SLIME compatibility functions.
4577
4578	(defun %method-generic-function (method)
4579	(method-generic-function method))
4580
4581	(defun %method-function (method)
4582	(method-function method))
4583
4584	(eval-when (:compile-toplevel :load-toplevel :execute)
4585	(require "MOP"))
4586
4587	(provide "CLOS")
4588

Note: See TracBrowser for help on using the repository browser.

Download in other formats: