| blob | 68b376592f518a51a5a956bd0d44582f98bf1022 |
1 ;;; eieio-core.el --- Core implementation for eieio -*- lexical-binding:t -*-
3 ;; Copyright (C) 1995-1996, 1998-2015 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
6 ;; Version: 1.4
7 ;; Keywords: OO, lisp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
25 ;;
26 ;; The "core" part of EIEIO is the implementation for the object
27 ;; system (such as eieio-defclass, or eieio-defmethod) but not the
28 ;; base classes for the object system, which are defined in EIEIO.
29 ;;
30 ;; See the commentary for eieio.el for more about EIEIO itself.
32 ;;; Code:
39 "Like `defalias', but with less side-effects.
40 More specifically, it has no side-effects at all when the new function
41 definition is the same (`eq') as the old one."
46 ;;;
47 ;; A few functions that are better in the official EIEIO src, but
48 ;; used from the core.
53 \f
54 ;;;
55 ;; Variable declarations.
56 ;;
61 "Non-nil to throw an error if an encountered tag is unsupported.
62 This may prevent classes from CLOS applications from being used with EIEIO
66 "If non-nil, skip all slot typechecking.
67 Set this to t permanently if a program is functioning well to get a
68 small speed increase. This variable is also used internally to handle
79 eieio-unbound
83 ;; This is a bootstrap for eieio-default-superclass so it has a value
84 ;; while it is being built itself.
87 ;;;
88 ;; Class currently in scope.
89 ;;
90 ;; When invoking methods, the running method needs to know which class
91 ;; is currently in scope. Generally this is the class of the method
92 ;; being called, but 'call-next-method' needs to query this state,
93 ;; and change it to be then next super class up.
94 ;;
95 ;; Thus, the scoped class is a stack that needs to be managed.
101 "Return the class currently in scope, or nil."
105 "Set CLASS as the currently scoped class while executing FORMS."
113 ;;;
114 ;; Field Accessors
115 ;;
126 doc prefix)))
128 defs)
137 parent children
139 ;; @todo
140 ;; the word "public" here is leftovers from the very first version.
141 ;; Get rid of it!
162 This will speed up instantiation time as only a `copy-sequence' will
163 be needed, instead of looping over all the values and setting them
171 name))
173 ;; FIXME: The constants below should have an `eieio-' prefix added!!
179 (defconst method-num-lists 4 "Number of indexes into methods vector in which groups of functions are kept.")
186 "Convert a specialized KEY into a generic method key."
190 ))
192 \f
193 ;;; Important macros used internally in eieio.
194 ;;
205 "Internal: Return the class vector from the CLASS symbol."
206 ;; No check: If eieio gets this far, it has probably been checked already.
210 "Return non-nil if CLASS is a valid class vector.
211 CLASS is a symbol."
212 ;; this new method is faster since it doesn't waste time checking lots of
213 ;; things.
220 ;; I think this is supposed to return a symbol, but to me CLASS is a symbol,
221 ;; and I wanted a string. Arg!
226 "Return parent classes to CLASS with no check."
233 "Return t if OBJ is of class-type CLASS with no error checking."
237 "Return the symbol representing the constructor of CLASS."
241 "Return non-nil if symbol METHOD is a generic function.
242 Only methods have the symbol `eieio-method-obarray' as a property
243 \(which contains a list of all bindings to that method type.)"
247 "Return t if symbol METHOD is a generic function with only primary methods.
248 Only methods have the symbol `eieio-method-obarray' as a property (which
249 contains a list of all bindings to that method type.)
250 Methods with only primary implementations are executed in an optimized way."
260 ))
263 "Return t if symbol METHOD is a generic function with only primary methods.
264 Only methods have the symbol `eieio-method-obarray' as a property (which
265 contains a list of all bindings to that method type.)
266 Methods with only primary implementations are executed in an optimized way."
276 ))
279 "Return from LIST the found OPTION, or nil if it doesn't exist."
283 "Return the value stored for CLASS' OPTION.
284 Return nil if that option doesn't exist."
288 "Return non-nil if OBJ is an EIEIO object."
296 "Return non-nil if CLASS is abstract.
297 Abstract classes cannot be instantiated."
301 "Return the invocation order of CLASS.
302 Abstract classes cannot be instantiated."
307 \f
308 ;;;
309 ;; Class Creation
314 ;; We autoload this because it's used in `make-autoload'.
315 ;;;###autoload
317 "Create autoload symbols for the EIEIO class CNAME.
318 SUPERCLASSES are the superclasses that CNAME inherits from.
319 DOC is the docstring for CNAME.
320 This function creates a mock-class for CNAME and adds it into
321 SUPERCLASSES as children.
322 It creates an autoload function for CNAME's constructor."
323 ;; Assume we've already debugged inputs.
327 )
329 nil ;; Do nothing if we already have this class.
331 ;; Create the class in NEWC, but don't fill anything else in.
336 ;; No parents?
339 clear-parent t)
340 )
342 ;; Hook our new class into the existing structures so we can
343 ;; autoload it later.
347 ;; TODO - If we create an autoload that is in the map, that
348 ;; map needs to be cleared!
351 ;; Does our parent exist?
354 ;; Create a symbol for this parent, and then store this
355 ;; parent on that symbol.
360 )
362 ;; We have a parent, save the child in there.
367 ;; save parent in child
369 )
371 ;; turn this into a usable self-pointing symbol
374 ;; Store the new class vector definition into the symbol. We need to
375 ;; do this first so that we can call defmethod for the accessor.
376 ;; The vector will be updated by the following while loop and will not
377 ;; need to be stored a second time.
380 ;; Clear the parent
383 ;; Create an autoload on top of our constructor function.
389 ))))
392 "If class CNAME is in an autoload state, load its file."
400 list)))))
403 ;; FIXME: Most of this should be moved to the `defclass' macro.
404 "Define CNAME as a new subclass of SUPERCLASSES.
405 SLOTS are the slots residing in that class definition, and options or
406 documentation OPTIONS-AND-DOC is the toplevel documentation for this class.
407 See `defclass' for more information."
408 ;; Run our eieio-hook each time, and clear it when we are done.
409 ;; This way people can add hooks safely if they want to modify eieio
410 ;; or add definitions when eieio is loaded or something like that.
426 ;; If this class already existed, and we are updating its structure,
427 ;; make sure we keep the old child list. This can cause bugs, but
428 ;; if no new slots are created, it also saves time, and prevents
429 ;; method table breakage, particularly when the users is only
430 ;; byte compiling an EIEIO file.
433 ;; If the old class did not exist, but did exist in the autoload map, then adopt those children.
434 ;; This is like the above, but deals with autoloads nicely.
441 ))
442 )
450 )
455 options-and-doc))
462 ;; bad class
464 ;; good parent class...
465 ;; save new child in parent
469 ;; Get custom groups, and store them into our local copy.
472 ;; save parent in child
476 ;; Reverse the list of our parents so that they are prioritized in
477 ;; the same order as specified in the code.
479 ;; If there is nothing to loop over, then inherit from the
480 ;; default superclass.
482 ;; adopt the default parent here, but clear it later...
484 ;; save new child in parent
488 ;; save parent in child
491 ;; turn this into a usable self-pointing symbol
494 ;; These two tests must be created right away so we can have self-
495 ;; referencing classes. ei, a class whose slot can contain only
496 ;; pointers to itself.
498 ;; Create the test function
506 ;; Make sure the method invocation order is a valid value.
510 ))
512 ;; Create a handy child test too
517 "Test OBJ to see if it an object is a child of type %s"
518 cname)
522 ;; Create a handy list of the class test too
527 "Test OBJ to see if it a list of objects which are a child of type %s"
528 cname)
531 ;; Loop over all the elements of the input list, test
532 ;; each to make sure it is a child of the desired object class.
537 ans)))))
539 ;; When using typep, (typep OBJ 'myclass) returns t for objects which
540 ;; are subclasses of myclass. For our predicates, however, it is
541 ;; important for EIEIO to be backwards compatible, where
542 ;; myobject-p, and myobject-child-p are different.
543 ;; "cl" uses this technique to specify symbols with specific typep
544 ;; test, so we can let typep have the CLOS documented behavior
545 ;; while keeping our above predicate clean.
547 ;; FIXME: It would be cleaner to use `cl-deftype' here.
551 ;; Before adding new slots, let's add all the methods and classes
552 ;; in from the parent class.
555 ;; Store the new class vector definition into the symbol. We need to
556 ;; do this first so that we can call defmethod for the accessor.
557 ;; The vector will be updated by the following while loop and will not
558 ;; need to be stored a second time.
561 ;; Query each slot in the declaration list and mangle into the
562 ;; class structure I have defined.
570 eieio-unbound)))
584 )
590 :initform
591 :initarg
592 :documentation
593 :protection
594 :reader
595 :writer
596 :allocation
597 :type
598 :custom
599 :label
600 :group
601 :printer
602 :allow-nil-initform
607 ;; Clean up the meaning of protection.
614 ;; Make sure the :allocation parameter has a valid value.
618 ;; The default type specifier is supposed to be t, meaning anything.
621 ;; Label is nil, or a string
625 ;; Is there an initarg, but allocation of class?
629 ;; intern the symbol so we can use it blankly
632 ;; The customgroup should be a list of symbols
637 ;; The customgroup better be a symbol, or list of symbols.
641 customg)
643 ;; First up, add this slot into our new class.
647 ;; We need to id the group, and store them in a group list attribute.
650 ;; Anyone can have an accessor function. This creates a function
651 ;; of the specified name, and also performs a `defsetf' if applicable
652 ;; so that users can `setf' the space returned by this function.
659 "Retrieves the slot `%s' from an object of class `%s'"
660 name cname)
663 ;; Else - Some error? nil?
664 nil)))
666 ;; FIXME: We should move more of eieio-defclass into the
667 ;; defclass macro so we don't have to use `eval' and require
668 ;; `gv' at run-time.
671 eieio--store)))))
673 ;; If a writer is defined, then create a generic method of that
674 ;; name whose purpose is to set the value of the slot.
677 writer nil cname
680 name cname)
682 ;; If a reader is defined, then create a generic method
683 ;; of that name whose purpose is to access this slot value.
686 reader nil cname
689 name cname)
691 )
694 ;; Now that everything has been loaded up, all our lists are backwards!
695 ;; Fix that up now.
702 (setf (eieio--class-public-custom-label newc) (nreverse (eieio--class-public-custom-label newc)))
703 (setf (eieio--class-public-custom-group newc) (nreverse (eieio--class-public-custom-group newc)))
708 ;; The storage for class-class-allocation-type needs to be turned into
709 ;; a vector now.
713 ;; Also, take class allocated values, and vectorize them for speed.
717 ;; Attach slot symbols into an obarray, and store the index of
718 ;; this slot as the variable slot in this new symbol. We need to
719 ;; know about primes, because obarrays are best set in vectors of
720 ;; prime number length, and we also need to make our vector small
721 ;; to save space, and also optimal for the number of items we have.
741 )
743 ;; Create the constructor function
745 ;; Abstract classes cannot be instantiated. Say so.
754 ;; Non-abstract classes need a constructor.
759 )
761 ;; Set up a specialized doc string.
762 ;; Use stored value since it is calculated in a non-trivial way
766 ;; Save the file location where this class is defined.
768 load-file-name
769 buffer-file-name)))
775 ;; We have a list of custom groups. Store them into the options.
782 ;; Set up the options we have collected.
785 ;; if this is a superclass, clear out parent (which was set to the
786 ;; default superclass eieio-default-superclass)
789 ;; Create the cached default object.
791 nil)))
796 ;; All type-checking has been done to our satisfaction
797 ;; before this call. Don't waste our time in this call..
801 ;; Return our new class object
802 ;; newc
803 cname
804 ))
807 "Whether the default value VAL should be evaluated for use."
811 "For SLOT, signal if SPEC does not match VALUE.
812 If SKIPNIL is non-nil, then if VALUE is nil return t instead."
821 "Add into NEWC attribute A.
822 If A already exists in NEWC, then do nothing. If it doesn't exist,
823 then also add in D (default), DOC, TYPE, CUST, LABEL, CUSTG, PRINT, PROT, and INIT arg.
824 Argument ALLOC specifies if the slot is allocated per instance, or per class.
825 If optional DEFAULTOVERRIDE is non-nil, then if A exists in NEWC,
826 we must override its value for a default.
827 Optional argument SKIPNIL indicates if type checking should be skipped
828 if default value is nil."
829 ;; Make sure we duplicate those items that are sequences.
832 ;; This copy can fail on a cons cell with a non-cons in the cdr. Let's skip it if it doesn't work.
838 ;; To prevent override information w/out specification of storage,
839 ;; we need to do this little hack.
843 ;; In this case, we modify the INSTANCE version of a given slot.
847 ;; Only add this element if it is so-far unique
856 (setf (eieio--class-public-custom-label newc) (cons label (eieio--class-public-custom-label newc)))
857 (setf (eieio--class-public-custom-group newc) (cons custg (eieio--class-public-custom-group newc)))
860 (setf (eieio--class-initarg-tuples newc) (cons (cons init a) (eieio--class-initarg-tuples newc)))
861 )
862 ;; When defaultoverride is true, we are usually adding new local
863 ;; attributes which must override the default value of any slot
864 ;; passed in by one of the parent classes.
866 ;; There is a match, and we must override the old value.
871 nil))
873 )
876 a)
877 ;; If type is passed in, is it the same?
881 "Child slot type `%s' does not match inherited type `%s' for `%s'"
882 type tp a)))
883 ;; If we have a repeat, only update the initarg...
887 ;; If we have a new initarg, check for it.
891 ;; Replace the CAR of the associate INITA.
892 ;;(message "Initarg: %S replace %s" inita init)
894 ))
896 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
897 ;; checked and SHOULD match the superclass
898 ;; protection. Otherwise an error is thrown. However
899 ;; I wonder if a more flexible schedule might be
900 ;; implemented.
901 ;;
902 ;; EML - We used to have (if prot... here,
903 ;; but a prot of 'nil means public.
904 ;;
906 )
909 prot super-prot a)))
910 ;; End original PLN
912 ;; PLN Tue Jun 26 11:57:06 2007 :
913 ;; Do a non redundant combination of ancient custom
914 ;; groups and new ones.
926 ;; End PLN
928 ;; PLN Mon Jun 25 22:44:34 2007 : If a new cust is
929 ;; set, simply replaces the old one.
931 ;; (message "Custom type redefined to %s" cust)
934 ;; If a new label is specified, it simply replaces
935 ;; the old one.
937 ;; (message "Custom label redefined to %s" label)
939 ;; End PLN
941 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
942 ;; doc is specified, simply replaces the old one.
944 ;;(message "Documentation redefined to %s" doc)
946 doc))
947 ;; End PLN
949 ;; If a new printer is specified, it simply replaces
950 ;; the old one.
952 ;; (message "printer redefined to %s" print)
955 )))
956 ))
958 ;; CLASS ALLOCATED SLOTS
963 ;; Here we have found a :class version of a slot. This
964 ;; requires a very different approach.
966 (setf (eieio--class-class-allocation-doc newc) (cons doc (eieio--class-class-allocation-doc newc)))
967 (setf (eieio--class-class-allocation-type newc) (cons type (eieio--class-class-allocation-type newc)))
968 (setf (eieio--class-class-allocation-custom newc) (cons cust (eieio--class-class-allocation-custom newc)))
969 (setf (eieio--class-class-allocation-custom-label newc) (cons label (eieio--class-class-allocation-custom-label newc)))
970 (setf (eieio--class-class-allocation-custom-group newc) (cons custg (eieio--class-class-allocation-custom-group newc)))
971 (setf (eieio--class-class-allocation-protection newc) (cons prot (eieio--class-class-allocation-protection newc)))
972 ;; Default value is stored in the 'values section, since new objects
973 ;; can't initialize from this element.
974 (setf (eieio--class-class-allocation-values newc) (cons value (eieio--class-class-allocation-values newc))))
976 ;; There is a match, and we must override the old value.
983 nil))
985 nil)))
988 a)
989 ;; If type is passed in, is it the same?
993 "Child slot type `%s' does not match inherited type `%s' for `%s'"
994 type tp a)))
995 ;; EML - Note: the only reason to override a class bound slot
996 ;; is to change the default, so allow unbound in.
998 ;; If we have a repeat, only update the value...
1002 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
1003 ;; checked and SHOULD match the superclass
1004 ;; protection. Otherwise an error is thrown. However
1005 ;; I wonder if a more flexible schedule might be
1006 ;; implemented.
1011 prot super-prot a)))
1012 ;; Do a non redundant combination of ancient custom groups
1013 ;; and new ones.
1026 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
1027 ;; doc is specified, simply replaces the old one.
1029 ;;(message "Documentation redefined to %s" doc)
1031 doc))
1032 ;; End PLN
1034 ;; If a new printer is specified, it simply replaces
1035 ;; the old one.
1037 ;; (message "printer redefined to %s" print)
1040 ))
1041 ))
1042 ))
1045 "Copy into NEWC the slots of PARENTS.
1046 Follow the rules of not overwriting early parents when applying to
1047 the new child class."
1052 ;; First, duplicate all the slots of the parent.
1071 ;; Increment each value.
1083 ;; Now duplicate all the class alloc slots.
1100 ;; Increment each value.
1110 ;; Loop over each parent class
1112 ))
1114 \f
1115 ;;; CLOS methods and generics
1116 ;;
1119 "Form to use for the initial definition of a generic."
1123 ;; Make sure the method tables are installed.
1125 ;; Construct the actual body of this function.
1129 method))))
1132 "The lambda form that would be used as the function defined on METHOD.
1133 All methods should call the same EIEIO function for dispatch.
1134 DOC-STRING is the documentation attached to METHOD."
1136 ,doc-string
1140 "Setup METHOD to call the generic form."
1145 "The lambda form that would be used as the function defined on METHOD.
1146 All methods should call the same EIEIO function for dispatch.
1147 DOC-STRING is the documentation attached to METHOD."
1149 ,doc-string
1153 "Setup METHOD to call the generic form."
1160 class
1161 impl
1162 )
1163 "The lambda form that would be used as the function defined on METHOD.
1164 All methods should call the same EIEIO function for dispatch.
1165 DOC-STRING is the documentation attached to METHOD.
1166 CLASS is the class symbol needed for private method access.
1167 IMPL is the symbol holding the method implementation."
1168 ;; NOTE: I tried out byte compiling this little fcn. Turns out it
1169 ;; is faster to execute this for not byte-compiled. ie, install this,
1170 ;; then measure calls going through here. I wonder why.
1175 ,doc-string
1176 ;; This is a cool cheat. Usually we need to look up in the
1177 ;; method table to find out if there is a method or not. We can
1178 ;; instead make that determination at load time when there is
1179 ;; only one method. If the first arg is not a child of the class
1180 ;; of that one implementation, then clearly, there is no method def.
1182 ;; Not an object. Just signal.
1186 ;; We do have an object. Make sure it is the right type.
1188 nil ; default superclass means just an obj. Already asked.
1192 ;; If not the right kind of object, call no applicable
1196 ;; It is ok, do the call.
1197 ;; Fill in inter-call variables then evaluate the method.
1202 )
1207 ;(,impl local-args)
1208 )))))))
1211 "Setup METHOD to call the generic form."
1215 )
1217 method doc-string
1220 ))))
1223 "Make the generic method METHOD have no implementations.
1224 It will leave the original generic function in place,
1225 but remove reference to all implementations of METHOD."
1230 "Work part of the `defmethod' macro defining METHOD with ARGS."
1232 ;; Find optional keys.
1237 ;; Primary key.
1238 ;; (t method-primary)
1240 ;; Make sure there is a generic (when called from defclass).
1245 ;; Create symbol for property to bind to. If the first arg is of
1246 ;; the form (varname vartype) and `vartype' is a class, then
1247 ;; that class will be the type symbol. If not, then it will fall
1248 ;; under the type `primary' which is a non-specific calling of the
1249 ;; function.
1253 argclass))
1254 ;; Generics are higher.
1256 ;; Put this lambda into the symbol so we can find it.
1258 )
1261 ;; Optimizing step:
1262 ;;
1263 ;; If this method, after this setup, only has primary methods, then
1264 ;; we can setup the generic that way.
1266 ;; If there is only one primary method, then we can go one more
1267 ;; optimization step.
1273 method)
1275 ;;; Slot type validation
1277 ;; This is a hideous hack for replacing `typep' from cl-macs, to avoid
1278 ;; requiring the CL library at run-time. It can be eliminated if/when
1279 ;; `typep' is merged into Emacs core.
1282 "Return non-nil if SPEC does not match VALUE."
1288 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1289 Checks the :type specifier.
1290 SLOT is the slot that is being checked, and is only used when throwing
1291 an error."
1293 nil
1294 ;; Trim off object IDX junk added in for the object index.
1301 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1302 Checks the :type specifier.
1303 SLOT is the slot that is being checked, and is only used when throwing
1304 an error."
1306 nil
1308 slot-idx)))
1313 "Throw a signal if VALUE is a representation of an UNBOUND slot.
1314 INSTANCE is the object being referenced. SLOTNAME is the offending
1315 slot. If the slot is ok, return VALUE.
1316 Argument FN is the function calling this verifier."
1319 value))
1321 \f
1322 ;;; Get/Set slots in an object.
1323 ;;
1325 "Return the value in OBJ at SLOT in the object vector."
1332 ;; It might be missing because it is a :class allocated slot.
1333 ;; Let's check that info out.
1335 ;; Oref that slot.
1337 ;; The slot-missing method is a cool way of allowing an object author
1338 ;; to intercept missing slot definitions. Since it is also the LAST
1339 ;; thing called in this fn, its return value would be retrieved.
1341 ;;(signal 'invalid-slot-name (list (eieio-object-name obj) slot))
1342 )
1348 "Do the work for the macro `oref-default' with similar parameters.
1349 Fills in OBJ's SLOT with its default value."
1355 ;; It might be missing because it is a :class allocated slot.
1356 ;; Let's check that info out.
1359 ;; Oref that slot.
1361 c)
1363 ;;(signal 'invalid-slot-name (list (class-name cl) slot))
1364 )
1371 "Check VAL, and return what `oref-default' would provide."
1373 ;; Is it a function call? If so, evaluate it.
1376 ;;;; check for quoted things, and unquote them
1377 ;;((and (consp val) (eq (car val) 'quote))
1378 ;; (car (cdr val)))
1379 ;; return it verbatim
1383 "Do the work for the macro `oset'.
1384 Fills in OBJ's SLOT with VALUE."
1389 ;; It might be missing because it is a :class allocated slot.
1390 ;; Let's check that info out.
1393 ;; Oset that slot.
1397 c value))
1398 ;; See oref for comment on `slot-missing'
1400 ;;(signal 'invalid-slot-name (list (eieio-object-name obj) slot))
1401 )
1406 "Do the work for the macro `oset-default'.
1407 Fills in the default value in CLASS' in SLOT with VALUE."
1413 ;; It might be missing because it is a :class allocated slot.
1414 ;; Let's check that info out.
1417 ;; Oref that slot.
1420 value))
1423 ;; Set this into the storage for defaults.
1425 value)
1426 ;; Take the value, and put it into our cache object.
1428 slot value)
1429 ))))
1431 \f
1432 ;;; EIEIO internal search functions
1433 ;;
1435 "Return non-nil if START-CLASS is the first class to define SLOT.
1436 This is for testing if the class currently in scope is the class that defines SLOT
1437 so that we can protect private slots."
1441 t
1447 ret)))
1450 "In CLASS for OBJ find the index of the named SLOT.
1451 The slot is a symbol which is installed in CLASS by the `defclass'
1452 call. OBJ can be nil, but if it is an object, and the slot in question
1453 is protected, access will be allowed if OBJ is a child of the currently
1454 scoped class.
1455 If SLOT is the value created with :initarg instead,
1456 reverse-lookup that name, and recurse with the associated slot value."
1457 ;; Removed checks to outside this call
1474 eieio-initializing-object))
1481 "In CLASS find the index of the named SLOT.
1482 The slot is a symbol which is installed in CLASS by the `defclass'
1483 call. If SLOT is the value created with :initarg instead,
1484 reverse-lookup that name, and recurse with the associated slot value."
1485 ;; This will happen less often, and with fewer slots. Do this the
1486 ;; storage cheap way.
1491 ;; Slot # is length of the total list, minus the remaining list of
1492 ;; the found slot.
1495 ;;;
1496 ;; Way to assign slots based on a list. Used for constructors, or
1497 ;; even resetting an object at run-time
1498 ;;
1500 "Take object OBJ, and reset all slots to their defaults.
1501 If SET-ALL is non-nil, then when a default is nil, that value is
1502 reset. If SET-ALL is nil, the slots are only reset if the default is
1503 not nil."
1514 "For CLASS, convert INITARG to the actual attribute name.
1515 If there is no translation, pass it in directly (so we can cheat if
1516 need be... May remove that later...)"
1520 nil)))
1523 "In CLASS, convert the ATTRIBUTE into the corresponding init argument tag.
1524 This is usually a symbol that starts with `:'."
1528 nil)))
1530 ;;;
1531 ;; Method Invocation order: C3
1533 "Return CLASS if it can go in the result now, otherwise nil"
1534 ;; Ensure CLASS is not in any position but the first in any of the
1535 ;; element lists of REMAINING-INPUTS.
1540 found))
1541 class))
1544 "Merge REVERSED-PARTIAL-RESULT REMAINING-INPUTS in a consistent order, if possible.
1545 If a consistent order does not exist, signal an error."
1551 ;; If all remaining inputs are empty lists, we are done.
1553 ;; Otherwise, we try to find the next element of the result. This
1554 ;; is achieved by considering the first element of each
1555 ;; (non-empty) input list and accepting a candidate if it is
1556 ;; consistent with the rests of the input lists.
1563 remaining-inputs))
1565 found)))
1567 ;; The graph is consistent so far, add NEXT to result and
1568 ;; merge input lists, dropping NEXT from their heads where
1569 ;; applicable.
1573 remaining-inputs))
1574 ;; The graph is inconsistent, give up
1578 "Return all parents of CLASS in c3 order."
1587 parents)
1590 )
1591 ;;;
1592 ;; Method Invocation Order: Depth First
1595 "Return all parents of CLASS in depth-first order."
1605 parents)
1608 ;; Remove duplicates.
1612 classes))
1614 ;;;
1615 ;; Method Invocation Order: Breadth First
1617 "Return all parents of CLASS in breadth-first order."
1629 )
1631 ;;;
1632 ;; Method Invocation Order
1635 "Return (transitively closed) list of parents of CLASS.
1636 The order, in which the parents are returned depends on the
1637 method invocation orders of the involved classes."
1639 nil
1641 (:depth-first
1643 (:breadth-first
1645 (:c3
1647 )
1651 \f
1652 ;;; CLOS generics internal function handling
1653 ;;
1659 "When using `call-next-method', provides a context for the current key.
1662 "When executing a PRIMARY or STATIC method, track the 'next-method'.
1663 During executions, the list is first generated, then as each next method
1669 "Abnormal hook run just before an EIEIO method is executed.
1670 The hook function must accept one argument, the list of forms
1674 "Call METHOD with ARGS.
1675 ARGS provides the context on which implementation to use.
1676 This should only be called from a generic function."
1677 ;; We must expand our arguments first as they are always
1678 ;; passed in as quoted symbols
1684 ;; get a copy
1687 ;; Is the class passed in autoloaded?
1688 ;; Since class names are also constructors, they can be autoloaded
1689 ;; via the autoload command. Check for this, and load them in.
1690 ;; It is ok if it doesn't turn out to be a class. Probably want that
1691 ;; function loaded anyway.
1697 ;; Determine the class to use.
1702 )
1703 ;; Make sure the class is a valid class
1704 ;; mclass can be nil (meaning a generic for should be used.
1705 ;; mclass cannot have a value that is not a class, however.
1708 method mclass)
1709 )
1710 ;; Now create a list in reverse order of all the calls we have
1711 ;; make in order to successfully do this right. Rules:
1712 ;; 1) Only call generics if scoped-class is not defined
1713 ;; This prevents multiple calls in the case of recursion
1714 ;; 2) Only call static if this is a static method.
1715 ;; 3) Only call specifics if the definition allows for them.
1716 ;; 4) Call in order based on :before, :primary, and :after
1718 ;; Non-static calls do all this stuff.
1720 ;; :after methods
1725 ;;(or (and mclass (eieio-generic-form method method-after mclass))
1726 ;; (eieio-generic-form method method-after nil))
1727 )
1731 ;; :primary methods
1738 primarymethodlist
1741 ;; :before methods
1746 ;;(or (and mclass (eieio-generic-form method method-before mclass))
1747 ;; (eieio-generic-form method method-before nil))
1748 )
1751 )
1754 ;; For the case of a class,
1755 ;; if there were no methods found, then there could be :static methods.
1761 primarymethodlist ;; Re-use even with bad name here
1763 ;; For the case of no class (ie - mclass == nil) then there may
1764 ;; be a primary method.
1770 primarymethodlist
1772 )
1775 primarymethodlist)
1777 ;; Now loop through all occurrences forms which we must execute
1778 ;; (which are happily sorted now) and execute them all!
1788 ;; Use the cdr, as the first element is the fcn
1789 ;; we are calling right now.
1791 )
1793 ;;(setq rval (apply (car (car lambdas)) newargs))
1797 )))
1804 'no-method-definition
1806 rval)))
1809 "Call METHOD with ARGS for methods with only :PRIMARY implementations.
1810 ARGS provides the context on which implementation to use.
1811 This should only be called from a generic function.
1813 This method is like `eieio-generic-call', but only
1814 implementations in the :PRIMARY slot are queried. After many
1815 years of use, it appears that over 90% of methods in use
1816 have :PRIMARY implementations only. We can therefore optimize
1817 for this common case to improve performance."
1818 ;; We must expand our arguments first as they are always
1819 ;; passed in as quoted symbols
1825 )
1826 ;; get a copy
1830 ;; Determine the class to use.
1839 method)
1840 ))
1841 ;; Make sure the class is a valid class
1842 ;; mclass can be nil (meaning a generic for should be used.
1843 ;; mclass cannot have a value that is not a class, however.
1846 )
1848 ;; :primary methods
1853 ;; Now loop through all occurrences forms which we must execute
1854 ;; (which are happily sorted now) and execute them all!
1858 ;; Use the cdr, as the first element is the fcn
1859 ;; we are calling right now.
1861 )
1865 ;; No methods found for this impl...
1870 'no-method-definition
1873 ;; Do the regular implementation here.
1876 lambdas)
1881 rval))))
1884 "Return an alist list of methods lambdas.
1885 METHOD is the method name.
1886 KEY represents either :before, or :after methods.
1887 CLASS is the starting class to search from in the method tree.
1888 If CLASS is nil, then an empty list of methods should be returned."
1889 ;; Note: eieiomt - the MT means MethodTree. See more comments below
1890 ;; for the rest of the eieiomt methods.
1892 ;; Collect lambda expressions stored for the class and its parent
1893 ;; classes.
1896 ;; Lookup the form to use for the PRIMARY object for the next level
1900 ;; This prevents duplicates coming out of the
1901 ;; class method optimizer. Perhaps we should
1902 ;; just not optimize before/afters?
1906 ;; Return collected lambda. For :after methods, return in current
1907 ;; order (most general class last); Otherwise, reverse order.
1909 lambdas
1912 \f
1913 ;;;
1914 ;; eieio-method-tree : eieiomt-
1915 ;;
1916 ;; Stored as eieio-method-tree in property list of a generic method
1917 ;;
1918 ;; (eieio-method-tree . [BEFORE PRIMARY AFTER
1919 ;; genericBEFORE genericPRIMARY genericAFTER])
1920 ;; and
1921 ;; (eieio-method-obarray . [BEFORE PRIMARY AFTER
1922 ;; genericBEFORE genericPRIMARY genericAFTER])
1923 ;; where the association is a vector.
1924 ;; (aref 0 -- all static methods.
1925 ;; (aref 1 -- all methods classified as :before
1926 ;; (aref 2 -- all methods classified as :primary
1927 ;; (aref 3 -- all methods classified as :after
1928 ;; (aref 4 -- a generic classified as :before
1929 ;; (aref 5 -- a generic classified as :primary
1930 ;; (aref 6 -- a generic classified as :after
1931 ;;
1936 "Install the method tree, and obarray onto METHOD-NAME.
1937 Do not do the work if they already exist."
1950 ))))
1953 "Add to METHOD-NAME the forms METHOD in a call position KEY for CLASS.
1954 METHOD-NAME is the name created by a call to `defgeneric'.
1955 METHOD are the forms for a given implementation.
1956 KEY is an integer (see comment in eieio.el near this function) which
1957 is associated with the :static :before :primary and :after tags.
1958 It also indicates if CLASS is defined or not.
1959 CLASS is the class this method is associated with."
1964 ;; Make sure the method tables are available.
1967 ;; only add new cells on if it doesn't already exist!
1971 ;; Add function definition into newly created symbol, and store
1972 ;; said symbol in the correct obarray, otherwise use the
1973 ;; other array to keep this stuff
1977 ;; Save the defmethod file location in a symbol property.
1979 load-file-name
1980 buffer-file-name))
1981 loc)
1988 ;; Now optimize the entire obarray
1991 ;; @todo - Is this overkill? Should we just clear the symbol?
1993 ))
1996 "Return the next parent class for CLASS.
1997 If CLASS is a superclass, return variable `eieio-default-superclass'.
1998 If CLASS is variable `eieio-default-superclass' then return nil.
1999 This is different from function `class-parent' as class parent returns
2000 nil for superclasses. This function performs no type checking!"
2001 ;; No type-checking because all calls are made from functions which
2002 ;; are safe and do checking for us.
2005 nil
2009 "Find the next class above S which has a function body for the optimizer."
2010 ;; Set the value to nil in case there is no nearest cell.
2012 ;; Find the nearest cell that has a function body. If we find one,
2013 ;; we replace the nil from above.
2019 eieiomt-optimizing-obarray)))
2025 "Return the lambda form belonging to METHOD using KEY based upon CLASS.
2026 If CLASS is not a class then use `generic' instead. If class has
2027 no form, but has a parent class, then trace to that parent class.
2028 The first time a form is requested from a symbol, an optimized path
2029 is memorized for faster future use."
2033 ;; 1) find our symbol
2036 ;; 2) If there isn't one, then make one.
2037 ;; This can be slow since it only occurs once
2040 ;; 2.1) Cache its nearest neighbor with a quick optimize
2041 ;; which should only occur once for this call ever
2044 ;; 3) If it's bound return this one.
2047 ;; 4) If it's not bound then this variable knows something
2050 ;; 4.1) This symbol holds the next class in its value
2053 ;; 4.2) The optimizer should always have chosen a
2054 ;; function-symbol
2055 ;;(if (fboundp cs)
2057 ;;(error "EIEIO optimizer: erratic data loss!"))
2058 )
2059 ;; There never will be a funcall...
2060 nil)))
2061 ;; for a generic call, what is a list, is the function body we want.
2065 ;; The car of EMTL is supposed to be a class, which in this
2066 ;; case is nil, so skip it.
2068 nil)))))
2070 \f
2071 ;;; Here are some special types of errors
2072 ;;
2080 ;;; Obsolete backward compatibility functions.
2081 ;; Needed to run byte-code compiled with the EIEIO of Emacs-23.
2084 "Obsolete work part of an old version of the `defmethod' macro."
2086 ;; find optional keys
2090 method-before)
2093 method-after)
2096 method-static)
2099 method-primary)
2100 ;; Primary key.
2102 ;; Get body, and fix contents of args to be the arguments of the fn.
2106 ;; Create a fixed version of the arguments.
2109 argfix))
2111 ;; Make sure there is a generic.
2113 method
2116 ;; create symbol for property to bind to. If the first arg is of
2117 ;; the form (varname vartype) and `vartype' is a class, then
2118 ;; that class will be the type symbol. If not, then it will fall
2119 ;; under the type `primary' which is a non-specific calling of the
2120 ;; function.
2128 ;; Generics are higher.
2130 ;; Put this lambda into the symbol so we can find it.
2134 key argclass))
2135 )
2138 ;; Optimizing step:
2139 ;;
2140 ;; If this method, after this setup, only has primary methods, then
2141 ;; we can setup the generic that way.
2143 ;; If there is only one primary method, then we can go one more
2144 ;; optimization step.
2150 method)
2154 "Obsolete work part of an old version of the `defgeneric' macro."
2158 )
2160 method))
2161 ;; Don't do this over and over.
2163 ;; This defun tells emacs where the first definition of this
2164 ;; method is defined.
2166 ;; Make sure the method tables are installed.
2168 ;; Apply the actual body of this function.
2170 ;; Return the method
2176 ;;; eieio-core.el ends here