| blob | ebc35f6237cab2b5ff583e76f691d9d5d6f6e909 |
1 ;;; eieio.el --- Enhanced Implementation of Emacs Interpreted Objects
2 ;;; or maybe Eric's Implementation of Emacs Interpreted Objects
4 ;; Copyright (C) 1995-1996, 1998-2012 Free Software Foundation, Inc.
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Version: 1.3
8 ;; Keywords: OO, lisp
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
26 ;;
27 ;; EIEIO is a series of Lisp routines which implements a subset of
28 ;; CLOS, the Common Lisp Object System. In addition, EIEIO also adds
29 ;; a few new features which help it integrate more strongly with the
30 ;; Emacs running environment.
31 ;;
32 ;; See eieio.texi for complete documentation on using this package.
33 ;;
34 ;; Note: the implementation of the c3 algorithm is based on:
35 ;; Kim Barrett et al.: A Monotonic Superclass Linearization for Dylan
36 ;; Retrieved from:
37 ;; http://192.220.96.201/dylan/linearization-oopsla96.html
39 ;; There is funny stuff going on with typep and deftype. This
40 ;; is the only way I seem to be able to make this stuff load properly.
42 ;; @TODO - fix :initform to be a form, not a quoted value
43 ;; @TODO - Prefix non-clos functions with `eieio-'.
45 ;;; Code:
53 "Display the current version of EIEIO."
58 ;; About the above. EIEIO must process its own code when it compiles
59 ;; itself, thus, by eval-and-compiling ourselves, we solve the problem.
61 ;; Compatibility
64 ;; XEmacs can only access a compiled functions arglist like this:
67 ;; Emacs doesn't have this function, but since FUNC is a vector, we can just
68 ;; grab the appropriate element.
70 "Return the argument list for the compiled function FUNC."
73 )
75 \f
76 ;;;
77 ;; Variable declarations.
78 ;;
84 "Non-nil to throw an error if an encountered tag is unsupported.
85 This may prevent classes from CLOS applications from being used with EIEIO
89 "If non-nil, skip all slot typechecking.
90 Set this to t permanently if a program is functioning well to get a
91 small speed increase. This variable is also used internally to handle
102 eieio-unbound
106 ;; This is a bootstrap for eieio-default-superclass so it has a value
107 ;; while it is being built itself.
110 ;; FIXME: The constants below should have an `eieio-' prefix added!!
114 (defconst class-symbol-obarray 4 "Obarray permitting fast access to variable position indexes.")
115 ;; @todo
116 ;; the word "public" here is leftovers from the very first version.
117 ;; Get rid of it!
138 "Cache index of what a newly created object would look like.
139 This will speed up instantiation time as only a `copy-sequence' will
140 be needed, instead of looping over all the values and setting them
143 "Storage location of tagged class options.
156 (defconst method-num-lists 4 "Number of indexes into methods vector in which groups of functions are kept.")
163 "Convert a specialized KEY into a generic method key."
167 ))
169 \f
170 ;;; Important macros used in eieio.
171 ;;
173 "Internal: Return the class vector from the CLASS symbol."
174 ;; No check: If eieio gets this far, it's probably been checked already.
178 "Return t if CLASS is a valid class vector.
179 CLASS is a symbol."
180 ;; this new method is faster since it doesn't waste time checking lots of
181 ;; things.
187 "Return non-nil if OBJ is an EIEIO object."
196 "Return the symbol representing the constructor of CLASS."
200 "Return t if symbol METHOD is a generic function.
201 Only methods have the symbol `eieio-method-obarray' as a property
202 \(which contains a list of all bindings to that method type.)"
206 "Return t if symbol METHOD is a generic function with only primary methods.
207 Only methods have the symbol `eieio-method-obarray' as a property (which
208 contains a list of all bindings to that method type.)
209 Methods with only primary implementations are executed in an optimized way."
219 ))
222 "Return t if symbol METHOD is a generic function with only primary methods.
223 Only methods have the symbol `eieio-method-obarray' as a property (which
224 contains a list of all bindings to that method type.)
225 Methods with only primary implementations are executed in an optimized way."
235 ))
238 "Return from LIST the found OPTION, or nil if it doesn't exist."
242 "Return the value stored for CLASS' OPTION.
243 Return nil if that option doesn't exist."
247 "Return non-nil if CLASS is abstract.
248 Abstract classes cannot be instantiated."
252 "Return the invocation order of CLASS.
253 Abstract classes cannot be instantiated."
257 \f
258 ;;; Defining a new class
259 ;;
261 "Define NAME as a new class derived from SUPERCLASS with SLOTS.
262 OPTIONS-AND-DOC is used as the class' options and base documentation.
263 SUPERCLASS is a list of superclasses to inherit from, with SLOTS
264 being the slots residing in that class definition. NOTE: Currently
265 only one slot may exist in SUPERCLASS as multiple inheritance is not
266 yet supported. Supported tags are:
268 :initform - Initializing form.
269 :initarg - Tag used during initialization.
270 :accessor - Tag used to create a function to access this slot.
271 :allocation - Specify where the value is stored.
272 Defaults to `:instance', but could also be `:class'.
273 :writer - A function symbol which will `write' an object's slot.
274 :reader - A function symbol which will `read' an object.
275 :type - The type of data allowed in this slot (see `typep').
276 :documentation
277 - A string documenting use of this slot.
279 The following are extensions on CLOS:
280 :protection - Specify protection for this slot.
281 Defaults to `:public'. Also use `:protected', or `:private'.
282 :custom - When customizing an object, the custom :type. Public only.
283 :label - A text string label used for a slot when customizing.
284 :group - Name of a customization group this slot belongs in.
285 :printer - A function to call to print the value of a slot.
286 See `eieio-override-prin1' as an example.
288 A class can also have optional options. These options happen in place
289 of documentation (including a :documentation tag), in addition to
290 documentation, or not at all. Supported options are:
292 :documentation - The doc-string used for this class.
294 Options added to EIEIO:
296 :allow-nil-initform - Non-nil to skip typechecking of null initforms.
297 :custom-groups - List of custom group names. Organizes slots into
298 reasonable groups for customizations.
299 :abstract - Non-nil to prevent instances of this class.
300 If a string, use as an error string if someone does
301 try to make an instance.
302 :method-invocation-order
303 - Control the method invocation order if there is
304 multiple inheritance. Valid values are:
305 :breadth-first - The default.
306 :depth-first
308 Options in CLOS not supported in EIEIO:
310 :metaclass - Class to use in place of `standard-class'
311 :default-initargs - Initargs to use when initializing new objects of
312 this class.
314 Due to the way class options are set up, you can add any tags you wish,
315 and reference them using the function `class-option'."
316 ;; We must `eval-and-compile' this so that when we byte compile
317 ;; an eieio program, there is no need to load it ahead of time.
318 ;; It also provides lots of nice debugging errors at compile time.
325 ;; We autoload this because it's used in `make-autoload'.
326 ;;;###autoload
328 "Create autoload symbols for the EIEIO class CNAME.
329 SUPERCLASSES are the superclasses that CNAME inherits from.
330 DOC is the docstring for CNAME.
331 This function creates a mock-class for CNAME and adds it into
332 SUPERCLASSES as children.
333 It creates an autoload function for CNAME's constructor."
334 ;; Assume we've already debugged inputs.
338 )
340 nil ;; Do nothing if we already have this class.
342 ;; Create the class in NEWC, but don't fill anything else in.
347 ;; No parents?
350 clear-parent t)
351 )
353 ;; Hook our new class into the existing structures so we can
354 ;; autoload it later.
358 ;; TODO - If we create an autoload that is in the map, that
359 ;; map needs to be cleared!
362 ;; Does our parent exist?
365 ;; Create a symbol for this parent, and then store this
366 ;; parent on that symbol.
371 )
373 ;; We have a parent, save the child in there.
378 ;; save parent in child
380 )
382 ;; turn this into a usable self-pointing symbol
385 ;; Store the new class vector definition into the symbol. We need to
386 ;; do this first so that we can call defmethod for the accessor.
387 ;; The vector will be updated by the following while loop and will not
388 ;; need to be stored a second time.
391 ;; Clear the parent
394 ;; Create an autoload on top of our constructor function.
400 ))))
403 "If class CNAME is in an autoload state, load its file."
408 ;; FIXME: Most of this should be moved to the `defclass' macro.
409 "Define CNAME as a new subclass of SUPERCLASSES.
410 SLOTS are the slots residing in that class definition, and options or
411 documentation OPTIONS-AND-DOC is the toplevel documentation for this class.
412 See `defclass' for more information."
413 ;; Run our eieio-hook each time, and clear it when we are done.
414 ;; This way people can add hooks safely if they want to modify eieio
415 ;; or add definitions when eieio is loaded or something like that.
432 ;; If this class already existed, and we are updating its structure,
433 ;; make sure we keep the old child list. This can cause bugs, but
434 ;; if no new slots are created, it also saves time, and prevents
435 ;; method table breakage, particularly when the users is only
436 ;; byte compiling an EIEIO file.
439 ;; If the old class did not exist, but did exist in the autoload map, then adopt those children.
440 ;; This is like the above, but deals with autoloads nicely.
447 ))
448 )
456 )
461 options-and-doc))
468 ;; bad class
470 ;; good parent class...
471 ;; save new child in parent
475 ;; Get custom groups, and store them into our local copy.
478 ;; save parent in child
482 ;; Reverse the list of our parents so that they are prioritized in
483 ;; the same order as specified in the code.
485 ;; If there is nothing to loop over, then inherit from the
486 ;; default superclass.
488 ;; adopt the default parent here, but clear it later...
490 ;; save new child in parent
494 ;; save parent in child
497 ;; turn this into a usable self-pointing symbol
500 ;; These two tests must be created right away so we can have self-
501 ;; referencing classes. ei, a class whose slot can contain only
502 ;; pointers to itself.
504 ;; Create the test function
512 ;; Make sure the method invocation order is a valid value.
516 ))
518 ;; Create a handy child test too
523 "Test OBJ to see if it an object is a child of type %s"
524 cname)
528 ;; Create a handy list of the class test too
533 "Test OBJ to see if it a list of objects which are a child of type %s"
534 cname)
537 ;; Loop over all the elements of the input list, test
538 ;; each to make sure it is a child of the desired object class.
543 ans)))))
545 ;; When using typep, (typep OBJ 'myclass) returns t for objects which
546 ;; are subclasses of myclass. For our predicates, however, it is
547 ;; important for EIEIO to be backwards compatible, where
548 ;; myobject-p, and myobject-child-p are different.
549 ;; "cl" uses this technique to specify symbols with specific typep
550 ;; test, so we can let typep have the CLOS documented behavior
551 ;; while keeping our above predicate clean.
553 ;; It would be cleaner to use `defsetf' here, but that requires cl
554 ;; at runtime.
558 ;; Before adding new slots, let's add all the methods and classes
559 ;; in from the parent class.
562 ;; Store the new class vector definition into the symbol. We need to
563 ;; do this first so that we can call defmethod for the accessor.
564 ;; The vector will be updated by the following while loop and will not
565 ;; need to be stored a second time.
568 ;; Query each slot in the declaration list and mangle into the
569 ;; class structure I have defined.
577 eieio-unbound)))
591 )
597 :initform
598 :initarg
599 :documentation
600 :protection
601 :reader
602 :writer
603 :allocation
604 :type
605 :custom
606 :label
607 :group
608 :printer
609 :allow-nil-initform
614 ;; Clean up the meaning of protection.
621 ;; Make sure the :allocation parameter has a valid value.
625 ;; The default type specifier is supposed to be t, meaning anything.
628 ;; Label is nil, or a string
632 ;; Is there an initarg, but allocation of class?
636 ;; intern the symbol so we can use it blankly
639 ;; The customgroup should be a list of symbols
644 ;; The customgroup better be a symbol, or list of symbols.
648 customg)
650 ;; First up, add this slot into our new class.
654 ;; We need to id the group, and store them in a group list attribute.
657 ;; Anyone can have an accessor function. This creates a function
658 ;; of the specified name, and also performs a `defsetf' if applicable
659 ;; so that users can `setf' the space returned by this function.
666 "Retrieves the slot `%s' from an object of class `%s'"
667 name cname)
670 ;; Else - Some error? nil?
671 nil)))
674 ;; FIXME: We should move more of eieio-defclass into the
675 ;; defclass macro so we don't have to use `eval' and require
676 ;; `gv' at run-time.
679 eieio--store)))
680 ;; Provide a setf method. It would be cleaner to use
681 ;; defsetf, but that would require CL at runtime.
691 --store-sym--)
694 ;; If a writer is defined, then create a generic method of that
695 ;; name whose purpose is to set the value of the slot.
698 writer nil cname
701 name cname)
703 ;; If a reader is defined, then create a generic method
704 ;; of that name whose purpose is to access this slot value.
707 reader nil cname
710 name cname)
712 )
715 ;; Now that everything has been loaded up, all our lists are backwards!
716 ;; Fix that up now.
729 ;; The storage for class-class-allocation-type needs to be turned into
730 ;; a vector now.
734 ;; Also, take class allocated values, and vectorize them for speed.
738 ;; Attach slot symbols into an obarray, and store the index of
739 ;; this slot as the variable slot in this new symbol. We need to
740 ;; know about primes, because obarrays are best set in vectors of
741 ;; prime number length, and we also need to make our vector small
742 ;; to save space, and also optimal for the number of items we have.
762 )
764 ;; Create the constructor function
766 ;; Abstract classes cannot be instantiated. Say so.
775 ;; Non-abstract classes need a constructor.
780 )
782 ;; Set up a specialized doc string.
783 ;; Use stored value since it is calculated in a non-trivial way
787 ;; Save the file location where this class is defined.
789 load-file-name
790 buffer-file-name))
791 loc)
797 ;; We have a list of custom groups. Store them into the options.
804 ;; Set up the options we have collected.
807 ;; if this is a superclass, clear out parent (which was set to the
808 ;; default superclass eieio-default-superclass)
811 ;; Create the cached default object.
818 ;; All type-checking has been done to our satisfaction
819 ;; before this call. Don't waste our time in this call..
823 ;; Return our new class object
824 ;; newc
825 cname
826 ))
829 "For SLOT, signal if SPEC does not match VALUE.
830 If SKIPNIL is non-nil, then if VALUE is nil return t instead."
839 "Add into NEWC attribute A.
840 If A already exists in NEWC, then do nothing. If it doesn't exist,
841 then also add in D (default), DOC, TYPE, CUST, LABEL, CUSTG, PRINT, PROT, and INIT arg.
842 Argument ALLOC specifies if the slot is allocated per instance, or per class.
843 If optional DEFAULTOVERRIDE is non-nil, then if A exists in NEWC,
844 we must override its value for a default.
845 Optional argument SKIPNIL indicates if type checking should be skipped
846 if default value is nil."
847 ;; Make sure we duplicate those items that are sequences.
850 ;; This copy can fail on a cons cell with a non-cons in the cdr. Let's skip it if it doesn't work.
856 ;; To prevent override information w/out specification of storage,
857 ;; we need to do this little hack.
861 ;; In this case, we modify the INSTANCE version of a given slot.
865 ;; Only add this element if it is so-far unique
879 )
880 ;; When defaultoverride is true, we are usually adding new local
881 ;; attributes which must override the default value of any slot
882 ;; passed in by one of the parent classes.
884 ;; There is a match, and we must override the old value.
889 nil))
891 )
894 a)
895 ;; If type is passed in, is it the same?
899 "Child slot type `%s' does not match inherited type `%s' for `%s'"
900 type tp a)))
901 ;; If we have a repeat, only update the initarg...
905 ;; If we have a new initarg, check for it.
909 ;; Replace the CAR of the associate INITA.
910 ;;(message "Initarg: %S replace %s" inita init)
912 ))
914 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
915 ;; checked and SHOULD match the superclass
916 ;; protection. Otherwise an error is thrown. However
917 ;; I wonder if a more flexible schedule might be
918 ;; implemented.
919 ;;
920 ;; EML - We used to have (if prot... here,
921 ;; but a prot of 'nil means public.
922 ;;
924 )
927 prot super-prot a)))
928 ;; End original PLN
930 ;; PLN Tue Jun 26 11:57:06 2007 :
931 ;; Do a non redundant combination of ancient custom
932 ;; groups and new ones.
944 ;; End PLN
946 ;; PLN Mon Jun 25 22:44:34 2007 : If a new cust is
947 ;; set, simply replaces the old one.
949 ;; (message "Custom type redefined to %s" cust)
952 ;; If a new label is specified, it simply replaces
953 ;; the old one.
955 ;; (message "Custom label redefined to %s" label)
957 ;; End PLN
959 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
960 ;; doc is specified, simply replaces the old one.
962 ;;(message "Documentation redefined to %s" doc)
964 doc))
965 ;; End PLN
967 ;; If a new printer is specified, it simply replaces
968 ;; the old one.
970 ;; (message "printer redefined to %s" print)
973 )))
974 ))
976 ;; CLASS ALLOCATED SLOTS
981 ;; Here we have found a :class version of a slot. This
982 ;; requires a very different approach.
987 (aset newc class-class-allocation-custom-label (cons label (aref newc class-class-allocation-custom-label)))
988 (aset newc class-class-allocation-custom-group (cons custg (aref newc class-class-allocation-custom-group)))
989 (aset newc class-class-allocation-protection (cons prot (aref newc class-class-allocation-protection)))
990 ;; Default value is stored in the 'values section, since new objects
991 ;; can't initialize from this element.
992 (aset newc class-class-allocation-values (cons value (aref newc class-class-allocation-values))))
994 ;; There is a match, and we must override the old value.
1001 nil))
1003 nil)))
1006 a)
1007 ;; If type is passed in, is it the same?
1011 "Child slot type `%s' does not match inherited type `%s' for `%s'"
1012 type tp a)))
1013 ;; EML - Note: the only reason to override a class bound slot
1014 ;; is to change the default, so allow unbound in.
1016 ;; If we have a repeat, only update the value...
1020 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
1021 ;; checked and SHOULD match the superclass
1022 ;; protection. Otherwise an error is thrown. However
1023 ;; I wonder if a more flexible schedule might be
1024 ;; implemented.
1029 prot super-prot a)))
1030 ;; Do a non redundant combination of ancient custom groups
1031 ;; and new ones.
1044 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
1045 ;; doc is specified, simply replaces the old one.
1047 ;;(message "Documentation redefined to %s" doc)
1049 doc))
1050 ;; End PLN
1052 ;; If a new printer is specified, it simply replaces
1053 ;; the old one.
1055 ;; (message "printer redefined to %s" print)
1058 ))
1059 ))
1060 ))
1063 "Copy into NEWC the slots of PARENTS.
1064 Follow the rules of not overwriting early parents when applying to
1065 the new child class."
1070 ;; First, duplicate all the slots of the parent.
1089 ;; Increment each value.
1101 ;; Now duplicate all the class alloc slots.
1118 ;; Increment each value.
1128 ;; Loop over each parent class
1130 ))
1132 ;;; CLOS style implementation of object creators.
1133 ;;
1135 "Make a new instance of CLASS based on INITARGS.
1136 CLASS is a class symbol. For example:
1138 (make-instance 'foo)
1140 INITARGS is a property list with keywords based on the :initarg
1141 for each slot. For example:
1143 (make-instance 'foo :slot1 value1 :slotN valueN)
1145 Compatibility note:
1147 If the first element of INITARGS is a string, it is used as the
1148 name of the class.
1150 In EIEIO, the class' constructor requires a name for use when printing.
1151 `make-instance' in CLOS doesn't use names the way Emacs does, so the
1152 class is used as the name slot instead when INITARGS doesn't start with
1153 a string."
1159 initargs)))
1161 \f
1162 ;;; CLOS methods and generics
1163 ;;
1168 "Like `defalias', but with less side-effects.
1169 More specifically, it has no side-effects at all when the new function
1170 definition is the same (`eq') as the old one."
1176 "Create a generic function METHOD.
1177 DOC-STRING is the base documentation for this class. A generic
1178 function has no body, as its purpose is to decide which method body
1179 is appropriate to use. Uses `defmethod' to create methods, and calls
1180 `defgeneric' for you. With this implementation the ARGS are
1181 currently ignored. You can use `defgeneric' to apply specialized
1182 top level documentation to a method."
1187 "Form to use for the initial definition of a generic."
1191 ;; Make sure the method tables are installed.
1193 ;; Construct the actual body of this function.
1197 method))))
1200 "The lambda form that would be used as the function defined on METHOD.
1201 All methods should call the same EIEIO function for dispatch.
1202 DOC-STRING is the documentation attached to METHOD."
1204 ,doc-string
1208 "Setup METHOD to call the generic form."
1213 "The lambda form that would be used as the function defined on METHOD.
1214 All methods should call the same EIEIO function for dispatch.
1215 DOC-STRING is the documentation attached to METHOD."
1217 ,doc-string
1221 "Setup METHOD to call the generic form."
1226 class
1227 impl
1228 )
1229 "The lambda form that would be used as the function defined on METHOD.
1230 All methods should call the same EIEIO function for dispatch.
1231 DOC-STRING is the documentation attached to METHOD.
1232 CLASS is the class symbol needed for private method access.
1233 IMPL is the symbol holding the method implementation."
1234 ;; NOTE: I tried out byte compiling this little fcn. Turns out it
1235 ;; is faster to execute this for not byte-compiled. ie, install this,
1236 ;; then measure calls going through here. I wonder why.
1241 ,doc-string
1242 ;; This is a cool cheat. Usually we need to look up in the
1243 ;; method table to find out if there is a method or not. We can
1244 ;; instead make that determination at load time when there is
1245 ;; only one method. If the first arg is not a child of the class
1246 ;; of that one implementation, then clearly, there is no method def.
1248 ;; Not an object. Just signal.
1252 ;; We do have an object. Make sure it is the right type.
1254 nil ; default superclass means just an obj. Already asked.
1258 ;; If not the right kind of object, call no applicable
1262 ;; It is ok, do the call.
1263 ;; Fill in inter-call variables then evaluate the method.
1269 )
1273 ;(,impl local-args)
1274 )))))))
1277 "Setup METHOD to call the generic form."
1281 )
1283 method doc-string
1286 ))))
1289 "Make the generic method METHOD have no implementations.
1290 It will leave the original generic function in place,
1291 but remove reference to all implementations of METHOD."
1296 "Create a new METHOD through `defgeneric' with ARGS.
1298 The optional second argument KEY is a specifier that
1299 modifies how the method is called, including:
1300 :before - Method will be called before the :primary
1301 :primary - The default if not specified
1302 :after - Method will be called after the :primary
1303 :static - First arg could be an object or class
1304 The next argument is the ARGLIST. The ARGLIST specifies the arguments
1305 to the method as with `defun'. The first argument can have a type
1306 specifier, such as:
1307 ((VARNAME CLASS) ARG2 ...)
1308 where VARNAME is the name of the local variable for the method being
1309 created. The CLASS is a class symbol for a class made with `defclass'.
1310 A DOCSTRING comes after the ARGLIST, and is optional.
1311 All the rest of the args are the BODY of the method. A method will
1312 return the value of the last form in the BODY.
1314 Summary:
1316 (defmethod mymethod [:before | :primary | :after | :static]
1317 ((typearg class-name) arg2 &optional opt &rest rest)
1319 body)"
1325 params))
1329 ;; Make sure there is a generic and the byte-compiler sees it.
1336 "Work part of the `defmethod' macro defining METHOD with ARGS."
1338 ;; find optional keys
1341 method-before)
1344 method-after)
1347 method-primary)
1350 method-static)
1351 ;; Primary key
1353 ;; Make sure there is a generic (when called from defclass).
1358 ;; create symbol for property to bind to. If the first arg is of
1359 ;; the form (varname vartype) and `vartype' is a class, then
1360 ;; that class will be the type symbol. If not, then it will fall
1361 ;; under the type `primary' which is a non-specific calling of the
1362 ;; function.
1366 argclass))
1369 ;; generics are higher
1371 ;; Put this lambda into the symbol so we can find it
1373 )
1376 ;; Optimizing step:
1377 ;;
1378 ;; If this method, after this setup, only has primary methods, then
1379 ;; we can setup the generic that way.
1381 ;; If there is only one primary method, then we can go one more
1382 ;; optimization step.
1388 method)
1390 ;;; Slot type validation
1392 ;; This is a hideous hack for replacing `typep' from cl-macs, to avoid
1393 ;; requiring the CL library at run-time. It can be eliminated if/when
1394 ;; `typep' is merged into Emacs core.
1438 "Return non-nil if SPEC does not match VALUE."
1444 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1445 Checks the :type specifier.
1446 SLOT is the slot that is being checked, and is only used when throwing
1447 an error."
1449 nil
1450 ;; Trim off object IDX junk added in for the object index.
1457 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1458 Checks the :type specifier.
1459 SLOT is the slot that is being checked, and is only used when throwing
1460 an error."
1462 nil
1464 slot-idx)))
1469 "Throw a signal if VALUE is a representation of an UNBOUND slot.
1470 INSTANCE is the object being referenced. SLOTNAME is the offending
1471 slot. If the slot is ok, return VALUE.
1472 Argument FN is the function calling this verifier."
1475 value))
1477 ;;; Get/Set slots in an object.
1478 ;;
1480 "Retrieve the value stored in OBJ in the slot named by SLOT.
1481 Slot is the name of the slot when created by `defclass' or the label
1482 created by the :initarg tag."
1486 "Return the value in OBJ at SLOT in the object vector."
1495 ;; It might be missing because it is a :class allocated slot.
1496 ;; Let's check that info out.
1498 ;; Oref that slot.
1500 ;; The slot-missing method is a cool way of allowing an object author
1501 ;; to intercept missing slot definitions. Since it is also the LAST
1502 ;; thing called in this fn, its return value would be retrieved.
1504 ;;(signal 'invalid-slot-name (list (object-name obj) slot))
1505 )
1514 "Get the default value of OBJ (maybe a class) for SLOT.
1515 The default value is the value installed in a class with the :initform
1516 tag. SLOT can be the slot name, or the tag specified by the :initarg
1517 tag in the `defclass' call."
1521 "Do the work for the macro `oref-default' with similar parameters.
1522 Fills in OBJ's SLOT with its default value."
1523 (if (not (or (eieio-object-p obj) (class-p obj))) (signal 'wrong-type-argument (list 'eieio-object-p obj)))
1528 ;; It might be missing because it is a :class allocated slot.
1529 ;; Let's check that info out.
1532 ;; Oref that slot.
1534 c)
1536 ;;(signal 'invalid-slot-name (list (class-name cl) slot))
1537 )
1544 "Whether the default value VAL should be evaluated for use."
1548 "Check VAL, and return what `oref-default' would provide."
1550 ;; Is it a function call? If so, evaluate it.
1553 ;;;; check for quoted things, and unquote them
1554 ;;((and (consp val) (eq (car val) 'quote))
1555 ;; (car (cdr val)))
1556 ;; return it verbatim
1559 ;;; Handy CLOS macros
1560 ;;
1562 "Bind SPEC-LIST lexically to slot values in OBJECT, and execute BODY.
1563 This establishes a lexical environment for referring to the slots in
1564 the instance named by the given slot-names as though they were
1565 variables. Within such a context the value of the slot can be
1566 specified by using its slot name, as if it were a lexically bound
1567 variable. Both setf and setq can be used to set the value of the
1568 slot.
1570 SPEC-LIST is of a form similar to `let'. For example:
1572 ((VAR1 SLOT1)
1573 SLOT2
1574 SLOTN
1575 (VARN+1 SLOTN+1))
1577 Where each VAR is the local variable given to the associated
1578 SLOT. A slot specified without a variable name is given a
1579 variable name of the same name as the slot."
1581 ;; Transform the spec-list into a symbol-macrolet spec-list.
1586 spec-list)))
1588 body)))
1589 \f
1590 ;;; Simple generators, and query functions. None of these would do
1591 ;; well embedded into an object.
1592 ;;
1598 ;; I think this is supposed to return a symbol, but to me CLASS is a symbol,
1599 ;; and I wanted a string. Arg!
1603 "Return a Lisp like symbol string for object OBJ.
1604 If EXTRA, include that in the string returned to represent the symbol."
1631 "Return parent classes to CLASS. (overload of variable).
1633 The CLOS function `class-direct-superclasses' is aliased to this function."
1641 "Return child classes to CLASS.
1643 The CLOS function `class-direct-subclasses' is aliased to this function."
1648 "Returns CLASS if it can go in the result now, otherwise nil"
1649 ;; Ensure CLASS is not in any position but the first in any of the
1650 ;; element lists of REMAINING-INPUTS.
1655 found))
1656 class))
1659 "Merge REVERSED-PARTIAL-RESULT REMAINING-INPUTS in a consistent order, if possible.
1660 If a consistent order does not exist, signal an error."
1666 ;; If all remaining inputs are empty lists, we are done.
1668 ;; Otherwise, we try to find the next element of the result. This
1669 ;; is achieved by considering the first element of each
1670 ;; (non-empty) input list and accepting a candidate if it is
1671 ;; consistent with the rests of the input lists.
1678 remaining-inputs))
1680 found)))
1682 ;; The graph is consistent so far, add NEXT to result and
1683 ;; merge input lists, dropping NEXT from their heads where
1684 ;; applicable.
1688 remaining-inputs))
1689 ;; The graph is inconsistent, give up
1693 "Return all parents of CLASS in depth-first order."
1703 parents)
1706 ;; Remove duplicates.
1710 classes))
1713 "Return all parents of CLASS in breadth-first order."
1725 )
1728 "Return all parents of CLASS in c3 order."
1737 parents)
1740 )
1743 "Return (transitively closed) list of parents of CLASS.
1744 The order, in which the parents are returned depends on the
1745 method invocation orders of the involved classes."
1747 nil
1749 (:depth-first
1751 (:breadth-first
1753 (:c3
1755 )
1757 ;; Official CLOS functions.
1767 (defmacro same-class-fast-p (obj class) "Return t if OBJ is of class-type CLASS with no error checking."
1776 "Return non-nil if OBJ is an instance of CLASS or CLASS' subclasses."
1778 ;; class will be checked one layer down
1780 ;; Backwards compatibility
1784 "Return non-nil if CHILD class is a subclass of CLASS."
1795 "Return list of slots available in OBJ."
1807 f))
1809 ;;; Object Set macros
1810 ;;
1812 "Set the value in OBJ for slot SLOT to VALUE.
1813 SLOT is the slot name as specified in `defclass' or the tag created
1814 with in the :initarg slot. VALUE can be any Lisp object."
1818 "Do the work for the macro `oset'.
1819 Fills in OBJ's SLOT with VALUE."
1824 ;; It might be missing because it is a :class allocated slot.
1825 ;; Let's check that info out.
1828 ;; Oset that slot.
1832 class-class-allocation-values)
1833 c value))
1834 ;; See oref for comment on `slot-missing'
1836 ;;(signal 'invalid-slot-name (list (object-name obj) slot))
1837 )
1842 "Set the default slot in CLASS for SLOT to VALUE.
1843 The default value is usually set with the :initform tag during class
1844 creation. This allows users to change the default behavior of classes
1845 after they are created."
1849 "Do the work for the macro `oset-default'.
1850 Fills in the default value in CLASS' in SLOT with VALUE."
1856 ;; It might be missing because it is a :class allocated slot.
1857 ;; Let's check that info out.
1860 ;; Oref that slot.
1863 value))
1866 ;; Set this into the storage for defaults.
1868 value)
1869 ;; Take the value, and put it into our cache object.
1871 slot value)
1872 )))
1874 ;;; CLOS queries into classes and slots
1875 ;;
1877 "Return non-nil if OBJECT's SLOT is bound.
1878 Setting a slot's value makes it bound. Calling `slot-makeunbound' will
1879 make a slot unbound.
1880 OBJECT can be an instance or a class."
1881 ;; Skip typechecking while retrieving this value.
1883 ;; Return nil if the magic symbol is in there.
1888 eieio-unbound))))
1891 "In OBJECT, make SLOT unbound."
1895 "Return non-nil if OBJECT-OR-CLASS has SLOT."
1899 object-or-class))
1900 )))
1903 ))
1906 "Return the class that SYMBOL represents.
1907 If there is no class, nil is returned if ERRORP is nil.
1908 If ERRORP is non-nil, `wrong-argument-type' is signaled."
1911 nil)
1914 ;;; Slightly more complex utility functions for objects
1915 ;;
1917 "Return an object if KEY is `equal' to SLOT's value of an object in LIST.
1918 LIST is a list of objects whose slots are searched.
1919 Objects in LIST do not need to have a slot named SLOT, nor does
1920 SLOT need to be bound. If these errors occur, those objects will
1921 be ignored."
1924 ;; This prevents errors for missing slots.
1931 "Return an association list with the contents of SLOT as the key element.
1932 LIST must be a list of objects with SLOT in it.
1933 This is useful when you need to do completing read on an object group."
1939 assoclist))
1944 "Return an association list with the contents of SLOT as the key element.
1945 LIST must be a list of objects, but those objects do not need to have
1946 SLOT in it. If it does not, then that element is left out of the association
1947 list."
1954 assoclist)))
1959 "In OBJECT's SLOT, add ITEM to the list of elements.
1960 Optional argument APPEND indicates we need to append to the list.
1961 If ITEM already exists in the list in SLOT, then it is not added.
1962 Comparison is done with `equal' through the `member' function call.
1963 If SLOT is unbound, bind it to the list containing ITEM."
1965 ;; Find the originating list.
1969 ;; turn it into a list.
1972 ;; Do the combination
1978 ;; Set back into the slot.
1982 "In OBJECT's SLOT, remove occurrences of ITEM.
1983 Deletion is done with `delete', which deletes by side effect,
1984 and comparisons are done with `equal'.
1985 If SLOT is unbound, do nothing."
1987 nil
1989 \f
1990 ;;; EIEIO internal search functions
1991 ;;
1993 "Return non-nil if START-CLASS is the first class to define SLOT.
1994 This is for testing if `scoped-class' is the class that defines SLOT
1995 so that we can protect private slots."
1999 t
2003 class-symbol-obarray))
2006 ret)))
2009 "In CLASS for OBJ find the index of the named SLOT.
2010 The slot is a symbol which is installed in CLASS by the `defclass'
2011 call. OBJ can be nil, but if it is an object, and the slot in question
2012 is protected, access will be allowed if OBJ is a child of the currently
2013 `scoped-class'.
2014 If SLOT is the value created with :initarg instead,
2015 reverse-lookup that name, and recurse with the associated slot value."
2016 ;; Removed checks to outside this call
2019 class-symbol-obarray)))
2034 eieio-initializing-object))
2041 "In CLASS find the index of the named SLOT.
2042 The slot is a symbol which is installed in CLASS by the `defclass'
2043 call. If SLOT is the value created with :initarg instead,
2044 reverse-lookup that name, and recurse with the associated slot value."
2045 ;; This will happen less often, and with fewer slots. Do this the
2046 ;; storage cheap way.
2051 ;; Slot # is length of the total list, minus the remaining list of
2052 ;; the found slot.
2054 \f
2055 ;;; CLOS generics internal function handling
2056 ;;
2062 "When using `call-next-method', provides a context for the current key.
2065 "When executing a PRIMARY or STATIC method, track the 'next-method'.
2066 During executions, the list is first generated, then as each next method
2072 "Abnormal hook run just before an EIEIO method is executed.
2073 The hook function must accept one argument, the list of forms
2077 "Call METHOD with ARGS.
2078 ARGS provides the context on which implementation to use.
2079 This should only be called from a generic function."
2080 ;; We must expand our arguments first as they are always
2081 ;; passed in as quoted symbols
2087 ;; get a copy
2090 ;; Is the class passed in autoloaded?
2091 ;; Since class names are also constructors, they can be autoloaded
2092 ;; via the autoload command. Check for this, and load them in.
2093 ;; It's ok if it doesn't turn out to be a class. Probably want that
2094 ;; function loaded anyway.
2100 ;; Determine the class to use.
2105 )
2106 ;; Make sure the class is a valid class
2107 ;; mclass can be nil (meaning a generic for should be used.
2108 ;; mclass cannot have a value that is not a class, however.
2111 method mclass)
2112 )
2113 ;; Now create a list in reverse order of all the calls we have
2114 ;; make in order to successfully do this right. Rules:
2115 ;; 1) Only call generics if scoped-class is not defined
2116 ;; This prevents multiple calls in the case of recursion
2117 ;; 2) Only call static if this is a static method.
2118 ;; 3) Only call specifics if the definition allows for them.
2119 ;; 4) Call in order based on :before, :primary, and :after
2121 ;; Non-static calls do all this stuff.
2123 ;; :after methods
2128 ;;(or (and mclass (eieio-generic-form method method-after mclass))
2129 ;; (eieio-generic-form method method-after nil))
2130 )
2134 ;; :primary methods
2141 primarymethodlist
2144 ;; :before methods
2149 ;;(or (and mclass (eieio-generic-form method method-before mclass))
2150 ;; (eieio-generic-form method method-before nil))
2151 )
2154 )
2157 ;; For the case of a class,
2158 ;; if there were no methods found, then there could be :static methods.
2164 primarymethodlist ;; Re-use even with bad name here
2166 ;; For the case of no class (ie - mclass == nil) then there may
2167 ;; be a primary method.
2173 primarymethodlist
2175 )
2178 primarymethodlist)
2180 ;; Now loop through all occurrences forms which we must execute
2181 ;; (which are happily sorted now) and execute them all!
2191 ;; Use the cdr, as the first element is the fcn
2192 ;; we are calling right now.
2194 )
2196 ;;(setq rval (apply (car (car lambdas)) newargs))
2200 rvalever t))
2201 ))
2207 rvalever t)
2209 'no-method-definition
2211 ;; Right Here... it could be that lastval is returned when
2212 ;; rvalever is nil. Is that right?
2213 rval)))
2216 "Call METHOD with ARGS for methods with only :PRIMARY implementations.
2217 ARGS provides the context on which implementation to use.
2218 This should only be called from a generic function.
2220 This method is like `eieio-generic-call', but only
2221 implementations in the :PRIMARY slot are queried. After many
2222 years of use, it appears that over 90% of methods in use
2223 have :PRIMARY implementations only. We can therefore optimize
2224 for this common case to improve performance."
2225 ;; We must expand our arguments first as they are always
2226 ;; passed in as quoted symbols
2232 )
2233 ;; get a copy
2237 ;; Determine the class to use.
2246 method)
2247 ))
2248 ;; Make sure the class is a valid class
2249 ;; mclass can be nil (meaning a generic for should be used.
2250 ;; mclass cannot have a value that is not a class, however.
2253 )
2255 ;; :primary methods
2260 ;; Now loop through all occurrences forms which we must execute
2261 ;; (which are happily sorted now) and execute them all!
2265 ;; Use the cdr, as the first element is the fcn
2266 ;; we are calling right now.
2268 )
2272 ;; No methods found for this impl...
2275 rvalever t)
2277 'no-method-definition
2280 ;; Do the regular implementation here.
2283 lambdas)
2287 rvalever t)
2288 )
2290 ;; Right Here... it could be that lastval is returned when
2291 ;; rvalever is nil. Is that right?
2292 rval)))
2295 "Return an alist list of methods lambdas.
2296 METHOD is the method name.
2297 KEY represents either :before, or :after methods.
2298 CLASS is the starting class to search from in the method tree.
2299 If CLASS is nil, then an empty list of methods should be returned."
2300 ;; Note: eieiomt - the MT means MethodTree. See more comments below
2301 ;; for the rest of the eieiomt methods.
2303 ;; Collect lambda expressions stored for the class and its parent
2304 ;; classes.
2307 ;; Lookup the form to use for the PRIMARY object for the next level
2311 ;; This prevents duplicates coming out of the
2312 ;; class method optimizer. Perhaps we should
2313 ;; just not optimize before/afters?
2317 ;; Return collected lambda. For :after methods, return in current
2318 ;; order (most general class last); Otherwise, reverse order.
2320 lambdas
2324 "Return non-nil if there is a next method.
2325 Returns a list of lambda expressions which is the `next-method'
2326 order."
2327 eieio-generic-call-next-method-list)
2330 "Call the superclass method from a subclass method.
2331 The superclass method is specified in the current method list,
2332 and is called the next method.
2334 If REPLACEMENT-ARGS is non-nil, then use them instead of
2335 `eieio-generic-call-arglst'. The generic arg list are the
2336 arguments passed in at the top level.
2338 Use `next-method-p' to find out if there is a next method to call."
2344 )
2347 )
2355 )
2357 ))))
2358 \f
2359 ;;;
2360 ;; eieio-method-tree : eieiomt-
2361 ;;
2362 ;; Stored as eieio-method-tree in property list of a generic method
2363 ;;
2364 ;; (eieio-method-tree . [BEFORE PRIMARY AFTER
2365 ;; genericBEFORE genericPRIMARY genericAFTER])
2366 ;; and
2367 ;; (eieio-method-obarray . [BEFORE PRIMARY AFTER
2368 ;; genericBEFORE genericPRIMARY genericAFTER])
2369 ;; where the association is a vector.
2370 ;; (aref 0 -- all static methods.
2371 ;; (aref 1 -- all methods classified as :before
2372 ;; (aref 2 -- all methods classified as :primary
2373 ;; (aref 3 -- all methods classified as :after
2374 ;; (aref 4 -- a generic classified as :before
2375 ;; (aref 5 -- a generic classified as :primary
2376 ;; (aref 6 -- a generic classified as :after
2377 ;;
2382 "Install the method tree, and obarray onto METHOD-NAME.
2383 Do not do the work if they already exist."
2396 ))))
2399 "Add to METHOD-NAME the forms METHOD in a call position KEY for CLASS.
2400 METHOD-NAME is the name created by a call to `defgeneric'.
2401 METHOD are the forms for a given implementation.
2402 KEY is an integer (see comment in eieio.el near this function) which
2403 is associated with the :static :before :primary and :after tags.
2404 It also indicates if CLASS is defined or not.
2405 CLASS is the class this method is associated with."
2410 ;; Make sure the method tables are available.
2413 ;; only add new cells on if it doesn't already exist!
2417 ;; Add function definition into newly created symbol, and store
2418 ;; said symbol in the correct obarray, otherwise use the
2419 ;; other array to keep this stuff
2423 ;; Save the defmethod file location in a symbol property.
2425 load-file-name
2426 buffer-file-name))
2427 loc)
2435 ;; Now optimize the entire obarray
2438 ;; @todo - Is this overkill? Should we just clear the symbol?
2440 ))
2443 "Return the next parent class for CLASS.
2444 If CLASS is a superclass, return variable `eieio-default-superclass'.
2445 If CLASS is variable `eieio-default-superclass' then return nil.
2446 This is different from function `class-parent' as class parent returns
2447 nil for superclasses. This function performs no type checking!"
2448 ;; No type-checking because all calls are made from functions which
2449 ;; are safe and do checking for us.
2452 nil
2456 "Find the next class above S which has a function body for the optimizer."
2457 ;; Set the value to nil in case there is no nearest cell.
2459 ;; Find the nearest cell that has a function body. If we find one,
2460 ;; we replace the nil from above.
2465 eieiomt-optimizing-obarray)))
2471 "Return the lambda form belonging to METHOD using KEY based upon CLASS.
2472 If CLASS is not a class then use `generic' instead. If class has
2473 no form, but has a parent class, then trace to that parent class.
2474 The first time a form is requested from a symbol, an optimized path
2475 is memorized for faster future use."
2479 ;; 1) find our symbol
2482 ;; 2) If there isn't one, then make one.
2483 ;; This can be slow since it only occurs once
2486 ;; 2.1) Cache its nearest neighbor with a quick optimize
2487 ;; which should only occur once for this call ever
2490 ;; 3) If it's bound return this one.
2493 ;; 4) If it's not bound then this variable knows something
2496 ;; 4.1) This symbol holds the next class in its value
2499 ;; 4.2) The optimizer should always have chosen a
2500 ;; function-symbol
2501 ;;(if (fboundp cs)
2503 class-symbol))
2504 ;;(error "EIEIO optimizer: erratic data loss!"))
2505 )
2506 ;; There never will be a funcall...
2507 nil)))
2508 ;; for a generic call, what is a list, is the function body we want.
2512 ;; The car of EMTL is supposed to be a class, which in this
2513 ;; case is nil, so skip it.
2515 nil)))))
2517 ;;;
2518 ;; Way to assign slots based on a list. Used for constructors, or
2519 ;; even resetting an object at run-time
2520 ;;
2522 "Take object OBJ, and reset all slots to their defaults.
2523 If SET-ALL is non-nil, then when a default is nil, that value is
2524 reset. If SET-ALL is nil, the slots are only reset if the default is
2525 not nil."
2536 "For CLASS, convert INITARG to the actual attribute name.
2537 If there is no translation, pass it in directly (so we can cheat if
2538 need be... May remove that later...)"
2542 nil)))
2545 "In CLASS, convert the ATTRIBUTE into the corresponding init argument tag.
2546 This is usually a symbol that starts with `:'."
2550 nil)))
2552 \f
2553 ;;; Here are some special types of errors
2554 ;;
2580 ;;; Here are some CLOS items that need the CL package
2581 ;;
2586 ;; Not needed for Emacs>=24.3 since gv.el's setf expands macros and
2587 ;; follows aliases.
2588 nil
2591 ;; The below setf method was written by Arnd Kohrs <kohrs@acm.org>
2602 store-temp)
2605 \f
2606 ;;;
2607 ;; We want all objects created by EIEIO to have some default set of
2608 ;; behaviors so we can create object utilities, and allow various
2609 ;; types of error checking. To do this, create the default EIEIO
2610 ;; class, and when no parent class is specified, use this as the
2611 ;; default. (But don't store it in the other classes as the default,
2612 ;; allowing for transparent support.)
2613 ;;
2616 nil
2617 "Default parent class for classes with no specified parent class.
2618 Its slots are automatically adopted by classes with no specified parents.
2619 This class is not stored in the `parent' slot of a class vector."
2629 "Default constructor for CLASS `eieio-default-superclass'.
2630 NEWNAME is the name to be given to the constructed object.
2631 SLOTS are the initialization slots used by `shared-initialize'.
2632 This static method is called when an object is constructed.
2633 It allocates the vector used to represent an EIEIO object, and then
2634 calls `shared-initialize' on that object."
2636 class-default-object-cache))))
2637 ;; Update the name for the newly created object.
2639 ;; Call the initialize method on the new object with the slots
2640 ;; that were passed down to us.
2642 ;; Return the created object.
2643 new-object))
2646 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2650 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2651 Called from the constructor routine."
2666 "Construct the new object THIS based on SLOTS.
2667 SLOTS is a tagged list where odd numbered elements are tags, and
2668 even numbered elements are the values to store in the tagged slot.
2669 If you overload the `initialize-instance', there you will need to
2670 call `shared-initialize' yourself, or you can call `call-next-method'
2671 to have this constructor called automatically. If these steps are
2672 not taken, then new objects of your class will not have their values
2673 dynamically set from SLOTS."
2674 ;; First, see if any of our defaults are `lambda', and
2675 ;; re-evaluate them and apply the value to our slots.
2680 ;; For each slot, see if we need to evaluate it.
2681 ;;
2682 ;; Paul Landes said in an email:
2683 ;; > CL evaluates it if it can, and otherwise, leaves it as
2684 ;; > the quoted thing as you already have. This is by the
2685 ;; > Sonya E. Keene book and other things I've look at on the
2686 ;; > web.
2690 ;; Next.
2693 ;; Shared initialize will parse our slots for us.
2701 "Method invoked when an attempt to access a slot in OBJECT fails.
2702 SLOT-NAME is the name of the failed slot, OPERATION is the type of access
2703 that was requested, and optional NEW-VALUE is the value that was desired
2704 to be set.
2706 This method is called from `oref', `oset', and other functions which
2707 directly reference slots in EIEIO objects."
2709 slot-name)))
2715 class slot-name fn)
2716 "Slot unbound is invoked during an attempt to reference an unbound slot.
2717 OBJECT is the instance of the object being reference. CLASS is the
2718 class of OBJECT, and SLOT-NAME is the offending slot. This function
2719 throws the signal `unbound-slot'. You can overload this function and
2720 return the value to use in place of the unbound value.
2721 Argument FN is the function signaling this error.
2722 Use `slot-boundp' to determine if a slot is bound or not.
2724 In CLOS, the argument list is (CLASS OBJECT SLOT-NAME), but
2725 EIEIO can only dispatch on the first argument, so the first two are swapped."
2727 slot-name fn)))
2734 "Called if there are no implementations for OBJECT in METHOD.
2735 OBJECT is the object which has no method implementation.
2736 ARGS are the arguments that were passed to METHOD.
2738 Implement this for a class to block this signal. The return
2739 value becomes the return value of the original method call."
2741 )
2748 "Called from `call-next-method' when no additional methods are available.
2749 OBJECT is othe object being called on `call-next-method'.
2750 ARGS are the arguments it is called by.
2751 This method signals `no-next-method' by default. Override this
2752 method to not throw an error, and its return value becomes the
2753 return value of `call-next-method'."
2755 )
2758 "Make a copy of OBJ, and then supply PARAMS.
2759 PARAMS is a parameter list of the same form used by `initialize-instance'.
2761 When overloading `clone', be sure to call `call-next-method'
2765 "Make a copy of OBJ, and then apply PARAMS."
2778 nobj))
2784 "Destructor for cleaning up any dynamic links to our object.
2785 Argument THIS is the object being destroyed. PARAMS are additional
2786 ignored parameters."
2787 ;; No cleanup... yet.
2788 )
2791 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2793 It is sometimes useful to put a summary of the object into the
2794 default #<notation> string when using EIEIO browsing tools.
2798 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2799 The default method for printing object THIS is to use the
2800 function `object-name'.
2802 It is sometimes useful to put a summary of the object into the
2803 default #<notation> string when using EIEIO browsing tools.
2805 Implement this function and specify STRINGS in a call to
2806 `call-next-method' to provide additional summary information.
2807 When passing in extra strings from child classes, always remember
2808 to prepend a space."
2815 "Write out object THIS to the current stream.
2819 "Write object THIS out to the current stream.
2820 This writes out the vector version of this object. Complex and recursive
2821 object are discouraged from being written.
2822 If optional COMMENT is non-nil, include comments when outputting
2823 this object."
2832 ;; Now output readable lisp to recreate this object
2833 ;; It should look like this:
2834 ;; (<constructor> <name> <slot> <slot> ... )
2835 ;; Each slot's slot is writen using its :writer.
2842 ;; Loop over all the public slots
2851 )
2858 ;; Use our public printer
2862 ;; Use our generic override prin1 function.
2874 "Perform a `prin1' on THING taking advantage of object knowledge."
2888 "Display LIST where list may contain objects."
2905 \f
2906 ;;; Unimplemented functions from CLOS
2907 ;;
2909 "Change the class of OBJ to type CLASS.
2910 This may create or delete slots, but does not affect the return value
2911 of `eq'."
2914 )
2916 ;;; Obsolete backward compatibility functions.
2917 ;; Needed to run byte-code compiled with the EIEIO of Emacs-23.
2920 "Obsolete work part of an old version of the `defmethod' macro."
2922 ;; find optional keys
2927 method-before)
2931 method-after)
2935 method-primary)
2939 method-static)
2940 ;; Primary key
2942 ;; get body, and fix contents of args to be the arguments of the fn.
2946 ;; Create a fixed version of the arguments
2949 argfix))
2951 ;; make sure there is a generic
2953 method
2956 ;; create symbol for property to bind to. If the first arg is of
2957 ;; the form (varname vartype) and `vartype' is a class, then
2958 ;; that class will be the type symbol. If not, then it will fall
2959 ;; under the type `primary' which is a non-specific calling of the
2960 ;; function.
2970 ;; generics are higher
2972 ;; Put this lambda into the symbol so we can find it
2976 key argclass))
2977 )
2980 ;; Optimizing step:
2981 ;;
2982 ;; If this method, after this setup, only has primary methods, then
2983 ;; we can setup the generic that way.
2985 ;; If there is only one primary method, then we can go one more
2986 ;; optimization step.
2992 method)
2996 "Obsolete work part of an old version of the `defgeneric' macro."
3000 )
3002 method))
3003 ;; Don't do this over and over.
3005 ;; This defun tells emacs where the first definition of this
3006 ;; method is defined.
3008 ;; Make sure the method tables are installed.
3010 ;; Apply the actual body of this function.
3012 ;; Return the method
3016 ;;; Interfacing with edebug
3017 ;;
3019 "Display EIEIO OBJECT in fancy format.
3020 Overrides the edebug default.
3021 Optional argument NOESCAPE is passed to `prin1-to-string' when appropriate."
3034 ;; ^^ This is the methods symbol
3036 list ; arguments
3038 def-body ; part to be debugged
3039 ))
3040 ;; The rest of the macros
3051 ;; I suspect this isn't the best way to do this, but when
3052 ;; cust-print was used on my system all my objects
3053 ;; appeared as "#1 =" which was not useful. This allows
3054 ;; edebug to print my objects in the nice way they were
3055 ;; meant to with `object-print' and `class-name'
3056 ;; (defalias 'edebug-prin1-to-string 'eieio-edebug-prin1-to-string)
3057 )
3058 )
3060 ;;; Autoloading some external symbols, and hooking into the help system
3061 ;;
3063 \f
3064 ;;; Start of automatically extracted autoloads.
3065 \f
3066 ;;;### (autoloads (customize-object) "eieio-custom" "eieio-custom.el"
3067 ;;;;;; "928623502e8bf40454822355388542b5")
3068 ;;; Generated autoloads from eieio-custom.el
3071 Customize OBJ in a custom buffer.
3072 Optional argument GROUP is the sub-group of slots to display.
3076 ;;;***
3077 \f
3078 ;;;### (autoloads (eieio-help-mode-augmentation-maybee eieio-describe-generic
3079 ;;;;;; eieio-describe-constructor eieio-describe-class eieio-browse)
3080 ;;;;;; "eieio-opt" "eieio-opt.el" "d808328f9c0156ecbd412d77ba8c569e")
3081 ;;; Generated autoloads from eieio-opt.el
3084 Create an object browser window to show all objects.
3085 If optional ROOT-CLASS, then start with that, otherwise start with
3086 variable `eieio-default-superclass'.
3092 Describe a CLASS defined by a string or symbol.
3093 If CLASS is actually an object, then also display current values of that object.
3094 Optional HEADERFCN should be called to insert a few bits of info first.
3099 Describe the constructor function FCN.
3100 Uses `eieio-describe-class' to describe the class being constructed.
3106 Describe the generic function GENERIC.
3107 Also extracts information about all methods specific to this generic.
3112 For buffers thrown into help mode, augment for EIEIO.
3113 Arguments UNUSED are not used.
3117 ;;;***
3118 \f
3119 ;;; End of automatically extracted autoloads.
3123 ;;; eieio ends here