xemacs-base / regexp-opt.el

Full commit
;;; regexp-opt.el --- generate efficient regexps to match strings

;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
;;   2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.

;; Author: Simon Marshall <>
;; Maintainer: FSF
;; Keywords: strings, regexps, extensions

;; This file is part of XEmacs.

;; XEmacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; XEmacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with XEmacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Synched up with: Revision 1.34 in GNU Emacs CVS, of 2007-01-21.

;;; Commentary:

;; The "opt" in "regexp-opt" stands for "optim\\(al\\|i[sz]e\\)".
;; This package generates a regexp from a given list of strings (which matches
;; one of those strings) so that the regexp generated by:
;; (regexp-opt strings)
;; is equivalent to, but more efficient than, the regexp generated by:
;; (mapconcat 'regexp-quote strings "\\|")
;; For example:
;; (let ((strings '("cond" "if" "when" "unless" "while"
;; 		    "let" "let*" "progn" "prog1" "prog2"
;; 		    "save-restriction" "save-excursion" "save-window-excursion"
;; 		    "save-current-buffer" "save-match-data"
;; 		    "catch" "throw" "unwind-protect" "condition-case")))
;;   (concat "(" (regexp-opt strings t) "\\>"))
;;  => "(\\(c\\(?:atch\\|ond\\(?:ition-case\\)?\\)\\|if\\|let\\*?\\|prog[12n]\\|save-\\(?:current-buffer\\|excursion\\|match-data\\|\\(?:restrict\\|window-excurs\\)ion\\)\\|throw\\|un\\(?:less\\|wind-protect\\)\\|wh\\(?:en\\|ile\\)\\)\\>"
;; Searching using the above example `regexp-opt' regexp takes approximately
;; two-thirds of the time taken using the equivalent `mapconcat' regexp.

;; Since this package was written to produce efficient regexps, not regexps
;; efficiently, it is probably not a good idea to in-line too many calls in
;; your code, unless you use the following trick with `eval-when-compile':
;; (defvar definition-regexp
;;   (eval-when-compile
;;     (concat "^("
;;             (regexp-opt '("defun" "defsubst" "defmacro" "defalias"
;;                           "defvar" "defconst") t)
;;             "\\>")))
;; The `byte-compile' code will be as if you had defined the variable thus:
;; (defvar definition-regexp
;;   "^(\\(def\\(alias\\|const\\|macro\\|subst\\|un\\|var\\)\\)\\>")
;; Note that if you use this trick for all instances of `regexp-opt' and
;; `regexp-opt-depth' in your code, regexp-opt.el would only have to be loaded
;; at compile time.  But note also that using this trick means that should
;; regexp-opt.el be changed, perhaps to fix a bug or to add a feature to
;; improve the efficiency of `regexp-opt' regexps, you would have to recompile
;; your code for such changes to have effect in your code.

;; Originally written for font-lock.el, from an idea from Stig's hl319.el, with
;; thanks for ideas also to Michael Ernst, Bob Glickstein, Dan Nicolaescu and
;; Stefan Monnier.
;; No doubt `regexp-opt' doesn't always produce optimal regexps, so code, ideas
;; or any other information to improve things are welcome.
;; One possible improvement would be to compile '("aa" "ab" "ba" "bb")
;; into "[ab][ab]" rather than "a[ab]\\|b[ab]".  I'm not sure it's worth
;; it but if someone knows how to do it without going through too many
;; contortions, I'm all ears.
;;; Code:

;; XEmacs; correct the docstring, make it clearer.
(defun regexp-opt (strings &optional paren)
  "Return a regexp which matches exactly those strings in STRINGS.

Each string in STRINGS should be unique.  Regexp special characters in
the elements of STRINGS will not be treated specially in matching;
they will be escaped as necessary in constructing the regexp.

If optional PAREN is non-nil, ensure that the returned regexp is enclosed by
at least one regexp grouping construct.  The returned regexp is typically
more efficient than the equivalent regexp:

 (let ((open (if PAREN \"\\\\(\" \"\")) (close (if PAREN \"\\\\)\" \"\")))
   (concat open (mapconcat 'regexp-quote STRINGS \"\\\\|\") close))

If PAREN is `words', then the resulting regexp is additionally surrounded
by \\=\\< and \\>."
    ;; Recurse on the sorted list.
    (let* ((max-lisp-eval-depth (* 1024 1024))
	   (max-specpdl-size (* 1024 1024))
	   (completion-ignore-case nil)
	   (completion-regexp-list nil)
	   (words (eq paren 'words))
	   (open (cond ((stringp paren) paren) (paren "\\(")))
           ;; XEmacs; 21.4 doesn't have #'delete-dups, but
           ;; #'delete-duplicates is dumped.
	   (sorted-strings (sort (delete-duplicates
                                  (copy-sequence strings) :test #'string=)
	   (re (regexp-opt-group sorted-strings open)))
      (if words (concat "\\<" re "\\>") re))))

;; XEmacs change; this functionality is in bytecomp.el in GNU Emacs, since
;; regexp-opt.el is in core.
(define-compiler-macro regexp-opt (&whole form &rest arguments)
  (if (and (cl-const-exprs-p (cdr form))
           (function-allows-args #'regexp-opt (length (cdr form))))
      (condition-case nil (eval form) (error form))

;; XEmacs; added here. This is in subr.el in GNU; this implementation is
;; from their revision 1.541 of 2007-01-04, under GPL 2. 
(defun-when-void subregexp-context-p (regexp pos &optional start)
  "Return non-nil if POS is in a normal subregexp context in REGEXP. 
A subregexp context is one where a sub-regexp can appear. 
A non-subregexp context is for example within brackets, or within a 
repetition bounds operator `\\=\\{...\\}', or right after a `\\'. 
If START is non-nil, it should be a position in REGEXP, smaller 
than POS, and known to be in a subregexp context." 
  ;; Here's one possible implementation, with the great benefit that it 
  ;; reuses the regexp-matcher's own parser, so it understands all the 
  ;; details of the syntax.  A disadvantage is that it needs to match the 
  ;; error string. 
  (condition-case err 
        (string-match (substring regexp (or start 0) pos) "") 
     (not (member (cadr err) '("Unmatched [ or [^" 
                               "Unmatched \\{" 
                               "Trailing backslash"))))) 
  ;; An alternative implementation: 
  ;; (defconst re-context-re 
  ;;   (let* ((harmless-ch "[^\\[]") 
  ;;          (harmless-esc "\\\\[^{]") 
  ;;          (class-harmless-ch "[^][]") 
  ;;          (class-lb-harmless "[^]:]") 
  ;;          (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?") 
  ;;          (class-lb (concat "\\[\\(" class-lb-harmless 
  ;;                            "\\|" class-lb-colon-maybe-charclass "\\)")) 
  ;;          (class 
  ;;           (concat "\\[^?]?" 
  ;;                   "\\(" class-harmless-ch 
  ;;                   "\\|" class-lb "\\)*" 
  ;;                   "\\[?]"))     ; special handling for bare [ at end of re
  ;;          (braces "\\\\{[0-9,]+\\\\}")) 
  ;;     (concat "\\`\\(" harmless-ch "\\|" harmless-esc 
  ;;             "\\|" class "\\|" braces "\\)*\\'")) 
  ;;   "Matches any prefix that corresponds to a normal subregexp context.") 
  ;; (string-match re-context-re (substring regexp (or start 0) pos)) 

(defun regexp-opt-depth (regexp)
  "Return the depth of REGEXP.
This means the number of non-shy regexp grouping constructs
\(parenthesized expressions) in REGEXP."
    ;; Hack to signal an error if REGEXP does not have balanced parentheses.
    (string-match regexp "")
    ;; Count the number of open parentheses in REGEXP.
    (let ((count 0) start last)
      (while (string-match "\\\\(\\(\\?:\\)?" regexp start)
	(setq start (match-end 0))	      ; Start of next search.
	(when (and (not (match-beginning 1))
		   (subregexp-context-p regexp (match-beginning 0) last))
	  ;; It's not a shy group and it's not inside brackets or after
	  ;; a backslash: it's really a group-open marker.
	  (setq last start)	    ; Speed up next regexp-opt-re-context-p.
	  (setq count (1+ count))))
;;; Workhorse functions.

  (require 'cl))

(defun regexp-opt-group (strings &optional paren lax)
  ;; XEmacs; docstring, not just a comment. 
  "Return a regexp to match a string in STRINGS.
If PAREN non-nil, output regexp parentheses around returned regexp.
If LAX non-nil, don't output parentheses if it doesn't require them.
Merges keywords to avoid backtracking in Emacs' regexp matcher.

The basic idea is to find the shortest common prefix or suffix, remove it
and recurse.  If there is no prefix, we divide the list into two so that
\(at least) one half will have at least a one-character common prefix.

Also we delay the addition of grouping parenthesis as long as possible
until we're sure we need them, and try to remove one-character sequences
so we can use character sets rather than grouping parenthesis."
  (let* ((open-group (cond ((stringp paren) paren) (paren "\\(?:") (t "")))
	 (close-group (if paren "\\)" ""))
	 (open-charset (if lax "" open-group))
	 (close-charset (if lax "" close-group)))
     ;; If there are no strings, just return the empty string.
     ((= (length strings) 0)
     ;; If there is only one string, just return it.
     ((= (length strings) 1)
      (if (= (length (car strings)) 1)
	  (concat open-charset (regexp-quote (car strings)) close-charset)
	(concat open-group (regexp-quote (car strings)) close-group)))
     ;; If there is an empty string, remove it and recurse on the rest.
     ((= (length (car strings)) 0)
      (concat open-charset
	      (regexp-opt-group (cdr strings) t t) "?"
     ;; If there are several one-char strings, use charsets
     ((and (= (length (car strings)) 1)
	   (let ((strs (cdr strings)))
	     (while (and strs (/= (length (car strs)) 1))
	       (pop strs))
      (let (letters rest)
	;; Collect one-char strings
	(dolist (s strings)
	  (if (= (length s) 1) (push (string-to-char s) letters) (push s rest)))

	(if rest
	    ;; several one-char strings: take them and recurse
	    ;; on the rest (first so as to match the longest).
	    (concat open-group
		    (regexp-opt-group (nreverse rest))
		    "\\|" (regexp-opt-charset letters)
	  ;; all are one-char strings: just return a character set.
	  (concat open-charset
		  (regexp-opt-charset letters)
     ;; We have a list of different length strings.
      ;; XEmacs; our #'try-completion requires an alist. 
      (let ((prefix (try-completion "" (mapcar 'list strings))))
	(if (> (length prefix) 0)
	    ;; common prefix: take it and recurse on the suffixes.
	    (let* ((n (length prefix))
		   (suffixes (mapcar (lambda (s) (substring s n)) strings)))
	      (concat open-group
		      (regexp-quote prefix)
		      (regexp-opt-group suffixes t t)

	  (let* ((sgnirts (mapcar (lambda (s)
                                    ;; XEmacs; our #'try-completion requires
                                    ;; an alist.
                                     (concat (nreverse (string-to-list s)))))
		 (xiffus (try-completion "" sgnirts)))
	    (if (> (length xiffus) 0)
		;; common suffix: take it and recurse on the prefixes.
		(let* ((n (- (length xiffus)))
			;; Sorting is necessary in cases such as ("ad" "d").
			(sort (mapcar (lambda (s) (substring s 0 n)) strings)
		  (concat open-group
			  (regexp-opt-group prefixes t t)
			   (concat (nreverse (string-to-list xiffus))))

	      ;; Otherwise, divide the list into those that start with a
	      ;; particular letter and those that do not, and recurse on them.
	      (let* ((char (char-to-string (string-to-char (car strings))))
                     ;; XEmacs; #'all-completions requires an alist.
		     (half1 (all-completions char (mapcar 'list strings)))
		     (half2 (nthcdr (length half1) strings)))
		(concat open-group
			(regexp-opt-group half1)
			"\\|" (regexp-opt-group half2)

(defun regexp-opt-charset (chars)
  ;; Return a regexp to match a character in CHARS.
  ;; The basic idea is to find character ranges.  Also we take care in the
  ;; position of character set meta characters in the character set regexp.
  (let* ((charmap (make-char-table 'generic)) ;; XEmacs; case-tables not suited.
	 (start -1) (end -2)
	 (charset "")
	 (bracket "") (dash "") (caret ""))
    ;; Make a character map but extract character set meta characters.
    (dolist (char chars)
      (case char
	 (setq bracket "]"))
	 (setq caret "^"))
	 (setq dash "-"))
         (put-char-table char t charmap)))) ;; XEmacs; not a sequence, no aset
    ;; Make a character set from the map using ranges where applicable.
     (lambda (c v)
       (when v
	 (if (= (1- c) end) (setq end c)
	   (if (> end (+ start 2))
	       (setq charset (format "%s%c-%c" charset start end))
	     (while (>= end start)
	       (setq charset (format "%s%c" charset start))
	       (incf start)))
	   (setq start c end c)))
      nil) ;; XEmacs; don't end the loop with the first char 
    (when (>= end start)
      (if (> end (+ start 2))
	  (setq charset (format "%s%c-%c" charset start end))
	(while (>= end start)
	  (setq charset (format "%s%c" charset start))
	  (incf start))))
    ;; Make sure a caret is not first and a dash is first or last.
    (if (and (string-equal charset "") (string-equal bracket ""))
	(concat "[" dash caret "]")
      (concat "[" bracket charset caret dash "]"))))

(provide 'regexp-opt)

;; arch-tag: 6c5a66f4-29af-4fd6-8c3b-4b554d5b4370
;;; regexp-opt.el ends here