Preserve face text properties in comint prompt.
[emacs.git] / lisp / emacs-lisp / eieio.el
1 ;;; eieio.el --- Enhanced Implementation of Emacs Interpreted Objects  -*- lexical-binding:t -*-
2 ;;;              or maybe Eric's Implementation of Emacs Interpreted Objects
3
4 ;; Copyright (C) 1995-1996, 1998-2015 Free Software Foundation, Inc.
5
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Version: 1.4
8 ;; Keywords: OO, lisp
9
10 ;; This file is part of GNU Emacs.
11
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.
16
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.
21
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/>.
24
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
38
39 ;; @TODO - fix :initform to be a form, not a quoted value
40 ;; @TODO - Prefix non-clos functions with `eieio-'.
41
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.
44
45 ;;; Code:
46
47 (defvar eieio-version "1.4"
48   "Current version of EIEIO.")
49
50 (defun eieio-version ()
51   "Display the current version of EIEIO."
52   (interactive)
53   (message eieio-version))
54
55 (require 'eieio-core)
56
57 \f
58 ;;; Defining a new class
59 ;;
60 (defmacro defclass (name superclasses slots &rest options-and-doc)
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:
65
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.
76
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.
83
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:
87
88   :documentation - The doc-string used for this class.
89
90 Options added to EIEIO:
91
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
103
104 Options in CLOS not supported in EIEIO:
105
106   :metaclass - Class to use in place of `standard-class'
107   :default-initargs - Initargs to use when initializing new objects of
108                       this class.
109
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'."
112   (declare (doc-string 4))
113   (cl-check-type superclasses list)
114
115   (cond ((and (stringp (car options-and-doc))
116               (/= 1 (% (length options-and-doc) 2)))
117          (error "Too many arguments to `defclass'"))
118         ((and (symbolp (car options-and-doc))
119               (/= 0 (% (length options-and-doc) 2)))
120          (error "Too many arguments to `defclass'")))
121
122   (if (stringp (car options-and-doc))
123       (setq options-and-doc
124             (cons :documentation options-and-doc)))
125
126   ;; Make sure the method invocation order is a valid value.
127   (let ((io (eieio--class-option-assoc options-and-doc
128                                        :method-invocation-order)))
129     (when (and io (not (member io '(:depth-first :breadth-first :c3))))
130       (error "Method invocation order %s is not allowed" io)))
131
132   (let ((testsym1 (intern (concat (symbol-name name) "-p")))
133         (testsym2 (intern (format "%s--eieio-childp" name)))
134         (accessors ()))
135
136     ;; Collect the accessors we need to define.
137     (pcase-dolist (`(,sname . ,soptions) slots)
138       (let* ((acces   (plist-get soptions :accessor))
139              (initarg (plist-get soptions :initarg))
140              (reader  (plist-get soptions :reader))
141              (writer  (plist-get soptions :writer))
142              (alloc   (plist-get soptions :allocation))
143              (label   (plist-get soptions :label)))
144
145         (if eieio-error-unsupported-class-tags
146             (let ((tmp soptions))
147               (while tmp
148                 (if (not (member (car tmp) '(:accessor
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
162                                              :custom-groups)))
163                     (signal 'invalid-slot-type (list (car tmp))))
164                 (setq tmp (cdr (cdr tmp))))))
165
166         ;; Make sure the :allocation parameter has a valid value.
167         (if (not (memq alloc '(nil :class :instance)))
168             (signal 'invalid-slot-type (list :allocation alloc)))
169
170         ;; Label is nil, or a string
171         (if (not (or (null label) (stringp label)))
172             (signal 'invalid-slot-type (list :label label)))
173
174         ;; Is there an initarg, but allocation of class?
175         (if (and initarg (eq alloc :class))
176             (message "Class allocated slots do not need :initarg"))
177
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.
181         (when acces
182           (push `(cl-defmethod (setf ,acces) (value (this ,name))
183                    (eieio-oset this ',sname value))
184                 accessors)
185           (push `(cl-defmethod ,acces ((this ,name))
186                    ,(format
187                      "Retrieve the slot `%S' from an object of class `%S'."
188                      sname name)
189                    ;; FIXME: Why is this different from the :reader case?
190                    (if (slot-boundp this ',sname) (eieio-oref this ',sname)))
191                 accessors)
192           (when (and eieio-backward-compatibility (eq alloc :class))
193             ;; FIXME: How could I declare this *method* as obsolete.
194             (push `(cl-defmethod ,acces ((this (subclass ,name)))
195                      ,(format
196                        "Retrieve the class slot `%S' from a class `%S'.
197 This method is obsolete."
198                        sname name)
199                      (if (slot-boundp this ',sname)
200                          (eieio-oref-default this ',sname)))
201                   accessors)))
202
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.
205         (if writer
206             (push `(cl-defmethod ,writer ((this ,name) value)
207                      ,(format "Set the slot `%S' of an object of class `%S'."
208                               sname name)
209                      (setf (slot-value this ',sname) value))
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.
213         (if reader
214             (push `(cl-defmethod ,reader ((this ,name))
215                      ,(format "Access the slot `%S' from object of class `%S'."
216                               sname name)
217                      (slot-value this ',sname))
218                   accessors))
219         ))
220
221     `(progn
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.
225
226        ;; Create the test functions.
227        (defalias ',testsym1 (eieio-make-class-predicate ',name))
228        (defalias ',testsym2 (eieio-make-child-predicate ',name))
229
230        ,@(when eieio-backward-compatibility
231            (let ((f (intern (format "%s-child-p" name))))
232              `((defalias ',f ',testsym2)
233                (make-obsolete
234                 ',f ,(format "use (cl-typep ... '%s) instead" name) "25.1"))))
235
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.
243
244        (put ',name 'cl-deftype-satisfies #',testsym2)
245
246        (eieio-defclass-internal ',name ',superclasses ',slots ',options-and-doc)
247
248        ,@accessors
249
250        ;; Create the constructor function
251        ,(if (eieio--class-option-assoc options-and-doc :abstract)
252             ;; Abstract classes cannot be instantiated.  Say so.
253             (let ((abs (eieio--class-option-assoc options-and-doc :abstract)))
254               (if (not (stringp abs))
255                   (setq abs (format "Class %s is abstract" name)))
256               `(defun ,name (&rest _)
257                  ,(format "You cannot create a new object of type %S." name)
258                  (error ,abs)))
259
260           ;; Non-abstract classes need a constructor.
261           `(defun ,name (&rest slots)
262              ,(format "Create a new object with name NAME of class type %S."
263                       name)
264              (declare (compiler-macro
265                        (lambda (whole)
266                          (if (not (stringp (car slots)))
267                              whole
268                            (macroexp--warn-and-return
269                             (format "Obsolete name arg %S to constructor %S"
270                                     (car slots) (car whole))
271                             ;; Keep the name arg, for backward compatibility,
272                             ;; but hide it so we don't trigger indefinitely.
273                             `(,(car whole) (identity ,(car slots))
274                               ,@(cdr slots)))))))
275              (apply #'make-instance ',name slots))))))
276
277
278 ;;; Get/Set slots in an object.
279 ;;
280 (defmacro oref (obj slot)
281   "Retrieve the value stored in OBJ in the slot named by SLOT.
282 Slot is the name of the slot when created by `defclass' or the label
283 created by the :initarg tag."
284   (declare (debug (form symbolp)))
285   `(eieio-oref ,obj (quote ,slot)))
286
287 (defalias 'slot-value 'eieio-oref)
288 (defalias 'set-slot-value 'eieio-oset)
289 (make-obsolete 'set-slot-value "use (setf (slot-value ..) ..) instead" "25.1")
290
291 (defmacro oref-default (obj slot)
292   "Get the default value of OBJ (maybe a class) for SLOT.
293 The default value is the value installed in a class with the :initform
294 tag.  SLOT can be the slot name, or the tag specified by the :initarg
295 tag in the `defclass' call."
296   (declare (debug (form symbolp)))
297   `(eieio-oref-default ,obj (quote ,slot)))
298
299 ;;; Handy CLOS macros
300 ;;
301 (defmacro with-slots (spec-list object &rest body)
302   "Bind SPEC-LIST lexically to slot values in OBJECT, and execute BODY.
303 This establishes a lexical environment for referring to the slots in
304 the instance named by the given slot-names as though they were
305 variables.  Within such a context the value of the slot can be
306 specified by using its slot name, as if it were a lexically bound
307 variable.  Both setf and setq can be used to set the value of the
308 slot.
309
310 SPEC-LIST is of a form similar to `let'.  For example:
311
312   ((VAR1 SLOT1)
313     SLOT2
314     SLOTN
315    (VARN+1 SLOTN+1))
316
317 Where each VAR is the local variable given to the associated
318 SLOT.  A slot specified without a variable name is given a
319 variable name of the same name as the slot."
320   (declare (indent 2) (debug (sexp sexp def-body)))
321   (require 'cl-lib)
322   ;; Transform the spec-list into a cl-symbol-macrolet spec-list.
323   (macroexp-let2 nil object object
324     `(cl-symbol-macrolet
325          ,(mapcar (lambda (entry)
326                     (let ((var  (if (listp entry) (car entry) entry))
327                           (slot (if (listp entry) (cadr entry) entry)))
328                       (list var `(slot-value ,object ',slot))))
329                   spec-list)
330        ,@body)))
331
332 ;; Keep it as a non-inlined function, so the internals of object don't get
333 ;; hard-coded in random .elc files.
334 (defun eieio-pcase-slot-index-table (obj)
335   "Return some data structure from which can be extracted the slot offset."
336   (eieio--class-index-table
337    (symbol-value (eieio--object-class-tag obj))))
338
339 (defun eieio-pcase-slot-index-from-index-table (index-table slot)
340   "Find the index to pass to `aref' to access SLOT."
341   (let ((index (gethash slot index-table)))
342     (if index (+ (eval-when-compile
343                    (length (cl-struct-slot-info 'eieio--object)))
344                  index))))
345
346 (pcase-defmacro eieio (&rest fields)
347   "Pcase patterns to match EIEIO objects.
348 Elements of FIELDS can be of the form (NAME UPAT) in which case the contents of
349 field NAME is matched against UPAT, or they can be of the form NAME which
350 is a shorthand for (NAME NAME)."
351   (let ((is (make-symbol "table")))
352     ;; FIXME: This generates a horrendous mess of redundant let bindings.
353     ;; `pcase' needs to be improved somehow to introduce let-bindings more
354     ;; sparingly, or the byte-compiler needs to be taught to optimize
355     ;; them away.
356     ;; FIXME: `pcase' does not do a good job here of sharing tests&code among
357     ;; various branches.
358     `(and (pred eieio-object-p)
359           (app eieio-pcase-slot-index-table ,is)
360           ,@(mapcar (lambda (field)
361                       (let* ((name (if (consp field) (car field) field))
362                              (pat (if (consp field) (cadr field) field))
363                              (i (make-symbol "index")))
364                         `(and (let (and ,i (pred natnump))
365                                 (eieio-pcase-slot-index-from-index-table
366                                  ,is ',name))
367                               (app (pcase--flip aref ,i) ,pat))))
368                     fields))))
369 \f
370 ;;; Simple generators, and query functions.  None of these would do
371 ;;  well embedded into an object.
372 ;;
373
374 (define-obsolete-function-alias
375   'object-class-fast #'eieio-object-class "24.4")
376
377 (cl-defgeneric eieio-object-name-string (obj)
378   "Return a string which is OBJ's name."
379   (declare (obsolete eieio-named "25.1")))
380
381 (defun eieio-object-name (obj &optional extra)
382   "Return a printed representation for object OBJ.
383 If EXTRA, include that in the string returned to represent the symbol."
384   (cl-check-type obj eieio-object)
385   (format "#<%s %s%s>" (eieio-object-class obj)
386           (eieio-object-name-string obj) (or extra "")))
387 (define-obsolete-function-alias 'object-name #'eieio-object-name "24.4")
388
389 (defconst eieio--object-names (make-hash-table :test #'eq :weakness 'key))
390
391 ;; In the past, every EIEIO object had a `name' field, so we had the two method
392 ;; below "for free".  Since this field is very rarely used, we got rid of it
393 ;; and instead we keep it in a weak hash-tables, for those very rare objects
394 ;; that use it.
395 (cl-defmethod eieio-object-name-string (obj)
396   (or (gethash obj eieio--object-names)
397       (symbol-name (eieio-object-class obj))))
398 (define-obsolete-function-alias
399   'object-name-string #'eieio-object-name-string "24.4")
400
401 (cl-defmethod eieio-object-set-name-string (obj name)
402   "Set the string which is OBJ's NAME."
403   (declare (obsolete eieio-named "25.1"))
404   (cl-check-type name string)
405   (setf (gethash obj eieio--object-names) name))
406 (define-obsolete-function-alias
407   'object-set-name-string 'eieio-object-set-name-string "24.4")
408
409 (defun eieio-object-class (obj)
410   "Return the class struct defining OBJ."
411   ;; FIXME: We say we return a "struct" but we return a symbol instead!
412   (cl-check-type obj eieio-object)
413   (eieio--class-name (eieio--object-class obj)))
414 (define-obsolete-function-alias 'object-class #'eieio-object-class "24.4")
415 ;; CLOS name, maybe?
416 (define-obsolete-function-alias 'class-of #'eieio-object-class "24.4")
417
418 (defun eieio-object-class-name (obj)
419   "Return a Lisp like symbol name for OBJ's class."
420   (cl-check-type obj eieio-object)
421   (eieio-class-name (eieio--object-class obj)))
422 (define-obsolete-function-alias
423   'object-class-name 'eieio-object-class-name "24.4")
424
425 (defun eieio-class-parents (class)
426   "Return parent classes to CLASS.  (overload of variable).
427
428 The CLOS function `class-direct-superclasses' is aliased to this function."
429   (eieio--class-parents (eieio--class-object class)))
430
431 (define-obsolete-function-alias 'class-parents #'eieio-class-parents "24.4")
432
433 (defun eieio-class-children (class)
434   "Return child classes to CLASS.
435 The CLOS function `class-direct-subclasses' is aliased to this function."
436   (cl-check-type class class)
437   (eieio--class-children (eieio--class-v class)))
438 (define-obsolete-function-alias
439   'class-children #'eieio-class-children "24.4")
440
441 ;; Official CLOS functions.
442 (define-obsolete-function-alias
443   'class-direct-superclasses #'eieio-class-parents "24.4")
444 (define-obsolete-function-alias
445   'class-direct-subclasses #'eieio-class-children "24.4")
446
447 (defmacro eieio-class-parent (class)
448   "Return first parent class to CLASS.  (overload of variable)."
449   `(car (eieio-class-parents ,class)))
450 (define-obsolete-function-alias 'class-parent 'eieio-class-parent "24.4")
451
452 (defun same-class-p (obj class)
453   "Return t if OBJ is of class-type CLASS."
454   (setq class (eieio--class-object class))
455   (cl-check-type class eieio--class)
456   (cl-check-type obj eieio-object)
457   (eq (eieio--object-class obj) class))
458
459 (defun object-of-class-p (obj class)
460   "Return non-nil if OBJ is an instance of CLASS or CLASS' subclasses."
461   (cl-check-type obj eieio-object)
462   ;; class will be checked one layer down
463   (child-of-class-p (eieio--object-class obj) class))
464 ;; Backwards compatibility
465 (defalias 'obj-of-class-p 'object-of-class-p)
466
467 (defun child-of-class-p (child class)
468   "Return non-nil if CHILD class is a subclass of CLASS."
469   (setq child (eieio--class-object child))
470   (cl-check-type child eieio--class)
471   ;; `eieio-default-superclass' is never mentioned in eieio--class-parents,
472   ;; so we have to special case it here.
473   (or (eq class 'eieio-default-superclass)
474       (let ((p nil))
475         (setq class (eieio--class-object class))
476         (cl-check-type class eieio--class)
477         (while (and child (not (eq child class)))
478           (setq p (append p (eieio--class-parents child))
479                 child (pop p)))
480         (if child t))))
481
482 (defun eieio-slot-descriptor-name (slot)
483   (cl--slot-descriptor-name slot))
484
485 (defun eieio-class-slots (class)
486   "Return list of slots available in instances of CLASS."
487   ;; FIXME: This only gives the instance slots and ignores the
488   ;; class-allocated slots.
489   (setq class (eieio--class-object class))
490   (cl-check-type class eieio--class)
491   (mapcar #'identity (eieio--class-slots class)))
492
493 (defun object-slots (obj)
494   "Return list of slot names available in OBJ."
495   (declare (obsolete eieio-class-slots "25.1"))
496   (cl-check-type obj eieio-object)
497   (mapcar #'cl--slot-descriptor-name
498           (eieio-class-slots (eieio--object-class obj))))
499
500 (defun eieio--class-slot-initarg (class slot)
501   "Fetch from CLASS, SLOT's :initarg."
502   (cl-check-type class eieio--class)
503   (let ((ia (eieio--class-initarg-tuples class))
504         (f nil))
505     (while (and ia (not f))
506       (if (eq (cdr (car ia)) slot)
507           (setq f (car (car ia))))
508       (setq ia (cdr ia)))
509     f))
510
511 ;;; Object Set macros
512 ;;
513 (defmacro oset (obj slot value)
514   "Set the value in OBJ for slot SLOT to VALUE.
515 SLOT is the slot name as specified in `defclass' or the tag created
516 with in the :initarg slot.  VALUE can be any Lisp object."
517   (declare (debug (form symbolp form)))
518   `(eieio-oset ,obj (quote ,slot) ,value))
519
520 (defmacro oset-default (class slot value)
521   "Set the default slot in CLASS for SLOT to VALUE.
522 The default value is usually set with the :initform tag during class
523 creation.  This allows users to change the default behavior of classes
524 after they are created."
525   (declare (debug (form symbolp form)))
526   `(eieio-oset-default ,class (quote ,slot) ,value))
527
528 ;;; CLOS queries into classes and slots
529 ;;
530 (defun slot-boundp (object slot)
531   "Return non-nil if OBJECT's SLOT is bound.
532 Setting a slot's value makes it bound.  Calling `slot-makeunbound' will
533 make a slot unbound.
534 OBJECT can be an instance or a class."
535   ;; Skip typechecking while retrieving this value.
536   (let ((eieio-skip-typecheck t))
537     ;; Return nil if the magic symbol is in there.
538     (not (eq (cond
539               ((eieio-object-p object) (eieio-oref object slot))
540               ((symbolp object)        (eieio-oref-default object slot))
541               (t (signal 'wrong-type-argument (list 'eieio-object-p object))))
542              eieio-unbound))))
543
544 (defun slot-makeunbound (object slot)
545   "In OBJECT, make SLOT unbound."
546   (eieio-oset object slot eieio-unbound))
547
548 (defun slot-exists-p (object-or-class slot)
549   "Return non-nil if OBJECT-OR-CLASS has SLOT."
550   (let ((cv (cond ((eieio-object-p object-or-class)
551                    (eieio--object-class object-or-class))
552                   ((eieio--class-p object-or-class) object-or-class)
553                   (t (find-class object-or-class 'error)))))
554     (or (gethash slot (eieio--class-index-table cv))
555         ;; FIXME: We could speed this up by adding class slots into the
556         ;; index-table (e.g. with a negative index?).
557         (let ((cs (eieio--class-class-slots cv))
558               found)
559           (dotimes (i (length cs))
560             (if (eq slot (cl--slot-descriptor-name (aref cs i)))
561                 (setq found t)))
562           found))))
563
564 (defun find-class (symbol &optional errorp)
565   "Return the class that SYMBOL represents.
566 If there is no class, nil is returned if ERRORP is nil.
567 If ERRORP is non-nil, `wrong-argument-type' is signaled."
568   (let ((class (eieio--class-v symbol)))
569     (cond
570      ((eieio--class-p class) class)
571      (errorp (signal 'wrong-type-argument (list 'class-p symbol))))))
572
573 ;;; Slightly more complex utility functions for objects
574 ;;
575 (defun object-assoc (key slot list)
576   "Return an object if KEY is `equal' to SLOT's value of an object in LIST.
577 LIST is a list of objects whose slots are searched.
578 Objects in LIST do not need to have a slot named SLOT, nor does
579 SLOT need to be bound.  If these errors occur, those objects will
580 be ignored."
581   (cl-check-type list list)
582   (while (and list (not (condition-case nil
583                             ;; This prevents errors for missing slots.
584                             (equal key (eieio-oref (car list) slot))
585                           (error nil))))
586     (setq list (cdr list)))
587   (car list))
588
589 (defun object-assoc-list (slot list)
590   "Return an association list with the contents of SLOT as the key element.
591 LIST must be a list of objects with SLOT in it.
592 This is useful when you need to do completing read on an object group."
593   (cl-check-type list list)
594   (let ((assoclist nil))
595     (while list
596       (setq assoclist (cons (cons (eieio-oref (car list) slot)
597                                   (car list))
598                             assoclist))
599       (setq list (cdr list)))
600     (nreverse assoclist)))
601
602 (defun object-assoc-list-safe (slot list)
603   "Return an association list with the contents of SLOT as the key element.
604 LIST must be a list of objects, but those objects do not need to have
605 SLOT in it.  If it does not, then that element is left out of the association
606 list."
607   (cl-check-type list list)
608   (let ((assoclist nil))
609     (while list
610       (if (slot-exists-p (car list) slot)
611           (setq assoclist (cons (cons (eieio-oref (car list) slot)
612                                       (car list))
613                                 assoclist)))
614       (setq list (cdr list)))
615     (nreverse assoclist)))
616
617 (defun object-add-to-list (object slot item &optional append)
618   "In OBJECT's SLOT, add ITEM to the list of elements.
619 Optional argument APPEND indicates we need to append to the list.
620 If ITEM already exists in the list in SLOT, then it is not added.
621 Comparison is done with `equal' through the `member' function call.
622 If SLOT is unbound, bind it to the list containing ITEM."
623   (let (ov)
624     ;; Find the originating list.
625     (if (not (slot-boundp object slot))
626         (setq ov (list item))
627       (setq ov (eieio-oref object slot))
628       ;; turn it into a list.
629       (unless (listp ov)
630         (setq ov (list ov)))
631       ;; Do the combination
632       (if (not (member item ov))
633           (setq ov
634                 (if append
635                     (append ov (list item))
636                   (cons item ov)))))
637     ;; Set back into the slot.
638     (eieio-oset object slot ov)))
639
640 (defun object-remove-from-list (object slot item)
641   "In OBJECT's SLOT, remove occurrences of ITEM.
642 Deletion is done with `delete', which deletes by side effect,
643 and comparisons are done with `equal'.
644 If SLOT is unbound, do nothing."
645   (if (not (slot-boundp object slot))
646       nil
647     (eieio-oset object slot (delete item (eieio-oref object slot)))))
648
649 ;;; Here are some CLOS items that need the CL package
650 ;;
651
652 ;; FIXME: Shouldn't this be a more complex gv-expander which extracts the
653 ;; common code between oref and oset, so as to reduce the redundant work done
654 ;; in (push foo (oref bar baz)), like we do for the `nth' expander?
655 (gv-define-simple-setter eieio-oref eieio-oset)
656
657 \f
658 ;;;
659 ;; We want all objects created by EIEIO to have some default set of
660 ;; behaviors so we can create object utilities, and allow various
661 ;; types of error checking.  To do this, create the default EIEIO
662 ;; class, and when no parent class is specified, use this as the
663 ;; default.  (But don't store it in the other classes as the default,
664 ;; allowing for transparent support.)
665 ;;
666
667 (defclass eieio-default-superclass nil
668   nil
669   "Default parent class for classes with no specified parent class.
670 Its slots are automatically adopted by classes with no specified parents.
671 This class is not stored in the `parent' slot of a class vector."
672   :abstract t)
673
674 (setq eieio-default-superclass (eieio--class-v 'eieio-default-superclass))
675
676 (defalias 'standard-class 'eieio-default-superclass)
677
678 (cl-defgeneric make-instance (class &rest initargs)
679   "Make a new instance of CLASS based on INITARGS.
680 For example:
681
682   (make-instance 'foo)
683
684 INITARGS is a property list with keywords based on the `:initarg'
685 for each slot.  For example:
686
687   (make-instance 'foo :slot1 value1 :slotN valueN)")
688
689 (define-obsolete-function-alias 'constructor #'make-instance "25.1")
690
691 (cl-defmethod make-instance
692     ((class (subclass eieio-default-superclass)) &rest slots)
693   "Default constructor for CLASS `eieio-default-superclass'.
694 SLOTS are the initialization slots used by `initialize-instance'.
695 This static method is called when an object is constructed.
696 It allocates the vector used to represent an EIEIO object, and then
697 calls `initialize-instance' on that object."
698   (let* ((new-object (copy-sequence (eieio--class-default-object-cache
699                                      (eieio--class-object class)))))
700     (if (and slots
701              (let ((x (car slots)))
702                (or (stringp x) (null x))))
703         (funcall (if eieio-backward-compatibility #'ignore #'message)
704                  "Obsolete name %S passed to %S constructor"
705                  (pop slots) class))
706     ;; Call the initialize method on the new object with the slots
707     ;; that were passed down to us.
708     (initialize-instance new-object slots)
709     ;; Return the created object.
710     new-object))
711
712 ;; FIXME: CLOS uses "&rest INITARGS" instead.
713 (cl-defgeneric shared-initialize (obj slots)
714   "Set slots of OBJ with SLOTS which is a list of name/value pairs.
715 Called from the constructor routine.")
716
717 (cl-defmethod shared-initialize ((obj eieio-default-superclass) slots)
718   "Set slots of OBJ with SLOTS which is a list of name/value pairs.
719 Called from the constructor routine."
720   (while slots
721     (let ((rn (eieio--initarg-to-attribute (eieio--object-class obj)
722                                            (car slots))))
723       (if (not rn)
724           (slot-missing obj (car slots) 'oset (car (cdr slots)))
725         (eieio-oset obj rn (car (cdr slots)))))
726     (setq slots (cdr (cdr slots)))))
727
728 ;; FIXME: CLOS uses "&rest INITARGS" instead.
729 (cl-defgeneric initialize-instance (this &optional slots)
730   "Construct the new object THIS based on SLOTS.")
731
732 (cl-defmethod initialize-instance ((this eieio-default-superclass)
733                                 &optional slots)
734   "Construct the new object THIS based on SLOTS.
735 SLOTS is a tagged list where odd numbered elements are tags, and
736 even numbered elements are the values to store in the tagged slot.
737 If you overload the `initialize-instance', there you will need to
738 call `shared-initialize' yourself, or you can call `call-next-method'
739 to have this constructor called automatically.  If these steps are
740 not taken, then new objects of your class will not have their values
741 dynamically set from SLOTS."
742   ;; First, see if any of our defaults are `lambda', and
743   ;; re-evaluate them and apply the value to our slots.
744   (let* ((this-class (eieio--object-class this))
745          (slots (eieio--class-slots this-class)))
746     (dotimes (i (length slots))
747       ;; For each slot, see if we need to evaluate it.
748       ;;
749       ;; Paul Landes said in an email:
750       ;; > CL evaluates it if it can, and otherwise, leaves it as
751       ;; > the quoted thing as you already have.  This is by the
752       ;; > Sonya E. Keene book and other things I've look at on the
753       ;; > web.
754       (let* ((slot (aref slots i))
755              (initform (cl--slot-descriptor-initform slot))
756              (dflt (eieio-default-eval-maybe initform)))
757         (when (not (eq dflt initform))
758           ;; FIXME: We should be able to just do (aset this (+ i <cst>) dflt)!
759           (eieio-oset this (cl--slot-descriptor-name slot) dflt)))))
760   ;; Shared initialize will parse our slots for us.
761   (shared-initialize this slots))
762
763 (cl-defgeneric slot-missing (object slot-name operation &optional new-value)
764   "Method invoked when an attempt to access a slot in OBJECT fails.")
765
766 (cl-defmethod slot-missing ((object eieio-default-superclass) slot-name
767                          _operation &optional _new-value)
768   "Method invoked when an attempt to access a slot in OBJECT fails.
769 SLOT-NAME is the name of the failed slot, OPERATION is the type of access
770 that was requested, and optional NEW-VALUE is the value that was desired
771 to be set.
772
773 This method is called from `oref', `oset', and other functions which
774 directly reference slots in EIEIO objects."
775   (signal 'invalid-slot-name (list (eieio-object-name object)
776                                    slot-name)))
777
778 (cl-defgeneric slot-unbound (object class slot-name fn)
779   "Slot unbound is invoked during an attempt to reference an unbound slot.")
780
781 (cl-defmethod slot-unbound ((object eieio-default-superclass)
782                          class slot-name fn)
783   "Slot unbound is invoked during an attempt to reference an unbound slot.
784 OBJECT is the instance of the object being reference.  CLASS is the
785 class of OBJECT, and SLOT-NAME is the offending slot.  This function
786 throws the signal `unbound-slot'.  You can overload this function and
787 return the value to use in place of the unbound value.
788 Argument FN is the function signaling this error.
789 Use `slot-boundp' to determine if a slot is bound or not.
790
791 In CLOS, the argument list is (CLASS OBJECT SLOT-NAME), but
792 EIEIO can only dispatch on the first argument, so the first two are swapped."
793   (signal 'unbound-slot (list (eieio-class-name class)
794                               (eieio-object-name object)
795                               slot-name fn)))
796
797 (cl-defgeneric clone (obj &rest params)
798   "Make a copy of OBJ, and then supply PARAMS.
799 PARAMS is a parameter list of the same form used by `initialize-instance'.
800
801 When overloading `clone', be sure to call `call-next-method'
802 first and modify the returned object.")
803
804 (cl-defmethod clone ((obj eieio-default-superclass) &rest params)
805   "Make a copy of OBJ, and then apply PARAMS."
806   (let ((nobj (copy-sequence obj)))
807     (if (stringp (car params))
808         (funcall (if eieio-backward-compatibility #'ignore #'message)
809                  "Obsolete name %S passed to clone" (pop params)))
810     (if params (shared-initialize nobj params))
811     nobj))
812
813 (cl-defgeneric destructor (this &rest params)
814   "Destructor for cleaning up any dynamic links to our object.")
815
816 (cl-defmethod destructor ((_this eieio-default-superclass) &rest _params)
817   "Destructor for cleaning up any dynamic links to our object.
818 Argument THIS is the object being destroyed.  PARAMS are additional
819 ignored parameters."
820   ;; No cleanup... yet.
821   )
822
823 (cl-defgeneric object-print (this &rest strings)
824   "Pretty printer for object THIS.  Call function `object-name' with STRINGS.
825
826 It is sometimes useful to put a summary of the object into the
827 default #<notation> string when using EIEIO browsing tools.
828 Implement this method to customize the summary.")
829
830 (cl-defmethod object-print ((this eieio-default-superclass) &rest strings)
831   "Pretty printer for object THIS.  Call function `object-name' with STRINGS.
832 The default method for printing object THIS is to use the
833 function `object-name'.
834
835 It is sometimes useful to put a summary of the object into the
836 default #<notation> string when using EIEIO browsing tools.
837
838 Implement this function and specify STRINGS in a call to
839 `call-next-method' to provide additional summary information.
840 When passing in extra strings from child classes, always remember
841 to prepend a space."
842   (eieio-object-name this (apply #'concat strings)))
843
844 (defvar eieio-print-depth 0
845   "When printing, keep track of the current indentation depth.")
846
847 (cl-defgeneric object-write (this &optional comment)
848   "Write out object THIS to the current stream.
849 Optional COMMENT will add comments to the beginning of the output.")
850
851 (cl-defmethod object-write ((this eieio-default-superclass) &optional comment)
852   "Write object THIS out to the current stream.
853 This writes out the vector version of this object.  Complex and recursive
854 object are discouraged from being written.
855   If optional COMMENT is non-nil, include comments when outputting
856 this object."
857   (when comment
858     (princ ";; Object ")
859     (princ (eieio-object-name-string this))
860     (princ "\n")
861     (princ comment)
862     (princ "\n"))
863   (let* ((cl (eieio-object-class this))
864          (cv (eieio--class-v cl)))
865     ;; Now output readable lisp to recreate this object
866     ;; It should look like this:
867     ;; (<constructor> <name> <slot> <slot> ... )
868     ;; Each slot's slot is writen using its :writer.
869     (princ (make-string (* eieio-print-depth 2) ? ))
870     (princ "(")
871     (princ (symbol-name (eieio--class-constructor (eieio-object-class this))))
872     (princ " ")
873     (prin1 (eieio-object-name-string this))
874     (princ "\n")
875     ;; Loop over all the public slots
876     (let ((slots (eieio--class-slots cv))
877           (eieio-print-depth (1+ eieio-print-depth)))
878       (dotimes (i (length slots))
879         (let ((slot (aref slots i)))
880           (when (slot-boundp this (cl--slot-descriptor-name slot))
881             (let ((i (eieio--class-slot-initarg
882                       cv (cl--slot-descriptor-name slot)))
883                   (v (eieio-oref this (cl--slot-descriptor-name slot))))
884               (unless (or (not i) (equal v (cl--slot-descriptor-initform slot)))
885                 (unless (bolp)
886                   (princ "\n"))
887                 (princ (make-string (* eieio-print-depth 2) ? ))
888                 (princ (symbol-name i))
889                 (if (alist-get :printer (cl--slot-descriptor-props slot))
890                     ;; Use our public printer
891                     (progn
892                       (princ " ")
893                       (funcall (alist-get :printer
894                                           (cl--slot-descriptor-props slot))
895                                v))
896                   ;; Use our generic override prin1 function.
897                   (princ (if (or (eieio-object-p v)
898                                  (eieio-object-p (car-safe v)))
899                              "\n" " "))
900                   (eieio-override-prin1 v))))))))
901     (princ ")")
902     (when (= eieio-print-depth 0)
903       (princ "\n"))))
904
905 (defun eieio-override-prin1 (thing)
906   "Perform a `prin1' on THING taking advantage of object knowledge."
907   (cond ((eieio-object-p thing)
908          (object-write thing))
909         ((consp thing)
910          (eieio-list-prin1 thing))
911         ((eieio--class-p thing)
912          (princ (eieio--class-print-name thing)))
913         (t (prin1 thing))))
914
915 (defun eieio-list-prin1 (list)
916   "Display LIST where list may contain objects."
917   (if (not (eieio-object-p (car list)))
918       (progn
919         (princ "'")
920         (prin1 list))
921     (princ (make-string (* eieio-print-depth 2) ? ))
922     (princ "(list")
923     (let ((eieio-print-depth (1+ eieio-print-depth)))
924       (while list
925         (princ "\n")
926         (if (eieio-object-p (car list))
927             (object-write (car list))
928           (princ (make-string (* eieio-print-depth 2) ? ))
929           (eieio-override-prin1 (car list)))
930         (setq list (cdr list))))
931     (princ ")")))
932
933 \f
934 ;;; Unimplemented functions from CLOS
935 ;;
936 (defun change-class (_obj _class)
937   "Change the class of OBJ to type CLASS.
938 This may create or delete slots, but does not affect the return value
939 of `eq'."
940   (error "EIEIO: `change-class' is unimplemented"))
941
942 ;; Hook ourselves into help system for describing classes and methods.
943 (add-hook 'help-fns-describe-function-functions 'eieio-help-constructor)
944
945 ;;; Interfacing with edebug
946 ;;
947 (defun eieio-edebug-prin1-to-string (print-function object &optional noescape)
948   "Display EIEIO OBJECT in fancy format.
949
950 Used as advice around `edebug-prin1-to-string', held in the
951 variable PRINT-FUNCTION.  Optional argument NOESCAPE is passed to
952 `prin1-to-string' when appropriate."
953   (cond ((eieio--class-p object) (eieio--class-print-name object))
954         ((eieio-object-p object) (object-print object))
955         ((and (listp object) (or (eieio--class-p (car object))
956                                  (eieio-object-p (car object))))
957          (concat "(" (mapconcat
958                       (lambda (x) (eieio-edebug-prin1-to-string print-function x))
959                       object " ")
960                  ")"))
961         (t (funcall print-function object noescape))))
962
963 (advice-add 'edebug-prin1-to-string
964             :around #'eieio-edebug-prin1-to-string)
965
966 \f
967 ;;; Start of automatically extracted autoloads.
968 \f
969 ;;;### (autoloads nil "eieio-custom" "eieio-custom.el" "813d32fbf76d4248fc6b4dc97ebcd720")
970 ;;; Generated autoloads from eieio-custom.el
971
972 (autoload 'customize-object "eieio-custom" "\
973 Customize OBJ in a custom buffer.
974 Optional argument GROUP is the sub-group of slots to display.
975
976 \(fn OBJ &optional GROUP)" nil nil)
977
978 ;;;***
979 \f
980 ;;;### (autoloads nil "eieio-opt" "eieio-opt.el" "3005b815c6b30eccbf0642170b3f82a5")
981 ;;; Generated autoloads from eieio-opt.el
982
983 (autoload 'eieio-browse "eieio-opt" "\
984 Create an object browser window to show all objects.
985 If optional ROOT-CLASS, then start with that, otherwise start with
986 variable `eieio-default-superclass'.
987
988 \(fn &optional ROOT-CLASS)" t nil)
989
990 (autoload 'eieio-help-class "eieio-opt" "\
991 Print help description for CLASS.
992 If CLASS is actually an object, then also display current values of that object.
993
994 \(fn CLASS)" nil nil)
995
996 (autoload 'eieio-help-constructor "eieio-opt" "\
997 Describe CTR if it is a class constructor.
998
999 \(fn CTR)" nil nil)
1000
1001 ;;;***
1002 \f
1003 ;;; End of automatically extracted autoloads.
1004
1005 (provide 'eieio)
1006
1007 ;;; eieio ends here