Mercurial > emacs
annotate lisp/derived.el @ 29191:3977c8167022
(handle_invisible_prop): Don't try to skip over
invisible text if end of text is already reached.
author | Gerd Moellmann <gerd@gnu.org> |
---|---|
date | Thu, 25 May 2000 15:53:05 +0000 |
parents | af5c31a82586 |
children | f4e4d31c70f5 |
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 |
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 |
29156 | 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 | |
28235
963f1d516e92
* derived.el (define-derived-mode): Don't autoload anymore.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26655
diff
changeset
|
29 ;; Obsolete. |
963f1d516e92
* derived.el (define-derived-mode): Don't autoload anymore.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26655
diff
changeset
|
30 ;; Use the `derived-major-mode' provided by easy-mmode.el instead. |
963f1d516e92
* derived.el (define-derived-mode): Don't autoload anymore.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26655
diff
changeset
|
31 ;; It is only kept for backward compatibility with byte-compiled files |
963f1d516e92
* derived.el (define-derived-mode): Don't autoload anymore.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26655
diff
changeset
|
32 ;; which refer to `derived-mode-init-mode-variables' and other functions. |
963f1d516e92
* derived.el (define-derived-mode): Don't autoload anymore.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26655
diff
changeset
|
33 |
963f1d516e92
* derived.el (define-derived-mode): Don't autoload anymore.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26655
diff
changeset
|
34 |
963f1d516e92
* derived.el (define-derived-mode): Don't autoload anymore.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26655
diff
changeset
|
35 |
5765 | 36 ;; GNU Emacs is already, in a sense, object oriented -- each object |
37 ;; (buffer) belongs to a class (major mode), and that class defines | |
38 ;; the relationship between messages (input events) and methods | |
39 ;; (commands) by means of a keymap. | |
40 ;; | |
41 ;; The only thing missing is a good scheme of inheritance. It is | |
42 ;; possible to simulate a single level of inheritance with generous | |
43 ;; use of hooks and a bit of work -- sgml-mode, for example, also runs | |
44 ;; the hooks for text-mode, and keymaps can inherit from other keymaps | |
45 ;; -- but generally, each major mode ends up reinventing the wheel. | |
46 ;; Ideally, someone should redesign all of Emacs's major modes to | |
47 ;; follow a more conventional object-oriented system: when defining a | |
48 ;; new major mode, the user should need only to name the existing mode | |
49 ;; it is most similar to, then list the (few) differences. | |
50 ;; | |
51 ;; 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
|
52 ;; 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
|
53 ;; `define-derived-mode' allows the user to make a variant of an existing |
5765 | 54 ;; major mode, with its own keymap. The new mode will inherit the key |
55 ;; bindings of its parent, and will, in fact, run its parent first | |
56 ;; every time it is called. For example, the commands | |
57 ;; | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
58 ;; (define-derived-mode hypertext-mode text-mode "Hypertext" |
5765 | 59 ;; "Major mode for hypertext.\n\n\\{hypertext-mode-map}" |
60 ;; (setq case-fold-search nil)) | |
61 ;; | |
62 ;; (define-key hypertext-mode-map [down-mouse-3] 'do-hyper-link) | |
63 ;; | |
64 ;; will create a function `hypertext-mode' with its own (sparse) | |
65 ;; keymap `hypertext-mode-map.' The command M-x hypertext-mode will | |
66 ;; perform the following actions: | |
67 ;; | |
68 ;; - run the command (text-mode) to get its default setup | |
69 ;; - replace the current keymap with 'hypertext-mode-map,' which will | |
70 ;; inherit from 'text-mode-map'. | |
71 ;; - replace the current syntax table with | |
72 ;; 'hypertext-mode-syntax-table', which will borrow its defaults | |
73 ;; 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
|
74 ;; - replace the current abbrev table with |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
75 ;; '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
|
76 ;; from the current text-mode-abbrev table |
5765 | 77 ;; - change the mode line to read "Hypertext" |
78 ;; - assign the value 'hypertext-mode' to the 'major-mode' variable | |
79 ;; - run the body of commands provided in the macro -- in this case, | |
80 ;; set the local variable `case-fold-search' to nil. | |
81 ;; | |
82 ;; The advantages of this system are threefold. First, text mode is | |
83 ;; untouched -- if you had added the new keystroke to `text-mode-map,' | |
84 ;; possibly using hooks, you would have added it to all text buffers | |
85 ;; -- 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
|
86 ;; 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
|
87 ;; a derived mode from a derived mode. The commands |
5765 | 88 ;; |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
89 ;; (define-derived-mode html-mode hypertext-mode "HTML") |
5765 | 90 ;; [various key definitions] |
91 ;; | |
92 ;; will add a new major mode for HTML with very little fuss. | |
93 ;; | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
94 ;; 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
|
95 ;; major mode which a derived mode is based on (ie. NOT necessarily the |
5765 | 96 ;; immediate parent). |
97 ;; | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
98 ;; (derived-mode-class 'text-mode) ==> text-mode |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
99 ;; (derived-mode-class 'hypertext-mode) ==> text-mode |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
100 ;; (derived-mode-class 'html-mode) ==> text-mode |
5765 | 101 |
102 ;;; Code: | |
103 | |
104 ;; PUBLIC: define a new major mode which inherits from an existing one. | |
105 | |
28235
963f1d516e92
* derived.el (define-derived-mode): Don't autoload anymore.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26655
diff
changeset
|
106 ;; ;;;###autoload |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
107 (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
|
108 "Create a new mode as a variant of an existing mode. |
5765 | 109 |
110 The arguments to this command are as follow: | |
111 | |
10401
598ca194bb60
(define-derived-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
7798
diff
changeset
|
112 CHILD: the name of the command for the derived mode. |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
113 PARENT: the name of the command for the parent mode (e.g. `text-mode'). |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
114 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
|
115 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
|
116 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
|
117 BODY: forms to execute just before running the |
5765 | 118 hooks for the new mode. |
119 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
120 Here is how you could define LaTeX-Thesis mode as a variant of LaTeX mode: |
5765 | 121 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
122 (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
|
123 |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
124 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
|
125 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
|
126 and DOCSTRING is generated by default. |
5765 | 127 |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
128 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
|
129 the parent, and then sets the variable `case-fold-search' to nil: |
5765 | 130 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
131 (define-derived-mode article-mode sgml-mode \"Article\" |
5765 | 132 \"Major mode for editing technical articles.\" |
133 (setq case-fold-search nil)) | |
134 | |
135 Note that if the documentation string had been left out, it would have | |
136 been generated automatically, with a reference to the keymap." | |
137 | |
138 ; Some trickiness, since what | |
139 ; appears to be the docstring | |
140 ; may really be the first | |
141 ; element of the body. | |
142 (if (and docstring (not (stringp docstring))) | |
143 (progn (setq body (cons docstring body)) | |
144 (setq docstring nil))) | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
145 (setq docstring (or docstring (derived-mode-make-docstring parent child))) |
5765 | 146 |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
147 `(progn |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
148 (derived-mode-init-mode-variables (quote ,child)) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
149 (defun ,child () |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
150 ,docstring |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
151 (interactive) |
5765 | 152 ; Run the parent. |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
153 (,parent) |
5765 | 154 ; Identify special modes. |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
155 (if (get (quote ,parent) 'special) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
156 (put (quote ,child) 'special t)) |
5765 | 157 ; Identify the child mode. |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
158 (setq major-mode (quote ,child)) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
159 (setq mode-name ,name) |
5765 | 160 ; Set up maps and tables. |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
161 (derived-mode-set-keymap (quote ,child)) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
162 (derived-mode-set-syntax-table (quote ,child)) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
163 (derived-mode-set-abbrev-table (quote ,child)) |
5765 | 164 ; Splice in the body (if any). |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
165 ,@body |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
166 ;;; ; Run the setup function, if |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
167 ;;; ; any -- this will soon be |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
168 ;;; ; obsolete. |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
169 ;;; (derived-mode-run-setup-function (quote ,child)) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
170 ; Run the hooks, if any. |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
171 (derived-mode-run-hooks (quote ,child))))) |
5765 | 172 |
173 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
174 ;; PUBLIC: find the ultimate class of a derived mode. |
5765 | 175 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
176 (defun derived-mode-class (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
177 "Find the class of a major MODE. |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
178 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
|
179 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
|
180 (while (get mode 'derived-mode-parent) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
181 (setq mode (get mode 'derived-mode-parent))) |
5765 | 182 mode) |
183 | |
184 | |
185 ;; Inline functions to construct various names from a mode name. | |
186 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
187 (defsubst derived-mode-setup-function-name (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
188 "Construct a setup-function name based on a MODE name." |
5765 | 189 (intern (concat (symbol-name mode) "-setup"))) |
190 | |
22685
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
191 (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
|
192 "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
|
193 (intern (concat (symbol-name mode) "-hook"))) |
5765 | 194 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
195 (defsubst derived-mode-map-name (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
196 "Construct a map name based on a MODE name." |
5765 | 197 (intern (concat (symbol-name mode) "-map"))) |
198 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
199 (defsubst derived-mode-syntax-table-name (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
200 "Construct a syntax-table name based on a MODE name." |
5765 | 201 (intern (concat (symbol-name mode) "-syntax-table"))) |
202 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
203 (defsubst derived-mode-abbrev-table-name (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
204 "Construct an abbrev-table name based on a MODE name." |
5765 | 205 (intern (concat (symbol-name mode) "-abbrev-table"))) |
206 | |
207 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
208 ;; Utility functions for defining a derived mode. |
5765 | 209 |
7717
c8f19e4a4d0f
(derived-mode-init-mode-variables): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
6257
diff
changeset
|
210 ;;;###autoload |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
211 (defun derived-mode-init-mode-variables (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
212 "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
|
213 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
|
214 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
|
215 the first time the mode is used." |
5765 | 216 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
217 (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
|
218 t |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
219 (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
|
220 (make-sparse-keymap) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
221 ,(format "Keymap for %s." mode))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
222 (put (derived-mode-map-name mode) 'derived-mode-unmerged t)) |
5765 | 223 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
224 (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
|
225 t |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
226 (eval `(defvar ,(derived-mode-syntax-table-name mode) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
227 ;; 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
|
228 ;; 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
|
229 ;; derived-mode-merge-syntax-tables. |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
230 (make-char-table 'syntax-table nil) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
231 ,(format "Syntax table for %s." mode))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
232 (put (derived-mode-syntax-table-name mode) 'derived-mode-unmerged t)) |
5765 | 233 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
234 (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
|
235 t |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
236 (eval `(defvar ,(derived-mode-abbrev-table-name mode) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
237 (progn |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
238 (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
|
239 (make-abbrev-table)) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
240 ,(format "Abbrev table for %s." mode))))) |
5765 | 241 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
242 (defun derived-mode-make-docstring (parent child) |
5765 | 243 "Construct a docstring for a new mode if none is provided." |
244 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
245 (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
|
246 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
|
247 abbrev table and syntax table: |
5765 | 248 |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
249 `%s-map' and `%s-syntax-table' |
5765 | 250 |
251 which more-or-less shadow | |
252 | |
5766
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
253 `%s-map' and `%s-syntax-table' |
5765 | 254 |
255 \\{%s-map}" parent child child parent parent child)) | |
256 | |
257 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
258 ;; Utility functions for running a derived mode. |
5765 | 259 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
260 (defun derived-mode-set-keymap (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
261 "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
|
262 (let* ((map-name (derived-mode-map-name mode)) |
5765 | 263 (new-map (eval map-name)) |
264 (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
|
265 (and old-map |
04c737b6b30e
(derived-mode-set-keymap): Cope if old-map is nil.
Richard M. Stallman <rms@gnu.org>
parents:
11437
diff
changeset
|
266 (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
|
267 (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
|
268 (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
|
269 (use-local-map new-map))) |
5765 | 270 |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
271 (defun derived-mode-set-syntax-table (mode) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
272 "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
|
273 (let* ((table-name (derived-mode-syntax-table-name mode)) |
5765 | 274 (old-table (syntax-table)) |
275 (new-table (eval table-name))) | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
276 (if (get table-name 'derived-mode-unmerged) |
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
277 (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
|
278 (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
|
279 (set-syntax-table new-table))) |
5765 | 280 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
281 (defun derived-mode-set-abbrev-table (mode) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
282 "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
|
283 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
|
284 (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
|
285 (old-table local-abbrev-table) |
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
286 (new-table (eval table-name))) |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
287 (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
|
288 (setq local-abbrev-table new-table))) |
5765 | 289 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
290 ;;;(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
|
291 ;;; "Run the setup function if it exists." |
5765 | 292 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
293 ;;; (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
|
294 ;;; (if (fboundp fname) |
27a2ad893b22
(define-mode-clone): Renamed from mode-clone.
Richard M. Stallman <rms@gnu.org>
parents:
5765
diff
changeset
|
295 ;;; (funcall fname)))) |
5765 | 296 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
297 (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
|
298 "Run the mode hook for MODE." |
5765 | 299 |
22685
a9f375bef470
(derived-mode-hooks-name): Use -hook, not -hooks, in mode hook name.
Richard M. Stallman <rms@gnu.org>
parents:
16983
diff
changeset
|
300 (let ((hooks-name (derived-mode-hook-name mode))) |
5765 | 301 (if (boundp hooks-name) |
302 (run-hooks hooks-name)))) | |
303 | |
304 ;; Functions to merge maps and tables. | |
305 | |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
306 (defun derived-mode-merge-keymaps (old new) |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
307 "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
|
308 The old keymap is set to be the last cdr of the new one, so that there will |
5765 | 309 be automatic inheritance." |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
310 ;; ?? 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
|
311 (let ((tail new)) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
312 ;; 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
|
313 (while (consp tail) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
314 (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
|
315 (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
|
316 (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
|
317 (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
|
318 ;; 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
|
319 (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
|
320 (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
|
321 (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
|
322 ;; 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
|
323 (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
|
324 (while (>= i 0) |
84e419a90298
(derived-mode-merge-keymaps): Recursively merge prefix key submaps also.
Richard M. Stallman <rms@gnu.org>
parents:
10401
diff
changeset
|
325 (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
|
326 (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
|
327 (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
|
328 ;; 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
|
329 (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
|
330 (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
|
331 (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
|
332 (setq tail (cdr tail)))) |
5924
d81345ecac1a
(clone-init-mode-variables): Don't defvar
Richard M. Stallman <rms@gnu.org>
parents:
5766
diff
changeset
|
333 (setcdr (nthcdr (1- (length new)) new) old)) |
5765 | 334 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
335 (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
|
336 "Merge an OLD syntax table into a NEW one. |
5765 | 337 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
|
338 (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
|
339 |
7798
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
340 ;; 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
|
341 ;; 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
|
342 ;; 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
|
343 ;; 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
|
344 (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
|
345 (if old |
26655
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
346 (mapatoms |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
347 (lambda (symbol) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
348 (or (intern-soft (symbol-name symbol) new) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
349 (define-abbrev new (symbol-name symbol) |
9b5edf2cbaff
Doc fixes, remove old backquote syntax.
Dave Love <fx@gnu.org>
parents:
22685
diff
changeset
|
350 (symbol-value symbol) (symbol-function symbol)))) |
7798
f627fbbd4524
(derived-mode-merge-abbrev-tables):
Richard M. Stallman <rms@gnu.org>
parents:
7717
diff
changeset
|
351 old))) |
5765 | 352 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
353 (provide 'derived) |
5765 | 354 |
6257
d2ff317d7ad7
Renamed from mode-clone.el.
Richard M. Stallman <rms@gnu.org>
parents:
5924
diff
changeset
|
355 ;;; derived.el ends here |