annotate lisp/emacs-lisp/generic.el @ 103855:6479d8a2ebcf

(describe-character-set): Don't show width.
author Kenichi Handa <handa@m17n.org>
date Sat, 11 Jul 2009 06:36:14 +0000
parents a9dc0e7c3f2b
children 1d1d5d9bd884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
1 ;;; generic.el --- defining simple major modes with comment and font-lock
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
2 ;;
74466
1d4b1a32fd66 Update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 68648
diff changeset
3 ;; Copyright (C) 1997, 1999, 2001, 2002, 2003, 2004,
100908
a9dc0e7c3f2b Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 94655
diff changeset
4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
5 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
6 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
7 ;; Created: Fri Sep 27 1996
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
8 ;; Keywords: generic, comment, font-lock
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
9
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
10 ;; This file is part of GNU Emacs.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
11
94655
90a2847062be Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 91327
diff changeset
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
94655
90a2847062be Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 91327
diff changeset
14 ;; the Free Software Foundation, either version 3 of the License, or
90a2847062be Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 91327
diff changeset
15 ;; (at your option) any later version.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
16
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
20 ;; GNU General Public License for more details.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
21
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
94655
90a2847062be Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 91327
diff changeset
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
24
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
25 ;;; Commentary:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
26
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
27 ;; INTRODUCTION:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
28 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
29 ;; The macro `define-generic-mode' can be used to define small modes
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
30 ;; which provide basic comment and font-lock support. These modes are
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
31 ;; intended for the many configuration files and such which are too
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
32 ;; small for a "real" mode, but still have a regular syntax, comment
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
33 ;; characters and the like.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
34 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
35 ;; Each generic mode can define the following:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
36 ;;
61931
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
37 ;; * List of comment-characters. The elements of this list should be
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
38 ;; either a character, a one or two character string, or a cons
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
39 ;; cell. If the entry is a character or a string, it is added to
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
40 ;; the mode's syntax table with "comment starter" syntax. If the
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
41 ;; entry is a cons cell, the `car' and `cdr' of the pair are
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
42 ;; considered the "comment starter" and "comment ender"
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
43 ;; respectively. (The latter should be nil if you want comments to
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
44 ;; end at the end of the line.) Emacs does not support comment
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
45 ;; strings of more than two characters in length.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
46 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
47 ;; * List of keywords to font-lock. Each keyword should be a string.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
48 ;; If you have additional keywords which should be highlighted in a
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
49 ;; face different from `font-lock-keyword-face', you can use the
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
50 ;; convenience function `generic-make-keywords-list' (which see),
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
51 ;; and add the result to the following list:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
52 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
53 ;; * Additional expressions to font-lock. This should be a list of
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
54 ;; expressions, each of which should be of the same form as those in
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
55 ;; `font-lock-keywords'.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
56 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
57 ;; * List of regular expressions to be placed in auto-mode-alist.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
58 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
59 ;; * List of functions to call to do some additional setup
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
60 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
61 ;; This should pretty much cover basic functionality; if you need much
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
62 ;; more than this, or you find yourself writing extensive customizations,
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
63 ;; perhaps you should be writing a major mode instead!
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
64 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
65 ;; EXAMPLE:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
66 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
67 ;; You can use `define-generic-mode' like this:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
68 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
69 ;; (define-generic-mode 'foo-generic-mode
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
70 ;; (list ?%)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
71 ;; (list "keyword")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
72 ;; nil
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
73 ;; (list "\\.FOO\\'")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
74 ;; (list 'foo-setup-function))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
75 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
76 ;; to define a new generic-mode `foo-generic-mode', which has '%' as a
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
77 ;; comment character, and "keyword" as a keyword. When files which
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
78 ;; end in '.FOO' are loaded, Emacs will go into foo-generic-mode and
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
79 ;; call foo-setup-function. You can also use the function
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
80 ;; `foo-generic-mode' (which is interactive) to put a buffer into
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
81 ;; foo-generic-mode.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
82 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
83 ;; GOTCHAS:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
84 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
85 ;; Be careful that your font-lock definitions are correct. Getting
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
86 ;; them wrong can cause Emacs to continually attempt to fontify! This
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
87 ;; problem is not specific to generic-mode.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
88
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
89 ;; Credit for suggestions, brainstorming, help with debugging:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
90 ;; ACorreir@pervasive-sw.com (Alfred Correira)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
91 ;; Extensive cleanup by:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
92 ;; Stefan Monnier (monnier+gnu/emacs@flint.cs.yale.edu)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
93
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
94 ;;; Code:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
95
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
96 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
97 ;; Internal Variables
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
98 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
99
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
100 (defvar generic-font-lock-keywords nil
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
101 "Keywords for `font-lock-defaults' in a generic mode.")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
102 (make-variable-buffer-local 'generic-font-lock-keywords)
64908
45df3993d950 (generic-font-lock-defaults): Declare with define-obsolete-variable-alias.
Lute Kamstra <lute@gnu.org>
parents: 64751
diff changeset
103 (define-obsolete-variable-alias 'generic-font-lock-defaults 'generic-font-lock-keywords "22.1")
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
104
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
105 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
106 (defvar generic-mode-list nil
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
107 "A list of mode names for `generic-mode'.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
108 Do not add entries to this list directly; use `define-generic-mode'
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
109 instead (which see).")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
110
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
111 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
112 ;; Functions
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
113 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
114
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
115 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
116 (defmacro define-generic-mode (mode comment-list keyword-list
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
117 font-lock-list auto-mode-list
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
118 function-list &optional docstring)
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
119 "Create a new generic mode MODE.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
120
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
121 MODE is the name of the command for the generic mode; don't quote it.
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
122 The optional DOCSTRING is the documentation for the mode command. If
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
123 you do not supply it, `define-generic-mode' uses a default
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
124 documentation string instead.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
125
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
126 COMMENT-LIST is a list in which each element is either a character, a
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
127 string of one or two characters, or a cons cell. A character or a
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
128 string is set up in the mode's syntax table as a \"comment starter\".
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
129 If the entry is a cons cell, the `car' is set up as a \"comment
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
130 starter\" and the `cdr' as a \"comment ender\". (Use nil for the
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
131 latter if you want comments to end at the end of the line.) Note that
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
132 the syntax table has limitations about what comment starters and
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
133 enders are actually possible.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
134
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
135 KEYWORD-LIST is a list of keywords to highlight with
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
136 `font-lock-keyword-face'. Each keyword should be a string.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
137
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
138 FONT-LOCK-LIST is a list of additional expressions to highlight. Each
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
139 element of this list should have the same form as an element of
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
140 `font-lock-keywords'.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
141
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
142 AUTO-MODE-LIST is a list of regular expressions to add to
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
143 `auto-mode-alist'. These regular expressions are added when Emacs
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
144 runs the macro expansion.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
145
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
146 FUNCTION-LIST is a list of functions to call to do some additional
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
147 setup. The mode command calls these functions just before it runs the
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
148 mode hook `MODE-hook'.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
149
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
150 See the file generic-x.el for some examples of `define-generic-mode'."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
151 (declare (debug (sexp def-form def-form def-form form def-form
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
152 [&optional stringp] &rest [keywordp form]))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
153 (indent 1))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
154
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
155 ;; Backward compatibility.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
156 (when (eq (car-safe mode) 'quote)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
157 (setq mode (eval mode)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
158
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
159 (let* ((name (symbol-name mode))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
160 (pretty-name (capitalize (replace-regexp-in-string
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
161 "-mode\\'" "" name))))
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
162
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
163 `(progn
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
164 ;; Add a new entry.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
165 (add-to-list 'generic-mode-list ,name)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
166
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
167 ;; Add it to auto-mode-alist
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
168 (dolist (re ,auto-mode-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
169 (add-to-list 'auto-mode-alist (cons re ',mode)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
170
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
171 (defun ,mode ()
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
172 ,(or docstring
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
173 (concat pretty-name " mode.\n"
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
174 "This a generic mode defined with `define-generic-mode'.\n"
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
175 "It runs `" name "-hook' as the last thing it does."))
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
176 (interactive)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
177 (generic-mode-internal ',mode ,comment-list ,keyword-list
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
178 ,font-lock-list ,function-list)))))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
179
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
180 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
181 (defun generic-mode-internal (mode comment-list keyword-list
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
182 font-lock-list function-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
183 "Go into the generic mode MODE."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
184 (let* ((name (symbol-name mode))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
185 (pretty-name (capitalize (replace-regexp-in-string
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
186 "-mode\\'" "" name)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
187 (mode-hook (intern (concat name "-hook"))))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
188
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
189 (kill-all-local-variables)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
190
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
191 (setq major-mode mode
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
192 mode-name pretty-name)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
193
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
194 (generic-mode-set-comments comment-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
195
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
196 ;; Font-lock functionality.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
197 ;; Font-lock-defaults is always set even if there are no keywords
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
198 ;; or font-lock expressions, so comments can be highlighted.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
199 (setq generic-font-lock-keywords font-lock-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
200 (when keyword-list
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
201 (push (concat "\\_<" (regexp-opt keyword-list t) "\\_>")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
202 generic-font-lock-keywords))
61904
114b2859d567 (generic-mode-internal): Simplify font-lock-defaults.
Lute Kamstra <lute@gnu.org>
parents: 61521
diff changeset
203 (setq font-lock-defaults '(generic-font-lock-keywords))
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
204
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
205 ;; Call a list of functions
84901
c22466a5f332 (generic-mode-internal): Use `mapc' rather than `mapcar'.
Juanma Barranquero <lekktu@gmail.com>
parents: 78217
diff changeset
206 (mapc 'funcall function-list)
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
207
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
208 (run-mode-hooks mode-hook)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
209
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
210 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
211 (defun generic-mode (mode)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
212 "Enter generic mode MODE.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
213
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
214 Generic modes provide basic comment and font-lock functionality
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
215 for \"generic\" files. (Files which are too small to warrant their
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
216 own mode, but have comment characters, keywords, and the like.)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
217
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
218 To define a generic-mode, use the function `define-generic-mode'.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
219 Some generic modes are defined in `generic-x.el'."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
220 (interactive
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
221 (list (completing-read "Generic mode: " generic-mode-list nil t)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
222 (funcall (intern mode)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
223
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
224 ;;; Comment Functionality
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
225 (defun generic-mode-set-comments (comment-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
226 "Set up comment functionality for generic mode."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
227 (let ((st (make-syntax-table))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
228 (chars nil)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
229 (comstyles))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
230 (make-local-variable 'comment-start)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
231 (make-local-variable 'comment-start-skip)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
232 (make-local-variable 'comment-end)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
233
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
234 ;; Go through all the comments
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
235 (dolist (start comment-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
236 (let (end (comstyle ""))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
237 ;; Normalize
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
238 (when (consp start)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
239 (setq end (cdr start))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
240 (setq start (car start)))
90143
146c086df160 Revision: miles@gnu.org--gnu-2005/emacs--unicode--0--patch-37
Miles Bader <miles@gnu.org>
parents: 61521
diff changeset
241 (when (characterp start) (setq start (char-to-string start)))
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
242 (cond
90143
146c086df160 Revision: miles@gnu.org--gnu-2005/emacs--unicode--0--patch-37
Miles Bader <miles@gnu.org>
parents: 61521
diff changeset
243 ((characterp end) (setq end (char-to-string end)))
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
244 ((zerop (length end)) (setq end "\n")))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
245
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
246 ;; Setup the vars for `comment-region'
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
247 (if comment-start
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
248 ;; We have already setup a comment-style, so use style b
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
249 (progn
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
250 (setq comstyle "b")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
251 (setq comment-start-skip
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
252 (concat comment-start-skip "\\|" (regexp-quote start) "+\\s-*")))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
253 ;; First comment-style
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
254 (setq comment-start start)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
255 (setq comment-end (if (string-equal end "\n") "" end))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
256 (setq comment-start-skip (concat (regexp-quote start) "+\\s-*")))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
257
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
258 ;; Reuse comstyles if necessary
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
259 (setq comstyle
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
260 (or (cdr (assoc start comstyles))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
261 (cdr (assoc end comstyles))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
262 comstyle))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
263 (push (cons start comstyle) comstyles)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
264 (push (cons end comstyle) comstyles)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
265
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
266 ;; Setup the syntax table
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
267 (if (= (length start) 1)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
268 (modify-syntax-entry (string-to-char start)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
269 (concat "< " comstyle) st)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
270 (let ((c0 (elt start 0)) (c1 (elt start 1)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
271 ;; Store the relevant info but don't update yet
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
272 (push (cons c0 (concat (cdr (assoc c0 chars)) "1")) chars)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
273 (push (cons c1 (concat (cdr (assoc c1 chars))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
274 (concat "2" comstyle))) chars)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
275 (if (= (length end) 1)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
276 (modify-syntax-entry (string-to-char end)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
277 (concat ">" comstyle) st)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
278 (let ((c0 (elt end 0)) (c1 (elt end 1)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
279 ;; Store the relevant info but don't update yet
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
280 (push (cons c0 (concat (cdr (assoc c0 chars))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
281 (concat "3" comstyle))) chars)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
282 (push (cons c1 (concat (cdr (assoc c1 chars)) "4")) chars)))))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
283
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
284 ;; Process the chars that were part of a 2-char comment marker
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
285 (dolist (cs (nreverse chars))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
286 (modify-syntax-entry (car cs)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
287 (concat (char-to-string (char-syntax (car cs)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
288 " " (cdr cs))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
289 st))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
290 (set-syntax-table st)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
291
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
292 (defun generic-bracket-support ()
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
293 "Imenu support for [KEYWORD] constructs found in INF, INI and Samba files."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
294 (setq imenu-generic-expression
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
295 '((nil "^\\[\\(.*\\)\\]" 1))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
296 imenu-case-fold-search t))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
297
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
298 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
299 (defun generic-make-keywords-list (keyword-list face &optional prefix suffix)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
300 "Return a `font-lock-keywords' construct that highlights KEYWORD-LIST.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
301 KEYWORD-LIST is a list of keyword strings that should be
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
302 highlighted with face FACE. This function calculates a regular
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
303 expression that matches these keywords and concatenates it with
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
304 PREFIX and SUFFIX. Then it returns a construct based on this
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
305 regular expression that can be used as an element of
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
306 `font-lock-keywords'."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
307 (unless (listp keyword-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
308 (error "Keywords argument must be a list of strings"))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
309 (list (concat prefix "\\_<"
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
310 ;; Use an optimized regexp.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
311 (regexp-opt keyword-list t)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
312 "\\_>" suffix)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
313 1
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
314 face))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
315
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
316 (provide 'generic)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
317
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
318 ;; arch-tag: 239c1fc4-1303-48d9-9ac0-657d655669ea
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
319 ;;; generic.el ends here