| blob | 526090954a9807074573762d003add1fe593cf4d |
1 ;;; eieio.el --- Enhanced Implementation of Emacs Interpreted Objects -*- lexical-binding:t -*-
2 ;;; or maybe Eric's Implementation of Emacs Interpreted Objects
4 ;; Copyright (C) 1995-1996, 1998-2015 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 ;; @TODO - fix :initform to be a form, not a quoted value
40 ;; @TODO - Prefix non-clos functions with `eieio-'.
42 ;; TODO: better integrate CL's defstructs and classes. E.g. make it possible
43 ;; to create a new class that inherits from a struct.
45 ;;; Code:
51 "Display the current version of EIEIO."
57 \f
58 ;;; Defining a new class
59 ;;
61 "Define NAME as a new class derived from SUPERCLASS with SLOTS.
62 OPTIONS-AND-DOC is used as the class' options and base documentation.
63 SUPERCLASSES is a list of superclasses to inherit from, with SLOTS
64 being the slots residing in that class definition. Supported tags are:
66 :initform - Initializing form.
67 :initarg - Tag used during initialization.
68 :accessor - Tag used to create a function to access this slot.
69 :allocation - Specify where the value is stored.
70 Defaults to `:instance', but could also be `:class'.
71 :writer - A function symbol which will `write' an object's slot.
72 :reader - A function symbol which will `read' an object.
73 :type - The type of data allowed in this slot (see `typep').
74 :documentation
75 - A string documenting use of this slot.
77 The following are extensions on CLOS:
78 :custom - When customizing an object, the custom :type. Public only.
79 :label - A text string label used for a slot when customizing.
80 :group - Name of a customization group this slot belongs in.
81 :printer - A function to call to print the value of a slot.
82 See `eieio-override-prin1' as an example.
84 A class can also have optional options. These options happen in place
85 of documentation (including a :documentation tag), in addition to
86 documentation, or not at all. Supported options are:
88 :documentation - The doc-string used for this class.
90 Options added to EIEIO:
92 :allow-nil-initform - Non-nil to skip typechecking of null initforms.
93 :custom-groups - List of custom group names. Organizes slots into
94 reasonable groups for customizations.
95 :abstract - Non-nil to prevent instances of this class.
96 If a string, use as an error string if someone does
97 try to make an instance.
98 :method-invocation-order
99 - Control the method invocation order if there is
100 multiple inheritance. Valid values are:
101 :breadth-first - The default.
102 :depth-first
104 Options in CLOS not supported in EIEIO:
106 :metaclass - Class to use in place of `standard-class'
107 :default-initargs - Initargs to use when initializing new objects of
108 this class.
110 Due to the way class options are set up, you can add any tags you wish,
111 and reference them using the function `class-option'."
126 ;; Make sure the method invocation order is a valid value.
136 ;; Collect the accessors we need to define.
149 :initform
150 :initarg
151 :documentation
152 :protection
153 :reader
154 :writer
155 :allocation
156 :type
157 :custom
158 :label
159 :group
160 :printer
161 :allow-nil-initform
166 ;; Make sure the :allocation parameter has a valid value.
170 ;; Label is nil, or a string
174 ;; Is there an initarg, but allocation of class?
178 ;; Anyone can have an accessor function. This creates a function
179 ;; of the specified name, and also performs a `defsetf' if applicable
180 ;; so that users can `setf' the space returned by this function.
184 accessors)
187 "Retrieve the slot `%S' from an object of class `%S'."
188 sname name)
189 ;; FIXME: Why is this different from the :reader case?
191 accessors)
193 ;; FIXME: How could I declare this *method* as obsolete.
196 "Retrieve the class slot `%S' from a class `%S'.
197 This method is obsolete."
198 sname name)
201 accessors)))
203 ;; If a writer is defined, then create a generic method of that
204 ;; name whose purpose is to set the value of the slot.
208 sname name)
210 accessors))
211 ;; If a reader is defined, then create a generic method
212 ;; of that name whose purpose is to access this slot value.
216 sname name)
218 accessors))
219 ))
222 ;; This test must be created right away so we can have self-
223 ;; referencing classes. ei, a class whose slot can contain only
224 ;; pointers to itself.
226 ;; Create the test functions.
236 ;; When using typep, (typep OBJ 'myclass) returns t for objects which
237 ;; are subclasses of myclass. For our predicates, however, it is
238 ;; important for EIEIO to be backwards compatible, where
239 ;; myobject-p, and myobject-child-p are different.
240 ;; "cl" uses this technique to specify symbols with specific typep
241 ;; test, so we can let typep have the CLOS documented behavior
242 ;; while keeping our above predicate clean.
248 ,@accessors
250 ;; Create the constructor function
252 ;; Abstract classes cannot be instantiated. Say so.
260 ;; Non-abstract classes need a constructor.
263 name)
267 whole
271 ;; Keep the name arg, for backward compatibility,
272 ;; but hide it so we don't trigger indefinitely.
278 ;;; CLOS style implementation of object creators.
279 ;;
281 "Make a new instance of CLASS based on INITARGS.
282 CLASS is a class symbol. For example:
284 (make-instance 'foo)
286 INITARGS is a property list with keywords based on the :initarg
287 for each slot. For example:
289 (make-instance 'foo :slot1 value1 :slotN valueN)
291 Compatibility note:
293 If the first element of INITARGS is a string, it is used as the
294 name of the class.
296 In EIEIO, the class' constructor requires a name for use when printing.
297 `make-instance' in CLOS doesn't use names the way Emacs does, so the
298 class is used as the name slot instead when INITARGS doesn't start with
299 a string."
302 \f
303 ;;; Get/Set slots in an object.
304 ;;
306 "Retrieve the value stored in OBJ in the slot named by SLOT.
307 Slot is the name of the slot when created by `defclass' or the label
308 created by the :initarg tag."
316 "Get the default value of OBJ (maybe a class) for SLOT.
317 The default value is the value installed in a class with the :initform
318 tag. SLOT can be the slot name, or the tag specified by the :initarg
319 tag in the `defclass' call."
323 ;;; Handy CLOS macros
324 ;;
326 "Bind SPEC-LIST lexically to slot values in OBJECT, and execute BODY.
327 This establishes a lexical environment for referring to the slots in
328 the instance named by the given slot-names as though they were
329 variables. Within such a context the value of the slot can be
330 specified by using its slot name, as if it were a lexically bound
331 variable. Both setf and setq can be used to set the value of the
332 slot.
334 SPEC-LIST is of a form similar to `let'. For example:
336 ((VAR1 SLOT1)
337 SLOT2
338 SLOTN
339 (VARN+1 SLOTN+1))
341 Where each VAR is the local variable given to the associated
342 SLOT. A slot specified without a variable name is given a
343 variable name of the same name as the slot."
346 ;; Transform the spec-list into a cl-symbol-macrolet spec-list.
351 spec-list)))
353 body)))
354 \f
355 ;;; Simple generators, and query functions. None of these would do
356 ;; well embedded into an object.
357 ;;
362 "Return a string which is OBJ's name."
366 "Return a Lisp like symbol string for object OBJ.
367 If EXTRA, include that in the string returned to represent the symbol."
375 ;; In the past, every EIEIO object had a `name' field, so we had the two method
376 ;; below "for free". Since this field is very rarely used, we got rid of it
377 ;; and instead we keep it in a weak hash-tables, for those very rare objects
378 ;; that use it.
386 "Set the string which is OBJ's NAME."
394 "Return the class struct defining OBJ."
395 ;; FIXME: We say we return a "struct" but we return a symbol instead!
399 ;; CLOS name, maybe?
403 "Return a Lisp like symbol name for OBJ's class."
410 "Return parent classes to CLASS. (overload of variable).
412 The CLOS function `class-direct-superclasses' is aliased to this function."
418 "Return child classes to CLASS.
419 The CLOS function `class-direct-subclasses' is aliased to this function."
425 ;; Official CLOS functions.
432 "Return first parent class to CLASS. (overload of variable)."
437 "Return t if OBJ is of class-type CLASS."
444 "Return non-nil if OBJ is an instance of CLASS or CLASS' subclasses."
446 ;; class will be checked one layer down
448 ;; Backwards compatibility
452 "Return non-nil if CHILD class is a subclass of CLASS."
455 ;; `eieio-default-superclass' is never mentioned in eieio--class-parent,
456 ;; so we have to special case it here.
467 "Return list of slots available in OBJ."
479 f))
481 ;;; Object Set macros
482 ;;
484 "Set the value in OBJ for slot SLOT to VALUE.
485 SLOT is the slot name as specified in `defclass' or the tag created
486 with in the :initarg slot. VALUE can be any Lisp object."
491 "Set the default slot in CLASS for SLOT to VALUE.
492 The default value is usually set with the :initform tag during class
493 creation. This allows users to change the default behavior of classes
494 after they are created."
498 ;;; CLOS queries into classes and slots
499 ;;
501 "Return non-nil if OBJECT's SLOT is bound.
502 Setting a slot's value makes it bound. Calling `slot-makeunbound' will
503 make a slot unbound.
504 OBJECT can be an instance or a class."
505 ;; Skip typechecking while retrieving this value.
507 ;; Return nil if the magic symbol is in there.
512 eieio-unbound))))
515 "In OBJECT, make SLOT unbound."
519 "Return non-nil if OBJECT-OR-CLASS has SLOT."
526 ))
529 "Return the class that SYMBOL represents.
530 If there is no class, nil is returned if ERRORP is nil.
531 If ERRORP is non-nil, `wrong-argument-type' is signaled."
537 ;;; Slightly more complex utility functions for objects
538 ;;
540 "Return an object if KEY is `equal' to SLOT's value of an object in LIST.
541 LIST is a list of objects whose slots are searched.
542 Objects in LIST do not need to have a slot named SLOT, nor does
543 SLOT need to be bound. If these errors occur, those objects will
544 be ignored."
547 ;; This prevents errors for missing slots.
554 "Return an association list with the contents of SLOT as the key element.
555 LIST must be a list of objects with SLOT in it.
556 This is useful when you need to do completing read on an object group."
562 assoclist))
567 "Return an association list with the contents of SLOT as the key element.
568 LIST must be a list of objects, but those objects do not need to have
569 SLOT in it. If it does not, then that element is left out of the association
570 list."
577 assoclist)))
582 "In OBJECT's SLOT, add ITEM to the list of elements.
583 Optional argument APPEND indicates we need to append to the list.
584 If ITEM already exists in the list in SLOT, then it is not added.
585 Comparison is done with `equal' through the `member' function call.
586 If SLOT is unbound, bind it to the list containing ITEM."
588 ;; Find the originating list.
592 ;; turn it into a list.
595 ;; Do the combination
601 ;; Set back into the slot.
605 "In OBJECT's SLOT, remove occurrences of ITEM.
606 Deletion is done with `delete', which deletes by side effect,
607 and comparisons are done with `equal'.
608 If SLOT is unbound, do nothing."
610 nil
613 ;;; Here are some CLOS items that need the CL package
614 ;;
618 \f
619 ;;;
620 ;; We want all objects created by EIEIO to have some default set of
621 ;; behaviors so we can create object utilities, and allow various
622 ;; types of error checking. To do this, create the default EIEIO
623 ;; class, and when no parent class is specified, use this as the
624 ;; default. (But don't store it in the other classes as the default,
625 ;; allowing for transparent support.)
626 ;;
629 nil
630 "Default parent class for classes with no specified parent class.
631 Its slots are automatically adopted by classes with no specified parents.
632 This class is not stored in the `parent' slot of a class vector."
646 "Default constructor for CLASS `eieio-default-superclass'.
647 SLOTS are the initialization slots used by `shared-initialize'.
648 This static method is called when an object is constructed.
649 It allocates the vector used to represent an EIEIO object, and then
650 calls `shared-initialize' on that object."
657 "Obsolete name %S passed to %S constructor"
659 ;; Call the initialize method on the new object with the slots
660 ;; that were passed down to us.
662 ;; Return the created object.
663 new-object))
666 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
670 "Set slots of OBJ with SLOTS which is a list of name/value pairs.
671 Called from the constructor routine."
685 "Construct the new object THIS based on SLOTS.
686 SLOTS is a tagged list where odd numbered elements are tags, and
687 even numbered elements are the values to store in the tagged slot.
688 If you overload the `initialize-instance', there you will need to
689 call `shared-initialize' yourself, or you can call `call-next-method'
690 to have this constructor called automatically. If these steps are
691 not taken, then new objects of your class will not have their values
692 dynamically set from SLOTS."
693 ;; First, see if any of our defaults are `lambda', and
694 ;; re-evaluate them and apply the value to our slots.
699 ;; For each slot, see if we need to evaluate it.
700 ;;
701 ;; Paul Landes said in an email:
702 ;; > CL evaluates it if it can, and otherwise, leaves it as
703 ;; > the quoted thing as you already have. This is by the
704 ;; > Sonya E. Keene book and other things I've look at on the
705 ;; > web.
709 ;; Next.
712 ;; Shared initialize will parse our slots for us.
720 "Method invoked when an attempt to access a slot in OBJECT fails.
721 SLOT-NAME is the name of the failed slot, OPERATION is the type of access
722 that was requested, and optional NEW-VALUE is the value that was desired
723 to be set.
725 This method is called from `oref', `oset', and other functions which
726 directly reference slots in EIEIO objects."
728 slot-name)))
734 class slot-name fn)
735 "Slot unbound is invoked during an attempt to reference an unbound slot.
736 OBJECT is the instance of the object being reference. CLASS is the
737 class of OBJECT, and SLOT-NAME is the offending slot. This function
738 throws the signal `unbound-slot'. You can overload this function and
739 return the value to use in place of the unbound value.
740 Argument FN is the function signaling this error.
741 Use `slot-boundp' to determine if a slot is bound or not.
743 In CLOS, the argument list is (CLASS OBJECT SLOT-NAME), but
744 EIEIO can only dispatch on the first argument, so the first two are swapped."
746 slot-name fn)))
749 "Make a copy of OBJ, and then supply PARAMS.
750 PARAMS is a parameter list of the same form used by `initialize-instance'.
752 When overloading `clone', be sure to call `call-next-method'
756 "Make a copy of OBJ, and then apply PARAMS."
762 nobj))
768 "Destructor for cleaning up any dynamic links to our object.
769 Argument THIS is the object being destroyed. PARAMS are additional
770 ignored parameters."
771 ;; No cleanup... yet.
772 )
775 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
777 It is sometimes useful to put a summary of the object into the
778 default #<notation> string when using EIEIO browsing tools.
782 "Pretty printer for object THIS. Call function `object-name' with STRINGS.
783 The default method for printing object THIS is to use the
784 function `object-name'.
786 It is sometimes useful to put a summary of the object into the
787 default #<notation> string when using EIEIO browsing tools.
789 Implement this function and specify STRINGS in a call to
790 `call-next-method' to provide additional summary information.
791 When passing in extra strings from child classes, always remember
792 to prepend a space."
799 "Write out object THIS to the current stream.
803 "Write object THIS out to the current stream.
804 This writes out the vector version of this object. Complex and recursive
805 object are discouraged from being written.
806 If optional COMMENT is non-nil, include comments when outputting
807 this object."
816 ;; Now output readable lisp to recreate this object
817 ;; It should look like this:
818 ;; (<constructor> <name> <slot> <slot> ... )
819 ;; Each slot's slot is writen using its :writer.
826 ;; Loop over all the public slots
835 )
842 ;; Use our public printer
846 ;; Use our generic override prin1 function.
858 "Perform a `prin1' on THING taking advantage of object knowledge."
868 "Display LIST where list may contain objects."
885 \f
886 ;;; Unimplemented functions from CLOS
887 ;;
889 "Change the class of OBJ to type CLASS.
890 This may create or delete slots, but does not affect the return value
891 of `eq'."
894 ;; Hook ourselves into help system for describing classes and methods.
897 ;;; Interfacing with edebug
898 ;;
900 "Display EIEIO OBJECT in fancy format.
902 Used as advice around `edebug-prin1-to-string', held in the
903 variable PRINT-FUNCTION. Optional argument NOESCAPE is passed to
904 `prin1-to-string' when appropriate."
918 \f
919 ;;; Start of automatically extracted autoloads.
920 \f
921 ;;;### (autoloads nil "eieio-custom" "eieio-custom.el" "2ec91e473fcad1ff20cd76edc4aab706")
922 ;;; Generated autoloads from eieio-custom.el
925 Customize OBJ in a custom buffer.
926 Optional argument GROUP is the sub-group of slots to display.
930 ;;;***
931 \f
932 ;;;### (autoloads nil "eieio-opt" "eieio-opt.el" "ff1097f185bc2c253276a7d19fe2f54a")
933 ;;; Generated autoloads from eieio-opt.el
936 Create an object browser window to show all objects.
937 If optional ROOT-CLASS, then start with that, otherwise start with
938 variable `eieio-default-superclass'.
943 Print help description for CLASS.
944 If CLASS is actually an object, then also display current values of that object.
949 Describe CTR if it is a class constructor.
953 ;;;***
954 \f
955 ;;; End of automatically extracted autoloads.
959 ;;; eieio ends here