;;; font-lock.el --- Electric font lock mode
-;; Copyright (C) 1992-1999 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 93, 94, 95, 96, 97, 98, 1999, 2000
+;; Free Software Foundation, Inc.
-;; Author: jwz, then rms, then sm <simon@gnu.org>
+;; Author: jwz, then rms, then sm
;; Maintainer: FSF
;; Keywords: languages, faces
;;
;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and
;; `font-lock-syntactic-keywords' can be generated via the function
-;; `regexp-opt', and their depth counted via the function `regexp-opt-depth'.
+;; `regexp-opt'.
;;; Adding patterns for modes that already support Font Lock:
where MATCHER can be either the regexp to search for, or the function name to
call to make the search (called with one argument, the limit of the search) and
return non-nil if it succeeds (and set `match-data' appropriately).
-MATCHER regexps can be generated via the function `regexp-opt'. MATCH is the
-subexpression of MATCHER to be highlighted. MATCH can be calculated via the
-function `regexp-opt-depth'. FACENAME is an expression whose value is the face
-name to use. Face default attributes can be modified via \\[customize].
+MATCHER regexps can be generated via the function `regexp-opt'. MATCH is
+the subexpression of MATCHER to be highlighted. FACENAME is an expression
+whose value is the face name to use. Face default attributes can be
+modified via \\[customize].
OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can
be overwritten. If `keep', only parts not already fontified are highlighted.
It is generally a bad idea to return a position greater than the end of the
line, i.e., cause the MATCHER search to span lines.
-These regular expressions should not match text which spans lines. While
-\\[font-lock-fontify-buffer] handles multi-line patterns correctly, updating
-when you edit the buffer does not, since it considers text one line at a time.
+These regular expressions can match text which spans lines, although
+it is better to avoid it if possible since updating them while editing
+text is slower, and it is not guaranteed to be always correct when using
+support modes like jit-lock or lazy-lock.
This variable is set by major modes via the variable `font-lock-defaults'.
Be careful when composing regexps for this list; a poorly written pattern can
(defvar font-lock-keywords-alist nil
"*Alist of `font-lock-keywords' local to a `major-mode'.
-This is normally set via `font-lock-add-keywords'.")
+This is normally set via `font-lock-add-keywords' and
+`font-lock-remove-keywords'.")
+
+(defvar font-lock-removed-keywords-alist nil
+ "*Alist of `font-lock-keywords' removed from `major-mode'.
+This is normally set via `font-lock-add-keywords' and
+`font-lock-remove-keywords'.")
(defvar font-lock-keywords-only nil
"*Non-nil means Font Lock should not fontify comments or strings.
(MATCH SYNTAX OVERRIDE LAXMATCH)
-where SYNTAX can be of the form (SYNTAX-CODE . MATCHING-CHAR), the name of a
-syntax table, or an expression whose value is such a form or a syntax table.
-OVERRIDE cannot be `prepend' or `append'.
+where SYNTAX can be of the form (SYNTAX-CODE . MATCHING-CHAR) (see
+also `string-to-syntax'), the name of a syntax table, or an expression
+whose value is such a form or a syntax table. OVERRIDE cannot be
+`prepend' or `append'.
For example, an element of the form highlights syntactically:
(when (and (not modified) (buffer-modified-p))
(set-buffer-modified-p nil)))))
(put 'save-buffer-state 'lisp-indent-function 1)
+ (def-edebug-spec save-buffer-state let)
;;
;; Shut up the byte compiler.
(defvar global-font-lock-mode) ; Now a defcustom.
(defun turn-on-font-lock ()
"Turn on Font Lock mode conditionally.
Turn on only if the terminal can display it."
- (when (and (not font-lock-mode) (or window-system (tty-display-color-p)))
+ (unless font-lock-mode
(font-lock-mode)))
;;;###autoload
;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them.
(let ((spec (cons keywords append)) cell)
(if (setq cell (assq mode font-lock-keywords-alist))
- (setcdr cell (append (cdr cell) (list spec)))
- (push (list mode spec) font-lock-keywords-alist))))
- (font-lock-mode
- ;; Otherwise if Font Lock mode is on, set or add the keywords now.
- (if (eq append 'set)
- (setq font-lock-keywords keywords)
- (font-lock-remove-keywords nil keywords)
+ (if (eq append 'set)
+ (setcdr cell (list spec))
+ (setcdr cell (append (cdr cell) (list spec))))
+ (push (list mode spec) font-lock-keywords-alist)))
+ ;; Make sure that `font-lock-removed-keywords-alist' does not
+ ;; contain the new keywords.
+ (font-lock-update-removed-keyword-alist mode keywords append))
+ (t
+ ;; Otherwise set or add the keywords now.
+ (font-lock-set-defaults)
+ (if (eq append 'set)
+ (setq font-lock-keywords keywords)
+ (font-lock-remove-keywords nil keywords) ;to avoid duplicates
(let ((old (if (eq (car-safe font-lock-keywords) t)
(cdr font-lock-keywords)
font-lock-keywords)))
(append old keywords)
(append keywords old))))))))
+(defun font-lock-update-removed-keyword-alist (mode keywords append)
+ ;; Update `font-lock-removed-keywords-alist' when adding new
+ ;; KEYWORDS to MODE.
+ ;;
+ ;; When font-lock is enabled first all keywords in the list
+ ;; `font-lock-keywords-alist' are added, then all keywords in the
+ ;; list `font-lock-removed-keywords-alist' are removed. If a
+ ;; keyword was once added, removed, and then added again it must be
+ ;; removed from the removed-keywords list. Otherwise the second add
+ ;; will not take effect.
+ (let ((cell (assq mode font-lock-removed-keywords-alist)))
+ (if cell
+ (if (eq append 'set)
+ ;; A new set of keywords is defined. Forget all about
+ ;; our old keywords that should be removed.
+ (setq font-lock-removed-keywords-alist
+ (delq cell font-lock-removed-keywords-alist))
+ ;; Delete all previously removed keywords.
+ (dolist (kword keywords)
+ (setcdr cell (delete kword (cdr cell))))
+ ;; Delete the mode cell if empty.
+ (if (null (cdr cell))
+ (setq font-lock-removed-keywords-alist
+ (delq cell font-lock-removed-keywords-alist)))))))
+
+;; Written by Anders Lindgren <andersl@andersl.com>.
+;;
+;; Case study:
+;; (I) The keywords are removed from a major mode.
+;; In this case the keyword could be local (i.e. added earlier by
+;; `font-lock-add-keywords'), global, or both.
+;;
+;; (a) In the local case we remove the keywords from the variable
+;; `font-lock-keywords-alist'.
+;;
+;; (b) The actual global keywords are not known at this time.
+;; All keywords are added to `font-lock-removed-keywords-alist',
+;; when font-lock is enabled those keywords are removed.
+;;
+;; Note that added keywords are taken out of the list of removed
+;; keywords. This ensure correct operation when the same keyword
+;; is added and removed several times.
+;;
+;; (II) The keywords are removed from the current buffer.
;;;###autoload
(defun font-lock-remove-keywords (mode keywords)
- "Remove highlighting KEYWORDS from the current buffer.
-A non-nil MODE is currently unsupported."
- (setq font-lock-keywords (copy-list font-lock-keywords))
- (dolist (keyword keywords)
- (setq font-lock-keywords
- (delete keyword
- (delete (font-lock-compile-keyword keyword)
- font-lock-keywords)))))
+ "Remove highlighting KEYWORDS for MODE.
+MODE should be a symbol, the major mode command name, such as `c-mode'
+or nil. If nil, highlighting keywords are removed for the current buffer."
+ (cond (mode
+ ;; Remove one keyword at the time.
+ (dolist (keyword keywords)
+ (let ((top-cell (assq mode font-lock-keywords-alist)))
+ ;; If MODE is non-nil, remove the KEYWORD from
+ ;; `font-lock-keywords-alist'.
+ (when top-cell
+ (dolist (keyword-list-append-pair (cdr top-cell))
+ ;; `keywords-list-append-pair' is a cons with a list of
+ ;; keywords in the car top-cell and the original append
+ ;; argument in the cdr top-cell.
+ (setcar keyword-list-append-pair
+ (delete keyword (car keyword-list-append-pair))))
+ ;; Remove keyword list/append pair when the keyword list
+ ;; is empty and append doesn't specify `set'. (If it
+ ;; should be deleted then previously deleted keywords
+ ;; would appear again.)
+ (let ((cell top-cell))
+ (while (cdr cell)
+ (if (and (null (car (car (cdr cell))))
+ (not (eq (cdr (car (cdr cell))) 'set)))
+ (setcdr cell (cdr (cdr cell)))
+ (setq cell (cdr cell)))))
+ ;; Final cleanup, remove major mode cell if last keyword
+ ;; was deleted.
+ (if (null (cdr top-cell))
+ (setq font-lock-keywords-alist
+ (delq top-cell font-lock-keywords-alist))))
+ ;; Remember the keyword in case it is not local.
+ (let ((cell (assq mode font-lock-removed-keywords-alist)))
+ (if cell
+ (unless (member keyword (cdr cell))
+ (nconc cell (list keyword)))
+ (push (cons mode (list keyword))
+ font-lock-removed-keywords-alist))))))
+ (t
+ ;; Otherwise remove it immediately.
+ (font-lock-set-defaults)
+ (setq font-lock-keywords (copy-sequence font-lock-keywords))
+ (dolist (keyword keywords)
+ (setq font-lock-keywords
+ (delete keyword
+ ;; The keywords might be compiled.
+ (delete (font-lock-compile-keyword keyword)
+ font-lock-keywords)))))))
\f
;;; Global Font Lock mode.
(setq font-lock-buffers (buffer-list)))
(t
(remove-hook 'find-file-hooks 'turn-on-font-lock-if-enabled)
- (mapcar (function (lambda (buffer)
- (with-current-buffer buffer
- (when font-lock-mode
- (font-lock-mode)))))
+ (mapc (function (lambda (buffer)
+ (with-current-buffer buffer
+ (when font-lock-mode
+ (font-lock-mode)))))
(buffer-list))))
(when message
(message "Global Font Lock mode %s." (if on-p "enabled" "disabled")))
(const :tag "lazy lock" lazy-lock-mode)
(const :tag "JIT lock" jit-lock-mode)))
))
+ :version "21.1"
:group 'font-lock)
(defvar fast-lock-mode nil)
(defun font-lock-after-fontify-buffer ()
(cond (fast-lock-mode
(fast-lock-after-fontify-buffer))
- (jit-lock-mode
- (jit-lock-after-fontify-buffer))
+ ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm
+ ;; (jit-lock-mode
+ ;; (jit-lock-after-fontify-buffer))
(lazy-lock-mode
(lazy-lock-after-fontify-buffer))))
(defun font-lock-after-unfontify-buffer ()
(cond (fast-lock-mode
(fast-lock-after-unfontify-buffer))
- (jit-lock-mode
- (jit-lock-after-unfontify-buffer))
+ ;; Useless as well. It's only called when:
+ ;; - turning off font-lock: it does not matter if we leave spurious
+ ;; `fontified' text props around since jit-lock-mode is also off.
+ ;; - font-lock-default-fontify-buffer fails: this is not run
+ ;; any more anyway. -sm
+ ;;
+ ;; (jit-lock-mode
+ ;; (jit-lock-after-unfontify-buffer))
(lazy-lock-mode
(lazy-lock-after-unfontify-buffer))))
(start (match-beginning match)) (end (match-end match))
(value (nth 1 highlight))
(override (nth 2 highlight)))
- (unless (numberp (car-safe value))
- (setq value (eval value)))
+ (cond ((stringp value)
+ (setq value (string-to-syntax value)))
+ ((not (numberp (car-safe value)))
+ (setq value (eval value))))
(cond ((not start)
;; No match but we might not signal an error.
(or (nth 3 highlight)
;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
(if (and (numberp pre-match-value) (> pre-match-value (point)))
(setq limit pre-match-value)
- (save-excursion (end-of-line) (setq limit (point))))
+ (setq limit (line-end-position)))
(save-match-data
;; Find an occurrence of `matcher' before `limit'.
(while (if (stringp matcher)
(pre-match-value (eval (nth 1 keywords))))
;; Set LIMIT to value of PRE-MATCH-FORM or the end of line.
(if (not (and (numberp pre-match-value) (> pre-match-value (point))))
- (save-excursion (end-of-line) (setq limit (point)))
+ (setq limit (line-end-position))
(setq limit pre-match-value)
(when (and font-lock-multiline
(funcall (if (eq font-lock-multiline t) '>= '>)
pre-match-value
- (save-excursion (forward-line 1) (point))))
+ (line-beginning-position 2)))
;; this is a multiline anchored match
- (set (make-local-variable 'font-lock-multiline) t)
+ (setq font-lock-multiline t)
(put-text-property (point) limit 'font-lock-multiline t)))
(save-match-data
;; Find an occurrence of `matcher' before `limit'.
- (while (if (stringp matcher)
- (re-search-forward matcher limit t)
- (funcall matcher limit))
+ (while (and (< (point) limit)
+ (if (stringp matcher)
+ (re-search-forward matcher limit t)
+ (funcall matcher limit)))
;; Apply each highlight to this instance of `matcher'.
(setq highlights lowdarks)
(while highlights
(save-excursion (goto-char (match-beginning 0))
(forward-line 1) (point))))
;; this is a multiline regexp match
- (set (make-local-variable 'font-lock-multiline) t)
+ (setq font-lock-multiline t)
(put-text-property (match-beginning 0) (point)
'font-lock-multiline t))
;; Apply each highlight to this instance of `matcher', which may be
"Set fontification defaults appropriately for this mode.
Sets various variables using `font-lock-defaults' (or, if nil, using
`font-lock-defaults-alist') and `font-lock-maximum-decoration'."
- ;; Set fontification defaults.
- (make-local-variable 'font-lock-fontified)
- ;; Set iff not previously set.
+ ;; Set fontification defaults iff not previously set.
(unless font-lock-set-defaults
(set (make-local-variable 'font-lock-set-defaults) t)
(set (make-local-variable 'font-lock-cache-state) nil)
(set (make-local-variable 'font-lock-cache-position) (make-marker))
+ (make-local-variable 'font-lock-fontified)
+ (make-local-variable 'font-lock-multiline)
(let* ((defaults (or font-lock-defaults
(cdr (assq major-mode font-lock-defaults-alist))))
(keywords
(font-lock-choose-keywords (nth 0 defaults)
(font-lock-value-in-major-mode font-lock-maximum-decoration)))
- (local (cdr (assq major-mode font-lock-keywords-alist))))
+ (local (cdr (assq major-mode font-lock-keywords-alist)))
+ (removed-keywords
+ (cdr-safe (assq major-mode font-lock-removed-keywords-alist))))
;; Regexp fontification?
(set (make-local-variable 'font-lock-keywords)
(font-lock-compile-keywords (font-lock-eval-keywords keywords)))
(while local
(font-lock-add-keywords nil (car (car local)) (cdr (car local)))
(setq local (cdr local)))
+ (when removed-keywords
+ (font-lock-remove-keywords nil removed-keywords))
;; Syntactic fontification?
(when (nth 1 defaults)
(set (make-local-variable 'font-lock-keywords-only) t))
;; Function declarations.
"\\(advice\\|alias\\|generic\\|macro\\*?\\|method\\|"
"setf\\|subst\\*?\\|un\\*?\\|"
- "ine-\\(condition\\|derived-mode\\|function\\|"
+ "ine-\\(condition\\|\\(?:derived\\|minor\\)-mode\\|"
"method-combination\\|setf-expander\\|skeleton\\|widget\\|"
- "\\(compiler\\|modify\\|symbol\\)-macro\\)\\)\\|"
+ "function\\|\\(compiler\\|modify\\|symbol\\)-macro\\)\\)\\|"
;; Variable declarations.
"\\(const\\(ant\\)?\\|custom\\|face\\|parameter\\|var\\)\\|"
;; Structure declarations.
"\\)\\)\\>"
;; Any whitespace and defined object.
"[ \t'\(]*"
- "\\(\\sw+\\)?")
+ "\\(setf[ \t]+\\sw+)\\|\\sw+\\)?")
'(1 font-lock-keyword-face)
'(9 (cond ((match-beginning 3) font-lock-function-name-face)
((match-beginning 6) font-lock-variable-name-face)
"\\|"))
(c-type-names-depth
`(regexp-opt-depth (,@ c-type-names)))
+ (c-preprocessor-directives
+ (eval-when-compile
+ (regexp-opt
+ '("define" "elif" "else" "endif" "error" "file" "if" "ifdef"
+ "ifndef" "include" "line" "pragma" "undef"))))
+ (c-preprocessor-directives-depth
+ (regexp-opt-depth c-preprocessor-directives))
)
(setq c-font-lock-keywords-1
(list
(1 font-lock-builtin-face) (2 font-lock-variable-name-face nil t)))
;;
;; Fontify otherwise as symbol names, and the preprocessor directive names.
- '("^#[ \t]*\\(\\sw+\\)\\>[ \t!]*\\(\\sw+\\)?"
- (1 font-lock-builtin-face) (2 font-lock-variable-name-face nil t))
+ (list
+ (concat "^#[ \t]*\\(" c-preprocessor-directives
+ "\\)\\>[ \t!]*\\(\\sw+\\)?")
+ '(1 font-lock-builtin-face)
+ (list (+ 2 c-preprocessor-directives-depth)
+ 'font-lock-variable-name-face nil t))
))
(setq c-font-lock-keywords-2
(concat "\\<\\(" c-keywords "\\|" c-type-specs "\\)\\>")
;;
;; Fontify case/goto keywords and targets, and case default/goto tags.
- '("\\<\\(case\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?"
- (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
+ '("\\<\\(case\\|goto\\)\\>"
+ (1 font-lock-keyword-face)
+ ("\\(-[0-9]+\\|\\sw+\\)"
+ ;; Return limit of search.
+ (save-excursion (skip-chars-forward "^:\n") (point))
+ nil
+ (1 font-lock-constant-face nil t)))
;; Anders Lindgren <andersl@andersl.com> points out that it is quicker to
;; use MATCH-ANCHORED to effectively anchor the regexp on the left.
;; This must come after the one for keywords and targets.
(goto-char (match-end 2)))
(error t)))))
+(defun font-lock-match-c++-structor-declaration (limit)
+ ;; Match C++ constructors and destructors inside class declarations.
+ (let ((res nil)
+ (regexp (concat "^\\s-+\\(\\(virtual\\|explicit\\)\\s-+\\)*~?\\(\\<"
+ (mapconcat 'identity
+ c++-font-lock-extra-types "\\|")
+ "\\>\\)\\s-*("
+ ;; Don't match function pointer declarations, e.g.:
+ ;; Foo (*fptr)();
+ "\\s-*[^*( \t]")))
+ (while (progn (setq res (re-search-forward regexp limit t))
+ (and res
+ (save-excursion
+ (beginning-of-line)
+ (save-match-data
+ (not (vectorp (c-at-toplevel-p))))))))
+ res))
+
(let* ((c++-keywords
(eval-when-compile
(regexp-opt
'(2 font-lock-builtin-face nil t))
;;
;; Fontify case/goto keywords and targets, and case default/goto tags.
- '("\\<\\(case\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?"
- (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
+ '("\\<\\(case\\|goto\\)\\>"
+ (1 font-lock-keyword-face)
+ ("\\(-[0-9]+\\|\\sw+\\)[ \t]*\\(::\\)?"
+ ;; Return limit of search.
+ (save-excursion
+ (while (progn
+ (skip-chars-forward "^:\n")
+ (looking-at "::"))
+ (forward-char 2))
+ (point))
+ nil
+ (1 (if (match-beginning 2)
+ font-lock-type-face
+ font-lock-constant-face) nil t)))
;; This must come after the one for keywords and targets.
'(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:\\($\\|[^:]\\)"
(beginning-of-line) (end-of-line)
(5 (if (match-beginning 6)
font-lock-function-name-face
font-lock-variable-name-face) nil t)))
+ ;;
+ ;; Fontify constructors and destructors inside class declarations.
+ '(font-lock-match-c++-structor-declaration
+ (3 font-lock-function-name-face t))
)))
)
'("\\<\\(false\\|null\\|true\\)\\>" . font-lock-constant-face)
;;
;; Javadoc tags within comments.
- '("@\\(author\\|exception\\|return\\|see\\|version\\)\\>"
- (1 font-lock-constant-face prepend))
+ (list
+ (concat "@\\("
+ "author\\|deprecated\\|exception"
+ "\\|link\\|return\\|see\\|serial\\|serialData\\|serialField"
+ "\\|since\\|throws"
+ "\\|version"
+ "\\)\\>"))
'("@\\(param\\)\\>[ \t]*\\(\\sw+\\)?"
(1 font-lock-constant-face prepend)
(2 font-lock-variable-name-face prepend t))
+ '("@\\(exception\\|throws\\)\\>[ \t]*\\(\\S-+\\)?"
+ (1 font-lock-constant-face prepend)
+ (2 font-lock-type-face prepend t))
)))
(setq java-font-lock-keywords-3
\f
;; Install ourselves:
+;; Useful for the popup-menu for mouse-3 on the modeline.
(unless (assq 'font-lock-mode minor-mode-alist)
(push '(font-lock-mode nil) minor-mode-alist))