[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Changes to hi-lock before release.
From: |
David Koppelman |
Subject: |
Changes to hi-lock before release. |
Date: |
Fri, 20 Apr 2007 14:06:14 -0500 |
User-agent: |
Gnus/5.11 (Gnus v5.11) Emacs/22.0.97 (gnu/linux) |
I believe the following changes should be made to hi-lock before
release. The problem is that hi-lock can automatically add font-lock
keywords when a buffer is loaded, allowing for some mischief. The
patch sets the loading of patterns from files off by default, but
by setting a variable the user can be prompted or can provide
a function to determine safety. The user can still add the patterns
by using a key sequence.
If font-lock-pattern safety-checking code becomes available later
I'll use that instead of these changes.
Index: hi-lock.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/hi-lock.el,v
retrieving revision 1.41
diff -u -p -r1.41 hi-lock.el
--- hi-lock.el 3 Feb 2007 17:26:01 -0000 1.41
+++ hi-lock.el 20 Apr 2007 19:00:30 -0000
@@ -3,7 +3,7 @@
;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
;; 2005, 2006, 2007 Free Software Foundation, Inc.
-;; Author: David M. Koppelman, address@hidden
+;; Author: David M. Koppelman, address@hidden
;; Keywords: faces, minor-mode, matching, display
;; This file is part of GNU Emacs.
@@ -33,7 +33,8 @@
;; 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:
;;
@@ -60,6 +61,14 @@
;;
;; (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:
@@ -115,6 +124,12 @@ calls."
:type '(repeat symbol)
:group 'hi-lock)
+(defvar hi-lock-file-patterns-policy 'never
+ "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.")
(defgroup hi-lock-faces nil
"Faces for hi-lock."
@@ -196,7 +211,7 @@ calls."
"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.
@@ -283,17 +298,22 @@ called interactively, are:
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.
+ (See `font-lock-keywords'.) They may be edited and re-loaded with
\\[hi-lock-find-patterns],
+ 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
@@ -590,9 +610,18 @@ not suitable."
(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."
--- display.texi 12 Apr 2007 08:35:15 -0500 1.125
+++ display.texi 19 Apr 2007 21:36:51 -0500
@@ -706,9 +706,16 @@ at point, with comment delimiters to pre
program. (This key binding runs the
@code{hi-lock-write-interactive-patterns} command.)
-These patterns will be read the next time you visit the file while
+These patterns may be read the next time you visit the file while
Hi Lock mode is enabled, or whenever you use the @kbd{M-x
-hi-lock-find-patterns} command.
+hi-lock-find-patterns} command.
+
+Patterns are not read if the buffer's mode is listed in
address@hidden Patterns are only used if
address@hidden is 'ask and the user responds yes
+to a prompt, or if @code{hi-lock-file-patterns-policy} is bound to a
+function and that function returns t. The function is called with the
+patterns as an argument.
@item C-x w i
@kindex C-x w i
- Changes to hi-lock before release.,
David Koppelman <=
Re: Changes to hi-lock before release., Richard Stallman, 2007/04/21