annotate lisp/emacs-lisp/eieio-base.el @ 112418:106bf56d370e

* lisp/subr.el (shell-quote-argument): Properly quote \n. Suggested by Flo <sensorflo@gmail.com>.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Fri, 21 Jan 2011 13:07:41 -0500
parents 376148b31b5e
children 417b1e4d63cd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
1 ;;; eieio-base.el --- Base classes for EIEIO.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
2
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 106840
diff changeset
3 ;;; Copyright (C) 2000, 2001, 2002, 2004, 2005, 2007, 2008, 2009, 2010, 2011
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
4 ;;; Free Software Foundation, Inc.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
5
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
7 ;; Version: 0.2
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
8 ;; Keywords: OO, lisp
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
9
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
10 ;; This file is part of GNU Emacs.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
11
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
14 ;; the Free Software Foundation, either version 3 of the License, or
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
15 ;; (at your option) any later version.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
16
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
20 ;; GNU General Public License for more details.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
21
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
24
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
25 ;;; Commentary:
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
26 ;;
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
27 ;; Base classes for EIEIO. These classes perform some basic tasks
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
28 ;; but are generally useless on their own. To use any of these classes,
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
29 ;; inherit from one or more of them.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
30
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
31 ;;; Code:
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
32
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
33 (require 'eieio)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
34
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
35 ;;; eieio-instance-inheritor
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
36 ;;
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
37 ;; Enable instance inheritance via the `clone' method.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
38 ;; Works by using the `slot-unbound' method which usually throws an
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
39 ;; error if a slot is unbound.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
40 (defclass eieio-instance-inheritor ()
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
41 ((parent-instance :initarg :parent-instance
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
42 :type eieio-instance-inheritor-child
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
43 :documentation
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
44 "The parent of this instance.
105474
0a64442c10e3 Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 105377
diff changeset
45 If a slot of this class is referenced, and is unbound, then the parent
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
46 is checked for a value.")
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
47 )
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
48 "This special class can enable instance inheritance.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
49 Use `clone' to make a new object that does instance inheritance from
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
50 a parent instance. When a slot in the child is referenced, and has
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
51 not been set, use values from the parent."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
52 :abstract t)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
53
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
54 (defmethod slot-unbound ((object eieio-instance-inheritor) class slot-name fn)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
55 "If a slot OBJECT in this CLASS is unbound, try to inherit, or throw a signal.
105474
0a64442c10e3 Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 105377
diff changeset
56 SLOT-NAME is the offending slot. FN is the function signalling the error."
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
57 (if (slot-boundp object 'parent-instance)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
58 ;; It may not look like it, but this line recurses back into this
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
59 ;; method if the parent instance's slot is unbound.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
60 (eieio-oref (oref object parent-instance) slot-name)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
61 ;; Throw the regular signal.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
62 (call-next-method)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
63
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
64 (defmethod clone ((obj eieio-instance-inheritor) &rest params)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
65 "Clone OBJ, initializing `:parent' to OBJ.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
66 All slots are unbound, except those initialized with PARAMS."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
67 (let ((nobj (make-vector (length obj) eieio-unbound))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
68 (nm (aref obj object-name))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
69 (passname (and params (stringp (car params))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
70 (num 1))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
71 (aset nobj 0 'object)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
72 (aset nobj object-class (aref obj object-class))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
73 ;; The following was copied from the default clone.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
74 (if (not passname)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
75 (save-match-data
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
76 (if (string-match "-\\([0-9]+\\)" nm)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
77 (setq num (1+ (string-to-number (match-string 1 nm)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
78 nm (substring nm 0 (match-beginning 0))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
79 (aset nobj object-name (concat nm "-" (int-to-string num))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
80 (aset nobj object-name (car params)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
81 ;; Now initialize from params.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
82 (if params (shared-initialize nobj (if passname (cdr params) params)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
83 (oset nobj parent-instance obj)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
84 nobj))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
85
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
86 (defmethod eieio-instance-inheritor-slot-boundp ((object eieio-instance-inheritor)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
87 slot)
105474
0a64442c10e3 Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 105377
diff changeset
88 "Return non-nil if the instance inheritor OBJECT's SLOT is bound.
0a64442c10e3 Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 105377
diff changeset
89 See `slot-boundp' for details on binding slots.
0a64442c10e3 Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 105377
diff changeset
90 The instance inheritor uses unbound slots as a way of cascading cloned
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
91 slot values, so testing for a slot being bound requires extra steps
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
92 for this kind of object."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
93 (if (slot-boundp object slot)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
94 ;; If it is regularly bound, return t.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
95 t
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
96 (if (slot-boundp object 'parent-instance)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
97 (eieio-instance-inheritor-slot-boundp (oref object parent-instance)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
98 slot)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
99 nil)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
100
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
101
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
102 ;;; eieio-instance-tracker
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
103 ;;
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
104 ;; Track all created instances of this class.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
105 ;; The class must initialize the `tracking-symbol' slot, and that
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
106 ;; symbol is then used to contain these objects.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
107 (defclass eieio-instance-tracker ()
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
108 ((tracking-symbol :type symbol
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
109 :allocation :class
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
110 :documentation
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
111 "The symbol used to maintain a list of our instances.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
112 The instance list is treated as a variable, with new instances added to it.")
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
113 )
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
114 "This special class enables instance tracking.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
115 Inheritors from this class must overload `tracking-symbol' which is
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
116 a variable symbol used to store a list of all instances."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
117 :abstract t)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
118
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
119 (defmethod initialize-instance :AFTER ((this eieio-instance-tracker)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
120 &rest slots)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
121 "Make sure THIS is in our master list of this class.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
122 Optional argument SLOTS are the initialization arguments."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
123 ;; Theoretically, this is never called twice for a given instance.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
124 (let ((sym (oref this tracking-symbol)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
125 (if (not (memq this (symbol-value sym)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
126 (set sym (append (symbol-value sym) (list this))))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
127
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
128 (defmethod delete-instance ((this eieio-instance-tracker))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
129 "Remove THIS from the master list of this class."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
130 (set (oref this tracking-symbol)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
131 (delq this (symbol-value (oref this tracking-symbol)))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
132
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
133 ;; In retrospect, this is a silly function.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
134 (defun eieio-instance-tracker-find (key slot list-symbol)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
135 "Find KEY as an element of SLOT in the objects in LIST-SYMBOL.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
136 Returns the first match."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
137 (object-assoc key slot (symbol-value list-symbol)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
138
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
139 ;;; eieio-singleton
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
140 ;;
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
141 ;; The singleton Design Pattern specifies that there is but one object
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
142 ;; of a given class ever created. The EIEIO singleton base class defines
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
143 ;; a CLASS allocated slot which contains the instance used. All calls to
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
144 ;; `make-instance' will either create a new instance and store it in this
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
145 ;; slot, or it will just return what is there.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
146 (defclass eieio-singleton ()
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
147 ((singleton :type eieio-singleton
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
148 :allocation :class
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
149 :documentation
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
150 "The only instance of this class that will be instantiated.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
151 Multiple calls to `make-instance' will return this object."))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
152 "This special class causes subclasses to be singletons.
106840
5df8e547a422 Fix typos in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 106815
diff changeset
153 A singleton is a class which will only ever have one instance."
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
154 :abstract t)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
155
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
156 (defmethod constructor :STATIC ((class eieio-singleton) name &rest slots)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
157 "Constructor for singleton CLASS.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
158 NAME and SLOTS initialize the new object.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
159 This constructor guarantees that no matter how many you request,
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
160 only one object ever exists."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
161 ;; NOTE TO SELF: In next version, make `slot-boundp' support classes
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
162 ;; with class allocated slots or default values.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
163 (let ((old (oref-default class singleton)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
164 (if (eq old eieio-unbound)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
165 (oset-default class singleton (call-next-method))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
166 old)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
167
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
168
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
169 ;;; eieio-persistent
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
170 ;;
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
171 ;; For objects which must save themselves to disk. Provides an
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
172 ;; `object-write' method to save an object to disk, and a
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
173 ;; `eieio-persistent-read' function to call to read an object
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
174 ;; from disk.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
175 ;;
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
176 ;; Also provide the method `eieio-persistent-path-relative' to
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
177 ;; calculate path names relative to a given instance. This will
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
178 ;; make the saved object location independent by converting all file
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
179 ;; references to be relative to the directory the object is saved to.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
180 ;; You must call `eieio-peristent-path-relative' on each file name
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
181 ;; saved in your object.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
182 (defclass eieio-persistent ()
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
183 ((file :initarg :file
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
184 :type string
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
185 :documentation
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
186 "The save file for this persistent object.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
187 This must be a string, and must be specified when the new object is
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
188 instantiated.")
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
189 (extension :type string
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
190 :allocation :class
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
191 :initform ".eieio"
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
192 :documentation
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
193 "Extension of files saved by this object.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
194 Enables auto-choosing nice file names based on name.")
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
195 (file-header-line :type string
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
196 :allocation :class
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
197 :initform ";; EIEIO PERSISTENT OBJECT"
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
198 :documentation
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
199 "Header line for the save file.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
200 This is used with the `object-write' method.")
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
201 (do-backups :type boolean
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
202 :allocation :class
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
203 :initform t
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
204 :documentation
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
205 "Saving this object should make backup files.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
206 Setting to nil will mean no backups are made."))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
207 "This special class enables persistence through save files
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
208 Use the `object-save' method to write this object to disk. The save
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
209 format is Emacs Lisp code which calls the constructor for the saved
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
210 object. For this reason, only slots which do not have an `:initarg'
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
211 specified will not be saved."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
212 :abstract t)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
213
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
214 (defmethod eieio-persistent-save-interactive ((this eieio-persistent) prompt
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
215 &optional name)
105474
0a64442c10e3 Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 105377
diff changeset
216 "Prepare to save THIS. Use in an `interactive' statement.
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
217 Query user for file name with PROMPT if THIS does not yet specify
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
218 a file. Optional argument NAME specifies a default file name."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
219 (unless (slot-boundp this 'file)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
220 (oset this file
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
221 (read-file-name prompt nil
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
222 (if name
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
223 (concat name (oref this extension))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
224 ))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
225 (oref this file))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
226
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
227 (defun eieio-persistent-read (filename)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
228 "Read a persistent object from FILENAME, and return it."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
229 (let ((ret nil)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
230 (buffstr nil))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
231 (unwind-protect
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
232 (progn
105813
df4934f25eef * textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105652
diff changeset
233 (with-current-buffer (get-buffer-create " *tmp eieio read*")
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
234 (insert-file-contents filename nil nil nil t)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
235 (goto-char (point-min))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
236 (setq buffstr (buffer-string)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
237 ;; Do the read in the buffer the read was initialized from
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
238 ;; so that any initialize-instance calls that depend on
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
239 ;; the current buffer will work.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
240 (setq ret (read buffstr))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
241 (if (not (child-of-class-p (car ret) 'eieio-persistent))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
242 (error "Corrupt object on disk"))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
243 (setq ret (eval ret))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
244 (oset ret file filename))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
245 (kill-buffer " *tmp eieio read*"))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
246 ret))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
247
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
248 (defmethod object-write ((this eieio-persistent) &optional comment)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
249 "Write persistent object THIS out to the current stream.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
250 Optional argument COMMENT is a header line comment."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
251 (call-next-method this (or comment (oref this file-header-line))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
252
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
253 (defmethod eieio-persistent-path-relative ((this eieio-persistent) file)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
254 "For object THIS, make absolute file name FILE relative."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
255 (file-relative-name (expand-file-name file)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
256 (file-name-directory (oref this file))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
257
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
258 (defmethod eieio-persistent-save ((this eieio-persistent) &optional file)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
259 "Save persistent object THIS to disk.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
260 Optional argument FILE overrides the file name specified in the object
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
261 instance."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
262 (save-excursion
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
263 (let ((b (set-buffer (get-buffer-create " *tmp object write*")))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
264 (default-directory (file-name-directory (oref this file)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
265 (cfn (oref this file)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
266 (unwind-protect
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
267 (save-excursion
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
268 (erase-buffer)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
269 (let ((standard-output (current-buffer)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
270 (oset this file
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
271 (if file
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
272 (eieio-persistent-path-relative this file)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
273 (file-name-nondirectory cfn)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
274 (object-write this (oref this file-header-line)))
105652
51bc239bdc37 * cedet/srecode/srt.el:
Chong Yidong <cyd@stupidchicken.com>
parents: 105474
diff changeset
275 (let ((backup-inhibited (not (oref this do-backups)))
51bc239bdc37 * cedet/srecode/srt.el:
Chong Yidong <cyd@stupidchicken.com>
parents: 105474
diff changeset
276 (cs (car (find-coding-systems-region
51bc239bdc37 * cedet/srecode/srt.el:
Chong Yidong <cyd@stupidchicken.com>
parents: 105474
diff changeset
277 (point-min) (point-max)))))
51bc239bdc37 * cedet/srecode/srt.el:
Chong Yidong <cyd@stupidchicken.com>
parents: 105474
diff changeset
278 (unless (eq cs 'undecided)
51bc239bdc37 * cedet/srecode/srt.el:
Chong Yidong <cyd@stupidchicken.com>
parents: 105474
diff changeset
279 (setq buffer-file-coding-system cs))
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
280 ;; Old way - write file. Leaves message behind.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
281 ;;(write-file cfn nil)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
282
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
283 ;; New way - Avoid the vast quantities of error checking
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
284 ;; just so I can get at the special flags that disable
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
285 ;; displaying random messages.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
286 (write-region (point-min) (point-max)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
287 cfn nil 1)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
288 ))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
289 ;; Restore :file, and kill the tmp buffer
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
290 (oset this file cfn)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
291 (setq buffer-file-name nil)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
292 (kill-buffer b)))))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
293
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
294 ;; Notes on the persistent object:
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
295 ;; It should also set up some hooks to help it keep itself up to date.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
296
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
297
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
298 ;;; Named object
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
299 ;;
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
300 ;; Named objects use the objects `name' as a slot, and that slot
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
301 ;; is accessed with the `object-name' symbol.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
302
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
303 (defclass eieio-named ()
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
304 ()
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
305 "Object with a name.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
306 Name storage already occurs in an object. This object provides get/set
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
307 access to it."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
308 :abstract t)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
309
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
310 (defmethod slot-missing ((obj eieio-named)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
311 slot-name operation &optional new-value)
106840
5df8e547a422 Fix typos in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 106815
diff changeset
312 "Called when a non-existent slot is accessed.
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
313 For variable `eieio-named', provide an imaginary `object-name' slot.
105474
0a64442c10e3 Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 105377
diff changeset
314 Argument OBJ is the named object.
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
315 Argument SLOT-NAME is the slot that was attempted to be accessed.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
316 OPERATION is the type of access, such as `oref' or `oset'.
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
317 NEW-VALUE is the value that was being set into SLOT if OPERATION were
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
318 a set type."
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
319 (if (or (eq slot-name 'object-name)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
320 (eq slot-name :object-name))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
321 (cond ((eq operation 'oset)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
322 (if (not (stringp new-value))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
323 (signal 'invalid-slot-type
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
324 (list obj slot-name 'string new-value)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
325 (object-set-name-string obj new-value))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
326 (t (object-name-string obj)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
327 (call-next-method)))
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
328
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
329 (provide 'eieio-base)
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
330
105377
7f4c7f5c0eba Add arch tagline
Miles Bader <miles@gnu.org>
parents: 104431
diff changeset
331 ;; arch-tag: 6260571e-9e8a-41a0-880f-a937b0c2ea8b
104431
a64f3429f0ac emacs-lisp/eieio-base.el, emacs-lisp/eieio-comp.el,
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
332 ;;; eieio-base.el ends here