Defines new editor modes.
A string containing the name of the mode being defined.
Name of function which sets up a buffer in this mode.
A quoted list of key-binding directions.
, the mode cannot be re-defined. The default value is
A quoted list of Editor variables and values.
A quoted list of synonyms for
Called upon exit from a buffer in this mode.
, the mode is defined as major, otherwise minor. The default value is
This function defines an Editor mode called
By default, any mode defined is a minor one--specification of major-mode status is made by supplying
is essentially for the purposes of mode specification--not all of the essential definitions required to establish a new Editor mode are made in a
call. In the example, below, other required calls are shown.
Key-bindings can be defined by supplying a quoted list of bindings, where a binding is a list containing as a first element the (string) name of the Editor command being bound, and as the second, the key binding description (see Advanced Features, for example key-bindings).
The state of Editor variables can be changed in the definition of a mode. These are supplied as a quoted list of dotted pairs, where the first element of the pair is the (symbol) name of the editor variable to be changed, and the second is the new value.
Let us define a minor mode,
has a set-up function, called
. All files with suffix
Here is the
(editor:defmode "Foo" :setup-function 'setup-foo-mode)
The next piece of code makes
(editor:define-file-type-hook ("foo") (buffer type)
(declare (ignore type))
(setf (editor:buffer-minor-mode buffer "Foo") t))
The next form defines the set-up function:
(defun setup-foo-mode (buffer)
(setf (editor:buffer-major-mode buffer) "Lisp")
(let ((pathname (editor:buffer-pathname buffer)))
(unless (and pathname
#.(format nil ";;; -*- mode :foo -*-~2%(in-package \"CL-USER\")~2%")))))
Now, any files loaded into the Editor with the suffix
LispWorks Editor User Guide (Macintosh version) - 14 Mar 2008