| blob | 119424e789c9ee403c47d978557eff4a82220686 |
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-2011 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:
54 "Display the current version of EIEIO."
59 ;; About the above. EIEIO must process its own code when it compiles
60 ;; itself, thus, by eval-and-compiling outselves, we solve the problem.
62 ;; Compatibility
65 ;; XEmacs can only access a compiled functions arglist like this:
68 ;; Emacs doesn't have this function, but since FUNC is a vector, we can just
69 ;; grab the appropriate element.
71 "Return the argument list for the compiled function FUNC."
74 )
76 \f
77 ;;;
78 ;; Variable declarations.
79 ;;
85 "Non-nil to throw an error if an encountered tag is unsupported.
86 This may prevent classes from CLOS applications from being used with EIEIO
90 "*If non-nil, skip all slot typechecking.
91 Set this to t permanently if a program is functioning well to get a
92 small speed increase. This variable is also used internally to handle
98 ;; State Variables
99 ;; FIXME: These two constants below should have an `eieio-' prefix added!!
101 "Inside a method, this variable is the object in question.
102 DO NOT SET THIS YOURSELF unless you are trying to simulate friendly slots.
104 Note: Embedded methods are no longer supported. The variable THIS is
105 still set for CLOS methods for the sake of routines like
109 "This is set to a class when a method is running.
110 This is so we know we are allowed to check private parts or how to
118 eieio-unbound
122 ;; This is a bootstrap for eieio-default-superclass so it has a value
123 ;; while it is being built itself.
126 ;; FIXME: The constants below should have an `eieio-' prefix added!!
130 (defconst class-symbol-obarray 4 "Obarray permitting fast access to variable position indexes.")
131 ;; @todo
132 ;; the word "public" here is leftovers from the very first version.
133 ;; Get rid of it!
154 "Cache index of what a newly created object would look like.
155 This will speed up instantiation time as only a `copy-sequence' will
156 be needed, instead of looping over all the values and setting them
159 "Storage location of tagged class options.
172 (defconst method-num-lists 4 "Number of indexes into methods vector in which groups of functions are kept.")
179 "Convert a specialized KEY into a generic method key."
183 ))
185 \f
186 ;;; Important macros used in eieio.
187 ;;
189 "Internal: Return the class vector from the CLASS symbol."
190 ;; No check: If eieio gets this far, it's probably been checked already.
194 "Return t if CLASS is a valid class vector.
195 CLASS is a symbol."
196 ;; this new method is faster since it doesn't waste time checking lots of
197 ;; things.
203 "Return non-nil if OBJ is an EIEIO object."
212 "Return the symbol representing the constructor of CLASS."
216 "Return t if symbol METHOD is a generic function.
217 Only methods have the symbol `eieio-method-obarray' as a property
218 \(which contains a list of all bindings to that method type.)"
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 t if symbol METHOD is a generic function with only primary methods.
239 Only methods have the symbol `eieio-method-obarray' as a property (which
240 contains a list of all bindings to that method type.)
241 Methods with only primary implementations are executed in an optimized way."
251 ))
254 "Return from LIST the found OPTION, or nil if it doesn't exist."
258 "Return the value stored for CLASS' OPTION.
259 Return nil if that option doesn't exist."
263 "Return non-nil if CLASS is abstract.
264 Abstract classes cannot be instantiated."
268 "Return the invocation order of CLASS.
269 Abstract classes cannot be instantiated."
273 \f
274 ;;; Defining a new class
275 ;;
277 "Define NAME as a new class derived from SUPERCLASS with SLOTS.
278 OPTIONS-AND-DOC is used as the class' options and base documentation.
279 SUPERCLASS is a list of superclasses to inherit from, with SLOTS
280 being the slots residing in that class definition. NOTE: Currently
281 only one slot may exist in SUPERCLASS as multiple inheritance is not
282 yet supported. Supported tags are:
284 :initform - Initializing form.
285 :initarg - Tag used during initialization.
286 :accessor - Tag used to create a function to access this slot.
287 :allocation - Specify where the value is stored.
288 Defaults to `:instance', but could also be `:class'.
289 :writer - A function symbol which will `write' an object's slot.
290 :reader - A function symbol which will `read' an object.
291 :type - The type of data allowed in this slot (see `typep').
292 :documentation
293 - A string documenting use of this slot.
295 The following are extensions on CLOS:
296 :protection - Specify protection for this slot.
297 Defaults to `:public'. Also use `:protected', or `:private'.
298 :custom - When customizing an object, the custom :type. Public only.
299 :label - A text string label used for a slot when customizing.
300 :group - Name of a customization group this slot belongs in.
301 :printer - A function to call to print the value of a slot.
302 See `eieio-override-prin1' as an example.
304 A class can also have optional options. These options happen in place
305 of documentation (including a :documentation tag), in addition to
306 documentation, or not at all. Supported options are:
308 :documentation - The doc-string used for this class.
310 Options added to EIEIO:
312 :allow-nil-initform - Non-nil to skip typechecking of null initforms.
313 :custom-groups - List of custom group names. Organizes slots into
314 reasonable groups for customizations.
315 :abstract - Non-nil to prevent instances of this class.
316 If a string, use as an error string if someone does
317 try to make an instance.
318 :method-invocation-order
319 - Control the method invocation order if there is
320 multiple inheritance. Valid values are:
321 :breadth-first - The default.
322 :depth-first
324 Options in CLOS not supported in EIEIO:
326 :metaclass - Class to use in place of `standard-class'
327 :default-initargs - Initargs to use when initializing new objects of
328 this class.
330 Due to the way class options are set up, you can add any tags you wish,
331 and reference them using the function `class-option'."
332 ;; We must `eval-and-compile' this so that when we byte compile
333 ;; an eieio program, there is no need to load it ahead of time.
334 ;; It also provides lots of nice debugging errors at compile time.
341 ;; We autoload this because it's used in `make-autoload'.
342 ;;;###autoload
344 "Create autoload symbols for the EIEIO class CNAME.
345 SUPERCLASSES are the superclasses that CNAME inherits from.
346 DOC is the docstring for CNAME.
347 This function creates a mock-class for CNAME and adds it into
348 SUPERCLASSES as children.
349 It creates an autoload function for CNAME's constructor."
350 ;; Assume we've already debugged inputs.
354 )
356 nil ;; Do nothing if we already have this class.
358 ;; Create the class in NEWC, but don't fill anything else in.
363 ;; No parents?
366 clear-parent t)
367 )
369 ;; Hook our new class into the existing structures so we can
370 ;; autoload it later.
374 ;; TODO - If we create an autoload that is in the map, that
375 ;; map needs to be cleared!
378 ;; Does our parent exist?
381 ;; Create a symbol for this parent, and then store this
382 ;; parent on that symbol.
387 )
389 ;; We have a parent, save the child in there.
394 ;; save parent in child
396 )
398 ;; turn this into a usable self-pointing symbol
401 ;; Store the new class vector definition into the symbol. We need to
402 ;; do this first so that we can call defmethod for the accessor.
403 ;; The vector will be updated by the following while loop and will not
404 ;; need to be stored a second time.
407 ;; Clear the parent
410 ;; Create an autoload on top of our constructor function.
415 ))))
418 "If class CNAME is in an autoload state, load its file."
423 ;; FIXME: Most of this should be moved to the `defclass' macro.
424 "Define CNAME as a new subclass of SUPERCLASSES.
425 SLOTS are the slots residing in that class definition, and options or
426 documentation OPTIONS-AND-DOC is the toplevel documentation for this class.
427 See `defclass' for more information."
428 ;; Run our eieio-hook each time, and clear it when we are done.
429 ;; This way people can add hooks safely if they want to modify eieio
430 ;; or add definitions when eieio is loaded or something like that.
447 ;; If this class already existed, and we are updating its structure,
448 ;; make sure we keep the old child list. This can cause bugs, but
449 ;; if no new slots are created, it also saves time, and prevents
450 ;; method table breakage, particularly when the users is only
451 ;; byte compiling an EIEIO file.
454 ;; If the old class did not exist, but did exist in the autoload map, then adopt those children.
455 ;; This is like the above, but deals with autoloads nicely.
462 ))
463 )
471 )
476 options-and-doc))
483 ;; bad class
485 ;; good parent class...
486 ;; save new child in parent
490 ;; Get custom groups, and store them into our local copy.
493 ;; save parent in child
497 ;; Reverse the list of our parents so that they are prioritized in
498 ;; the same order as specified in the code.
500 ;; If there is nothing to loop over, then inherit from the
501 ;; default superclass.
503 ;; adopt the default parent here, but clear it later...
505 ;; save new child in parent
509 ;; save parent in child
512 ;; turn this into a usable self-pointing symbol
515 ;; These two tests must be created right away so we can have self-
516 ;; referencing classes. ei, a class whose slot can contain only
517 ;; pointers to itself.
519 ;; Create the test function
527 ;; Make sure the method invocation order is a valid value.
531 ))
533 ;; Create a handy child test too
538 "Test OBJ to see if it an object is a child of type %s"
539 cname)
543 ;; When using typep, (typep OBJ 'myclass) returns t for objects which
544 ;; are subclasses of myclass. For our predicates, however, it is
545 ;; important for EIEIO to be backwards compatible, where
546 ;; myobject-p, and myobject-child-p are different.
547 ;; "cl" uses this technique to specify symbols with specific typep
548 ;; test, so we can let typep have the CLOS documented behavior
549 ;; while keeping our above predicate clean.
551 ;; It would be cleaner to use `defsetf' here, but that requires cl
552 ;; at runtime.
556 ;; before adding new slots, lets add all the methods and classes
557 ;; in from the parent class
560 ;; Store the new class vector definition into the symbol. We need to
561 ;; do this first so that we can call defmethod for the accessor.
562 ;; The vector will be updated by the following while loop and will not
563 ;; need to be stored a second time.
566 ;; Query each slot in the declaration list and mangle into the
567 ;; class structure I have defined.
575 eieio-unbound)))
589 )
595 :initform
596 :initarg
597 :documentation
598 :protection
599 :reader
600 :writer
601 :allocation
602 :type
603 :custom
604 :label
605 :group
606 :printer
607 :allow-nil-initform
612 ;; Clean up the meaning of protection.
619 ;; Make sure the :allocation parameter has a valid value.
623 ;; The default type specifier is supposed to be t, meaning anything.
626 ;; Label is nil, or a string
630 ;; Is there an initarg, but allocation of class?
634 ;; intern the symbol so we can use it blankly
637 ;; The customgroup should be a list of symbols
642 ;; The customgroup better be a symbol, or list of symbols.
646 customg)
648 ;; First up, add this slot into our new class.
652 ;; We need to id the group, and store them in a group list attribute.
655 ;; anyone can have an accessor function. This creates a function
656 ;; of the specified name, and also performs a `defsetf' if applicable
657 ;; so that users can `setf' the space returned by this function
664 "Retrieves the slot `%s' from an object of class `%s'"
665 name cname)
668 ;; Else - Some error? nil?
669 nil)))
671 ;; Provide a setf method. It would be cleaner to use
672 ;; defsetf, but that would require CL at runtime.
684 ;; If a writer is defined, then create a generic method of that
685 ;; name whose purpose is to set the value of the slot.
688 writer nil cname
691 name cname)
693 ;; If a reader is defined, then create a generic method
694 ;; of that name whose purpose is to access this slot value.
697 reader nil cname
700 name cname)
702 )
705 ;; Now that everything has been loaded up, all our lists are backwards! Fix that up now.
718 ;; The storage for class-class-allocation-type needs to be turned into
719 ;; a vector now.
723 ;; Also, take class allocated values, and vectorize them for speed.
727 ;; Attach slot symbols into an obarray, and store the index of
728 ;; this slot as the variable slot in this new symbol. We need to
729 ;; know about primes, because obarrays are best set in vectors of
730 ;; prime number length, and we also need to make our vector small
731 ;; to save space, and also optimal for the number of items we have.
751 )
753 ;; Create the constructor function
755 ;; Abstract classes cannot be instantiated. Say so.
764 ;; Non-abstract classes need a constructor.
769 )
771 ;; Set up a specialized doc string.
772 ;; Use stored value since it is calculated in a non-trivial way
776 ;; We have a list of custom groups. Store them into the options.
783 ;; Set up the options we have collected.
786 ;; if this is a superclass, clear out parent (which was set to the
787 ;; default superclass eieio-default-superclass)
790 ;; Create the cached default object.
797 ;; All type-checking has been done to our satisfaction
798 ;; before this call. Don't waste our time in this call..
802 ;; Return our new class object
803 ;; newc
804 cname
805 ))
808 "For SLOT, signal if SPEC does not match VALUE.
809 If SKIPNIL is non-nil, then if VALUE is nil return t instead."
818 "Add into NEWC attribute A.
819 If A already exists in NEWC, then do nothing. If it doesn't exist,
820 then also add in D (default), DOC, TYPE, CUST, LABEL, CUSTG, PRINT, PROT, and INIT arg.
821 Argument ALLOC specifies if the slot is allocated per instance, or per class.
822 If optional DEFAULTOVERRIDE is non-nil, then if A exists in NEWC,
823 we must override its value for a default.
824 Optional argument SKIPNIL indicates if type checking should be skipped
825 if default value is nil."
826 ;; Make sure we duplicate those items that are sequences.
829 ;; This copy can fail on a cons cell with a non-cons in the cdr. Lets skip it if it doesn't work.
835 ;; To prevent override information w/out specification of storage,
836 ;; we need to do this little hack.
840 ;; In this case, we modify the INSTANCE version of a given slot.
844 ;; Only add this element if it is so-far unique
858 )
859 ;; When defaultoverride is true, we are usually adding new local
860 ;; attributes which must override the default value of any slot
861 ;; passed in by one of the parent classes.
863 ;; There is a match, and we must override the old value.
868 nil))
870 )
873 a)
874 ;; If type is passed in, is it the same?
878 "Child slot type `%s' does not match inherited type `%s' for `%s'"
879 type tp a)))
880 ;; If we have a repeat, only update the initarg...
884 ;; If we have a new initarg, check for it.
888 ;; Replace the CAR of the associate INITA.
889 ;;(message "Initarg: %S replace %s" inita init)
891 ))
893 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
894 ;; checked and SHOULD match the superclass
895 ;; protection. Otherwise an error is thrown. However
896 ;; I wonder if a more flexible schedule might be
897 ;; implemented.
898 ;;
899 ;; EML - We used to have (if prot... here,
900 ;; but a prot of 'nil means public.
901 ;;
903 )
906 prot super-prot a)))
907 ;; End original PLN
909 ;; PLN Tue Jun 26 11:57:06 2007 :
910 ;; Do a non redundant combination of ancient custom
911 ;; groups and new ones.
923 ;; End PLN
925 ;; PLN Mon Jun 25 22:44:34 2007 : If a new cust is
926 ;; set, simply replaces the old one.
928 ;; (message "Custom type redefined to %s" cust)
931 ;; If a new label is specified, it simply replaces
932 ;; the old one.
934 ;; (message "Custom label redefined to %s" label)
936 ;; End PLN
938 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
939 ;; doc is specified, simply replaces the old one.
941 ;;(message "Documentation redefined to %s" doc)
943 doc))
944 ;; End PLN
946 ;; If a new printer is specified, it simply replaces
947 ;; the old one.
949 ;; (message "printer redefined to %s" print)
952 )))
953 ))
955 ;; CLASS ALLOCATED SLOTS
960 ;; Here we have found a :class version of a slot. This
961 ;; requires a very different approach.
966 (aset newc class-class-allocation-custom-label (cons label (aref newc class-class-allocation-custom-label)))
967 (aset newc class-class-allocation-custom-group (cons custg (aref newc class-class-allocation-custom-group)))
968 (aset newc class-class-allocation-protection (cons prot (aref newc class-class-allocation-protection)))
969 ;; Default value is stored in the 'values section, since new objects
970 ;; can't initialize from this element.
971 (aset newc class-class-allocation-values (cons value (aref newc class-class-allocation-values))))
973 ;; There is a match, and we must override the old value.
980 nil))
982 nil)))
985 a)
986 ;; If type is passed in, is it the same?
990 "Child slot type `%s' does not match inherited type `%s' for `%s'"
991 type tp a)))
992 ;; EML - Note: the only reason to override a class bound slot
993 ;; is to change the default, so allow unbound in.
995 ;; If we have a repeat, only update the vlaue...
999 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
1000 ;; checked and SHOULD match the superclass
1001 ;; protection. Otherwise an error is thrown. However
1002 ;; I wonder if a more flexible schedule might be
1003 ;; implemented.
1008 prot super-prot a)))
1009 ;; Do a non redundant combination of ancient custom groups
1010 ;; and new ones.
1023 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
1024 ;; doc is specified, simply replaces the old one.
1026 ;;(message "Documentation redefined to %s" doc)
1028 doc))
1029 ;; End PLN
1031 ;; If a new printer is specified, it simply replaces
1032 ;; the old one.
1034 ;; (message "printer redefined to %s" print)
1037 ))
1038 ))
1039 ))
1042 "Copy into NEWC the slots of PARENTS.
1043 Follow the rules of not overwriting early parents when applying to
1044 the new child class."
1049 ;; First, duplicate all the slots of the parent.
1068 ;; Increment each value.
1080 ;; Now duplicate all the class alloc slots.
1097 ;; Increment each value.
1107 ;; Loop over each parent class
1109 ))
1111 ;;; CLOS style implementation of object creators.
1112 ;;
1114 "Make a new instance of CLASS based on INITARGS.
1115 CLASS is a class symbol. For example:
1117 (make-instance 'foo)
1119 INITARGS is a property list with keywords based on the :initarg
1120 for each slot. For example:
1122 (make-instance 'foo :slot1 value1 :slotN valueN)
1124 Compatibility note:
1126 If the first element of INITARGS is a string, it is used as the
1127 name of the class.
1129 In EIEIO, the class' constructor requires a name for use when printing.
1130 `make-instance' in CLOS doesn't use names the way Emacs does, so the
1131 class is used as the name slot instead when INITARGS doesn't start with
1132 a string."
1138 initargs)))
1140 \f
1141 ;;; CLOS methods and generics
1142 ;;
1147 "Like `defalias', but with less side-effects.
1148 More specifically, it has no side-effects at all when the new function
1149 definition is the same (`eq') as the old one."
1155 "Create a generic function METHOD.
1156 DOC-STRING is the base documentation for this class. A generic
1157 function has no body, as its purpose is to decide which method body
1158 is appropriate to use. Uses `defmethod' to create methods, and calls
1159 `defgeneric' for you. With this implementation the ARGS are
1160 currently ignored. You can use `defgeneric' to apply specialized
1161 top level documentation to a method."
1166 "Form to use for the initial definition of a generic."
1170 ;; Make sure the method tables are installed.
1172 ;; Construct the actual body of this function.
1176 method))))
1179 "The lambda form that would be used as the function defined on METHOD.
1180 All methods should call the same EIEIO function for dispatch.
1181 DOC-STRING is the documentation attached to METHOD."
1183 ,doc-string
1187 "Setup METHOD to call the generic form."
1192 "The lambda form that would be used as the function defined on METHOD.
1193 All methods should call the same EIEIO function for dispatch.
1194 DOC-STRING is the documentation attached to METHOD."
1196 ,doc-string
1200 "Setup METHOD to call the generic form."
1205 class
1206 impl
1207 )
1208 "The lambda form that would be used as the function defined on METHOD.
1209 All methods should call the same EIEIO function for dispatch.
1210 DOC-STRING is the documentation attached to METHOD.
1211 CLASS is the class symbol needed for private method access.
1212 IMPL is the symbol holding the method implementation."
1213 ;; NOTE: I tried out byte compiling this little fcn. Turns out it
1214 ;; is faster to execute this for not byte-compiled. ie, install this,
1215 ;; then measure calls going through here. I wonder why.
1220 ,doc-string
1221 ;; This is a cool cheat. Usually we need to look up in the
1222 ;; method table to find out if there is a method or not. We can
1223 ;; instead make that determination at load time when there is
1224 ;; only one method. If the first arg is not a child of the class
1225 ;; of that one implementation, then clearly, there is no method def.
1227 ;; Not an object. Just signal.
1231 ;; We do have an object. Make sure it is the right type.
1233 nil ; default superclass means just an obj. Already asked.
1237 ;; If not the right kind of object, call no applicable
1241 ;; It is ok, do the call.
1242 ;; Fill in inter-call variables then evaluate the method.
1248 )
1250 ;;(,impl local-args)
1251 )))))))
1254 "Setup METHOD to call the generic form."
1258 )
1260 method doc-string
1263 ))))
1266 "Make the generic method METHOD have no implementations.
1267 It will leave the original generic function in place,
1268 but remove reference to all implementations of METHOD."
1273 "Create a new METHOD through `defgeneric' with ARGS.
1275 The optional second argument KEY is a specifier that
1276 modifies how the method is called, including:
1277 :before - Method will be called before the :primary
1278 :primary - The default if not specified
1279 :after - Method will be called after the :primary
1280 :static - First arg could be an object or class
1281 The next argument is the ARGLIST. The ARGLIST specifies the arguments
1282 to the method as with `defun'. The first argument can have a type
1283 specifier, such as:
1284 ((VARNAME CLASS) ARG2 ...)
1285 where VARNAME is the name of the local variable for the method being
1286 created. The CLASS is a class symbol for a class made with `defclass'.
1287 A DOCSTRING comes after the ARGLIST, and is optional.
1288 All the rest of the args are the BODY of the method. A method will
1289 return the value of the last form in the BODY.
1291 Summary:
1293 (defmethod mymethod [:before | :primary | :after | :static]
1294 ((typearg class-name) arg2 &optional opt &rest rest)
1296 body)"
1302 params))
1306 ;; Make sure there is a generic and the byte-compiler sees it.
1313 "Work part of the `defmethod' macro defining METHOD with ARGS."
1315 ;; find optional keys
1318 method-before)
1321 method-after)
1324 method-primary)
1327 method-static)
1328 ;; Primary key
1330 ;; Make sure there is a generic (when called from defclass).
1335 ;; create symbol for property to bind to. If the first arg is of
1336 ;; the form (varname vartype) and `vartype' is a class, then
1337 ;; that class will be the type symbol. If not, then it will fall
1338 ;; under the type `primary' which is a non-specific calling of the
1339 ;; function.
1343 argclass))
1346 ;; generics are higher
1348 ;; Put this lambda into the symbol so we can find it
1350 )
1353 ;; Optimizing step:
1354 ;;
1355 ;; If this method, after this setup, only has primary methods, then
1356 ;; we can setup the generic that way.
1358 ;; If there is only one primary method, then we can go one more
1359 ;; optimization step.
1365 method)
1367 ;;; Slot type validation
1369 ;; This is a hideous hack for replacing `typep' from cl-macs, to avoid
1370 ;; requiring the CL library at run-time. It can be eliminated if/when
1371 ;; `typep' is merged into Emacs core.
1415 "Return non-nil if SPEC does not match VALUE."
1421 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1422 Checks the :type specifier.
1423 SLOT is the slot that is being checked, and is only used when throwing
1424 an error."
1426 nil
1427 ;; Trim off object IDX junk added in for the object index.
1434 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1435 Checks the :type specifier.
1436 SLOT is the slot that is being checked, and is only used when throwing
1437 an error."
1439 nil
1441 slot-idx)))
1446 "Throw a signal if VALUE is a representation of an UNBOUND slot.
1447 INSTANCE is the object being referenced. SLOTNAME is the offending
1448 slot. If the slot is ok, return VALUE.
1449 Argument FN is the function calling this verifier."
1452 value))
1454 ;;; Get/Set slots in an object.
1455 ;;
1457 "Retrieve the value stored in OBJ in the slot named by SLOT.
1458 Slot is the name of the slot when created by `defclass' or the label
1459 created by the :initarg tag."
1463 "Return the value in OBJ at SLOT in the object vector."
1472 ;; It might be missing because it is a :class allocated slot.
1473 ;; Lets check that info out.
1475 ;; Oref that slot.
1477 ;; The slot-missing method is a cool way of allowing an object author
1478 ;; to intercept missing slot definitions. Since it is also the LAST
1479 ;; thing called in this fn, its return value would be retrieved.
1481 ;;(signal 'invalid-slot-name (list (object-name obj) slot))
1482 )
1491 "Get the default value of OBJ (maybe a class) for SLOT.
1492 The default value is the value installed in a class with the :initform
1493 tag. SLOT can be the slot name, or the tag specified by the :initarg
1494 tag in the `defclass' call."
1498 "Do the work for the macro `oref-default' with similar parameters.
1499 Fills in OBJ's SLOT with its default value."
1500 (if (not (or (eieio-object-p obj) (class-p obj))) (signal 'wrong-type-argument (list 'eieio-object-p obj)))
1505 ;; It might be missing because it is a :class allocated slot.
1506 ;; Lets check that info out.
1509 ;; Oref that slot.
1511 c)
1513 ;;(signal 'invalid-slot-name (list (class-name cl) slot))
1514 )
1521 "Whether the default value VAL should be evaluated for use."
1525 "Check VAL, and return what `oref-default' would provide."
1527 ;; Is it a function call? If so, evaluate it.
1530 ;;;; check for quoted things, and unquote them
1531 ;;((and (consp val) (eq (car val) 'quote))
1532 ;; (car (cdr val)))
1533 ;; return it verbatim
1536 ;;; Object Set macros
1537 ;;
1539 "Set the value in OBJ for slot SLOT to VALUE.
1540 SLOT is the slot name as specified in `defclass' or the tag created
1541 with in the :initarg slot. VALUE can be any Lisp object."
1545 "Do the work for the macro `oset'.
1546 Fills in OBJ's SLOT with VALUE."
1551 ;; It might be missing because it is a :class allocated slot.
1552 ;; Lets check that info out.
1555 ;; Oset that slot.
1559 class-class-allocation-values)
1560 c value))
1561 ;; See oref for comment on `slot-missing'
1563 ;;(signal 'invalid-slot-name (list (object-name obj) slot))
1564 )
1569 "Set the default slot in CLASS for SLOT to VALUE.
1570 The default value is usually set with the :initform tag during class
1571 creation. This allows users to change the default behavior of classes
1572 after they are created."
1576 "Do the work for the macro `oset-default'.
1577 Fills in the default value in CLASS' in SLOT with VALUE."
1583 ;; It might be missing because it is a :class allocated slot.
1584 ;; Lets check that info out.
1587 ;; Oref that slot.
1590 value))
1593 ;; Set this into the storage for defaults.
1595 value)
1596 ;; Take the value, and put it into our cache object.
1598 slot value)
1599 )))
1601 ;;; Handy CLOS macros
1602 ;;
1604 "Bind SPEC-LIST lexically to slot values in OBJECT, and execute BODY.
1605 This establishes a lexical environment for referring to the slots in
1606 the instance named by the given slot-names as though they were
1607 variables. Within such a context the value of the slot can be
1608 specified by using its slot name, as if it were a lexically bound
1609 variable. Both setf and setq can be used to set the value of the
1610 slot.
1612 SPEC-LIST is of a form similar to `let'. For example:
1614 ((VAR1 SLOT1)
1615 SLOT2
1616 SLOTN
1617 (VARN+1 SLOTN+1))
1619 Where each VAR is the local variable given to the associated
1620 SLOT. A slot specified without a variable name is given a
1621 variable name of the same name as the slot."
1623 ;; Transform the spec-list into a symbol-macrolet spec-list.
1628 spec-list)))
1630 body)))
1631 \f
1632 ;;; Simple generators, and query functions. None of these would do
1633 ;; well embedded into an object.
1634 ;;
1640 ;; I think this is supposed to return a symbol, but to me CLASS is a symbol,
1641 ;; and I wanted a string. Arg!
1645 "Return a Lisp like symbol string for object OBJ.
1646 If EXTRA, include that in the string returned to represent the symbol."
1673 "Return parent classes to CLASS. (overload of variable).
1675 The CLOS function `class-direct-superclasses' is aliased to this function."
1683 "Return child classes to CLASS.
1685 The CLOS function `class-direct-subclasses' is aliased to this function."
1690 "Returns CLASS if it can go in the result now, otherwise nil"
1691 ;; Ensure CLASS is not in any position but the first in any of the
1692 ;; element lists of REMAINING-INPUTS.
1697 found))
1698 class))
1701 "Merge REVERSED-PARTIAL-RESULT REMAINING-INPUTS in a consistent order, if possible.
1702 If a consistent order does not exist, signal an error."
1708 ;; If all remaining inputs are empty lists, we are done.
1710 ;; Otherwise, we try to find the next element of the result. This
1711 ;; is achieved by considering the first element of each
1712 ;; (non-empty) input list and accepting a candidate if it is
1713 ;; consistent with the rests of the input lists.
1720 remaining-inputs))
1722 found)))
1724 ;; The graph is consistent so far, add NEXT to result and
1725 ;; merge input lists, dropping NEXT from their heads where
1726 ;; applicable.
1730 remaining-inputs))
1731 ;; The graph is inconsistent, give up
1735 "Return all parents of CLASS in depth-first order."
1745 parents)
1748 ;; Remove duplicates.
1752 classes))
1755 "Return all parents of CLASS in breadth-first order."
1767 )
1770 "Return all parents of CLASS in c3 order."
1779 parents)
1782 )
1785 "Return (transitively closed) list of parents of CLASS.
1786 The order, in which the parents are returned depends on the
1787 method invocation orders of the involved classes."
1789 nil
1791 (:depth-first
1793 (:breadth-first
1795 (:c3
1797 )
1799 ;; Official CLOS functions.
1809 (defmacro same-class-fast-p (obj class) "Return t if OBJ is of class-type CLASS with no error checking."
1818 "Return non-nil if OBJ is an instance of CLASS or CLASS' subclasses."
1820 ;; class will be checked one layer down
1822 ;; Backwards compatibility
1826 "Return non-nil if CHILD class is a subclass of CLASS."
1837 "Return list of slots available in OBJ."
1849 f))
1851 ;;; CLOS queries into classes and slots
1852 ;;
1854 "Return non-nil if OBJECT's SLOT is bound.
1855 Setting a slot's value makes it bound. Calling `slot-makeunbound' will
1856 make a slot unbound.
1857 OBJECT can be an instance or a class."
1858 ;; Skip typechecking while retrieving this value.
1860 ;; Return nil if the magic symbol is in there.
1865 eieio-unbound))))
1868 "In OBJECT, make SLOT unbound."
1872 "Return non-nil if OBJECT-OR-CLASS has SLOT."
1876 object-or-class))
1877 )))
1880 ))
1883 "Return the class that SYMBOL represents.
1884 If there is no class, nil is returned if ERRORP is nil.
1885 If ERRORP is non-nil, `wrong-argument-type' is signaled."
1888 nil)
1891 ;;; Slightly more complex utility functions for objects
1892 ;;
1894 "Return an object if KEY is `equal' to SLOT's value of an object in LIST.
1895 LIST is a list of objects whose slots are searched.
1896 Objects in LIST do not need to have a slot named SLOT, nor does
1897 SLOT need to be bound. If these errors occur, those objects will
1898 be ignored."
1901 ;; This prevents errors for missing slots.
1908 "Return an association list with the contents of SLOT as the key element.
1909 LIST must be a list of objects with SLOT in it.
1910 This is useful when you need to do completing read on an object group."
1916 assoclist))
1921 "Return an association list with the contents of SLOT as the key element.
1922 LIST must be a list of objects, but those objects do not need to have
1923 SLOT in it. If it does not, then that element is left out of the association
1924 list."
1931 assoclist)))
1936 "In OBJECT's SLOT, add ITEM to the list of elements.
1937 Optional argument APPEND indicates we need to append to the list.
1938 If ITEM already exists in the list in SLOT, then it is not added.
1939 Comparison is done with `equal' through the `member' function call.
1940 If SLOT is unbound, bind it to the list containing ITEM."
1942 ;; Find the originating list.
1946 ;; turn it into a list.
1949 ;; Do the combination
1955 ;; Set back into the slot.
1959 "In OBJECT's SLOT, remove occurrences of ITEM.
1960 Deletion is done with `delete', which deletes by side effect,
1961 and comparisons are done with `equal'.
1962 If SLOT is unbound, do nothing."
1964 nil
1966 \f
1967 ;;; EIEIO internal search functions
1968 ;;
1970 "Return non-nil if START-CLASS is the first class to define SLOT.
1971 This is for testing if `scoped-class' is the class that defines SLOT
1972 so that we can protect private slots."
1976 t
1980 class-symbol-obarray))
1983 ret)))
1986 "In CLASS for OBJ find the index of the named SLOT.
1987 The slot is a symbol which is installed in CLASS by the `defclass'
1988 call. OBJ can be nil, but if it is an object, and the slot in question
1989 is protected, access will be allowed if OBJ is a child of the currently
1990 `scoped-class'.
1991 If SLOT is the value created with :initarg instead,
1992 reverse-lookup that name, and recurse with the associated slot value."
1993 ;; Removed checks to outside this call
1996 class-symbol-obarray)))
2003 scoped-class
2011 eieio-initializing-object))
2018 "In CLASS find the index of the named SLOT.
2019 The slot is a symbol which is installed in CLASS by the `defclass'
2020 call. If SLOT is the value created with :initarg instead,
2021 reverse-lookup that name, and recurse with the associated slot value."
2022 ;; This will happen less often, and with fewer slots. Do this the
2023 ;; storage cheap way.
2028 ;; Slot # is length of the total list, minus the remaining list of
2029 ;; the found slot.
2031 \f
2032 ;;; CLOS generics internal function handling
2033 ;;
2039 "When using `call-next-method', provides a context for the current key.
2042 "When executing a PRIMARY or STATIC method, track the 'next-method'.
2043 During executions, the list is first generated, then as each next method
2047 "*Hooks run just before a method is executed.
2048 The hook function must accept one argument, the list of forms
2052 "Call METHOD with ARGS.
2053 ARGS provides the context on which implementation to use.
2054 This should only be called from a generic function."
2055 ;; We must expand our arguments first as they are always
2056 ;; passed in as quoted symbols
2062 ;; get a copy
2065 ;; Is the class passed in autoloaded?
2066 ;; Since class names are also constructors, they can be autoloaded
2067 ;; via the autoload command. Check for this, and load them in.
2068 ;; It's ok if it doesn't turn out to be a class. Probably want that
2069 ;; function loaded anyway.
2075 ;; Determine the class to use.
2080 )
2081 ;; Make sure the class is a valid class
2082 ;; mclass can be nil (meaning a generic for should be used.
2083 ;; mclass cannot have a value that is not a class, however.
2086 method mclass)
2087 )
2088 ;; Now create a list in reverse order of all the calls we have
2089 ;; make in order to successfully do this right. Rules:
2090 ;; 1) Only call generics if scoped-class is not defined
2091 ;; This prevents multiple calls in the case of recursion
2092 ;; 2) Only call static if this is a static method.
2093 ;; 3) Only call specifics if the definition allows for them.
2094 ;; 4) Call in order based on :before, :primary, and :after
2096 ;; Non-static calls do all this stuff.
2098 ;; :after methods
2103 ;;(or (and mclass (eieio-generic-form method method-after mclass))
2104 ;; (eieio-generic-form method method-after nil))
2105 )
2109 ;; :primary methods
2116 primarymethodlist
2119 ;; :before methods
2124 ;;(or (and mclass (eieio-generic-form method method-before mclass))
2125 ;; (eieio-generic-form method method-before nil))
2126 )
2129 )
2132 ;; For the case of a class,
2133 ;; if there were no methods found, then there could be :static methods.
2139 primarymethodlist ;; Re-use even with bad name here
2141 ;; For the case of no class (ie - mclass == nil) then there may
2142 ;; be a primary method.
2148 primarymethodlist
2150 )
2153 primarymethodlist)
2155 ;; Now loop through all occurrences forms which we must execute
2156 ;; (which are happily sorted now) and execute them all!
2166 ;; Use the cdr, as the first element is the fcn
2167 ;; we are calling right now.
2169 )
2171 ;;(setq rval (apply (car (car lambdas)) newargs))
2175 rvalever t))
2176 ))
2182 rvalever t)
2184 'no-method-definition
2186 ;; Right Here... it could be that lastval is returned when
2187 ;; rvalever is nil. Is that right?
2188 rval)))
2191 "Call METHOD with ARGS for methods with only :PRIMARY implementations.
2192 ARGS provides the context on which implementation to use.
2193 This should only be called from a generic function.
2195 This method is like `eieio-generic-call', but only
2196 implementations in the :PRIMARY slot are queried. After many
2197 years of use, it appears that over 90% of methods in use
2198 have :PRIMARY implementations only. We can therefore optimize
2199 for this common case to improve performance."
2200 ;; We must expand our arguments first as they are always
2201 ;; passed in as quoted symbols
2207 )
2208 ;; get a copy
2212 ;; Determine the class to use.
2221 method)
2222 ))
2223 ;; Make sure the class is a valid class
2224 ;; mclass can be nil (meaning a generic for should be used.
2225 ;; mclass cannot have a value that is not a class, however.
2228 )
2230 ;; :primary methods
2235 ;; Now loop through all occurrences forms which we must execute
2236 ;; (which are happily sorted now) and execute them all!
2240 ;; Use the cdr, as the first element is the fcn
2241 ;; we are calling right now.
2243 )
2247 ;; No methods found for this impl...
2250 rvalever t)
2252 'no-method-definition
2255 ;; Do the regular implementation here.
2258 lambdas)
2262 rvalever t)
2263 )
2265 ;; Right Here... it could be that lastval is returned when
2266 ;; rvalever is nil. Is that right?
2267 rval)))
2270 "Return an alist list of methods lambdas.
2271 METHOD is the method name.
2272 KEY represents either :before, or :after methods.
2273 CLASS is the starting class to search from in the method tree.
2274 If CLASS is nil, then an empty list of methods should be returned."
2275 ;; Note: eieiomt - the MT means MethodTree. See more comments below
2276 ;; for the rest of the eieiomt methods.
2278 ;; Collect lambda expressions stored for the class and its parent
2279 ;; classes.
2282 ;; Lookup the form to use for the PRIMARY object for the next level
2286 ;; This prevents duplicates coming out of the
2287 ;; class method optimizer. Perhaps we should
2288 ;; just not optimize before/afters?
2292 ;; Return collected lambda. For :after methods, return in current
2293 ;; order (most general class last); Otherwise, reverse order.
2295 lambdas
2299 "Return non-nil if there is a next method.
2300 Returns a list of lambda expressions which is the `next-method'
2301 order."
2302 eieio-generic-call-next-method-list)
2305 "Call the superclass method from a subclass method.
2306 The superclass method is specified in the current method list,
2307 and is called the next method.
2309 If REPLACEMENT-ARGS is non-nil, then use them instead of
2310 `eieio-generic-call-arglst'. The generic arg list are the
2311 arguments passed in at the top level.
2313 Use `next-method-p' to find out if there is a next method to call."
2319 )
2322 )
2330 )
2332 ))))
2333 \f
2334 ;;;
2335 ;; eieio-method-tree : eieiomt-
2336 ;;
2337 ;; Stored as eieio-method-tree in property list of a generic method
2338 ;;
2339 ;; (eieio-method-tree . [BEFORE PRIMARY AFTER
2340 ;; genericBEFORE genericPRIMARY genericAFTER])
2341 ;; and
2342 ;; (eieio-method-obarray . [BEFORE PRIMARY AFTER
2343 ;; genericBEFORE genericPRIMARY genericAFTER])
2344 ;; where the association is a vector.
2345 ;; (aref 0 -- all static methods.
2346 ;; (aref 1 -- all methods classified as :before
2347 ;; (aref 2 -- all methods classified as :primary
2348 ;; (aref 3 -- all methods classified as :after
2349 ;; (aref 4 -- a generic classified as :before
2350 ;; (aref 5 -- a generic classified as :primary
2351 ;; (aref 6 -- a generic classified as :after
2352 ;;
2357 "Install the method tree, and obarray onto METHOD-NAME.
2358 Do not do the work if they already exist."
2371 ))))
2374 "Add to METHOD-NAME the forms METHOD in a call position KEY for CLASS.
2375 METHOD-NAME is the name created by a call to `defgeneric'.
2376 METHOD are the forms for a given implementation.
2377 KEY is an integer (see comment in eieio.el near this function) which
2378 is associated with the :static :before :primary and :after tags.
2379 It also indicates if CLASS is defined or not.
2380 CLASS is the class this method is associated with."
2385 ;; Make sure the method tables are available.
2388 ;; only add new cells on if it doesn't already exist!
2392 ;; Add function definition into newly created symbol, and store
2393 ;; said symbol in the correct obarray, otherwise use the
2394 ;; other array to keep this stuff
2398 ;; Now optimize the entire obarray
2401 ;; @todo - Is this overkill? Should we just clear the symbol?
2403 ))
2406 "Return the next parent class for CLASS.
2407 If CLASS is a superclass, return variable `eieio-default-superclass'.
2408 If CLASS is variable `eieio-default-superclass' then return nil.
2409 This is different from function `class-parent' as class parent returns
2410 nil for superclasses. This function performs no type checking!"
2411 ;; No type-checking because all calls are made from functions which
2412 ;; are safe and do checking for us.
2415 nil
2419 "Find the next class above S which has a function body for the optimizer."
2420 ;; Set the value to nil in case there is no nearest cell.
2422 ;; Find the nearest cell that has a function body. If we find one,
2423 ;; we replace the nil from above.
2428 eieiomt-optimizing-obarray)))
2434 "Return the lambda form belonging to METHOD using KEY based upon CLASS.
2435 If CLASS is not a class then use `generic' instead. If class has
2436 no form, but has a parent class, then trace to that parent class.
2437 The first time a form is requested from a symbol, an optimized path
2438 is memorized for faster future use."
2442 ;; 1) find our symbol
2445 ;; 2) If there isn't one, then make one.
2446 ;; This can be slow since it only occurs once
2449 ;; 2.1) Cache its nearest neighbor with a quick optimize
2450 ;; which should only occur once for this call ever
2453 ;; 3) If it's bound return this one.
2456 ;; 4) If it's not bound then this variable knows something
2459 ;; 4.1) This symbol holds the next class in its value
2462 ;; 4.2) The optimizer should always have chosen a
2463 ;; function-symbol
2464 ;;(if (fboundp cs)
2466 class-symbol))
2467 ;;(error "EIEIO optimizer: erratic data loss!"))
2468 )
2469 ;; There never will be a funcall...
2470 nil)))
2471 ;; for a generic call, what is a list, is the function body we want.
2475 ;; The car of EMTL is supposed to be a class, which in this
2476 ;; case is nil, so skip it.
2478 nil)))))
2480 ;;;
2481 ;; Way to assign slots based on a list. Used for constructors, or
2482 ;; even resetting an object at run-time
2483 ;;
2485 "Take object OBJ, and reset all slots to their defaults.
2486 If SET-ALL is non-nil, then when a default is nil, that value is
2487 reset. If SET-ALL is nil, the slots are only reset if the default is
2488 not nil."
2499 "For CLASS, convert INITARG to the actual attribute name.
2500 If there is no translation, pass it in directly (so we can cheat if
2501 need be... May remove that later...)"
2505 nil)))
2508 "In CLASS, convert the ATTRIBUTE into the corresponding init argument tag.
2509 This is usually a symbol that starts with `:'."
2513 nil)))
2515 \f
2516 ;;; Here are some special types of errors
2517 ;;
2543 ;;; Here are some CLOS items that need the CL package
2544 ;;
2549 ;; The below setf method was written by Arnd Kohrs <kohrs@acm.org>
2560 store-temp)
2563 \f
2564 ;;;
2565 ;; We want all objects created by EIEIO to have some default set of
2566 ;; behaviors so we can create object utilities, and allow various
2567 ;; types of error checking. To do this, create the default EIEIO
2568 ;; class, and when no parent class is specified, use this as the
2569 ;; default. (But don't store it in the other classes as the default,
2570 ;; allowing for transparent support.)
2571 ;;
2574 nil
2575 "Default parent class for classes with no specified parent class.
2576 Its slots are automatically adopted by classes with no specified parents.
2577 This class is not stored in the `parent' slot of a class vector."
2587 "Default constructor for CLASS `eieio-default-superclass'.
2588 NEWNAME is the name to be given to the constructed object.
2589 SLOTS are the initialization slots used by `shared-initialize'.
2590 This static method is called when an object is constructed.
2591 It allocates the vector used to represent an EIEIO object, and then
2592 calls `shared-initialize' on that object."
2594 class-default-object-cache))))
2595 ;; Update the name for the newly created object.
2597 ;; Call the initialize method on the new object with the slots
2598 ;; that were passed down to us.
2600 ;; Return the created object.
2601 new-object))
2604 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2608 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2609 Called from the constructor routine."
2624 "Construct the new object THIS based on SLOTS.
2625 SLOTS is a tagged list where odd numbered elements are tags, and
2626 even numbered elements are the values to store in the tagged slot.
2627 If you overload the `initialize-instance', there you will need to
2628 call `shared-initialize' yourself, or you can call `call-next-method'
2629 to have this constructor called automatically. If these steps are
2630 not taken, then new objects of your class will not have their values
2631 dynamically set from SLOTS."
2632 ;; First, see if any of our defaults are `lambda', and
2633 ;; re-evaluate them and apply the value to our slots.
2638 ;; For each slot, see if we need to evaluate it.
2639 ;;
2640 ;; Paul Landes said in an email:
2641 ;; > CL evaluates it if it can, and otherwise, leaves it as
2642 ;; > the quoted thing as you already have. This is by the
2643 ;; > Sonya E. Keene book and other things I've look at on the
2644 ;; > web.
2648 ;; Next.
2651 ;; Shared initialize will parse our slots for us.
2659 "Method invoked when an attempt to access a slot in OBJECT fails.
2660 SLOT-NAME is the name of the failed slot, OPERATION is the type of access
2661 that was requested, and optional NEW-VALUE is the value that was desired
2662 to be set.
2664 This method is called from `oref', `oset', and other functions which
2665 directly reference slots in EIEIO objects."
2667 slot-name)))
2673 class slot-name fn)
2674 "Slot unbound is invoked during an attempt to reference an unbound slot.
2675 OBJECT is the instance of the object being reference. CLASS is the
2676 class of OBJECT, and SLOT-NAME is the offending slot. This function
2677 throws the signal `unbound-slot'. You can overload this function and
2678 return the value to use in place of the unbound value.
2679 Argument FN is the function signaling this error.
2680 Use `slot-boundp' to determine if a slot is bound or not.
2682 In CLOS, the argument list is (CLASS OBJECT SLOT-NAME), but
2683 EIEIO can only dispatch on the first argument, so the first two are swapped."
2685 slot-name fn)))
2692 "Called if there are no implementations for OBJECT in METHOD.
2693 OBJECT is the object which has no method implementation.
2694 ARGS are the arguments that were passed to METHOD.
2696 Implement this for a class to block this signal. The return
2697 value becomes the return value of the original method call."
2699 )
2706 "Called from `call-next-method' when no additional methods are available.
2707 OBJECT is othe object being called on `call-next-method'.
2708 ARGS are the arguments it is called by.
2709 This method signals `no-next-method' by default. Override this
2710 method to not throw an error, and its return value becomes the
2711 return value of `call-next-method'."
2713 )
2716 "Make a copy of OBJ, and then supply PARAMS.
2717 PARAMS is a parameter list of the same form used by `initialize-instance'.
2719 When overloading `clone', be sure to call `call-next-method'
2723 "Make a copy of OBJ, and then apply PARAMS."
2736 nobj))
2742 "Destructor for cleaning up any dynamic links to our object.
2743 Argument THIS is the object being destroyed. PARAMS are additional
2744 ignored parameters."
2745 ;; No cleanup... yet.
2746 )
2749 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2751 It is sometimes useful to put a summary of the object into the
2752 default #<notation> string when using EIEIO browsing tools.
2756 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2757 The default method for printing object THIS is to use the
2758 function `object-name'.
2760 It is sometimes useful to put a summary of the object into the
2761 default #<notation> string when using EIEIO browsing tools.
2763 Implement this function and specify STRINGS in a call to
2764 `call-next-method' to provide additional summary information.
2765 When passing in extra strings from child classes, always remember
2766 to prepend a space."
2773 "Write out object THIS to the current stream.
2777 "Write object THIS out to the current stream.
2778 This writes out the vector version of this object. Complex and recursive
2779 object are discouraged from being written.
2780 If optional COMMENT is non-nil, include comments when outputting
2781 this object."
2790 ;; Now output readable lisp to recreate this object
2791 ;; It should look like this:
2792 ;; (<constructor> <name> <slot> <slot> ... )
2793 ;; Each slot's slot is writen using its :writer.
2800 ;; Loop over all the public slots
2809 )
2815 ;; Use our public printer
2817 ;; Use our generic override prin1 function.
2826 "Perform a `prin1' on THING taking advantage of object knowledge."
2838 "Display LIST where list may contain objects."
2855 \f
2856 ;;; Unimplemented functions from CLOS
2857 ;;
2859 "Change the class of OBJ to type CLASS.
2860 This may create or delete slots, but does not affect the return value
2861 of `eq'."
2864 )
2866 \f
2867 ;;; Obsolete backward compatibility functions.
2868 ;; Needed to run byte-code compiled with the EIEIO of Emacs-23.
2871 "Obsolete work part of an old version of the `defmethod' macro."
2873 ;; find optional keys
2878 method-before)
2882 method-after)
2886 method-primary)
2890 method-static)
2891 ;; Primary key
2893 ;; get body, and fix contents of args to be the arguments of the fn.
2897 ;; Create a fixed version of the arguments
2900 argfix))
2902 ;; make sure there is a generic
2904 method
2907 ;; create symbol for property to bind to. If the first arg is of
2908 ;; the form (varname vartype) and `vartype' is a class, then
2909 ;; that class will be the type symbol. If not, then it will fall
2910 ;; under the type `primary' which is a non-specific calling of the
2911 ;; function.
2921 ;; generics are higher
2923 ;; Put this lambda into the symbol so we can find it
2927 key argclass))
2928 )
2931 ;; Optimizing step:
2932 ;;
2933 ;; If this method, after this setup, only has primary methods, then
2934 ;; we can setup the generic that way.
2936 ;; If there is only one primary method, then we can go one more
2937 ;; optimization step.
2943 method)
2947 "Obsolete work part of an old version of the `defgeneric' macro."
2951 )
2953 method))
2954 ;; Don't do this over and over.
2956 ;; This defun tells emacs where the first definition of this
2957 ;; method is defined.
2959 ;; Make sure the method tables are installed.
2961 ;; Apply the actual body of this function.
2963 ;; Return the method
2967 ;;; Interfacing with edebug
2968 ;;
2970 "Display EIEIO OBJECT in fancy format.
2971 Overrides the edebug default.
2972 Optional argument NOESCAPE is passed to `prin1-to-string' when appropriate."
2985 ;; ^^ This is the methods symbol
2987 list ; arguments
2989 def-body ; part to be debugged
2990 ))
2991 ;; The rest of the macros
3002 ;; I suspect this isn't the best way to do this, but when
3003 ;; cust-print was used on my system all my objects
3004 ;; appeared as "#1 =" which was not useful. This allows
3005 ;; edebug to print my objects in the nice way they were
3006 ;; meant to with `object-print' and `class-name'
3007 ;; (defalias 'edebug-prin1-to-string 'eieio-edebug-prin1-to-string)
3008 )
3009 )
3011 ;;; Interfacing with imenu in emacs lisp mode
3012 ;; (Only if the expression is defined)
3013 ;;
3018 "Examine `lisp-imenu-generic-expression' and modify it to find `defmethod'."
3021 ;; it's of the form '( ( title expr indx ) ... )
3032 ))
3034 ;;; Autoloading some external symbols, and hooking into the help system
3035 ;;
3037 \f
3038 ;;; Start of automatically extracted autoloads.
3039 \f
3040 ;;;### (autoloads (customize-object) "eieio-custom" "eieio-custom.el"
3041 ;;;;;; "cf1bd64c76a6e6406545e8c5a5530d43")
3042 ;;; Generated autoloads from eieio-custom.el
3045 Customize OBJ in a custom buffer.
3046 Optional argument GROUP is the sub-group of slots to display.
3050 ;;;***
3051 \f
3052 ;;;### (autoloads (eieio-help-mode-augmentation-maybee eieio-describe-generic
3053 ;;;;;; eieio-describe-constructor eieio-describe-class eieio-browse)
3054 ;;;;;; "eieio-opt" "eieio-opt.el" "1bed0a56310f402683419139ebc18d7f")
3055 ;;; Generated autoloads from eieio-opt.el
3058 Create an object browser window to show all objects.
3059 If optional ROOT-CLASS, then start with that, otherwise start with
3060 variable `eieio-default-superclass'.
3067 Describe a CLASS defined by a string or symbol.
3068 If CLASS is actually an object, then also display current values of that object.
3069 Optional HEADERFCN should be called to insert a few bits of info first.
3074 Describe the constructor function FCN.
3075 Uses `eieio-describe-class' to describe the class being constructed.
3082 Describe the generic function GENERIC.
3083 Also extracts information about all methods specific to this generic.
3088 For buffers thrown into help mode, augment for EIEIO.
3089 Arguments UNUSED are not used.
3093 ;;;***
3094 \f
3095 ;;; End of automatically extracted autoloads.
3099 ;;; eieio ends here