| blob | 37b1ec5fa942686a70c079a517038448027cb247 |
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-2013 Free Software Foundation, Inc.
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Version: 1.4
8 ;; Keywords: OO, lisp
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
26 ;;
27 ;; EIEIO is a series of Lisp routines which implements a subset of
28 ;; CLOS, the Common Lisp Object System. In addition, EIEIO also adds
29 ;; a few new features which help it integrate more strongly with the
30 ;; Emacs running environment.
31 ;;
32 ;; See eieio.texi for complete documentation on using this package.
33 ;;
34 ;; Note: the implementation of the c3 algorithm is based on:
35 ;; Kim Barrett et al.: A Monotonic Superclass Linearization for Dylan
36 ;; Retrieved from:
37 ;; http://192.220.96.201/dylan/linearization-oopsla96.html
39 ;; There is funny stuff going on with typep and deftype. This
40 ;; is the only way I seem to be able to make this stuff load properly.
42 ;; @TODO - fix :initform to be a form, not a quoted value
43 ;; @TODO - Prefix non-clos functions with `eieio-'.
45 ;;; Code:
53 "Display the current version of EIEIO."
58 ;; About the above. EIEIO must process its own code when it compiles
59 ;; itself, thus, by eval-and-compiling ourselves, we solve the problem.
61 ;; Compatibility
64 ;; XEmacs can only access a compiled functions arglist like this:
67 ;; Emacs doesn't have this function, but since FUNC is a vector, we can just
68 ;; grab the appropriate element.
70 "Return the argument list for the compiled function FUNC."
73 )
75 \f
76 ;;;
77 ;; Variable declarations.
78 ;;
84 "Non-nil to throw an error if an encountered tag is unsupported.
85 This may prevent classes from CLOS applications from being used with EIEIO
89 "If non-nil, skip all slot typechecking.
90 Set this to t permanently if a program is functioning well to get a
91 small speed increase. This variable is also used internally to handle
102 eieio-unbound
106 ;; This is a bootstrap for eieio-default-superclass so it has a value
107 ;; while it is being built itself.
120 doc prefix)))
122 defs)
131 parent children
133 ;; @todo
134 ;; the word "public" here is leftovers from the very first version.
135 ;; Get rid of it!
156 This will speed up instantiation time as only a `copy-sequence' will
157 be needed, instead of looping over all the values and setting them
165 name))
168 ;; FIXME: The constants below should have an `eieio-' prefix added!!
174 (defconst method-num-lists 4 "Number of indexes into methods vector in which groups of functions are kept.")
181 "Convert a specialized KEY into a generic method key."
185 ))
187 \f
188 ;;; Important macros used in eieio.
189 ;;
191 "Internal: Return the class vector from the CLASS symbol."
192 ;; No check: If eieio gets this far, it's probably been checked already.
196 "Return t if CLASS is a valid class vector.
197 CLASS is a symbol."
198 ;; this new method is faster since it doesn't waste time checking lots of
199 ;; things.
205 "Return non-nil if OBJ is an EIEIO object."
214 "Return the symbol representing the constructor of CLASS."
218 "Return t if symbol METHOD is a generic function.
219 Only methods have the symbol `eieio-method-obarray' as a property
220 \(which contains a list of all bindings to that method type.)"
224 "Return t if symbol METHOD is a generic function with only primary methods.
225 Only methods have the symbol `eieio-method-obarray' as a property (which
226 contains a list of all bindings to that method type.)
227 Methods with only primary implementations are executed in an optimized way."
237 ))
240 "Return t if symbol METHOD is a generic function with only primary methods.
241 Only methods have the symbol `eieio-method-obarray' as a property (which
242 contains a list of all bindings to that method type.)
243 Methods with only primary implementations are executed in an optimized way."
253 ))
256 "Return from LIST the found OPTION, or nil if it doesn't exist."
260 "Return the value stored for CLASS' OPTION.
261 Return nil if that option doesn't exist."
265 "Return non-nil if CLASS is abstract.
266 Abstract classes cannot be instantiated."
270 "Return the invocation order of CLASS.
271 Abstract classes cannot be instantiated."
275 \f
276 ;;; Defining a new class
277 ;;
279 "Define NAME as a new class derived from SUPERCLASS with SLOTS.
280 OPTIONS-AND-DOC is used as the class' options and base documentation.
281 SUPERCLASS is a list of superclasses to inherit from, with SLOTS
282 being the slots residing in that class definition. NOTE: Currently
283 only one slot may exist in SUPERCLASS as multiple inheritance is not
284 yet supported. Supported tags are:
286 :initform - Initializing form.
287 :initarg - Tag used during initialization.
288 :accessor - Tag used to create a function to access this slot.
289 :allocation - Specify where the value is stored.
290 Defaults to `:instance', but could also be `:class'.
291 :writer - A function symbol which will `write' an object's slot.
292 :reader - A function symbol which will `read' an object.
293 :type - The type of data allowed in this slot (see `typep').
294 :documentation
295 - A string documenting use of this slot.
297 The following are extensions on CLOS:
298 :protection - Specify protection for this slot.
299 Defaults to `:public'. Also use `:protected', or `:private'.
300 :custom - When customizing an object, the custom :type. Public only.
301 :label - A text string label used for a slot when customizing.
302 :group - Name of a customization group this slot belongs in.
303 :printer - A function to call to print the value of a slot.
304 See `eieio-override-prin1' as an example.
306 A class can also have optional options. These options happen in place
307 of documentation (including a :documentation tag), in addition to
308 documentation, or not at all. Supported options are:
310 :documentation - The doc-string used for this class.
312 Options added to EIEIO:
314 :allow-nil-initform - Non-nil to skip typechecking of null initforms.
315 :custom-groups - List of custom group names. Organizes slots into
316 reasonable groups for customizations.
317 :abstract - Non-nil to prevent instances of this class.
318 If a string, use as an error string if someone does
319 try to make an instance.
320 :method-invocation-order
321 - Control the method invocation order if there is
322 multiple inheritance. Valid values are:
323 :breadth-first - The default.
324 :depth-first
326 Options in CLOS not supported in EIEIO:
328 :metaclass - Class to use in place of `standard-class'
329 :default-initargs - Initargs to use when initializing new objects of
330 this class.
332 Due to the way class options are set up, you can add any tags you wish,
333 and reference them using the function `class-option'."
334 ;; We must `eval-and-compile' this so that when we byte compile
335 ;; an eieio program, there is no need to load it ahead of time.
336 ;; It also provides lots of nice debugging errors at compile time.
343 ;; We autoload this because it's used in `make-autoload'.
344 ;;;###autoload
346 "Create autoload symbols for the EIEIO class CNAME.
347 SUPERCLASSES are the superclasses that CNAME inherits from.
348 DOC is the docstring for CNAME.
349 This function creates a mock-class for CNAME and adds it into
350 SUPERCLASSES as children.
351 It creates an autoload function for CNAME's constructor."
352 ;; Assume we've already debugged inputs.
356 )
358 nil ;; Do nothing if we already have this class.
360 ;; Create the class in NEWC, but don't fill anything else in.
365 ;; No parents?
368 clear-parent t)
369 )
371 ;; Hook our new class into the existing structures so we can
372 ;; autoload it later.
376 ;; TODO - If we create an autoload that is in the map, that
377 ;; map needs to be cleared!
380 ;; Does our parent exist?
383 ;; Create a symbol for this parent, and then store this
384 ;; parent on that symbol.
389 )
391 ;; We have a parent, save the child in there.
396 ;; save parent in child
398 )
400 ;; turn this into a usable self-pointing symbol
403 ;; Store the new class vector definition into the symbol. We need to
404 ;; do this first so that we can call defmethod for the accessor.
405 ;; The vector will be updated by the following while loop and will not
406 ;; need to be stored a second time.
409 ;; Clear the parent
412 ;; Create an autoload on top of our constructor function.
418 ))))
421 "If class CNAME is in an autoload state, load its file."
435 ;; FIXME: Most of this should be moved to the `defclass' macro.
436 "Define CNAME as a new subclass of SUPERCLASSES.
437 SLOTS are the slots residing in that class definition, and options or
438 documentation OPTIONS-AND-DOC is the toplevel documentation for this class.
439 See `defclass' for more information."
440 ;; Run our eieio-hook each time, and clear it when we are done.
441 ;; This way people can add hooks safely if they want to modify eieio
442 ;; or add definitions when eieio is loaded or something like that.
458 ;; If this class already existed, and we are updating its structure,
459 ;; make sure we keep the old child list. This can cause bugs, but
460 ;; if no new slots are created, it also saves time, and prevents
461 ;; method table breakage, particularly when the users is only
462 ;; byte compiling an EIEIO file.
465 ;; If the old class did not exist, but did exist in the autoload map, then adopt those children.
466 ;; This is like the above, but deals with autoloads nicely.
473 ))
474 )
482 )
487 options-and-doc))
494 ;; bad class
496 ;; good parent class...
497 ;; save new child in parent
501 ;; Get custom groups, and store them into our local copy.
504 ;; save parent in child
508 ;; Reverse the list of our parents so that they are prioritized in
509 ;; the same order as specified in the code.
511 ;; If there is nothing to loop over, then inherit from the
512 ;; default superclass.
514 ;; adopt the default parent here, but clear it later...
516 ;; save new child in parent
520 ;; save parent in child
523 ;; turn this into a usable self-pointing symbol
526 ;; These two tests must be created right away so we can have self-
527 ;; referencing classes. ei, a class whose slot can contain only
528 ;; pointers to itself.
530 ;; Create the test function
538 ;; Make sure the method invocation order is a valid value.
542 ))
544 ;; Create a handy child test too
549 "Test OBJ to see if it an object is a child of type %s"
550 cname)
554 ;; Create a handy list of the class test too
559 "Test OBJ to see if it a list of objects which are a child of type %s"
560 cname)
563 ;; Loop over all the elements of the input list, test
564 ;; each to make sure it is a child of the desired object class.
569 ans)))))
571 ;; When using typep, (typep OBJ 'myclass) returns t for objects which
572 ;; are subclasses of myclass. For our predicates, however, it is
573 ;; important for EIEIO to be backwards compatible, where
574 ;; myobject-p, and myobject-child-p are different.
575 ;; "cl" uses this technique to specify symbols with specific typep
576 ;; test, so we can let typep have the CLOS documented behavior
577 ;; while keeping our above predicate clean.
579 ;; It would be cleaner to use `defsetf' here, but that requires cl
580 ;; at runtime.
584 ;; Before adding new slots, let's add all the methods and classes
585 ;; in from the parent class.
588 ;; Store the new class vector definition into the symbol. We need to
589 ;; do this first so that we can call defmethod for the accessor.
590 ;; The vector will be updated by the following while loop and will not
591 ;; need to be stored a second time.
594 ;; Query each slot in the declaration list and mangle into the
595 ;; class structure I have defined.
603 eieio-unbound)))
617 )
623 :initform
624 :initarg
625 :documentation
626 :protection
627 :reader
628 :writer
629 :allocation
630 :type
631 :custom
632 :label
633 :group
634 :printer
635 :allow-nil-initform
640 ;; Clean up the meaning of protection.
647 ;; Make sure the :allocation parameter has a valid value.
651 ;; The default type specifier is supposed to be t, meaning anything.
654 ;; Label is nil, or a string
658 ;; Is there an initarg, but allocation of class?
662 ;; intern the symbol so we can use it blankly
665 ;; The customgroup should be a list of symbols
670 ;; The customgroup better be a symbol, or list of symbols.
674 customg)
676 ;; First up, add this slot into our new class.
680 ;; We need to id the group, and store them in a group list attribute.
683 ;; Anyone can have an accessor function. This creates a function
684 ;; of the specified name, and also performs a `defsetf' if applicable
685 ;; so that users can `setf' the space returned by this function.
692 "Retrieves the slot `%s' from an object of class `%s'"
693 name cname)
696 ;; Else - Some error? nil?
697 nil)))
700 ;; FIXME: We should move more of eieio-defclass into the
701 ;; defclass macro so we don't have to use `eval' and require
702 ;; `gv' at run-time.
705 eieio--store)))
706 ;; Provide a setf method. It would be cleaner to use
707 ;; defsetf, but that would require CL at runtime.
717 --store-sym--)
720 ;; If a writer is defined, then create a generic method of that
721 ;; name whose purpose is to set the value of the slot.
724 writer nil cname
727 name cname)
729 ;; If a reader is defined, then create a generic method
730 ;; of that name whose purpose is to access this slot value.
733 reader nil cname
736 name cname)
738 )
741 ;; Now that everything has been loaded up, all our lists are backwards!
742 ;; Fix that up now.
749 (setf (eieio--class-public-custom-label newc) (nreverse (eieio--class-public-custom-label newc)))
750 (setf (eieio--class-public-custom-group newc) (nreverse (eieio--class-public-custom-group newc)))
755 ;; The storage for class-class-allocation-type needs to be turned into
756 ;; a vector now.
760 ;; Also, take class allocated values, and vectorize them for speed.
764 ;; Attach slot symbols into an obarray, and store the index of
765 ;; this slot as the variable slot in this new symbol. We need to
766 ;; know about primes, because obarrays are best set in vectors of
767 ;; prime number length, and we also need to make our vector small
768 ;; to save space, and also optimal for the number of items we have.
788 )
790 ;; Create the constructor function
792 ;; Abstract classes cannot be instantiated. Say so.
801 ;; Non-abstract classes need a constructor.
806 )
808 ;; Set up a specialized doc string.
809 ;; Use stored value since it is calculated in a non-trivial way
813 ;; Save the file location where this class is defined.
815 load-file-name
816 buffer-file-name))
817 loc)
823 ;; We have a list of custom groups. Store them into the options.
830 ;; Set up the options we have collected.
833 ;; if this is a superclass, clear out parent (which was set to the
834 ;; default superclass eieio-default-superclass)
837 ;; Create the cached default object.
839 nil)))
844 ;; All type-checking has been done to our satisfaction
845 ;; before this call. Don't waste our time in this call..
849 ;; Return our new class object
850 ;; newc
851 cname
852 ))
855 "For SLOT, signal if SPEC does not match VALUE.
856 If SKIPNIL is non-nil, then if VALUE is nil return t instead."
865 "Add into NEWC attribute A.
866 If A already exists in NEWC, then do nothing. If it doesn't exist,
867 then also add in D (default), DOC, TYPE, CUST, LABEL, CUSTG, PRINT, PROT, and INIT arg.
868 Argument ALLOC specifies if the slot is allocated per instance, or per class.
869 If optional DEFAULTOVERRIDE is non-nil, then if A exists in NEWC,
870 we must override its value for a default.
871 Optional argument SKIPNIL indicates if type checking should be skipped
872 if default value is nil."
873 ;; Make sure we duplicate those items that are sequences.
876 ;; This copy can fail on a cons cell with a non-cons in the cdr. Let's skip it if it doesn't work.
882 ;; To prevent override information w/out specification of storage,
883 ;; we need to do this little hack.
887 ;; In this case, we modify the INSTANCE version of a given slot.
891 ;; Only add this element if it is so-far unique
900 (setf (eieio--class-public-custom-label newc) (cons label (eieio--class-public-custom-label newc)))
901 (setf (eieio--class-public-custom-group newc) (cons custg (eieio--class-public-custom-group newc)))
904 (setf (eieio--class-initarg-tuples newc) (cons (cons init a) (eieio--class-initarg-tuples newc)))
905 )
906 ;; When defaultoverride is true, we are usually adding new local
907 ;; attributes which must override the default value of any slot
908 ;; passed in by one of the parent classes.
910 ;; There is a match, and we must override the old value.
915 nil))
917 )
920 a)
921 ;; If type is passed in, is it the same?
925 "Child slot type `%s' does not match inherited type `%s' for `%s'"
926 type tp a)))
927 ;; If we have a repeat, only update the initarg...
931 ;; If we have a new initarg, check for it.
935 ;; Replace the CAR of the associate INITA.
936 ;;(message "Initarg: %S replace %s" inita init)
938 ))
940 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
941 ;; checked and SHOULD match the superclass
942 ;; protection. Otherwise an error is thrown. However
943 ;; I wonder if a more flexible schedule might be
944 ;; implemented.
945 ;;
946 ;; EML - We used to have (if prot... here,
947 ;; but a prot of 'nil means public.
948 ;;
950 )
953 prot super-prot a)))
954 ;; End original PLN
956 ;; PLN Tue Jun 26 11:57:06 2007 :
957 ;; Do a non redundant combination of ancient custom
958 ;; groups and new ones.
970 ;; End PLN
972 ;; PLN Mon Jun 25 22:44:34 2007 : If a new cust is
973 ;; set, simply replaces the old one.
975 ;; (message "Custom type redefined to %s" cust)
978 ;; If a new label is specified, it simply replaces
979 ;; the old one.
981 ;; (message "Custom label redefined to %s" label)
983 ;; End PLN
985 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
986 ;; doc is specified, simply replaces the old one.
988 ;;(message "Documentation redefined to %s" doc)
990 doc))
991 ;; End PLN
993 ;; If a new printer is specified, it simply replaces
994 ;; the old one.
996 ;; (message "printer redefined to %s" print)
999 )))
1000 ))
1002 ;; CLASS ALLOCATED SLOTS
1007 ;; Here we have found a :class version of a slot. This
1008 ;; requires a very different approach.
1010 (setf (eieio--class-class-allocation-doc newc) (cons doc (eieio--class-class-allocation-doc newc)))
1011 (setf (eieio--class-class-allocation-type newc) (cons type (eieio--class-class-allocation-type newc)))
1012 (setf (eieio--class-class-allocation-custom newc) (cons cust (eieio--class-class-allocation-custom newc)))
1013 (setf (eieio--class-class-allocation-custom-label newc) (cons label (eieio--class-class-allocation-custom-label newc)))
1014 (setf (eieio--class-class-allocation-custom-group newc) (cons custg (eieio--class-class-allocation-custom-group newc)))
1015 (setf (eieio--class-class-allocation-protection newc) (cons prot (eieio--class-class-allocation-protection newc)))
1016 ;; Default value is stored in the 'values section, since new objects
1017 ;; can't initialize from this element.
1018 (setf (eieio--class-class-allocation-values newc) (cons value (eieio--class-class-allocation-values newc))))
1020 ;; There is a match, and we must override the old value.
1027 nil))
1029 nil)))
1032 a)
1033 ;; If type is passed in, is it the same?
1037 "Child slot type `%s' does not match inherited type `%s' for `%s'"
1038 type tp a)))
1039 ;; EML - Note: the only reason to override a class bound slot
1040 ;; is to change the default, so allow unbound in.
1042 ;; If we have a repeat, only update the value...
1046 ;; PLN Tue Jun 26 11:57:06 2007 : The protection is
1047 ;; checked and SHOULD match the superclass
1048 ;; protection. Otherwise an error is thrown. However
1049 ;; I wonder if a more flexible schedule might be
1050 ;; implemented.
1055 prot super-prot a)))
1056 ;; Do a non redundant combination of ancient custom groups
1057 ;; and new ones.
1070 ;; PLN Sat Jun 30 17:24:42 2007 : when a new
1071 ;; doc is specified, simply replaces the old one.
1073 ;;(message "Documentation redefined to %s" doc)
1075 doc))
1076 ;; End PLN
1078 ;; If a new printer is specified, it simply replaces
1079 ;; the old one.
1081 ;; (message "printer redefined to %s" print)
1084 ))
1085 ))
1086 ))
1089 "Copy into NEWC the slots of PARENTS.
1090 Follow the rules of not overwriting early parents when applying to
1091 the new child class."
1096 ;; First, duplicate all the slots of the parent.
1115 ;; Increment each value.
1127 ;; Now duplicate all the class alloc slots.
1144 ;; Increment each value.
1154 ;; Loop over each parent class
1156 ))
1158 ;;; CLOS style implementation of object creators.
1159 ;;
1161 "Make a new instance of CLASS based on INITARGS.
1162 CLASS is a class symbol. For example:
1164 (make-instance 'foo)
1166 INITARGS is a property list with keywords based on the :initarg
1167 for each slot. For example:
1169 (make-instance 'foo :slot1 value1 :slotN valueN)
1171 Compatibility note:
1173 If the first element of INITARGS is a string, it is used as the
1174 name of the class.
1176 In EIEIO, the class' constructor requires a name for use when printing.
1177 `make-instance' in CLOS doesn't use names the way Emacs does, so the
1178 class is used as the name slot instead when INITARGS doesn't start with
1179 a string."
1185 initargs)))
1187 \f
1188 ;;; CLOS methods and generics
1189 ;;
1194 "Like `defalias', but with less side-effects.
1195 More specifically, it has no side-effects at all when the new function
1196 definition is the same (`eq') as the old one."
1202 "Create a generic function METHOD.
1203 DOC-STRING is the base documentation for this class. A generic
1204 function has no body, as its purpose is to decide which method body
1205 is appropriate to use. Uses `defmethod' to create methods, and calls
1206 `defgeneric' for you. With this implementation the ARGS are
1207 currently ignored. You can use `defgeneric' to apply specialized
1208 top level documentation to a method."
1213 "Form to use for the initial definition of a generic."
1217 ;; Make sure the method tables are installed.
1219 ;; Construct the actual body of this function.
1223 method))))
1226 "The lambda form that would be used as the function defined on METHOD.
1227 All methods should call the same EIEIO function for dispatch.
1228 DOC-STRING is the documentation attached to METHOD."
1230 ,doc-string
1234 "Setup METHOD to call the generic form."
1239 "The lambda form that would be used as the function defined on METHOD.
1240 All methods should call the same EIEIO function for dispatch.
1241 DOC-STRING is the documentation attached to METHOD."
1243 ,doc-string
1247 "Setup METHOD to call the generic form."
1252 class
1253 impl
1254 )
1255 "The lambda form that would be used as the function defined on METHOD.
1256 All methods should call the same EIEIO function for dispatch.
1257 DOC-STRING is the documentation attached to METHOD.
1258 CLASS is the class symbol needed for private method access.
1259 IMPL is the symbol holding the method implementation."
1260 ;; NOTE: I tried out byte compiling this little fcn. Turns out it
1261 ;; is faster to execute this for not byte-compiled. ie, install this,
1262 ;; then measure calls going through here. I wonder why.
1267 ,doc-string
1268 ;; This is a cool cheat. Usually we need to look up in the
1269 ;; method table to find out if there is a method or not. We can
1270 ;; instead make that determination at load time when there is
1271 ;; only one method. If the first arg is not a child of the class
1272 ;; of that one implementation, then clearly, there is no method def.
1274 ;; Not an object. Just signal.
1278 ;; We do have an object. Make sure it is the right type.
1280 nil ; default superclass means just an obj. Already asked.
1284 ;; If not the right kind of object, call no applicable
1288 ;; It is ok, do the call.
1289 ;; Fill in inter-call variables then evaluate the method.
1295 )
1299 ;(,impl local-args)
1300 )))))))
1303 "Setup METHOD to call the generic form."
1307 )
1309 method doc-string
1312 ))))
1315 "Make the generic method METHOD have no implementations.
1316 It will leave the original generic function in place,
1317 but remove reference to all implementations of METHOD."
1322 "Create a new METHOD through `defgeneric' with ARGS.
1324 The optional second argument KEY is a specifier that
1325 modifies how the method is called, including:
1326 :before - Method will be called before the :primary
1327 :primary - The default if not specified
1328 :after - Method will be called after the :primary
1329 :static - First arg could be an object or class
1330 The next argument is the ARGLIST. The ARGLIST specifies the arguments
1331 to the method as with `defun'. The first argument can have a type
1332 specifier, such as:
1333 ((VARNAME CLASS) ARG2 ...)
1334 where VARNAME is the name of the local variable for the method being
1335 created. The CLASS is a class symbol for a class made with `defclass'.
1336 A DOCSTRING comes after the ARGLIST, and is optional.
1337 All the rest of the args are the BODY of the method. A method will
1338 return the value of the last form in the BODY.
1340 Summary:
1342 (defmethod mymethod [:before | :primary | :after | :static]
1343 ((typearg class-name) arg2 &optional opt &rest rest)
1345 body)"
1351 params))
1355 ;; Make sure there is a generic and the byte-compiler sees it.
1362 "Work part of the `defmethod' macro defining METHOD with ARGS."
1364 ;; Find optional keys.
1369 ;; Primary key.
1370 ;; (t method-primary)
1372 ;; Make sure there is a generic (when called from defclass).
1377 ;; Create symbol for property to bind to. If the first arg is of
1378 ;; the form (varname vartype) and `vartype' is a class, then
1379 ;; that class will be the type symbol. If not, then it will fall
1380 ;; under the type `primary' which is a non-specific calling of the
1381 ;; function.
1385 argclass))
1386 ;; Generics are higher.
1388 ;; Put this lambda into the symbol so we can find it.
1390 )
1393 ;; Optimizing step:
1394 ;;
1395 ;; If this method, after this setup, only has primary methods, then
1396 ;; we can setup the generic that way.
1398 ;; If there is only one primary method, then we can go one more
1399 ;; optimization step.
1405 method)
1407 ;;; Slot type validation
1409 ;; This is a hideous hack for replacing `typep' from cl-macs, to avoid
1410 ;; requiring the CL library at run-time. It can be eliminated if/when
1411 ;; `typep' is merged into Emacs core.
1455 "Return non-nil if SPEC does not match VALUE."
1461 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1462 Checks the :type specifier.
1463 SLOT is the slot that is being checked, and is only used when throwing
1464 an error."
1466 nil
1467 ;; Trim off object IDX junk added in for the object index.
1474 "Make sure that for CLASS referencing SLOT-IDX, VALUE is valid.
1475 Checks the :type specifier.
1476 SLOT is the slot that is being checked, and is only used when throwing
1477 an error."
1479 nil
1481 slot-idx)))
1486 "Throw a signal if VALUE is a representation of an UNBOUND slot.
1487 INSTANCE is the object being referenced. SLOTNAME is the offending
1488 slot. If the slot is ok, return VALUE.
1489 Argument FN is the function calling this verifier."
1492 value))
1494 ;;; Get/Set slots in an object.
1495 ;;
1497 "Retrieve the value stored in OBJ in the slot named by SLOT.
1498 Slot is the name of the slot when created by `defclass' or the label
1499 created by the :initarg tag."
1503 "Return the value in OBJ at SLOT in the object vector."
1510 ;; It might be missing because it is a :class allocated slot.
1511 ;; Let's check that info out.
1513 ;; Oref that slot.
1515 ;; The slot-missing method is a cool way of allowing an object author
1516 ;; to intercept missing slot definitions. Since it is also the LAST
1517 ;; thing called in this fn, its return value would be retrieved.
1519 ;;(signal 'invalid-slot-name (list (eieio-object-name obj) slot))
1520 )
1528 "Get the default value of OBJ (maybe a class) for SLOT.
1529 The default value is the value installed in a class with the :initform
1530 tag. SLOT can be the slot name, or the tag specified by the :initarg
1531 tag in the `defclass' call."
1535 "Do the work for the macro `oref-default' with similar parameters.
1536 Fills in OBJ's SLOT with its default value."
1542 ;; It might be missing because it is a :class allocated slot.
1543 ;; Let's check that info out.
1546 ;; Oref that slot.
1548 c)
1550 ;;(signal 'invalid-slot-name (list (class-name cl) slot))
1551 )
1558 "Whether the default value VAL should be evaluated for use."
1562 "Check VAL, and return what `oref-default' would provide."
1564 ;; Is it a function call? If so, evaluate it.
1567 ;;;; check for quoted things, and unquote them
1568 ;;((and (consp val) (eq (car val) 'quote))
1569 ;; (car (cdr val)))
1570 ;; return it verbatim
1573 ;;; Handy CLOS macros
1574 ;;
1576 "Bind SPEC-LIST lexically to slot values in OBJECT, and execute BODY.
1577 This establishes a lexical environment for referring to the slots in
1578 the instance named by the given slot-names as though they were
1579 variables. Within such a context the value of the slot can be
1580 specified by using its slot name, as if it were a lexically bound
1581 variable. Both setf and setq can be used to set the value of the
1582 slot.
1584 SPEC-LIST is of a form similar to `let'. For example:
1586 ((VAR1 SLOT1)
1587 SLOT2
1588 SLOTN
1589 (VARN+1 SLOTN+1))
1591 Where each VAR is the local variable given to the associated
1592 SLOT. A slot specified without a variable name is given a
1593 variable name of the same name as the slot."
1595 ;; Transform the spec-list into a symbol-macrolet spec-list.
1600 spec-list)))
1602 body)))
1603 \f
1604 ;;; Simple generators, and query functions. None of these would do
1605 ;; well embedded into an object.
1606 ;;
1612 ;; I think this is supposed to return a symbol, but to me CLASS is a symbol,
1613 ;; and I wanted a string. Arg!
1618 "Return a Lisp like symbol string for object OBJ.
1619 If EXTRA, include that in the string returned to represent the symbol."
1632 "Set the string which is OBJ's NAME."
1643 ;; CLOS name, maybe?
1647 "Return a Lisp like symbol name for OBJ's class."
1654 "Return parent classes to CLASS with no check."
1658 "Return parent classes to CLASS. (overload of variable).
1660 The CLOS function `class-direct-superclasses' is aliased to this function."
1669 "Return child classes to CLASS.
1671 The CLOS function `class-direct-subclasses' is aliased to this function."
1678 "Return CLASS if it can go in the result now, otherwise nil"
1679 ;; Ensure CLASS is not in any position but the first in any of the
1680 ;; element lists of REMAINING-INPUTS.
1685 found))
1686 class))
1689 "Merge REVERSED-PARTIAL-RESULT REMAINING-INPUTS in a consistent order, if possible.
1690 If a consistent order does not exist, signal an error."
1696 ;; If all remaining inputs are empty lists, we are done.
1698 ;; Otherwise, we try to find the next element of the result. This
1699 ;; is achieved by considering the first element of each
1700 ;; (non-empty) input list and accepting a candidate if it is
1701 ;; consistent with the rests of the input lists.
1708 remaining-inputs))
1710 found)))
1712 ;; The graph is consistent so far, add NEXT to result and
1713 ;; merge input lists, dropping NEXT from their heads where
1714 ;; applicable.
1718 remaining-inputs))
1719 ;; The graph is inconsistent, give up
1723 "Return all parents of CLASS in depth-first order."
1733 parents)
1736 ;; Remove duplicates.
1740 classes))
1743 "Return all parents of CLASS in breadth-first order."
1755 )
1758 "Return all parents of CLASS in c3 order."
1767 parents)
1770 )
1773 "Return (transitively closed) list of parents of CLASS.
1774 The order, in which the parents are returned depends on the
1775 method invocation orders of the involved classes."
1777 nil
1779 (:depth-first
1781 (:breadth-first
1783 (:c3
1785 )
1789 ;; Official CLOS functions.
1796 "Return first parent class to CLASS. (overload of variable)."
1801 "Return t if OBJ is of class-type CLASS with no error checking."
1810 "Return non-nil if OBJ is an instance of CLASS or CLASS' subclasses."
1812 ;; class will be checked one layer down
1814 ;; Backwards compatibility
1818 "Return non-nil if CHILD class is a subclass of CLASS."
1829 "Return list of slots available in OBJ."
1841 f))
1843 ;;; Object Set macros
1844 ;;
1846 "Set the value in OBJ for slot SLOT to VALUE.
1847 SLOT is the slot name as specified in `defclass' or the tag created
1848 with in the :initarg slot. VALUE can be any Lisp object."
1852 "Do the work for the macro `oset'.
1853 Fills in OBJ's SLOT with VALUE."
1858 ;; It might be missing because it is a :class allocated slot.
1859 ;; Let's check that info out.
1862 ;; Oset that slot.
1866 c value))
1867 ;; See oref for comment on `slot-missing'
1869 ;;(signal 'invalid-slot-name (list (eieio-object-name obj) slot))
1870 )
1875 "Set the default slot in CLASS for SLOT to VALUE.
1876 The default value is usually set with the :initform tag during class
1877 creation. This allows users to change the default behavior of classes
1878 after they are created."
1882 "Do the work for the macro `oset-default'.
1883 Fills in the default value in CLASS' in SLOT with VALUE."
1889 ;; It might be missing because it is a :class allocated slot.
1890 ;; Let's check that info out.
1893 ;; Oref that slot.
1896 value))
1899 ;; Set this into the storage for defaults.
1901 value)
1902 ;; Take the value, and put it into our cache object.
1904 slot value)
1905 )))
1907 ;;; CLOS queries into classes and slots
1908 ;;
1910 "Return non-nil if OBJECT's SLOT is bound.
1911 Setting a slot's value makes it bound. Calling `slot-makeunbound' will
1912 make a slot unbound.
1913 OBJECT can be an instance or a class."
1914 ;; Skip typechecking while retrieving this value.
1916 ;; Return nil if the magic symbol is in there.
1921 eieio-unbound))))
1924 "In OBJECT, make SLOT unbound."
1928 "Return non-nil if OBJECT-OR-CLASS has SLOT."
1932 object-or-class))
1933 )))
1936 ))
1939 "Return the class that SYMBOL represents.
1940 If there is no class, nil is returned if ERRORP is nil.
1941 If ERRORP is non-nil, `wrong-argument-type' is signaled."
1944 nil)
1947 ;;; Slightly more complex utility functions for objects
1948 ;;
1950 "Return an object if KEY is `equal' to SLOT's value of an object in LIST.
1951 LIST is a list of objects whose slots are searched.
1952 Objects in LIST do not need to have a slot named SLOT, nor does
1953 SLOT need to be bound. If these errors occur, those objects will
1954 be ignored."
1957 ;; This prevents errors for missing slots.
1964 "Return an association list with the contents of SLOT as the key element.
1965 LIST must be a list of objects with SLOT in it.
1966 This is useful when you need to do completing read on an object group."
1972 assoclist))
1977 "Return an association list with the contents of SLOT as the key element.
1978 LIST must be a list of objects, but those objects do not need to have
1979 SLOT in it. If it does not, then that element is left out of the association
1980 list."
1987 assoclist)))
1992 "In OBJECT's SLOT, add ITEM to the list of elements.
1993 Optional argument APPEND indicates we need to append to the list.
1994 If ITEM already exists in the list in SLOT, then it is not added.
1995 Comparison is done with `equal' through the `member' function call.
1996 If SLOT is unbound, bind it to the list containing ITEM."
1998 ;; Find the originating list.
2002 ;; turn it into a list.
2005 ;; Do the combination
2011 ;; Set back into the slot.
2015 "In OBJECT's SLOT, remove occurrences of ITEM.
2016 Deletion is done with `delete', which deletes by side effect,
2017 and comparisons are done with `equal'.
2018 If SLOT is unbound, do nothing."
2020 nil
2022 \f
2023 ;;; EIEIO internal search functions
2024 ;;
2026 "Return non-nil if START-CLASS is the first class to define SLOT.
2027 This is for testing if `scoped-class' is the class that defines SLOT
2028 so that we can protect private slots."
2032 t
2038 ret)))
2041 "In CLASS for OBJ find the index of the named SLOT.
2042 The slot is a symbol which is installed in CLASS by the `defclass'
2043 call. OBJ can be nil, but if it is an object, and the slot in question
2044 is protected, access will be allowed if OBJ is a child of the currently
2045 `scoped-class'.
2046 If SLOT is the value created with :initarg instead,
2047 reverse-lookup that name, and recurse with the associated slot value."
2048 ;; Removed checks to outside this call
2065 eieio-initializing-object))
2072 "In CLASS find the index of the named SLOT.
2073 The slot is a symbol which is installed in CLASS by the `defclass'
2074 call. If SLOT is the value created with :initarg instead,
2075 reverse-lookup that name, and recurse with the associated slot value."
2076 ;; This will happen less often, and with fewer slots. Do this the
2077 ;; storage cheap way.
2082 ;; Slot # is length of the total list, minus the remaining list of
2083 ;; the found slot.
2085 \f
2086 ;;; CLOS generics internal function handling
2087 ;;
2093 "When using `call-next-method', provides a context for the current key.
2096 "When executing a PRIMARY or STATIC method, track the 'next-method'.
2097 During executions, the list is first generated, then as each next method
2103 "Abnormal hook run just before an EIEIO method is executed.
2104 The hook function must accept one argument, the list of forms
2108 "Call METHOD with ARGS.
2109 ARGS provides the context on which implementation to use.
2110 This should only be called from a generic function."
2111 ;; We must expand our arguments first as they are always
2112 ;; passed in as quoted symbols
2118 ;; get a copy
2121 ;; Is the class passed in autoloaded?
2122 ;; Since class names are also constructors, they can be autoloaded
2123 ;; via the autoload command. Check for this, and load them in.
2124 ;; It's ok if it doesn't turn out to be a class. Probably want that
2125 ;; function loaded anyway.
2131 ;; Determine the class to use.
2136 )
2137 ;; Make sure the class is a valid class
2138 ;; mclass can be nil (meaning a generic for should be used.
2139 ;; mclass cannot have a value that is not a class, however.
2142 method mclass)
2143 )
2144 ;; Now create a list in reverse order of all the calls we have
2145 ;; make in order to successfully do this right. Rules:
2146 ;; 1) Only call generics if scoped-class is not defined
2147 ;; This prevents multiple calls in the case of recursion
2148 ;; 2) Only call static if this is a static method.
2149 ;; 3) Only call specifics if the definition allows for them.
2150 ;; 4) Call in order based on :before, :primary, and :after
2152 ;; Non-static calls do all this stuff.
2154 ;; :after methods
2159 ;;(or (and mclass (eieio-generic-form method method-after mclass))
2160 ;; (eieio-generic-form method method-after nil))
2161 )
2165 ;; :primary methods
2172 primarymethodlist
2175 ;; :before methods
2180 ;;(or (and mclass (eieio-generic-form method method-before mclass))
2181 ;; (eieio-generic-form method method-before nil))
2182 )
2185 )
2188 ;; For the case of a class,
2189 ;; if there were no methods found, then there could be :static methods.
2195 primarymethodlist ;; Re-use even with bad name here
2197 ;; For the case of no class (ie - mclass == nil) then there may
2198 ;; be a primary method.
2204 primarymethodlist
2206 )
2209 primarymethodlist)
2211 ;; Now loop through all occurrences forms which we must execute
2212 ;; (which are happily sorted now) and execute them all!
2222 ;; Use the cdr, as the first element is the fcn
2223 ;; we are calling right now.
2225 )
2227 ;;(setq rval (apply (car (car lambdas)) newargs))
2231 rvalever t))
2232 ))
2238 rvalever t)
2240 'no-method-definition
2242 ;; Right Here... it could be that lastval is returned when
2243 ;; rvalever is nil. Is that right?
2244 rval)))
2247 "Call METHOD with ARGS for methods with only :PRIMARY implementations.
2248 ARGS provides the context on which implementation to use.
2249 This should only be called from a generic function.
2251 This method is like `eieio-generic-call', but only
2252 implementations in the :PRIMARY slot are queried. After many
2253 years of use, it appears that over 90% of methods in use
2254 have :PRIMARY implementations only. We can therefore optimize
2255 for this common case to improve performance."
2256 ;; We must expand our arguments first as they are always
2257 ;; passed in as quoted symbols
2263 )
2264 ;; get a copy
2268 ;; Determine the class to use.
2277 method)
2278 ))
2279 ;; Make sure the class is a valid class
2280 ;; mclass can be nil (meaning a generic for should be used.
2281 ;; mclass cannot have a value that is not a class, however.
2284 )
2286 ;; :primary methods
2291 ;; Now loop through all occurrences forms which we must execute
2292 ;; (which are happily sorted now) and execute them all!
2296 ;; Use the cdr, as the first element is the fcn
2297 ;; we are calling right now.
2299 )
2303 ;; No methods found for this impl...
2306 rvalever t)
2308 'no-method-definition
2311 ;; Do the regular implementation here.
2314 lambdas)
2318 rvalever t)
2319 )
2321 ;; Right Here... it could be that lastval is returned when
2322 ;; rvalever is nil. Is that right?
2323 rval)))
2326 "Return an alist list of methods lambdas.
2327 METHOD is the method name.
2328 KEY represents either :before, or :after methods.
2329 CLASS is the starting class to search from in the method tree.
2330 If CLASS is nil, then an empty list of methods should be returned."
2331 ;; Note: eieiomt - the MT means MethodTree. See more comments below
2332 ;; for the rest of the eieiomt methods.
2334 ;; Collect lambda expressions stored for the class and its parent
2335 ;; classes.
2338 ;; Lookup the form to use for the PRIMARY object for the next level
2342 ;; This prevents duplicates coming out of the
2343 ;; class method optimizer. Perhaps we should
2344 ;; just not optimize before/afters?
2348 ;; Return collected lambda. For :after methods, return in current
2349 ;; order (most general class last); Otherwise, reverse order.
2351 lambdas
2355 "Return non-nil if there is a next method.
2356 Returns a list of lambda expressions which is the `next-method'
2357 order."
2358 eieio-generic-call-next-method-list)
2361 "Call the superclass method from a subclass method.
2362 The superclass method is specified in the current method list,
2363 and is called the next method.
2365 If REPLACEMENT-ARGS is non-nil, then use them instead of
2366 `eieio-generic-call-arglst'. The generic arg list are the
2367 arguments passed in at the top level.
2369 Use `next-method-p' to find out if there is a next method to call."
2375 )
2378 )
2386 )
2388 ))))
2389 \f
2390 ;;;
2391 ;; eieio-method-tree : eieiomt-
2392 ;;
2393 ;; Stored as eieio-method-tree in property list of a generic method
2394 ;;
2395 ;; (eieio-method-tree . [BEFORE PRIMARY AFTER
2396 ;; genericBEFORE genericPRIMARY genericAFTER])
2397 ;; and
2398 ;; (eieio-method-obarray . [BEFORE PRIMARY AFTER
2399 ;; genericBEFORE genericPRIMARY genericAFTER])
2400 ;; where the association is a vector.
2401 ;; (aref 0 -- all static methods.
2402 ;; (aref 1 -- all methods classified as :before
2403 ;; (aref 2 -- all methods classified as :primary
2404 ;; (aref 3 -- all methods classified as :after
2405 ;; (aref 4 -- a generic classified as :before
2406 ;; (aref 5 -- a generic classified as :primary
2407 ;; (aref 6 -- a generic classified as :after
2408 ;;
2413 "Install the method tree, and obarray onto METHOD-NAME.
2414 Do not do the work if they already exist."
2427 ))))
2430 "Add to METHOD-NAME the forms METHOD in a call position KEY for CLASS.
2431 METHOD-NAME is the name created by a call to `defgeneric'.
2432 METHOD are the forms for a given implementation.
2433 KEY is an integer (see comment in eieio.el near this function) which
2434 is associated with the :static :before :primary and :after tags.
2435 It also indicates if CLASS is defined or not.
2436 CLASS is the class this method is associated with."
2441 ;; Make sure the method tables are available.
2444 ;; only add new cells on if it doesn't already exist!
2448 ;; Add function definition into newly created symbol, and store
2449 ;; said symbol in the correct obarray, otherwise use the
2450 ;; other array to keep this stuff
2454 ;; Save the defmethod file location in a symbol property.
2456 load-file-name
2457 buffer-file-name))
2458 loc)
2466 ;; Now optimize the entire obarray
2469 ;; @todo - Is this overkill? Should we just clear the symbol?
2471 ))
2474 "Return the next parent class for CLASS.
2475 If CLASS is a superclass, return variable `eieio-default-superclass'.
2476 If CLASS is variable `eieio-default-superclass' then return nil.
2477 This is different from function `class-parent' as class parent returns
2478 nil for superclasses. This function performs no type checking!"
2479 ;; No type-checking because all calls are made from functions which
2480 ;; are safe and do checking for us.
2483 nil
2487 "Find the next class above S which has a function body for the optimizer."
2488 ;; Set the value to nil in case there is no nearest cell.
2490 ;; Find the nearest cell that has a function body. If we find one,
2491 ;; we replace the nil from above.
2496 eieiomt-optimizing-obarray)))
2502 "Return the lambda form belonging to METHOD using KEY based upon CLASS.
2503 If CLASS is not a class then use `generic' instead. If class has
2504 no form, but has a parent class, then trace to that parent class.
2505 The first time a form is requested from a symbol, an optimized path
2506 is memorized for faster future use."
2510 ;; 1) find our symbol
2513 ;; 2) If there isn't one, then make one.
2514 ;; This can be slow since it only occurs once
2517 ;; 2.1) Cache its nearest neighbor with a quick optimize
2518 ;; which should only occur once for this call ever
2521 ;; 3) If it's bound return this one.
2524 ;; 4) If it's not bound then this variable knows something
2527 ;; 4.1) This symbol holds the next class in its value
2530 ;; 4.2) The optimizer should always have chosen a
2531 ;; function-symbol
2532 ;;(if (fboundp cs)
2534 ;;(error "EIEIO optimizer: erratic data loss!"))
2535 )
2536 ;; There never will be a funcall...
2537 nil)))
2538 ;; for a generic call, what is a list, is the function body we want.
2542 ;; The car of EMTL is supposed to be a class, which in this
2543 ;; case is nil, so skip it.
2545 nil)))))
2547 ;;;
2548 ;; Way to assign slots based on a list. Used for constructors, or
2549 ;; even resetting an object at run-time
2550 ;;
2552 "Take object OBJ, and reset all slots to their defaults.
2553 If SET-ALL is non-nil, then when a default is nil, that value is
2554 reset. If SET-ALL is nil, the slots are only reset if the default is
2555 not nil."
2566 "For CLASS, convert INITARG to the actual attribute name.
2567 If there is no translation, pass it in directly (so we can cheat if
2568 need be... May remove that later...)"
2572 nil)))
2575 "In CLASS, convert the ATTRIBUTE into the corresponding init argument tag.
2576 This is usually a symbol that starts with `:'."
2580 nil)))
2582 \f
2583 ;;; Here are some special types of errors
2584 ;;
2610 ;;; Here are some CLOS items that need the CL package
2611 ;;
2616 ;; Not needed for Emacs>=24.3 since gv.el's setf expands macros and
2617 ;; follows aliases.
2618 nil
2621 ;; The below setf method was written by Arnd Kohrs <kohrs@acm.org>
2632 store-temp)
2635 \f
2636 ;;;
2637 ;; We want all objects created by EIEIO to have some default set of
2638 ;; behaviors so we can create object utilities, and allow various
2639 ;; types of error checking. To do this, create the default EIEIO
2640 ;; class, and when no parent class is specified, use this as the
2641 ;; default. (But don't store it in the other classes as the default,
2642 ;; allowing for transparent support.)
2643 ;;
2646 nil
2647 "Default parent class for classes with no specified parent class.
2648 Its slots are automatically adopted by classes with no specified parents.
2649 This class is not stored in the `parent' slot of a class vector."
2659 "Default constructor for CLASS `eieio-default-superclass'.
2660 NEWNAME is the name to be given to the constructed object.
2661 SLOTS are the initialization slots used by `shared-initialize'.
2662 This static method is called when an object is constructed.
2663 It allocates the vector used to represent an EIEIO object, and then
2664 calls `shared-initialize' on that object."
2666 ;; Update the name for the newly created object.
2668 ;; Call the initialize method on the new object with the slots
2669 ;; that were passed down to us.
2671 ;; Return the created object.
2672 new-object))
2675 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2679 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
2680 Called from the constructor routine."
2695 "Construct the new object THIS based on SLOTS.
2696 SLOTS is a tagged list where odd numbered elements are tags, and
2697 even numbered elements are the values to store in the tagged slot.
2698 If you overload the `initialize-instance', there you will need to
2699 call `shared-initialize' yourself, or you can call `call-next-method'
2700 to have this constructor called automatically. If these steps are
2701 not taken, then new objects of your class will not have their values
2702 dynamically set from SLOTS."
2703 ;; First, see if any of our defaults are `lambda', and
2704 ;; re-evaluate them and apply the value to our slots.
2709 ;; For each slot, see if we need to evaluate it.
2710 ;;
2711 ;; Paul Landes said in an email:
2712 ;; > CL evaluates it if it can, and otherwise, leaves it as
2713 ;; > the quoted thing as you already have. This is by the
2714 ;; > Sonya E. Keene book and other things I've look at on the
2715 ;; > web.
2719 ;; Next.
2722 ;; Shared initialize will parse our slots for us.
2730 "Method invoked when an attempt to access a slot in OBJECT fails.
2731 SLOT-NAME is the name of the failed slot, OPERATION is the type of access
2732 that was requested, and optional NEW-VALUE is the value that was desired
2733 to be set.
2735 This method is called from `oref', `oset', and other functions which
2736 directly reference slots in EIEIO objects."
2738 slot-name)))
2744 class slot-name fn)
2745 "Slot unbound is invoked during an attempt to reference an unbound slot.
2746 OBJECT is the instance of the object being reference. CLASS is the
2747 class of OBJECT, and SLOT-NAME is the offending slot. This function
2748 throws the signal `unbound-slot'. You can overload this function and
2749 return the value to use in place of the unbound value.
2750 Argument FN is the function signaling this error.
2751 Use `slot-boundp' to determine if a slot is bound or not.
2753 In CLOS, the argument list is (CLASS OBJECT SLOT-NAME), but
2754 EIEIO can only dispatch on the first argument, so the first two are swapped."
2756 slot-name fn)))
2763 "Called if there are no implementations for OBJECT in METHOD.
2764 OBJECT is the object which has no method implementation.
2765 ARGS are the arguments that were passed to METHOD.
2767 Implement this for a class to block this signal. The return
2768 value becomes the return value of the original method call."
2770 )
2777 "Called from `call-next-method' when no additional methods are available.
2778 OBJECT is othe object being called on `call-next-method'.
2779 ARGS are the arguments it is called by.
2780 This method signals `no-next-method' by default. Override this
2781 method to not throw an error, and its return value becomes the
2782 return value of `call-next-method'."
2784 )
2787 "Make a copy of OBJ, and then supply PARAMS.
2788 PARAMS is a parameter list of the same form used by `initialize-instance'.
2790 When overloading `clone', be sure to call `call-next-method'
2794 "Make a copy of OBJ, and then apply PARAMS."
2807 nobj))
2813 "Destructor for cleaning up any dynamic links to our object.
2814 Argument THIS is the object being destroyed. PARAMS are additional
2815 ignored parameters."
2816 ;; No cleanup... yet.
2817 )
2820 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2822 It is sometimes useful to put a summary of the object into the
2823 default #<notation> string when using EIEIO browsing tools.
2827 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
2828 The default method for printing object THIS is to use the
2829 function `object-name'.
2831 It is sometimes useful to put a summary of the object into the
2832 default #<notation> string when using EIEIO browsing tools.
2834 Implement this function and specify STRINGS in a call to
2835 `call-next-method' to provide additional summary information.
2836 When passing in extra strings from child classes, always remember
2837 to prepend a space."
2844 "Write out object THIS to the current stream.
2848 "Write object THIS out to the current stream.
2849 This writes out the vector version of this object. Complex and recursive
2850 object are discouraged from being written.
2851 If optional COMMENT is non-nil, include comments when outputting
2852 this object."
2861 ;; Now output readable lisp to recreate this object
2862 ;; It should look like this:
2863 ;; (<constructor> <name> <slot> <slot> ... )
2864 ;; Each slot's slot is writen using its :writer.
2871 ;; Loop over all the public slots
2880 )
2887 ;; Use our public printer
2891 ;; Use our generic override prin1 function.
2903 "Perform a `prin1' on THING taking advantage of object knowledge."
2917 "Display LIST where list may contain objects."
2934 \f
2935 ;;; Unimplemented functions from CLOS
2936 ;;
2938 "Change the class of OBJ to type CLASS.
2939 This may create or delete slots, but does not affect the return value
2940 of `eq'."
2943 )
2945 ;;; Obsolete backward compatibility functions.
2946 ;; Needed to run byte-code compiled with the EIEIO of Emacs-23.
2949 "Obsolete work part of an old version of the `defmethod' macro."
2951 ;; find optional keys
2955 method-before)
2958 method-after)
2961 method-static)
2964 method-primary)
2965 ;; Primary key.
2967 ;; Get body, and fix contents of args to be the arguments of the fn.
2971 ;; Create a fixed version of the arguments.
2974 argfix))
2976 ;; Make sure there is a generic.
2978 method
2981 ;; create symbol for property to bind to. If the first arg is of
2982 ;; the form (varname vartype) and `vartype' is a class, then
2983 ;; that class will be the type symbol. If not, then it will fall
2984 ;; under the type `primary' which is a non-specific calling of the
2985 ;; function.
2993 ;; Generics are higher.
2995 ;; Put this lambda into the symbol so we can find it.
2999 key argclass))
3000 )
3003 ;; Optimizing step:
3004 ;;
3005 ;; If this method, after this setup, only has primary methods, then
3006 ;; we can setup the generic that way.
3008 ;; If there is only one primary method, then we can go one more
3009 ;; optimization step.
3015 method)
3019 "Obsolete work part of an old version of the `defgeneric' macro."
3023 )
3025 method))
3026 ;; Don't do this over and over.
3028 ;; This defun tells emacs where the first definition of this
3029 ;; method is defined.
3031 ;; Make sure the method tables are installed.
3033 ;; Apply the actual body of this function.
3035 ;; Return the method
3039 ;;; Interfacing with edebug
3040 ;;
3042 "Display EIEIO OBJECT in fancy format.
3043 Overrides the edebug default.
3044 Optional argument NOESCAPE is passed to `prin1-to-string' when appropriate."
3057 ;; ^^ This is the methods symbol
3059 list ; arguments
3061 def-body ; part to be debugged
3062 ))
3063 ;; The rest of the macros
3074 ;; I suspect this isn't the best way to do this, but when
3075 ;; cust-print was used on my system all my objects
3076 ;; appeared as "#1 =" which was not useful. This allows
3077 ;; edebug to print my objects in the nice way they were
3078 ;; meant to with `object-print' and `class-name'
3079 ;; (defalias 'edebug-prin1-to-string 'eieio-edebug-prin1-to-string)
3080 )
3081 )
3083 ;;; Autoloading some external symbols, and hooking into the help system
3084 ;;
3086 \f
3087 ;;; Start of automatically extracted autoloads.
3088 \f
3089 ;;;### (autoloads (customize-object) "eieio-custom" "eieio-custom.el"
3090 ;;;;;; "928623502e8bf40454822355388542b5")
3091 ;;; Generated autoloads from eieio-custom.el
3094 Customize OBJ in a custom buffer.
3095 Optional argument GROUP is the sub-group of slots to display.
3099 ;;;***
3100 \f
3101 ;;;### (autoloads (eieio-help-mode-augmentation-maybee eieio-describe-generic
3102 ;;;;;; eieio-describe-constructor eieio-describe-class eieio-browse)
3103 ;;;;;; "eieio-opt" "eieio-opt.el" "d808328f9c0156ecbd412d77ba8c569e")
3104 ;;; Generated autoloads from eieio-opt.el
3107 Create an object browser window to show all objects.
3108 If optional ROOT-CLASS, then start with that, otherwise start with
3109 variable `eieio-default-superclass'.
3115 Describe a CLASS defined by a string or symbol.
3116 If CLASS is actually an object, then also display current values of that object.
3117 Optional HEADERFCN should be called to insert a few bits of info first.
3122 Describe the constructor function FCN.
3123 Uses `eieio-describe-class' to describe the class being constructed.
3129 Describe the generic function GENERIC.
3130 Also extracts information about all methods specific to this generic.
3135 For buffers thrown into help mode, augment for EIEIO.
3136 Arguments UNUSED are not used.
3140 ;;;***
3141 \f
3142 ;;; End of automatically extracted autoloads.
3146 ;;; eieio ends here