| blob | 34fb5b9c9fc246d44db02527868f2b93e0be392c |
1 ;;; eieio.el --- Enhanced Implementation of Emacs Interpreted Objects
2 ;;; or maybe Eric's Implementation of Emacs Intrepreted Objects
4 ;; Copyright (C) 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
5 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
7 ;; Author: Eric M. Ludlam <zappo@gnu.org>
8 ;; Version: 0.2
9 ;; Keywords: OO, lisp
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
27 ;;
28 ;; EIEIO is a series of Lisp routines which implements a subset of
29 ;; CLOS, the Common Lisp Object System. In addition, EIEIO also adds
30 ;; a few new features which help it integrate more strongly with the
31 ;; Emacs running environment.
32 ;;
33 ;; See eieio.texi for complete documentation on using this package.
35 ;; There is funny stuff going on with typep and deftype. This
36 ;; is the only way I seem to be able to make this stuff load properly.
38 ;; @TODO - fix :initform to be a form, not a quoted value
39 ;; @TODO - Prefix non-clos functions with `eieio-'.
41 ;;; Code:
51 "Display the current version of EIEIO."
56 ;; About the above. EIEIO must process its own code when it compiles
57 ;; itself, thus, by eval-and-compiling outselves, we solve the problem.
59 ;; Compatibility
62 ;; XEmacs can only access a compiled functions arglist like this:
65 ;; Emacs doesn't have this function, but since FUNC is a vector, we can just
66 ;; grab the appropriate element.
68 "Return the argument list for the compiled function FUNC."
71 )
73 \f
74 ;;;
75 ;; Variable declarations.
76 ;;
82 "*Non-nil to throw an error if an encountered tag us unsupported.
83 This may prevent classes from CLOS applications from being used with EIEIO
87 "*If non-nil, skip all slot typechecking.
88 Set this to t permanently if a program is functioning well to get a
89 small speed increase. This variable is also used internally to handle
95 ;; State Variables
97 "Inside a method, this variable is the object in question.
98 DO NOT SET THIS YOURSELF unless you are trying to simulate friendly slots.
100 Note: Embedded methods are no longer supported. The variable THIS is
101 still set for CLOS methods for the sake of routines like
105 "This is set to a class when a method is running.
106 This is so we know we are allowed to check private parts or how to
114 eieio-unbound
118 ;; This is a bootstrap for eieio-default-superclass so it has a value
119 ;; while it is being built itself.
125 (defconst class-symbol-obarray 4 "Obarray permitting fast access to variable position indexes.")
126 ;; @todo
127 ;; the word "public" here is leftovers from the very first version.
128 ;; Get rid of it!
149 "Cache index of what a newly created object would look like.
150 This will speed up instantiation time as only a `copy-sequence' will
151 be needed, instead of looping over all the values and setting them
154 "Storage location of tagged class options.
167 (defconst method-num-lists 4 "Number of indexes into methods vector in which groups of functions are kept.")
173 ;; How to specialty compile stuff.
177 \f
178 ;;; Important macros used in eieio.
179 ;;
181 "Internal: Return the class vector from the CLASS symbol."
182 ;; No check: If eieio gets this far, it's probably been checked already.
186 "Return t if CLASS is a valid class vector.
187 CLASS is a symbol."
188 ;; this new method is faster since it doesn't waste time checking lots of
189 ;; things.
195 "Return non-nil if OBJ is an EIEIO object."
204 "Return the symbol representing the constructor of CLASS."
208 "Return t if symbol METHOD is a generic function.
209 Only methods have the symbol `eieio-method-obarray' as a property
210 \(which contains a list of all bindings to that method type.)"
214 "Return t if symbol METHOD is a generic function with only primary methods.
215 Only methods have the symbol `eieio-method-obarray' as a property (which
216 contains a list of all bindings to that method type.)
217 Methods with only primary implementations are executed in an optimized way."
227 ))
230 "Return t if symbol METHOD is a generic function with only primary methods.
231 Only methods have the symbol `eieio-method-obarray' as a property (which
232 contains a list of all bindings to that method type.)
233 Methods with only primary implementations are executed in an optimized way."
243 ))
246 "Return from LIST the found OPTION.
247 Return nil if it doesn't exist."
251 "Return the value stored for CLASS' OPTION.
252 Return nil if that option doesn't exist."
256 "Return non-nil if CLASS is abstract.
257 Abstract classes cannot be instantiated."
261 "Return the invocation order of CLASS.
262 Abstract classes cannot be instantiated."
266 \f
267 ;;; Defining a new class
268 ;;
270 "Define NAME as a new class derived from SUPERCLASS with SLOTS.
271 OPTIONS-AND-DOC is used as the class' options and base documentation.
272 SUPERCLASS is a list of superclasses to inherit from, with SLOTS
273 being the slots residing in that class definition. NOTE: Currently
274 only one slot may exist in SUPERCLASS as multiple inheritance is not
275 yet supported. Supported tags are:
277 :initform - Initializing form.
278 :initarg - Tag used during initialization.
279 :accessor - Tag used to create a function to access this slot.
280 :allocation - Specify where the value is stored.
281 Defaults to `:instance', but could also be `:class'.
282 :writer - A function symbol which will `write' an object's slot.
283 :reader - A function symbol which will `read' an object.
284 :type - The type of data allowed in this slot (see `typep').
285 :documentation
286 - A string documenting use of this slot.
288 The following are extensions on CLOS:
289 :protection - Specify protection for this slot.
290 Defaults to `:public'. Also use `:protected', or `:private'.
291 :custom - When customizing an object, the custom :type. Public only.
292 :label - A text string label used for a slot when customizing.
293 :group - Name of a customization group this slot belongs in.
294 :printer - A function to call to print the value of a slot.
295 See `eieio-override-prin1' as an example.
297 A class can also have optional options. These options happen in place
298 of documentation (including a :documentation tag), in addition to
299 documentation, or not at all. Supported options are:
301 :documentation - The doc-string used for this class.
303 Options added to EIEIO:
305 :allow-nil-initform - Non-nil to skip typechecking of null initforms.
306 :custom-groups - List of custom group names. Organizes slots into
307 reasonable groups for customizations.
308 :abstract - Non-nil to prevent instances of this class.
309 If a string, use as an error string if someone does
310 try to make an instance.
311 :method-invocation-order
312 - Control the method invocation order if there is
313 multiple inheritance. Valid values are:
314 :breadth-first - The default.
315 :depth-first
317 Options in CLOS not supported in EIEIO:
319 :metaclass - Class to use in place of `standard-class'
320 :default-initargs - Initargs to use when initializing new objects of
321 this class.
323 Due to the way class options are set up, you can add any tags you wish,
324 and reference them using the function `class-option'."
325 ;; We must `eval-and-compile' this so that when we byte compile
326 ;; an eieio program, there is no need to load it ahead of time.
327 ;; It also provides lots of nice debugging errors at compile time.
334 ;; We autoload this because it's used in `make-autoload'.
335 ;;;###autoload
337 "Create autoload symbols for the EIEIO class CNAME.
338 SUPERCLASSES are the superclasses that CNAME inherits from.
339 DOC is the docstring for CNAME.
340 This function creates a mock-class for CNAME and adds it into
341 SUPERCLASSES as children.
342 It creates an autoload function for CNAME's constructor."
343 ;; Assume we've already debugged inputs.
347 )
349 nil ;; Do nothing if we already have this class.
351 ;; Create the class in NEWC, but don't fill anything else in.
356 ;; No parents?
359 clear-parent t)
360 )
362 ;; Hook our new class into the existing structures so we can
363 ;; autoload it later.
367 ;; TODO - If we create an autoload that is in the map, that
368 ;; map needs to be cleared!
371 ;; Does our parent exist?
374 ;; Create a symbol for this parent, and then store this
375 ;; parent on that symbol.
380 )
382 ;; We have a parent, save the child in there.
387 ;; save parent in child
389 )
391 ;; turn this into a useable self-pointing symbol
394 ;; Store the new class vector definition into the symbol. We need to
395 ;; do this first so that we can call defmethod for the accessor.
396 ;; The vector will be updated by the following while loop and will not
397 ;; need to be stored a second time.
400 ;; Clear the parent
403 ;; Create an autoload on top of our constructor function.
408 ))))
411 "If class CNAME is in an autoload state, load its file."
416 "Define CNAME as a new subclass of SUPERCLASSES.
417 SLOTS are the slots residing in that class definition, and options or
418 documentation OPTIONS-AND-DOC is the toplevel documentation for this class.
419 See `defclass' for more information."
420 ;; Run our eieio-hook each time, and clear it when we are done.
421 ;; This way people can add hooks safely if they want to modify eieio
422 ;; or add definitions when eieio is loaded or something like that.
439 ;; If this class already existed, and we are updating its structure,
440 ;; make sure we keep the old child list. This can cause bugs, but
441 ;; if no new slots are created, it also saves time, and prevents
442 ;; method table breakage, particularly when the users is only
443 ;; byte compiling an EIEIO file.
446 ;; If the old class did not exist, but did exist in the autoload map, then adopt those children.
447 ;; This is like the above, but deals with autoloads nicely.
454 ))
455 )
463 )
468 options-and-doc))
475 ;; bad class
477 ;; good parent class...
478 ;; save new child in parent
482 ;; Get custom groups, and store them into our local copy.
485 ;; save parent in child
489 ;; Reverse the list of our parents so that they are prioritized in
490 ;; the same order as specified in the code.
492 ;; If there is nothing to loop over, then inherit from the
493 ;; default superclass.
495 ;; adopt the default parent here, but clear it later...
497 ;; save new child in parent
501 ;; save parent in child
504 ;; turn this into a useable self-pointing symbol
507 ;; These two tests must be created right away so we can have self-
508 ;; referencing classes. ei, a class whose slot can contain only
509 ;; pointers to itself.
511 ;; Create the test function
519 ;; Make sure the method invocation order is a valid value.
523 ))
525 ;; Create a handy child test too
530 "Test OBJ to see if it an object is a child of type %s"
531 cname)
535 ;; When using typep, (typep OBJ 'myclass) returns t for objects which
536 ;; are subclasses of myclass. For our predicates, however, it is
537 ;; important for EIEIO to be backwards compatible, where
538 ;; myobject-p, and myobject-child-p are different.
539 ;; "cl" uses this technique to specify symbols with specific typep
540 ;; test, so we can let typep have the CLOS documented behavior
541 ;; while keeping our above predicate clean.
543 ;; It would be cleaner to use `defsetf' here, but that requires cl
544 ;; at runtime.
548 ;; before adding new slots, lets add all the methods and classes
549 ;; in from the parent class
552 ;; Store the new class vector definition into the symbol. We need to
553 ;; do this first so that we can call defmethod for the accessor.
554 ;; The vector will be updated by the following while loop and will not
555 ;; need to be stored a second time.
558 ;; Query each slot in the declaration list and mangle into the
559 ;; class structure I have defined.
567 eieio-unbound)))
581 )
587 :initform
588 :initarg
589 :documentation
590 :protection
591 :reader
592 :writer
593 :allocation
594 :type
595 :custom
596 :label
597 :group
598 :printer
599 :allow-nil-initform
604 ;; Clean up the meaning of protection.
611 ;; Make sure the :allocation parameter has a valid value.
615 ;; The default type specifier is supposed to be t, meaning anything.
618 ;; Label is nil, or a string
622 ;; Is there an initarg, but allocation of class?
626 ;; intern the symbol so we can use it blankly
629 ;; The customgroup should be a list of symbols
634 ;; The customgroup better be a symbol, or list of symbols.
638 customg)
640 ;; First up, add this slot into our new class.
644 ;; We need to id the group, and store them in a group list attribute.
647 ;; anyone can have an accessor function. This creates a function
648 ;; of the specified name, and also performs a `defsetf' if applicable
649 ;; so that users can `setf' the space returned by this function
656 "Retrieves the slot `%s' from an object of class `%s'"
657 name cname)
660 ;; Else - Some error? nil?
661 nil)))
663 ;; Provide a setf method. It would be cleaner to use
664 ;; defsetf, but that would require CL at runtime.
676 ;; If a writer is defined, then create a generic method of that
677 ;; name whose purpose is to set the value of the slot.
683 name cname)
685 ))
686 ;; If a reader is defined, then create a generic method
687 ;; of that name whose purpose is to access this slot value.
693 name cname)
695 )
698 ;; Now that everything has been loaded up, all our lists are backwards! Fix that up now.
711 ;; The storage for class-class-allocation-type needs to be turned into
712 ;; a vector now.
716 ;; Also, take class allocated values, and vectorize them for speed.
720 ;; Attach slot symbols into an obarray, and store the index of
721 ;; this slot as the variable slot in this new symbol. We need to
722 ;; know about primes, because obarrays are best set in vectors of
723 ;; prime number length, and we also need to make our vector small
724 ;; to save space, and also optimal for the number of items we have.
744 )
746 ;; Create the constructor function
748 ;; Abstract classes cannot be instantiated. Say so.
757 ;; Non-abstract classes need a constructor.
762 )
764 ;; Set up a specialized doc string.
765 ;; Use stored value since it is calculated in a non-trivial way
769 ;; We have a list of custom groups. Store them into the options.
776 ;; Set up the options we have collected.
779 ;; if this is a superclass, clear out parent (which was set to the
780 ;; default superclass eieio-default-superclass)
783 ;; Create the cached default object.
790 ;; All type-checking has been done to our satisfaction
791 ;; before this call. Don't waste our time in this call..
795 ;; Return our new class object
796 ;; newc
797 cname
798 ))
801 "For SLOT, signal if SPEC does not match VALUE.
802 If SKIPNIL is non-nil, then if VALUE is nil return t instead."
811 "Add into NEWC attribute A.
812 If A already exists in NEWC, then do nothing. If it doesn't exist,
813 then also add in D (default), DOC, TYPE, CUST, LABEL, CUSTG, PRINT, PROT, and INIT arg.
814 Argument ALLOC specifies if the slot is allocated per instance, or per class.
815 If optional DEFAULTOVERRIDE is non-nil, then if A exists in NEWC,
816 we must override its value for a default.
817 Optional argument SKIPNIL indicates if type checking should be skipped
818 if default value is nil."
819 ;; Make sure we duplicate those items that are sequences.
822 ;; This copy can fail on a cons cell with a non-cons in the cdr. Lets skip it if it doesn't work.
828 ;; To prevent override information w/out specification of storage,
829 ;; we need to do this little hack.
833 ;; In this case, we modify the INSTANCE version of a given slot.
837 ;; Only add this element if it is so-far unique
851 )
852 ;; When defaultoverride is true, we are usually adding new local
853 ;; attributes which must override the default value of any slot
854 ;; passed in by one of the parent classes.
856 ;; There is a match, and we must override the old value.
861 nil))
863 )
866 a)
867 ;; If type is passed in, is it the same?
871 "Child slot type `%s' does not match inherited type `%s' for `%s'"
872 type tp a)))
873 ;; If we have a repeat, only update the initarg...
877 ;; If we have a new initarg, check for it.
881 ;; Replace the CAR of the associate INITA.
882 ;;(message "Initarg: %S replace %s" inita init)
884 ))
886 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
887 ;; checked and SHOULD match the superclass
888 ;; protection. Otherwise an error is thrown. However
889 ;; I wonder if a more flexible schedule might be
890 ;; implemented.
891 ;;
892 ;; EML - We used to have (if prot... here,
893 ;; but a prot of 'nil means public.
894 ;;
896 )
899 prot super-prot a)))
900 ;; End original PLN
902 ;; PLN Tue Jun 26 11:57:06 2007 :
903 ;; Do a non redundant combination of ancient custom
904 ;; groups and new ones.
916 ;; End PLN
918 ;; PLN Mon Jun 25 22:44:34 2007 : If a new cust is
919 ;; set, simply replaces the old one.
921 ;; (message "Custom type redefined to %s" cust)
924 ;; If a new label is specified, it simply replaces
925 ;; the old one.
927 ;; (message "Custom label redefined to %s" label)
929 ;; End PLN
931 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
932 ;; doc is specified, simply replaces the old one.
934 ;;(message "Documentation redefined to %s" doc)
936 doc))
937 ;; End PLN
939 ;; If a new printer is specified, it simply replaces
940 ;; the old one.
942 ;; (message "printer redefined to %s" print)
945 )))
946 ))
948 ;; CLASS ALLOCATED SLOTS
953 ;; Here we have found a :class version of a slot. This
954 ;; requires a very different aproach.
959 (aset newc class-class-allocation-custom-label (cons label (aref newc class-class-allocation-custom-label)))
960 (aset newc class-class-allocation-custom-group (cons custg (aref newc class-class-allocation-custom-group)))
961 (aset newc class-class-allocation-protection (cons prot (aref newc class-class-allocation-protection)))
962 ;; Default value is stored in the 'values section, since new objects
963 ;; can't initialize from this element.
964 (aset newc class-class-allocation-values (cons value (aref newc class-class-allocation-values))))
966 ;; There is a match, and we must override the old value.
973 nil))
975 nil)))
978 a)
979 ;; If type is passed in, is it the same?
983 "Child slot type `%s' does not match inherited type `%s' for `%s'"
984 type tp a)))
985 ;; EML - Note: the only reason to override a class bound slot
986 ;; is to change the default, so allow unbound in.
988 ;; If we have a repeat, only update the vlaue...
992 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
993 ;; checked and SHOULD match the superclass
994 ;; protection. Otherwise an error is thrown. However
995 ;; I wonder if a more flexible schedule might be
996 ;; implemented.
1001 prot super-prot a)))
1002 ;; Do a non redundant combination of ancient custom groups
1003 ;; and new ones.
1016 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
1017 ;; doc is specified, simply replaces the old one.
1019 ;;(message "Documentation redefined to %s" doc)
1021 doc))
1022 ;; End PLN
1024 ;; If a new printer is specified, it simply replaces
1025 ;; the old one.
1027 ;; (message "printer redefined to %s" print)
1030 ))
1031 ))
1032 ))
1035 "Copy into NEWC the slots of PARENTS.
1036 Follow the rules of not overwriting early parents when applying to
1037 the new child class."
1042 ;; First, duplicate all the slots of the parent.
1061 ;; Increment each value.
1073 ;; Now duplicate all the class alloc slots.
1090 ;; Increment each value.
1100 ;; Loop over each parent class
1102 ))
1104 ;;; CLOS style implementation of object creators.
1105 ;;
1107 "Make a new instance of CLASS based on INITARGS.
1108 CLASS is a class symbol. For example:
1110 (make-instance 'foo)
1112 INITARGS is a property list with keywords based on the :initarg
1113 for each slot. For example:
1115 (make-instance 'foo :slot1 value1 :slotN valueN)
1117 Compatibility note:
1119 If the first element of INITARGS is a string, it is used as the
1120 name of the class.
1122 In EIEIO, the class' constructor requires a name for use when printing.
1123 `make-instance' in CLOS doesn't use names the way Emacs does, so the
1124 class is used as the name slot instead when INITARGS doesn't start with
1125 a string."
1131 initargs)))
1133 \f
1134 ;;; CLOS methods and generics
1135 ;;
1137 "Create a generic function METHOD.
1138 DOC-STRING is the base documentation for this class. A generic
1139 function has no body, as its purpose is to decide which method body
1140 is appropriate to use. Uses `defmethod' to create methods, and calls
1141 `defgeneric' for you. With this implementation the ARGS are
1142 currently ignored. You can use `defgeneric' to apply specialized
1143 top level documentation to a method."
1147 "The lambda form that would be used as the function defined on METHOD.
1148 All methods should call the same EIEIO function for dispatch.
1149 DOC-STRING is the documentation attached to METHOD."
1151 ,doc-string
1155 "Setup METHOD to call the generic form."
1160 "The lambda form that would be used as the function defined on METHOD.
1161 All methods should call the same EIEIO function for dispatch.
1162 DOC-STRING is the documentation attached to METHOD."
1164 ,doc-string
1168 "Setup METHOD to call the generic form."
1173 class
1174 impl
1175 )
1176 "The lambda form that would be used as the function defined on METHOD.
1177 All methods should call the same EIEIO function for dispatch.
1178 DOC-STRING is the documentation attached to METHOD.
1179 CLASS is the class symbol needed for private method access.
1180 IMPL is the symbol holding the method implementation."
1181 ;; NOTE: I tried out byte compiling this little fcn. Turns out it
1182 ;; is faster to execute this for not byte-compiled. ie, install this,
1183 ;; then measure calls going through here. I wonder why.
1187 )
1190 ,doc-string
1191 ;; This is a cool cheat. Usually we need to look up in the
1192 ;; method table to find out if there is a method or not. We can
1193 ;; instead make that determination at load time when there is
1194 ;; only one method. If the first arg is not a child of the class
1195 ;; of that one implementation, then clearly, there is no method def.
1197 ;; Not an object. Just signal.
1200 ;; We do have an object. Make sure it is the right type.
1202 nil ; default superclass means just an obj. Already asked.
1205 )
1207 ;; If not the right kind of object, call no applicable
1211 ;; It is ok, do the call.
1212 ;; Fill in inter-call variables then evaluate the method.
1218 )
1220 ;(,impl local-args)
1221 ))))
1222 )
1223 ))
1226 "Setup METHOD to call the generic form."
1230 )
1232 method doc-string
1235 ))))
1238 "Engine part to `defgeneric' macro defining METHOD with DOC-STRING."
1242 )
1244 method))
1245 ;; Don't do this over and over.
1247 ;; This defun tells emacs where the first definition of this
1248 ;; method is defined.
1250 ;; Make sure the method tables are installed.
1252 ;; Apply the actual body of this function.
1254 ;; Return the method
1258 "Make the generic method METHOD have no implementations.
1259 It will leave the original generic function in place,
1260 but remove reference to all implementations of METHOD."
1265 "Create a new METHOD through `defgeneric' with ARGS.
1267 The optional second argument KEY is a specifier that
1268 modifies how the method is called, including:
1269 :before - Method will be called before the :primary
1270 :primary - The default if not specified
1271 :after - Method will be called after the :primary
1272 :static - First arg could be an object or class
1273 The next argument is the ARGLIST. The ARGLIST specifies the arguments
1274 to the method as with `defun'. The first argument can have a type
1275 specifier, such as:
1276 ((VARNAME CLASS) ARG2 ...)
1277 where VARNAME is the name of the local variable for the method being
1278 created. The CLASS is a class symbol for a class made with `defclass'.
1279 A DOCSTRING comes after the ARGLIST, and is optional.
1280 All the rest of the args are the BODY of the method. A method will
1281 return the value of the last form in the BODY.
1283 Summary:
1285 (defmethod mymethod [:before | :primary | :after | :static]
1286 ((typearg class-name) arg2 &optional opt &rest rest)
1288 body)"
1292 "Work part of the `defmethod' macro defining METHOD with ARGS."
1294 ;; find optional keys
1299 method-before)
1303 method-after)
1307 method-primary)
1311 method-static)
1312 ;; Primary key
1314 ;; get body, and fix contents of args to be the arguments of the fn.
1318 ;; Create a fixed version of the arguments
1321 argfix))
1323 ;; make sure there is a generic
1325 method
1328 ;; create symbol for property to bind to. If the first arg is of
1329 ;; the form (varname vartype) and `vartype' is a class, then
1330 ;; that class will be the type symbol. If not, then it will fall
1331 ;; under the type `primary' which is a non-specific calling of the
1332 ;; function.
1342 ;; generics are higher
1344 ;; Put this lambda into the symbol so we can find it
1348 key argclass))
1349 )
1352 ;; Optimizing step:
1353 ;;
1354 ;; If this method, after this setup, only has primary methods, then
1355 ;; we can setup the generic that way.
1357 ;; If there is only one primary method, then we can go one more
1358 ;; optimization step.
1364 method)
1366 ;;; Slot type validation
1368 ;; This is a hideous hack for replacing `typep' from cl-macs, to avoid
1369 ;; requiring the CL library at run-time. It can be eliminated if/when
1370 ;; `typep' is merged into Emacs core.
1414 "Return non-nil if SPEC does not match VALUE."
1420 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1421 Checks the :type specifier.
1422 SLOT is the slot that is being checked, and is only used when throwing
1423 an error."
1425 nil
1426 ;; Trim off object IDX junk added in for the object index.
1433 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1434 Checks the :type specifier.
1435 SLOT is the slot that is being checked, and is only used when throwing
1436 an error."
1438 nil
1440 slot-idx)))
1445 "Throw a signal if VALUE is a representation of an UNBOUND slot.
1446 INSTANCE is the object being referenced. SLOTNAME is the offending
1447 slot. If the slot is ok, return VALUE.
1448 Argument FN is the function calling this verifier."
1451 value))
1453 ;;; Get/Set slots in an object.
1454 ;;
1456 "Retrieve the value stored in OBJ in the slot named by SLOT.
1457 Slot is the name of the slot when created by `defclass' or the label
1458 created by the :initarg tag."
1462 "Return the value in OBJ at SLOT in the object vector."
1471 ;; It might be missing because it is a :class allocated slot.
1472 ;; Lets check that info out.
1474 ;; Oref that slot.
1476 ;; The slot-missing method is a cool way of allowing an object author
1477 ;; to intercept missing slot definitions. Since it is also the LAST
1478 ;; thing called in this fn, its return value would be retrieved.
1480 ;;(signal 'invalid-slot-name (list (object-name obj) slot))
1481 )
1490 "Get the default value of OBJ (maybe a class) for SLOT.
1491 The default value is the value installed in a class with the :initform
1492 tag. SLOT can be the slot name, or the tag specified by the :initarg
1493 tag in the `defclass' call."
1497 "Do the work for the macro `oref-default' with similar parameters.
1498 Fills in OBJ's SLOT with its default value."
1499 (if (not (or (eieio-object-p obj) (class-p obj))) (signal 'wrong-type-argument (list 'eieio-object-p obj)))
1504 ;; It might be missing because it is a :class allocated slot.
1505 ;; Lets check that info out.
1508 ;; Oref that slot.
1510 c)
1512 ;;(signal 'invalid-slot-name (list (class-name cl) slot))
1513 )
1520 "Check VAL, and return what `oref-default' would provide."
1521 ;; check for quoted things, and unquote them
1524 ;; return it verbatim
1525 val))
1527 ;;; Object Set macros
1528 ;;
1530 "Set the value in OBJ for slot SLOT to VALUE.
1531 SLOT is the slot name as specified in `defclass' or the tag created
1532 with in the :initarg slot. VALUE can be any Lisp object."
1536 "Do the work for the macro `oset'.
1537 Fills in OBJ's SLOT with VALUE."
1542 ;; It might be missing because it is a :class allocated slot.
1543 ;; Lets check that info out.
1546 ;; Oset that slot.
1550 class-class-allocation-values)
1551 c value))
1552 ;; See oref for comment on `slot-missing'
1554 ;;(signal 'invalid-slot-name (list (object-name obj) slot))
1555 )
1560 "Set the default slot in CLASS for SLOT to VALUE.
1561 The default value is usually set with the :initform tag during class
1562 creation. This allows users to change the default behavior of classes
1563 after they are created."
1567 "Do the work for the macro `oset-default'.
1568 Fills in the default value in CLASS' in SLOT with VALUE."
1574 ;; It might be missing because it is a :class allocated slot.
1575 ;; Lets check that info out.
1578 ;; Oref that slot.
1581 value))
1584 ;; Set this into the storage for defaults.
1586 value)
1587 ;; Take the value, and put it into our cache object.
1589 slot value)
1590 )))
1592 ;;; Handy CLOS macros
1593 ;;
1595 "Bind SPEC-LIST lexically to slot values in OBJECT, and execute BODY.
1596 This establishes a lexical environment for referring to the slots in
1597 the instance named by the given slot-names as though they were
1598 variables. Within such a context the value of the slot can be
1599 specified by using its slot name, as if it were a lexically bound
1600 variable. Both setf and setq can be used to set the value of the
1601 slot.
1603 SPEC-LIST is of a form similar to `let'. For example:
1605 ((VAR1 SLOT1)
1606 SLOT2
1607 SLOTN
1608 (VARN+1 SLOTN+1))
1610 Where each VAR is the local variable given to the associated
1611 SLOT. A slot specified without a variable name is given a
1612 variable name of the same name as the slot."
1614 ;; Transform the spec-list into a symbol-macrolet spec-list.
1619 spec-list)))
1621 body)))
1622 \f
1623 ;;; Simple generators, and query functions. None of these would do
1624 ;; well embedded into an object.
1625 ;;
1631 ;; I think this is supposed to return a symbol, but to me CLASS is a symbol,
1632 ;; and I wanted a string. Arg!
1636 "Return a Lisp like symbol string for object OBJ.
1637 If EXTRA, include that in the string returned to represent the symbol."
1664 "Return parent classes to CLASS. (overload of variable).
1666 The CLOS function `class-direct-superclasses' is aliased to this function."
1674 "Return child classes to CLASS.
1676 The CLOS function `class-direct-subclasses' is aliased to this function."
1680 ;; Official CLOS functions.
1690 (defmacro same-class-fast-p (obj class) "Return t if OBJ is of class-type CLASS with no error checking."
1699 "Return non-nil if OBJ is an instance of CLASS or CLASS' subclasses."
1701 ;; class will be checked one layer down
1703 ;; Backwards compatibility
1707 "Return non-nil if CHILD class is a subclass of CLASS."
1729 f))
1731 ;;; CLOS queries into classes and slots
1732 ;;
1734 "Return non-nil if OBJECT's SLOT is bound.
1735 Setting a slot's value makes it bound. Calling `slot-makeunbound' will
1736 make a slot unbound.
1737 OBJECT can be an instance or a class."
1738 ;; Skip typechecking while retrieving this value.
1740 ;; Return nil if the magic symbol is in there.
1748 "In OBJECT, make SLOT unbound."
1752 "Return non-nil if OBJECT-OR-CLASS has SLOT."
1756 object-or-class))
1757 )))
1760 ))
1763 "Return the class that SYMBOL represents.
1764 If there is no class, nil is returned if ERRORP is nil.
1765 If ERRORP is non-nil, `wrong-argument-type' is signaled."
1768 nil)
1771 ;;; Slightly more complex utility functions for objects
1772 ;;
1774 "Return an object if KEY is `equal' to SLOT's value of an object in LIST.
1775 LIST is a list of objects whose slots are searched.
1776 Objects in LIST do not need to have a slot named SLOT, nor does
1777 SLOT need to be bound. If these errors occur, those objects will
1778 be ignored."
1781 ;; This prevents errors for missing slots.
1788 "Return an association list with the contents of SLOT as the key element.
1789 LIST must be a list of objects with SLOT in it.
1790 This is useful when you need to do completing read on an object group."
1796 assoclist))
1801 "Return an association list with the contents of SLOT as the key element.
1802 LIST must be a list of objects, but those objects do not need to have
1803 SLOT in it. If it does not, then that element is left out of the association
1804 list."
1811 assoclist)))
1816 "In OBJECT's SLOT, add ITEM to the list of elements.
1817 Optional argument APPEND indicates we need to append to the list.
1818 If ITEM already exists in the list in SLOT, then it is not added.
1819 Comparison is done with `equal' through the `member' function call.
1820 If SLOT is unbound, bind it to the list containing ITEM."
1822 ;; Find the originating list.
1826 ;; turn it into a list.
1829 ;; Do the combination
1835 ;; Set back into the slot.
1839 "In OBJECT's SLOT, remove occurrences of ITEM.
1840 Deletion is done with `delete', which deletes by side effect,
1841 and comparisons are done with `equal'.
1842 If SLOT is unbound, do nothing."
1844 nil
1846 \f
1847 ;;; EIEIO internal search functions
1848 ;;
1850 "Return non-nil if START-CLASS is the first class to define SLOT.
1851 This is for testing if `scoped-class' is the class that defines SLOT
1852 so that we can protect private slots."
1856 t
1860 class-symbol-obarray))
1863 ret)))
1866 "In CLASS for OBJ find the index of the named SLOT.
1867 The slot is a symbol which is installed in CLASS by the `defclass'
1868 call. OBJ can be nil, but if it is an object, and the slot in question
1869 is protected, access will be allowed if OBJ is a child of the currently
1870 `scoped-class'.
1871 If SLOT is the value created with :initarg instead,
1872 reverse-lookup that name, and recurse with the associated slot value."
1873 ;; Removed checks to outside this call
1876 class-symbol-obarray)))
1883 scoped-class
1891 eieio-initializing-object))
1898 "In CLASS find the index of the named SLOT.
1899 The slot is a symbol which is installed in CLASS by the `defclass'
1900 call. If SLOT is the value created with :initarg instead,
1901 reverse-lookup that name, and recurse with the associated slot value."
1902 ;; This will happen less often, and with fewer slots. Do this the
1903 ;; storage cheap way.
1908 ;; Slot # is length of the total list, minus the remaining list of
1909 ;; the found slot.
1911 \f
1912 ;;; CLOS generics internal function handling
1913 ;;
1919 "When using `call-next-method', provides a context for the current key.
1922 "When executing a PRIMARY or STATIC method, track the 'next-method'.
1923 During executions, the list is first generated, then as each next method
1927 "*Hooks run just before a method is executed.
1928 The hook function must accept one argument, the list of forms
1932 "Call METHOD with ARGS.
1933 ARGS provides the context on which implementation to use.
1934 This should only be called from a generic function."
1935 ;; We must expand our arguments first as they are always
1936 ;; passed in as quoted symbols
1942 ;; get a copy
1945 ;; Is the class passed in autoloaded?
1946 ;; Since class names are also constructors, they can be autoloaded
1947 ;; via the autoload command. Check for this, and load them in.
1948 ;; It's ok if it doesn't turn out to be a class. Probably want that
1949 ;; function loaded anyway.
1955 ;; Determine the class to use.
1960 )
1961 ;; Make sure the class is a valid class
1962 ;; mclass can be nil (meaning a generic for should be used.
1963 ;; mclass cannot have a value that is not a class, however.
1966 method mclass)
1967 )
1968 ;; Now create a list in reverse order of all the calls we have
1969 ;; make in order to successfully do this right. Rules:
1970 ;; 1) Only call generics if scoped-class is not defined
1971 ;; This prevents multiple calls in the case of recursion
1972 ;; 2) Only call static if this is a static method.
1973 ;; 3) Only call specifics if the definition allows for them.
1974 ;; 4) Call in order based on :before, :primary, and :after
1976 ;; Non-static calls do all this stuff.
1978 ;; :after methods
1983 ;;(or (and mclass (eieio-generic-form method method-after mclass))
1984 ;; (eieio-generic-form method method-after nil))
1985 )
1989 ;; :primary methods
1996 primarymethodlist
1999 ;; :before methods
2004 ;;(or (and mclass (eieio-generic-form method method-before mclass))
2005 ;; (eieio-generic-form method method-before nil))
2006 )
2009 )
2011 ;; If there were no methods found, then there could be :static methods.
2017 primarymethodlist ;; Re-use even with bad name here
2021 primarymethodlist)
2023 ;; Now loop through all occurrences forms which we must execute
2024 ;; (which are happily sorted now) and execute them all!
2034 ;; Use the cdr, as the first element is the fcn
2035 ;; we are calling right now.
2037 )
2039 ;;(setq rval (apply (car (car lambdas)) newargs))
2043 rvalever t))
2044 ))
2050 rvalever t)
2052 'no-method-definition
2054 ;; Right Here... it could be that lastval is returned when
2055 ;; rvalever is nil. Is that right?
2056 rval)))
2059 "Call METHOD with ARGS for methods with only :PRIMARY implementations.
2060 ARGS provides the context on which implementation to use.
2061 This should only be called from a generic function.
2063 This method is like `eieio-generic-call', but only
2064 implementations in the :PRIMARY slot are queried. After many
2065 years of use, it appears that over 90% of methods in use
2066 have :PRIMARY implementations only. We can therefore optimize
2067 for this common case to improve performance."
2068 ;; We must expand our arguments first as they are always
2069 ;; passed in as quoted symbols
2075 )
2076 ;; get a copy
2080 ;; Determine the class to use.
2089 method)
2090 ))
2091 ;; Make sure the class is a valid class
2092 ;; mclass can be nil (meaning a generic for should be used.
2093 ;; mclass cannot have a value that is not a class, however.
2096 )
2098 ;; :primary methods
2103 ;; Now loop through all occurrences forms which we must execute
2104 ;; (which are happily sorted now) and execute them all!
2108 ;; Use the cdr, as the first element is the fcn
2109 ;; we are calling right now.
2111 )
2115 ;; No methods found for this impl...
2118 rvalever t)
2120 'no-method-definition
2123 ;; Do the regular implementation here.
2126 lambdas)
2130 rvalever t)
2131 )
2133 ;; Right Here... it could be that lastval is returned when
2134 ;; rvalever is nil. Is that right?
2135 rval)))
2138 "Return an alist list of methods lambdas.
2139 METHOD is the method name.
2140 KEY represents either :before, or :after methods.
2141 CLASS is the starting class to search from in the method tree.
2142 If CLASS is nil, then an empty list of methods should be returned."
2143 ;; Note: eieiomt - the MT means MethodTree. See more comments below
2144 ;; for the rest of the eieiomt methods.
2148 ;; Note: a nil can show up in the class list once we start
2149 ;; searching through the method tree.
2151 ;; lookup the form to use for the PRIMARY object for the next level
2154 ;; This prevents duplicates coming out of the
2155 ;; class method optimizer. Perhaps we should
2156 ;; just not optimize before/afters?
2161 ;; Add new classes to mclass. Since our input might not be a class
2162 ;; protect against that.
2164 ;; If there is a class, append any methods it may provide
2165 ;; to the remainder of the class list.
2168 ;; Depth first.
2170 ;; Breadth first.
2172 )
2173 ;; Advance to next entry in mclass if it is nil.
2175 )
2177 lambdas
2181 "Return non-nil if there is a next method.
2182 Returns a list of lambda expressions which is the `next-method'
2183 order."
2184 eieio-generic-call-next-method-list)
2187 "Call the superclass method from a subclass method.
2188 The superclass method is specified in the current method list,
2189 and is called the next method.
2191 If REPLACEMENT-ARGS is non-nil, then use them instead of
2192 `eieio-generic-call-arglst'. The generic arg list are the
2193 arguments passed in at the top level.
2195 Use `next-method-p' to find out if there is a next method to call."
2201 )
2204 )
2211 )
2213 ))))
2214 \f
2215 ;;;
2216 ;; eieio-method-tree : eieiomt-
2217 ;;
2218 ;; Stored as eieio-method-tree in property list of a generic method
2219 ;;
2220 ;; (eieio-method-tree . [BEFORE PRIMARY AFTER
2221 ;; genericBEFORE genericPRIMARY genericAFTER])
2222 ;; and
2223 ;; (eieio-method-obarray . [BEFORE PRIMARY AFTER
2224 ;; genericBEFORE genericPRIMARY genericAFTER])
2225 ;; where the association is a vector.
2226 ;; (aref 0 -- all static methods.
2227 ;; (aref 1 -- all methods classified as :before
2228 ;; (aref 2 -- all methods classified as :primary
2229 ;; (aref 3 -- all methods classified as :after
2230 ;; (aref 4 -- a generic classified as :before
2231 ;; (aref 5 -- a generic classified as :primary
2232 ;; (aref 6 -- a generic classified as :after
2233 ;;
2238 "Install the method tree, and obarray onto METHOD-NAME.
2239 Do not do the work if they already exist."
2252 ))))
2255 "Add to METHOD-NAME the forms METHOD in a call position KEY for CLASS.
2256 METHOD-NAME is the name created by a call to `defgeneric'.
2257 METHOD are the forms for a given implementation.
2258 KEY is an integer (see comment in eieio.el near this function) which
2259 is associated with the :static :before :primary and :after tags.
2260 It also indicates if CLASS is defined or not.
2261 CLASS is the class this method is associated with."
2266 ;; Make sure the method tables are available.
2269 ;; only add new cells on if it doesn't already exist!
2273 ;; Add function definition into newly created symbol, and store
2274 ;; said symbol in the correct obarray, otherwise use the
2275 ;; other array to keep this stuff
2279 ;; Now optimize the entire obarray
2282 ;; @todo - Is this overkill? Should we just clear the symbol?
2284 ))
2287 "Return the next parent class for CLASS.
2288 If CLASS is a superclass, return variable `eieio-default-superclass'.
2289 If CLASS is variable `eieio-default-superclass' then return nil.
2290 This is different from function `class-parent' as class parent returns
2291 nil for superclasses. This function performs no type checking!"
2292 ;; No type-checking because all calls are made from functions which
2293 ;; are safe and do checking for us.
2296 nil
2300 "Find the next class above S which has a function body for the optimizer."
2301 ;; (message "Optimizing %S" s)
2306 ;; This converts ES from a single symbol to a list of parent classes.
2308 ;; Loop over ES, then its children individually.
2309 ;; We can have multiple hits only at one level of the parent tree.
2317 ;; Pre-pend the subclasses of (car es) so we get
2318 ;; DEPTH FIRST optimization.
2320 ;; Else, we are breadth first.
2321 ;; (message "Class %s is breadth first" es)
2323 )))
2324 ;; If there is no nearest call, then set our value to nil
2326 ))
2329 "Return the lambda form belonging to METHOD using KEY based upon CLASS.
2330 If CLASS is not a class then use `generic' instead. If class has
2331 no form, but has a parent class, then trace to that parent class.
2332 The first time a form is requested from a symbol, an optimized path
2333 is memorized for faster future use."
2337 ;; 1) find our symbol
2340 ;; 2) If there isn't one, then make one.
2341 ;; This can be slow since it only occurs once
2344 ;; 2.1) Cache its nearest neighbor with a quick optimize
2345 ;; which should only occur once for this call ever
2348 ;; 3) If it's bound return this one.
2351 ;; 4) If it's not bound then this variable knows something
2354 ;; 4.1) This symbol holds the next class in its value
2357 ;; 4.2) The optimizer should always have chosen a
2358 ;; function-symbol
2359 ;;(if (fboundp cs)
2361 class-symbol))
2362 ;;(error "EIEIO optimizer: erratic data loss!"))
2363 )
2364 ;; There never will be a funcall...
2365 nil)))
2366 ;; for a generic call, what is a list, is the function body we want.
2370 ;; The car of EMTL is supposed to be a class, which in this
2371 ;; case is nil, so skip it.
2373 nil)))))
2375 ;;;
2376 ;; Way to assign slots based on a list. Used for constructors, or
2377 ;; even resetting an object at run-time
2378 ;;
2380 "Take object OBJ, and reset all slots to their defaults.
2381 If SET-ALL is non-nil, then when a default is nil, that value is
2382 reset. If SET-ALL is nil, the slots are only reset if the default is
2383 not nil."
2394 "For CLASS, convert INITARG to the actual attribute name.
2395 If there is no translation, pass it in directly (so we can cheat if
2396 need be... May remove that later...)"
2400 nil)))
2403 "In CLASS, convert the ATTRIBUTE into the corresponding init argument tag.
2404 This is usually a symbol that starts with `:'."
2408 nil)))
2410 \f
2411 ;;; Here are some special types of errors
2412 ;;
2433 ;;; Here are some CLOS items that need the CL package
2434 ;;
2439 ;; The below setf method was written by Arnd Kohrs <kohrs@acm.org>
2450 store-temp)
2453 \f
2454 ;;;
2455 ;; We want all objects created by EIEIO to have some default set of
2456 ;; behaviours so we can create object utilities, and allow various
2457 ;; types of error checking. To do this, create the default EIEIO
2458 ;; class, and when no parent class is specified, use this as the
2459 ;; default. (But don't store it in the other classes as the default,
2460 ;; allowing for transparent support.)
2461 ;;
2464 nil
2465 "Default parent class for classes with no specified parent class.
2466 Its slots are automatically adopted by classes with no specified parents.
2467 This class is not stored in the `parent' slot of a class vector."
2477 "Default constructor for CLASS `eieio-default-superclass'.
2478 NEWNAME is the name to be given to the constructed object.
2479 SLOTS are the initialization slots used by `shared-initialize'.
2480 This static method is called when an object is constructed.
2481 It allocates the vector used to represent an EIEIO object, and then
2482 calls `shared-initialize' on that object."
2484 class-default-object-cache))))
2485 ;; Update the name for the newly created object.
2487 ;; Call the initialize method on the new object with the slots
2488 ;; that were passed down to us.
2490 ;; Return the created object.
2491 new-object))
2494 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2498 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2499 Called from the constructor routine."
2514 "Construct the new object THIS based on SLOTS.
2515 SLOTS is a tagged list where odd numbered elements are tags, and
2516 even numbered elements are the values to store in the tagged slot.
2517 If you overload the `initialize-instance', there you will need to
2518 call `shared-initialize' yourself, or you can call `call-next-method'
2519 to have this constructor called automatically. If these steps are
2520 not taken, then new objects of your class will not have their values
2521 dynamically set from SLOTS."
2522 ;; First, see if any of our defaults are `lambda', and
2523 ;; re-evaluate them and apply the value to our slots.
2530 ;; Shared initialize will parse our slots for us.
2538 "Method invoked when an attempt to access a slot in OBJECT fails.
2539 SLOT-NAME is the name of the failed slot, OPERATION is the type of access
2540 that was requested, and optional NEW-VALUE is the value that was desired
2541 to be set.
2543 This method is called from `oref', `oset', and other functions which
2544 directly reference slots in EIEIO objects."
2546 slot-name)))
2552 class slot-name fn)
2553 "Slot unbound is invoked during an attempt to reference an unbound slot.
2554 OBJECT is the instance of the object being reference. CLASS is the
2555 class of OBJECT, and SLOT-NAME is the offending slot. This function
2556 throws the signal `unbound-slot'. You can overload this function and
2557 return the value to use in place of the unbound value.
2558 Argument FN is the function signaling this error.
2559 Use `slot-boundp' to determine if a slot is bound or not.
2561 In CLOS, the argument list is (CLASS OBJECT SLOT-NAME), but
2562 EIEIO can only dispatch on the first argument, so the first two are swapped."
2564 slot-name fn)))
2571 "Called if there are no implementations for OBJECT in METHOD.
2572 OBJECT is the object which has no method implementation.
2573 ARGS are the arguments that were passed to METHOD.
2575 Implement this for a class to block this signal. The return
2576 value becomes the return value of the original method call."
2578 )
2585 "Called from `call-next-method' when no additional methods are available.
2586 OBJECT is othe object being called on `call-next-method'.
2587 ARGS are the arguments it is called by.
2588 This method signals `no-next-method' by default. Override this
2589 method to not throw an error, and its return value becomes the
2590 return value of `call-next-method'."
2592 )
2595 "Make a copy of OBJ, and then supply PARAMS.
2596 PARAMS is a parameter list of the same form used by `initialize-instance'.
2598 When overloading `clone', be sure to call `call-next-method'
2602 "Make a copy of OBJ, and then apply PARAMS."
2615 nobj))
2621 "Destructor for cleaning up any dynamic links to our object.
2622 Argument THIS is the object being destroyed. PARAMS are additional
2623 ignored parameters."
2624 ;; No cleanup... yet.
2625 )
2628 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2630 It is sometimes useful to put a summary of the object into the
2631 default #<notation> string when using EIEIO browsing tools.
2635 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2636 The default method for printing object THIS is to use the
2637 function `object-name'.
2639 It is sometimes useful to put a summary of the object into the
2640 default #<notation> string when using EIEIO browsing tools.
2642 Implement this function and specify STRINGS in a call to
2643 `call-next-method' to provide additional summary information.
2644 When passing in extra strings from child classes, always remember
2645 to prepend a space."
2652 "Write out object THIS to the current stream.
2656 "Write object THIS out to the current stream.
2657 This writes out the vector version of this object. Complex and recursive
2658 object are discouraged from being written.
2659 If optional COMMENT is non-nil, include comments when outputting
2660 this object."
2669 ;; Now output readable lisp to recreate this object
2670 ;; It should look like this:
2671 ;; (<constructor> <name> <slot> <slot> ... )
2672 ;; Each slot's slot is writen using its :writer.
2679 ;; Loop over all the public slots
2688 )
2694 ;; Use our public printer
2696 ;; Use our generic override prin1 function.
2705 "Perform a `prin1' on THING taking advantage of object knowledge."
2717 "Display LIST where list may contain objects."
2734 \f
2735 ;;; Unimplemented functions from CLOS
2736 ;;
2738 "Change the class of OBJ to type CLASS.
2739 This may create or delete slots, but does not affect the return value
2740 of `eq'."
2743 )
2745 \f
2746 ;;; Interfacing with edebug
2747 ;;
2749 "Display EIEIO OBJECT in fancy format.
2750 Overrides the edebug default.
2751 Optional argument NOESCAPE is passed to `prin1-to-string' when appropriate."
2764 ;; ^^ This is the methods symbol
2766 list ; arguments
2768 def-body ; part to be debugged
2769 ))
2770 ;; The rest of the macros
2781 ;; I suspect this isn't the best way to do this, but when
2782 ;; cust-print was used on my system all my objects
2783 ;; appeared as "#1 =" which was not useful. This allows
2784 ;; edebug to print my objects in the nice way they were
2785 ;; meant to with `object-print' and `class-name'
2786 ;; (defalias 'edebug-prin1-to-string 'eieio-edebug-prin1-to-string)
2787 )
2788 )
2790 ;;; Interfacing with imenu in emacs lisp mode
2791 ;; (Only if the expression is defined)
2792 ;;
2797 "Examine `lisp-imenu-generic-expression' and modify it to find `defmethod'."
2800 ;; it's of the form '( ( title expr indx ) ... )
2811 ))
2813 ;;; Autoloading some external symbols, and hooking into the help system
2814 ;;
2816 (autoload 'eieio-help-mode-augmentation-maybee "eieio-opt" "For buffers thrown into help mode, augment for EIEIO.")
2821 (autoload 'eieio-describe-generic "eieio-opt" "Describe GENERIC defined by a string or symbol." t)
2828 ;; arch-tag: c1aeab9c-2938-41a3-842b-1a38bd26e9f2
2829 ;;; eieio ends here