annotate lisp/derived.el @ 41309:8c4c4027c7bd

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