Now on revision 107302. ------------------------------------------------------------ revno: 107302 committer: Glenn Morris branch nick: trunk timestamp: Wed 2012-02-15 23:22:57 -0800 message: Fix some emacs-xtra.pdf cross-references to other manuals * doc/emacs/vc1-xtra.texi (VC Delete/Rename, CVS Options): * doc/emacs/cal-xtra.texi (Diary Display): Fix TeX cross-refs to other manuals. diff: === modified file 'doc/emacs/ChangeLog' --- doc/emacs/ChangeLog 2012-02-16 07:15:27 +0000 +++ doc/emacs/ChangeLog 2012-02-16 07:22:57 +0000 @@ -1,5 +1,8 @@ 2012-02-16 Glenn Morris + * vc1-xtra.texi (VC Delete/Rename, CVS Options): + * cal-xtra.texi (Diary Display): Fix TeX cross-refs to other manuals. + * dired-xtra.texi (Subdir Switches): Small fixes. * fortran-xtra.texi: Tiny changes and some adjustments to line breaks. === modified file 'doc/emacs/cal-xtra.texi' --- doc/emacs/cal-xtra.texi 2012-01-19 07:21:25 +0000 +++ doc/emacs/cal-xtra.texi 2012-02-16 07:22:57 +0000 @@ -538,7 +538,13 @@ days to be shown in the fancy diary buffer, set the variable @code{diary-list-include-blanks} to @code{t}.@refill - The fancy diary buffer enables View mode (@pxref{View Mode}). + The fancy diary buffer enables View mode +@iftex +(@pxref{View Mode,,, emacs, the Emacs Manual}). +@end iftex +@ifnottex +(@pxref{View Mode}). +@end ifnottex The alternative display method @code{diary-simple-display} shows the actual diary buffer, and uses invisible text to hide entries that don't @@ -569,7 +575,13 @@ hidden. After preparing the buffer, it runs the hook @code{diary-print-entries-hook}. The default value of this hook sends the data directly to the printer with the command @code{lpr-buffer} -(@pxref{Printing}). If you want to use a different command to do the +@iftex +(@pxref{Printing,,, emacs, the Emacs Manual}). +@end iftex +@ifnottex +(@pxref{Printing}). +@end ifnottex +If you want to use a different command to do the printing, just change the value of this hook. Other uses might include, for example, rearranging the lines into order by day and time. === modified file 'doc/emacs/vc1-xtra.texi' --- doc/emacs/vc1-xtra.texi 2012-01-19 07:21:25 +0000 +++ doc/emacs/vc1-xtra.texi 2012-02-16 07:22:57 +0000 @@ -123,7 +123,7 @@ it via the version control system. The file is removed from the working tree, and in the VC Directory buffer @iftex -(@pxref{VC Directory Mode}), +(@pxref{VC Directory Mode,,, emacs, the Emacs Manual}), @end iftex @ifnottex (@pxref{VC Directory Mode}), @@ -438,4 +438,10 @@ locking-like behavior using its @env{CVSREAD} or @dfn{watch} feature; see the CVS documentation for details. If that case, you can use @kbd{C-x v v} in Emacs to toggle locking, as you would for a -locking-based version control system (@pxref{VC With A Locking VCS}). +locking-based version control system +@iftex +(@pxref{VC With A Locking VCS,,,emacs, the Emacs Manual}). +@end iftex +@ifnottex +(@pxref{VC With A Locking VCS}). +@end ifnottex ------------------------------------------------------------ revno: 107301 committer: Glenn Morris branch nick: trunk timestamp: Wed 2012-02-15 23:15:27 -0800 message: * doc/emacs/dired-xtra.texi (Subdir Switches): Small fixes. * admin/FOR-RELEASE: Related markup. diff: === modified file 'admin/FOR-RELEASE' --- admin/FOR-RELEASE 2012-02-16 06:53:50 +0000 +++ admin/FOR-RELEASE 2012-02-16 07:15:27 +0000 @@ -132,7 +132,7 @@ commands.texi cyd custom.texi cyd dired.texi cyd -dired-xtra.texi +dired-xtra.texi rgm display.texi cyd emacs.texi emacs-xtra.texi === modified file 'doc/emacs/ChangeLog' --- doc/emacs/ChangeLog 2012-02-16 06:52:04 +0000 +++ doc/emacs/ChangeLog 2012-02-16 07:15:27 +0000 @@ -1,5 +1,7 @@ 2012-02-16 Glenn Morris + * dired-xtra.texi (Subdir Switches): Small fixes. + * fortran-xtra.texi: Tiny changes and some adjustments to line breaks. 2012-02-15 Glenn Morris === modified file 'doc/emacs/dired-xtra.texi' --- doc/emacs/dired-xtra.texi 2012-01-19 07:21:25 +0000 +++ doc/emacs/dired-xtra.texi 2012-02-16 07:15:27 +0000 @@ -1,5 +1,5 @@ @c This is part of the Emacs manual. -@c Copyright (C) 2004-2012 Free Software Foundation, Inc. +@c Copyright (C) 2004-2012 Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. @c @c This file is included either in emacs-xtra.texi (when producing the @@ -9,12 +9,19 @@ You can insert subdirectories with specified @command{ls} switches in Dired buffers using @kbd{C-u i}. You can change the @command{ls} -switches of an already inserted subdirectory using @kbd{C-u l}. +switches of an already inserted subdirectory at point using @kbd{C-u l}. Dired preserves the switches if you revert the buffer. Deleting a subdirectory forgets about its switches. -Using @code{dired-undo} (@pxref{Marks vs Flags}) to reinsert or delete +Using @code{dired-undo} +@iftex +(@pxref{Marks vs Flags,,, emacs, the Emacs Manual}) +@end iftex +@ifnottex +(@pxref{Marks vs Flags}) +@end ifnottex +to reinsert or delete subdirectories that were inserted with explicit switches can bypass Dired's machinery for remembering (or forgetting) switches. Deleting a subdirectory using @code{dired-undo} does not forget its switches. ------------------------------------------------------------ revno: 107300 committer: Glenn Morris branch nick: trunk timestamp: Wed 2012-02-15 23:13:28 -0800 message: More adjustments to fortran line breaks, for pdf version diff: === modified file 'doc/emacs/fortran-xtra.texi' --- doc/emacs/fortran-xtra.texi 2012-02-16 06:52:04 +0000 +++ doc/emacs/fortran-xtra.texi 2012-02-16 07:13:28 +0000 @@ -99,7 +99,7 @@ the current one, whichever comes first (@code{f90-next-block}). A code block is a subroutine, @code{if}--@code{endif} statement, and so forth. This command exists for F90 mode only, not Fortran mode. -With a numeric argument, this moves forward that many blocks. +With a numeric argument, it moves forward that many blocks. @kindex C-c C-a @r{(F90 mode)} @findex f90-previous-block @@ -237,17 +237,17 @@ The setting of continuation style affects several other aspects of editing in Fortran mode. In fixed form mode, the minimum column number for the body of a statement is 6. Lines inside of Fortran -blocks that are indented to larger column numbers always use only the +blocks that are indented to larger column numbers must use only the space character for whitespace. In tab format mode, the minimum column number for the statement body is 8, and the whitespace before -column 8 must always consist of one tab character. +column 8 must consist of one tab character. @node ForIndent Num @subsubsection Line Numbers If a number is the first non-whitespace in the line, Fortran indentation assumes it is a line number and moves it to columns 0 -through 4. (Columns always count from 0 in GNU Emacs.) +through 4. (Columns always count from 0 in Emacs.) @vindex fortran-line-number-indent Line numbers of four digits or less are normally indented one space. @@ -327,7 +327,7 @@ @samp{do} that ends there. If you always end @samp{do} statements with a @samp{continue} line (or if you use the more modern @samp{enddo}), then you can speed up indentation by setting this variable to -@code{nil}. The default is @code{nil}. +@code{nil} (the default). @item fortran-blink-matching-if If this is @code{t}, indenting an @samp{endif} (or @samp{enddo} @@ -336,17 +336,17 @@ @item fortran-minimum-statement-indent-fixed Minimum indentation for Fortran statements when using fixed form -continuation line style. Statement bodies are never indented less than -this much. The default is 6. +continuation line style. Statement bodies are never indented by less than +this. The default is 6. @item fortran-minimum-statement-indent-tab Minimum indentation for Fortran statements for tab format continuation line -style. Statement bodies are never indented less than this much. The +style. Statement bodies are never indented by less than this. The default is 8. @end table -The variables controlling the indentation of comments are described in -the following section. +The following section describes the variables controlling the +indentation of comments. @node Fortran Comments @subsection Fortran Comments @@ -505,8 +505,7 @@ Split the current window horizontally temporarily so that it is @code{fortran-line-length} columns wide (@code{fortran-window-create-momentarily}). This may help you avoid -making lines longer than the character limit imposed by your Fortran -compiler. +making lines longer than the limit imposed by your Fortran compiler. @item C-u C-c C-w Split the current window horizontally so that it is @code{fortran-line-length} columns wide (@code{fortran-window-create}). ------------------------------------------------------------ revno: 107299 committer: Glenn Morris branch nick: trunk timestamp: Wed 2012-02-15 22:53:50 -0800 message: FOR-RELEASE updates diff: === modified file 'admin/FOR-RELEASE' --- admin/FOR-RELEASE 2012-02-14 16:41:16 +0000 +++ admin/FOR-RELEASE 2012-02-16 06:53:50 +0000 @@ -61,11 +61,6 @@ * BUGS -** rms: gnus-dired.el is a mistake. Those features should not -be part of Gnus. They should be moved to some other part of Emacs. -rsteib: Gnus dependencies in `gnus-dired.el' (and `mailcap.el') have been -minimized. I don't know what is left to do here. - ** Check for modes which bind M-s that conflicts with a new global binding M-s and change key bindings where necessary. The current list of modes: @@ -145,7 +140,7 @@ entering.texi cyd files.texi cyd fixit.texi cyd -fortran-xtra.texi +fortran-xtra.texi rgm frames.texi cyd glossary.texi help.texi cyd @@ -232,7 +227,7 @@ windows.texi * PLANNED ADDITIONS -* pov-mode (probably not for Emacs-23: waiting for a Free POV-Ray). +* pov-mode (waiting for a Free POV-Ray) ** gas-mode ? ------------------------------------------------------------ revno: 107298 committer: Glenn Morris branch nick: trunk timestamp: Wed 2012-02-15 22:52:04 -0800 message: * doc/emacs/fortran-xtra.texi: Tiny changes and some adjustments to line breaks. diff: === modified file 'doc/emacs/ChangeLog' --- doc/emacs/ChangeLog 2012-02-15 03:15:26 +0000 +++ doc/emacs/ChangeLog 2012-02-16 06:52:04 +0000 @@ -1,3 +1,7 @@ +2012-02-16 Glenn Morris + + * fortran-xtra.texi: Tiny changes and some adjustments to line breaks. + 2012-02-15 Glenn Morris * sending.texi (Mail Sending): smtpmail-auth-credentials was removed. === modified file 'doc/emacs/fortran-xtra.texi' --- doc/emacs/fortran-xtra.texi 2012-01-19 07:21:25 +0000 +++ doc/emacs/fortran-xtra.texi 2012-02-16 06:52:04 +0000 @@ -1,5 +1,5 @@ @c This is part of the Emacs manual. -@c Copyright (C) 2004-2012 Free Software Foundation, Inc. +@c Copyright (C) 2004-2012 Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. @c @c This file is included either in emacs-xtra.texi (when producing the @@ -70,11 +70,10 @@ @subsection Motion Commands In addition to the normal commands for moving by and operating on -``defuns'' (Fortran subprograms---functions and subroutines, using the -commands @code{fortran-beginning-of-subprogram} and -@code{fortran-end-of-subprogram}; as well as modules for F90 mode), -Fortran mode provides special commands to move by statements and other -program units. +``defuns'' (Fortran subprograms---functions and subroutines, as well +as modules for F90 mode, using the commands @code{fortran-end-of-subprogram} +and @code{fortran-beginning-of-subprogram}), Fortran mode provides +special commands to move by statements and other program units. @table @kbd @kindex C-c C-n @r{(Fortran mode)} @@ -97,16 +96,15 @@ @findex f90-next-block @item C-c C-e Move point forward to the start of the next code block, or the end of -the current block, whichever is encountered first. -(@code{f90-next-block}). A code block is a subroutine, -@code{if}--@code{endif} statement, and so forth. This command exists -for F90 mode only, not Fortran mode. With a numeric argument, this -moves forward that many blocks. +the current one, whichever comes first (@code{f90-next-block}). +A code block is a subroutine, @code{if}--@code{endif} statement, and +so forth. This command exists for F90 mode only, not Fortran mode. +With a numeric argument, this moves forward that many blocks. @kindex C-c C-a @r{(F90 mode)} @findex f90-previous-block @item C-c C-a -Move point backward to the previous code block +Move point backward to the previous block (@code{f90-previous-block}). This is like @code{f90-next-block}, but moves backwards. @@ -163,7 +161,7 @@ @item M-^ Join this line to the previous line (@code{fortran-join-line}). @item C-M-q -Indent all the lines of the subprogram point is in +Indent all the lines of the subprogram that point is in (@code{fortran-indent-subprogram}). @item M-q Fill a comment block or statement (using @code{fortran-fill-paragraph} @@ -364,7 +362,7 @@ some Fortran 77 compilers accept this syntax, Fortran mode will not insert such comments unless you have said in advance to do so. To do this, set the variable @code{fortran-comment-line-start} to @samp{"!"}. -If you use an unusual value, you may also need to adjust +If you use an unusual value, you may need to change @code{fortran-comment-line-start-skip}. @@ -373,7 +371,7 @@ Align comment or insert new comment (@code{comment-dwim}). @item C-x ; -Applies to nonstandard @samp{!} comments only. +Applies to nonstandard @samp{!} comments only (@code{comment-set-column}). @item C-c ; Turn all lines of the region into comments, or (with argument) turn them back @@ -406,10 +404,10 @@ @code{fortran-comment-line-extra-indent} and the minimum statement indentation. This is the default. -The minimum statement indentation is -@code{fortran-minimum-statement-indent-fixed} for fixed form -continuation line style and @code{fortran-minimum-statement-indent-tab} -for tab format style. +The minimum indentation is +@code{fortran-minimum-statement-indent-tab} for tab format +continuation line style and @code{fortran-minimum-statement-indent-fixed} +for fixed form style. @item relative Align the text as if it were a line of code, but with an additional @@ -434,17 +432,17 @@ lines are directives. Matching lines are never indented, and receive distinctive font-locking. - The normal Emacs comment command @kbd{C-x ;} has not been redefined. If -you use @samp{!} comments, this command can be used with them. Otherwise -it is useless in Fortran mode. + The normal Emacs comment command @kbd{C-x ;} (@code{comment-set-column}) +has not been redefined. If you use @samp{!} comments, this command +can be used with them. Otherwise it is useless in Fortran mode. @kindex C-c ; @r{(Fortran mode)} @findex fortran-comment-region @vindex fortran-comment-region The command @kbd{C-c ;} (@code{fortran-comment-region}) turns all the -lines of the region into comments by inserting the string @samp{C$$$} at +lines of the region into comments by inserting the string @samp{c$$$} at the front of each one. With a numeric argument, it turns the region -back into live code by deleting @samp{C$$$} from the front of each line +back into live code by deleting @samp{c$$$} from the front of each line in it. The string used for these comments can be controlled by setting the variable @code{fortran-comment-region}. Note that here we have an example of a command and a variable with the same name; these two uses ------------------------------------------------------------ revno: 107297 committer: Chong Yidong branch nick: trunk timestamp: Thu 2012-02-16 14:04:38 +0800 message: Updates to Font Lock docs in Lisp manual. * doc/lispref/modes.texi (Minor Modes): Update how mode commands should treat arguments now. (Mode Line Basics): Clarify force-mode-line-update. (Mode Line Top): Note that the example is not realistic. (Mode Line Variables, Mode Line Data, %-Constructs, Header Lines) (Emulating Mode Line): Use "mode line" instead of "mode-line", and "mode line construct" instead of "mode line specification". (Syntactic Font Lock): Remove mention of obsolete variable font-lock-syntactic-keywords. (Setting Syntax Properties): Node deleted. (Font Lock Mode): Note that Font Lock mode is a minor mode. (Font Lock Basics): Note that syntactic fontification falls back on `syntax-table'. (Search-based Fontification): Emphasize that font-lock-keywords should not be set directly. (Faces for Font Lock): Avoid some confusing terminology. (Syntactic Font Lock): Minor clarifications. diff: === modified file 'doc/lispref/ChangeLog' --- doc/lispref/ChangeLog 2012-02-15 13:45:02 +0000 +++ doc/lispref/ChangeLog 2012-02-16 06:04:38 +0000 @@ -1,3 +1,23 @@ +2012-02-16 Chong Yidong + + * modes.texi (Minor Modes): Update how mode commands should treat + arguments now. + (Mode Line Basics): Clarify force-mode-line-update. + (Mode Line Top): Note that the example is not realistic. + (Mode Line Variables, Mode Line Data, %-Constructs, Header Lines) + (Emulating Mode Line): Use "mode line" instead of "mode-line", and + "mode line construct" instead of "mode line specification". + (Syntactic Font Lock): Remove mention of obsolete variable + font-lock-syntactic-keywords. + (Setting Syntax Properties): Node deleted. + (Font Lock Mode): Note that Font Lock mode is a minor mode. + (Font Lock Basics): Note that syntactic fontification falls back + on `syntax-table'. + (Search-based Fontification): Emphasize that font-lock-keywords + should not be set directly. + (Faces for Font Lock): Avoid some confusing terminology. + (Syntactic Font Lock): Minor clarifications. + 2012-02-15 Chong Yidong * minibuf.texi (Basic Completion): Define "completion table". @@ -9,6 +29,10 @@ (Setting Hooks): Update minor mode usage example. (Major Mode Conventions): Note that completion-at-point-functions should be altered locally. Add xref to Completion in Buffers. + Remove duplicate tip about auto-mode-alist. + (Minor Modes): Rewrite introduction. + (Minor Mode Conventions): Copyedits. Don't recommend + variable-only minor modes since few minor modes are like that. 2012-02-15 Glenn Morris === modified file 'doc/lispref/elisp.texi' --- doc/lispref/elisp.texi 2012-02-15 13:45:02 +0000 +++ doc/lispref/elisp.texi 2012-02-16 06:04:38 +0000 @@ -814,8 +814,6 @@ contents can also specify how to fontify it. * Faces for Font Lock:: Special faces specifically for Font Lock. * Syntactic Font Lock:: Fontification based on syntax tables. -* Setting Syntax Properties:: Defining character syntax based on context - using the Font Lock mechanism. * Multiline Font Lock:: How to coerce Font Lock into properly highlighting multiline constructs. === modified file 'doc/lispref/modes.texi' --- doc/lispref/modes.texi 2012-02-15 13:45:02 +0000 +++ doc/lispref/modes.texi 2012-02-16 06:04:38 +0000 @@ -464,11 +464,6 @@ @code{completion-at-point-functions}. @xref{Completion in Buffers}. @item -Use @code{defvar} or @code{defcustom} to set mode-related variables, so -that they are not reinitialized if they already have a value. (Such -reinitialization could discard customizations made by the user.) - -@item @cindex buffer-local variables in modes To make a buffer-local binding for an Emacs customization variable, use @code{make-local-variable} in the major mode command, not @@ -546,15 +541,13 @@ the file that contains the mode definition. @item -In the comments that document the file, you should provide a sample -@code{autoload} form and an example of how to add to -@code{auto-mode-alist}, that users can include in their init files -(@pxref{Init File}). - -@item @cindex mode loading The top-level forms in the file defining the mode should be written so that they may be evaluated more than once without adverse consequences. +For instance, use @code{defvar} or @code{defcustom} to set mode-related +variables, so that they are not reinitialized if they already have a +value (@pxref{Defining Variables}). + @end itemize @node Auto Major Mode @@ -1201,27 +1194,20 @@ @section Minor Modes @cindex minor mode - A @dfn{minor mode} provides features that users may enable or disable -independently of the choice of major mode. Minor modes can be enabled -individually or in combination. Minor modes would be better named -``generally available, optional feature modes,'' except that such a name -would be unwieldy. - - A minor mode is not usually meant as a variation of a single major mode. -Usually they are general and can apply to many major modes. For -example, Auto Fill mode works with any major mode that permits text -insertion. To be general, a minor mode must be effectively independent -of the things major modes do. - - A minor mode is often much more difficult to implement than a major -mode. One reason is that you should be able to activate and deactivate -minor modes in any order. A minor mode should be able to have its -desired effect regardless of the major mode and regardless of the other -minor modes in effect. - - Often the biggest problem in implementing a minor mode is finding a -way to insert the necessary hook into the rest of Emacs. Minor mode -keymaps make this easier than it used to be. + A @dfn{minor mode} provides optional features that users may enable or +disable independently of the choice of major mode. Minor modes can be +enabled individually or in combination. + + Most minor modes implement features that are independent of the major +mode, and can thus be used with most major modes. For example, Auto +Fill mode works with any major mode that permits text insertion. A few +minor modes, however, are specific to a particular major mode. For +example, Diff Auto Refine mode is a minor mode that is intended to be +used only with Diff mode. + + Ideally, a minor mode should have its desired effect regardless of the +other minor modes in effect. It should be possible to activate and +deactivate minor modes in any order. @defvar minor-mode-list The value of this variable is a list of all minor mode commands. @@ -1239,60 +1225,76 @@ @cindex conventions for writing minor modes There are conventions for writing minor modes just as there are for -major modes. Several of the major mode conventions apply to minor -modes as well: those regarding the name of the mode initialization -function, the names of global symbols, the use of a hook at the end of -the initialization function, and the use of keymaps and other tables. - - In addition, there are several conventions that are specific to -minor modes. (The easiest way to follow all the conventions is to use -the macro @code{define-minor-mode}; @ref{Defining Minor Modes}.) +major modes. These conventions are described below. The easiest way to +follow them is to use the macro @code{define-minor-mode}. +@xref{Defining Minor Modes}. @itemize @bullet @item @cindex mode variable -Make a variable whose name ends in @samp{-mode} to control the minor -mode. We call this the @dfn{mode variable}. The minor mode command -should set this variable (@code{nil} to disable; anything else to -enable). - -If possible, implement the mode so that setting the variable -automatically enables or disables the mode. Then the minor mode command -does not need to do anything except set the variable. +Define a variable whose name ends in @samp{-mode}. We call this the +@dfn{mode variable}. The minor mode command should set this variable. +The value will be @code{nil} is the mode is disabled, and non-@code{nil} +if the mode is enabled. The variable should be buffer-local if the +minor mode is buffer-local. This variable is used in conjunction with the @code{minor-mode-alist} to -display the minor mode name in the mode line. It can also enable -or disable a minor mode keymap. Individual commands or hooks can also -check the variable's value. - -If you want the minor mode to be enabled separately in each buffer, -make the variable buffer-local. +display the minor mode name in the mode line. It also determines +whether the minor mode keymap is active, via @code{minor-mode-map-alist} +(@pxref{Controlling Active Maps}). Individual commands or hooks can +also check its value. @item -Define a command whose name is the same as the mode variable. -Its job is to enable and disable the mode by setting the variable. - -The command should accept one optional argument. If the argument is -@code{nil}, it should toggle the mode (turn it on if it is off, and -off if it is on). It should turn the mode on if the argument is a -positive integer, the symbol @code{t}, or a list whose @sc{car} is one -of those. It should turn the mode off if the argument is a negative -integer or zero, the symbol @code{-}, or a list whose @sc{car} is a -negative integer or zero. The meaning of other arguments is not -specified. - -Here is an example taken from the definition of @code{transient-mark-mode}. -It shows the use of @code{transient-mark-mode} as a variable that enables or -disables the mode's behavior, and also shows the proper way to toggle, -enable or disable the minor mode based on the raw prefix argument value. - -@smallexample -@group -(setq transient-mark-mode - (if (null arg) (not transient-mark-mode) - (> (prefix-numeric-value arg) 0))) -@end group -@end smallexample +Define a command, called the @dfn{mode command}, whose name is the same +as the mode variable. Its job is to set the value of the mode variable, +plus anything else that needs to be done to actually enable or disable +the mode's features. + +The mode command should accept one optional argument. If called +interactively with no prefix argument, it should toggle the mode +(i.e.@: enable if it is disabled, and disable if it is enabled). If +called interactively with a prefix argument, it should enable the mode +if the argument is positive and disable it otherwise. + +If the mode command is called from Lisp (i.e.@: non-interactively), it +should enable the mode if the argument is omitted or @code{nil}; it +should toggle the mode if the argument is the symbol @code{toggle}; +otherwise it should treat the argument in the same way as for an +interactive call with a numeric prefix argument, as described above. + +The following example shows how to implement this behavior (it is +similar to the code generated by the @code{define-minor-mode} macro): + +@example +(interactive (list (or current-prefix-arg 'toggle))) +(let ((enable (if (eq arg 'toggle) + (not foo-mode) ; @r{this mode's mode variable} + (> (prefix-numeric-value arg) 0)))) + (if enable + @var{do-enable} + @var{do-disable})) +@end example + +The reason for this somewhat complex behavior is that it lets users +easily toggle the minor mode interactively, and also lets the minor mode +be easily enabled in a mode hook, like this: + +@example +(add-hook 'text-mode-hook 'foo-mode) +@end example + +@noindent +This behaves correctly whether or not @code{foo-mode} was already +enabled, since the @code{foo-mode} mode command unconditionally enables +the minor mode when it is called from Lisp with no argument. Disabling +a minor mode in a mode hook is a little uglier: + +@example +(add-hook 'text-mode-hook (lambda () (foo-mode -1))) +@end example + +@noindent +However, this is not very commonly done. @item Add an element to @code{minor-mode-alist} for each minor mode @@ -1315,8 +1317,7 @@ @smallexample @group (unless (assq 'leif-mode minor-mode-alist) - (setq minor-mode-alist - (cons '(leif-mode " Leif") minor-mode-alist))) + (push '(leif-mode " Leif") minor-mode-alist)) @end group @end smallexample @@ -1330,25 +1331,24 @@ @end smallexample @end itemize - Global minor modes distributed with Emacs should if possible support -enabling and disabling via Custom (@pxref{Customization}). To do this, -the first step is to define the mode variable with @code{defcustom}, and -specify @code{:type 'boolean}. + In addition, several major mode conventions apply to minor modes as +well: those regarding the names of global symbols, the use of a hook at +the end of the initialization function, and the use of keymaps and other +tables. - If just setting the variable is not sufficient to enable the mode, you + The minor mode should, if possible, support enabling and disabling via +Custom (@pxref{Customization}). To do this, the mode variable should be +defined with @code{defcustom}, usually with @code{:type 'boolean}. If +just setting the variable is not sufficient to enable the mode, you should also specify a @code{:set} method which enables the mode by -invoking the mode command. Note in the variable's documentation string that -setting the variable other than via Custom may not take effect. - - Also mark the definition with an autoload cookie (@pxref{autoload cookie}), -and specify a @code{:require} so that customizing the variable will load -the library that defines the mode. This will copy suitable definitions -into @file{loaddefs.el} so that users can use @code{customize-option} to -enable the mode. For example: +invoking the mode command. Note in the variable's documentation string +that setting the variable other than via Custom may not take effect. +Also, mark the definition with an autoload cookie (@pxref{autoload +cookie}), and specify a @code{:require} so that customizing the variable +will load the library that defines the mode. For example: @smallexample @group - ;;;###autoload (defcustom msb-mode nil "Toggle msb-mode. @@ -1578,7 +1578,7 @@ @node Mode Line Format -@section Mode-Line Format +@section Mode Line Format @cindex mode line Each Emacs window (aside from minibuffer windows) typically has a mode @@ -1608,61 +1608,59 @@ @node Mode Line Basics @subsection Mode Line Basics - @code{mode-line-format} is a buffer-local variable that holds a -@dfn{mode line construct}, a kind of template, which controls what is -displayed on the mode line of the current buffer. The value of -@code{header-line-format} specifies the buffer's header line in the -same way. All windows for the same buffer use the same + The contents of each mode line are specified by the buffer-local +variable @code{mode-line-format} (@pxref{Mode Line Top}). This variable +holds a @dfn{mode line construct}: a template that controls what is +displayed on the buffer's mode line. The value of +@code{header-line-format} specifies the buffer's header line in the same +way. All windows for the same buffer use the same @code{mode-line-format} and @code{header-line-format}. - For efficiency, Emacs does not continuously recompute the mode -line and header line of a window. It does so when circumstances -appear to call for it---for instance, if you change the window -configuration, switch buffers, narrow or widen the buffer, scroll, or -change the buffer's modification status. If you modify any of the -variables referenced by @code{mode-line-format} (@pxref{Mode Line -Variables}), or any other variables and data structures that affect -how text is displayed (@pxref{Display}), you may want to force an -update of the mode line so as to display the new information or -display it in the new way. + For efficiency, Emacs does not continuously recompute each window's +mode line and header line. It does so when circumstances appear to call +for it---for instance, if you change the window configuration, switch +buffers, narrow or widen the buffer, scroll, or modify the buffer. If +you alter any of the variables referenced by @code{mode-line-format} or +@code{header-line-format} (@pxref{Mode Line Variables}), or any other +data structures that affect how text is displayed (@pxref{Display}), you +should use the function @code{force-mode-line-update} to update the +display. @defun force-mode-line-update &optional all -Force redisplay of the current buffer's mode line and header line. -The next redisplay will update the mode line and header line based on -the latest values of all relevant variables. With optional -non-@code{nil} @var{all}, force redisplay of all mode lines and header -lines. +This function forces Emacs to update the current buffer's mode line and +header line, based on the latest values of all relevant variables, +during its next redisplay cycle. If the optional argument @var{all} is +non-@code{nil}, it forces an update for all mode lines and header lines. -This function also forces recomputation of the menu bar menus -and the frame title. +This function also forces an update of the menu bar and frame title. @end defun The selected window's mode line is usually displayed in a different -color using the face @code{mode-line}. Other windows' mode lines -appear in the face @code{mode-line-inactive} instead. @xref{Faces}. +color using the face @code{mode-line}. Other windows' mode lines appear +in the face @code{mode-line-inactive} instead. @xref{Faces}. @node Mode Line Data @subsection The Data Structure of the Mode Line -@cindex mode-line construct +@cindex mode line construct - The mode-line contents are controlled by a data structure called a -@dfn{mode-line construct}, made up of lists, strings, symbols, and + The mode line contents are controlled by a data structure called a +@dfn{mode line construct}, made up of lists, strings, symbols, and numbers kept in buffer-local variables. Each data type has a specific -meaning for the mode-line appearance, as described below. The same -data structure is used for constructing frame titles (@pxref{Frame -Titles}) and header lines (@pxref{Header Lines}). +meaning for the mode line appearance, as described below. The same data +structure is used for constructing frame titles (@pxref{Frame Titles}) +and header lines (@pxref{Header Lines}). - A mode-line construct may be as simple as a fixed string of text, + A mode line construct may be as simple as a fixed string of text, but it usually specifies how to combine fixed strings with variables' values to construct the text. Many of these variables are themselves -defined to have mode-line constructs as their values. +defined to have mode line constructs as their values. - Here are the meanings of various data types as mode-line constructs: + Here are the meanings of various data types as mode line constructs: @table @code @cindex percent symbol in mode line @item @var{string} -A string as a mode-line construct appears verbatim except for +A string as a mode line construct appears verbatim except for @dfn{@code{%}-constructs} in it. These stand for substitution of other data; see @ref{%-Constructs}. @@ -1675,8 +1673,8 @@ special meanings. @xref{Properties in Mode}. @item @var{symbol} -A symbol as a mode-line construct stands for its value. The value of -@var{symbol} is used as a mode-line construct, in place of @var{symbol}. +A symbol as a mode line construct stands for its value. The value of +@var{symbol} is used as a mode line construct, in place of @var{symbol}. However, the symbols @code{t} and @code{nil} are ignored, as is any symbol whose value is void. @@ -1685,17 +1683,17 @@ Unless @var{symbol} is marked as ``risky'' (i.e., it has a non-@code{nil} @code{risky-local-variable} property), all text -properties specified in @var{symbol}'s value are ignored. This -includes the text properties of strings in @var{symbol}'s value, as -well as all @code{:eval} and @code{:propertize} forms in it. (The -reason for this is security: non-risky variables could be set -automatically from file variables without prompting the user.) +properties specified in @var{symbol}'s value are ignored. This includes +the text properties of strings in @var{symbol}'s value, as well as all +@code{:eval} and @code{:propertize} forms in it. (The reason for this +is security: non-risky variables could be set automatically from file +variables without prompting the user.) @item (@var{string} @var{rest}@dots{}) @itemx (@var{list} @var{rest}@dots{}) A list whose first element is a string or list means to process all the elements recursively and concatenate the results. This is the most -common form of mode-line construct. +common form of mode line construct. @item (:eval @var{form}) A list whose first element is the symbol @code{:eval} says to evaluate @@ -1705,24 +1703,24 @@ @item (:propertize @var{elt} @var{props}@dots{}) A list whose first element is the symbol @code{:propertize} says to -process the mode-line construct @var{elt} recursively, then add the text +process the mode line construct @var{elt} recursively, then add the text properties specified by @var{props} to the result. The argument @var{props} should consist of zero or more pairs @var{text-property} -@var{value}. (This feature is new as of Emacs 22.1.) +@var{value}. @item (@var{symbol} @var{then} @var{else}) A list whose first element is a symbol that is not a keyword specifies a conditional. Its meaning depends on the value of @var{symbol}. If @var{symbol} has a non-@code{nil} value, the second element, -@var{then}, is processed recursively as a mode-line element. +@var{then}, is processed recursively as a mode line element. Otherwise, the third element, @var{else}, is processed recursively. -You may omit @var{else}; then the mode-line element displays nothing +You may omit @var{else}; then the mode line element displays nothing if the value of @var{symbol} is @code{nil} or void. @item (@var{width} @var{rest}@dots{}) A list whose first element is an integer specifies truncation or padding of the results of @var{rest}. The remaining elements -@var{rest} are processed recursively as mode-line constructs and +@var{rest} are processed recursively as mode line constructs and concatenated together. When @var{width} is positive, the result is space filled on the right if its width is less than @var{width}. When @var{width} is negative, the result is truncated on the right to @@ -1739,12 +1737,12 @@ @code{mode-line-format}. @defopt mode-line-format -The value of this variable is a mode-line construct that controls the +The value of this variable is a mode line construct that controls the contents of the mode-line. It is always buffer-local in all buffers. -If you set this variable to @code{nil} in a buffer, that buffer does -not have a mode line. (A window that is just one line tall never -displays a mode line.) +If you set this variable to @code{nil} in a buffer, that buffer does not +have a mode line. (A window that is just one line tall also does not +display a mode line.) @end defopt The default value of @code{mode-line-format} is designed to use the @@ -1762,9 +1760,9 @@ the user or by Lisp programs (such as @code{display-time} and major modes) via changes to those variables remain effective. - Here is an example of a @code{mode-line-format} that might be -useful for @code{shell-mode}, since it contains the host name and default -directory. + Here is a hypothetical example of a @code{mode-line-format} that might +be useful for Shell mode (in reality, Shell mode does not set +@code{mode-line-format}): @example @group @@ -1777,7 +1775,7 @@ @end group @group ;; @r{Note that this is evaluated while making the list.} - ;; @r{It makes a mode-line construct which is just a string.} + ;; @r{It makes a mode line construct which is just a string.} (getenv "HOST") @end group ":" @@ -1794,8 +1792,7 @@ '(which-func-mode ("" which-func-format "--")) '(line-number-mode "L%l--") '(column-number-mode "C%c--") - '(-3 "%p") - "-%-")) + '(-3 "%p"))) @end group @end example @@ -1807,23 +1804,23 @@ @node Mode Line Variables @subsection Variables Used in the Mode Line - This section describes variables incorporated by the standard value -of @code{mode-line-format} into the text of the mode line. There is + This section describes variables incorporated by the standard value of +@code{mode-line-format} into the text of the mode line. There is nothing inherently special about these variables; any other variables -could have the same effects on the mode line if -@code{mode-line-format}'s value were changed to use them. However, -various parts of Emacs set these variables on the understanding that -they will control parts of the mode line; therefore, practically -speaking, it is essential for the mode line to use them. +could have the same effects on the mode line if the value of +@code{mode-line-format} is changed to use them. However, various parts +of Emacs set these variables on the understanding that they will control +parts of the mode line; therefore, practically speaking, it is essential +for the mode line to use them. @defvar mode-line-mule-info -This variable holds the value of the mode-line construct that displays +This variable holds the value of the mode line construct that displays information about the language environment, buffer coding system, and current input method. @xref{Non-ASCII Characters}. @end defvar @defvar mode-line-modified -This variable holds the value of the mode-line construct that displays +This variable holds the value of the mode line construct that displays whether the current buffer is modified. Its default value displays @samp{**} if the buffer is modified, @samp{--} if the buffer is not modified, @samp{%%} if the buffer is read only, and @samp{%*} if the @@ -1886,7 +1883,7 @@ @end defvar @defvar mode-line-process -This buffer-local variable contains the mode-line information on process +This buffer-local variable contains the mode line information on process status in modes used for communicating with subprocesses. It is displayed immediately following the major mode name, with no intervening space. For example, its value in the @samp{*shell*} buffer is @@ -1905,12 +1902,12 @@ (@var{minor-mode-variable} @var{mode-line-string}) @end example -More generally, @var{mode-line-string} can be any mode-line spec. It -appears in the mode line when the value of @var{minor-mode-variable} +More generally, @var{mode-line-string} can be any mode line construct. +It appears in the mode line when the value of @var{minor-mode-variable} is non-@code{nil}, and not otherwise. These strings should begin with spaces so that they don't run together. Conventionally, the -@var{minor-mode-variable} for a specific mode is set to a -non-@code{nil} value when that minor mode is activated. +@var{minor-mode-variable} for a specific mode is set to a non-@code{nil} +value when that minor mode is activated. @code{minor-mode-alist} itself is not buffer-local. Each variable mentioned in the alist should be buffer-local if its minor mode can be @@ -1918,12 +1915,12 @@ @end defvar @defvar global-mode-string -This variable holds a mode-line spec that, by default, appears in the -mode line just after the @code{which-func-mode} minor mode if set, -else after @code{mode-line-modes}. The command @code{display-time} -sets @code{global-mode-string} to refer to the variable -@code{display-time-string}, which holds a string containing the time -and load information. +This variable holds a mode line construct that, by default, appears in +the mode line just after the @code{which-func-mode} minor mode if set, +else after @code{mode-line-modes}. The command @code{display-time} sets +@code{global-mode-string} to refer to the variable +@code{display-time-string}, which holds a string containing the time and +load information. The @samp{%M} construct substitutes the value of @code{global-mode-string}, but that is obsolete, since the variable is @@ -1957,7 +1954,7 @@ @node %-Constructs @subsection @code{%}-Constructs in the Mode Line - Strings used as mode-line constructs can use certain + Strings used as mode line constructs can use certain @code{%}-constructs to substitute various kinds of data. Here is a list of the defined @code{%}-constructs, and what they mean. In any construct except @samp{%%}, you can add a decimal integer after the @@ -2003,8 +2000,8 @@ @item %p The percentage of the buffer text above the @strong{top} of window, or -@samp{Top}, @samp{Bottom} or @samp{All}. Note that the default -mode-line specification truncates this to three characters. +@samp{Top}, @samp{Bottom} or @samp{All}. Note that the default mode +line construct truncates this to three characters. @item %P The percentage of the buffer text that is above the @strong{bottom} of @@ -2084,11 +2081,11 @@ @enumerate @item -Put a string with a text property directly into the mode-line data +Put a string with a text property directly into the mode line data structure. @item -Put a text property on a mode-line %-construct such as @samp{%12b}; then +Put a text property on a mode line %-construct such as @samp{%12b}; then the expansion of the %-construct will have that same text property. @item @@ -2096,7 +2093,7 @@ give @var{elt} a text property specified by @var{props}. @item -Use a list containing @code{:eval @var{form}} in the mode-line data +Use a list containing @code{:eval @var{form}} in the mode line data structure, and make @var{form} evaluate to a string that has a text property. @end enumerate @@ -2118,10 +2115,10 @@ @cindex header line (of a window) @cindex window header line - A window can have a @dfn{header line} at the -top, just as it can have a mode line at the bottom. The header line -feature works just like the mode-line feature, except that it's -controlled by different variables. + A window can have a @dfn{header line} at the top, just as it can have +a mode line at the bottom. The header line feature works just like the +mode line feature, except that it's controlled by +@code{header-line-format}: @defvar header-line-format This variable, local in every buffer, specifies how to display the @@ -2136,11 +2133,11 @@ header line. @node Emulating Mode Line -@subsection Emulating Mode-Line Formatting +@subsection Emulating Mode Line Formatting - You can use the function @code{format-mode-line} to compute -the text that would appear in a mode line or header line -based on a certain mode-line specification. + You can use the function @code{format-mode-line} to compute the text +that would appear in a mode line or header line based on a certain +mode line construct. @defun format-mode-line format &optional face window buffer This function formats a line of text according to @var{format} as if it @@ -2374,12 +2371,12 @@ @section Font Lock Mode @cindex Font Lock mode - @dfn{Font Lock mode} is a feature that automatically attaches -@code{face} properties to certain parts of the buffer based on their -syntactic role. How it parses the buffer depends on the major mode; -most major modes define syntactic criteria for which faces to use in -which contexts. This section explains how to customize Font Lock for a -particular major mode. + @dfn{Font Lock mode} is a buffer-local minor mode that automatically +attaches @code{face} properties to certain parts of the buffer based on +their syntactic role. How it parses the buffer depends on the major +mode; most major modes define syntactic criteria for which faces to use +in which contexts. This section explains how to customize Font Lock for +a particular major mode. Font Lock mode finds text to highlight in two ways: through syntactic parsing based on the syntax table, and through searching @@ -2398,8 +2395,6 @@ contents can also specify how to fontify it. * Faces for Font Lock:: Special faces specifically for Font Lock. * Syntactic Font Lock:: Fontification based on syntax tables. -* Setting Syntax Properties:: Defining character syntax based on context - using the Font Lock mechanism. * Multiline Font Lock:: How to coerce Font Lock into properly highlighting multiline constructs. @end menu @@ -2414,12 +2409,12 @@ Lock mode is enabled, to set all the other variables. @defvar font-lock-defaults -This variable is set by major modes, as a buffer-local variable, to -specify how to fontify text in that mode. It automatically becomes -buffer-local when you set it. If its value is @code{nil}, Font-Lock -mode does no highlighting, and you can use the @samp{Faces} menu -(under @samp{Edit} and then @samp{Text Properties} in the menu bar) to -assign faces explicitly to text in the buffer. +This variable is set by major modes to specify how to fontify text in +that mode. It automatically becomes buffer-local when set. If its +value is @code{nil}, Font Lock mode does no highlighting, and you can +use the @samp{Faces} menu (under @samp{Edit} and then @samp{Text +Properties} in the menu bar) to assign faces explicitly to text in the +buffer. If non-@code{nil}, the value should look like this: @@ -2442,19 +2437,20 @@ The second element, @var{keywords-only}, specifies the value of the variable @code{font-lock-keywords-only}. If this is omitted or @code{nil}, syntactic fontification (of strings and comments) is also -performed. If this is non-@code{nil}, such fontification is not +performed. If this is non-@code{nil}, syntactic fontification is not performed. @xref{Syntactic Font Lock}. The third element, @var{case-fold}, specifies the value of @code{font-lock-keywords-case-fold-search}. If it is non-@code{nil}, -Font Lock mode ignores case when searching as directed by -@code{font-lock-keywords}. +Font Lock mode ignores case during search-based fontification. -If the fourth element, @var{syntax-alist}, is non-@code{nil}, it -should be a list of cons cells of the form @code{(@var{char-or-string} -. @var{string})}. These are used to set up a syntax table for -syntactic fontification (@pxref{Syntax Table Functions}). The -resulting syntax table is stored in @code{font-lock-syntax-table}. +If the fourth element, @var{syntax-alist}, is non-@code{nil}, it should +be a list of cons cells of the form @code{(@var{char-or-string} +. @var{string})}. These are used to set up a syntax table for syntactic +fontification; the resulting syntax table is stored in +@code{font-lock-syntax-table}. If @var{syntax-alist} is omitted or +@code{nil}, syntactic fontification uses the syntax table returned by +the @code{syntax-table} function. @xref{Syntax Table Functions}. The fifth element, @var{syntax-begin}, specifies the value of @code{font-lock-beginning-of-syntax-function}. We recommend setting @@ -2480,15 +2476,17 @@ @node Search-based Fontification @subsection Search-based Fontification - The most important variable for customizing Font Lock mode is -@code{font-lock-keywords}. It specifies the search criteria for -search-based fontification. You should specify the value of this -variable with @var{keywords} in @code{font-lock-defaults}. + The variable which directly controls search-based fontification is +@code{font-lock-keywords}, which is typically specified via the +@var{keywords} element in @code{font-lock-defaults}. @defvar font-lock-keywords -This variable's value is a list of the keywords to highlight. Be -careful when composing regular expressions for this list; a poorly -written pattern can dramatically slow things down! +The value of this variable is a list of the keywords to highlight. Lisp +programs should not set this variable directly. Normally, the value is +automatically set by Font Lock mode, using the @var{keywords} element in +@code{font-lock-defaults}. The value can also be altered using the +functions @code{font-lock-add-keywords} and +@code{font-lock-remove-keywords} (@pxref{Customizing Keywords}). @end defvar Each element of @code{font-lock-keywords} specifies how to find @@ -2513,9 +2511,10 @@ "\\" @end example -The function @code{regexp-opt} (@pxref{Regexp Functions}) is useful -for calculating optimal regular expressions to match a number of -different keywords. +Be careful when composing these regular expressions; a poorly written +pattern can dramatically slow things down! The function +@code{regexp-opt} (@pxref{Regexp Functions}) is useful for calculating +optimal regular expressions to match several keywords. @item @var{function} Find text by calling @var{function}, and highlight the matches @@ -2740,7 +2739,7 @@ @code{c-font-lock-extra-types}, @code{c++-font-lock-extra-types}, and @code{java-font-lock-extra-types}, for example. -@strong{Warning:} major mode commands must not call +@strong{Warning:} Major mode commands must not call @code{font-lock-add-keywords} under any circumstances, either directly or indirectly, except through their mode hooks. (Doing so would lead to incorrect behavior for some minor modes.) They should set up their @@ -2756,7 +2755,10 @@ @code{font-lock-add-keywords} apply here too. @end defun - For example, this code + For example, the following code adds two fontification patterns for C +mode: one to fontify the word @samp{FIXME}, even in comments, and +another to fontify the words @samp{and}, @samp{or} and @samp{not} as +keywords. @smallexample (font-lock-add-keywords 'c-mode @@ -2765,13 +2767,8 @@ @end smallexample @noindent -adds two fontification patterns for C mode: one to fontify the word -@samp{FIXME}, even in comments, and another to fontify the words -@samp{and}, @samp{or} and @samp{not} as keywords. - -@noindent -That example affects only C mode proper. To add the same patterns to -C mode @emph{and} all modes derived from it, do this instead: +This example affects only C mode proper. To add the same patterns to C +mode @emph{and} all modes derived from it, do this instead: @smallexample (add-hook 'c-mode-hook @@ -2858,13 +2855,13 @@ @node Levels of Font Lock @subsection Levels of Font Lock - Many major modes offer three different levels of fontification. You + Some major modes offer three different levels of fontification. You can define multiple levels by using a list of symbols for @var{keywords} in @code{font-lock-defaults}. Each symbol specifies one level of fontification; it is up to the user to choose one of these levels, normally by setting @code{font-lock-maximum-decoration} (@pxref{Font -Lock,,, emacs, the GNU Emacs Manual}). The chosen level's symbol -value is used to initialize @code{font-lock-keywords}. +Lock,,, emacs, the GNU Emacs Manual}). The chosen level's symbol value +is used to initialize @code{font-lock-keywords}. Here are the conventions for how to define the levels of fontification: @@ -2912,10 +2909,10 @@ @cindex font lock faces Font Lock mode can highlight using any face, but Emacs defines several -faces specifically for syntactic highlighting. These @dfn{Font Lock -faces} are listed below. They can also be used by major modes for -syntactic highlighting outside of Font Lock mode (@pxref{Major Mode -Conventions}). +faces specifically for Font Lock to use to highlight text. These +@dfn{Font Lock faces} are listed below. They can also be used by major +modes for syntactic highlighting outside of Font Lock mode (@pxref{Major +Mode Conventions}). Each of these symbols is both a face name, and a variable whose default value is the symbol itself. Thus, the default value of @@ -2990,128 +2987,60 @@ @subsection Syntactic Font Lock @cindex syntactic font lock -Syntactic fontification uses the syntax table to find comments and -string constants (@pxref{Syntax Tables}). It highlights them using -@code{font-lock-comment-face} and @code{font-lock-string-face} -(@pxref{Faces for Font Lock}), or whatever -@code{font-lock-syntactic-face-function} chooses. There are several -variables that affect syntactic fontification; you should set them by -means of @code{font-lock-defaults} (@pxref{Font Lock Basics}). +Syntactic fontification uses a syntax table (@pxref{Syntax Tables}) to +find and highlight syntactically relevant text. If enabled, it runs +prior to search-based fontification. The variable +@code{font-lock-syntactic-face-function}, documented below, determines +which syntactic constructs to highlight. There are several variables +that affect syntactic fontification; you should set them by means of +@code{font-lock-defaults} (@pxref{Font Lock Basics}). @defvar font-lock-keywords-only -Non-@code{nil} means Font Lock should not do syntactic fontification; -it should only fontify based on @code{font-lock-keywords}. The normal -way for a mode to set this variable to @code{t} is with -@var{keywords-only} in @code{font-lock-defaults}. +If the value of this variable is non-@code{nil}, Font Lock does not do +syntactic fontification, only search-based fontification based on +@code{font-lock-keywords}. It is normally set by Font Lock mode based +on the @var{keywords-only} element in @code{font-lock-defaults}. @end defvar @defvar font-lock-syntax-table This variable holds the syntax table to use for fontification of -comments and strings. Specify it using @var{syntax-alist} in -@code{font-lock-defaults}. If this is @code{nil}, fontification uses -the buffer's syntax table. +comments and strings. It is normally set by Font Lock mode based on the +@var{syntax-alist} element in @code{font-lock-defaults}. If this value +is @code{nil}, syntactic fontification uses the buffer's syntax table +(the value returned by the function @code{syntax-table}; @pxref{Syntax +Table Functions}). @end defvar @defvar font-lock-beginning-of-syntax-function If this variable is non-@code{nil}, it should be a function to move point back to a position that is syntactically at ``top level'' and -outside of strings or comments. Font Lock uses this when necessary -to get the right results for syntactic fontification. - -This function is called with no arguments. It should leave point at -the beginning of any enclosing syntactic block. Typical values are -@code{beginning-of-line} (used when the start of the line is known to -be outside a syntactic block), or @code{beginning-of-defun} for +outside of strings or comments. The value is normally set through an +@var{other-vars} element in @code{font-lock-defaults}. If it is +@code{nil}, Font Lock uses @code{syntax-begin-function} to move back +outside of any comment, string, or sexp (@pxref{Position Parse}). + +This variable is semi-obsolete; we usually recommend setting +@code{syntax-begin-function} instead. One of its uses is to tune the +behavior of syntactic fontification, e.g.@: to ensure that different +kinds of strings or comments are highlighted differently. + +The specified function is called with no arguments. It should leave +point at the beginning of any enclosing syntactic block. Typical values +are @code{beginning-of-line} (used when the start of the line is known +to be outside a syntactic block), or @code{beginning-of-defun} for programming modes, or @code{backward-paragraph} for textual modes. - -If the value is @code{nil}, Font Lock uses -@code{syntax-begin-function} to move back outside of any comment, -string, or sexp. This variable is semi-obsolete; we recommend setting -@code{syntax-begin-function} instead. - -Specify this variable using @var{syntax-begin} in -@code{font-lock-defaults}. @end defvar @defvar font-lock-syntactic-face-function -A function to determine which face to use for a given syntactic -element (a string or a comment). The function is called with one -argument, the parse state at point returned by -@code{parse-partial-sexp}, and should return a face. The default -value returns @code{font-lock-comment-face} for comments and -@code{font-lock-string-face} for strings. - -This can be used to highlighting different kinds of strings or -comments differently. It is also sometimes abused together with -@code{font-lock-syntactic-keywords} to highlight constructs that span -multiple lines, but this is too esoteric to document here. - -Specify this variable using @var{other-vars} in -@code{font-lock-defaults}. -@end defvar - -@node Setting Syntax Properties -@subsection Setting Syntax Properties - - Font Lock mode can be used to update @code{syntax-table} properties -automatically (@pxref{Syntax Properties}). This is useful in -languages for which a single syntax table by itself is not sufficient. - -@defvar font-lock-syntactic-keywords -This variable enables and controls updating @code{syntax-table} -properties by Font Lock. Its value should be a list of elements of -this form: - -@example -(@var{matcher} @var{subexp} @var{syntax} @var{override} @var{laxmatch}) -@end example - -The parts of this element have the same meanings as in the corresponding -sort of element of @code{font-lock-keywords}, - -@example -(@var{matcher} @var{subexp} @var{facespec} @var{override} @var{laxmatch}) -@end example - -However, instead of specifying the value @var{facespec} to use for the -@code{face} property, it specifies the value @var{syntax} to use for -the @code{syntax-table} property. Here, @var{syntax} can be a string -(as taken by @code{modify-syntax-entry}), a syntax table, a cons cell -(as returned by @code{string-to-syntax}), or an expression whose value -is one of those two types. @var{override} cannot be @code{prepend} or -@code{append}. - -For example, an element of the form: - -@example -("\\$\\(#\\)" 1 ".") -@end example - -highlights syntactically a hash character when following a dollar -character, with a SYNTAX of @code{"."} (meaning punctuation syntax). -Assuming that the buffer syntax table specifies hash characters to -have comment start syntax, the element will only highlight hash -characters that do not follow dollar characters as comments -syntactically. - -An element of the form: - -@example - ("\\('\\).\\('\\)" - (1 "\"") - (2 "\"")) -@end example - -highlights syntactically both single quotes which surround a single -character, with a SYNTAX of @code{"\""} (meaning string quote syntax). -Assuming that the buffer syntax table does not specify single quotes -to have quote syntax, the element will only highlight single quotes of -the form @samp{'@var{c}'} as strings syntactically. Other forms, such -as @samp{foo'bar} or @samp{'fubar'}, will not be highlighted as -strings. - -Major modes normally set this variable with @var{other-vars} in -@code{font-lock-defaults}. +If this variable is non-@code{nil}, it should be a function to determine +which face to use for a given syntactic element (a string or a comment). +The value is normally set through an @var{other-vars} element in +@code{font-lock-defaults}. + +The function is called with one argument, the parse state at point +returned by @code{parse-partial-sexp}, and should return a face. The +default value returns @code{font-lock-comment-face} for comments and +@code{font-lock-string-face} for strings (@pxref{Faces for Font Lock}). @end defvar @node Multiline Font Lock @@ -3220,18 +3149,17 @@ The @code{font-lock-multiline} property is meant to ensure proper refontification; it does not automatically identify new multiline -constructs. Identifying the requires that Font-Lock operate on large -enough chunks at a time. This will happen by accident on many cases, -which may give the impression that multiline constructs magically work. -If you set the @code{font-lock-multiline} variable non-@code{nil}, -this impression will be even stronger, since the highlighting of those -constructs which are found will be properly updated from then on. -But that does not work reliably. +constructs. Identifying the requires that Font Lock mode operate on +large enough chunks at a time. This will happen by accident on many +cases, which may give the impression that multiline constructs magically +work. If you set the @code{font-lock-multiline} variable +non-@code{nil}, this impression will be even stronger, since the +highlighting of those constructs which are found will be properly +updated from then on. But that does not work reliably. - To find multiline constructs reliably, you must either manually -place the @code{font-lock-multiline} property on the text before -Font-Lock looks at it, or use -@code{font-lock-fontify-region-function}. + To find multiline constructs reliably, you must either manually place +the @code{font-lock-multiline} property on the text before Font Lock +mode looks at it, or use @code{font-lock-fontify-region-function}. @node Region to Refontify @subsubsection Region to Fontify after a Buffer Change @@ -3246,8 +3174,8 @@ the following variable: @defvar font-lock-extend-after-change-region-function -This buffer-local variable is either @code{nil} or a function for -Font-Lock to call to determine the region to scan and fontify. +This buffer-local variable is either @code{nil} or a function for Font +Lock mode to call to determine the region to scan and fontify. The function is given three parameters, the standard @var{beg}, @var{end}, and @var{old-len} from @code{after-change-functions} === modified file 'doc/lispref/syntax.texi' --- doc/lispref/syntax.texi 2012-01-31 06:51:33 +0000 +++ doc/lispref/syntax.texi 2012-02-16 06:04:38 +0000 @@ -536,9 +536,7 @@ When the syntax table is not flexible enough to specify the syntax of a language, you can use @code{syntax-table} text properties to override the syntax table for specific character occurrences in the -buffer. @xref{Text Properties}. You can use Font Lock mode to set -@code{syntax-table} text properties. @xref{Setting Syntax -Properties}. +buffer. @xref{Text Properties}. The valid values of @code{syntax-table} text property are: === modified file 'doc/lispref/vol1.texi' --- doc/lispref/vol1.texi 2012-02-15 13:45:02 +0000 +++ doc/lispref/vol1.texi 2012-02-16 06:04:38 +0000 @@ -835,8 +835,6 @@ contents can also specify how to fontify it. * Faces for Font Lock:: Special faces specifically for Font Lock. * Syntactic Font Lock:: Fontification based on syntax tables. -* Setting Syntax Properties:: Defining character syntax based on context - using the Font Lock mechanism. * Multiline Font Lock:: How to coerce Font Lock into properly highlighting multiline constructs. === modified file 'doc/lispref/vol2.texi' --- doc/lispref/vol2.texi 2012-02-15 13:45:02 +0000 +++ doc/lispref/vol2.texi 2012-02-16 06:04:38 +0000 @@ -834,8 +834,6 @@ contents can also specify how to fontify it. * Faces for Font Lock:: Special faces specifically for Font Lock. * Syntactic Font Lock:: Fontification based on syntax tables. -* Setting Syntax Properties:: Defining character syntax based on context - using the Font Lock mechanism. * Multiline Font Lock:: How to coerce Font Lock into properly highlighting multiline constructs. ------------------------------------------------------------ revno: 107296 committer: Chong Yidong branch nick: trunk timestamp: Wed 2012-02-15 21:45:02 +0800 message: Docstring and manual updates for completion-at-point-functions. * doc/lispref/minibuf.texi (Basic Completion): Define "completion table". Move completion-in-region to Completion in Buffers node. (Completion Commands): Use "completion table" terminology. (Completion in Buffers): New node. * doc/lispref/modes.texi (Hooks): add-hook can be used for abnormal hooks too. (Setting Hooks): Update minor mode usage example. (Major Mode Conventions): Note that completion-at-point-functions should be altered locally. Add xref to Completion in Buffers. * lisp/minibuffer.el (completion-at-point-functions): Doc fix. diff: === modified file 'doc/lispref/ChangeLog' --- doc/lispref/ChangeLog 2012-02-15 08:48:45 +0000 +++ doc/lispref/ChangeLog 2012-02-15 13:45:02 +0000 @@ -1,3 +1,15 @@ +2012-02-15 Chong Yidong + + * minibuf.texi (Basic Completion): Define "completion table". + Move completion-in-region to Completion in Buffers node. + (Completion Commands): Use "completion table" terminology. + (Completion in Buffers): New node. + + * modes.texi (Hooks): add-hook can be used for abnormal hooks too. + (Setting Hooks): Update minor mode usage example. + (Major Mode Conventions): Note that completion-at-point-functions + should be altered locally. Add xref to Completion in Buffers. + 2012-02-15 Glenn Morris * processes.texi (Network): Document open-network-stream :parameters. === modified file 'doc/lispref/elisp.texi' --- doc/lispref/elisp.texi 2012-02-11 06:17:22 +0000 +++ doc/lispref/elisp.texi 2012-02-15 13:45:02 +0000 @@ -654,6 +654,7 @@ shell commands. * Completion Styles:: Specifying rules for performing completion. * Programmed Completion:: Writing your own completion-function. +* Completion in Buffers:: Completing text in ordinary buffers. Command Loop === modified file 'doc/lispref/minibuf.texi' --- doc/lispref/minibuf.texi 2012-02-04 01:23:09 +0000 +++ doc/lispref/minibuf.texi 2012-02-15 13:45:02 +0000 @@ -633,6 +633,7 @@ shell commands. * Completion Styles:: Specifying rules for performing completion. * Programmed Completion:: Writing your own completion-function. +* Completion in Buffers:: Completing text in ordinary buffers. @end menu @node Basic Completion @@ -644,10 +645,12 @@ @defun try-completion string collection &optional predicate This function returns the longest common substring of all possible -completions of @var{string} in @var{collection}. The value of -@var{collection} must be a list of strings, an alist whose keys are -strings or symbols, an obarray, a hash table, or a completion function -(@pxref{Programmed Completion}). +completions of @var{string} in @var{collection}. + +@cindex completion table +The @var{collection} argument is called the @dfn{completion table}. +Its value must be a list of strings, an alist whose keys are strings +or symbols, an obarray, a hash table, or a completion function. Completion compares @var{string} against each of the permissible completions specified by @var{collection}. If no permissible @@ -678,13 +681,13 @@ If @var{collection} is a hash table, then the keys that are strings are the possible completions. Other keys are ignored. -You can also use a function as @var{collection}. -Then the function is solely responsible for performing completion; -@code{try-completion} returns whatever this function returns. The -function is called with three arguments: @var{string}, @var{predicate} -and @code{nil} (the reason for the third argument is so that the same -function can be used in @code{all-completions} and do the appropriate -thing in either case). @xref{Programmed Completion}. +You can also use a function as @var{collection}. Then the function is +solely responsible for performing completion; @code{try-completion} +returns whatever this function returns. The function is called with +three arguments: @var{string}, @var{predicate} and @code{nil} (the +reason for the third argument is so that the same function can be used +in @code{all-completions} and do the appropriate thing in either +case). @xref{Programmed Completion}. If the argument @var{predicate} is non-@code{nil}, then it must be a function of one argument, unless @var{collection} is a hash table, in @@ -862,30 +865,13 @@ It is done by calling @var{fun} with no arguments. The value @var{fun} returns becomes the permanent value of @var{var}. -Here is an example of use: +Here is a usage example: @smallexample (defvar foo (lazy-completion-table foo make-my-alist)) @end smallexample @end defmac -The function @code{completion-in-region} provides a convenient way to -perform completion on an arbitrary stretch of text in an Emacs buffer: - -@defun completion-in-region start end collection &optional predicate -This function completes the text in the current buffer between the -positions @var{start} and @var{end}, using @var{collection}. The -argument @var{collection} has the same meaning as in -@code{try-completion} (@pxref{Basic Completion}). - -This function inserts the completion text directly into the current -buffer. Unlike @code{completing-read} (@pxref{Minibuffer -Completion}), it does not activate the minibuffer. - -For this function to work, point must be somewhere between @var{start} -and @var{end}. -@end defun - @node Minibuffer Completion @subsection Completion and the Minibuffer @cindex minibuffer completion @@ -899,13 +885,14 @@ providing completion. It activates the minibuffer with prompt @var{prompt}, which must be a string. -The actual completion is done by passing @var{collection} and -@var{predicate} to the function @code{try-completion} (@pxref{Basic -Completion}). This happens in certain commands bound in the local -keymaps used for completion. Some of these commands also call -@code{test-completion}. Thus, if @var{predicate} is non-@code{nil}, -it should be compatible with @var{collection} and -@code{completion-ignore-case}. @xref{Definition of test-completion}. +The actual completion is done by passing the completion table +@var{collection} and the completion predicate @var{predicate} to the +function @code{try-completion} (@pxref{Basic Completion}). This +happens in certain commands bound in the local keymaps used for +completion. Some of these commands also call @code{test-completion}. +Thus, if @var{predicate} is non-@code{nil}, it should be compatible +with @var{collection} and @code{completion-ignore-case}. +@xref{Definition of test-completion}. The value of the optional argument @var{require-match} determines how the user may exit the minibuffer: @@ -1005,10 +992,11 @@ in the minibuffer to do completion. @defvar minibuffer-completion-table -The value of this variable is the collection used for completion in -the minibuffer. This is the global variable that contains what +The value of this variable is the completion table used for completion +in the minibuffer. This is the global variable that contains what @code{completing-read} passes to @code{try-completion}. It is used by -minibuffer completion commands such as @code{minibuffer-complete-word}. +minibuffer completion commands such as +@code{minibuffer-complete-word}. @end defvar @defvar minibuffer-completion-predicate @@ -1717,6 +1705,87 @@ (@pxref{Completion Commands}). @end defvar +@node Completion in Buffers +@subsection Completion in Ordinary Buffers +@cindex inline completion + +@findex completion-at-point + Although completion is usually done in the minibuffer, the +completion facility can also be used on the text in ordinary Emacs +buffers. In many major modes, in-buffer completion is performed by +the @kbd{C-M-i} or @kbd{M-@key{TAB}} command, bound to +@code{completion-at-point}. @xref{Symbol Completion,,, emacs, The GNU +Emacs Manual}. This command uses the abnormal hook variable +@code{completion-at-point-functions}: + +@defvar completion-at-point-functions +The value of this abnormal hook should be a list of functions, which +are used to compute a completion table for completing the text at +point. It can be used by major modes to provide mode-specific +completion tables (@pxref{Major Mode Conventions}). + +When the command @code{completion-at-point} runs, it calls the +functions in the list one by one, without any argument. Each function +should return @code{nil} if it is unable to produce a completion table +for the text at point. Otherwise it should return a list of the form + +@example +(@var{start} @var{end} @var{collection} . @var{props}) +@end example + +@noindent +@var{start} and @var{end} delimit the text to complete (which should +enclose point). @var{collection} is a completion table for completing +that text, in a form suitable for passing as the second argument to +@code{try-completion} (@pxref{Basic Completion}); completion +alternatives will be generated from this completion table in the usual +way, via the completion styles defined in @code{completion-styles} +(@pxref{Completion Styles}). @var{props} is a property list for +additional information; the following optional properties are +recognized: + +@table @code +@item :predicate +The value should be a predicate that completion candidates need to +satisfy. + +@item :exclusive +If the value is @code{no}, then if the completion table fails to match +the text at point, then @code{completion-at-point} moves on to the +next function in @code{completion-at-point-functions} instead of +reporting a completion failure. +@end table + +A function in @code{completion-at-point-functions} may also return a +function. In that case, that returned function is called, with no +argument, and it is entirely responsible for performing the +completion. We discourage this usage; it is intended to help convert +old code to using @code{completion-at-point}. + +The first function in @code{completion-at-point-functions} to return a +non-@code{nil} value is used by @code{completion-at-point}. The +remaining functions are not called. The exception to this is when +there is a @code{:exclusive} specification, as described above. +@end defvar + + The following function provides a convenient way to perform +completion on an arbitrary stretch of text in an Emacs buffer: + +@defun completion-in-region start end collection &optional predicate +This function completes the text in the current buffer between the +positions @var{start} and @var{end}, using @var{collection}. The +argument @var{collection} has the same meaning as in +@code{try-completion} (@pxref{Basic Completion}). + +This function inserts the completion text directly into the current +buffer. Unlike @code{completing-read} (@pxref{Minibuffer +Completion}), it does not activate the minibuffer. + +For this function to work, point must be somewhere between @var{start} +and @var{end}. +@end defun + + @node Yes-or-No Queries @section Yes-or-No Queries @cindex asking the user questions === modified file 'doc/lispref/modes.texi' --- doc/lispref/modes.texi 2012-02-10 02:33:01 +0000 +++ doc/lispref/modes.texi 2012-02-15 13:45:02 +0000 @@ -48,17 +48,16 @@ possible, so that you can use them in a uniform way. Every major mode command is supposed to run a normal hook called the -@dfn{mode hook} as the one of the last steps of initialization. This -makes it easy for a user to customize the behavior of the mode, by -overriding the buffer-local variable assignments already made by the -mode. Most minor mode functions also run a mode hook at the end. But -hooks are used in other contexts too. For example, the hook -@code{suspend-hook} runs just before Emacs suspends itself -(@pxref{Suspending Emacs}). +@dfn{mode hook} as one of the last steps of initialization. This makes +it easy for a user to customize the behavior of the mode, by overriding +the buffer-local variable assignments already made by the mode. Most +minor mode functions also run a mode hook at the end. But hooks are +used in other contexts too. For example, the hook @code{suspend-hook} +runs just before Emacs suspends itself (@pxref{Suspending Emacs}). - The recommended way to add a hook function to a normal hook is by -calling @code{add-hook} (see below). The hook functions may be any of -the valid kinds of functions that @code{funcall} accepts (@pxref{What + The recommended way to add a hook function to a hook is by calling +@code{add-hook} (@pxref{Setting Hooks}). The hook functions may be any +of the valid kinds of functions that @code{funcall} accepts (@pxref{What Is a Function}). Most normal hook variables are initially void; @code{add-hook} knows how to deal with this. You can add hooks either globally or buffer-locally with @code{add-hook}. @@ -178,7 +177,7 @@ in Lisp Interaction mode: @example -(add-hook 'lisp-interaction-mode-hook 'turn-on-auto-fill) +(add-hook 'lisp-interaction-mode-hook 'auto-fill-mode) @end example @defun add-hook hook function &optional append local @@ -202,13 +201,13 @@ changing major modes) won't delete it from the hook variable's local value. -It is best to design your hook functions so that the order in which -they are executed does not matter. Any dependence on the order is -asking for trouble. However, the order is predictable: normally, -@var{function} goes at the front of the hook list, so it will be -executed first (barring another @code{add-hook} call). If the -optional argument @var{append} is non-@code{nil}, the new hook -function goes at the end of the hook list and will be executed last. +For a normal hook, hook functions should be designed so that the order +in which they are executed does not matter. Any dependence on the order +is asking for trouble. However, the order is predictable: normally, +@var{function} goes at the front of the hook list, so it is executed +first (barring another @code{add-hook} call). If the optional argument +@var{append} is non-@code{nil}, the new hook function goes at the end of +the hook list and is executed last. @code{add-hook} can handle the cases where @var{hook} is void or its value is a single function; it sets or changes the value to a list of @@ -302,8 +301,8 @@ If you use the @code{define-derived-mode} macro, it will take care of many of these conventions automatically. @xref{Derived Modes}. Note -also that fundamental mode is an exception to many of these conventions, -because its definition is to present the global state of Emacs. +also that Fundamental mode is an exception to many of these conventions, +because it represents the default state of Emacs. The following list of conventions is only partial. Each major mode should aim for consistency in general with other Emacs major modes, as @@ -460,8 +459,9 @@ this mode. @item -The mode can specify how to complete various keywords by adding -to the special hook @code{completion-at-point-functions}. +The mode can specify how to complete various keywords by adding one or +more buffer-local entries to the special hook +@code{completion-at-point-functions}. @xref{Completion in Buffers}. @item Use @code{defvar} or @code{defcustom} to set mode-related variables, so @@ -555,16 +555,15 @@ @cindex mode loading The top-level forms in the file defining the mode should be written so that they may be evaluated more than once without adverse consequences. -Even if you never load the file more than once, someone else will. @end itemize @node Auto Major Mode @subsection How Emacs Chooses a Major Mode @cindex major mode, automatic selection - Based on information in the file name or in the file itself, Emacs -automatically selects a major mode for the new buffer when a file is -visited. It also processes local variables specified in the file text. + When Emacs visits a file, it automatically selects a major mode for +the buffer based on information in the file name or in the file itself. +It also processes local variables specified in the file text. @deffn Command normal-mode &optional find-file This function establishes the proper major mode and buffer-local variable === modified file 'doc/lispref/vol1.texi' --- doc/lispref/vol1.texi 2012-02-11 06:17:22 +0000 +++ doc/lispref/vol1.texi 2012-02-15 13:45:02 +0000 @@ -675,6 +675,7 @@ shell commands. * Completion Styles:: Specifying rules for performing completion. * Programmed Completion:: Writing your own completion-function. +* Completion in Buffers:: Completing text in ordinary buffers. Command Loop === modified file 'doc/lispref/vol2.texi' --- doc/lispref/vol2.texi 2012-02-11 06:17:22 +0000 +++ doc/lispref/vol2.texi 2012-02-15 13:45:02 +0000 @@ -674,6 +674,7 @@ shell commands. * Completion Styles:: Specifying rules for performing completion. * Programmed Completion:: Writing your own completion-function. +* Completion in Buffers:: Completing text in ordinary buffers. Command Loop === modified file 'lisp/ChangeLog' --- lisp/ChangeLog 2012-02-15 08:00:23 +0000 +++ lisp/ChangeLog 2012-02-15 13:45:02 +0000 @@ -5,6 +5,8 @@ 2012-02-15 Chong Yidong + * minibuffer.el (completion-at-point-functions): Doc fix. + * custom.el (defcustom): Doc fix; note use of defvar. 2012-02-15 Glenn Morris === modified file 'lisp/minibuffer.el' --- lisp/minibuffer.el 2012-02-13 22:49:16 +0000 +++ lisp/minibuffer.el 2012-02-15 13:45:02 +0000 @@ -1550,16 +1550,16 @@ Each function on this hook is called in turns without any argument and should return either nil to mean that it is not applicable at point, or a function of no argument to perform completion (discouraged), -or a list of the form (START END COLLECTION &rest PROPS) where +or a list of the form (START END COLLECTION . PROPS) where START and END delimit the entity to complete and should include point, COLLECTION is the completion table to use to complete it, and PROPS is a property list for additional information. Currently supported properties are all the properties that can appear in `completion-extra-properties' plus: `:predicate' a predicate that completion candidates need to satisfy. - `:exclusive' If `no', means that if the completion data does not match the - text at point failure, then instead of reporting a completion failure, - the completion should try the next completion function.") + `:exclusive' If `no', means that if the completion table fails to + match the text at point, then instead of reporting a completion + failure, the completion should try the next completion function.") (defvar completion--capf-misbehave-funs nil "List of functions found on `completion-at-point-functions' that misbehave. ------------------------------------------------------------ revno: 107295 author: Lars Ingebrigtsen committer: Katsumi Yamaoka branch nick: trunk timestamp: Wed 2012-02-15 09:36:28 +0000 message: shr.el (shr-remove-trailing-whitespace): Really delete the padding on too-wide lines. diff: === modified file 'lisp/gnus/ChangeLog' --- lisp/gnus/ChangeLog 2012-02-15 06:40:08 +0000 +++ lisp/gnus/ChangeLog 2012-02-15 09:36:28 +0000 @@ -1,3 +1,8 @@ +2012-02-15 Lars Ingebrigtsen + + * shr.el (shr-remove-trailing-whitespace): Really delete the padding on + too-wide lines. + 2012-02-15 Paul Eggert * shr.el (shr-rescale-image): Undo previous change; see === modified file 'lisp/gnus/shr.el' --- lisp/gnus/shr.el 2012-02-15 06:40:08 +0000 +++ lisp/gnus/shr.el 2012-02-15 09:36:28 +0000 @@ -160,7 +160,7 @@ (goto-char start) (while (not (eobp)) (end-of-line) - (when (> (current-column) width) + (when (> (shr-previous-newline-padding-width (current-column)) width) (dolist (overlay (overlays-at (point))) (when (overlay-get overlay 'before-string) (overlay-put overlay 'before-string nil)))) ------------------------------------------------------------ revno: 107294 committer: Glenn Morris branch nick: trunk timestamp: Wed 2012-02-15 00:50:38 -0800 message: Add some more cindex entries to previous change diff: === modified file 'doc/lispref/processes.texi' --- doc/lispref/processes.texi 2012-02-15 08:48:45 +0000 +++ doc/lispref/processes.texi 2012-02-15 08:50:38 +0000 @@ -1939,7 +1939,10 @@ @code{process-command} to determine whether a network connection or server is stopped; a non-@code{nil} value means yes. +@cindex network connection, encrypted @cindex encrypted network connections +@cindex TLS network connections +@cindex STARTTLS network connections @defun open-network-stream name buffer-or-name host service &rest parameters This function opens a TCP connection, with optional encryption, and returns a process object that represents the connection. ------------------------------------------------------------ revno: 107293 committer: Glenn Morris branch nick: trunk timestamp: Wed 2012-02-15 00:48:45 -0800 message: * lispref/processes.texi (Network): Document open-network-stream :parameters. * etc/NEWS: Related markup. diff: === modified file 'doc/lispref/ChangeLog' --- doc/lispref/ChangeLog 2012-02-14 16:41:16 +0000 +++ doc/lispref/ChangeLog 2012-02-15 08:48:45 +0000 @@ -1,3 +1,7 @@ +2012-02-15 Glenn Morris + + * processes.texi (Network): Document open-network-stream :parameters. + 2012-02-14 Chong Yidong * keymaps.texi (Format of Keymaps): The CACHE component of keymaps === modified file 'doc/lispref/processes.texi' --- doc/lispref/processes.texi 2012-02-02 07:21:20 +0000 +++ doc/lispref/processes.texi 2012-02-15 08:48:45 +0000 @@ -1939,9 +1939,10 @@ @code{process-command} to determine whether a network connection or server is stopped; a non-@code{nil} value means yes. -@defun open-network-stream name buffer-or-name host service -This function opens a TCP connection, and returns a process object -that represents the connection. +@cindex encrypted network connections +@defun open-network-stream name buffer-or-name host service &rest parameters +This function opens a TCP connection, with optional encryption, and +returns a process object that represents the connection. The @var{name} argument specifies the name for the process object. It is modified as necessary to make it unique. @@ -1955,6 +1956,83 @@ The arguments @var{host} and @var{service} specify where to connect to; @var{host} is the host name (a string), and @var{service} is the name of a defined network service (a string) or a port number (an integer). + +@c FIXME? Is this too lengthy for the printed manual? +The remaining arguments @var{parameters} are keyword/argument pairs +that are mainly relevant to encrypted connections: + +@table @code + +@item :nowait @var{boolean} +If non-@code{nil}, try to make an asynchronous connection. + +@item :type @var{type} +The type of connection. Options are: + +@table @code +@item plain +An ordinary, unencrypted connection. +@item tls +@itemx ssl +A TLS (``Transport Layer Security'') connection. +@item nil +@itemx network +Start with a plain connection, and if parameters @samp{:success} +and @samp{:capability-command} are supplied, try to upgrade to an encrypted +connection via STARTTLS. If that fails, retain the unencrypted connection. +@item starttls +As for @code{nil}, but if STARTTLS fails drop the connection. +@item shell +A shell connection. +@end table + +@item :always-query-capabilities @var{boolean} +If non-@code{nil}, always ask for the server's capabilities, even when +doing a @samp{plain} connection. + +@item :capability-command @var{capability-command} +Command string to query the host capabilities. + +@item :end-of-command @var{regexp} +@itemx :end-of-capability @var{regexp} +Regular expression matching the end of a command, or the end of the +command @var{capability-command}. The latter defaults to the former. + +@item :starttls-function @var{function} +Function of one argument (the response to @var{capability-command}), +which returns either @code{nil}, or the command to activate STARTTLS +if supported. + +@item :success @var{regexp} +Regular expression matching a successful STARTTLS negotiation. + +@item :use-starttls-if-possible @var{boolean} +If non-@code{nil}, do opportunistic STARTTLS upgrades even if Emacs +doesn't have built-in TLS support. + +@item :client-certificate @var{list-or-t} +Either a list of the form @code{(@var{key-file} @var{cert-file})}, +naming the certificate key file and certificate file itself, or +@code{t}, meaning to query @code{auth-source} for this information +(@pxref{Top,,auth-source, auth, Emacs auth-source Library}). +Only used for TLS or STARTTLS. + +@item :return-list @var{cons-or-nil} +The return value of this function. If omitted or @code{nil}, return a +process object. Otherwise, a cons of the form @code{(@var{process-object} +. @var{plist})}, where @var{plist} has keywords: + +@table @code +@item :greeting @var{string-or-nil} +If non-@code{nil}, the greeting string returned by the host. +@item :capabilities @var{string-or-nil} +If non-@code{nil}, the host's capability string. +@item :type @var{symbol} +The connection type: @samp{plain} or @samp{tls}. +@end table + +@end table + @end defun @node Network Servers === modified file 'etc/NEWS' --- etc/NEWS 2012-02-15 07:55:18 +0000 +++ etc/NEWS 2012-02-15 08:48:45 +0000 @@ -1289,6 +1289,7 @@ ** `glyphless-char-display' can now distinguish between graphical and text terminal display, via a char-table entry that is a cons cell. ++++ ** `open-network-stream' can now be used to open an encrypted stream. It now accepts an optional `:type' parameter for initiating a TLS connection, directly or via STARTTLS. To do STARTTLS, additional ------------------------------------------------------------ revno: 107292 committer: Glenn Morris branch nick: trunk timestamp: Wed 2012-02-15 00:00:23 -0800 message: * lisp/shell.el (shell-delimiter-argument-list): Revert 2011-02-17 change. diff: === modified file 'lisp/ChangeLog' --- lisp/ChangeLog 2012-02-15 04:00:34 +0000 +++ lisp/ChangeLog 2012-02-15 08:00:23 +0000 @@ -1,3 +1,8 @@ +2012-02-15 Glenn Morris + + * shell.el (shell-delimiter-argument-list): + Revert 2011-02-17 change. (Bug#8027) + 2012-02-15 Chong Yidong * custom.el (defcustom): Doc fix; note use of defvar. === modified file 'lisp/shell.el' --- lisp/shell.el 2012-01-19 07:21:25 +0000 +++ lisp/shell.el 2012-02-15 08:00:23 +0000 @@ -153,13 +153,14 @@ :type '(repeat (string :tag "Suffix")) :group 'shell) -(defcustom shell-delimiter-argument-list nil ; '(?\| ?& ?< ?> ?\( ?\) ?\;) +(defcustom shell-delimiter-argument-list '(?\| ?& ?< ?> ?\( ?\) ?\;) "List of characters to recognize as separate arguments. This variable is used to initialize `comint-delimiter-argument-list' in the shell buffer. The value may depend on the operating system or shell." :type '(choice (const nil) (repeat :tag "List of characters" character)) - :version "24.1" ; changed to nil (bug#8027) + ;; Reverted. +;; :version "24.1" ; changed to nil (bug#8027) :group 'shell) (defvar shell-file-name-chars ------------------------------------------------------------ revno: 107291 committer: Glenn Morris branch nick: trunk timestamp: Tue 2012-02-14 23:55:18 -0800 message: NEWS update re finder-inf changes diff: === modified file 'etc/NEWS' --- etc/NEWS 2012-02-15 03:15:26 +0000 +++ etc/NEWS 2012-02-15 07:55:18 +0000 @@ -1111,7 +1111,10 @@ ** The following obsolete files were removed: sc.el, x-menu.el, rnews.el, rnewspost.el -** FIXME finder-inf.el changes. +--- +** The format of the finder-inf.el file has changed, since the finder +mechanism is now based on the package concept. The variable +finder-package-info is replaced by package--builtins and finder-keywords-hash. * Lisp changes in Emacs 24.1