annotate man/xemacs/major.texi @ 5353:38e24b8be4ea

Improve the lexical scoping in #'block, #'return-from. lisp/ChangeLog addition: 2011-02-07 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el: * bytecomp.el (byte-compile-initial-macro-environment): Shadow `block', `return-from' here, we implement them differently when byte-compiling. * bytecomp.el (byte-compile-active-blocks): New. * bytecomp.el (byte-compile-block-1): New. * bytecomp.el (byte-compile-return-from-1): New. * bytecomp.el (return-from-1): New. * bytecomp.el (block-1): New. These are two aliases that exist to have their own associated byte-compile functions, which functions implement `block' and `return-from'. * cl-extra.el (cl-macroexpand-all): Fix a bug here when macros in the environment have been compiled. * cl-macs.el (block): * cl-macs.el (return): * cl-macs.el (return-from): Be more careful about lexical scope in these macros. * cl.el: * cl.el ('cl-block-wrapper): Removed. * cl.el ('cl-block-throw): Removed. These aren't needed in code generated by this XEmacs. They shouldn't be needed in code generated by XEmacs 21.4, but if it turns out the packages do need them, we can put them back. 2011-01-30 Mike Sperber <mike@xemacs.org> * font-lock.el (font-lock-fontify-pending-extents): Don't fail if `font-lock-mode' is unset, which can happen in the middle of `revert-buffer'. 2011-01-23 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (delete): * cl-macs.el (delq): * cl-macs.el (remove): * cl-macs.el (remq): Don't use the compiler macro if these functions were given the wrong number of arguments, as happens in lisp-tests.el. * cl-seq.el (remove, remq): Removed. I added these to subr.el, and forgot to remove them from here. 2011-01-22 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-setq, byte-compile-set): Remove kludge allowing keywords' values to be set, all the code that does that is gone. * cl-compat.el (elt-satisfies-test-p): * faces.el (set-face-parent): * faces.el (face-doc-string): * gtk-font-menu.el: * gtk-font-menu.el (gtk-reset-device-font-menus): * msw-font-menu.el: * msw-font-menu.el (mswindows-reset-device-font-menus): * package-get.el (package-get-installedp): * select.el (select-convert-from-image-data): * sound.el: * sound.el (load-sound-file): * x-font-menu.el (x-reset-device-font-menus-core): Don't quote keywords, they're self-quoting, and the win from backward-compatibility is sufficiently small now that the style problem overrides it. 2011-01-22 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (block, return-from): Require that NAME be a symbol in these macros, as always documented in the #'block docstring and as required by Common Lisp. * descr-text.el (unidata-initialize-unihan-database): Correct the use of non-symbols in #'block and #'return-from in this function. 2011-01-15 Aidan Kehoe <kehoea@parhasard.net> * cl-extra.el (concatenate): Accept more complicated TYPEs in this function, handing the sequences over to #'coerce if we don't understand them here. * cl-macs.el (inline): Don't proclaim #'concatenate as inline, its compiler macro is more useful than doing that. 2011-01-11 Aidan Kehoe <kehoea@parhasard.net> * subr.el (delete, delq, remove, remq): Move #'remove, #'remq here, they don't belong in cl-seq.el; move #'delete, #'delq here from fns.c, implement them in terms of #'delete*, allowing support for sequences generally. * update-elc.el (do-autoload-commands): Use #'delete*, not #'delq here, now the latter's no longer dumped. * cl-macs.el (delete, delq): Add compiler macros transforming #'delete and #'delq to #'delete* calls. 2011-01-10 Aidan Kehoe <kehoea@parhasard.net> * dialog.el (make-dialog-box): Correct a misplaced parenthesis here, thank you Mats Lidell in 87zkr9gqrh.fsf@mail.contactor.se ! 2011-01-02 Aidan Kehoe <kehoea@parhasard.net> * dialog.el (make-dialog-box): * list-mode.el (display-completion-list): These functions used to use cl-parsing-keywords; change them to use defun* instead, fixing the build. (Not sure what led to me not including this change in d1b17a33450b!) 2011-01-02 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (define-star-compiler-macros): Make sure the form has ITEM and LIST specified before attempting to change to calls with explicit tests; necessary for some tests in lisp-tests.el to compile correctly. (stable-union, stable-intersection): Add compiler macros for these functions, in the same way we do for most of the other functions in cl-seq.el. 2011-01-01 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (dolist, dotimes, do-symbols, macrolet) (symbol-macrolet): Define these macros with defmacro* instead of parsing the argument list by hand, for the sake of style and readability; use backquote where appropriate, instead of calling #'list and and friends, for the same reason. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * x-misc.el (device-x-display): Provide this function, documented in the Lispref for years, but not existing previously. Thank you Julian Bradfield, thank you Jeff Mincy. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * cl-seq.el: Move the heavy lifting from this file to C. Dump the cl-parsing-keywords macro, but don't use defun* for the functions we define that do take keywords, dynamic scope lossage makes that not practical. * subr.el (sort, fillarray): Move these aliases here. (map-plist): #'nsublis is now built-in, but at this point #'eql isn't necessarily available as a test; use #'eq. * obsolete.el (cl-delete-duplicates): Make this available for old compiler macros and old code. (memql): Document that this is equivalent to #'member*, and worse. * cl.el (adjoin, subst): Removed. These are in C. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * simple.el (assoc-ignore-case): Remove a duplicate definition of this function (it's already in subr.el). * iso8859-1.el (char-width): On non-Mule, make this function equivalent to that produced by (constantly 1), but preserve its docstring. * subr.el (subst-char-in-string): Define this in terms of #'substitute, #'nsubstitute. (string-width): Define this using #'reduce and #'char-width. (char-width): Give this a simpler definition, it makes far more sense to check for mule at load time and redefine, as we do in iso8859-1.el. (store-substring): Implement this in terms of #'replace, now #'replace is cheap. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * update-elc.el (lisp-files-needed-for-byte-compilation) (lisp-files-needing-early-byte-compilation): cl-macs belongs in the former, not the latter, it is as fundamental as bytecomp.el. 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * cl.el: Provde the Common Lisp program-error, type-error as error symbols. This doesn't nearly go far enough for anyone using the Common Lisp errors. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (delete-duplicates): If the form has an incorrect number of arguments, don't attempt a compiler macroexpansion. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (cl-safe-expr-p): Forms that start with the symbol lambda are also safe. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (= < > <= >=): For these functions' compiler macros, the optimisation is safe even if the first and the last arguments have side effects, since they're only used the once. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (inline-side-effect-free-compiler-macros): Unroll a loop here at macro-expansion time, so these compiler macros are compiled. Use #'eql instead of #'eq in a couple of places for better style. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * cl-extra.el (notany, notevery): Avoid some dynamic scope stupidity with local variable names in these functions, when they weren't prefixed with cl-; go into some more detail in the doc strings. 2010-12-29 Aidan Kehoe <kehoea@parhasard.net> * byte-optimize.el (side-effect-free-fns): #'remove, #'remq are free of side-effects. (side-effect-and-error-free-fns): Drop dot, dot-marker from the list. 2010-11-17 Aidan Kehoe <kehoea@parhasard.net> * cl-extra.el (coerce): In the argument list, name the first argument OBJECT, not X; the former name was always used in the doc string and is clearer. Handle vector type specifications which include the length of the target sequence, error if there's a mismatch. * cl-macs.el (cl-make-type-test): Handle type specifications starting with the symbol 'eql. 2010-11-14 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (eql): Don't remove the byte-compile property of this symbol. That was necessary to override a bug in bytecomp.el where #'eql was confused with #'eq, which bug we no longer have. If neither expression is constant, don't attempt to handle the expression in this compiler macro, leave it to byte-compile-eql, which produces better code anyway. * bytecomp.el (eq): #'eql is not the function associated with the byte-eq byte code. (byte-compile-eql): Add an explicit compile method for this function, for cases where the cl-macs compiler macro hasn't reduced it to #'eq or #'equal. 2010-10-25 Aidan Kehoe <kehoea@parhasard.net> Add compiler macros and compilation sanity-checking for various functions that take keywords. * byte-optimize.el (side-effect-free-fns): #'symbol-value is side-effect free and not error free. * bytecomp.el (byte-compile-normal-call): Check keyword argument lists for sanity; store information about the positions where keyword arguments start using the new byte-compile-keyword-start property. * cl-macs.el (cl-const-expr-val): Take a new optional argument, cl-not-constant, defaulting to nil, in this function; return it if the expression is not constant. (cl-non-fixnum-number-p): Make this into a separate function, we want to pass it to #'every. (eql): Use it. (define-star-compiler-macros): Use the same code to generate the member*, assoc* and rassoc* compiler macros; special-case some code in #'add-to-list in subr.el. (remove, remq): Add compiler macros for these two functions, in preparation for #'remove being in C. (define-foo-if-compiler-macros): Transform (remove-if-not ...) calls to (remove ... :if-not) at compile time, which will be a real win once the latter is in C. (define-substitute-if-compiler-macros) (define-subst-if-compiler-macros): Similarly for these functions. (delete-duplicates): Change this compiler macro to use #'plists-equal; if we don't have information about the type of SEQUENCE at compile time, don't bother attempting to inline the call, the function will be in C soon enough. (equalp): Remove an old commented-out compiler macro for this, if we want to see it it's in version control. (subst-char-in-string): Transform this to a call to nsubstitute or nsubstitute, if that is appropriate. * cl.el (ldiff): Don't call setf here, this makes for a load-time dependency problem in cl-macs.el 2010-06-14 Stephen J. Turnbull <stephen@xemacs.org> * term/vt100.el: Refer to XEmacs, not GNU Emacs, in permissions. * term/bg-mouse.el: * term/sup-mouse.el: Put copyright notice in canonical "Copyright DATE AUTHOR" form. Refer to XEmacs, not GNU Emacs, in permissions. * site-load.el: Add permission boilerplate. * mule/canna-leim.el: * alist.el: Refer to XEmacs, not APEL/this program, in permissions. * mule/canna-leim.el: Remove my copyright, I've assigned it to the FSF. 2010-06-14 Stephen J. Turnbull <stephen@xemacs.org> * gtk.el: * gtk-widget-accessors.el: * gtk-package.el: * gtk-marshal.el: * gtk-compose.el: * gnome.el: Add copyright notice based on internal evidence. 2010-06-14 Stephen J. Turnbull <stephen@xemacs.org> * easymenu.el: Add reference to COPYING to permission notice. * gutter.el: * gutter-items.el: * menubar-items.el: Fix typo "Xmacs" in permissions notice. 2010-06-14 Stephen J. Turnbull <stephen@xemacs.org> * auto-save.el: * font.el: * fontconfig.el: * mule/kinsoku.el: Add "part of XEmacs" text to permission notice. 2010-10-14 Aidan Kehoe <kehoea@parhasard.net> * byte-optimize.el (side-effect-free-fns): * cl-macs.el (remf, getf): * cl-extra.el (tailp, cl-set-getf, cl-do-remf): * cl.el (ldiff, endp): Tighten up Common Lisp compatibility for #'ldiff, #'endp, #'tailp; add circularity checking for the first two. #'cl-set-getf and #'cl-do-remf were Lisp implementations of #'plist-put and #'plist-remprop; change the names to aliases, changes the macros that use them to using #'plist-put and #'plist-remprop directly. 2010-10-12 Aidan Kehoe <kehoea@parhasard.net> * abbrev.el (fundamental-mode-abbrev-table, global-abbrev-table): Create both these abbrev tables using the usual #'define-abbrev-table calls, rather than attempting to special-case them. * cl-extra.el: Force cl-macs to be loaded here, if cl-extra.el is being loaded interpreted. Previously other, later files would redundantly call (load "cl-macs") when interpreted, it's more reasonable to do it here, once. * cmdloop.el (read-quoted-char-radix): Use defcustom here, we don't have any dump-order dependencies that would prevent that. * custom.el (eval-when-compile): Don't load cl-macs when interpreted or when byte-compiling, rely on cl-extra.el in the former case and the appropriate entry in bytecomp-load-hook in the latter. Get rid of custom-declare-variable-list, we have no dump-time dependencies that would require it. * faces.el (eval-when-compile): Don't load cl-macs when interpreted or when byte-compiling. * packages.el: Remove some inaccurate comments. * post-gc.el (cleanup-simple-finalizers): Use #'delete-if-not here, now the order of preloaded-file-list has been changed to make it available. * subr.el (custom-declare-variable-list): Remove. No need for it. Also remove a stub define-abbrev-table from this file, given the current order of preloaded-file-list there's no need for it. 2010-10-10 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-constp) Forms quoted with FUNCTION are also constant. (byte-compile-initial-macro-environment): In #'the, if FORM is constant and does not match TYPE, warn at byte-compile time. 2010-10-10 Aidan Kehoe <kehoea@parhasard.net> * backquote.el (bq-vector-contents, bq-list*): Remove; the former is equivalent to (append VECTOR nil), the latter to (list* ...). (bq-process-2): Use (append VECTOR nil) instead of using #'bq-vector-contents to convert to a list. (bq-process-1): Now we use list* instead of bq-list * subr.el (list*): Moved from cl.el, since it is now required to be available the first time a backquoted form is encountered. * cl.el (list*): Move to subr.el. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * test-harness.el (Check-Message): Add an omitted comma here, thank you the buildbot. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * hash-table.el (hash-table-key-list, hash-table-value-list) (hash-table-key-value-alist, hash-table-key-value-plist): Remove some useless #'nreverse calls in these files; our hash tables have no order, it's not helpful to pretend they do. * behavior.el (read-behavior): Do the same in this file, in some code evidently copied from hash-table.el. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * info.el (Info-insert-dir): * format.el (format-deannotate-region): * files.el (cd, save-buffers-kill-emacs): Use #'some, #'every and related functions for applying boolean operations to lists, instead of rolling our own ones that cons and don't short-circuit. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-initial-macro-environment): * cl-macs.el (the): Rephrase the docstring, make its implementation when compiling files a little nicer. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * descr-text.el (unidata-initialize-unicodedata-database) (unidata-initialize-unihan-database, describe-char-unicode-data) (describe-char-unicode-data): Wrap calls to the database functions with (with-fboundp ...), avoiding byte compile warnings on builds without support for the database functions. (describe-char): (reduce #'max ...), not (apply #'max ...), no need to cons needlessly. (describe-char): Remove a redundant lambda wrapping #'extent-properties. (describe-char-unicode-data): Call #'nsubst when replacing "" with nil in the result of #'split-string, instead of consing inside mapcar. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * x-faces.el (x-available-font-sizes): * specifier.el (let-specifier): * package-ui.el (pui-add-required-packages): * msw-faces.el (mswindows-available-font-sizes): * modeline.el (modeline-minor-mode-menu): * minibuf.el (minibuf-directory-files): Replace the O2N (delq nil (mapcar (lambda (W) (and X Y)) Z)) with the ON (mapcan (lambda (W) (and X (list Y))) Z) in these files. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * cl-macs.el (= < > <= >=): When these functions are handed more than two arguments, and those arguments have no side effects, transform to a series of two argument calls, avoiding funcall in the byte-compiled code. * mule/mule-cmds.el (finish-set-language-environment): Take advantage of this change in a function called 256 times at startup. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-function-form, byte-compile-quote) (byte-compile-quote-form): Warn at compile time, and error at runtime, if a (quote ...) or a (function ...) form attempts to quote more than one object. 2010-09-16 Aidan Kehoe <kehoea@parhasard.net> * byte-optimize.el (byte-optimize-apply): Transform (apply 'nconc (mapcar ...)) to (mapcan ...); warn about use of the first idiom. * update-elc.el (do-autoload-commands): * packages.el (packages-find-package-library-path): * frame.el (frame-list): * extents.el (extent-descendants): * etags.el (buffer-tag-table-files): * dumped-lisp.el (preloaded-file-list): * device.el (device-list): * bytecomp-runtime.el (proclaim-inline, proclaim-notinline) Use #'mapcan, not (apply #'nconc (mapcar ...) in all these files. * bytecomp-runtime.el (eval-when-compile, eval-and-compile): In passing, mention that these macros also evaluate the body when interpreted. tests/ChangeLog addition: 2011-02-07 Aidan Kehoe <kehoea@parhasard.net> * automated/lisp-tests.el: Test lexical scope for `block', `return-from'; add a Known-Bug-Expect-Failure for a contorted example that fails when byte-compiled.
author Aidan Kehoe <kehoea@parhasard.net>
date Mon, 07 Feb 2011 12:01:24 +0000
parents 40dc584fce16
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 @node Major Modes, Indentation, Mule, Top
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 @chapter Major Modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 @cindex major modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 @kindex TAB
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 @kindex DEL
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 @kindex LFD
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 Emacs has many different @dfn{major modes}, each of which customizes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 Emacs for editing text of a particular sort. The major modes are mutually
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 exclusive; at any time, each buffer has one major mode. The mode line
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 normally contains the name of the current major mode in parentheses.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 @xref{Mode Line}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 The least specialized major mode is called @dfn{Fundamental mode}. This
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 mode has no mode-specific redefinitions or variable settings. Each
2736
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
17 Emacs command behaves in its most generic manner, and each option is in its
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 default state. For editing any specific type of text, such as Lisp code or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 English text, you should switch to the appropriate major mode, such as Lisp
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 mode or Text mode.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 Selecting a major mode changes the meanings of a few keys to become
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 more specifically adapted to the language being edited. @key{TAB},
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 @key{DEL}, and @key{LFD} are changed frequently. In addition, commands
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 which handle comments use the mode to determine how to delimit comments.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 Many major modes redefine the syntactical properties of characters
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 appearing in the buffer. @xref{Syntax}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28
2522
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
29 The major modes fall into three major groups. Programming modes
2736
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
30 (@pxref{Programs}) are for specific programming languages. They tend to
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
31 be line-oriented, often enforcing indentation. They emphasize
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
32 facilities for creating and displaying structure. Text modes
2522
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
33 (like Nroff mode, @TeX{} mode, Outline mode, XML mode, etc.@:) are for
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
34 editing human readable text. The remaining major modes are not intended
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
35 for direct use in editing user files; they are used in buffers created
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
36 by Emacs for specific purposes. Examples of such modes include Dired
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
37 mode which is used for buffers made by Dired (@pxref{Dired}), Mail mode
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
38 for buffers made by @kbd{C-x m} (@pxref{Sending Mail}), and Shell mode
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
39 for buffers used for communicating with an inferior shell process
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 (@pxref{Interactive Shell}).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 Most programming language major modes specify that only blank lines
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 separate paragraphs. This is so that the paragraph commands remain useful.
2736
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
44 @xref{Paragraphs}. They also cause Auto Fill minor mode to use the
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
45 definition of
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 @key{TAB} to indent the new lines it creates. This is because most lines
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 in a program are usually indented. @xref{Indentation}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 @menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 * Choosing Modes:: How major modes are specified or chosen.
2522
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
51 * Mode Hooks:: Customizing a major mode
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 @end menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53
2522
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
54 @node Choosing Modes, Mode Hooks, Major Modes, Major Modes
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 @section Choosing Major Modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 You can select a major mode explicitly for the current buffer, but
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 most of the time Emacs determines which mode to use based on the file
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 name or some text in the file.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 Use a @kbd{M-x} command to explicitly select a new major mode. Add
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 @code{-mode} to the name of a major mode to get the name of a command to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 select that mode. For example, to enter Lisp mode, execute @kbd{M-x
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 lisp-mode}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 @vindex auto-mode-alist
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 When you visit a file, Emacs usually chooses the right major mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 based on the file's name. For example, files whose names end in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 @code{.c} are edited in C mode. The variable @code{auto-mode-alist}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 controls the correspondence between file names and major mode. Its value
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 is a list in which each element has the form:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 (@var{regexp} . @var{mode-function})
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 For example, one element normally found in the list has the form
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 @code{(@t{"\\.c$"} . c-mode)}. It is responsible for selecting C mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 for files whose names end in @file{.c}. (Note that @samp{\\} is needed in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 Lisp syntax to include a @samp{\} in the string, which is needed to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 suppress the special meaning of @samp{.} in regexps.) The only practical
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 way to change this variable is with Lisp code.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 You can specify which major mode should be used for editing a certain
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 file by a special sort of text in the first non-blank line of the file.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 The mode name should appear in this line both preceded and followed by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 @samp{-*-}. Other text may appear on the line as well. For example,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91 ;-*-Lisp-*-
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 tells Emacs to use Lisp mode. Note how the semicolon is used to make Lisp
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 treat this line as a comment. Such an explicit specification overrides any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97 default mode based on the file name.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99 Another format of mode specification is:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102 -*-Mode: @var{modename};-*-
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 which allows other things besides the major mode name to be specified.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 However, Emacs does not look for anything except the mode name.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 The major mode can also be specified in a local variables list.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 @xref{File Variables}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 @vindex default-major-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113 When you visit a file that does not specify a major mode to use, or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 when you create a new buffer with @kbd{C-x b}, Emacs uses the major mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 specified by the variable @code{default-major-mode}. Normally this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 value is the symbol @code{fundamental-mode}, which specifies Fundamental
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 mode. If @code{default-major-mode} is @code{nil}, the major mode is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 taken from the previously selected buffer.
2522
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
119
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
120 @node Mode Hooks, , Choosing Modes, Major Modes
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
121 @section Mode Hook Variables
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
122
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
123 @cindex Hook variables
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
124 @cindex mode hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
125 @findex add-hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
126 @findex remove-hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
127 @vindex lisp-mode-hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
128 @vindex emacs-lisp-mode-hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
129 @vindex lisp-interaction-mode-hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
130 @vindex scheme-mode-hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
131
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
132 The last step taken by a major mode, by convention, is to invoke a
2736
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
133 list of user supplied functions that are stored in a @dfn{hook}
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
134 variable. This allows a user to further customize the major mode, and
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
135 is particularly convenient for associating minor modes with major modes.
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
136 @xref{Minor Modes}. For example, to automatically turn on the Auto Fill
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
137 minor mode when Text mode is invoked, add the following code to the
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
138 initialization file (@pxref{Init File})
2522
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
139
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
140 @example
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
141 (add-hook 'text-mode-hook 'turn-on-auto-fill)
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
142 @end example
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
143
2736
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
144 Derived modes often @dfn{inherit} the parent mode's hooks. For
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
145 example, Texinfo Mode is derived from Text Mode, so customizing
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
146 @code{text-mode-hook} as above will also enable Auto Fill minor mode in
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
147 buffers containing Texinfo files.
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
148
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
149 Hooks are also commonly used to set up buffer local variables
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
150 (@pxref{Locals}).
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
151
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
152 The name of the hook variable is created by appending the string
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
153 @code{-hook} to the name of the function used to invoke the major mode.
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
154 For example, as seen above, the hook variable used by Text Mode would be
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
155 named @code{text-mode-hook}. By convention the mode hook function
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
156 receives no arguments. If a hook variable does not exist, or it has the
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
157 value @code{nil}, the major mode simply ignores it.
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
158
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
159 The recommended way to add functions to a hook variable is with the
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
160 @code{add-hook} function.
40dc584fce16 [xemacs-hg @ 2005-04-18 03:59:48 by stephent]
stephent
parents: 2522
diff changeset
161 @code{add-hook} will check that the function is not already
2522
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
162 listed in the hook variable before adding it. It will also create a hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
163 variable with the value @code{nil} if one does not exist before adding
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
164 the function. @code{add-hook} adds functions to the front of the hook
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
165 variable list. This means that the last hook added is run first by the
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
166 major mode. It is considered very poor style to write hook functions
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
167 that depend on the order that hooks are executed.
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
168
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
169 Hooks can be removed from hook variables with @code{remove-hook}.
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
170
52dc9b940348 [xemacs-hg @ 2005-01-28 00:12:32 by ben]
ben
parents: 428
diff changeset
171