;;; hi-lock.el --- minor mode for interactive automatic highlighting
;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
-;; 2005 Free Software Foundation, Inc.
+;; 2005, 2006, 2007 Free Software Foundation, Inc.
-;; Author: David M. Koppelman, koppel@ee.lsu.edu
+;; Author: David M. Koppelman, koppel@ece.lsu.edu
;; Keywords: faces, minor-mode, matching, display
;; This file is part of GNU Emacs.
;; GNU Emacs 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)
+;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; will remove the highlighting. Any existing face can be used for
;; highlighting and a set of appropriate faces is provided. The
;; regexps can be written into the current buffer in a form that will
-;; be recognized the next time the corresponding file is read.
+;; be recognized the next time the corresponding file is read (when
+;; file patterns is turned on).
;;
;; Applications:
;;
;;
;; (global-hi-lock-mode 1)
;;
+;; To enable the use of patterns found in files (presumably placed
+;; there by hi-lock) include the following in your .emacs file:
+;;
+;; (setq hi-lock-file-patterns-policy 'ask)
+;;
+;; If you get tired of being asked each time a file is loaded replace
+;; `ask' with a function that returns t if patterns should be read.
+;;
;; You might also want to bind the hi-lock commands to more
;; finger-friendly sequences:
:type '(repeat symbol)
:group 'hi-lock)
+(defcustom hi-lock-file-patterns-policy 'ask
+ "Specify when hi-lock should use patterns found in file.
+If `ask', prompt when patterns found in buffer; if bound to a function,
+use patterns when function returns t (function is called with patterns
+as first argument); if nil or `never' or anything else, don't use file
+patterns."
+ :type '(choice (const :tag "Do not use file patterns" never)
+ (const :tag "Ask about file patterns" ask)
+ (function :tag "Function to check file patterns"))
+ :group 'hi-lock
+ :version "22.1")
+
+;; It can have a function value.
+(put 'hi-lock-file-patterns-policy 'risky-local-variable t)
(defgroup hi-lock-faces nil
"Faces for hi-lock."
"History of regexps used for interactive fontification.")
(defvar hi-lock-file-patterns-prefix "Hi-lock"
- "Regexp for finding hi-lock patterns at top of file.")
+ "Search target for finding hi-lock patterns at top of file.")
(defvar hi-lock-archaic-interface-message-used nil
"True if user alerted that `global-hi-lock-mode' is now the global switch.
Remove highlighting on matches of REGEXP in current buffer.
\\[hi-lock-write-interactive-patterns]
- Write active REGEXPs into buffer as comments (if possible). They will
+ Write active REGEXPs into buffer as comments (if possible). They may
be read the next time file is loaded or when the \\[hi-lock-find-patterns] command
is issued. The inserted regexps are in the form of font lock keywords.
(See `font-lock-keywords'.) They may be edited and re-loaded with \\[hi-lock-find-patterns],
- any valid `font-lock-keywords' form is acceptable.
+ any valid `font-lock-keywords' form is acceptable. When a file is
+ loaded the patterns are read if `hi-lock-file-patterns-policy is
+ 'ask and the user responds y to the prompt, or if
+ `hi-lock-file-patterns-policy' is bound to a function and that
+ function returns t.
\\[hi-lock-find-patterns]
Re-read patterns stored in buffer (in the format produced by \\[hi-lock-write-interactive-patterns]).
-When hi-lock is started and if the mode is not excluded, the
-beginning of the buffer is searched for lines of the form:
+When hi-lock is started and if the mode is not excluded or patterns
+rejected, the beginning of the buffer is searched for lines of the
+form:
Hi-lock: FOO
where FOO is a list of patterns. These are added to the font lock
keywords already present. The patterns must start before position
(remove-hook 'font-lock-mode-hook 'hi-lock-font-lock-hook t)))
;;;###autoload
-(define-global-minor-mode global-hi-lock-mode
+(define-globalized-minor-mode global-hi-lock-mode
hi-lock-mode turn-on-hi-lock-if-enabled
:group 'hi-lock)
\\<minibuffer-local-must-match-map>Use \\[minibuffer-complete] to complete a partially typed regexp.
\(See info node `Minibuffer History'.\)"
(interactive
- (if (and (display-popup-menus-p) (vectorp (this-command-keys)))
+ (if (and (display-popup-menus-p) (not last-nonmenu-event))
(catch 'snafu
(or
(x-popup-menu
(if (null hi-lock-interactive-patterns)
(error "There are no interactive patterns"))
(let ((beg (point)))
- (mapcar
+ (mapc
(lambda (pattern)
(insert (format "%s: (%s)\n"
hi-lock-file-patterns-prefix
(setq all-patterns (append (read (current-buffer)) all-patterns))
(error (message "Invalid pattern list expression at %d"
(line-number-at-pos)))))))
- (when hi-lock-mode (hi-lock-set-file-patterns all-patterns))
- (if (interactive-p)
- (message "Hi-lock added %d patterns." (length all-patterns))))))
+ (when (and all-patterns
+ hi-lock-mode
+ (cond
+ ((eq this-command 'hi-lock-find-patterns) t)
+ ((functionp hi-lock-file-patterns-policy)
+ (funcall hi-lock-file-patterns-policy all-patterns))
+ ((eq hi-lock-file-patterns-policy 'ask)
+ (y-or-n-p "Add patterns from this buffer to hi-lock? "))
+ (t nil)))
+ (hi-lock-set-file-patterns all-patterns)
+ (if (interactive-p)
+ (message "Hi-lock added %d patterns." (length all-patterns)))))))
(defun hi-lock-font-lock-hook ()
"Add hi-lock patterns to font-lock's."