0.9.7.25:
[sbcl.git] / src / pcl / generic-functions.lisp
1 ;;;; Mostly this file contains generic functions. The exceptions are hacks.
2
3 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; more information.
5
6 ;;;; This software is in the public domain and is provided with absolutely no
7 ;;;; warranty. See the COPYING and CREDITS files for more information.
8
9 (in-package "SB-PCL")
10 \f
11 ;;;; class predicates
12
13 (defgeneric class-eq-specializer-p (object))
14
15 (defgeneric classp (object))
16
17 (defgeneric condition-class-p (object))
18
19 (defgeneric eql-specializer-p (object))
20
21 (defgeneric exact-class-specializer-p (object))
22
23 (defgeneric forward-referenced-class-p (object))
24
25 (defgeneric funcallable-standard-class-p (object))
26
27 (defgeneric generic-function-p (object))
28
29 (defgeneric legal-lambda-list-p (object x))
30
31 (defgeneric method-combination-p (object))
32
33 (defgeneric method-p (object))
34
35 (defgeneric short-method-combination-p (object))
36
37 (defgeneric slot-class-p (object))
38
39 (defgeneric specializerp (object))
40
41 (defgeneric standard-accessor-method-p (object))
42
43 (defgeneric standard-boundp-method-p (object))
44
45 (defgeneric standard-class-p (object))
46
47 (defgeneric standard-generic-function-p (object))
48
49 (defgeneric standard-method-p (object))
50
51 (defgeneric standard-reader-method-p (object))
52
53 (defgeneric standard-writer-method-p (object))
54
55 (defgeneric structure-class-p (object))
56 \f
57 ;;;; readers
58
59 (defgeneric accessor-method-slot-definition (standard-accessor-method))
60
61 (defgeneric class-can-precede-list (pcl-class))
62
63 (defgeneric class-defstruct-constructor (structure-class))
64
65 (defgeneric class-defstruct-form (structure-class))
66
67 (defgeneric class-direct-subclasses (class))
68
69 (defgeneric class-direct-superclasses (class))
70
71 (defgeneric class-eq-specializer (class))
72
73 (defgeneric class-incompatible-superclass-list (pcl-class))
74
75 (defgeneric class-name (class))
76
77 (defgeneric class-precedence-list (pcl-class))
78
79 (defgeneric class-wrapper (pcl-class))
80
81 (defgeneric definition-source (definition-source-mixin))
82
83 (defgeneric eql-specializer-object (eql-specializer))
84
85 (defgeneric generic-function-declarations (standard-generic-function))
86
87 (defgeneric generic-function-method-class (standard-generic-function))
88
89 (defgeneric generic-function-method-combination (standard-generic-function))
90
91 (defgeneric generic-function-methods (standard-generic-function))
92
93 (defgeneric generic-function-name (standard-generic-function))
94
95 (defgeneric gf-arg-info (standard-generic-function))
96
97 (defgeneric gf-dfun-state (standard-generic-function))
98
99 (defgeneric generic-function-initial-methods (standard-generic-function))
100
101 (defgeneric long-method-combination-function (long-method-combination))
102
103 (defgeneric method-combination-documentation (standard-method-combination))
104
105 (defgeneric method-combination-options (standard-method-combination))
106
107 (defgeneric method-combination-type (standard-method-combination))
108
109 (defgeneric method-fast-function (standard-method))
110
111 (defgeneric method-generic-function (standard-method))
112
113 (defgeneric object-plist (plist-mixin))
114
115 (defgeneric short-combination-identity-with-one-argument
116   (short-method-combination))
117
118 (defgeneric short-combination-operator (short-method-combination))
119
120 (defgeneric slot-definition-boundp-function (effective-slot-definition))
121
122 (defgeneric slot-definition-class (slot-definition))
123
124 (defgeneric slot-definition-defstruct-accessor-symbol
125   (structure-slot-definition))
126
127 (defgeneric slot-definition-initargs (slot-definition))
128
129 (defgeneric slot-definition-initform (slot-definition))
130
131 (defgeneric slot-definition-initfunction (slot-definition))
132
133 (defgeneric slot-definition-internal-reader-function
134   (structure-slot-definition))
135
136 (defgeneric slot-definition-internal-writer-function
137   (structure-slot-definition))
138
139 (defgeneric slot-definition-location (standard-effective-slot-definition))
140
141 (defgeneric slot-definition-name (slot-definition))
142
143 (defgeneric slot-definition-reader-function (effective-slot-definition))
144
145 (defgeneric slot-definition-readers (slot-definition))
146
147 (defgeneric slot-definition-type (slot-definition))
148
149 (defgeneric slot-definition-writer-function (effective-slot-definition))
150
151 (defgeneric slot-definition-writers (slot-definition))
152
153 (defgeneric specializer-object (class-eq-specializer))
154
155 (defgeneric specializer-type (specializer))
156 \f
157 ;;;; writers
158
159 (defgeneric (setf class-defstruct-constructor) (new-value structure-class))
160
161 (defgeneric (setf class-defstruct-form) (new-value structure-class))
162
163 (defgeneric (setf class-direct-slots) (new-value slot-class))
164
165 (defgeneric (setf class-incompatible-superclass-list) (new-value pcl-class))
166
167 (defgeneric (setf class-name) (new-value class))
168
169 (defgeneric (setf class-slots) (new-value slot-class))
170
171 (defgeneric (setf generic-function-method-class) (new-value
172                                                   standard-generic-function))
173
174 (defgeneric (setf generic-function-method-combination)
175   (new-value standard-generic-function))
176
177 (defgeneric (setf generic-function-declarations) (new-value
178                                                   standard-generic-function))
179
180 (defgeneric (setf generic-function-methods) (new-value
181                                              standard-generic-function))
182
183 (defgeneric (setf generic-function-name) (new-value standard-generic-function))
184
185 (defgeneric (setf gf-dfun-state) (new-value standard-generic-function))
186
187 (defgeneric (setf generic-function-initial-methods)
188   (new-value standard-generic-function))
189
190 (defgeneric (setf method-generic-function) (new-value standard-method))
191
192 (defgeneric (setf object-plist) (new-value plist-mixin))
193
194 (defgeneric (setf slot-definition-allocation) (new-value
195                                                standard-slot-definition))
196
197 (defgeneric (setf slot-definition-boundp-function)
198   (new-value effective-slot-definition))
199
200 (defgeneric (setf slot-definition-class) (new-value slot-definition))
201
202 (defgeneric (setf slot-definition-defstruct-accessor-symbol)
203   (new-value structure-slot-definition))
204
205 (defgeneric (setf slot-definition-initargs) (new-value slot-definition))
206
207 (defgeneric (setf slot-definition-initform) (new-value slot-definition))
208
209 (defgeneric (setf slot-definition-initfunction) (new-value slot-definition))
210
211 (defgeneric (setf slot-definition-internal-reader-function)
212   (new-value structure-slot-definition))
213
214 (defgeneric (setf slot-definition-internal-writer-function)
215   (new-value structure-slot-definition))
216
217 (defgeneric (setf slot-definition-location)
218   (new-value standard-effective-slot-definition))
219
220 (defgeneric (setf slot-definition-name) (new-value slot-definition))
221
222 (defgeneric (setf slot-definition-reader-function) (new-value
223                                                     effective-slot-definition))
224
225 (defgeneric (setf slot-definition-readers) (new-value slot-definition))
226
227 (defgeneric (setf slot-definition-type) (new-value slot-definition))
228
229 (defgeneric (setf slot-definition-writer-function)
230   (new-value effective-slot-definition))
231
232 (defgeneric (setf slot-definition-writers) (new-value slot-definition))
233 \f
234 ;;;; 1 argument
235
236 (defgeneric accessor-method-class (method))
237
238 (defgeneric accessor-method-slot-name (m))
239
240 (defgeneric class-default-initargs (class))
241
242 (defgeneric class-direct-default-initargs (class))
243
244 (defgeneric class-direct-slots (class))
245
246 (defgeneric class-finalized-p (class))
247
248 (defgeneric class-prototype (class))
249
250 (defgeneric class-slot-cells (class))
251
252 (defgeneric class-slots (class))
253
254 (defgeneric compute-class-precedence-list (root))
255
256 (defgeneric compute-default-initargs (class))
257
258 (defgeneric compute-discriminating-function (gf))
259
260 (defgeneric compute-discriminating-function-arglist-info (generic-function))
261
262 (defgeneric compute-slots (class))
263
264 (defgeneric finalize-inheritance (class))
265
266 (defgeneric function-keywords (method))
267
268 (defgeneric generic-function-argument-precedence-order (gf))
269
270 (defgeneric generic-function-lambda-list (gf))
271
272 (defgeneric generic-function-pretty-arglist (generic-function))
273
274 (defgeneric gf-fast-method-function-p (gf))
275
276 (defgeneric initialize-internal-slot-functions (slotd))
277
278 (defgeneric make-instances-obsolete (class))
279
280 (defgeneric method-function (method))
281
282 (defgeneric method-lambda-list (m))
283
284 (defgeneric method-pretty-arglist (method))
285
286 (defgeneric method-qualifiers (m))
287
288 (defgeneric method-specializers (m))
289
290 (defgeneric raw-instance-allocator (class))
291
292 (defgeneric slot-definition-allocation (slotd))
293
294 (defgeneric slots-fetcher (class))
295
296 (defgeneric specializer-class (specializer))
297
298 (defgeneric specializer-direct-generic-functions (specializer))
299
300 (defgeneric specializer-direct-methods (specializer))
301
302 (defgeneric specializer-method-table (specializer))
303
304 (defgeneric update-constructors (class))
305
306 (defgeneric wrapper-fetcher (class))
307 \f
308 ;;;; 2 arguments
309
310 (defgeneric add-dependent (metaobject dependent))
311
312 (defgeneric add-direct-method (specializer method))
313
314 (defgeneric add-direct-subclass (class subclass))
315
316 (defgeneric add-method (generic-function method))
317
318 (defgeneric (setf class-slot-cells) (new-value class))
319
320 (defgeneric class-slot-value (class slot-name))
321
322 (defgeneric compatible-meta-class-change-p (class proto-new-class))
323
324 (defgeneric compute-applicable-methods (generic-function arguments))
325
326 (defgeneric compute-applicable-methods-using-classes
327   (generic-function classes))
328
329 (defgeneric compute-effective-slot-definition-initargs (class direct-slotds))
330
331 (defgeneric describe-object (object stream))
332
333 (defgeneric direct-slot-definition-class (class &rest initargs))
334
335 (defgeneric effective-slot-definition-class (class &rest initargs))
336
337 (defgeneric legal-documentation-p (object x))
338
339 (defgeneric legal-method-function-p (object x))
340
341 (defgeneric legal-qualifier-p (object x))
342
343 (defgeneric legal-qualifiers-p (object x))
344
345 (defgeneric legal-slot-name-p (object x))
346
347 (defgeneric legal-specializer-p (object x))
348
349 (defgeneric legal-specializers-p (object x))
350
351 (defgeneric make-boundp-method-function (class slot-name))
352
353 (defgeneric make-reader-method-function (class slot-name))
354
355 (defgeneric make-writer-method-function (class slot-name))
356
357 (defgeneric map-dependents (metaobject function))
358
359 (defgeneric remove-boundp-method (class generic-function))
360
361 (defgeneric remove-dependent (metaobject dependent))
362
363 (defgeneric remove-direct-method (specializer method))
364
365 (defgeneric remove-direct-subclass (class subclass))
366
367 (defgeneric remove-method (generic-function method))
368
369 (defgeneric remove-reader-method (class generic-function))
370
371 (defgeneric remove-writer-method (class generic-function))
372
373 (defgeneric same-specializer-p (specl1 specl2))
374
375 (defgeneric slot-accessor-function (slotd type))
376
377 (defgeneric slot-accessor-std-p (slotd type))
378
379 ;;; This controls DESCRIBE-OBJECT (SLOT-OBJECT STREAM) behavior.
380 (defgeneric slots-to-inspect (class object))
381
382 (defgeneric update-gf-dfun (class gf))
383
384 (defgeneric validate-superclass (class superclass))
385
386 (defgeneric (setf documentation) (new-value slotd doc-type)
387   (:argument-precedence-order doc-type slotd new-value))
388
389 (defgeneric documentation (slotd doc-type)
390   (:argument-precedence-order doc-type slotd))
391 \f
392 ;;;; 3 arguments
393
394 (defgeneric add-boundp-method (class generic-function slot-name))
395
396 (defgeneric add-reader-method (class generic-function slot-name))
397
398 (defgeneric add-writer-method (class generic-function slot-name))
399
400 (defgeneric (setf class-slot-value) (nv class slot-name))
401
402 ;;; CMUCL comment (from Gerd Moellmann/Pierre Mai, 2002-10-19):
403 ;;;
404 ;;; According to AMOP, COMPUTE-EFFECTIVE-METHOD should return two
405 ;;; values.  Alas, the second value is only vaguely described in AMOP,
406 ;;; and, when asked on 2002-10-18, Gregor Kiczales said he couldn't
407 ;;; remember what the second value was supposed to be.  So, PCL's
408 ;;; COMPUTE-EFFECTIVE-METHOD returns one value as do Allegro and
409 ;;; Lispworks.
410 (defgeneric compute-effective-method (generic-function
411                                       combin
412                                       applicable-methods))
413
414 (defgeneric compute-effective-slot-definition (class name dslotds))
415
416 (defgeneric compute-slot-accessor-info (slotd type gf))
417
418 (defgeneric default-initargs (class initargs defaults))
419
420 (defgeneric find-method-combination (generic-function type options))
421
422 (defgeneric invalid-qualifiers (generic-function combin method))
423
424 (defgeneric (setf slot-accessor-function) (function slotd type))
425
426 (defgeneric (setf slot-accessor-std-p) (value slotd type))
427
428 (defgeneric slot-boundp-using-class (class object slotd))
429
430 (defgeneric slot-makunbound-using-class (class object slotd))
431
432 (defgeneric slot-unbound (class instance slot-name))
433
434 (defgeneric slot-value-using-class (class object slotd))
435 \f
436 ;;;; 4 arguments
437
438 (defgeneric make-method-lambda (proto-generic-function
439                                 proto-method
440                                 lambda-expression
441                                 environment))
442
443 (defgeneric (setf slot-value-using-class) (new-value class object slotd))
444 \f
445 ;;;; 5 arguments
446
447 (defgeneric make-method-initargs-form (proto-generic-function
448                                        proto-method
449                                        lambda-expression
450                                        lambda-list
451                                        environment))
452 \f
453 ;;;; optional arguments
454
455 (defgeneric get-method (generic-function
456                         qualifiers
457                         specializers
458                         &optional errorp))
459
460 (defgeneric find-method (generic-function
461                          qualifiers
462                          specializers
463                          &optional errorp))
464
465 (defgeneric slot-missing (class
466                           instance
467                           slot-name
468                           operation
469                           &optional new-value))
470 \f
471 ;;;; &KEY arguments
472
473 (defgeneric allocate-instance (class &rest initargs))
474
475 (defgeneric ensure-class-using-class (class
476                                       name
477                                       &rest args
478                                       &key &allow-other-keys))
479
480 (defgeneric ensure-generic-function-using-class (generic-function
481                                                  fun-name
482                                                  &key &allow-other-keys))
483
484 (defgeneric initialize-instance (gf &key &allow-other-keys))
485
486 (defgeneric make-instance (class &rest initargs &key &allow-other-keys))
487
488 (defgeneric change-class (instance new-class-name &rest initargs &key &allow-other-keys))
489
490 (defgeneric no-applicable-method (generic-function &rest args))
491
492 (defgeneric no-next-method (generic-function method &rest args))
493
494 (defgeneric no-primary-method (generic-function &rest args))
495
496 (defgeneric reader-method-class (class direct-slot &rest initargs))
497
498 (defgeneric reinitialize-instance (gf &rest args &key &allow-other-keys))
499
500 (defgeneric shared-initialize (generic-function
501                                slot-names
502                                &key &allow-other-keys))
503
504 (defgeneric update-dependent (metaobject dependent &rest initargs))
505
506 (defgeneric update-instance-for-different-class (previous
507                                                  current
508                                                  &rest initargs))
509
510 (defgeneric update-instance-for-redefined-class (instance
511                                                  added-slots
512                                                  discarded-slots
513                                                  property-list
514                                                  &rest initargs))
515
516 (defgeneric writer-method-class (class direct-slot &rest initargs))