Mercurial > emacs
annotate lisp/generic.el @ 61309:ebfe038b7e6c
*** empty log message ***
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Tue, 05 Apr 2005 08:09:49 +0000 |
parents | 3f688bd09fa4 |
children | 0aa94186ae69 |
rev | line source |
---|---|
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
37058
diff
changeset
|
1 ;;; generic.el --- defining simple major modes with comment and font-lock |
18254 | 2 ;; |
60595
b392b963c10b
(define-generic-mode): Let generic-mode-list be a list of strings;
Lute Kamstra <lute@gnu.org>
parents:
58587
diff
changeset
|
3 ;; Copyright (C) 1997, 1999, 2004, 2005 Free Software Foundation, Inc. |
18254 | 4 ;; |
21182 | 5 ;; Author: Peter Breton <pbreton@cs.umb.edu> |
18254 | 6 ;; Created: Fri Sep 27 1996 |
7 ;; Keywords: generic, comment, font-lock | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 ;; Boston, MA 02111-1307, USA. | |
25 | |
26 ;; Purpose: | |
27 | |
28 ;; Meta-mode to create simple major modes | |
29 ;; with basic comment and font-lock support | |
30 | |
31 ;;; Commentary: | |
32 | |
33 ;; INTRODUCTION: | |
34 | |
35 ;; Generic-mode is a meta-mode which can be used to define small modes | |
21014 | 36 ;; which provide basic comment and font-lock support. These modes are |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
37 ;; intended for the many configuration files and such which are too |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
38 ;; small for a "real" mode, but still have a regular syntax, comment |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
39 ;; characters and the like. |
18254 | 40 ;; |
41 ;; Each generic mode can define the following: | |
42 ;; | |
21014 | 43 ;; * List of comment-characters. The entries in this list should be |
18254 | 44 ;; either a character, a one or two character string or a cons pair. |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
45 ;; If the entry is a character or a string, it is added to the |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
46 ;; mode's syntax table with `comment-start' syntax. If the entry is |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
47 ;; a cons pair, the elements of the pair are considered to be |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
48 ;; `comment-start' and `comment-end' respectively. (The latter |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
49 ;; should be nil if you want comments to end at end of line.) |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
50 ;; LIMITATIONS: Emacs does not support comment strings of more than |
18254 | 51 ;; two characters in length. |
52 ;; | |
21014 | 53 ;; * List of keywords to font-lock. Each keyword should be a string. |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
54 ;; If you have additional keywords which should be highlighted in a |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
55 ;; face different from `font-lock-keyword-face', you can use the |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
56 ;; convenience function `generic-make-keywords-list' (which see), |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
57 ;; and add the result to the following list: |
32120 | 58 ;; |
21014 | 59 ;; * Additional expressions to font-lock. This should be a list of |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
60 ;; expressions, each of which should be of the same form as those in |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
61 ;; `font-lock-keywords'. |
32120 | 62 ;; |
18254 | 63 ;; * List of regular expressions to be placed in auto-mode-alist. |
64 ;; | |
65 ;; * List of functions to call to do some additional setup | |
66 ;; | |
67 ;; This should pretty much cover basic functionality; if you need much | |
68 ;; more than this, or you find yourself writing extensive customizations, | |
69 ;; perhaps you should be writing a major mode instead! | |
70 ;; | |
71 ;; LOCAL VARIABLES: | |
72 ;; | |
73 ;; To put a file into generic mode using local variables, use a line | |
74 ;; like this in a Local Variables block: | |
75 ;; | |
76 ;; mode: default-generic | |
77 ;; | |
78 ;; Do NOT use "mode: generic"! | |
79 ;; See also "AUTOMATICALLY ENTERING GENERIC MODE" below. | |
32120 | 80 ;; |
18254 | 81 ;; DEFINING NEW GENERIC MODES: |
82 ;; | |
21182 | 83 ;; Use the `define-generic-mode' function to define new modes. |
18254 | 84 ;; For example: |
85 ;; | |
86 ;; (define-generic-mode 'foo-generic-mode | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
87 ;; (list ?%) |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
88 ;; (list "keyword") |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
89 ;; nil |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
90 ;; (list "\\.FOO\\'") |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
91 ;; (list 'foo-setup-function)) |
18254 | 92 ;; |
21182 | 93 ;; defines a new generic-mode `foo-generic-mode', which has '%' as a |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
94 ;; comment character, and "keyword" as a keyword. When files which |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
95 ;; end in '.FOO' are loaded, Emacs will go into foo-generic-mode and |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
96 ;; call foo-setup-function. You can also use the function |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
97 ;; `foo-generic-mode' (which is interactive) to put a buffer into |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
98 ;; foo-generic-mode. |
18254 | 99 ;; |
100 ;; AUTOMATICALLY ENTERING GENERIC MODE: | |
101 ;; | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
102 ;; Generic-mode provides a hook which automatically puts a file into |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
103 ;; default-generic-mode if the first few lines of a file in |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
104 ;; fundamental mode start with a hash comment character. To disable |
21182 | 105 ;; this functionality, set the variable `generic-use-find-file-hook' |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
106 ;; to nil BEFORE loading generic-mode. See the variables |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
107 ;; `generic-lines-to-scan' and `generic-find-file-regexp' for |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
108 ;; customization options. |
32120 | 109 ;; |
18254 | 110 ;; GOTCHAS: |
111 ;; | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
112 ;; Be careful that your font-lock definitions are correct. Getting |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
113 ;; them wrong can cause Emacs to continually attempt to fontify! This |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
114 ;; problem is not specific to generic-mode. |
32120 | 115 ;; |
18254 | 116 |
21057 | 117 ;; Credit for suggestions, brainstorming, help with debugging: |
18254 | 118 ;; ACorreir@pervasive-sw.com (Alfred Correira) |
32120 | 119 ;; Extensive cleanup by: |
120 ;; Stefan Monnier (monnier+gnu/emacs@flint.cs.yale.edu) | |
121 ;; | |
122 ;;; Code: | |
18254 | 123 |
124 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
21077
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
125 ;; Internal Variables |
18254 | 126 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
127 | |
60870
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
128 (defvar generic-font-lock-keywords nil |
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
129 "Keywords for `font-lock-defaults' in a generic mode.") |
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
130 (make-variable-buffer-local 'generic-font-lock-keywords) |
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
131 (defvaralias 'generic-font-lock-defaults 'generic-font-lock-keywords) |
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
132 (make-obsolete-variable 'generic-font-lock-defaults 'generic-font-lock-keywords "22.1") |
18254 | 133 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
134 ;;;###autoload |
32120 | 135 (defvar generic-mode-list nil |
136 "A list of mode names for `generic-mode'. | |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
137 Do not add entries to this list directly; use `define-generic-mode' |
18254 | 138 instead (which see).") |
139 | |
21077
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
140 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
141 ;; Customization Variables |
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
142 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
143 |
21879
14316c9ecdac
(generic): Added defgroup declaration.
Richard M. Stallman <rms@gnu.org>
parents:
21182
diff
changeset
|
144 (defgroup generic nil |
14316c9ecdac
(generic): Added defgroup declaration.
Richard M. Stallman <rms@gnu.org>
parents:
21182
diff
changeset
|
145 "Define simple major modes with comment and font-lock support." |
14316c9ecdac
(generic): Added defgroup declaration.
Richard M. Stallman <rms@gnu.org>
parents:
21182
diff
changeset
|
146 :prefix "generic-" |
14316c9ecdac
(generic): Added defgroup declaration.
Richard M. Stallman <rms@gnu.org>
parents:
21182
diff
changeset
|
147 :group 'extensions) |
14316c9ecdac
(generic): Added defgroup declaration.
Richard M. Stallman <rms@gnu.org>
parents:
21182
diff
changeset
|
148 |
21077
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
149 (defcustom generic-use-find-file-hook t |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
150 "*If non-nil, add a hook to enter `default-generic-mode' automatically. |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
151 This is done if the first few lines of a file in fundamental mode |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
152 start with a hash comment character." |
21077
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
153 :group 'generic |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
154 :type 'boolean) |
18254 | 155 |
21077
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
156 (defcustom generic-lines-to-scan 3 |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
157 "*Number of lines that `generic-mode-find-file-hook' looks at. |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
158 Relevant when deciding whether to enter Default-Generic mode automatically. |
21077
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
159 This variable should be set to a small positive number." |
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
160 :group 'generic |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
161 :type 'integer) |
18254 | 162 |
32120 | 163 (defcustom generic-find-file-regexp "^#" |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
164 "*Regular expression used by `generic-mode-find-file-hook'. |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
165 Files in fundamental mode whose first few lines contain a match |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
166 for this regexp, should be put into Default-Generic mode instead. |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
167 The number of lines tested for the matches is specified by the |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
168 value of the variable `generic-lines-to-scan', which see." |
21077
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
169 :group 'generic |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
170 :type 'regexp) |
18254 | 171 |
36124
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
172 (defcustom generic-ignore-files-regexp "[Tt][Aa][Gg][Ss]\\'" |
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
173 "*Regular expression used by `generic-mode-find-file-hook'. |
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
174 Files whose names match this regular expression should not be put |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
175 into Default-Generic mode, even if they have lines which match |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
176 the regexp in `generic-find-file-regexp'. If the value is nil, |
36124
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
177 `generic-mode-find-file-hook' does not check the file names." |
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
178 :group 'generic |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
179 :type '(choice (const :tag "Don't check file names" nil) regexp)) |
36124
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
180 |
18254 | 181 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
182 ;; Functions | |
183 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
184 | |
22347
f53740d7d40d
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21928
diff
changeset
|
185 ;;;###autoload |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
186 (defmacro define-generic-mode (mode comment-list keyword-list |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
187 font-lock-list auto-mode-list |
61241
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
188 function-list &optional docstring |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
189 &rest custom-keyword-args) |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
190 "Create a new generic mode MODE. |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
191 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
192 MODE is the name of the command for the generic mode; it need not |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
193 be quoted. The optional DOCSTRING is the documentation for the |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
194 mode command. If you do not supply it, a default documentation |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
195 string will be used instead. |
18254 | 196 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
197 COMMENT-LIST is a list, whose entries are either a single |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
198 character, a one or two character string or a cons pair. If the |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
199 entry is a character or a string, it is added to the mode's |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
200 syntax table with `comment-start' syntax. If the entry is a cons |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
201 pair, the elements of the pair are considered to be |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
202 `comment-start' and `comment-end' respectively. (The latter |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
203 should be nil if you want comments to end at end of line.) Note |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
204 that Emacs has limitations regarding comment characters. |
18254 | 205 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
206 KEYWORD-LIST is a list of keywords to highlight with |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
207 `font-lock-keyword-face'. Each keyword should be a string. |
18254 | 208 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
209 FONT-LOCK-LIST is a list of additional expressions to highlight. |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
210 Each entry in the list should have the same form as an entry in |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
211 `font-lock-keywords'. |
18254 | 212 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
213 AUTO-MODE-LIST is a list of regular expressions to add to |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
214 `auto-mode-alist'. These regexps are added to `auto-mode-alist' |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
215 as soon as `define-generic-mode' is called. |
18254 | 216 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
217 FUNCTION-LIST is a list of functions to call to do some |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
218 additional setup. |
18254 | 219 |
61241
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
220 The optional CUSTOM-KEYWORD-ARGS are pairs of keywords and |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
221 values. They will be passed to the generated `defcustom' form of |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
222 the mode hook variable MODE-hook. You can specify keyword |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
223 arguments without specifying a docstring. |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
224 |
21014 | 225 See the file generic-x.el for some examples of `define-generic-mode'." |
61183
20df42e1599e
(define-generic-mode): Add indentation rule.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
61169
diff
changeset
|
226 (declare (debug (sexp def-form def-form def-form form def-form |
20df42e1599e
(define-generic-mode): Add indentation rule.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
61169
diff
changeset
|
227 &optional stringp)) |
20df42e1599e
(define-generic-mode): Add indentation rule.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
61169
diff
changeset
|
228 (indent 1)) |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
229 |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
230 ;; Backward compatibility. |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
231 (when (eq (car-safe mode) 'quote) |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
232 (setq mode (eval mode))) |
61241
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
233 |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
234 (when (and docstring (not (stringp docstring))) |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
235 ;; DOCSTRING is not a string so we assume that it's actually the |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
236 ;; first keyword of CUSTOM-KEYWORD-ARGS. |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
237 (push docstring custom-keyword-args) |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
238 (setq docstring nil)) |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
239 |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
240 (let* ((mode-name (symbol-name mode)) |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
241 (pretty-name (capitalize (replace-regexp-in-string |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
242 "-mode\\'" "" mode-name))) |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
243 (mode-hook (intern (concat mode-name "-hook")))) |
18254 | 244 |
61241
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
245 (unless (plist-get custom-keyword-args :group) |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
246 (setq custom-keyword-args |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
247 (plist-put custom-keyword-args |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
248 :group `(or (custom-current-group) |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
249 ',(intern (replace-regexp-in-string |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
250 "-mode\\'" "" mode-name)))))) |
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
251 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
252 `(progn |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
253 ;; Add a new entry. |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
254 (add-to-list 'generic-mode-list ,mode-name) |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
255 |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
256 ;; Add it to auto-mode-alist |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
257 (dolist (re ,auto-mode-list) |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
258 (add-to-list 'auto-mode-alist (cons re ',mode))) |
32120 | 259 |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
260 (defcustom ,mode-hook nil |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
261 ,(concat "Hook run when entering " pretty-name " mode.") |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
262 :type 'hook |
61241
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
263 ,@custom-keyword-args) |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
264 |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
265 (defun ,mode () |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
266 ,(or docstring |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
267 (concat pretty-name " mode.\n" |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
268 "This a generic mode defined with `define-generic-mode'.")) |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
269 (interactive) |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
270 (generic-mode-internal ',mode ,comment-list ,keyword-list |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
271 ,font-lock-list ,function-list))))) |
18254 | 272 |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
273 ;;;###autoload |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
274 (defun generic-mode-internal (mode comment-list keyword-list |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
275 font-lock-list function-list) |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
276 "Go into the generic mode MODE." |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
277 (let* ((mode-name (symbol-name mode)) |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
278 (pretty-name (capitalize (replace-regexp-in-string |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
279 "-mode\\'" "" mode-name))) |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
280 (mode-hook (intern (concat mode-name "-hook")))) |
18254 | 281 |
282 (kill-all-local-variables) | |
283 | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
284 (setq major-mode mode |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
285 mode-name pretty-name) |
18254 | 286 |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
287 (generic-mode-set-comments comment-list) |
18254 | 288 |
60870
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
289 ;; Font-lock functionality. |
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
290 ;; Font-lock-defaults is always set even if there are no keywords |
18254 | 291 ;; or font-lock expressions, so comments can be highlighted. |
60870
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
292 (setq generic-font-lock-keywords |
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
293 (append |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
294 (when keyword-list |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
295 (list (generic-make-keywords-list keyword-list |
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
296 font-lock-keyword-face))) |
60870
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
297 font-lock-list)) |
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
298 (setq font-lock-defaults '(generic-font-lock-keywords nil)) |
18254 | 299 |
300 ;; Call a list of functions | |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
301 (mapcar 'funcall function-list) |
23392
d86ad410d285
(generic-mode-with-type): Added hooks for generic-modes.
Karl Heuer <kwzh@gnu.org>
parents:
22402
diff
changeset
|
302 |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
303 (run-mode-hooks mode-hook))) |
18254 | 304 |
305 ;;;###autoload | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
306 (defun generic-mode (mode) |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
307 "Enter generic mode MODE. |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
308 |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
309 Generic modes provide basic comment and font-lock functionality |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
310 for \"generic\" files. (Files which are too small to warrant their |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
311 own mode, but have comment characters, keywords, and the like.) |
18254 | 312 |
313 To define a generic-mode, use the function `define-generic-mode'. | |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
314 Some generic modes are defined in `generic-x.el'." |
18254 | 315 (interactive |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
316 (list (completing-read "Generic mode: " generic-mode-list nil t))) |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
317 (funcall (intern mode))) |
18254 | 318 |
319 ;;; Comment Functionality | |
320 (defun generic-mode-set-comments (comment-list) | |
321 "Set up comment functionality for generic mode." | |
32120 | 322 (let ((st (make-syntax-table)) |
323 (chars nil) | |
324 (comstyles)) | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
325 (make-local-variable 'comment-start) |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
326 (make-local-variable 'comment-start-skip) |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
327 (make-local-variable 'comment-end) |
18254 | 328 |
32120 | 329 ;; Go through all the comments |
330 (dolist (start comment-list) | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
331 (let (end (comstyle "")) |
32120 | 332 ;; Normalize |
333 (when (consp start) | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
334 (setq end (cdr start)) |
32120 | 335 (setq start (car start))) |
336 (when (char-valid-p start) (setq start (char-to-string start))) | |
58473
9aacf8e5ae58
(generic-mode-set-comments): Accept an empty comment-end.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57113
diff
changeset
|
337 (cond |
9aacf8e5ae58
(generic-mode-set-comments): Accept an empty comment-end.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57113
diff
changeset
|
338 ((char-valid-p end) (setq end (char-to-string end))) |
9aacf8e5ae58
(generic-mode-set-comments): Accept an empty comment-end.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57113
diff
changeset
|
339 ((zerop (length end)) (setq end "\n"))) |
18254 | 340 |
32120 | 341 ;; Setup the vars for `comment-region' |
342 (if comment-start | |
343 ;; We have already setup a comment-style, so use style b | |
344 (progn | |
345 (setq comstyle "b") | |
346 (setq comment-start-skip | |
347 (concat comment-start-skip "\\|" (regexp-quote start) "+\\s-*"))) | |
348 ;; First comment-style | |
349 (setq comment-start start) | |
37058
a2e5f00c1254
(generic-mode-set-comments): Use "" rather than nil for comment-end.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
36124
diff
changeset
|
350 (setq comment-end (if (string-equal end "\n") "" end)) |
32120 | 351 (setq comment-start-skip (concat (regexp-quote start) "+\\s-*"))) |
18254 | 352 |
32120 | 353 ;; Reuse comstyles if necessary |
354 (setq comstyle | |
355 (or (cdr (assoc start comstyles)) | |
356 (cdr (assoc end comstyles)) | |
357 comstyle)) | |
358 (push (cons start comstyle) comstyles) | |
359 (push (cons end comstyle) comstyles) | |
18254 | 360 |
32120 | 361 ;; Setup the syntax table |
362 (if (= (length start) 1) | |
363 (modify-syntax-entry (string-to-char start) | |
364 (concat "< " comstyle) st) | |
365 (let ((c0 (elt start 0)) (c1 (elt start 1))) | |
366 ;; Store the relevant info but don't update yet | |
367 (push (cons c0 (concat (cdr (assoc c0 chars)) "1")) chars) | |
368 (push (cons c1 (concat (cdr (assoc c1 chars)) | |
369 (concat "2" comstyle))) chars))) | |
370 (if (= (length end) 1) | |
371 (modify-syntax-entry (string-to-char end) | |
372 (concat ">" comstyle) st) | |
373 (let ((c0 (elt end 0)) (c1 (elt end 1))) | |
374 ;; Store the relevant info but don't update yet | |
375 (push (cons c0 (concat (cdr (assoc c0 chars)) | |
376 (concat "3" comstyle))) chars) | |
377 (push (cons c1 (concat (cdr (assoc c1 chars)) "4")) chars))))) | |
18254 | 378 |
32120 | 379 ;; Process the chars that were part of a 2-char comment marker |
380 (dolist (cs (nreverse chars)) | |
381 (modify-syntax-entry (car cs) | |
382 (concat (char-to-string (char-syntax (car cs))) | |
383 " " (cdr cs)) | |
384 st)) | |
385 (set-syntax-table st))) | |
18254 | 386 |
387 (defun generic-bracket-support () | |
60870
92071f8a7671
(generic-font-lock-defaults): Make it obsolete.
Lute Kamstra <lute@gnu.org>
parents:
60849
diff
changeset
|
388 "Imenu support for [KEYWORD] constructs found in INF, INI and Samba files." |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
389 (setq imenu-generic-expression |
20459 | 390 '((nil "^\\[\\(.*\\)\\]" 1)) |
391 imenu-case-fold-search t)) | |
18254 | 392 |
393 ;; This generic mode is always defined | |
61241
3f688bd09fa4
(define-generic-mode): Add argument to specify keywords for defcustom.
Lute Kamstra <lute@gnu.org>
parents:
61183
diff
changeset
|
394 (define-generic-mode default-generic-mode (list ?#) nil nil nil nil :group 'generic) |
18254 | 395 |
396 ;; A more general solution would allow us to enter generic-mode for | |
397 ;; *any* comment character, but would require us to synthesize a new | |
398 ;; generic-mode on the fly. I think this gives us most of what we | |
399 ;; want. | |
400 (defun generic-mode-find-file-hook () | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
401 "Hook function to enter Default-Generic mode automatically. |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
402 |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
403 Done if the first few lines of a file in Fundamental mode start |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
404 with a match for the regexp in `generic-find-file-regexp', unless |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
405 the file's name matches the regexp which is the value of the |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
406 variable `generic-ignore-files-regexp'. |
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
407 |
36124
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
408 This hook will be installed if the variable |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
409 `generic-use-find-file-hook' is non-nil. The variable |
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
410 `generic-lines-to-scan' determines the number of lines to look at." |
36124
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
411 (when (and (eq major-mode 'fundamental-mode) |
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
412 (or (null generic-ignore-files-regexp) |
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
413 (not (string-match |
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
414 generic-ignore-files-regexp |
5eb6597319ec
(generic-find-file-regexp): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
34814
diff
changeset
|
415 (file-name-sans-versions buffer-file-name))))) |
32120 | 416 (save-excursion |
417 (goto-char (point-min)) | |
418 (when (re-search-forward generic-find-file-regexp | |
419 (save-excursion | |
420 (forward-line generic-lines-to-scan) | |
421 (point)) t) | |
18254 | 422 (goto-char (point-min)) |
32120 | 423 (default-generic-mode))))) |
18254 | 424 |
425 (defun generic-mode-ini-file-find-file-hook () | |
60773
1771db839aa6
Fix commentary section. Don't require cl for compilation.
Lute Kamstra <lute@gnu.org>
parents:
60595
diff
changeset
|
426 "Hook function to enter Default-Generic mode automatically for INI files. |
61169
e2b959792f0f
(define-generic-mode): Add debug declaration. Add defcustom for the
Lute Kamstra <lute@gnu.org>
parents:
60902
diff
changeset
|
427 Done if the first few lines of a file in Fundamental mode look like an |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
428 INI file. This hook is NOT installed by default." |
21077
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
429 (and (eq major-mode 'fundamental-mode) |
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
430 (save-excursion |
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
431 (goto-char (point-min)) |
4b5c8a2ce0b2
(generic-mode-ini-file-find-file-hook): Use and-s instead of if-s.
Richard M. Stallman <rms@gnu.org>
parents:
21057
diff
changeset
|
432 (and (looking-at "^\\s-*\\[.*\\]") |
32120 | 433 (ini-generic-mode))))) |
18254 | 434 |
435 (and generic-use-find-file-hook | |
60902
7160fe3a7ef1
find-file-hooks -> find-file-hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
60870
diff
changeset
|
436 (add-hook 'find-file-hook 'generic-mode-find-file-hook)) |
18254 | 437 |
60849
cb4033032773
(generic-make-keywords-list): Add autoload cookie.
Lute Kamstra <lute@gnu.org>
parents:
60773
diff
changeset
|
438 ;;;###autoload |
18254 | 439 (defun generic-make-keywords-list (keywords-list face &optional prefix suffix) |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
440 "Return a regular expression matching the specified KEYWORDS-LIST. |
18254 | 441 The regexp is highlighted with FACE." |
32120 | 442 (unless (listp keywords-list) |
443 (error "Keywords argument must be a list of strings")) | |
57113
5bd3a1e1dfe5
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-549
Miles Bader <miles@gnu.org>
parents:
55555
diff
changeset
|
444 (list (concat prefix "\\_<" |
21879
14316c9ecdac
(generic): Added defgroup declaration.
Richard M. Stallman <rms@gnu.org>
parents:
21182
diff
changeset
|
445 ;; Use an optimized regexp. |
14316c9ecdac
(generic): Added defgroup declaration.
Richard M. Stallman <rms@gnu.org>
parents:
21182
diff
changeset
|
446 (regexp-opt keywords-list t) |
57113
5bd3a1e1dfe5
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-549
Miles Bader <miles@gnu.org>
parents:
55555
diff
changeset
|
447 "\\_>" suffix) |
21879
14316c9ecdac
(generic): Added defgroup declaration.
Richard M. Stallman <rms@gnu.org>
parents:
21182
diff
changeset
|
448 1 |
21928
42fa0da05721
(generic-make-keywords-list): Delete spurious paren.
Richard M. Stallman <rms@gnu.org>
parents:
21879
diff
changeset
|
449 face)) |
18254 | 450 |
21013
adb28ace7f33
Provide generic, not generic-mode.
Richard M. Stallman <rms@gnu.org>
parents:
20459
diff
changeset
|
451 (provide 'generic) |
18254 | 452 |
58473
9aacf8e5ae58
(generic-mode-set-comments): Accept an empty comment-end.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57113
diff
changeset
|
453 ;; arch-tag: 239c1fc4-1303-48d9-9ac0-657d655669ea |
24022
218b7edb9baf
Re-write `(make-variable-buffer-local (defvar ...'
Dave Love <fx@gnu.org>
parents:
23392
diff
changeset
|
454 ;;; generic.el ends here |