annotate lisp/derived.el @ 12719:dde58f45b00a

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