Mercurial > emacs
annotate lisp/emacs-lisp/regexp-opt.el @ 20483:141c2d41d39c
(toggle-enable-multibyte-characters): Doc fix.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 21 Dec 1997 01:49:03 +0000 |
parents | 013cea3890cb |
children | d2cb43703bfb |
rev | line source |
---|---|
18014 | 1 ;;; regexp-opt.el --- generate efficient regexps to match strings. |
2 | |
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc. | |
4 | |
5 ;; Author: Simon Marshall <simon@gnu.ai.mit.edu> | |
6 ;; Keywords: strings, regexps | |
7 | |
8 ;; This file is part of GNU Emacs. | |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
12 ;; the Free Software Foundation; either version 2, or (at your option) | |
13 ;; any later version. | |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
24 | |
25 ;;; Commentary: | |
26 | |
27 ;; The "opt" in "regexp-opt" stands for "optim\\(al\\|i\\(se\\|ze\\)\\)". | |
28 ;; | |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
29 ;; This package generates a regexp from a given list of strings (which matches |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
30 ;; one of those strings) so that the regexp generated by: |
18014 | 31 ;; |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
32 ;; (regexp-opt strings) |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
33 ;; |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
34 ;; is equivalent to, but more efficient than, the regexp generated by: |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
35 ;; |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
36 ;; (mapconcat 'regexp-quote strings "\\|") |
18014 | 37 ;; |
38 ;; For example: | |
39 ;; | |
40 ;; (let ((strings '("cond" "if" "when" "unless" "while" | |
41 ;; "let" "let*" "progn" "prog1" "prog2" | |
42 ;; "save-restriction" "save-excursion" "save-window-excursion" | |
43 ;; "save-current-buffer" "save-match-data" | |
44 ;; "catch" "throw" "unwind-protect" "condition-case"))) | |
45 ;; (concat "(" (regexp-opt strings t) "\\>")) | |
46 ;; => "(\\(c\\(atch\\|ond\\(ition-case\\)?\\)\\|if\\|let\\*?\\|prog[12n]\\|save-\\(current-buffer\\|excursion\\|match-data\\|restriction\\|window-excursion\\)\\|throw\\|un\\(less\\|wind-protect\\)\\|wh\\(en\\|ile\\)\\)\\>" | |
47 ;; | |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
48 ;; Searching using the above example `regexp-opt' regexp takes approximately |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
49 ;; two-thirds of the time taken using the equivalent `mapconcat' regexp. |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
50 |
18014 | 51 ;; Since this package was written to produce efficient regexps, not regexps |
52 ;; efficiently, it is probably not a good idea to in-line too many calls in | |
53 ;; your code, unless you use the following trick with `eval-when-compile': | |
54 ;; | |
55 ;; (defvar definition-regexp | |
56 ;; (eval-when-compile | |
57 ;; (concat "^(" | |
58 ;; (regexp-opt '("defun" "defsubst" "defmacro" "defalias" | |
59 ;; "defvar" "defconst") t) | |
60 ;; "\\>"))) | |
61 ;; | |
62 ;; The `byte-compile' code will be as if you had defined the variable thus: | |
63 ;; | |
64 ;; (defvar definition-regexp | |
65 ;; "^(\\(def\\(alias\\|const\\|macro\\|subst\\|un\\|var\\)\\)\\>") | |
66 ;; | |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
67 ;; Note that if you use this trick for all instances of `regexp-opt' and |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
68 ;; `regexp-opt-depth' in your code, regexp-opt.el would only have to be loaded |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
69 ;; at compile time. But note also that using this trick means that should |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
70 ;; regexp-opt.el be changed, perhaps to fix a bug or to add a feature to |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
71 ;; improve the efficiency of `regexp-opt' regexps, you would have to recompile |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
72 ;; your code for such changes to have effect in your code. |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
73 |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
74 ;; Originally written for font-lock.el, from an idea from Stig's hl319.el, with |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
75 ;; thanks for ideas also to Michael Ernst, Bob Glickstein and Dan Nicolaescu. |
18014 | 76 ;; Please don't tell me that it doesn't produce optimal regexps; I know that |
77 ;; already. For example, the above explanation for the meaning of "opt" would | |
78 ;; be more efficient as "optim\\(al\\|i[sz]e\\)", but this requires complex | |
79 ;; forward looking. But (ideas or) code to improve things (are) is welcome. | |
80 | |
81 ;;; Code: | |
82 | |
83 ;;;###autoload | |
84 (defun regexp-opt (strings &optional paren) | |
85 "Return a regexp to match a string in STRINGS. | |
19782 | 86 Each string should be unique in STRINGS and should not contain any regexps, |
87 quoted or not. If optional PAREN is non-nil, ensure that the returned regexp | |
88 is enclosed by at least one regexp grouping construct. | |
18014 | 89 The returned regexp is typically more efficient than the equivalent regexp: |
90 | |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
91 (let ((open-paren (if PAREN \"\\\\(\" \"\")) (close-paren (if PAREN \"\\\\)\" \"\"))) |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
92 (concat open-paren (mapconcat 'regexp-quote STRINGS \"\\\\|\") close-paren)) |
18014 | 93 |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
94 but typically contains more regexp grouping constructs. |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
95 Use `regexp-opt-depth' to count them." |
18014 | 96 (save-match-data |
97 ;; Recurse on the sorted list. | |
98 (let ((max-lisp-eval-depth (* 1024 1024)) | |
99 (completion-ignore-case nil)) | |
100 (regexp-opt-group (sort (copy-sequence strings) 'string-lessp) paren)))) | |
101 | |
102 ;;;###autoload | |
103 (defun regexp-opt-depth (regexp) | |
104 "Return the depth of REGEXP. | |
105 This means the number of regexp grouping constructs (parenthesised expressions) | |
106 in REGEXP." | |
107 (save-match-data | |
108 ;; Hack to signal an error if REGEXP does not have balanced parentheses. | |
109 (string-match regexp "") | |
110 ;; Count the number of open parentheses in REGEXP. | |
111 (let ((count 0) start) | |
112 (while (string-match "\\\\(" regexp start) | |
113 (setq count (1+ count) start (match-end 0))) | |
114 count))) | |
115 | |
116 ;;; Workhorse functions. | |
117 | |
118 (eval-when-compile | |
119 (require 'cl)) | |
120 | |
121 (unless (fboundp 'make-bool-vector) | |
122 (defalias 'make-bool-vector 'make-vector)) | |
123 | |
124 (defun regexp-opt-group (strings &optional paren lax) | |
125 ;; | |
126 ;; Return a regexp to match a string in STRINGS. | |
127 ;; If PAREN non-nil, output regexp parentheses around returned regexp. | |
128 ;; If LAX non-nil, don't output parentheses if it doesn't require them. | |
129 ;; Merges keywords to avoid backtracking in Emacs' regexp matcher. | |
130 ;; | |
131 ;; The basic idea is to find the shortest common prefix, remove it and | |
132 ;; recurse. If there is no prefix, we divide the list into two so that (at | |
133 ;; least) one half will have at least a one-character common prefix. | |
134 ;; | |
135 ;; Also we delay the addition of grouping parenthesis as long as possible | |
136 ;; until we're sure we need them, and try to remove one-character sequences | |
137 ;; so we can use character sets rather than grouping parenthesis. | |
138 ;; | |
139 (let* ((open-group (if paren "\\(" "")) | |
140 (close-group (if paren "\\)" "")) | |
141 (open-charset (if lax "" open-group)) | |
142 (close-charset (if lax "" close-group))) | |
143 (cond | |
144 ;; | |
145 ;; If there is only one string, just return it. | |
146 ((= (length strings) 1) | |
147 (if (= (length (car strings)) 1) | |
148 (concat open-charset (regexp-quote (car strings)) close-charset) | |
149 (concat open-group (regexp-quote (car strings)) close-group))) | |
150 ;; | |
151 ;; If there is an empty string, remove it and recurse on the rest. | |
152 ((= (length (car strings)) 0) | |
153 (concat open-charset | |
154 (regexp-opt-group (cdr strings) t t) "?" | |
155 close-charset)) | |
156 ;; | |
157 ;; If all are one-character strings, just return a character set. | |
158 ((= (length strings) (apply '+ (mapcar 'length strings))) | |
159 (concat open-charset | |
160 (regexp-opt-charset strings) | |
161 close-charset)) | |
162 ;; | |
163 ;; We have a list of different length strings. | |
164 (t | |
165 (let ((prefix (try-completion "" (mapcar 'list strings))) | |
166 (letters (let ((completion-regexp-list '("^.$"))) | |
167 (all-completions "" (mapcar 'list strings))))) | |
168 (cond | |
169 ;; | |
170 ;; If there is a common prefix, remove it and recurse on the suffixes. | |
171 ((> (length prefix) 0) | |
172 (let* ((length (length prefix)) | |
173 (suffixes (mapcar (lambda (s) (substring s length)) strings))) | |
174 (concat open-group | |
175 (regexp-quote prefix) (regexp-opt-group suffixes t t) | |
176 close-group))) | |
177 ;; | |
178 ;; If there are several one-character strings, remove them and recurse | |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
179 ;; on the rest (first so the final regexp finds the longest match). |
18014 | 180 ((> (length letters) 1) |
181 (let ((rest (let ((completion-regexp-list '("^..+$"))) | |
182 (all-completions "" (mapcar 'list strings))))) | |
183 (concat open-group | |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
184 (regexp-opt-group rest) "\\|" (regexp-opt-charset letters) |
18014 | 185 close-group))) |
186 ;; | |
187 ;; Otherwise, divide the list into those that start with a particular | |
188 ;; letter and those that do not, and recurse on them. | |
189 (t | |
190 (let* ((char (substring (car strings) 0 1)) | |
191 (half1 (all-completions char (mapcar 'list strings))) | |
192 (half2 (nthcdr (length half1) strings))) | |
193 (concat open-group | |
194 (regexp-opt-group half1) "\\|" (regexp-opt-group half2) | |
195 close-group))))))))) | |
196 | |
197 (defun regexp-opt-charset (chars) | |
198 ;; | |
199 ;; Return a regexp to match a character in CHARS. | |
200 ;; | |
201 ;; The basic idea is to find character ranges. Also we take care in the | |
202 ;; position of character set meta characters in the character set regexp. | |
203 ;; | |
204 (let* ((charwidth 256) ; Yeah, right. | |
205 (charmap (make-bool-vector charwidth nil)) | |
206 (charset "") | |
207 (bracket "") (dash "") (caret "")) | |
208 ;; | |
209 ;; Make a character map but extract character set meta characters. | |
18149
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
210 (dolist (char (mapcar 'string-to-char chars)) |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
211 (case char |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
212 (?\] |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
213 (setq bracket "]")) |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
214 (?^ |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
215 (setq caret "^")) |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
216 (?- |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
217 (setq dash "-")) |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
218 (otherwise |
2fec7f622b82
emit charsets after strings so that the final regexp finds the longest match.
Simon Marshall <simon@gnu.org>
parents:
18014
diff
changeset
|
219 (aset charmap char t)))) |
18014 | 220 ;; |
221 ;; Make a character set from the map using ranges where applicable. | |
18465 | 222 (dotimes (char charwidth) |
223 (let ((start char)) | |
224 (while (and (< char charwidth) (aref charmap char)) | |
225 (incf char)) | |
226 (cond ((> char (+ start 3)) | |
227 (setq charset (format "%s%c-%c" charset start (1- char)))) | |
228 ((> char start) | |
229 (setq charset (format "%s%c" charset (setq char start))))))) | |
18014 | 230 ;; |
231 ;; Make sure a caret is not first and a dash is first or last. | |
232 (if (and (string-equal charset "") (string-equal bracket "")) | |
233 (concat "[" dash caret "]") | |
234 (concat "[" bracket charset caret dash "]")))) | |
235 | |
236 (provide 'regexp-opt) | |
237 | |
238 ;;; regexp-opt.el ends here |