annotate lisp/emacs-lisp/generic.el @ 62260:a0af6e05c03a

(define-generic-mode): Don't generate a defcustom for the mode hook variable. Delete the last argument.
author Lute Kamstra <lute@gnu.org>
date Thu, 12 May 2005 13:23:31 +0000
parents f3e1b2ceffd2
children 18a818a2ee7c f042e7c0fe20
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 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
3 ;; Copyright (C) 1997, 1999, 2004, 2005 Free Software Foundation, Inc.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
4 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
5 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
6 ;; Created: Fri Sep 27 1996
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
7 ;; Keywords: generic, comment, font-lock
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
8
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
10
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
14 ;; any later version.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
15
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
16 ;; 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
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
20
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
24 ;; Boston, MA 02111-1307, USA.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
25
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
27
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
28 ;; INTRODUCTION:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
29 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
30 ;; 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
31 ;; 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
32 ;; 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
33 ;; 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
34 ;; characters and the like.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
35 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
36 ;; Each generic mode can define the following:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
37 ;;
61931
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
38 ;; * List of comment-characters. The elements of this list should be
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
39 ;; 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
40 ;; 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
41 ;; the mode's syntax table with "comment starter" syntax. If the
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
42 ;; 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
43 ;; considered the "comment starter" and "comment ender"
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
44 ;; respectively. (The latter should be nil if you want comments to
f3e1b2ceffd2 Improve commentary section.
Lute Kamstra <lute@gnu.org>
parents: 61916
diff changeset
45 ;; 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
46 ;; strings of more than two characters in length.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
47 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
48 ;; * 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
49 ;; 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
50 ;; 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
51 ;; convenience function `generic-make-keywords-list' (which see),
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
52 ;; and add the result to the following list:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
53 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
54 ;; * 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
55 ;; 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
56 ;; `font-lock-keywords'.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
57 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
58 ;; * 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
59 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
60 ;; * List of functions to call to do some additional setup
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
61 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
62 ;; 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
63 ;; more than this, or you find yourself writing extensive customizations,
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
64 ;; perhaps you should be writing a major mode instead!
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
65 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
66 ;; EXAMPLE:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
67 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
68 ;; You can use `define-generic-mode' like this:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
69 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
70 ;; (define-generic-mode 'foo-generic-mode
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
71 ;; (list ?%)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
72 ;; (list "keyword")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
73 ;; nil
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
74 ;; (list "\\.FOO\\'")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
75 ;; (list 'foo-setup-function))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
76 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
77 ;; 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
78 ;; comment character, and "keyword" as a keyword. When files which
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
79 ;; 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
80 ;; call foo-setup-function. You can also use the function
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
81 ;; `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
82 ;; foo-generic-mode.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
83 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
84 ;; GOTCHAS:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
85 ;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
86 ;; Be careful that your font-lock definitions are correct. Getting
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
87 ;; 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
88 ;; problem is not specific to generic-mode.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
89
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
90 ;; Credit for suggestions, brainstorming, help with debugging:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
91 ;; ACorreir@pervasive-sw.com (Alfred Correira)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
92 ;; Extensive cleanup by:
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
93 ;; Stefan Monnier (monnier+gnu/emacs@flint.cs.yale.edu)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
94
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
95 ;;; Code:
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
98 ;; Internal Variables
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
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
101 (defvar generic-font-lock-keywords nil
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
102 "Keywords for `font-lock-defaults' in a generic mode.")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
103 (make-variable-buffer-local 'generic-font-lock-keywords)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
104 (defvaralias 'generic-font-lock-defaults 'generic-font-lock-keywords)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
105 (make-obsolete-variable 'generic-font-lock-defaults 'generic-font-lock-keywords "22.1")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
106
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
107 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
108 (defvar generic-mode-list nil
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
109 "A list of mode names for `generic-mode'.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
110 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
111 instead (which see).")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
112
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 ;; Functions
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
115 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
116
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
117 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
118 (defmacro define-generic-mode (mode comment-list keyword-list
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
119 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
120 function-list &optional docstring)
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
121 "Create a new generic mode MODE.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
122
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
123 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
124 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
125 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
126 documentation string instead.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
127
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
128 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
129 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
130 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
131 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
132 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
133 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
134 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
135 enders are actually possible.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
136
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
137 KEYWORD-LIST is a list of keywords to highlight with
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
138 `font-lock-keyword-face'. Each keyword should be a string.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
139
62260
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-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
141 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
142 `font-lock-keywords'.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
143
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
144 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
145 `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
146 runs the macro expansion.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
147
62260
a0af6e05c03a (define-generic-mode): Don't generate a defcustom for the mode hook
Lute Kamstra <lute@gnu.org>
parents: 61931
diff changeset
148 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
149 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
150 mode hook `MODE-hook'.
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
151
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
152 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
153 (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
154 [&optional stringp] &rest [keywordp form]))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
155 (indent 1))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
156
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
157 ;; Backward compatibility.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
158 (when (eq (car-safe mode) 'quote)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
159 (setq mode (eval mode)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
160
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
161 (let* ((name (symbol-name mode))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
162 (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
163 "-mode\\'" "" name))))
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
164
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
165 `(progn
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
166 ;; Add a new entry.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
167 (add-to-list 'generic-mode-list ,name)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
168
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
169 ;; Add it to auto-mode-alist
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
170 (dolist (re ,auto-mode-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
171 (add-to-list 'auto-mode-alist (cons re ',mode)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
172
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
173 (defun ,mode ()
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
174 ,(or docstring
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
175 (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
176 "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
177 "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
178 (interactive)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
179 (generic-mode-internal ',mode ,comment-list ,keyword-list
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
180 ,font-lock-list ,function-list)))))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
181
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
182 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
183 (defun generic-mode-internal (mode comment-list keyword-list
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
184 font-lock-list function-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
185 "Go into the generic mode MODE."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
186 (let* ((name (symbol-name mode))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
187 (pretty-name (capitalize (replace-regexp-in-string
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
188 "-mode\\'" "" name)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
189 (mode-hook (intern (concat name "-hook"))))
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 (kill-all-local-variables)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
192
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
193 (setq major-mode mode
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
194 mode-name pretty-name)
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 (generic-mode-set-comments comment-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
197
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
198 ;; Font-lock functionality.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
199 ;; 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
200 ;; or font-lock expressions, so comments can be highlighted.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
201 (setq generic-font-lock-keywords font-lock-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
202 (when keyword-list
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
203 (push (concat "\\_<" (regexp-opt keyword-list t) "\\_>")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
204 generic-font-lock-keywords))
61904
114b2859d567 (generic-mode-internal): Simplify font-lock-defaults.
Lute Kamstra <lute@gnu.org>
parents: 61521
diff changeset
205 (setq font-lock-defaults '(generic-font-lock-keywords))
61521
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
206
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
207 ;; Call a list of functions
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
208 (mapcar 'funcall function-list)
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 (run-mode-hooks mode-hook)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
211
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
212 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
213 (defun generic-mode (mode)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
214 "Enter generic mode MODE.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
215
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
216 Generic modes provide basic comment and font-lock functionality
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
217 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
218 own mode, but have comment characters, keywords, and the like.)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
219
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
220 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
221 Some generic modes are defined in `generic-x.el'."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
222 (interactive
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
223 (list (completing-read "Generic mode: " generic-mode-list nil t)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
224 (funcall (intern mode)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
225
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
226 ;;; Comment Functionality
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
227 (defun generic-mode-set-comments (comment-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
228 "Set up comment functionality for generic mode."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
229 (let ((st (make-syntax-table))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
230 (chars nil)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
231 (comstyles))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
232 (make-local-variable 'comment-start)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
233 (make-local-variable 'comment-start-skip)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
234 (make-local-variable 'comment-end)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
235
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
236 ;; Go through all the comments
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
237 (dolist (start comment-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
238 (let (end (comstyle ""))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
239 ;; Normalize
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
240 (when (consp start)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
241 (setq end (cdr start))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
242 (setq start (car start)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
243 (when (char-valid-p start) (setq start (char-to-string start)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
244 (cond
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
245 ((char-valid-p end) (setq end (char-to-string end)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
246 ((zerop (length end)) (setq end "\n")))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
247
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
248 ;; Setup the vars for `comment-region'
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
249 (if comment-start
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
250 ;; 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
251 (progn
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
252 (setq comstyle "b")
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
253 (setq comment-start-skip
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
254 (concat comment-start-skip "\\|" (regexp-quote start) "+\\s-*")))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
255 ;; First comment-style
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
256 (setq comment-start start)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
257 (setq comment-end (if (string-equal end "\n") "" end))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
258 (setq comment-start-skip (concat (regexp-quote start) "+\\s-*")))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
259
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
260 ;; Reuse comstyles if necessary
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
261 (setq comstyle
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
262 (or (cdr (assoc start comstyles))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
263 (cdr (assoc end comstyles))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
264 comstyle))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
265 (push (cons start comstyle) comstyles)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
266 (push (cons end comstyle) comstyles)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
267
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
268 ;; Setup the syntax table
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
269 (if (= (length start) 1)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
270 (modify-syntax-entry (string-to-char start)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
271 (concat "< " comstyle) st)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
272 (let ((c0 (elt start 0)) (c1 (elt start 1)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
273 ;; Store the relevant info but don't update yet
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
274 (push (cons c0 (concat (cdr (assoc c0 chars)) "1")) chars)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
275 (push (cons c1 (concat (cdr (assoc c1 chars))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
276 (concat "2" comstyle))) chars)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
277 (if (= (length end) 1)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
278 (modify-syntax-entry (string-to-char end)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
279 (concat ">" comstyle) st)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
280 (let ((c0 (elt end 0)) (c1 (elt end 1)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
281 ;; Store the relevant info but don't update yet
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
282 (push (cons c0 (concat (cdr (assoc c0 chars))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
283 (concat "3" comstyle))) chars)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
284 (push (cons c1 (concat (cdr (assoc c1 chars)) "4")) chars)))))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
285
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
286 ;; 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
287 (dolist (cs (nreverse chars))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
288 (modify-syntax-entry (car cs)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
289 (concat (char-to-string (char-syntax (car cs)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
290 " " (cdr cs))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
291 st))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
292 (set-syntax-table st)))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
293
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
294 (defun generic-bracket-support ()
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
295 "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
296 (setq imenu-generic-expression
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
297 '((nil "^\\[\\(.*\\)\\]" 1))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
298 imenu-case-fold-search t))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
299
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
300 ;;;###autoload
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
301 (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
302 "Return a `font-lock-keywords' construct that highlights KEYWORD-LIST.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
303 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
304 highlighted with face FACE. This function calculates a regular
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
305 expression that matches these keywords and concatenates it with
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
306 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
307 regular expression that can be used as an element of
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
308 `font-lock-keywords'."
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
309 (unless (listp keyword-list)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
310 (error "Keywords argument must be a list of strings"))
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
311 (list (concat prefix "\\_<"
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
312 ;; Use an optimized regexp.
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
313 (regexp-opt keyword-list t)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
314 "\\_>" suffix)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
315 1
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
316 face))
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 (provide 'generic)
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
319
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
320 ;; arch-tag: 239c1fc4-1303-48d9-9ac0-657d655669ea
2f8b7bd746aa Move here from parent dir.
Lute Kamstra <lute@gnu.org>
parents:
diff changeset
321 ;;; generic.el ends here