| blob | 97022f0acbe31d506f17a2e3f0f9675c22ed3e18 |
1 ;;; eieio.el --- Enhanced Implementation of Emacs Interpreted Objects
2 ;;; or maybe Eric's Implementation of Emacs Intrepreted Objects
4 ;; Copyright (C) 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
5 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
7 ;; Author: Eric M. Ludlam <zappo@gnu.org>
8 ;; Version: 1.3
9 ;; Keywords: OO, lisp
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
27 ;;
28 ;; EIEIO is a series of Lisp routines which implements a subset of
29 ;; CLOS, the Common Lisp Object System. In addition, EIEIO also adds
30 ;; a few new features which help it integrate more strongly with the
31 ;; Emacs running environment.
32 ;;
33 ;; See eieio.texi for complete documentation on using this package.
34 ;;
35 ;; Note: the implementation of the c3 algorithm is based on:
36 ;; Kim Barrett et al.: A Monotonic Superclass Linearization for Dylan
37 ;; Retrieved from:
38 ;; http://192.220.96.201/dylan/linearization-oopsla96.html
40 ;; There is funny stuff going on with typep and deftype. This
41 ;; is the only way I seem to be able to make this stuff load properly.
43 ;; @TODO - fix :initform to be a form, not a quoted value
44 ;; @TODO - Prefix non-clos functions with `eieio-'.
46 ;;; Code:
56 "Display the current version of EIEIO."
61 ;; About the above. EIEIO must process its own code when it compiles
62 ;; itself, thus, by eval-and-compiling outselves, we solve the problem.
64 ;; Compatibility
67 ;; XEmacs can only access a compiled functions arglist like this:
70 ;; Emacs doesn't have this function, but since FUNC is a vector, we can just
71 ;; grab the appropriate element.
73 "Return the argument list for the compiled function FUNC."
76 )
78 \f
79 ;;;
80 ;; Variable declarations.
81 ;;
87 "Non-nil to throw an error if an encountered tag is unsupported.
88 This may prevent classes from CLOS applications from being used with EIEIO
92 "*If non-nil, skip all slot typechecking.
93 Set this to t permanently if a program is functioning well to get a
94 small speed increase. This variable is also used internally to handle
100 ;; State Variables
102 "Inside a method, this variable is the object in question.
103 DO NOT SET THIS YOURSELF unless you are trying to simulate friendly slots.
105 Note: Embedded methods are no longer supported. The variable THIS is
106 still set for CLOS methods for the sake of routines like
110 "This is set to a class when a method is running.
111 This is so we know we are allowed to check private parts or how to
119 eieio-unbound
123 ;; This is a bootstrap for eieio-default-superclass so it has a value
124 ;; while it is being built itself.
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 ;; How to specialty compile stuff.
189 \f
190 ;;; Important macros used in eieio.
191 ;;
193 "Internal: Return the class vector from the CLASS symbol."
194 ;; No check: If eieio gets this far, it's probably been checked already.
198 "Return t if CLASS is a valid class vector.
199 CLASS is a symbol."
200 ;; this new method is faster since it doesn't waste time checking lots of
201 ;; things.
207 "Return non-nil if OBJ is an EIEIO object."
216 "Return the symbol representing the constructor of CLASS."
220 "Return t if symbol METHOD is a generic function.
221 Only methods have the symbol `eieio-method-obarray' as a property
222 \(which contains a list of all bindings to that method type.)"
226 "Return t if symbol METHOD is a generic function with only primary methods.
227 Only methods have the symbol `eieio-method-obarray' as a property (which
228 contains a list of all bindings to that method type.)
229 Methods with only primary implementations are executed in an optimized way."
239 ))
242 "Return t if symbol METHOD is a generic function with only primary methods.
243 Only methods have the symbol `eieio-method-obarray' as a property (which
244 contains a list of all bindings to that method type.)
245 Methods with only primary implementations are executed in an optimized way."
255 ))
258 "Return from LIST the found OPTION, or nil if it doesn't exist."
262 "Return the value stored for CLASS' OPTION.
263 Return nil if that option doesn't exist."
267 "Return non-nil if CLASS is abstract.
268 Abstract classes cannot be instantiated."
272 "Return the invocation order of CLASS.
273 Abstract classes cannot be instantiated."
277 \f
278 ;;; Defining a new class
279 ;;
281 "Define NAME as a new class derived from SUPERCLASS with SLOTS.
282 OPTIONS-AND-DOC is used as the class' options and base documentation.
283 SUPERCLASS is a list of superclasses to inherit from, with SLOTS
284 being the slots residing in that class definition. NOTE: Currently
285 only one slot may exist in SUPERCLASS as multiple inheritance is not
286 yet supported. Supported tags are:
288 :initform - Initializing form.
289 :initarg - Tag used during initialization.
290 :accessor - Tag used to create a function to access this slot.
291 :allocation - Specify where the value is stored.
292 Defaults to `:instance', but could also be `:class'.
293 :writer - A function symbol which will `write' an object's slot.
294 :reader - A function symbol which will `read' an object.
295 :type - The type of data allowed in this slot (see `typep').
296 :documentation
297 - A string documenting use of this slot.
299 The following are extensions on CLOS:
300 :protection - Specify protection for this slot.
301 Defaults to `:public'. Also use `:protected', or `:private'.
302 :custom - When customizing an object, the custom :type. Public only.
303 :label - A text string label used for a slot when customizing.
304 :group - Name of a customization group this slot belongs in.
305 :printer - A function to call to print the value of a slot.
306 See `eieio-override-prin1' as an example.
308 A class can also have optional options. These options happen in place
309 of documentation (including a :documentation tag), in addition to
310 documentation, or not at all. Supported options are:
312 :documentation - The doc-string used for this class.
314 Options added to EIEIO:
316 :allow-nil-initform - Non-nil to skip typechecking of null initforms.
317 :custom-groups - List of custom group names. Organizes slots into
318 reasonable groups for customizations.
319 :abstract - Non-nil to prevent instances of this class.
320 If a string, use as an error string if someone does
321 try to make an instance.
322 :method-invocation-order
323 - Control the method invocation order if there is
324 multiple inheritance. Valid values are:
325 :breadth-first - The default.
326 :depth-first
328 Options in CLOS not supported in EIEIO:
330 :metaclass - Class to use in place of `standard-class'
331 :default-initargs - Initargs to use when initializing new objects of
332 this class.
334 Due to the way class options are set up, you can add any tags you wish,
335 and reference them using the function `class-option'."
336 ;; We must `eval-and-compile' this so that when we byte compile
337 ;; an eieio program, there is no need to load it ahead of time.
338 ;; It also provides lots of nice debugging errors at compile time.
345 ;; We autoload this because it's used in `make-autoload'.
346 ;;;###autoload
348 "Create autoload symbols for the EIEIO class CNAME.
349 SUPERCLASSES are the superclasses that CNAME inherits from.
350 DOC is the docstring for CNAME.
351 This function creates a mock-class for CNAME and adds it into
352 SUPERCLASSES as children.
353 It creates an autoload function for CNAME's constructor."
354 ;; Assume we've already debugged inputs.
358 )
360 nil ;; Do nothing if we already have this class.
362 ;; Create the class in NEWC, but don't fill anything else in.
367 ;; No parents?
370 clear-parent t)
371 )
373 ;; Hook our new class into the existing structures so we can
374 ;; autoload it later.
378 ;; TODO - If we create an autoload that is in the map, that
379 ;; map needs to be cleared!
382 ;; Does our parent exist?
385 ;; Create a symbol for this parent, and then store this
386 ;; parent on that symbol.
391 )
393 ;; We have a parent, save the child in there.
398 ;; save parent in child
400 )
402 ;; turn this into a useable self-pointing symbol
405 ;; Store the new class vector definition into the symbol. We need to
406 ;; do this first so that we can call defmethod for the accessor.
407 ;; The vector will be updated by the following while loop and will not
408 ;; need to be stored a second time.
411 ;; Clear the parent
414 ;; Create an autoload on top of our constructor function.
419 ))))
422 "If class CNAME is in an autoload state, load its file."
427 "Define CNAME as a new subclass of SUPERCLASSES.
428 SLOTS are the slots residing in that class definition, and options or
429 documentation OPTIONS-AND-DOC is the toplevel documentation for this class.
430 See `defclass' for more information."
431 ;; Run our eieio-hook each time, and clear it when we are done.
432 ;; This way people can add hooks safely if they want to modify eieio
433 ;; or add definitions when eieio is loaded or something like that.
450 ;; If this class already existed, and we are updating its structure,
451 ;; make sure we keep the old child list. This can cause bugs, but
452 ;; if no new slots are created, it also saves time, and prevents
453 ;; method table breakage, particularly when the users is only
454 ;; byte compiling an EIEIO file.
457 ;; If the old class did not exist, but did exist in the autoload map, then adopt those children.
458 ;; This is like the above, but deals with autoloads nicely.
465 ))
466 )
474 )
479 options-and-doc))
486 ;; bad class
488 ;; good parent class...
489 ;; save new child in parent
493 ;; Get custom groups, and store them into our local copy.
496 ;; save parent in child
500 ;; Reverse the list of our parents so that they are prioritized in
501 ;; the same order as specified in the code.
503 ;; If there is nothing to loop over, then inherit from the
504 ;; default superclass.
506 ;; adopt the default parent here, but clear it later...
508 ;; save new child in parent
512 ;; save parent in child
515 ;; turn this into a useable self-pointing symbol
518 ;; These two tests must be created right away so we can have self-
519 ;; referencing classes. ei, a class whose slot can contain only
520 ;; pointers to itself.
522 ;; Create the test function
530 ;; Make sure the method invocation order is a valid value.
534 ))
536 ;; Create a handy child test too
541 "Test OBJ to see if it an object is a child of type %s"
542 cname)
546 ;; When using typep, (typep OBJ 'myclass) returns t for objects which
547 ;; are subclasses of myclass. For our predicates, however, it is
548 ;; important for EIEIO to be backwards compatible, where
549 ;; myobject-p, and myobject-child-p are different.
550 ;; "cl" uses this technique to specify symbols with specific typep
551 ;; test, so we can let typep have the CLOS documented behavior
552 ;; while keeping our above predicate clean.
554 ;; It would be cleaner to use `defsetf' here, but that requires cl
555 ;; at runtime.
559 ;; before adding new slots, lets add all the methods and classes
560 ;; in from the parent class
563 ;; Store the new class vector definition into the symbol. We need to
564 ;; do this first so that we can call defmethod for the accessor.
565 ;; The vector will be updated by the following while loop and will not
566 ;; need to be stored a second time.
569 ;; Query each slot in the declaration list and mangle into the
570 ;; class structure I have defined.
578 eieio-unbound)))
592 )
598 :initform
599 :initarg
600 :documentation
601 :protection
602 :reader
603 :writer
604 :allocation
605 :type
606 :custom
607 :label
608 :group
609 :printer
610 :allow-nil-initform
615 ;; Clean up the meaning of protection.
622 ;; Make sure the :allocation parameter has a valid value.
626 ;; The default type specifier is supposed to be t, meaning anything.
629 ;; Label is nil, or a string
633 ;; Is there an initarg, but allocation of class?
637 ;; intern the symbol so we can use it blankly
640 ;; The customgroup should be a list of symbols
645 ;; The customgroup better be a symbol, or list of symbols.
649 customg)
651 ;; First up, add this slot into our new class.
655 ;; We need to id the group, and store them in a group list attribute.
658 ;; anyone can have an accessor function. This creates a function
659 ;; of the specified name, and also performs a `defsetf' if applicable
660 ;; so that users can `setf' the space returned by this function
667 "Retrieves the slot `%s' from an object of class `%s'"
668 name cname)
671 ;; Else - Some error? nil?
672 nil)))
674 ;; Provide a setf method. It would be cleaner to use
675 ;; defsetf, but that would require CL at runtime.
687 ;; If a writer is defined, then create a generic method of that
688 ;; name whose purpose is to set the value of the slot.
694 name cname)
696 ))
697 ;; If a reader is defined, then create a generic method
698 ;; of that name whose purpose is to access this slot value.
704 name cname)
706 )
709 ;; Now that everything has been loaded up, all our lists are backwards! Fix that up now.
722 ;; The storage for class-class-allocation-type needs to be turned into
723 ;; a vector now.
727 ;; Also, take class allocated values, and vectorize them for speed.
731 ;; Attach slot symbols into an obarray, and store the index of
732 ;; this slot as the variable slot in this new symbol. We need to
733 ;; know about primes, because obarrays are best set in vectors of
734 ;; prime number length, and we also need to make our vector small
735 ;; to save space, and also optimal for the number of items we have.
755 )
757 ;; Create the constructor function
759 ;; Abstract classes cannot be instantiated. Say so.
768 ;; Non-abstract classes need a constructor.
773 )
775 ;; Set up a specialized doc string.
776 ;; Use stored value since it is calculated in a non-trivial way
780 ;; We have a list of custom groups. Store them into the options.
787 ;; Set up the options we have collected.
790 ;; if this is a superclass, clear out parent (which was set to the
791 ;; default superclass eieio-default-superclass)
794 ;; Create the cached default object.
801 ;; All type-checking has been done to our satisfaction
802 ;; before this call. Don't waste our time in this call..
806 ;; Return our new class object
807 ;; newc
808 cname
809 ))
812 "For SLOT, signal if SPEC does not match VALUE.
813 If SKIPNIL is non-nil, then if VALUE is nil return t instead."
822 "Add into NEWC attribute A.
823 If A already exists in NEWC, then do nothing. If it doesn't exist,
824 then also add in D (default), DOC, TYPE, CUST, LABEL, CUSTG, PRINT, PROT, and INIT arg.
825 Argument ALLOC specifies if the slot is allocated per instance, or per class.
826 If optional DEFAULTOVERRIDE is non-nil, then if A exists in NEWC,
827 we must override its value for a default.
828 Optional argument SKIPNIL indicates if type checking should be skipped
829 if default value is nil."
830 ;; Make sure we duplicate those items that are sequences.
833 ;; This copy can fail on a cons cell with a non-cons in the cdr. Lets skip it if it doesn't work.
839 ;; To prevent override information w/out specification of storage,
840 ;; we need to do this little hack.
844 ;; In this case, we modify the INSTANCE version of a given slot.
848 ;; Only add this element if it is so-far unique
862 )
863 ;; When defaultoverride is true, we are usually adding new local
864 ;; attributes which must override the default value of any slot
865 ;; passed in by one of the parent classes.
867 ;; There is a match, and we must override the old value.
872 nil))
874 )
877 a)
878 ;; If type is passed in, is it the same?
882 "Child slot type `%s' does not match inherited type `%s' for `%s'"
883 type tp a)))
884 ;; If we have a repeat, only update the initarg...
888 ;; If we have a new initarg, check for it.
892 ;; Replace the CAR of the associate INITA.
893 ;;(message "Initarg: %S replace %s" inita init)
895 ))
897 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
898 ;; checked and SHOULD match the superclass
899 ;; protection. Otherwise an error is thrown. However
900 ;; I wonder if a more flexible schedule might be
901 ;; implemented.
902 ;;
903 ;; EML - We used to have (if prot... here,
904 ;; but a prot of 'nil means public.
905 ;;
907 )
910 prot super-prot a)))
911 ;; End original PLN
913 ;; PLN Tue Jun 26 11:57:06 2007 :
914 ;; Do a non redundant combination of ancient custom
915 ;; groups and new ones.
927 ;; End PLN
929 ;; PLN Mon Jun 25 22:44:34 2007 : If a new cust is
930 ;; set, simply replaces the old one.
932 ;; (message "Custom type redefined to %s" cust)
935 ;; If a new label is specified, it simply replaces
936 ;; the old one.
938 ;; (message "Custom label redefined to %s" label)
940 ;; End PLN
942 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
943 ;; doc is specified, simply replaces the old one.
945 ;;(message "Documentation redefined to %s" doc)
947 doc))
948 ;; End PLN
950 ;; If a new printer is specified, it simply replaces
951 ;; the old one.
953 ;; (message "printer redefined to %s" print)
956 )))
957 ))
959 ;; CLASS ALLOCATED SLOTS
964 ;; Here we have found a :class version of a slot. This
965 ;; requires a very different aproach.
970 (aset newc class-class-allocation-custom-label (cons label (aref newc class-class-allocation-custom-label)))
971 (aset newc class-class-allocation-custom-group (cons custg (aref newc class-class-allocation-custom-group)))
972 (aset newc class-class-allocation-protection (cons prot (aref newc class-class-allocation-protection)))
973 ;; Default value is stored in the 'values section, since new objects
974 ;; can't initialize from this element.
975 (aset newc class-class-allocation-values (cons value (aref newc class-class-allocation-values))))
977 ;; There is a match, and we must override the old value.
984 nil))
986 nil)))
989 a)
990 ;; If type is passed in, is it the same?
994 "Child slot type `%s' does not match inherited type `%s' for `%s'"
995 type tp a)))
996 ;; EML - Note: the only reason to override a class bound slot
997 ;; is to change the default, so allow unbound in.
999 ;; If we have a repeat, only update the vlaue...
1003 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
1004 ;; checked and SHOULD match the superclass
1005 ;; protection. Otherwise an error is thrown. However
1006 ;; I wonder if a more flexible schedule might be
1007 ;; implemented.
1012 prot super-prot a)))
1013 ;; Do a non redundant combination of ancient custom groups
1014 ;; and new ones.
1027 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
1028 ;; doc is specified, simply replaces the old one.
1030 ;;(message "Documentation redefined to %s" doc)
1032 doc))
1033 ;; End PLN
1035 ;; If a new printer is specified, it simply replaces
1036 ;; the old one.
1038 ;; (message "printer redefined to %s" print)
1041 ))
1042 ))
1043 ))
1046 "Copy into NEWC the slots of PARENTS.
1047 Follow the rules of not overwriting early parents when applying to
1048 the new child class."
1053 ;; First, duplicate all the slots of the parent.
1072 ;; Increment each value.
1084 ;; Now duplicate all the class alloc slots.
1101 ;; Increment each value.
1111 ;; Loop over each parent class
1113 ))
1115 ;;; CLOS style implementation of object creators.
1116 ;;
1118 "Make a new instance of CLASS based on INITARGS.
1119 CLASS is a class symbol. For example:
1121 (make-instance 'foo)
1123 INITARGS is a property list with keywords based on the :initarg
1124 for each slot. For example:
1126 (make-instance 'foo :slot1 value1 :slotN valueN)
1128 Compatibility note:
1130 If the first element of INITARGS is a string, it is used as the
1131 name of the class.
1133 In EIEIO, the class' constructor requires a name for use when printing.
1134 `make-instance' in CLOS doesn't use names the way Emacs does, so the
1135 class is used as the name slot instead when INITARGS doesn't start with
1136 a string."
1142 initargs)))
1144 \f
1145 ;;; CLOS methods and generics
1146 ;;
1148 "Create a generic function METHOD.
1149 DOC-STRING is the base documentation for this class. A generic
1150 function has no body, as its purpose is to decide which method body
1151 is appropriate to use. Uses `defmethod' to create methods, and calls
1152 `defgeneric' for you. With this implementation the ARGS are
1153 currently ignored. You can use `defgeneric' to apply specialized
1154 top level documentation to a method."
1158 "The lambda form that would be used as the function defined on METHOD.
1159 All methods should call the same EIEIO function for dispatch.
1160 DOC-STRING is the documentation attached to METHOD."
1162 ,doc-string
1166 "Setup METHOD to call the generic form."
1171 "The lambda form that would be used as the function defined on METHOD.
1172 All methods should call the same EIEIO function for dispatch.
1173 DOC-STRING is the documentation attached to METHOD."
1175 ,doc-string
1179 "Setup METHOD to call the generic form."
1184 class
1185 impl
1186 )
1187 "The lambda form that would be used as the function defined on METHOD.
1188 All methods should call the same EIEIO function for dispatch.
1189 DOC-STRING is the documentation attached to METHOD.
1190 CLASS is the class symbol needed for private method access.
1191 IMPL is the symbol holding the method implementation."
1192 ;; NOTE: I tried out byte compiling this little fcn. Turns out it
1193 ;; is faster to execute this for not byte-compiled. ie, install this,
1194 ;; then measure calls going through here. I wonder why.
1198 )
1201 ,doc-string
1202 ;; This is a cool cheat. Usually we need to look up in the
1203 ;; method table to find out if there is a method or not. We can
1204 ;; instead make that determination at load time when there is
1205 ;; only one method. If the first arg is not a child of the class
1206 ;; of that one implementation, then clearly, there is no method def.
1208 ;; Not an object. Just signal.
1211 ;; We do have an object. Make sure it is the right type.
1213 nil ; default superclass means just an obj. Already asked.
1216 )
1218 ;; If not the right kind of object, call no applicable
1222 ;; It is ok, do the call.
1223 ;; Fill in inter-call variables then evaluate the method.
1229 )
1231 ;(,impl local-args)
1232 ))))
1233 )
1234 ))
1237 "Setup METHOD to call the generic form."
1241 )
1243 method doc-string
1246 ))))
1249 "Engine part to `defgeneric' macro defining METHOD with DOC-STRING."
1253 )
1255 method))
1256 ;; Don't do this over and over.
1258 ;; This defun tells emacs where the first definition of this
1259 ;; method is defined.
1261 ;; Make sure the method tables are installed.
1263 ;; Apply the actual body of this function.
1265 ;; Return the method
1269 "Make the generic method METHOD have no implementations.
1270 It will leave the original generic function in place,
1271 but remove reference to all implementations of METHOD."
1276 "Create a new METHOD through `defgeneric' with ARGS.
1278 The optional second argument KEY is a specifier that
1279 modifies how the method is called, including:
1280 :before - Method will be called before the :primary
1281 :primary - The default if not specified
1282 :after - Method will be called after the :primary
1283 :static - First arg could be an object or class
1284 The next argument is the ARGLIST. The ARGLIST specifies the arguments
1285 to the method as with `defun'. The first argument can have a type
1286 specifier, such as:
1287 ((VARNAME CLASS) ARG2 ...)
1288 where VARNAME is the name of the local variable for the method being
1289 created. The CLASS is a class symbol for a class made with `defclass'.
1290 A DOCSTRING comes after the ARGLIST, and is optional.
1291 All the rest of the args are the BODY of the method. A method will
1292 return the value of the last form in the BODY.
1294 Summary:
1296 (defmethod mymethod [:before | :primary | :after | :static]
1297 ((typearg class-name) arg2 &optional opt &rest rest)
1299 body)"
1303 "Work part of the `defmethod' macro defining METHOD with ARGS."
1305 ;; find optional keys
1310 method-before)
1314 method-after)
1318 method-primary)
1322 method-static)
1323 ;; Primary key
1325 ;; get body, and fix contents of args to be the arguments of the fn.
1329 ;; Create a fixed version of the arguments
1332 argfix))
1334 ;; make sure there is a generic
1336 method
1339 ;; create symbol for property to bind to. If the first arg is of
1340 ;; the form (varname vartype) and `vartype' is a class, then
1341 ;; that class will be the type symbol. If not, then it will fall
1342 ;; under the type `primary' which is a non-specific calling of the
1343 ;; function.
1353 ;; generics are higher
1355 ;; Put this lambda into the symbol so we can find it
1359 key argclass))
1360 )
1363 ;; Optimizing step:
1364 ;;
1365 ;; If this method, after this setup, only has primary methods, then
1366 ;; we can setup the generic that way.
1368 ;; If there is only one primary method, then we can go one more
1369 ;; optimization step.
1375 method)
1377 ;;; Slot type validation
1379 ;; This is a hideous hack for replacing `typep' from cl-macs, to avoid
1380 ;; requiring the CL library at run-time. It can be eliminated if/when
1381 ;; `typep' is merged into Emacs core.
1425 "Return non-nil if SPEC does not match VALUE."
1431 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1432 Checks the :type specifier.
1433 SLOT is the slot that is being checked, and is only used when throwing
1434 an error."
1436 nil
1437 ;; Trim off object IDX junk added in for the object index.
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
1451 slot-idx)))
1456 "Throw a signal if VALUE is a representation of an UNBOUND slot.
1457 INSTANCE is the object being referenced. SLOTNAME is the offending
1458 slot. If the slot is ok, return VALUE.
1459 Argument FN is the function calling this verifier."
1462 value))
1464 ;;; Get/Set slots in an object.
1465 ;;
1467 "Retrieve the value stored in OBJ in the slot named by SLOT.
1468 Slot is the name of the slot when created by `defclass' or the label
1469 created by the :initarg tag."
1473 "Return the value in OBJ at SLOT in the object vector."
1482 ;; It might be missing because it is a :class allocated slot.
1483 ;; Lets check that info out.
1485 ;; Oref that slot.
1487 ;; The slot-missing method is a cool way of allowing an object author
1488 ;; to intercept missing slot definitions. Since it is also the LAST
1489 ;; thing called in this fn, its return value would be retrieved.
1491 ;;(signal 'invalid-slot-name (list (object-name obj) slot))
1492 )
1501 "Get the default value of OBJ (maybe a class) for SLOT.
1502 The default value is the value installed in a class with the :initform
1503 tag. SLOT can be the slot name, or the tag specified by the :initarg
1504 tag in the `defclass' call."
1508 "Do the work for the macro `oref-default' with similar parameters.
1509 Fills in OBJ's SLOT with its default value."
1510 (if (not (or (eieio-object-p obj) (class-p obj))) (signal 'wrong-type-argument (list 'eieio-object-p obj)))
1515 ;; It might be missing because it is a :class allocated slot.
1516 ;; Lets check that info out.
1519 ;; Oref that slot.
1521 c)
1523 ;;(signal 'invalid-slot-name (list (class-name cl) slot))
1524 )
1531 "Whether the default value VAL should be evaluated for use."
1535 "Check VAL, and return what `oref-default' would provide."
1537 ;; Is it a function call? If so, evaluate it.
1540 ;;;; check for quoted things, and unquote them
1541 ;;((and (consp val) (eq (car val) 'quote))
1542 ;; (car (cdr val)))
1543 ;; return it verbatim
1546 ;;; Object Set macros
1547 ;;
1549 "Set the value in OBJ for slot SLOT to VALUE.
1550 SLOT is the slot name as specified in `defclass' or the tag created
1551 with in the :initarg slot. VALUE can be any Lisp object."
1555 "Do the work for the macro `oset'.
1556 Fills in OBJ's SLOT with VALUE."
1561 ;; It might be missing because it is a :class allocated slot.
1562 ;; Lets check that info out.
1565 ;; Oset that slot.
1569 class-class-allocation-values)
1570 c value))
1571 ;; See oref for comment on `slot-missing'
1573 ;;(signal 'invalid-slot-name (list (object-name obj) slot))
1574 )
1579 "Set the default slot in CLASS for SLOT to VALUE.
1580 The default value is usually set with the :initform tag during class
1581 creation. This allows users to change the default behavior of classes
1582 after they are created."
1586 "Do the work for the macro `oset-default'.
1587 Fills in the default value in CLASS' in SLOT with VALUE."
1593 ;; It might be missing because it is a :class allocated slot.
1594 ;; Lets check that info out.
1597 ;; Oref that slot.
1600 value))
1603 ;; Set this into the storage for defaults.
1605 value)
1606 ;; Take the value, and put it into our cache object.
1608 slot value)
1609 )))
1611 ;;; Handy CLOS macros
1612 ;;
1614 "Bind SPEC-LIST lexically to slot values in OBJECT, and execute BODY.
1615 This establishes a lexical environment for referring to the slots in
1616 the instance named by the given slot-names as though they were
1617 variables. Within such a context the value of the slot can be
1618 specified by using its slot name, as if it were a lexically bound
1619 variable. Both setf and setq can be used to set the value of the
1620 slot.
1622 SPEC-LIST is of a form similar to `let'. For example:
1624 ((VAR1 SLOT1)
1625 SLOT2
1626 SLOTN
1627 (VARN+1 SLOTN+1))
1629 Where each VAR is the local variable given to the associated
1630 SLOT. A slot specified without a variable name is given a
1631 variable name of the same name as the slot."
1632 ;; Transform the spec-list into a symbol-macrolet spec-list.
1637 spec-list)))
1639 body)))
1642 \f
1643 ;;; Simple generators, and query functions. None of these would do
1644 ;; well embedded into an object.
1645 ;;
1651 ;; I think this is supposed to return a symbol, but to me CLASS is a symbol,
1652 ;; and I wanted a string. Arg!
1656 "Return a Lisp like symbol string for object OBJ.
1657 If EXTRA, include that in the string returned to represent the symbol."
1684 "Return parent classes to CLASS. (overload of variable).
1686 The CLOS function `class-direct-superclasses' is aliased to this function."
1694 "Return child classes to CLASS.
1696 The CLOS function `class-direct-subclasses' is aliased to this function."
1701 "Returns CLASS if it can go in the result now, otherwise nil"
1702 ;; Ensure CLASS is not in any position but the first in any of the
1703 ;; element lists of REMAINING-INPUTS.
1708 found))
1709 class))
1712 "Merge REVERSED-PARTIAL-RESULT REMAINING-INPUTS in a consistent order, if possible.
1713 If a consistent order does not exist, signal an error."
1719 ;; If all remaining inputs are empty lists, we are done.
1721 ;; Otherwise, we try to find the next element of the result. This
1722 ;; is achieved by considering the first element of each
1723 ;; (non-empty) input list and accepting a candidate if it is
1724 ;; consistent with the rests of the input lists.
1731 remaining-inputs))
1733 found)))
1735 ;; The graph is consistent so far, add NEXT to result and
1736 ;; merge input lists, dropping NEXT from their heads where
1737 ;; applicable.
1741 remaining-inputs))
1742 ;; The graph is inconsistent, give up
1746 "Return all parents of CLASS in depth-first order."
1756 parents)
1759 ;; Remove duplicates.
1763 classes))
1766 "Return all parents of CLASS in breadth-first order."
1778 )
1781 "Return all parents of CLASS in c3 order."
1790 parents)
1793 )
1796 "Return (transitively closed) list of parents of CLASS.
1797 The order, in which the parents are returned depends on the
1798 method invocation orders of the involved classes."
1800 nil
1802 (:depth-first
1804 (:breadth-first
1806 (:c3
1808 )
1810 ;; Official CLOS functions.
1820 (defmacro same-class-fast-p (obj class) "Return t if OBJ is of class-type CLASS with no error checking."
1829 "Return non-nil if OBJ is an instance of CLASS or CLASS' subclasses."
1831 ;; class will be checked one layer down
1833 ;; Backwards compatibility
1837 "Return non-nil if CHILD class is a subclass of CLASS."
1848 "Return list of slots available in OBJ."
1860 f))
1862 ;;; CLOS queries into classes and slots
1863 ;;
1865 "Return non-nil if OBJECT's SLOT is bound.
1866 Setting a slot's value makes it bound. Calling `slot-makeunbound' will
1867 make a slot unbound.
1868 OBJECT can be an instance or a class."
1869 ;; Skip typechecking while retrieving this value.
1871 ;; Return nil if the magic symbol is in there.
1879 "In OBJECT, make SLOT unbound."
1883 "Return non-nil if OBJECT-OR-CLASS has SLOT."
1887 object-or-class))
1888 )))
1891 ))
1894 "Return the class that SYMBOL represents.
1895 If there is no class, nil is returned if ERRORP is nil.
1896 If ERRORP is non-nil, `wrong-argument-type' is signaled."
1899 nil)
1902 ;;; Slightly more complex utility functions for objects
1903 ;;
1905 "Return an object if KEY is `equal' to SLOT's value of an object in LIST.
1906 LIST is a list of objects whose slots are searched.
1907 Objects in LIST do not need to have a slot named SLOT, nor does
1908 SLOT need to be bound. If these errors occur, those objects will
1909 be ignored."
1912 ;; This prevents errors for missing slots.
1919 "Return an association list with the contents of SLOT as the key element.
1920 LIST must be a list of objects with SLOT in it.
1921 This is useful when you need to do completing read on an object group."
1927 assoclist))
1932 "Return an association list with the contents of SLOT as the key element.
1933 LIST must be a list of objects, but those objects do not need to have
1934 SLOT in it. If it does not, then that element is left out of the association
1935 list."
1942 assoclist)))
1947 "In OBJECT's SLOT, add ITEM to the list of elements.
1948 Optional argument APPEND indicates we need to append to the list.
1949 If ITEM already exists in the list in SLOT, then it is not added.
1950 Comparison is done with `equal' through the `member' function call.
1951 If SLOT is unbound, bind it to the list containing ITEM."
1953 ;; Find the originating list.
1957 ;; turn it into a list.
1960 ;; Do the combination
1966 ;; Set back into the slot.
1970 "In OBJECT's SLOT, remove occurrences of ITEM.
1971 Deletion is done with `delete', which deletes by side effect,
1972 and comparisons are done with `equal'.
1973 If SLOT is unbound, do nothing."
1975 nil
1977 \f
1978 ;;; EIEIO internal search functions
1979 ;;
1981 "Return non-nil if START-CLASS is the first class to define SLOT.
1982 This is for testing if `scoped-class' is the class that defines SLOT
1983 so that we can protect private slots."
1987 t
1991 class-symbol-obarray))
1994 ret)))
1997 "In CLASS for OBJ find the index of the named SLOT.
1998 The slot is a symbol which is installed in CLASS by the `defclass'
1999 call. OBJ can be nil, but if it is an object, and the slot in question
2000 is protected, access will be allowed if OBJ is a child of the currently
2001 `scoped-class'.
2002 If SLOT is the value created with :initarg instead,
2003 reverse-lookup that name, and recurse with the associated slot value."
2004 ;; Removed checks to outside this call
2007 class-symbol-obarray)))
2014 scoped-class
2022 eieio-initializing-object))
2029 "In CLASS find the index of the named SLOT.
2030 The slot is a symbol which is installed in CLASS by the `defclass'
2031 call. If SLOT is the value created with :initarg instead,
2032 reverse-lookup that name, and recurse with the associated slot value."
2033 ;; This will happen less often, and with fewer slots. Do this the
2034 ;; storage cheap way.
2039 ;; Slot # is length of the total list, minus the remaining list of
2040 ;; the found slot.
2042 \f
2043 ;;; CLOS generics internal function handling
2044 ;;
2050 "When using `call-next-method', provides a context for the current key.
2053 "When executing a PRIMARY or STATIC method, track the 'next-method'.
2054 During executions, the list is first generated, then as each next method
2058 "*Hooks run just before a method is executed.
2059 The hook function must accept one argument, the list of forms
2063 "Call METHOD with ARGS.
2064 ARGS provides the context on which implementation to use.
2065 This should only be called from a generic function."
2066 ;; We must expand our arguments first as they are always
2067 ;; passed in as quoted symbols
2073 ;; get a copy
2076 ;; Is the class passed in autoloaded?
2077 ;; Since class names are also constructors, they can be autoloaded
2078 ;; via the autoload command. Check for this, and load them in.
2079 ;; It's ok if it doesn't turn out to be a class. Probably want that
2080 ;; function loaded anyway.
2086 ;; Determine the class to use.
2091 )
2092 ;; Make sure the class is a valid class
2093 ;; mclass can be nil (meaning a generic for should be used.
2094 ;; mclass cannot have a value that is not a class, however.
2097 method mclass)
2098 )
2099 ;; Now create a list in reverse order of all the calls we have
2100 ;; make in order to successfully do this right. Rules:
2101 ;; 1) Only call generics if scoped-class is not defined
2102 ;; This prevents multiple calls in the case of recursion
2103 ;; 2) Only call static if this is a static method.
2104 ;; 3) Only call specifics if the definition allows for them.
2105 ;; 4) Call in order based on :before, :primary, and :after
2107 ;; Non-static calls do all this stuff.
2109 ;; :after methods
2114 ;;(or (and mclass (eieio-generic-form method method-after mclass))
2115 ;; (eieio-generic-form method method-after nil))
2116 )
2120 ;; :primary methods
2127 primarymethodlist
2130 ;; :before methods
2135 ;;(or (and mclass (eieio-generic-form method method-before mclass))
2136 ;; (eieio-generic-form method method-before nil))
2137 )
2140 )
2143 ;; For the case of a class,
2144 ;; if there were no methods found, then there could be :static methods.
2150 primarymethodlist ;; Re-use even with bad name here
2152 ;; For the case of no class (ie - mclass == nil) then there may
2153 ;; be a primary method.
2159 primarymethodlist
2161 )
2164 primarymethodlist)
2166 ;; Now loop through all occurrences forms which we must execute
2167 ;; (which are happily sorted now) and execute them all!
2177 ;; Use the cdr, as the first element is the fcn
2178 ;; we are calling right now.
2180 )
2182 ;;(setq rval (apply (car (car lambdas)) newargs))
2186 rvalever t))
2187 ))
2193 rvalever t)
2195 'no-method-definition
2197 ;; Right Here... it could be that lastval is returned when
2198 ;; rvalever is nil. Is that right?
2199 rval)))
2202 "Call METHOD with ARGS for methods with only :PRIMARY implementations.
2203 ARGS provides the context on which implementation to use.
2204 This should only be called from a generic function.
2206 This method is like `eieio-generic-call', but only
2207 implementations in the :PRIMARY slot are queried. After many
2208 years of use, it appears that over 90% of methods in use
2209 have :PRIMARY implementations only. We can therefore optimize
2210 for this common case to improve performance."
2211 ;; We must expand our arguments first as they are always
2212 ;; passed in as quoted symbols
2218 )
2219 ;; get a copy
2223 ;; Determine the class to use.
2232 method)
2233 ))
2234 ;; Make sure the class is a valid class
2235 ;; mclass can be nil (meaning a generic for should be used.
2236 ;; mclass cannot have a value that is not a class, however.
2239 )
2241 ;; :primary methods
2246 ;; Now loop through all occurrences forms which we must execute
2247 ;; (which are happily sorted now) and execute them all!
2251 ;; Use the cdr, as the first element is the fcn
2252 ;; we are calling right now.
2254 )
2258 ;; No methods found for this impl...
2261 rvalever t)
2263 'no-method-definition
2266 ;; Do the regular implementation here.
2269 lambdas)
2273 rvalever t)
2274 )
2276 ;; Right Here... it could be that lastval is returned when
2277 ;; rvalever is nil. Is that right?
2278 rval)))
2281 "Return an alist list of methods lambdas.
2282 METHOD is the method name.
2283 KEY represents either :before, or :after methods.
2284 CLASS is the starting class to search from in the method tree.
2285 If CLASS is nil, then an empty list of methods should be returned."
2286 ;; Note: eieiomt - the MT means MethodTree. See more comments below
2287 ;; for the rest of the eieiomt methods.
2289 ;; Collect lambda expressions stored for the class and its parent
2290 ;; classes.
2293 ;; Lookup the form to use for the PRIMARY object for the next level
2297 ;; This prevents duplicates coming out of the
2298 ;; class method optimizer. Perhaps we should
2299 ;; just not optimize before/afters?
2303 ;; Return collected lambda. For :after methods, return in current
2304 ;; order (most general class last); Otherwise, reverse order.
2306 lambdas
2310 "Return non-nil if there is a next method.
2311 Returns a list of lambda expressions which is the `next-method'
2312 order."
2313 eieio-generic-call-next-method-list)
2316 "Call the superclass method from a subclass method.
2317 The superclass method is specified in the current method list,
2318 and is called the next method.
2320 If REPLACEMENT-ARGS is non-nil, then use them instead of
2321 `eieio-generic-call-arglst'. The generic arg list are the
2322 arguments passed in at the top level.
2324 Use `next-method-p' to find out if there is a next method to call."
2330 )
2333 )
2341 )
2343 ))))
2344 \f
2345 ;;;
2346 ;; eieio-method-tree : eieiomt-
2347 ;;
2348 ;; Stored as eieio-method-tree in property list of a generic method
2349 ;;
2350 ;; (eieio-method-tree . [BEFORE PRIMARY AFTER
2351 ;; genericBEFORE genericPRIMARY genericAFTER])
2352 ;; and
2353 ;; (eieio-method-obarray . [BEFORE PRIMARY AFTER
2354 ;; genericBEFORE genericPRIMARY genericAFTER])
2355 ;; where the association is a vector.
2356 ;; (aref 0 -- all static methods.
2357 ;; (aref 1 -- all methods classified as :before
2358 ;; (aref 2 -- all methods classified as :primary
2359 ;; (aref 3 -- all methods classified as :after
2360 ;; (aref 4 -- a generic classified as :before
2361 ;; (aref 5 -- a generic classified as :primary
2362 ;; (aref 6 -- a generic classified as :after
2363 ;;
2368 "Install the method tree, and obarray onto METHOD-NAME.
2369 Do not do the work if they already exist."
2382 ))))
2385 "Add to METHOD-NAME the forms METHOD in a call position KEY for CLASS.
2386 METHOD-NAME is the name created by a call to `defgeneric'.
2387 METHOD are the forms for a given implementation.
2388 KEY is an integer (see comment in eieio.el near this function) which
2389 is associated with the :static :before :primary and :after tags.
2390 It also indicates if CLASS is defined or not.
2391 CLASS is the class this method is associated with."
2396 ;; Make sure the method tables are available.
2399 ;; only add new cells on if it doesn't already exist!
2403 ;; Add function definition into newly created symbol, and store
2404 ;; said symbol in the correct obarray, otherwise use the
2405 ;; other array to keep this stuff
2409 ;; Now optimize the entire obarray
2412 ;; @todo - Is this overkill? Should we just clear the symbol?
2414 ))
2417 "Return the next parent class for CLASS.
2418 If CLASS is a superclass, return variable `eieio-default-superclass'.
2419 If CLASS is variable `eieio-default-superclass' then return nil.
2420 This is different from function `class-parent' as class parent returns
2421 nil for superclasses. This function performs no type checking!"
2422 ;; No type-checking because all calls are made from functions which
2423 ;; are safe and do checking for us.
2426 nil
2430 "Find the next class above S which has a function body for the optimizer."
2431 ;; Set the value to nil in case there is no nearest cell.
2433 ;; Find the nearest cell that has a function body. If we find one,
2434 ;; we replace the nil from above.
2439 eieiomt-optimizing-obarray)))
2445 "Return the lambda form belonging to METHOD using KEY based upon CLASS.
2446 If CLASS is not a class then use `generic' instead. If class has
2447 no form, but has a parent class, then trace to that parent class.
2448 The first time a form is requested from a symbol, an optimized path
2449 is memorized for faster future use."
2453 ;; 1) find our symbol
2456 ;; 2) If there isn't one, then make one.
2457 ;; This can be slow since it only occurs once
2460 ;; 2.1) Cache its nearest neighbor with a quick optimize
2461 ;; which should only occur once for this call ever
2464 ;; 3) If it's bound return this one.
2467 ;; 4) If it's not bound then this variable knows something
2470 ;; 4.1) This symbol holds the next class in its value
2473 ;; 4.2) The optimizer should always have chosen a
2474 ;; function-symbol
2475 ;;(if (fboundp cs)
2477 class-symbol))
2478 ;;(error "EIEIO optimizer: erratic data loss!"))
2479 )
2480 ;; There never will be a funcall...
2481 nil)))
2482 ;; for a generic call, what is a list, is the function body we want.
2486 ;; The car of EMTL is supposed to be a class, which in this
2487 ;; case is nil, so skip it.
2489 nil)))))
2491 ;;;
2492 ;; Way to assign slots based on a list. Used for constructors, or
2493 ;; even resetting an object at run-time
2494 ;;
2496 "Take object OBJ, and reset all slots to their defaults.
2497 If SET-ALL is non-nil, then when a default is nil, that value is
2498 reset. If SET-ALL is nil, the slots are only reset if the default is
2499 not nil."
2510 "For CLASS, convert INITARG to the actual attribute name.
2511 If there is no translation, pass it in directly (so we can cheat if
2512 need be... May remove that later...)"
2516 nil)))
2519 "In CLASS, convert the ATTRIBUTE into the corresponding init argument tag.
2520 This is usually a symbol that starts with `:'."
2524 nil)))
2526 \f
2527 ;;; Here are some special types of errors
2528 ;;
2554 ;;; Here are some CLOS items that need the CL package
2555 ;;
2560 ;; The below setf method was written by Arnd Kohrs <kohrs@acm.org>
2571 store-temp)
2574 \f
2575 ;;;
2576 ;; We want all objects created by EIEIO to have some default set of
2577 ;; behaviours so we can create object utilities, and allow various
2578 ;; types of error checking. To do this, create the default EIEIO
2579 ;; class, and when no parent class is specified, use this as the
2580 ;; default. (But don't store it in the other classes as the default,
2581 ;; allowing for transparent support.)
2582 ;;
2585 nil
2586 "Default parent class for classes with no specified parent class.
2587 Its slots are automatically adopted by classes with no specified parents.
2588 This class is not stored in the `parent' slot of a class vector."
2598 "Default constructor for CLASS `eieio-default-superclass'.
2599 NEWNAME is the name to be given to the constructed object.
2600 SLOTS are the initialization slots used by `shared-initialize'.
2601 This static method is called when an object is constructed.
2602 It allocates the vector used to represent an EIEIO object, and then
2603 calls `shared-initialize' on that object."
2605 class-default-object-cache))))
2606 ;; Update the name for the newly created object.
2608 ;; Call the initialize method on the new object with the slots
2609 ;; that were passed down to us.
2611 ;; Return the created object.
2612 new-object))
2615 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2619 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2620 Called from the constructor routine."
2635 "Construct the new object THIS based on SLOTS.
2636 SLOTS is a tagged list where odd numbered elements are tags, and
2637 even numbered elements are the values to store in the tagged slot.
2638 If you overload the `initialize-instance', there you will need to
2639 call `shared-initialize' yourself, or you can call `call-next-method'
2640 to have this constructor called automatically. If these steps are
2641 not taken, then new objects of your class will not have their values
2642 dynamically set from SLOTS."
2643 ;; First, see if any of our defaults are `lambda', and
2644 ;; re-evaluate them and apply the value to our slots.
2649 ;; For each slot, see if we need to evaluate it.
2650 ;;
2651 ;; Paul Landes said in an email:
2652 ;; > CL evaluates it if it can, and otherwise, leaves it as
2653 ;; > the quoted thing as you already have. This is by the
2654 ;; > Sonya E. Keene book and other things I've look at on the
2655 ;; > web.
2659 ;; Next.
2662 ;; Shared initialize will parse our slots for us.
2670 "Method invoked when an attempt to access a slot in OBJECT fails.
2671 SLOT-NAME is the name of the failed slot, OPERATION is the type of access
2672 that was requested, and optional NEW-VALUE is the value that was desired
2673 to be set.
2675 This method is called from `oref', `oset', and other functions which
2676 directly reference slots in EIEIO objects."
2678 slot-name)))
2684 class slot-name fn)
2685 "Slot unbound is invoked during an attempt to reference an unbound slot.
2686 OBJECT is the instance of the object being reference. CLASS is the
2687 class of OBJECT, and SLOT-NAME is the offending slot. This function
2688 throws the signal `unbound-slot'. You can overload this function and
2689 return the value to use in place of the unbound value.
2690 Argument FN is the function signaling this error.
2691 Use `slot-boundp' to determine if a slot is bound or not.
2693 In CLOS, the argument list is (CLASS OBJECT SLOT-NAME), but
2694 EIEIO can only dispatch on the first argument, so the first two are swapped."
2696 slot-name fn)))
2703 "Called if there are no implementations for OBJECT in METHOD.
2704 OBJECT is the object which has no method implementation.
2705 ARGS are the arguments that were passed to METHOD.
2707 Implement this for a class to block this signal. The return
2708 value becomes the return value of the original method call."
2710 )
2717 "Called from `call-next-method' when no additional methods are available.
2718 OBJECT is othe object being called on `call-next-method'.
2719 ARGS are the arguments it is called by.
2720 This method signals `no-next-method' by default. Override this
2721 method to not throw an error, and its return value becomes the
2722 return value of `call-next-method'."
2724 )
2727 "Make a copy of OBJ, and then supply PARAMS.
2728 PARAMS is a parameter list of the same form used by `initialize-instance'.
2730 When overloading `clone', be sure to call `call-next-method'
2734 "Make a copy of OBJ, and then apply PARAMS."
2747 nobj))
2753 "Destructor for cleaning up any dynamic links to our object.
2754 Argument THIS is the object being destroyed. PARAMS are additional
2755 ignored parameters."
2756 ;; No cleanup... yet.
2757 )
2760 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2762 It is sometimes useful to put a summary of the object into the
2763 default #<notation> string when using EIEIO browsing tools.
2767 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2768 The default method for printing object THIS is to use the
2769 function `object-name'.
2771 It is sometimes useful to put a summary of the object into the
2772 default #<notation> string when using EIEIO browsing tools.
2774 Implement this function and specify STRINGS in a call to
2775 `call-next-method' to provide additional summary information.
2776 When passing in extra strings from child classes, always remember
2777 to prepend a space."
2784 "Write out object THIS to the current stream.
2788 "Write object THIS out to the current stream.
2789 This writes out the vector version of this object. Complex and recursive
2790 object are discouraged from being written.
2791 If optional COMMENT is non-nil, include comments when outputting
2792 this object."
2801 ;; Now output readable lisp to recreate this object
2802 ;; It should look like this:
2803 ;; (<constructor> <name> <slot> <slot> ... )
2804 ;; Each slot's slot is writen using its :writer.
2811 ;; Loop over all the public slots
2820 )
2826 ;; Use our public printer
2828 ;; Use our generic override prin1 function.
2837 "Perform a `prin1' on THING taking advantage of object knowledge."
2849 "Display LIST where list may contain objects."
2866 \f
2867 ;;; Unimplemented functions from CLOS
2868 ;;
2870 "Change the class of OBJ to type CLASS.
2871 This may create or delete slots, but does not affect the return value
2872 of `eq'."
2875 )
2877 \f
2878 ;;; Interfacing with edebug
2879 ;;
2881 "Display EIEIO OBJECT in fancy format.
2882 Overrides the edebug default.
2883 Optional argument NOESCAPE is passed to `prin1-to-string' when appropriate."
2896 ;; ^^ This is the methods symbol
2898 list ; arguments
2900 def-body ; part to be debugged
2901 ))
2902 ;; The rest of the macros
2913 ;; I suspect this isn't the best way to do this, but when
2914 ;; cust-print was used on my system all my objects
2915 ;; appeared as "#1 =" which was not useful. This allows
2916 ;; edebug to print my objects in the nice way they were
2917 ;; meant to with `object-print' and `class-name'
2918 ;; (defalias 'edebug-prin1-to-string 'eieio-edebug-prin1-to-string)
2919 )
2920 )
2922 ;;; Interfacing with imenu in emacs lisp mode
2923 ;; (Only if the expression is defined)
2924 ;;
2929 "Examine `lisp-imenu-generic-expression' and modify it to find `defmethod'."
2932 ;; it's of the form '( ( title expr indx ) ... )
2943 ))
2945 ;;; Autoloading some external symbols, and hooking into the help system
2946 ;;
2948 (autoload 'eieio-help-mode-augmentation-maybee "eieio-opt" "For buffers thrown into help mode, augment for EIEIO.")
2953 (autoload 'eieio-describe-generic "eieio-opt" "Describe GENERIC defined by a string or symbol." t)
2960 ;; arch-tag: c1aeab9c-2938-41a3-842b-1a38bd26e9f2
2961 ;;; eieio ends here