@copying
This manual documents EIEIO, an object framework for Emacs Lisp.
-Copyright @copyright{} 2007, 2008, 2009 Free Software Foundation, Inc.
+Copyright @copyright{} 2007-2011 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@end quotation
@end copying
-@ifinfo
-@format
-START-INFO-DIR-ENTRY
-* eieio: (eieio). Objects for Emacs
-END-INFO-DIR-ENTRY
-@end format
-@end ifinfo
+@dircategory Emacs misc features
+@direntry
+* EIEIO: (eieio). An objects system for Emacs Lisp.
+@end direntry
@titlepage
@center @titlefont{@value{TITLE}}
@code{rec}, and ensures that the method defined above is called. If
@code{rec} is some other class lacking a @code{call-record} method, or
some other data type, Emacs signals a @code{no-method-definition}
-error. @ref{Signals}.
+error. @ref{Signals}.
@node Introduction
@comment node-name, next, previous, up
@menu
* Inheritance:: How to specify parents classes
-* Slot Options:: How to specify features of a slot.
-* Class Options:: How to specify features for this class.
+* Slot Options:: How to specify features of a slot.
+* Class Options:: How to specify features for this class.
@end menu
@node Inheritance
slot will instead be @code{(lambda () some-variablename)}.
After a class has been created with @code{defclass}, you can change
-that default value with @code{oset-default}. @ref{Accessing Slots}.
+that default value with @code{oset-default}. @ref{Accessing Slots}.
@item :type
An unquoted type specifier used to validate data set into this slot.
@item :printer
This routine takes a symbol which is a function name. The function
-should accept one argument. The a rgument is the value from the slot
+should accept one argument. The argument is the value from the slot
to be printed. The function in @code{object-write} will write the
slot value out to a printable form on @code{standard-output}.
-The output format MUST be something that could in turn be interpreted
+The output format MUST be something that could in turn be interpreted
with @code{read} such that the object can be brought back in from the
output stream. Thus, if you wanted to output a symbol, you would need
to quote the symbol. If you wanted to run a function on load, you
@comment node-name, next, previous, up
@chapter Making New Objects
-Suppose we have defined a simple class is defined, such as:
+Suppose we have a simple class is defined, such as:
@example
(defclass record ()
@end defun
-To create an object from a class symbol, use use @code{make-instance}.
+To create an object from a class symbol, use @code{make-instance}.
@defun make-instance class &rest initargs
@anchor{make-instance}
(make-instance @code{'foo} @code{:slot1} value1 @code{:slotN} valueN)
@end example
-Compatability note:
+Compatibility note:
If the first element of @var{initargs} is a string, it is used as the
name of the class.
@var{value}.
This allows the user to set both public and private defaults after the
-class has been constructed, and provides a way to to configure the
+class has been constructed, and provides a way to configure the
default behavior of packages built with classes (the same way
@code{setq-default} does for buffer-local variables).
@end example
Where each @var{var} is the local variable given to the associated
-@var{slot}. A Slot specified without a variable name is given a
+@var{slot}. A slot specified without a variable name is given a
variable name of the same name as the slot.
@example
@defun class-constructor class
Return a symbol used as a constructor for @var{class}. The
constructor is a function used to create new instances of
-@var{CLASS}. This function provides a way to make an object of a class
+@var{CLASS}. This function provides a way to make an object of a class
without knowing what it is. This is not a part of CLOS.
@end defun
@defun object-name obj
Return a string of the form @samp{#<object-class myobjname>} for @var{obj}.
-This should look like Lisp symbols from other parts of emacs such as
+This should look like Lisp symbols from other parts of Emacs such as
buffers and processes, and is shorter and cleaner than printing the
object's vector. It is more useful to use @code{object-print} to get
and object's print form, as this allows the object to add extra display
@defun object-assoc key slot list
@anchor{object-assoc}
Return an object if @var{key} is @dfn{equal} to SLOT's value of an object in @var{list}.
-@var{list} is a list of objects who's slots are searched.
+@var{list} is a list of objects whose slots are searched.
Objects in @var{list} do not need to have a slot named @var{slot}, nor does
@var{slot} need to be bound. If these errors occur, those objects will
be ignored.
objects to have all slots unbound. This class' @code{slot-unbound}
method will cause references to unbound slots to be redirected to the
parent instance. If the parent slot is also unbound, then
-@code{slot-unbound} will signal an an error named @code{slot-unbound}.
+@code{slot-unbound} will signal an error named @code{slot-unbound}.
@node eieio-instance-tracker
@section @code{eieio-instance-tracker}
This convenience function lets you find instances. @var{key} is the
value to search for. @var{slot} is the slot to compare @var{KEY}
against. The function @code{equal} is used for comparison.
-The paramter @var{list-symbol} is the variable symbol which contains the
+The parameter @var{list-symbol} is the variable symbol which contains the
list of objects to be searched.
@end deffn
This class is in package @file{eieio-speedbar}.
If a series of class instances map to a tree structure, it is possible
-to cause your classes to be displayable in Speedbar. @xref{Top,,,speedbar}.
+to cause your classes to be displayable in Speedbar. @xref{Top,,,speedbar}.
Inheriting from these classes will enable a speedbar major display mode
with a minimum of effort.
@chapter Browsing class trees
The command @kbd{M-x eieio-browse} displays a buffer listing all the
-currently loaded classes in emacs. The classes are listed in an
+currently loaded classes in Emacs. The classes are listed in an
indented tree structure, starting from @code{eieio-default-superclass}
(@pxref{Default Superclass}).
@chapter Class Values
Details about any class or object can be retrieved using the function
-@code{eieio-describe-class} function. Interactively, type in the name of
+@code{eieio-describe-class}. Interactively, type in the name of
a class. In a program, pass it a string with the name of a class, a
class symbol, or an object. The resulting buffer will display all slot
names.
-Additionally, all methods defined to have functionality on this class is
-displayed.
+Additionally, all methods defined to have functionality on this class
+are displayed.
@node Default Superclass
@comment node-name, next, previous, up
@chapter Default Superclass
-All defined classes, if created with no specified parent class) will
+All defined classes, if created with no specified parent class, will
inherit from a special class stored in
@code{eieio-default-superclass}. This superclass is quite simple, but
with it, certain default methods or attributes can be added to all
@node Basic Methods
@section Basic Methods
-Additional useful methods defined on the base sublcass are:
+Additional useful methods defined on the base subclass are:
@defun clone obj &rest params
@anchor{clone}
(cons (format " value: %s" (render this)) strings)))
@end example
-here is what some output could look like:
+Here is what some output could look like:
@example
(object-print test-object)
=> #<data-object test-object value: 3>
behavior that occurs during one of these error cases, or even ignore
the error by providing some behavior.
-@defun slot-missing ab &rest foo
+@defun slot-missing object slot-name operation &optional new-value
@anchor{slot-missing}
Method invoked when an attempt to access a slot in @var{object} fails.
@var{slot-name} is the name of the failed slot, @var{operation} is the type of access
@anchor{no-next-method}
Called from @dfn{call-next-method} when no additional methods are available.
@var{object} is othe object being called on @dfn{call-next-method}.
-@var{args} are the arguments it is called by.
+@var{args} are the arguments it is called by.
This method signals @dfn{no-next-method} by default. Override this
-method to not throw an error, and it's return value becomes the
+method to not throw an error, and its return value becomes the
return value of @dfn{call-next-method}.
@end defun
@comment node-name, next, previous, up
@chapter Naming Conventions
-@pxref{Standards,,,elisp,GNU Emacs Lisp Reference Manual}, for a
-description of Emacs Lisp programming conventions. These conventions
-help ensure that Emacs packages work nicely one another, so an
-@eieio{}-based program should follow them. Here are some conventions
-that apply specifically to @eieio{}-based programs:
+@xref{Tips,,Tips and Conventions,elisp,GNU Emacs Lisp Reference
+Manual}, for a description of Emacs Lisp programming conventions.
+These conventions help ensure that Emacs packages work nicely one
+another, so an @eieio{}-based program should follow them. Here are
+some conventions that apply specifically to @eieio{}-based programs:
@itemize
@item :type
Specifier uses the @code{typep} function from the @file{cl}
-package. @xref{(cl)Type Predicates}. It therefore has the same issues as
+package. @xref{(cl)Type Predicates}. It therefore has the same issues as
that package. Extensions include the ability to provide object names.
@end table
Calls defgeneric, and accepts most of the expected arguments. Only
the first argument to the created method may have a type specifier.
To type cast against a class, the class must exist before defmethod is
-called. In addition, the @code{:around} tag is not supported.
+called. In addition, the @code{:around} tag is not supported.
@item call-next-method
Inside a method, calls the next available method up the inheritance tree
@chapter Wish List
@eieio{} is an incomplete implementation of CLOS. Finding ways to
-improve the compatability would help make CLOS style programs run
+improve the compatibility would help make CLOS style programs run
better in Emacs.
-Some important compatability features that would be good to add are:
+Some important compatibility features that would be good to add are:
@enumerate
@item
HCoop / bpt / emacs.git / blobdiff