Mercurial > emacs
annotate lisp/derived.el @ 25805:efe07431a7ba
(reftex-view-cr-cite): Deal with multiple thebibliography environments.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Fri, 24 Sep 1999 10:04:08 +0000 |
parents | a9f375bef470 |
children | 9b5edf2cbaff |
rev | line source |
---|---|
15261 | 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 |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
4 ;; Copyright (C) 1993, 1994 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 |
5765 | 8 |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
14169 | 22 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 ;; Boston, MA 02111-1307, USA. | |
5765 | 25 |
26 ;;; Commentary: | |
27 | |
28 ;; GNU Emacs is already, in a sense, object oriented -- each object | |
29 ;; (buffer) belongs to a class (major mode), and that class defines | |
30 ;; the relationship between messages (input events) and methods | |
31 ;; (commands) by means of a keymap. | |
32 ;; | |
33 ;; The only thing missing is a good scheme of inheritance. It is | |
34 ;; possible to simulate a single level of inheritance with generous | |
35 ;; use of hooks and a bit of work -- sgml-mode, for example, also runs | |
36 ;; the hooks for text-mode, and keymaps can inherit from other keymaps | |
37 ;; -- but generally, each major mode ends up reinventing the wheel. | |
38 ;; Ideally, someone should redesign all of Emacs's major modes to | |
39 ;; follow a more conventional object-oriented system: when defining a | |
40 ;; new major mode, the user should need only to name the existing mode | |
41 ;; it is most similar to, then list the (few) differences. | |
42 ;; | |
43 ;; 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
|
44 ;; 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
|
45 ;; `define-derived-mode' allows the user to make a variant of an existing |
5765 | 46 ;; major mode, with its own keymap. The new mode will inherit the key |
47 ;; bindings of its parent, and will, in fact, run its parent first | |
48 ;; every time it is called. For example, the commands | |
49 ;; | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
50 ;; (define-derived-mode hypertext-mode text-mode "Hypertext" |
5765 | 51 ;; "Major mode for hypertext.\n\n\\{hypertext-mode-map}" |
52 ;; (setq case-fold-search nil)) | |
53 ;; | |
54 ;; (define-key hypertext-mode-map [down-mouse-3] 'do-hyper-link) | |
55 ;; | |
56 ;; will create a function `hypertext-mode' with its own (sparse) | |
57 ;; keymap `hypertext-mode-map.' The command M-x hypertext-mode will | |
58 ;; perform the following actions: | |
59 ;; | |
60 ;; - run the command (text-mode) to get its default setup | |
61 ;; - replace the current keymap with 'hypertext-mode-map,' which will | |
62 ;; inherit from 'text-mode-map'. | |
63 ;; - replace the current syntax table with | |
64 ;; 'hypertext-mode-syntax-table', which will borrow its defaults | |
65 ;; 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
|
66 ;; - replace the current abbrev table with |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
67 ;; '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
|
68 ;; from the current text-mode-abbrev table |
5765 | 69 ;; - change the mode line to read "Hypertext" |
70 ;; - assign the value 'hypertext-mode' to the 'major-mode' variable | |
71 ;; - run the body of commands provided in the macro -- in this case, | |
72 ;; set the local variable `case-fold-search' to nil. | |
73 ;; - **run the command (hypertext-mode-setup), which is empty by | |
74 ;; default, but may be redefined by the user to contain special | |
75 ;; commands (ie. setting local variables like 'outline-regexp') | |
76 ;; **NOTE: do not use this option -- it will soon be obsolete. | |
22685
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
77 ;; - run anything assigned to 'hypertext-mode-hook' (obsolete, but |
5765 | 78 ;; supported for the sake of compatibility). |
79 ;; | |
80 ;; The advantages of this system are threefold. First, text mode is | |
81 ;; untouched -- if you had added the new keystroke to `text-mode-map,' | |
82 ;; possibly using hooks, you would have added it to all text buffers | |
83 ;; -- 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
|
84 ;; 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
|
85 ;; a derived mode from a derived mode. The commands |
5765 | 86 ;; |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
87 ;; (define-derived-mode html-mode hypertext-mode "HTML") |
5765 | 88 ;; [various key definitions] |
89 ;; | |
90 ;; will add a new major mode for HTML with very little fuss. | |
91 ;; | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
92 ;; Note also the function `derived-mode-class,' which returns the non-derived |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
93 ;; major mode which a derived mode is based on (ie. NOT necessarily the |
5765 | 94 ;; immediate parent). |
95 ;; | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
96 ;; (derived-mode-class 'text-mode) ==> text-mode |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
97 ;; (derived-mode-class 'hypertext-mode) ==> text-mode |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
98 ;; (derived-mode-class 'html-mode) ==> text-mode |
5765 | 99 |
100 ;;; Code: | |
101 | |
102 ;; PUBLIC: define a new major mode which inherits from an existing one. | |
103 | |
104 ;;;###autoload | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
105 (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
|
106 "Create a new mode as a variant of an existing mode. |
5765 | 107 |
108 The arguments to this command are as follow: | |
109 | |
10401
598ca194bb60
(define-derived-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7798
diff
changeset
|
110 CHILD: the name of the command for the derived mode. |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
111 PARENT: the name of the command for the parent mode (ie. text-mode). |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
112 NAME: a string which will appear in the status line (ie. \"Hypertext\") |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
113 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
|
114 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
|
115 BODY: forms to execute just before running the |
5765 | 116 hooks for the new mode. |
117 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
118 Here is how you could define LaTeX-Thesis mode as a variant of LaTeX mode: |
5765 | 119 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
120 (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
|
121 |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
122 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
|
123 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
|
124 and DOCSTRING is generated by default. |
5765 | 125 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
126 On a more complicated level, the following command uses sgml-mode as |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
127 the parent, and then sets the variable `case-fold-search' to nil: |
5765 | 128 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
129 (define-derived-mode article-mode sgml-mode \"Article\" |
5765 | 130 \"Major mode for editing technical articles.\" |
131 (setq case-fold-search nil)) | |
132 | |
133 Note that if the documentation string had been left out, it would have | |
134 been generated automatically, with a reference to the keymap." | |
135 | |
136 ; Some trickiness, since what | |
137 ; appears to be the docstring | |
138 ; may really be the first | |
139 ; element of the body. | |
140 (if (and docstring (not (stringp docstring))) | |
141 (progn (setq body (cons docstring body)) | |
142 (setq docstring nil))) | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
143 (setq docstring (or docstring (derived-mode-make-docstring parent child))) |
5765 | 144 |
145 (` (progn | |
16983
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
146 (derived-mode-init-mode-variables '(, child)) |
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
147 (put '(, child) 'derived-mode-parent '(, parent)) |
5765 | 148 (defun (, child) () |
149 (, docstring) | |
150 (interactive) | |
151 ; Run the parent. | |
152 ((, parent)) | |
153 ; Identify special modes. | |
16983
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
154 (if (get '(, parent) 'special) |
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
155 (put '(, child) 'special t)) |
5765 | 156 ; Identify the child mode. |
16983
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
157 (setq major-mode '(, child)) |
5765 | 158 (setq mode-name (, name)) |
159 ; Set up maps and tables. | |
16983
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
160 (derived-mode-set-keymap '(, child)) |
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
161 (derived-mode-set-syntax-table '(, child)) |
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
162 (derived-mode-set-abbrev-table '(, child)) |
5765 | 163 ; Splice in the body (if any). |
164 (,@ body) | |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
165 ;;; ; Run the setup function, if |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
166 ;;; ; any -- this will soon be |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
167 ;;; ; obsolete. |
16983
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
168 ;;; (derived-mode-run-setup-function '(, child)) |
22685
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
169 ; Run the hook, if any. |
16983
8c94c682773a
(define-derived-mode): Add derived-mode-parent
Richard M. Stallman <rms@gnu.org>
parents:
15261
diff
changeset
|
170 (derived-mode-run-hooks '(, child)))))) |
5765 | 171 |
172 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
173 ;; PUBLIC: find the ultimate class of a derived mode. |
5765 | 174 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
175 (defun derived-mode-class (mode) |
5765 | 176 "Find the class of a major mode. |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
177 A mode's class is the first ancestor which is NOT a derived mode. |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
178 Use the `derived-mode-parent' property of the symbol to trace backwards." |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
179 (while (get mode 'derived-mode-parent) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
180 (setq mode (get mode 'derived-mode-parent))) |
5765 | 181 mode) |
182 | |
183 | |
184 ;; Inline functions to construct various names from a mode name. | |
185 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
186 (defsubst derived-mode-setup-function-name (mode) |
5765 | 187 "Construct a setup-function name based on a mode name." |
188 (intern (concat (symbol-name mode) "-setup"))) | |
189 | |
22685
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
190 (defsubst derived-mode-hook-name (mode) |
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
191 "Construct the mode hook name based on mode name MODE." |
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
192 (intern (concat (symbol-name mode) "-hook"))) |
5765 | 193 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
194 (defsubst derived-mode-map-name (mode) |
5765 | 195 "Construct a map name based on a mode name." |
196 (intern (concat (symbol-name mode) "-map"))) | |
197 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
198 (defsubst derived-mode-syntax-table-name (mode) |
5765 | 199 "Construct a syntax-table name based on a mode name." |
200 (intern (concat (symbol-name mode) "-syntax-table"))) | |
201 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
202 (defsubst derived-mode-abbrev-table-name (mode) |
5765 | 203 "Construct an abbrev-table name based on a mode name." |
204 (intern (concat (symbol-name mode) "-abbrev-table"))) | |
205 | |
206 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
207 ;; Utility functions for defining a derived mode. |
5765 | 208 |
7717
c8f19e4a4d0f
(derived-mode-init-mode-variables): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
6257
diff
changeset
|
209 ;;;###autoload |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
210 (defun derived-mode-init-mode-variables (mode) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
211 "Initialise variables for a new mode. |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
212 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
|
213 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
|
214 the first time the mode is used." |
5765 | 215 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
216 (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
|
217 t |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
218 (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
|
219 (make-sparse-keymap) |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
220 (, (format "Keymap for %s." mode))))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
221 (put (derived-mode-map-name mode) 'derived-mode-unmerged t)) |
5765 | 222 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
223 (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
|
224 t |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
225 (eval (` (defvar (, (derived-mode-syntax-table-name mode)) |
13268
6d2b9a2c1ca4
(derived-mode-init-mode-variables): Make proper syntax-table.
Richard M. Stallman <rms@gnu.org>
parents:
12611
diff
changeset
|
226 ;; Make a syntax table which doesn't specify anything |
6d2b9a2c1ca4
(derived-mode-init-mode-variables): Make proper syntax-table.
Richard M. Stallman <rms@gnu.org>
parents:
12611
diff
changeset
|
227 ;; for any char. Valid data will be merged in by |
6d2b9a2c1ca4
(derived-mode-init-mode-variables): Make proper syntax-table.
Richard M. Stallman <rms@gnu.org>
parents:
12611
diff
changeset
|
228 ;; derived-mode-merge-syntax-tables. |
6d2b9a2c1ca4
(derived-mode-init-mode-variables): Make proper syntax-table.
Richard M. Stallman <rms@gnu.org>
parents:
12611
diff
changeset
|
229 (make-char-table 'syntax-table nil) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
230 (, (format "Syntax table for %s." mode))))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
231 (put (derived-mode-syntax-table-name mode) 'derived-mode-unmerged t)) |
5765 | 232 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
233 (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
|
234 t |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
235 (eval (` (defvar (, (derived-mode-abbrev-table-name mode)) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
236 (progn (define-abbrev-table (derived-mode-abbrev-table-name mode) nil) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
237 (make-abbrev-table)) |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
238 (, (format "Abbrev table for %s." mode))))))) |
5765 | 239 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
240 (defun derived-mode-make-docstring (parent child) |
5765 | 241 "Construct a docstring for a new mode if none is provided." |
242 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
243 (format "This major mode is a variant of `%s', created by `define-derived-mode'. |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
244 It inherits all of the parent's attributes, but has its own keymap, |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
245 abbrev table and syntax table: |
5765 | 246 |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
247 `%s-map' and `%s-syntax-table' |
5765 | 248 |
249 which more-or-less shadow | |
250 | |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
251 `%s-map' and `%s-syntax-table' |
5765 | 252 |
253 \\{%s-map}" parent child child parent parent child)) | |
254 | |
255 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
256 ;; Utility functions for running a derived mode. |
5765 | 257 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
258 (defun derived-mode-set-keymap (mode) |
5765 | 259 "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
|
260 (let* ((map-name (derived-mode-map-name mode)) |
5765 | 261 (new-map (eval map-name)) |
262 (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
|
263 (and old-map |
04c737b6b30e
(derived-mode-set-keymap): Cope if old-map is nil.
Richard M. Stallman <rms@gnu.org>
parents:
11437
diff
changeset
|
264 (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
|
265 (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
|
266 (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
|
267 (use-local-map new-map))) |
5765 | 268 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
269 (defun derived-mode-set-syntax-table (mode) |
5765 | 270 "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
|
271 (let* ((table-name (derived-mode-syntax-table-name mode)) |
5765 | 272 (old-table (syntax-table)) |
273 (new-table (eval table-name))) | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
274 (if (get table-name 'derived-mode-unmerged) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
275 (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
|
276 (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
|
277 (set-syntax-table new-table))) |
5765 | 278 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
279 (defun derived-mode-set-abbrev-table (mode) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
280 "Set the abbrev table if it exists. |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
281 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
|
282 (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
|
283 (old-table local-abbrev-table) |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
284 (new-table (eval table-name))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
285 (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
|
286 (setq local-abbrev-table new-table))) |
5765 | 287 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
288 ;;;(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
|
289 ;;; "Run the setup function if it exists." |
5765 | 290 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
291 ;;; (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
|
292 ;;; (if (fboundp fname) |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
293 ;;; (funcall fname)))) |
5765 | 294 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
295 (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
|
296 "Run the mode hook for MODE." |
5765 | 297 |
22685
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
298 (let ((hooks-name (derived-mode-hook-name mode))) |
5765 | 299 (if (boundp hooks-name) |
300 (run-hooks hooks-name)))) | |
301 | |
302 ;; Functions to merge maps and tables. | |
303 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
304 (defun derived-mode-merge-keymaps (old new) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
305 "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
|
306 The old keymap is set to be the last cdr of the new one, so that there will |
5765 | 307 be automatic inheritance." |
11437
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
308 (let ((tail new)) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
309 ;; 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
|
310 (while (consp tail) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
311 (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
|
312 (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
|
313 (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
|
314 (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
|
315 ;; 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
|
316 (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
|
317 (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
|
318 (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
|
319 ;; 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
|
320 (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
|
321 (while (>= i 0) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
322 (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
|
323 (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
|
324 (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
|
325 ;; 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
|
326 (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
|
327 (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
|
328 (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
|
329 (setq tail (cdr tail)))) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
330 (setcdr (nthcdr (1- (length new)) new) old)) |
5765 | 331 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
332 (defun derived-mode-merge-syntax-tables (old new) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
333 "Merge an old syntax table into a new one. |
5765 | 334 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
|
335 (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
|
336 |
7798
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
337 ;; 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
|
338 ;; 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
|
339 ;; 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
|
340 ;; 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
|
341 (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
|
342 (if old |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
343 (mapatoms |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
344 (function |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
345 (lambda (symbol) |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
346 (or (intern-soft (symbol-name symbol) new) |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
347 (define-abbrev new (symbol-name symbol) |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
348 (symbol-value symbol) (symbol-function symbol))))) |
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
349 old))) |
5765 | 350 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
351 (provide 'derived) |
5765 | 352 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
353 ;;; derived.el ends here |