Don't assume 'grep' supports GREP_OPTIONS.
[emacs.git] / lisp / emacs-lisp / eieio.el
1 ;;; eieio.el --- Enhanced Implementation of Emacs Interpreted Objects
2 ;;;              or maybe Eric's Implementation of Emacs Interpreted Objects
3
4 ;; Copyright (C) 1995-1996, 1998-2014 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 ;; 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.
41
42 ;; @TODO - fix :initform to be a form, not a quoted value
43 ;; @TODO - Prefix non-clos functions with `eieio-'.
44
45 ;;; Code:
46
47 (eval-when-compile (require 'cl))       ;FIXME: Use cl-lib!
48
49 (defvar eieio-version "1.4"
50   "Current version of EIEIO.")
51
52 (defun eieio-version ()
53   "Display the current version of EIEIO."
54   (interactive)
55   (message eieio-version))
56
57 (require 'eieio-core)
58
59 \f
60 ;;; Defining a new class
61 ;;
62 (defmacro defclass (name superclass slots &rest options-and-doc)
63   "Define NAME as a new class derived from SUPERCLASS with SLOTS.
64 OPTIONS-AND-DOC is used as the class' options and base documentation.
65 SUPERCLASS is a list of superclasses to inherit from, with SLOTS
66 being the slots residing in that class definition.  NOTE: Currently
67 only one slot may exist in SUPERCLASS as multiple inheritance is not
68 yet supported.  Supported tags are:
69
70   :initform   - Initializing form.
71   :initarg    - Tag used during initialization.
72   :accessor   - Tag used to create a function to access this slot.
73   :allocation - Specify where the value is stored.
74                 Defaults to `:instance', but could also be `:class'.
75   :writer     - A function symbol which will `write' an object's slot.
76   :reader     - A function symbol which will `read' an object.
77   :type       - The type of data allowed in this slot (see `typep').
78   :documentation
79               - A string documenting use of this slot.
80
81 The following are extensions on CLOS:
82   :protection - Specify protection for this slot.
83                 Defaults to `:public'.  Also use `:protected', or `:private'.
84   :custom     - When customizing an object, the custom :type.  Public only.
85   :label      - A text string label used for a slot when customizing.
86   :group      - Name of a customization group this slot belongs in.
87   :printer    - A function to call to print the value of a slot.
88                 See `eieio-override-prin1' as an example.
89
90 A class can also have optional options.  These options happen in place
91 of documentation (including a :documentation tag), in addition to
92 documentation, or not at all.  Supported options are:
93
94   :documentation - The doc-string used for this class.
95
96 Options added to EIEIO:
97
98   :allow-nil-initform - Non-nil to skip typechecking of null initforms.
99   :custom-groups      - List of custom group names.  Organizes slots into
100                         reasonable groups for customizations.
101   :abstract           - Non-nil to prevent instances of this class.
102                         If a string, use as an error string if someone does
103                         try to make an instance.
104   :method-invocation-order
105                       - Control the method invocation order if there is
106                         multiple inheritance.  Valid values are:
107                          :breadth-first - The default.
108                          :depth-first
109
110 Options in CLOS not supported in EIEIO:
111
112   :metaclass - Class to use in place of `standard-class'
113   :default-initargs - Initargs to use when initializing new objects of
114                       this class.
115
116 Due to the way class options are set up, you can add any tags you wish,
117 and reference them using the function `class-option'."
118   ;; This is eval-and-compile only to silence spurious compiler warnings
119   ;; about functions and variables not known to be defined.
120   ;; When eieio-defclass code is merged here and this becomes
121   ;; transparent to the compiler, the eval-and-compile can be removed.
122   `(eval-and-compile
123      (eieio-defclass ',name ',superclass ',slots ',options-and-doc)))
124
125
126 ;;; CLOS style implementation of object creators.
127 ;;
128 (defun make-instance (class &rest initargs)
129   "Make a new instance of CLASS based on INITARGS.
130 CLASS is a class symbol.  For example:
131
132   (make-instance 'foo)
133
134   INITARGS is a property list with keywords based on the :initarg
135 for each slot.  For example:
136
137   (make-instance 'foo :slot1 value1 :slotN valueN)
138
139 Compatibility note:
140
141 If the first element of INITARGS is a string, it is used as the
142 name of the class.
143
144 In EIEIO, the class' constructor requires a name for use when printing.
145 `make-instance' in CLOS doesn't use names the way Emacs does, so the
146 class is used as the name slot instead when INITARGS doesn't start with
147 a string."
148   (if (and (car initargs) (stringp (car initargs)))
149       (apply (class-constructor class) initargs)
150     (apply  (class-constructor class)
151             (cond ((symbolp class) (symbol-name class))
152                   (t (format "%S" class)))
153             initargs)))
154
155 \f
156 ;;; CLOS methods and generics
157 ;;
158 (defmacro defgeneric (method args &optional doc-string)
159   "Create a generic function METHOD.
160 DOC-STRING is the base documentation for this class.  A generic
161 function has no body, as its purpose is to decide which method body
162 is appropriate to use.  Uses `defmethod' to create methods, and calls
163 `defgeneric' for you.  With this implementation the ARGS are
164 currently ignored.  You can use `defgeneric' to apply specialized
165 top level documentation to a method."
166   `(eieio--defalias ',method
167                     (eieio--defgeneric-init-form ',method ,doc-string)))
168
169 (defmacro defmethod (method &rest args)
170   "Create a new METHOD through `defgeneric' with ARGS.
171
172 The optional second argument KEY is a specifier that
173 modifies how the method is called, including:
174    :before  - Method will be called before the :primary
175    :primary - The default if not specified
176    :after   - Method will be called after the :primary
177    :static  - First arg could be an object or class
178 The next argument is the ARGLIST.  The ARGLIST specifies the arguments
179 to the method as with `defun'.  The first argument can have a type
180 specifier, such as:
181   ((VARNAME CLASS) ARG2 ...)
182 where VARNAME is the name of the local variable for the method being
183 created.  The CLASS is a class symbol for a class made with `defclass'.
184 A DOCSTRING comes after the ARGLIST, and is optional.
185 All the rest of the args are the BODY of the method.  A method will
186 return the value of the last form in the BODY.
187
188 Summary:
189
190  (defmethod mymethod [:before | :primary | :after | :static]
191                      ((typearg class-name) arg2 &optional opt &rest rest)
192     \"doc-string\"
193      body)"
194   (let* ((key (if (keywordp (car args)) (pop args)))
195          (params (car args))
196          (arg1 (car params))
197          (fargs (if (consp arg1)
198                    (cons (car arg1) (cdr params))
199                  params))
200          (class (if (consp arg1) (nth 1 arg1)))
201          (code `(lambda ,fargs ,@(cdr args))))
202     `(progn
203        ;; Make sure there is a generic and the byte-compiler sees it.
204        (defgeneric ,method ,args
205          ,(or (documentation code)
206               (format "Generically created method `%s'." method)))
207        (eieio--defmethod ',method ',key ',class #',code))))
208
209 ;;; Get/Set slots in an object.
210 ;;
211 (defmacro oref (obj slot)
212   "Retrieve the value stored in OBJ in the slot named by SLOT.
213 Slot is the name of the slot when created by `defclass' or the label
214 created by the :initarg tag."
215   `(eieio-oref ,obj (quote ,slot)))
216
217 (defalias 'slot-value 'eieio-oref)
218 (defalias 'set-slot-value 'eieio-oset)
219
220 (defmacro oref-default (obj slot)
221   "Get the default value of OBJ (maybe a class) for SLOT.
222 The default value is the value installed in a class with the :initform
223 tag.  SLOT can be the slot name, or the tag specified by the :initarg
224 tag in the `defclass' call."
225   `(eieio-oref-default ,obj (quote ,slot)))
226
227 ;;; Handy CLOS macros
228 ;;
229 (defmacro with-slots (spec-list object &rest body)
230   "Bind SPEC-LIST lexically to slot values in OBJECT, and execute BODY.
231 This establishes a lexical environment for referring to the slots in
232 the instance named by the given slot-names as though they were
233 variables.  Within such a context the value of the slot can be
234 specified by using its slot name, as if it were a lexically bound
235 variable.  Both setf and setq can be used to set the value of the
236 slot.
237
238 SPEC-LIST is of a form similar to `let'.  For example:
239
240   ((VAR1 SLOT1)
241     SLOT2
242     SLOTN
243    (VARN+1 SLOTN+1))
244
245 Where each VAR is the local variable given to the associated
246 SLOT.  A slot specified without a variable name is given a
247 variable name of the same name as the slot."
248   (declare (indent 2))
249   ;; Transform the spec-list into a cl-symbol-macrolet spec-list.
250   (let ((mappings (mapcar (lambda (entry)
251                             (let ((var  (if (listp entry) (car entry) entry))
252                                   (slot (if (listp entry) (cadr entry) entry)))
253                               (list var `(slot-value ,object ',slot))))
254                           spec-list)))
255     (append (list 'cl-symbol-macrolet mappings)
256             body)))
257 \f
258 ;;; Simple generators, and query functions.  None of these would do
259 ;;  well embedded into an object.
260 ;;
261 (define-obsolete-function-alias
262   'object-class-fast #'eieio--object-class "24.4")
263
264 (defun eieio-object-name (obj &optional extra)
265   "Return a Lisp like symbol string for object OBJ.
266 If EXTRA, include that in the string returned to represent the symbol."
267   (eieio--check-type eieio-object-p obj)
268   (format "#<%s %s%s>" (symbol-name (eieio--object-class obj))
269           (eieio--object-name obj) (or extra "")))
270 (define-obsolete-function-alias 'object-name #'eieio-object-name "24.4")
271
272 (defun eieio-object-name-string (obj) "Return a string which is OBJ's name."
273   (eieio--check-type eieio-object-p obj)
274   (eieio--object-name obj))
275 (define-obsolete-function-alias
276   'object-name-string #'eieio-object-name-string "24.4")
277
278 (defun eieio-object-set-name-string (obj name)
279   "Set the string which is OBJ's NAME."
280   (eieio--check-type eieio-object-p obj)
281   (eieio--check-type stringp name)
282   (setf (eieio--object-name obj) name))
283 (define-obsolete-function-alias
284   'object-set-name-string 'eieio-object-set-name-string "24.4")
285
286 (defun eieio-object-class (obj) "Return the class struct defining OBJ."
287   (eieio--check-type eieio-object-p obj)
288   (eieio--object-class obj))
289 (define-obsolete-function-alias 'object-class #'eieio-object-class "24.4")
290 ;; CLOS name, maybe?
291 (define-obsolete-function-alias 'class-of #'eieio-object-class "24.4")
292
293 (defun eieio-object-class-name (obj)
294   "Return a Lisp like symbol name for OBJ's class."
295   (eieio--check-type eieio-object-p obj)
296   (eieio-class-name (eieio--object-class obj)))
297 (define-obsolete-function-alias
298   'object-class-name 'eieio-object-class-name "24.4")
299
300 (defun eieio-class-parents (class)
301   "Return parent classes to CLASS.  (overload of variable).
302
303 The CLOS function `class-direct-superclasses' is aliased to this function."
304   (eieio--check-type class-p class)
305   (eieio-class-parents-fast class))
306 (define-obsolete-function-alias 'class-parents #'eieio-class-parents "24.4")
307
308 (defun eieio-class-children (class)
309   "Return child classes to CLASS.
310 The CLOS function `class-direct-subclasses' is aliased to this function."
311   (eieio--check-type class-p class)
312   (eieio-class-children-fast class))
313 (define-obsolete-function-alias
314   'class-children #'eieio-class-children "24.4")
315
316 ;; Official CLOS functions.
317 (define-obsolete-function-alias
318   'class-direct-superclasses #'eieio-class-parents "24.4")
319 (define-obsolete-function-alias
320   'class-direct-subclasses #'eieio-class-children "24.4")
321
322 (defmacro eieio-class-parent (class)
323   "Return first parent class to CLASS.  (overload of variable)."
324   `(car (eieio-class-parents ,class)))
325 (define-obsolete-function-alias 'class-parent 'eieio-class-parent "24.4")
326
327 (defun same-class-p (obj class) "Return t if OBJ is of class-type CLASS."
328   (eieio--check-type class-p class)
329   (eieio--check-type eieio-object-p obj)
330   (same-class-fast-p obj class))
331
332 (defun object-of-class-p (obj class)
333   "Return non-nil if OBJ is an instance of CLASS or CLASS' subclasses."
334   (eieio--check-type eieio-object-p obj)
335   ;; class will be checked one layer down
336   (child-of-class-p (eieio--object-class obj) class))
337 ;; Backwards compatibility
338 (defalias 'obj-of-class-p 'object-of-class-p)
339
340 (defun child-of-class-p (child class)
341   "Return non-nil if CHILD class is a subclass of CLASS."
342   (eieio--check-type class-p class)
343   (eieio--check-type class-p child)
344   (let ((p nil))
345     (while (and child (not (eq child class)))
346       (setq p (append p (eieio--class-parent (class-v child)))
347             child (car p)
348             p (cdr p)))
349     (if child t)))
350
351 (defun object-slots (obj)
352   "Return list of slots available in OBJ."
353   (eieio--check-type eieio-object-p obj)
354   (eieio--class-public-a (class-v (eieio--object-class obj))))
355
356 (defun class-slot-initarg (class slot) "Fetch from CLASS, SLOT's :initarg."
357   (eieio--check-type class-p class)
358   (let ((ia (eieio--class-initarg-tuples (class-v class)))
359         (f nil))
360     (while (and ia (not f))
361       (if (eq (cdr (car ia)) slot)
362           (setq f (car (car ia))))
363       (setq ia (cdr ia)))
364     f))
365
366 ;;; Object Set macros
367 ;;
368 (defmacro oset (obj slot value)
369   "Set the value in OBJ for slot SLOT to VALUE.
370 SLOT is the slot name as specified in `defclass' or the tag created
371 with in the :initarg slot.  VALUE can be any Lisp object."
372   `(eieio-oset ,obj (quote ,slot) ,value))
373
374 (defmacro oset-default (class slot value)
375   "Set the default slot in CLASS for SLOT to VALUE.
376 The default value is usually set with the :initform tag during class
377 creation.  This allows users to change the default behavior of classes
378 after they are created."
379   `(eieio-oset-default ,class (quote ,slot) ,value))
380
381 ;;; CLOS queries into classes and slots
382 ;;
383 (defun slot-boundp (object slot)
384   "Return non-nil if OBJECT's SLOT is bound.
385 Setting a slot's value makes it bound.  Calling `slot-makeunbound' will
386 make a slot unbound.
387 OBJECT can be an instance or a class."
388   ;; Skip typechecking while retrieving this value.
389   (let ((eieio-skip-typecheck t))
390     ;; Return nil if the magic symbol is in there.
391     (not (eq (cond
392               ((eieio-object-p object) (eieio-oref object slot))
393               ((class-p object)        (eieio-oref-default object slot))
394               (t (signal 'wrong-type-argument (list 'eieio-object-p object))))
395              eieio-unbound))))
396
397 (defun slot-makeunbound (object slot)
398   "In OBJECT, make SLOT unbound."
399   (eieio-oset object slot eieio-unbound))
400
401 (defun slot-exists-p (object-or-class slot)
402   "Return non-nil if OBJECT-OR-CLASS has SLOT."
403   (let ((cv (class-v (cond ((eieio-object-p object-or-class)
404                             (eieio-object-class object-or-class))
405                            ((class-p object-or-class)
406                             object-or-class))
407                      )))
408     (or (memq slot (eieio--class-public-a cv))
409         (memq slot (eieio--class-class-allocation-a cv)))
410     ))
411
412 (defun find-class (symbol &optional errorp)
413   "Return the class that SYMBOL represents.
414 If there is no class, nil is returned if ERRORP is nil.
415 If ERRORP is non-nil, `wrong-argument-type' is signaled."
416   (if (not (class-p symbol))
417       (if errorp (signal 'wrong-type-argument (list 'class-p symbol))
418         nil)
419     (class-v symbol)))
420
421 ;;; Slightly more complex utility functions for objects
422 ;;
423 (defun object-assoc (key slot list)
424   "Return an object if KEY is `equal' to SLOT's value of an object in LIST.
425 LIST is a list of objects whose slots are searched.
426 Objects in LIST do not need to have a slot named SLOT, nor does
427 SLOT need to be bound.  If these errors occur, those objects will
428 be ignored."
429   (eieio--check-type listp list)
430   (while (and list (not (condition-case nil
431                             ;; This prevents errors for missing slots.
432                             (equal key (eieio-oref (car list) slot))
433                           (error nil))))
434     (setq list (cdr list)))
435   (car list))
436
437 (defun object-assoc-list (slot list)
438   "Return an association list with the contents of SLOT as the key element.
439 LIST must be a list of objects with SLOT in it.
440 This is useful when you need to do completing read on an object group."
441   (eieio--check-type listp list)
442   (let ((assoclist nil))
443     (while list
444       (setq assoclist (cons (cons (eieio-oref (car list) slot)
445                                   (car list))
446                             assoclist))
447       (setq list (cdr list)))
448     (nreverse assoclist)))
449
450 (defun object-assoc-list-safe (slot list)
451   "Return an association list with the contents of SLOT as the key element.
452 LIST must be a list of objects, but those objects do not need to have
453 SLOT in it.  If it does not, then that element is left out of the association
454 list."
455   (eieio--check-type listp list)
456   (let ((assoclist nil))
457     (while list
458       (if (slot-exists-p (car list) slot)
459           (setq assoclist (cons (cons (eieio-oref (car list) slot)
460                                       (car list))
461                                 assoclist)))
462       (setq list (cdr list)))
463     (nreverse assoclist)))
464
465 (defun object-add-to-list (object slot item &optional append)
466   "In OBJECT's SLOT, add ITEM to the list of elements.
467 Optional argument APPEND indicates we need to append to the list.
468 If ITEM already exists in the list in SLOT, then it is not added.
469 Comparison is done with `equal' through the `member' function call.
470 If SLOT is unbound, bind it to the list containing ITEM."
471   (let (ov)
472     ;; Find the originating list.
473     (if (not (slot-boundp object slot))
474         (setq ov (list item))
475       (setq ov (eieio-oref object slot))
476       ;; turn it into a list.
477       (unless (listp ov)
478         (setq ov (list ov)))
479       ;; Do the combination
480       (if (not (member item ov))
481           (setq ov
482                 (if append
483                     (append ov (list item))
484                   (cons item ov)))))
485     ;; Set back into the slot.
486     (eieio-oset object slot ov)))
487
488 (defun object-remove-from-list (object slot item)
489   "In OBJECT's SLOT, remove occurrences of ITEM.
490 Deletion is done with `delete', which deletes by side effect,
491 and comparisons are done with `equal'.
492 If SLOT is unbound, do nothing."
493   (if (not (slot-boundp object slot))
494       nil
495     (eieio-oset object slot (delete item (eieio-oref object slot)))))
496
497 ;;;
498 ;; Method Calling Functions
499
500 (defun next-method-p ()
501   "Return non-nil if there is a next method.
502 Returns a list of lambda expressions which is the `next-method'
503 order."
504   eieio-generic-call-next-method-list)
505
506 (defun call-next-method (&rest replacement-args)
507   "Call the superclass method from a subclass method.
508 The superclass method is specified in the current method list,
509 and is called the next method.
510
511 If REPLACEMENT-ARGS is non-nil, then use them instead of
512 `eieio-generic-call-arglst'.  The generic arg list are the
513 arguments passed in at the top level.
514
515 Use `next-method-p' to find out if there is a next method to call."
516   (if (not (eieio--scoped-class))
517       (error "`call-next-method' not called within a class specific method"))
518   (if (and (/= eieio-generic-call-key method-primary)
519            (/= eieio-generic-call-key method-static))
520       (error "Cannot `call-next-method' except in :primary or :static methods")
521     )
522   (let ((newargs (or replacement-args eieio-generic-call-arglst))
523         (next (car eieio-generic-call-next-method-list))
524         )
525     (if (or (not next) (not (car next)))
526         (apply 'no-next-method (car newargs) (cdr newargs))
527       (let* ((eieio-generic-call-next-method-list
528               (cdr eieio-generic-call-next-method-list))
529              (eieio-generic-call-arglst newargs)
530              (fcn (car next))
531              )
532         (eieio--with-scoped-class (cdr next)
533           (apply fcn newargs)) ))))
534
535 ;;; Here are some CLOS items that need the CL package
536 ;;
537
538 (defsetf eieio-oref eieio-oset)
539
540 (if (eval-when-compile (fboundp 'gv-define-expander))
541     ;; Not needed for Emacs>=24.3 since gv.el's setf expands macros and
542     ;; follows aliases.
543     nil
544 (defsetf slot-value eieio-oset)
545
546 ;; The below setf method was written by Arnd Kohrs <kohrs@acm.org>
547 (define-setf-method oref (obj slot)
548   (with-no-warnings
549     (require 'cl)
550     (let ((obj-temp (gensym))
551           (slot-temp (gensym))
552           (store-temp (gensym)))
553       (list (list obj-temp slot-temp)
554             (list obj `(quote ,slot))
555             (list store-temp)
556             (list 'set-slot-value obj-temp slot-temp
557                   store-temp)
558             (list 'slot-value obj-temp slot-temp))))))
559
560 \f
561 ;;;
562 ;; We want all objects created by EIEIO to have some default set of
563 ;; behaviors so we can create object utilities, and allow various
564 ;; types of error checking.  To do this, create the default EIEIO
565 ;; class, and when no parent class is specified, use this as the
566 ;; default.  (But don't store it in the other classes as the default,
567 ;; allowing for transparent support.)
568 ;;
569
570 (defclass eieio-default-superclass nil
571   nil
572   "Default parent class for classes with no specified parent class.
573 Its slots are automatically adopted by classes with no specified parents.
574 This class is not stored in the `parent' slot of a class vector."
575   :abstract t)
576
577 (defalias 'standard-class 'eieio-default-superclass)
578
579 (defgeneric constructor (class newname &rest slots)
580   "Default constructor for CLASS `eieio-default-superclass'.")
581
582 (defmethod constructor :static
583   ((class eieio-default-superclass) newname &rest slots)
584   "Default constructor for CLASS `eieio-default-superclass'.
585 NEWNAME is the name to be given to the constructed object.
586 SLOTS are the initialization slots used by `shared-initialize'.
587 This static method is called when an object is constructed.
588 It allocates the vector used to represent an EIEIO object, and then
589 calls `shared-initialize' on that object."
590   (let* ((new-object (copy-sequence (eieio--class-default-object-cache (class-v class)))))
591     ;; Update the name for the newly created object.
592     (setf (eieio--object-name new-object) newname)
593     ;; Call the initialize method on the new object with the slots
594     ;; that were passed down to us.
595     (initialize-instance new-object slots)
596     ;; Return the created object.
597     new-object))
598
599 (defgeneric shared-initialize (obj slots)
600   "Set slots of OBJ with SLOTS which is a list of name/value pairs.
601 Called from the constructor routine.")
602
603 (defmethod shared-initialize ((obj eieio-default-superclass) slots)
604   "Set slots of OBJ with SLOTS which is a list of name/value pairs.
605 Called from the constructor routine."
606   (eieio--with-scoped-class (eieio--object-class obj)
607     (while slots
608       (let ((rn (eieio-initarg-to-attribute (eieio--object-class obj)
609                                             (car slots))))
610         (if (not rn)
611             (slot-missing obj (car slots) 'oset (car (cdr slots)))
612           (eieio-oset obj rn (car (cdr slots)))))
613       (setq slots (cdr (cdr slots))))))
614
615 (defgeneric initialize-instance (this &optional slots)
616   "Construct the new object THIS based on SLOTS.")
617
618 (defmethod initialize-instance ((this eieio-default-superclass)
619                                 &optional slots)
620   "Construct the new object THIS based on SLOTS.
621 SLOTS is a tagged list where odd numbered elements are tags, and
622 even numbered elements are the values to store in the tagged slot.
623 If you overload the `initialize-instance', there you will need to
624 call `shared-initialize' yourself, or you can call `call-next-method'
625 to have this constructor called automatically.  If these steps are
626 not taken, then new objects of your class will not have their values
627 dynamically set from SLOTS."
628   ;; First, see if any of our defaults are `lambda', and
629   ;; re-evaluate them and apply the value to our slots.
630   (let* ((this-class (class-v (eieio--object-class this)))
631          (slot (eieio--class-public-a this-class))
632          (defaults (eieio--class-public-d this-class)))
633     (while slot
634       ;; For each slot, see if we need to evaluate it.
635       ;;
636       ;; Paul Landes said in an email:
637       ;; > CL evaluates it if it can, and otherwise, leaves it as
638       ;; > the quoted thing as you already have.  This is by the
639       ;; > Sonya E. Keene book and other things I've look at on the
640       ;; > web.
641       (let ((dflt (eieio-default-eval-maybe (car defaults))))
642         (when (not (eq dflt (car defaults)))
643           (eieio-oset this (car slot) dflt) ))
644       ;; Next.
645       (setq slot (cdr slot)
646             defaults (cdr defaults))))
647   ;; Shared initialize will parse our slots for us.
648   (shared-initialize this slots))
649
650 (defgeneric slot-missing (object slot-name operation &optional new-value)
651   "Method invoked when an attempt to access a slot in OBJECT fails.")
652
653 (defmethod slot-missing ((object eieio-default-superclass) slot-name
654                          operation &optional new-value)
655   "Method invoked when an attempt to access a slot in OBJECT fails.
656 SLOT-NAME is the name of the failed slot, OPERATION is the type of access
657 that was requested, and optional NEW-VALUE is the value that was desired
658 to be set.
659
660 This method is called from `oref', `oset', and other functions which
661 directly reference slots in EIEIO objects."
662   (signal 'invalid-slot-name (list (eieio-object-name object)
663                                    slot-name)))
664
665 (defgeneric slot-unbound (object class slot-name fn)
666   "Slot unbound is invoked during an attempt to reference an unbound slot.")
667
668 (defmethod slot-unbound ((object eieio-default-superclass)
669                          class slot-name fn)
670   "Slot unbound is invoked during an attempt to reference an unbound slot.
671 OBJECT is the instance of the object being reference.  CLASS is the
672 class of OBJECT, and SLOT-NAME is the offending slot.  This function
673 throws the signal `unbound-slot'.  You can overload this function and
674 return the value to use in place of the unbound value.
675 Argument FN is the function signaling this error.
676 Use `slot-boundp' to determine if a slot is bound or not.
677
678 In CLOS, the argument list is (CLASS OBJECT SLOT-NAME), but
679 EIEIO can only dispatch on the first argument, so the first two are swapped."
680   (signal 'unbound-slot (list (eieio-class-name class) (eieio-object-name object)
681                               slot-name fn)))
682
683 (defgeneric no-applicable-method (object method &rest args)
684   "Called if there are no implementations for OBJECT in METHOD.")
685
686 (defmethod no-applicable-method ((object eieio-default-superclass)
687                                  method &rest args)
688   "Called if there are no implementations for OBJECT in METHOD.
689 OBJECT is the object which has no method implementation.
690 ARGS are the arguments that were passed to METHOD.
691
692 Implement this for a class to block this signal.  The return
693 value becomes the return value of the original method call."
694   (signal 'no-method-definition (list method (eieio-object-name object)))
695   )
696
697 (defgeneric no-next-method (object &rest args)
698 "Called from `call-next-method' when no additional methods are available.")
699
700 (defmethod no-next-method ((object eieio-default-superclass)
701                            &rest args)
702   "Called from `call-next-method' when no additional methods are available.
703 OBJECT is othe object being called on `call-next-method'.
704 ARGS are the arguments it is called by.
705 This method signals `no-next-method' by default.  Override this
706 method to not throw an error, and its return value becomes the
707 return value of `call-next-method'."
708   (signal 'no-next-method (list (eieio-object-name object) args))
709   )
710
711 (defgeneric clone (obj &rest params)
712   "Make a copy of OBJ, and then supply PARAMS.
713 PARAMS is a parameter list of the same form used by `initialize-instance'.
714
715 When overloading `clone', be sure to call `call-next-method'
716 first and modify the returned object.")
717
718 (defmethod clone ((obj eieio-default-superclass) &rest params)
719   "Make a copy of OBJ, and then apply PARAMS."
720   (let ((nobj (copy-sequence obj))
721         (nm (eieio--object-name obj))
722         (passname (and params (stringp (car params))))
723         (num 1))
724     (if params (shared-initialize nobj (if passname (cdr params) params)))
725     (if (not passname)
726         (save-match-data
727           (if (string-match "-\\([0-9]+\\)" nm)
728               (setq num (1+ (string-to-number (match-string 1 nm)))
729                     nm (substring nm 0 (match-beginning 0))))
730           (setf (eieio--object-name nobj) (concat nm "-" (int-to-string num))))
731       (setf (eieio--object-name nobj) (car params)))
732     nobj))
733
734 (defgeneric destructor (this &rest params)
735   "Destructor for cleaning up any dynamic links to our object.")
736
737 (defmethod destructor ((this eieio-default-superclass) &rest params)
738   "Destructor for cleaning up any dynamic links to our object.
739 Argument THIS is the object being destroyed.  PARAMS are additional
740 ignored parameters."
741   ;; No cleanup... yet.
742   )
743
744 (defgeneric object-print (this &rest strings)
745   "Pretty printer for object THIS.  Call function `object-name' with STRINGS.
746
747 It is sometimes useful to put a summary of the object into the
748 default #<notation> string when using EIEIO browsing tools.
749 Implement this method to customize the summary.")
750
751 (defmethod object-print ((this eieio-default-superclass) &rest strings)
752   "Pretty printer for object THIS.  Call function `object-name' with STRINGS.
753 The default method for printing object THIS is to use the
754 function `object-name'.
755
756 It is sometimes useful to put a summary of the object into the
757 default #<notation> string when using EIEIO browsing tools.
758
759 Implement this function and specify STRINGS in a call to
760 `call-next-method' to provide additional summary information.
761 When passing in extra strings from child classes, always remember
762 to prepend a space."
763   (eieio-object-name this (apply 'concat strings)))
764
765 (defvar eieio-print-depth 0
766   "When printing, keep track of the current indentation depth.")
767
768 (defgeneric object-write (this &optional comment)
769   "Write out object THIS to the current stream.
770 Optional COMMENT will add comments to the beginning of the output.")
771
772 (defmethod object-write ((this eieio-default-superclass) &optional comment)
773   "Write object THIS out to the current stream.
774 This writes out the vector version of this object.  Complex and recursive
775 object are discouraged from being written.
776   If optional COMMENT is non-nil, include comments when outputting
777 this object."
778   (when comment
779     (princ ";; Object ")
780     (princ (eieio-object-name-string this))
781     (princ "\n")
782     (princ comment)
783     (princ "\n"))
784   (let* ((cl (eieio-object-class this))
785          (cv (class-v cl)))
786     ;; Now output readable lisp to recreate this object
787     ;; It should look like this:
788     ;; (<constructor> <name> <slot> <slot> ... )
789     ;; Each slot's slot is writen using its :writer.
790     (princ (make-string (* eieio-print-depth 2) ? ))
791     (princ "(")
792     (princ (symbol-name (class-constructor (eieio-object-class this))))
793     (princ " ")
794     (prin1 (eieio-object-name-string this))
795     (princ "\n")
796     ;; Loop over all the public slots
797     (let ((publa (eieio--class-public-a cv))
798           (publd (eieio--class-public-d cv))
799           (publp (eieio--class-public-printer cv))
800           (eieio-print-depth (1+ eieio-print-depth)))
801       (while publa
802         (when (slot-boundp this (car publa))
803           (let ((i (class-slot-initarg cl (car publa)))
804                 (v (eieio-oref this (car publa)))
805                 )
806             (unless (or (not i) (equal v (car publd)))
807               (unless (bolp)
808                 (princ "\n"))
809               (princ (make-string (* eieio-print-depth 2) ? ))
810               (princ (symbol-name i))
811               (if (car publp)
812                   ;; Use our public printer
813                   (progn
814                     (princ " ")
815                     (funcall (car publp) v))
816                 ;; Use our generic override prin1 function.
817                 (princ (if (or (eieio-object-p v)
818                                (eieio-object-p (car-safe v)))
819                            "\n" " "))
820                 (eieio-override-prin1 v)))))
821         (setq publa (cdr publa) publd (cdr publd)
822               publp (cdr publp))))
823     (princ ")")
824     (when (= eieio-print-depth 0)
825       (princ "\n"))))
826
827 (defun eieio-override-prin1 (thing)
828   "Perform a `prin1' on THING taking advantage of object knowledge."
829   (cond ((eieio-object-p thing)
830          (object-write thing))
831         ((consp thing)
832          (eieio-list-prin1 thing))
833         ((class-p thing)
834          (princ (eieio-class-name thing)))
835         ((or (keywordp thing) (booleanp thing))
836          (prin1 thing))
837         ((symbolp thing)
838          (princ (concat "'" (symbol-name thing))))
839         (t (prin1 thing))))
840
841 (defun eieio-list-prin1 (list)
842   "Display LIST where list may contain objects."
843   (if (not (eieio-object-p (car list)))
844       (progn
845         (princ "'")
846         (prin1 list))
847     (princ (make-string (* eieio-print-depth 2) ? ))
848     (princ "(list")
849     (let ((eieio-print-depth (1+ eieio-print-depth)))
850       (while list
851         (princ "\n")
852         (if (eieio-object-p (car list))
853             (object-write (car list))
854           (princ (make-string (* eieio-print-depth 2) ? ))
855           (eieio-override-prin1 (car list)))
856         (setq list (cdr list))))
857     (princ ")")))
858
859 \f
860 ;;; Unimplemented functions from CLOS
861 ;;
862 (defun change-class (obj class)
863   "Change the class of OBJ to type CLASS.
864 This may create or delete slots, but does not affect the return value
865 of `eq'."
866   (error "EIEIO: `change-class' is unimplemented"))
867
868 ;; Hook ourselves into help system for describing classes and methods.
869 (add-hook 'help-fns-describe-function-functions 'eieio-help-generic)
870 (add-hook 'help-fns-describe-function-functions 'eieio-help-constructor)
871
872 ;;; Interfacing with edebug
873 ;;
874 (defun eieio-edebug-prin1-to-string (object &optional noescape)
875   "Display EIEIO OBJECT in fancy format.
876 Overrides the edebug default.
877 Optional argument NOESCAPE is passed to `prin1-to-string' when appropriate."
878   (cond ((class-p object) (eieio-class-name object))
879         ((eieio-object-p object) (object-print object))
880         ((and (listp object) (or (class-p (car object))
881                                  (eieio-object-p (car object))))
882          (concat "(" (mapconcat 'eieio-edebug-prin1-to-string object " ") ")"))
883         (t (prin1-to-string object noescape))))
884
885 (add-hook 'edebug-setup-hook
886           (lambda ()
887             (def-edebug-spec defmethod
888               (&define                  ; this means we are defining something
889                [&or name ("setf" :name setf name)]
890                ;; ^^ This is the methods symbol
891                [ &optional symbolp ]    ; this is key :before etc
892                list              ; arguments
893                [ &optional stringp ]    ; documentation string
894                def-body                 ; part to be debugged
895                ))
896             ;; The rest of the macros
897             (def-edebug-spec oref (form quote))
898             (def-edebug-spec oref-default (form quote))
899             (def-edebug-spec oset (form quote form))
900             (def-edebug-spec oset-default (form quote form))
901             (def-edebug-spec class-v form)
902             (def-edebug-spec class-p form)
903             (def-edebug-spec eieio-object-p form)
904             (def-edebug-spec class-constructor form)
905             (def-edebug-spec generic-p form)
906             (def-edebug-spec with-slots (list list def-body))
907             ;; I suspect this isn't the best way to do this, but when
908             ;; cust-print was used on my system all my objects
909             ;; appeared as "#1 =" which was not useful.  This allows
910             ;; edebug to print my objects in the nice way they were
911             ;; meant to with `object-print' and `class-name'
912             ;; (defalias 'edebug-prin1-to-string 'eieio-edebug-prin1-to-string)
913             )
914           )
915
916 \f
917 ;;; Start of automatically extracted autoloads.
918 \f
919 ;;;### (autoloads nil "eieio-custom" "eieio-custom.el" "5b0e7b1beea11f9e9de6887279f75d61")
920 ;;; Generated autoloads from eieio-custom.el
921
922 (autoload 'customize-object "eieio-custom" "\
923 Customize OBJ in a custom buffer.
924 Optional argument GROUP is the sub-group of slots to display.
925
926 \(fn OBJ &optional GROUP)" nil nil)
927
928 ;;;***
929 \f
930 ;;;### (autoloads nil "eieio-opt" "eieio-opt.el" "99b94c63a73593402e3c825178a44f4f")
931 ;;; Generated autoloads from eieio-opt.el
932
933 (autoload 'eieio-browse "eieio-opt" "\
934 Create an object browser window to show all objects.
935 If optional ROOT-CLASS, then start with that, otherwise start with
936 variable `eieio-default-superclass'.
937
938 \(fn &optional ROOT-CLASS)" t nil)
939
940 (autoload 'eieio-help-class "eieio-opt" "\
941 Print help description for CLASS.
942 If CLASS is actually an object, then also display current values of that object.
943
944 \(fn CLASS)" nil nil)
945
946 (autoload 'eieio-help-constructor "eieio-opt" "\
947 Describe CTR if it is a class constructor.
948
949 \(fn CTR)" nil nil)
950
951 (autoload 'eieio-help-generic "eieio-opt" "\
952 Describe GENERIC if it is a generic function.
953
954 \(fn GENERIC)" nil nil)
955
956 ;;;***
957 \f
958 ;;; End of automatically extracted autoloads.
959
960 (provide 'eieio)
961
962 ;;; eieio ends here