From: Luc Teirlinck <teirllm@dms.auburn.edu>
Cc: monnier@iro.umontreal.ca, emacs-devel@gnu.org
Subject: Re: org-mode and mode hooks.
Date: Mon, 6 Jun 2005 18:28:49 -0500 (CDT) [thread overview]
Message-ID: <200506062328.j56NSnY18148@raven.dms.auburn.edu> (raw)
In-Reply-To: <E1Derip-0004Xl-EI@fencepost.gnu.org> (message from Richard Stallman on Sun, 05 Jun 2005 05:47:11 -0400)
Richard Stallman wrote:
I will add this to the documentation of font-lock-add-keywords.
@strong{Warning:} major mode functions must not call
@code{font-lock-add-keywords} under any circumstances, either directly
or indirectly. (This would lead to incorrect behavior for some minor
modes.) They should set up for Font Lock mode by setting
@code{font-lock-keywords}.
Well, it depends on _how_ they call it indirectly. For instance, if
the indirect call adds it to a mode hook everything is fine. I
believe that it is better to apply the patch below to modes.texi.
(I could not reply earlier due to connection problems.)
===File ~/modes.texi-diff===================================
*** modes.texi 29 May 2005 10:42:38 -0500 1.112
--- modes.texi 06 Jun 2005 18:06:28 -0500
***************
*** 2626,2632 ****
You can use @code{font-lock-add-keywords} to add additional
search-based fontification rules to a major mode, and
! @code{font-lock-remove-keywords} to removes rules.
@defun font-lock-add-keywords mode keywords &optional append
This function adds highlighting @var{keywords} for @var{mode}. The
--- 2626,2634 ----
You can use @code{font-lock-add-keywords} to add additional
search-based fontification rules to a major mode, and
! @code{font-lock-remove-keywords} to remove rules. These two functions
! are meant for user customization and for use in minor mode functions.
! Major mode functions should set @code{font-lock-keywords} instead.
@defun font-lock-add-keywords mode keywords &optional append
This function adds highlighting @var{keywords} for @var{mode}. The
***************
*** 2657,2662 ****
--- 2659,2685 ----
@samp{FIXME}, even in comments, and another to fontify the words
@samp{and}, @samp{or} and @samp{not} as keywords.
+ The above example does @emph{not} add the fontification patterns to
+ major modes derived from C mode, as is usually desired. To add them
+ to derived modes too, pass @code{nil} for mode and add the call to
+ @var{mode}'s mode hook.
+
+ For example:
+
+ @smallexample
+ (add-hook 'c-mode-hook
+ (lambda ()
+ (font-lock-add-keywords nil
+ '(("\\<\\(FIXME\\):" 1 font-lock-warning-face prepend)
+ ("\\<\\(and\\|or\\|not\\)\\>" .
+ font-lock-keyword-face)))))
+ @end smallexample
+
+ The above procedure may fail to add keywords to a derived mode if
+ @var{mode} or the derived mode do not yet follow the standard
+ conventions. File a bug report if this happens, so that the offending
+ major mode can be corrected.
+
Some modes have specialized support for additional patterns. See the
variables @code{c-font-lock-extra-types},
@code{c++-font-lock-extra-types}, @code{objc-font-lock-extra-types}
***************
*** 2668,2682 ****
in @code{font-lock-add-keywords}, @var{mode} should be a major mode
command name or @code{nil}. If @code{nil}, the highlighting
@var{keywords} are immediately removed in the current buffer.
- @end defun
! @strong{Warning:} Only use a non-@code{nil} @var{mode} argument when
! you use @code{font-lock-add-keywords} or
! @code{font-lock-remove-keywords} in your @file{.emacs} file. When you
! use these functions from a Lisp program (such as a minor mode), we
! recommend that you use @code{nil} for @var{mode} (and place the call
! on a hook) to avoid subtle problems due to the details of the
! implementation.
@node Other Font Lock Variables
@subsection Other Font Lock Variables
--- 2691,2704 ----
in @code{font-lock-add-keywords}, @var{mode} should be a major mode
command name or @code{nil}. If @code{nil}, the highlighting
@var{keywords} are immediately removed in the current buffer.
! This function does @emph{not} remove the highlighting @var{keywords}
! from derived modes, as is usually desired. To remove them from
! derived modes too, pass @code{nil} for mode and add the call to
! @var{mode}'s hook. This may fail if @var{mode} or a derived mode do
! not yet follow the standard conventions. File a bug report if this
! happens, so that the offending major mode can be corrected.
! @end defun
@node Other Font Lock Variables
@subsection Other Font Lock Variables
============================================================
next prev parent reply other threads:[~2005-06-06 23:28 UTC|newest]
Thread overview: 121+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-05-25 13:31 org-mode and mode hooks Lute Kamstra
2005-05-25 14:45 ` Stefan Monnier
2005-05-25 15:20 ` Carsten Dominik
2005-05-25 15:44 ` Lute Kamstra
2005-05-25 16:36 ` Luc Teirlinck
2005-05-25 17:01 ` Lute Kamstra
2005-05-25 17:12 ` Luc Teirlinck
2005-05-25 17:28 ` Lute Kamstra
2005-05-25 17:45 ` Luc Teirlinck
2005-05-25 16:24 ` Luc Teirlinck
2005-05-26 6:00 ` Richard Stallman
2005-05-26 10:31 ` Lute Kamstra
2005-05-26 17:31 ` Lute Kamstra
2005-05-27 14:18 ` Richard Stallman
2005-06-27 8:25 ` Lute Kamstra
2005-06-28 4:16 ` Richard M. Stallman
2005-05-27 3:39 ` Richard Stallman
2005-05-27 8:07 ` Juri Linkov
2005-06-27 8:28 ` Lute Kamstra
2005-05-25 17:30 ` Luc Teirlinck
2005-05-25 21:35 ` Luc Teirlinck
2005-05-25 22:15 ` Stefan Monnier
2005-05-26 3:59 ` Luc Teirlinck
2005-05-26 14:08 ` Stefan Monnier
2005-05-26 15:01 ` Luc Teirlinck
2005-05-26 17:04 ` Stefan Monnier
2005-05-27 17:17 ` Luc Teirlinck
2005-05-27 17:27 ` Luc Teirlinck
2005-05-28 11:53 ` Richard Stallman
2005-05-29 1:57 ` Luc Teirlinck
2005-05-29 12:04 ` Richard Stallman
2005-05-29 23:54 ` Luc Teirlinck
2005-05-31 4:18 ` Richard Stallman
2005-05-31 15:44 ` Luc Teirlinck
2005-05-31 19:08 ` Stefan Monnier
2005-06-01 3:50 ` Luc Teirlinck
2005-06-01 17:22 ` Richard Stallman
2005-06-01 19:11 ` Luc Teirlinck
2005-06-01 21:21 ` Stefan Monnier
2005-06-01 22:42 ` Luc Teirlinck
2005-06-01 22:55 ` Stefan Monnier
2005-06-01 23:26 ` Luc Teirlinck
2005-06-01 23:43 ` Stefan Monnier
2005-06-01 23:55 ` Luc Teirlinck
2005-06-01 23:57 ` Luc Teirlinck
2005-06-01 23:58 ` David Kastrup
2005-06-02 0:15 ` Luc Teirlinck
2005-06-01 23:49 ` Luc Teirlinck
2005-06-03 8:01 ` Richard Stallman
2005-06-03 14:59 ` Luc Teirlinck
2005-06-03 15:05 ` Luc Teirlinck
2005-06-04 10:16 ` Richard Stallman
2005-06-04 14:54 ` Luc Teirlinck
2005-06-04 16:33 ` Stefan Monnier
2005-06-04 17:48 ` Luc Teirlinck
2005-06-05 0:36 ` David Kastrup
2005-06-05 9:47 ` Richard Stallman
2005-06-07 0:23 ` Luc Teirlinck
2005-06-04 15:17 ` Luc Teirlinck
2005-06-05 9:47 ` Richard Stallman
2005-06-06 23:28 ` Luc Teirlinck [this message]
2005-06-07 18:15 ` Stefan Monnier
2005-06-07 19:08 ` Luc Teirlinck
2005-06-07 22:10 ` Stefan Monnier
2005-06-08 1:36 ` Luc Teirlinck
2005-06-08 16:15 ` Stefan Monnier
2005-06-09 1:06 ` Luc Teirlinck
2005-06-08 12:02 ` Richard Stallman
2005-06-02 6:15 ` Carsten Dominik
2005-06-01 19:14 ` Luc Teirlinck
2005-06-01 19:19 ` Luc Teirlinck
2005-06-01 21:24 ` Stefan Monnier
2005-05-31 16:30 ` Luc Teirlinck
2005-06-01 2:33 ` Luc Teirlinck
2005-06-01 17:23 ` Richard Stallman
2005-06-01 17:48 ` Luc Teirlinck
2005-06-01 2:42 ` Luc Teirlinck
2005-06-01 17:23 ` Richard Stallman
2005-06-01 18:05 ` Luc Teirlinck
2005-06-01 2:47 ` Luc Teirlinck
2005-06-01 17:23 ` Richard Stallman
2005-06-02 3:21 ` Luc Teirlinck
2005-06-03 22:32 ` Richard Stallman
2005-06-03 23:08 ` Luc Teirlinck
2005-06-04 18:00 ` Richard Stallman
2005-06-01 3:01 ` Luc Teirlinck
2005-05-30 1:43 ` Luc Teirlinck
2005-05-30 2:50 ` Luc Teirlinck
2005-05-30 15:31 ` Luc Teirlinck
2005-05-30 16:52 ` Luc Teirlinck
2005-05-30 17:24 ` Luc Teirlinck
2005-05-30 3:35 ` Luc Teirlinck
2005-05-29 2:20 ` Luc Teirlinck
2005-05-29 12:04 ` Richard Stallman
2005-05-30 0:42 ` Luc Teirlinck
2005-05-30 1:58 ` Luc Teirlinck
2005-05-28 1:58 ` Luc Teirlinck
2005-05-27 14:49 ` Michael Mauger
2005-05-27 15:35 ` Luc Teirlinck
2005-05-27 16:40 ` Luc Teirlinck
2005-05-27 17:15 ` Stefan Monnier
2005-05-27 19:13 ` Luc Teirlinck
2005-05-31 18:25 ` Michael Mauger
2005-05-27 19:43 ` Luc Teirlinck
2005-05-28 11:53 ` Richard Stallman
2005-05-28 18:48 ` Luc Teirlinck
2005-06-07 1:19 ` Luc Teirlinck
2005-06-07 1:49 ` Miles Bader
2005-06-07 1:55 ` Luc Teirlinck
2005-06-07 2:01 ` Miles Bader
2005-06-07 18:23 ` Stefan Monnier
2005-06-07 18:17 ` Stefan Monnier
2005-06-08 12:01 ` Richard Stallman
2005-05-26 14:53 ` Richard Stallman
2005-05-26 15:06 ` Luc Teirlinck
2005-05-26 4:16 ` Luc Teirlinck
2005-05-25 22:22 ` Lute Kamstra
[not found] ` <17044.33688.784219.190965@sam.science.uva.nl>
2005-05-25 15:37 ` Lute Kamstra
2005-05-25 15:49 ` Carsten Dominik
2005-05-26 5:59 ` Richard Stallman
[not found] <87sm07o3oz.fsf-monnier+emacs@gnu.org>
2005-05-29 2:00 ` Luc Teirlinck
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=200506062328.j56NSnY18148@raven.dms.auburn.edu \
--to=teirllm@dms.auburn.edu \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).