Mercurial > emacs
annotate lisp/derived.el @ 47360:c17030759a04
(define-derived-mode): Add keyword arguments.
(derived-mode-make-docstring): Take abbrev and syntax table names.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Mon, 09 Sep 2002 23:55:56 +0000 |
parents | fb621b18f76e |
children | be1386f066bb |
rev | line source |
---|---|
38412
253f761ad37b
Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents:
34323
diff
changeset
|
1 ;;; derived.el --- allow inheritance of major modes |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
2 ;;; (formerly mode-clone.el) |
5765 | 3 |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
4 ;; Copyright (C) 1993, 1994, 1999 Free Software Foundation, Inc. |
5765 | 5 |
6 ;; Author: David Megginson (dmeggins@aix1.uottawa.ca) | |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
7 ;; Maintainer: FSF |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
8 ;; Keywords: extensions |
5765 | 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 2, or (at your option) | |
15 ;; 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 | |
14169 | 23 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 ;; Boston, MA 02111-1307, USA. | |
5765 | 26 |
27 ;;; Commentary: | |
28 | |
29 ;; GNU Emacs is already, in a sense, object oriented -- each object | |
30 ;; (buffer) belongs to a class (major mode), and that class defines | |
31 ;; the relationship between messages (input events) and methods | |
32 ;; (commands) by means of a keymap. | |
33 ;; | |
34 ;; The only thing missing is a good scheme of inheritance. It is | |
35 ;; possible to simulate a single level of inheritance with generous | |
36 ;; use of hooks and a bit of work -- sgml-mode, for example, also runs | |
37 ;; the hooks for text-mode, and keymaps can inherit from other keymaps | |
38 ;; -- but generally, each major mode ends up reinventing the wheel. | |
39 ;; Ideally, someone should redesign all of Emacs's major modes to | |
40 ;; follow a more conventional object-oriented system: when defining a | |
41 ;; new major mode, the user should need only to name the existing mode | |
42 ;; it is most similar to, then list the (few) differences. | |
43 ;; | |
44 ;; In the mean time, this package offers most of the advantages of | |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
45 ;; full inheritance with the existing major modes. The macro |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
46 ;; `define-derived-mode' allows the user to make a variant of an existing |
5765 | 47 ;; major mode, with its own keymap. The new mode will inherit the key |
48 ;; bindings of its parent, and will, in fact, run its parent first | |
49 ;; every time it is called. For example, the commands | |
50 ;; | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
51 ;; (define-derived-mode hypertext-mode text-mode "Hypertext" |
5765 | 52 ;; "Major mode for hypertext.\n\n\\{hypertext-mode-map}" |
53 ;; (setq case-fold-search nil)) | |
54 ;; | |
55 ;; (define-key hypertext-mode-map [down-mouse-3] 'do-hyper-link) | |
56 ;; | |
57 ;; will create a function `hypertext-mode' with its own (sparse) | |
58 ;; keymap `hypertext-mode-map.' The command M-x hypertext-mode will | |
59 ;; perform the following actions: | |
60 ;; | |
61 ;; - run the command (text-mode) to get its default setup | |
62 ;; - replace the current keymap with 'hypertext-mode-map,' which will | |
63 ;; inherit from 'text-mode-map'. | |
64 ;; - replace the current syntax table with | |
65 ;; 'hypertext-mode-syntax-table', which will borrow its defaults | |
66 ;; from the current text-mode-syntax-table. | |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
67 ;; - replace the current abbrev table with |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
68 ;; 'hypertext-mode-abbrev-table', which will borrow its defaults |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
69 ;; from the current text-mode-abbrev table |
5765 | 70 ;; - change the mode line to read "Hypertext" |
71 ;; - assign the value 'hypertext-mode' to the 'major-mode' variable | |
72 ;; - run the body of commands provided in the macro -- in this case, | |
73 ;; set the local variable `case-fold-search' to nil. | |
74 ;; | |
75 ;; The advantages of this system are threefold. First, text mode is | |
76 ;; untouched -- if you had added the new keystroke to `text-mode-map,' | |
77 ;; possibly using hooks, you would have added it to all text buffers | |
78 ;; -- here, it appears only in hypertext buffers, where it makes | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
79 ;; sense. Second, it is possible to build even further, and make |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
80 ;; a derived mode from a derived mode. The commands |
5765 | 81 ;; |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
82 ;; (define-derived-mode html-mode hypertext-mode "HTML") |
5765 | 83 ;; [various key definitions] |
40344
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
84 ;; |
5765 | 85 ;; will add a new major mode for HTML with very little fuss. |
86 ;; | |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
87 ;; Note also the function `derived-mode-p' which can tell if the current |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
88 ;; mode derives from another. In a hypertext-mode, buffer, for example, |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
89 ;; (derived-mode-p 'text-mode) would return non-nil. This should always |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
90 ;; be used in place of (eq major-mode 'text-mode). |
5765 | 91 |
92 ;;; Code: | |
93 | |
40344
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
94 ;;; PRIVATE: defsubst must be defined before they are first used |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
95 |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
96 (defsubst derived-mode-hook-name (mode) |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
97 "Construct the mode hook name based on mode name MODE." |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
98 (intern (concat (symbol-name mode) "-hook"))) |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
99 |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
100 (defsubst derived-mode-map-name (mode) |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
101 "Construct a map name based on a MODE name." |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
102 (intern (concat (symbol-name mode) "-map"))) |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
103 |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
104 (defsubst derived-mode-syntax-table-name (mode) |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
105 "Construct a syntax-table name based on a MODE name." |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
106 (intern (concat (symbol-name mode) "-syntax-table"))) |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
107 |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
108 (defsubst derived-mode-abbrev-table-name (mode) |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
109 "Construct an abbrev-table name based on a MODE name." |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
110 (intern (concat (symbol-name mode) "-abbrev-table"))) |
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
111 |
5765 | 112 ;; PUBLIC: define a new major mode which inherits from an existing one. |
113 | |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
114 ;;;###autoload |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
115 (defmacro define-derived-mode (child parent name &optional docstring &rest body) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
116 "Create a new mode as a variant of an existing mode. |
5765 | 117 |
118 The arguments to this command are as follow: | |
119 | |
10401
598ca194bb60
(define-derived-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7798
diff
changeset
|
120 CHILD: the name of the command for the derived mode. |
39553
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
121 PARENT: the name of the command for the parent mode (e.g. `text-mode') |
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
122 or nil if there is no parent. |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
123 NAME: a string which will appear in the status line (e.g. \"Hypertext\") |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
124 DOCSTRING: an optional documentation string--if you do not supply one, |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
125 the function will attempt to invent something useful. |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
126 BODY: forms to execute just before running the |
40917
b5584ab9e544
(define-derived-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
40344
diff
changeset
|
127 hooks for the new mode. Do not use `interactive' here. |
5765 | 128 |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
129 BODY can start with a bunch of keyword arguments. The following keyword |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
130 arguments are currently understood: |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
131 :group GROUP |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
132 Declare the customization group that corresponds to this mode. |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
133 :syntax-table TABLE |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
134 Use TABLE instead of the default. |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
135 A nil value means to simply use the same syntax-table as the parent. |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
136 :abbrev-table TABLE |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
137 Use TABLE instead of the default. |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
138 A nil value means to simply use the same abbrev-table as the parent. |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
139 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
140 Here is how you could define LaTeX-Thesis mode as a variant of LaTeX mode: |
5765 | 141 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
142 (define-derived-mode LaTeX-thesis-mode LaTeX-mode \"LaTeX-Thesis\") |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
143 |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
144 You could then make new key bindings for `LaTeX-thesis-mode-map' |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
145 without changing regular LaTeX mode. In this example, BODY is empty, |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
146 and DOCSTRING is generated by default. |
5765 | 147 |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
148 On a more complicated level, the following command uses `sgml-mode' as |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
149 the parent, and then sets the variable `case-fold-search' to nil: |
5765 | 150 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
151 (define-derived-mode article-mode sgml-mode \"Article\" |
5765 | 152 \"Major mode for editing technical articles.\" |
153 (setq case-fold-search nil)) | |
154 | |
155 Note that if the documentation string had been left out, it would have | |
156 been generated automatically, with a reference to the keymap." | |
157 | |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
158 (when (and docstring (not (stringp docstring))) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
159 ;; Some trickiness, since what appears to be the docstring may really be |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
160 ;; the first element of the body. |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
161 (push docstring body) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
162 (setq docstring nil)) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
163 |
39553
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
164 (when (eq parent 'fundamental-mode) (setq parent nil)) |
5765 | 165 |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
166 (let ((map (derived-mode-map-name child)) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
167 (syntax (derived-mode-syntax-table-name child)) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
168 (abbrev (derived-mode-abbrev-table-name child)) |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
169 (declare-abbrev t) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
170 (declare-syntax t) |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
171 (hook (derived-mode-hook-name child)) |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
172 (group nil)) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
173 |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
174 ;; Process the keyword args. |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
175 (while (keywordp (car body)) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
176 (case (pop body) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
177 (:group (setq group (pop body))) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
178 (:abbrev-table (setq abbrev (pop body)) (setq declare-abbrev nil)) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
179 (:syntax-table (setq syntax (pop body)) (setq declare-syntax nil)))) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
180 |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
181 |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
182 (setq docstring (derived-mode-make-docstring |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
183 parent child docstring syntax abbrev)) |
40344
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
184 |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
185 `(progn |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
186 (defvar ,map (make-sparse-keymap)) |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
187 ,(if declare-syntax |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
188 `(defvar ,syntax (make-syntax-table))) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
189 ,(if declare-abbrev |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
190 `(defvar ,abbrev |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
191 (progn (define-abbrev-table ',abbrev nil) ,abbrev))) |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
192 (put ',child 'derived-mode-parent ',parent) |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
193 ,(if group `(put ',child 'custom-group ,group)) |
40344
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
194 |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
195 (defun ,child () |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
196 ,docstring |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
197 (interactive) |
5765 | 198 ; Run the parent. |
40283
628cde7da5bc
(define-derived-mode): Use {delay,run}-mode-hooks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39553
diff
changeset
|
199 (delay-mode-hooks |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
200 |
39553
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
201 (,(or parent 'kill-all-local-variables)) |
5765 | 202 ; Identify the child mode. |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
203 (setq major-mode (quote ,child)) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
204 (setq mode-name ,name) |
39553
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
205 ; Identify special modes. |
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
206 ,(when parent |
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
207 `(progn |
46072
fb621b18f76e
(define-derived-mode): Preserve `mode-class' rather than `special' property.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41976
diff
changeset
|
208 (if (get (quote ,parent) 'mode-class) |
fb621b18f76e
(define-derived-mode): Preserve `mode-class' rather than `special' property.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41976
diff
changeset
|
209 (put (quote ,child) 'mode-class |
fb621b18f76e
(define-derived-mode): Preserve `mode-class' rather than `special' property.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41976
diff
changeset
|
210 (get (quote ,parent) 'mode-class))) |
5765 | 211 ; Set up maps and tables. |
39553
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
212 (unless (keymap-parent ,map) |
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
213 (set-keymap-parent ,map (current-local-map))) |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
214 ,(when declare-syntax |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
215 `(let ((parent (char-table-parent ,syntax))) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
216 (unless (and parent |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
217 (not (eq parent (standard-syntax-table)))) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
218 (set-char-table-parent ,syntax (syntax-table))))) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
219 ,(when declare-abbrev |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
220 `(when local-abbrev-table |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
221 (mapatoms |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
222 (lambda (symbol) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
223 (or (intern-soft (symbol-name symbol) ,abbrev) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
224 (define-abbrev ,abbrev |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
225 (symbol-name symbol) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
226 (symbol-value symbol) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
227 (symbol-function symbol)))) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
228 local-abbrev-table))))) |
40344
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
229 |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
230 (use-local-map ,map) |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
231 ,(when syntax `(set-syntax-table ,syntax)) |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
232 ,(when abbrev `(setq local-abbrev-table ,abbrev)) |
5765 | 233 ; Splice in the body (if any). |
34323
1e0fd85c0b60
(define-derived-mode): Don't use combine-run-hooks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34148
diff
changeset
|
234 ,@body |
40283
628cde7da5bc
(define-derived-mode): Use {delay,run}-mode-hooks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39553
diff
changeset
|
235 ) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
236 ; Run the hooks, if any. |
40283
628cde7da5bc
(define-derived-mode): Use {delay,run}-mode-hooks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39553
diff
changeset
|
237 (run-mode-hooks ',hook))))) |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
238 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
239 ;; PUBLIC: find the ultimate class of a derived mode. |
5765 | 240 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
241 (defun derived-mode-class (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
242 "Find the class of a major MODE. |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
243 A mode's class is the first ancestor which is NOT a derived mode. |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
244 Use the `derived-mode-parent' property of the symbol to trace backwards. |
46072
fb621b18f76e
(define-derived-mode): Preserve `mode-class' rather than `special' property.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41976
diff
changeset
|
245 Since major-modes might all derive from `fundamental-mode', this function |
fb621b18f76e
(define-derived-mode): Preserve `mode-class' rather than `special' property.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41976
diff
changeset
|
246 is not very useful." |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
247 (while (get mode 'derived-mode-parent) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
248 (setq mode (get mode 'derived-mode-parent))) |
5765 | 249 mode) |
46072
fb621b18f76e
(define-derived-mode): Preserve `mode-class' rather than `special' property.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41976
diff
changeset
|
250 (make-obsolete 'derived-mode-class 'derived-mode-p "21.4") |
5765 | 251 |
252 | |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
253 ;;; PRIVATE |
5765 | 254 |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
255 (defun derived-mode-make-docstring (parent child &optional |
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
256 docstring syntax abbrev) |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
257 "Construct a docstring for a new mode if none is provided." |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
258 |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
259 (let ((map (derived-mode-map-name child)) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
260 (hook (derived-mode-hook-name child))) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
261 |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
262 (unless (stringp docstring) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
263 ;; Use a default docstring. |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
264 (setq docstring |
39553
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
265 (if (null parent) |
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
266 (format "Major-mode. |
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
267 Uses keymap `%s', abbrev table `%s' and syntax-table `%s'." map abbrev syntax) |
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
268 (format "Major mode derived from `%s' by `define-derived-mode'. |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
269 It inherits all of the parent's attributes, but has its own keymap, |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
270 abbrev table and syntax table: |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
271 |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
272 `%s', `%s' and `%s' |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
273 |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
274 which more-or-less shadow %s's corresponding tables." |
39553
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
275 parent map abbrev syntax parent)))) |
40344
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
276 |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
277 (unless (string-match (regexp-quote (symbol-name hook)) docstring) |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
278 ;; Make sure the docstring mentions the mode's hook. |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
279 (setq docstring |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
280 (concat docstring |
39553
71d39c72c6e5
(define-derived-mode, derived-mode-make-docstring): Allow `parent' to be nil.
Gerd Moellmann <gerd@gnu.org>
parents:
38412
diff
changeset
|
281 (if (null parent) |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
282 "\n\nThis mode " |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
283 (concat |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
284 "\n\nIn addition to any hooks its parent mode " |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
285 (if (string-match (regexp-quote (format "`%s'" parent)) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
286 docstring) nil |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
287 (format "`%s' " parent)) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
288 "might have run,\nthis mode ")) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
289 (format "runs the hook `%s'" hook) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
290 ", as the final step\nduring initialization."))) |
40344
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
291 |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
292 (unless (string-match "\\\\[{[]" docstring) |
47360
c17030759a04
(define-derived-mode): Add keyword arguments.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46072
diff
changeset
|
293 ;; And don't forget to put the mode's keymap. |
34148
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
294 (setq docstring (concat docstring "\n\n\\{" (symbol-name map) "}"))) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
295 |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
296 docstring)) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
297 |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
298 |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
299 ;;; OBSOLETE |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
300 ;; The functions below are only provided for backward compatibility with |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
301 ;; code byte-compiled with versions of derived.el prior to Emacs-21. |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
302 |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
303 (defsubst derived-mode-setup-function-name (mode) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
304 "Construct a setup-function name based on a MODE name." |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
305 (intern (concat (symbol-name mode) "-setup"))) |
7f4f9332942e
(define-derived-mode): Revived, moved from easy-mmode.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
29223
diff
changeset
|
306 |
5765 | 307 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
308 ;; Utility functions for defining a derived mode. |
5765 | 309 |
7717
c8f19e4a4d0f
(derived-mode-init-mode-variables): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
6257
diff
changeset
|
310 ;;;###autoload |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
311 (defun derived-mode-init-mode-variables (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
312 "Initialise variables for a new MODE. |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
313 Right now, if they don't already exist, set up a blank keymap, an |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
314 empty syntax table, and an empty abbrev table -- these will be merged |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
315 the first time the mode is used." |
5765 | 316 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
317 (if (boundp (derived-mode-map-name mode)) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
318 t |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
319 (eval `(defvar ,(derived-mode-map-name mode) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
320 (make-sparse-keymap) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
321 ,(format "Keymap for %s." mode))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
322 (put (derived-mode-map-name mode) 'derived-mode-unmerged t)) |
5765 | 323 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
324 (if (boundp (derived-mode-syntax-table-name mode)) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
325 t |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
326 (eval `(defvar ,(derived-mode-syntax-table-name mode) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
327 ;; Make a syntax table which doesn't specify anything |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
328 ;; for any char. Valid data will be merged in by |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
329 ;; derived-mode-merge-syntax-tables. |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
330 (make-char-table 'syntax-table nil) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
331 ,(format "Syntax table for %s." mode))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
332 (put (derived-mode-syntax-table-name mode) 'derived-mode-unmerged t)) |
5765 | 333 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
334 (if (boundp (derived-mode-abbrev-table-name mode)) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
335 t |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
336 (eval `(defvar ,(derived-mode-abbrev-table-name mode) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
337 (progn |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
338 (define-abbrev-table (derived-mode-abbrev-table-name mode) nil) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
339 (make-abbrev-table)) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
340 ,(format "Abbrev table for %s." mode))))) |
5765 | 341 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
342 ;; Utility functions for running a derived mode. |
5765 | 343 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
344 (defun derived-mode-set-keymap (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
345 "Set the keymap of the new MODE, maybe merging with the parent." |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
346 (let* ((map-name (derived-mode-map-name mode)) |
5765 | 347 (new-map (eval map-name)) |
348 (old-map (current-local-map))) | |
12611
04c737b6b30e
(derived-mode-set-keymap): Cope if old-map is nil.
Richard M. Stallman <rms@gnu.org>
parents:
11437
diff
changeset
|
349 (and old-map |
04c737b6b30e
(derived-mode-set-keymap): Cope if old-map is nil.
Richard M. Stallman <rms@gnu.org>
parents:
11437
diff
changeset
|
350 (get map-name 'derived-mode-unmerged) |
04c737b6b30e
(derived-mode-set-keymap): Cope if old-map is nil.
Richard M. Stallman <rms@gnu.org>
parents:
11437
diff
changeset
|
351 (derived-mode-merge-keymaps old-map new-map)) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
352 (put map-name 'derived-mode-unmerged nil) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
353 (use-local-map new-map))) |
5765 | 354 |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
355 (defun derived-mode-set-syntax-table (mode) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
356 "Set the syntax table of the new MODE, maybe merging with the parent." |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
357 (let* ((table-name (derived-mode-syntax-table-name mode)) |
5765 | 358 (old-table (syntax-table)) |
359 (new-table (eval table-name))) | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
360 (if (get table-name 'derived-mode-unmerged) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
361 (derived-mode-merge-syntax-tables old-table new-table)) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
362 (put table-name 'derived-mode-unmerged nil) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
363 (set-syntax-table new-table))) |
5765 | 364 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
365 (defun derived-mode-set-abbrev-table (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
366 "Set the abbrev table for MODE if it exists. |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
367 Always merge its parent into it, since the merge is non-destructive." |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
368 (let* ((table-name (derived-mode-abbrev-table-name mode)) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
369 (old-table local-abbrev-table) |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
370 (new-table (eval table-name))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
371 (derived-mode-merge-abbrev-tables old-table new-table) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
372 (setq local-abbrev-table new-table))) |
5765 | 373 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
374 ;;;(defun derived-mode-run-setup-function (mode) |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
375 ;;; "Run the setup function if it exists." |
5765 | 376 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
377 ;;; (let ((fname (derived-mode-setup-function-name mode))) |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
378 ;;; (if (fboundp fname) |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
379 ;;; (funcall fname)))) |
5765 | 380 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
381 (defun derived-mode-run-hooks (mode) |
22685
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
382 "Run the mode hook for MODE." |
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
383 (let ((hooks-name (derived-mode-hook-name mode))) |
5765 | 384 (if (boundp hooks-name) |
385 (run-hooks hooks-name)))) | |
386 | |
387 ;; Functions to merge maps and tables. | |
388 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
389 (defun derived-mode-merge-keymaps (old new) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
390 "Merge an OLD keymap into a NEW one. |
11437
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
391 The old keymap is set to be the last cdr of the new one, so that there will |
5765 | 392 be automatic inheritance." |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
393 ;; ?? Can this just use `set-keymap-parent'? |
11437
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
394 (let ((tail new)) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
395 ;; Scan the NEW map for prefix keys. |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
396 (while (consp tail) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
397 (and (consp (car tail)) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
398 (let* ((key (vector (car (car tail)))) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
399 (subnew (lookup-key new key)) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
400 (subold (lookup-key old key))) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
401 ;; If KEY is a prefix key in both OLD and NEW, merge them. |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
402 (and (keymapp subnew) (keymapp subold) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
403 (derived-mode-merge-keymaps subold subnew)))) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
404 (and (vectorp (car tail)) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
405 ;; Search a vector of ASCII char bindings for prefix keys. |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
406 (let ((i (1- (length (car tail))))) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
407 (while (>= i 0) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
408 (let* ((key (vector i)) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
409 (subnew (lookup-key new key)) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
410 (subold (lookup-key old key))) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
411 ;; If KEY is a prefix key in both OLD and NEW, merge them. |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
412 (and (keymapp subnew) (keymapp subold) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
413 (derived-mode-merge-keymaps subold subnew))) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
414 (setq i (1- i))))) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
415 (setq tail (cdr tail)))) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
416 (setcdr (nthcdr (1- (length new)) new) old)) |
5765 | 417 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
418 (defun derived-mode-merge-syntax-tables (old new) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
419 "Merge an OLD syntax table into a NEW one. |
5765 | 420 Where the new table already has an entry, nothing is copied from the old one." |
14637
89952d6af6c2
(derived-mode-merge-syntax-tables): Use inheritance.
Karl Heuer <kwzh@gnu.org>
parents:
14169
diff
changeset
|
421 (set-char-table-parent new old)) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
422 |
7798
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
423 ;; Merge an old abbrev table into a new one. |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
424 ;; This function requires internal knowledge of how abbrev tables work, |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
425 ;; presuming that they are obarrays with the abbrev as the symbol, the expansion |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
426 ;; as the value of the symbol, and the hook as the function definition. |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
427 (defun derived-mode-merge-abbrev-tables (old new) |
7798
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
428 (if old |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
429 (mapatoms |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
430 (lambda (symbol) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
431 (or (intern-soft (symbol-name symbol) new) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
432 (define-abbrev new (symbol-name symbol) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
433 (symbol-value symbol) (symbol-function symbol)))) |
7798
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
434 old))) |
40344
d184455da497
(derived-mode-hook-name, derived-mode-map-name)
Sam Steingold <sds@gnu.org>
parents:
40283
diff
changeset
|
435 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
436 (provide 'derived) |
5765 | 437 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
438 ;;; derived.el ends here |