| blob | 76655caf65aca9f89f050f0866a8e38621f72b77 |
1 ;;; eieio-core.el --- Core implementation for eieio
3 ;; Copyright (C) 1995-1996, 1998-2014 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:
36 ;; Compatibility
39 ;; XEmacs can only access a compiled functions arglist like this:
42 ;; Emacs doesn't have this function, but since FUNC is a vector, we can just
43 ;; grab the appropriate element.
45 "Return the argument list for the compiled function FUNC."
48 )
53 "Like `defalias', but with less side-effects.
54 More specifically, it has no side-effects at all when the new function
55 definition is the same (`eq') as the old one."
60 ;;;
61 ;; A few functions that are better in the official EIEIO src, but
62 ;; used from the core.
67 \f
68 ;;;
69 ;; Variable declarations.
70 ;;
75 "Non-nil to throw an error if an encountered tag is unsupported.
76 This may prevent classes from CLOS applications from being used with EIEIO
80 "If non-nil, skip all slot typechecking.
81 Set this to t permanently if a program is functioning well to get a
82 small speed increase. This variable is also used internally to handle
93 eieio-unbound
97 ;; This is a bootstrap for eieio-default-superclass so it has a value
98 ;; while it is being built itself.
101 ;;;
102 ;; Class currently in scope.
103 ;;
104 ;; When invoking methods, the running method needs to know which class
105 ;; is currently in scope. Generally this is the class of the method
106 ;; being called, but 'call-next-method' needs to query this state,
107 ;; and change it to be then next super class up.
108 ;;
109 ;; Thus, the scoped class is a stack that needs to be managed.
115 "Return the class currently in scope, or nil."
119 "Set CLASS as the currently scoped class while executing FORMS."
127 ;;;
128 ;; Field Accessors
129 ;;
140 doc prefix)))
142 defs)
151 parent children
153 ;; @todo
154 ;; the word "public" here is leftovers from the very first version.
155 ;; Get rid of it!
176 This will speed up instantiation time as only a `copy-sequence' will
177 be needed, instead of looping over all the values and setting them
185 name))
187 ;; FIXME: The constants below should have an `eieio-' prefix added!!
193 (defconst method-num-lists 4 "Number of indexes into methods vector in which groups of functions are kept.")
200 "Convert a specialized KEY into a generic method key."
204 ))
206 \f
207 ;;; Important macros used internally in eieio.
208 ;;
219 "Internal: Return the class vector from the CLASS symbol."
220 ;; No check: If eieio gets this far, it has probably been checked already.
224 "Return t if CLASS is a valid class vector.
225 CLASS is a symbol."
226 ;; this new method is faster since it doesn't waste time checking lots of
227 ;; things.
234 ;; I think this is supposed to return a symbol, but to me CLASS is a symbol,
235 ;; and I wanted a string. Arg!
240 "Return parent classes to CLASS with no check."
247 "Return t if OBJ is of class-type CLASS with no error checking."
251 "Return the symbol representing the constructor of CLASS."
255 "Return t if symbol METHOD is a generic function.
256 Only methods have the symbol `eieio-method-obarray' as a property
257 \(which contains a list of all bindings to that method type.)"
261 "Return t if symbol METHOD is a generic function with only primary methods.
262 Only methods have the symbol `eieio-method-obarray' as a property (which
263 contains a list of all bindings to that method type.)
264 Methods with only primary implementations are executed in an optimized way."
274 ))
277 "Return t if symbol METHOD is a generic function with only primary methods.
278 Only methods have the symbol `eieio-method-obarray' as a property (which
279 contains a list of all bindings to that method type.)
280 Methods with only primary implementations are executed in an optimized way."
290 ))
293 "Return from LIST the found OPTION, or nil if it doesn't exist."
297 "Return the value stored for CLASS' OPTION.
298 Return nil if that option doesn't exist."
302 "Return non-nil if OBJ is an EIEIO object."
311 "Return non-nil if CLASS is abstract.
312 Abstract classes cannot be instantiated."
316 "Return the invocation order of CLASS.
317 Abstract classes cannot be instantiated."
322 \f
323 ;;;
324 ;; Class Creation
329 ;; We autoload this because it's used in `make-autoload'.
330 ;;;###autoload
332 "Create autoload symbols for the EIEIO class CNAME.
333 SUPERCLASSES are the superclasses that CNAME inherits from.
334 DOC is the docstring for CNAME.
335 This function creates a mock-class for CNAME and adds it into
336 SUPERCLASSES as children.
337 It creates an autoload function for CNAME's constructor."
338 ;; Assume we've already debugged inputs.
342 )
344 nil ;; Do nothing if we already have this class.
346 ;; Create the class in NEWC, but don't fill anything else in.
351 ;; No parents?
354 clear-parent t)
355 )
357 ;; Hook our new class into the existing structures so we can
358 ;; autoload it later.
362 ;; TODO - If we create an autoload that is in the map, that
363 ;; map needs to be cleared!
366 ;; Does our parent exist?
369 ;; Create a symbol for this parent, and then store this
370 ;; parent on that symbol.
375 )
377 ;; We have a parent, save the child in there.
382 ;; save parent in child
384 )
386 ;; turn this into a usable self-pointing symbol
389 ;; Store the new class vector definition into the symbol. We need to
390 ;; do this first so that we can call defmethod for the accessor.
391 ;; The vector will be updated by the following while loop and will not
392 ;; need to be stored a second time.
395 ;; Clear the parent
398 ;; Create an autoload on top of our constructor function.
404 ))))
407 "If class CNAME is in an autoload state, load its file."
412 ;; FIXME: Most of this should be moved to the `defclass' macro.
413 "Define CNAME as a new subclass of SUPERCLASSES.
414 SLOTS are the slots residing in that class definition, and options or
415 documentation OPTIONS-AND-DOC is the toplevel documentation for this class.
416 See `defclass' for more information."
417 ;; Run our eieio-hook each time, and clear it when we are done.
418 ;; This way people can add hooks safely if they want to modify eieio
419 ;; or add definitions when eieio is loaded or something like that.
435 ;; If this class already existed, and we are updating its structure,
436 ;; make sure we keep the old child list. This can cause bugs, but
437 ;; if no new slots are created, it also saves time, and prevents
438 ;; method table breakage, particularly when the users is only
439 ;; byte compiling an EIEIO file.
442 ;; If the old class did not exist, but did exist in the autoload map, then adopt those children.
443 ;; This is like the above, but deals with autoloads nicely.
450 ))
451 )
459 )
464 options-and-doc))
471 ;; bad class
473 ;; good parent class...
474 ;; save new child in parent
478 ;; Get custom groups, and store them into our local copy.
481 ;; save parent in child
485 ;; Reverse the list of our parents so that they are prioritized in
486 ;; the same order as specified in the code.
488 ;; If there is nothing to loop over, then inherit from the
489 ;; default superclass.
491 ;; adopt the default parent here, but clear it later...
493 ;; save new child in parent
497 ;; save parent in child
500 ;; turn this into a usable self-pointing symbol
503 ;; These two tests must be created right away so we can have self-
504 ;; referencing classes. ei, a class whose slot can contain only
505 ;; pointers to itself.
507 ;; Create the test function
515 ;; Make sure the method invocation order is a valid value.
519 ))
521 ;; Create a handy child test too
526 "Test OBJ to see if it an object is a child of type %s"
527 cname)
531 ;; Create a handy list of the class test too
536 "Test OBJ to see if it a list of objects which are a child of type %s"
537 cname)
540 ;; Loop over all the elements of the input list, test
541 ;; each to make sure it is a child of the desired object class.
546 ans)))))
548 ;; When using typep, (typep OBJ 'myclass) returns t for objects which
549 ;; are subclasses of myclass. For our predicates, however, it is
550 ;; important for EIEIO to be backwards compatible, where
551 ;; myobject-p, and myobject-child-p are different.
552 ;; "cl" uses this technique to specify symbols with specific typep
553 ;; test, so we can let typep have the CLOS documented behavior
554 ;; while keeping our above predicate clean.
556 ;; It would be cleaner to use `defsetf' here, but that requires cl
557 ;; at runtime.
561 ;; Before adding new slots, let's add all the methods and classes
562 ;; in from the parent class.
565 ;; Store the new class vector definition into the symbol. We need to
566 ;; do this first so that we can call defmethod for the accessor.
567 ;; The vector will be updated by the following while loop and will not
568 ;; need to be stored a second time.
571 ;; Query each slot in the declaration list and mangle into the
572 ;; class structure I have defined.
580 eieio-unbound)))
594 )
600 :initform
601 :initarg
602 :documentation
603 :protection
604 :reader
605 :writer
606 :allocation
607 :type
608 :custom
609 :label
610 :group
611 :printer
612 :allow-nil-initform
617 ;; Clean up the meaning of protection.
624 ;; Make sure the :allocation parameter has a valid value.
628 ;; The default type specifier is supposed to be t, meaning anything.
631 ;; Label is nil, or a string
635 ;; Is there an initarg, but allocation of class?
639 ;; intern the symbol so we can use it blankly
642 ;; The customgroup should be a list of symbols
647 ;; The customgroup better be a symbol, or list of symbols.
651 customg)
653 ;; First up, add this slot into our new class.
657 ;; We need to id the group, and store them in a group list attribute.
660 ;; Anyone can have an accessor function. This creates a function
661 ;; of the specified name, and also performs a `defsetf' if applicable
662 ;; so that users can `setf' the space returned by this function.
669 "Retrieves the slot `%s' from an object of class `%s'"
670 name cname)
673 ;; Else - Some error? nil?
674 nil)))
677 ;; FIXME: We should move more of eieio-defclass into the
678 ;; defclass macro so we don't have to use `eval' and require
679 ;; `gv' at run-time.
682 eieio--store)))
683 ;; Provide a setf method. It would be cleaner to use
684 ;; defsetf, but that would require CL at runtime.
694 --store-sym--)
697 ;; If a writer is defined, then create a generic method of that
698 ;; name whose purpose is to set the value of the slot.
701 writer nil cname
704 name cname)
706 ;; If a reader is defined, then create a generic method
707 ;; of that name whose purpose is to access this slot value.
710 reader nil cname
713 name cname)
715 )
718 ;; Now that everything has been loaded up, all our lists are backwards!
719 ;; Fix that up now.
726 (setf (eieio--class-public-custom-label newc) (nreverse (eieio--class-public-custom-label newc)))
727 (setf (eieio--class-public-custom-group newc) (nreverse (eieio--class-public-custom-group newc)))
732 ;; The storage for class-class-allocation-type needs to be turned into
733 ;; a vector now.
737 ;; Also, take class allocated values, and vectorize them for speed.
741 ;; Attach slot symbols into an obarray, and store the index of
742 ;; this slot as the variable slot in this new symbol. We need to
743 ;; know about primes, because obarrays are best set in vectors of
744 ;; prime number length, and we also need to make our vector small
745 ;; to save space, and also optimal for the number of items we have.
765 )
767 ;; Create the constructor function
769 ;; Abstract classes cannot be instantiated. Say so.
778 ;; Non-abstract classes need a constructor.
783 )
785 ;; Set up a specialized doc string.
786 ;; Use stored value since it is calculated in a non-trivial way
790 ;; Save the file location where this class is defined.
792 load-file-name
793 buffer-file-name)))
799 ;; We have a list of custom groups. Store them into the options.
806 ;; Set up the options we have collected.
809 ;; if this is a superclass, clear out parent (which was set to the
810 ;; default superclass eieio-default-superclass)
813 ;; Create the cached default object.
815 nil)))
820 ;; All type-checking has been done to our satisfaction
821 ;; before this call. Don't waste our time in this call..
825 ;; Return our new class object
826 ;; newc
827 cname
828 ))
831 "Whether the default value VAL should be evaluated for use."
835 "For SLOT, signal if SPEC does not match VALUE.
836 If SKIPNIL is non-nil, then if VALUE is nil return t instead."
845 "Add into NEWC attribute A.
846 If A already exists in NEWC, then do nothing. If it doesn't exist,
847 then also add in D (default), DOC, TYPE, CUST, LABEL, CUSTG, PRINT, PROT, and INIT arg.
848 Argument ALLOC specifies if the slot is allocated per instance, or per class.
849 If optional DEFAULTOVERRIDE is non-nil, then if A exists in NEWC,
850 we must override its value for a default.
851 Optional argument SKIPNIL indicates if type checking should be skipped
852 if default value is nil."
853 ;; Make sure we duplicate those items that are sequences.
856 ;; This copy can fail on a cons cell with a non-cons in the cdr. Let's skip it if it doesn't work.
862 ;; To prevent override information w/out specification of storage,
863 ;; we need to do this little hack.
867 ;; In this case, we modify the INSTANCE version of a given slot.
871 ;; Only add this element if it is so-far unique
880 (setf (eieio--class-public-custom-label newc) (cons label (eieio--class-public-custom-label newc)))
881 (setf (eieio--class-public-custom-group newc) (cons custg (eieio--class-public-custom-group newc)))
884 (setf (eieio--class-initarg-tuples newc) (cons (cons init a) (eieio--class-initarg-tuples newc)))
885 )
886 ;; When defaultoverride is true, we are usually adding new local
887 ;; attributes which must override the default value of any slot
888 ;; passed in by one of the parent classes.
890 ;; There is a match, and we must override the old value.
895 nil))
897 )
900 a)
901 ;; If type is passed in, is it the same?
905 "Child slot type `%s' does not match inherited type `%s' for `%s'"
906 type tp a)))
907 ;; If we have a repeat, only update the initarg...
911 ;; If we have a new initarg, check for it.
915 ;; Replace the CAR of the associate INITA.
916 ;;(message "Initarg: %S replace %s" inita init)
918 ))
920 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
921 ;; checked and SHOULD match the superclass
922 ;; protection. Otherwise an error is thrown. However
923 ;; I wonder if a more flexible schedule might be
924 ;; implemented.
925 ;;
926 ;; EML - We used to have (if prot... here,
927 ;; but a prot of 'nil means public.
928 ;;
930 )
933 prot super-prot a)))
934 ;; End original PLN
936 ;; PLN Tue Jun 26 11:57:06 2007 :
937 ;; Do a non redundant combination of ancient custom
938 ;; groups and new ones.
950 ;; End PLN
952 ;; PLN Mon Jun 25 22:44:34 2007 : If a new cust is
953 ;; set, simply replaces the old one.
955 ;; (message "Custom type redefined to %s" cust)
958 ;; If a new label is specified, it simply replaces
959 ;; the old one.
961 ;; (message "Custom label redefined to %s" label)
963 ;; End PLN
965 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
966 ;; doc is specified, simply replaces the old one.
968 ;;(message "Documentation redefined to %s" doc)
970 doc))
971 ;; End PLN
973 ;; If a new printer is specified, it simply replaces
974 ;; the old one.
976 ;; (message "printer redefined to %s" print)
979 )))
980 ))
982 ;; CLASS ALLOCATED SLOTS
987 ;; Here we have found a :class version of a slot. This
988 ;; requires a very different approach.
990 (setf (eieio--class-class-allocation-doc newc) (cons doc (eieio--class-class-allocation-doc newc)))
991 (setf (eieio--class-class-allocation-type newc) (cons type (eieio--class-class-allocation-type newc)))
992 (setf (eieio--class-class-allocation-custom newc) (cons cust (eieio--class-class-allocation-custom newc)))
993 (setf (eieio--class-class-allocation-custom-label newc) (cons label (eieio--class-class-allocation-custom-label newc)))
994 (setf (eieio--class-class-allocation-custom-group newc) (cons custg (eieio--class-class-allocation-custom-group newc)))
995 (setf (eieio--class-class-allocation-protection newc) (cons prot (eieio--class-class-allocation-protection newc)))
996 ;; Default value is stored in the 'values section, since new objects
997 ;; can't initialize from this element.
998 (setf (eieio--class-class-allocation-values newc) (cons value (eieio--class-class-allocation-values newc))))
1000 ;; There is a match, and we must override the old value.
1007 nil))
1009 nil)))
1012 a)
1013 ;; If type is passed in, is it the same?
1017 "Child slot type `%s' does not match inherited type `%s' for `%s'"
1018 type tp a)))
1019 ;; EML - Note: the only reason to override a class bound slot
1020 ;; is to change the default, so allow unbound in.
1022 ;; If we have a repeat, only update the value...
1026 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
1027 ;; checked and SHOULD match the superclass
1028 ;; protection. Otherwise an error is thrown. However
1029 ;; I wonder if a more flexible schedule might be
1030 ;; implemented.
1035 prot super-prot a)))
1036 ;; Do a non redundant combination of ancient custom groups
1037 ;; and new ones.
1050 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
1051 ;; doc is specified, simply replaces the old one.
1053 ;;(message "Documentation redefined to %s" doc)
1055 doc))
1056 ;; End PLN
1058 ;; If a new printer is specified, it simply replaces
1059 ;; the old one.
1061 ;; (message "printer redefined to %s" print)
1064 ))
1065 ))
1066 ))
1069 "Copy into NEWC the slots of PARENTS.
1070 Follow the rules of not overwriting early parents when applying to
1071 the new child class."
1076 ;; First, duplicate all the slots of the parent.
1095 ;; Increment each value.
1107 ;; Now duplicate all the class alloc slots.
1124 ;; Increment each value.
1134 ;; Loop over each parent class
1136 ))
1138 \f
1139 ;;; CLOS methods and generics
1140 ;;
1143 "Form to use for the initial definition of a generic."
1147 ;; Make sure the method tables are installed.
1149 ;; Construct the actual body of this function.
1153 method))))
1156 "The lambda form that would be used as the function defined on METHOD.
1157 All methods should call the same EIEIO function for dispatch.
1158 DOC-STRING is the documentation attached to METHOD."
1160 ,doc-string
1164 "Setup METHOD to call the generic form."
1169 "The lambda form that would be used as the function defined on METHOD.
1170 All methods should call the same EIEIO function for dispatch.
1171 DOC-STRING is the documentation attached to METHOD."
1173 ,doc-string
1177 "Setup METHOD to call the generic form."
1182 class
1183 impl
1184 )
1185 "The lambda form that would be used as the function defined on METHOD.
1186 All methods should call the same EIEIO function for dispatch.
1187 DOC-STRING is the documentation attached to METHOD.
1188 CLASS is the class symbol needed for private method access.
1189 IMPL is the symbol holding the method implementation."
1190 ;; NOTE: I tried out byte compiling this little fcn. Turns out it
1191 ;; is faster to execute this for not byte-compiled. ie, install this,
1192 ;; then measure calls going through here. I wonder why.
1197 ,doc-string
1198 ;; This is a cool cheat. Usually we need to look up in the
1199 ;; method table to find out if there is a method or not. We can
1200 ;; instead make that determination at load time when there is
1201 ;; only one method. If the first arg is not a child of the class
1202 ;; of that one implementation, then clearly, there is no method def.
1204 ;; Not an object. Just signal.
1208 ;; We do have an object. Make sure it is the right type.
1210 nil ; default superclass means just an obj. Already asked.
1214 ;; If not the right kind of object, call no applicable
1218 ;; It is ok, do the call.
1219 ;; Fill in inter-call variables then evaluate the method.
1224 )
1229 ;(,impl local-args)
1230 )))))))
1233 "Setup METHOD to call the generic form."
1237 )
1239 method doc-string
1242 ))))
1245 "Make the generic method METHOD have no implementations.
1246 It will leave the original generic function in place,
1247 but remove reference to all implementations of METHOD."
1252 "Work part of the `defmethod' macro defining METHOD with ARGS."
1254 ;; Find optional keys.
1259 ;; Primary key.
1260 ;; (t method-primary)
1262 ;; Make sure there is a generic (when called from defclass).
1267 ;; Create symbol for property to bind to. If the first arg is of
1268 ;; the form (varname vartype) and `vartype' is a class, then
1269 ;; that class will be the type symbol. If not, then it will fall
1270 ;; under the type `primary' which is a non-specific calling of the
1271 ;; function.
1275 argclass))
1276 ;; Generics are higher.
1278 ;; Put this lambda into the symbol so we can find it.
1280 )
1283 ;; Optimizing step:
1284 ;;
1285 ;; If this method, after this setup, only has primary methods, then
1286 ;; we can setup the generic that way.
1288 ;; If there is only one primary method, then we can go one more
1289 ;; optimization step.
1295 method)
1297 ;;; Slot type validation
1299 ;; This is a hideous hack for replacing `typep' from cl-macs, to avoid
1300 ;; requiring the CL library at run-time. It can be eliminated if/when
1301 ;; `typep' is merged into Emacs core.
1345 "Return non-nil if SPEC does not match VALUE."
1351 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1352 Checks the :type specifier.
1353 SLOT is the slot that is being checked, and is only used when throwing
1354 an error."
1356 nil
1357 ;; Trim off object IDX junk added in for the object index.
1364 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1365 Checks the :type specifier.
1366 SLOT is the slot that is being checked, and is only used when throwing
1367 an error."
1369 nil
1371 slot-idx)))
1376 "Throw a signal if VALUE is a representation of an UNBOUND slot.
1377 INSTANCE is the object being referenced. SLOTNAME is the offending
1378 slot. If the slot is ok, return VALUE.
1379 Argument FN is the function calling this verifier."
1382 value))
1384 \f
1385 ;;; Get/Set slots in an object.
1386 ;;
1388 "Return the value in OBJ at SLOT in the object vector."
1395 ;; It might be missing because it is a :class allocated slot.
1396 ;; Let's check that info out.
1398 ;; Oref that slot.
1400 ;; The slot-missing method is a cool way of allowing an object author
1401 ;; to intercept missing slot definitions. Since it is also the LAST
1402 ;; thing called in this fn, its return value would be retrieved.
1404 ;;(signal 'invalid-slot-name (list (eieio-object-name obj) slot))
1405 )
1411 "Do the work for the macro `oref-default' with similar parameters.
1412 Fills in OBJ's SLOT with its default value."
1418 ;; It might be missing because it is a :class allocated slot.
1419 ;; Let's check that info out.
1422 ;; Oref that slot.
1424 c)
1426 ;;(signal 'invalid-slot-name (list (class-name cl) slot))
1427 )
1434 "Check VAL, and return what `oref-default' would provide."
1436 ;; Is it a function call? If so, evaluate it.
1439 ;;;; check for quoted things, and unquote them
1440 ;;((and (consp val) (eq (car val) 'quote))
1441 ;; (car (cdr val)))
1442 ;; return it verbatim
1446 "Do the work for the macro `oset'.
1447 Fills in OBJ's SLOT with VALUE."
1452 ;; It might be missing because it is a :class allocated slot.
1453 ;; Let's check that info out.
1456 ;; Oset that slot.
1460 c value))
1461 ;; See oref for comment on `slot-missing'
1463 ;;(signal 'invalid-slot-name (list (eieio-object-name obj) slot))
1464 )
1469 "Do the work for the macro `oset-default'.
1470 Fills in the default value in CLASS' in SLOT with VALUE."
1476 ;; It might be missing because it is a :class allocated slot.
1477 ;; Let's check that info out.
1480 ;; Oref that slot.
1483 value))
1486 ;; Set this into the storage for defaults.
1488 value)
1489 ;; Take the value, and put it into our cache object.
1491 slot value)
1492 ))))
1494 \f
1495 ;;; EIEIO internal search functions
1496 ;;
1498 "Return non-nil if START-CLASS is the first class to define SLOT.
1499 This is for testing if the class currently in scope is the class that defines SLOT
1500 so that we can protect private slots."
1504 t
1510 ret)))
1513 "In CLASS for OBJ find the index of the named SLOT.
1514 The slot is a symbol which is installed in CLASS by the `defclass'
1515 call. OBJ can be nil, but if it is an object, and the slot in question
1516 is protected, access will be allowed if OBJ is a child of the currently
1517 scoped class.
1518 If SLOT is the value created with :initarg instead,
1519 reverse-lookup that name, and recurse with the associated slot value."
1520 ;; Removed checks to outside this call
1537 eieio-initializing-object))
1544 "In CLASS find the index of the named SLOT.
1545 The slot is a symbol which is installed in CLASS by the `defclass'
1546 call. If SLOT is the value created with :initarg instead,
1547 reverse-lookup that name, and recurse with the associated slot value."
1548 ;; This will happen less often, and with fewer slots. Do this the
1549 ;; storage cheap way.
1554 ;; Slot # is length of the total list, minus the remaining list of
1555 ;; the found slot.
1558 ;;;
1559 ;; Way to assign slots based on a list. Used for constructors, or
1560 ;; even resetting an object at run-time
1561 ;;
1563 "Take object OBJ, and reset all slots to their defaults.
1564 If SET-ALL is non-nil, then when a default is nil, that value is
1565 reset. If SET-ALL is nil, the slots are only reset if the default is
1566 not nil."
1577 "For CLASS, convert INITARG to the actual attribute name.
1578 If there is no translation, pass it in directly (so we can cheat if
1579 need be... May remove that later...)"
1583 nil)))
1586 "In CLASS, convert the ATTRIBUTE into the corresponding init argument tag.
1587 This is usually a symbol that starts with `:'."
1591 nil)))
1593 ;;;
1594 ;; Method Invocation order: C3
1596 "Return CLASS if it can go in the result now, otherwise nil"
1597 ;; Ensure CLASS is not in any position but the first in any of the
1598 ;; element lists of REMAINING-INPUTS.
1603 found))
1604 class))
1607 "Merge REVERSED-PARTIAL-RESULT REMAINING-INPUTS in a consistent order, if possible.
1608 If a consistent order does not exist, signal an error."
1614 ;; If all remaining inputs are empty lists, we are done.
1616 ;; Otherwise, we try to find the next element of the result. This
1617 ;; is achieved by considering the first element of each
1618 ;; (non-empty) input list and accepting a candidate if it is
1619 ;; consistent with the rests of the input lists.
1626 remaining-inputs))
1628 found)))
1630 ;; The graph is consistent so far, add NEXT to result and
1631 ;; merge input lists, dropping NEXT from their heads where
1632 ;; applicable.
1636 remaining-inputs))
1637 ;; The graph is inconsistent, give up
1641 "Return all parents of CLASS in c3 order."
1650 parents)
1653 )
1654 ;;;
1655 ;; Method Invocation Order: Depth First
1658 "Return all parents of CLASS in depth-first order."
1668 parents)
1671 ;; Remove duplicates.
1675 classes))
1677 ;;;
1678 ;; Method Invocation Order: Breadth First
1680 "Return all parents of CLASS in breadth-first order."
1692 )
1694 ;;;
1695 ;; Method Invocation Order
1698 "Return (transitively closed) list of parents of CLASS.
1699 The order, in which the parents are returned depends on the
1700 method invocation orders of the involved classes."
1702 nil
1704 (:depth-first
1706 (:breadth-first
1708 (:c3
1710 )
1714 \f
1715 ;;; CLOS generics internal function handling
1716 ;;
1722 "When using `call-next-method', provides a context for the current key.
1725 "When executing a PRIMARY or STATIC method, track the 'next-method'.
1726 During executions, the list is first generated, then as each next method
1732 "Abnormal hook run just before an EIEIO method is executed.
1733 The hook function must accept one argument, the list of forms
1737 "Call METHOD with ARGS.
1738 ARGS provides the context on which implementation to use.
1739 This should only be called from a generic function."
1740 ;; We must expand our arguments first as they are always
1741 ;; passed in as quoted symbols
1747 ;; get a copy
1750 ;; Is the class passed in autoloaded?
1751 ;; Since class names are also constructors, they can be autoloaded
1752 ;; via the autoload command. Check for this, and load them in.
1753 ;; It is ok if it doesn't turn out to be a class. Probably want that
1754 ;; function loaded anyway.
1760 ;; Determine the class to use.
1765 )
1766 ;; Make sure the class is a valid class
1767 ;; mclass can be nil (meaning a generic for should be used.
1768 ;; mclass cannot have a value that is not a class, however.
1771 method mclass)
1772 )
1773 ;; Now create a list in reverse order of all the calls we have
1774 ;; make in order to successfully do this right. Rules:
1775 ;; 1) Only call generics if scoped-class is not defined
1776 ;; This prevents multiple calls in the case of recursion
1777 ;; 2) Only call static if this is a static method.
1778 ;; 3) Only call specifics if the definition allows for them.
1779 ;; 4) Call in order based on :before, :primary, and :after
1781 ;; Non-static calls do all this stuff.
1783 ;; :after methods
1788 ;;(or (and mclass (eieio-generic-form method method-after mclass))
1789 ;; (eieio-generic-form method method-after nil))
1790 )
1794 ;; :primary methods
1801 primarymethodlist
1804 ;; :before methods
1809 ;;(or (and mclass (eieio-generic-form method method-before mclass))
1810 ;; (eieio-generic-form method method-before nil))
1811 )
1814 )
1817 ;; For the case of a class,
1818 ;; if there were no methods found, then there could be :static methods.
1824 primarymethodlist ;; Re-use even with bad name here
1826 ;; For the case of no class (ie - mclass == nil) then there may
1827 ;; be a primary method.
1833 primarymethodlist
1835 )
1838 primarymethodlist)
1840 ;; Now loop through all occurrences forms which we must execute
1841 ;; (which are happily sorted now) and execute them all!
1851 ;; Use the cdr, as the first element is the fcn
1852 ;; we are calling right now.
1854 )
1856 ;;(setq rval (apply (car (car lambdas)) newargs))
1860 rvalever t))
1861 )))
1867 rvalever t)
1869 'no-method-definition
1871 ;; Right Here... it could be that lastval is returned when
1872 ;; rvalever is nil. Is that right?
1873 rval)))
1876 "Call METHOD with ARGS for methods with only :PRIMARY implementations.
1877 ARGS provides the context on which implementation to use.
1878 This should only be called from a generic function.
1880 This method is like `eieio-generic-call', but only
1881 implementations in the :PRIMARY slot are queried. After many
1882 years of use, it appears that over 90% of methods in use
1883 have :PRIMARY implementations only. We can therefore optimize
1884 for this common case to improve performance."
1885 ;; We must expand our arguments first as they are always
1886 ;; passed in as quoted symbols
1892 )
1893 ;; get a copy
1897 ;; Determine the class to use.
1906 method)
1907 ))
1908 ;; Make sure the class is a valid class
1909 ;; mclass can be nil (meaning a generic for should be used.
1910 ;; mclass cannot have a value that is not a class, however.
1913 )
1915 ;; :primary methods
1920 ;; Now loop through all occurrences forms which we must execute
1921 ;; (which are happily sorted now) and execute them all!
1925 ;; Use the cdr, as the first element is the fcn
1926 ;; we are calling right now.
1928 )
1932 ;; No methods found for this impl...
1935 rvalever t)
1937 'no-method-definition
1940 ;; Do the regular implementation here.
1943 lambdas)
1947 rvalever t)
1948 )
1950 ;; Right Here... it could be that lastval is returned when
1951 ;; rvalever is nil. Is that right?
1952 rval))))
1955 "Return an alist list of methods lambdas.
1956 METHOD is the method name.
1957 KEY represents either :before, or :after methods.
1958 CLASS is the starting class to search from in the method tree.
1959 If CLASS is nil, then an empty list of methods should be returned."
1960 ;; Note: eieiomt - the MT means MethodTree. See more comments below
1961 ;; for the rest of the eieiomt methods.
1963 ;; Collect lambda expressions stored for the class and its parent
1964 ;; classes.
1967 ;; Lookup the form to use for the PRIMARY object for the next level
1971 ;; This prevents duplicates coming out of the
1972 ;; class method optimizer. Perhaps we should
1973 ;; just not optimize before/afters?
1977 ;; Return collected lambda. For :after methods, return in current
1978 ;; order (most general class last); Otherwise, reverse order.
1980 lambdas
1983 \f
1984 ;;;
1985 ;; eieio-method-tree : eieiomt-
1986 ;;
1987 ;; Stored as eieio-method-tree in property list of a generic method
1988 ;;
1989 ;; (eieio-method-tree . [BEFORE PRIMARY AFTER
1990 ;; genericBEFORE genericPRIMARY genericAFTER])
1991 ;; and
1992 ;; (eieio-method-obarray . [BEFORE PRIMARY AFTER
1993 ;; genericBEFORE genericPRIMARY genericAFTER])
1994 ;; where the association is a vector.
1995 ;; (aref 0 -- all static methods.
1996 ;; (aref 1 -- all methods classified as :before
1997 ;; (aref 2 -- all methods classified as :primary
1998 ;; (aref 3 -- all methods classified as :after
1999 ;; (aref 4 -- a generic classified as :before
2000 ;; (aref 5 -- a generic classified as :primary
2001 ;; (aref 6 -- a generic classified as :after
2002 ;;
2007 "Install the method tree, and obarray onto METHOD-NAME.
2008 Do not do the work if they already exist."
2021 ))))
2024 "Add to METHOD-NAME the forms METHOD in a call position KEY for CLASS.
2025 METHOD-NAME is the name created by a call to `defgeneric'.
2026 METHOD are the forms for a given implementation.
2027 KEY is an integer (see comment in eieio.el near this function) which
2028 is associated with the :static :before :primary and :after tags.
2029 It also indicates if CLASS is defined or not.
2030 CLASS is the class this method is associated with."
2035 ;; Make sure the method tables are available.
2038 ;; only add new cells on if it doesn't already exist!
2042 ;; Add function definition into newly created symbol, and store
2043 ;; said symbol in the correct obarray, otherwise use the
2044 ;; other array to keep this stuff
2048 ;; Save the defmethod file location in a symbol property.
2050 load-file-name
2051 buffer-file-name))
2052 loc)
2059 ;; Now optimize the entire obarray
2062 ;; @todo - Is this overkill? Should we just clear the symbol?
2064 ))
2067 "Return the next parent class for CLASS.
2068 If CLASS is a superclass, return variable `eieio-default-superclass'.
2069 If CLASS is variable `eieio-default-superclass' then return nil.
2070 This is different from function `class-parent' as class parent returns
2071 nil for superclasses. This function performs no type checking!"
2072 ;; No type-checking because all calls are made from functions which
2073 ;; are safe and do checking for us.
2076 nil
2080 "Find the next class above S which has a function body for the optimizer."
2081 ;; Set the value to nil in case there is no nearest cell.
2083 ;; Find the nearest cell that has a function body. If we find one,
2084 ;; we replace the nil from above.
2089 eieiomt-optimizing-obarray)))
2095 "Return the lambda form belonging to METHOD using KEY based upon CLASS.
2096 If CLASS is not a class then use `generic' instead. If class has
2097 no form, but has a parent class, then trace to that parent class.
2098 The first time a form is requested from a symbol, an optimized path
2099 is memorized for faster future use."
2103 ;; 1) find our symbol
2106 ;; 2) If there isn't one, then make one.
2107 ;; This can be slow since it only occurs once
2110 ;; 2.1) Cache its nearest neighbor with a quick optimize
2111 ;; which should only occur once for this call ever
2114 ;; 3) If it's bound return this one.
2117 ;; 4) If it's not bound then this variable knows something
2120 ;; 4.1) This symbol holds the next class in its value
2123 ;; 4.2) The optimizer should always have chosen a
2124 ;; function-symbol
2125 ;;(if (fboundp cs)
2127 ;;(error "EIEIO optimizer: erratic data loss!"))
2128 )
2129 ;; There never will be a funcall...
2130 nil)))
2131 ;; for a generic call, what is a list, is the function body we want.
2135 ;; The car of EMTL is supposed to be a class, which in this
2136 ;; case is nil, so skip it.
2138 nil)))))
2140 \f
2141 ;;; Here are some special types of errors
2142 ;;
2168 ;;; Obsolete backward compatibility functions.
2169 ;; Needed to run byte-code compiled with the EIEIO of Emacs-23.
2172 "Obsolete work part of an old version of the `defmethod' macro."
2174 ;; find optional keys
2178 method-before)
2181 method-after)
2184 method-static)
2187 method-primary)
2188 ;; Primary key.
2190 ;; Get body, and fix contents of args to be the arguments of the fn.
2194 ;; Create a fixed version of the arguments.
2197 argfix))
2199 ;; Make sure there is a generic.
2201 method
2204 ;; create symbol for property to bind to. If the first arg is of
2205 ;; the form (varname vartype) and `vartype' is a class, then
2206 ;; that class will be the type symbol. If not, then it will fall
2207 ;; under the type `primary' which is a non-specific calling of the
2208 ;; function.
2216 ;; Generics are higher.
2218 ;; Put this lambda into the symbol so we can find it.
2222 key argclass))
2223 )
2226 ;; Optimizing step:
2227 ;;
2228 ;; If this method, after this setup, only has primary methods, then
2229 ;; we can setup the generic that way.
2231 ;; If there is only one primary method, then we can go one more
2232 ;; optimization step.
2238 method)
2242 "Obsolete work part of an old version of the `defgeneric' macro."
2246 )
2248 method))
2249 ;; Don't do this over and over.
2251 ;; This defun tells emacs where the first definition of this
2252 ;; method is defined.
2254 ;; Make sure the method tables are installed.
2256 ;; Apply the actual body of this function.
2258 ;; Return the method
2264 ;;; eieio-core.el ends here